actix-web-csp 0.1.0

High-performance Content Security Policy middleware for Actix Web
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
# Actix Web CSP


A high-performance Content Security Policy (CSP) middleware for Actix Web applications. Built with security-first principles and optimized for production workloads.

## Features


- ๐Ÿ›ก๏ธ **Complete CSP Implementation** - Full support for all CSP directives
- โšก **High Performance** - Optimized for minimal overhead with connection pooling
- ๐Ÿ”’ **Security Focused** - Blocks XSS, injection attacks, and unauthorized resource loading
- ๐Ÿ“Š **Built-in Monitoring** - Real-time violation reporting and performance metrics
- ๐ŸŽฏ **Nonce & Hash Support** - Dynamic nonce generation and content hashing
- ๐Ÿ”ง **Easy Integration** - Simple middleware setup with extensive configuration options
- ๐Ÿงช **Security Testing** - Comprehensive security validation tools included

## Quick Start


Add to your `Cargo.toml`:

```toml
[dependencies]
actix_web_csp = "0.1.0"
actix-web = "4.3"
```

Basic usage:

```rust
use actix_web::{web, App, HttpServer, HttpResponse, Result};
use actix_web_csp::{CspPolicyBuilder, Source, csp_middleware};

async fn index() -> Result<HttpResponse> {
    Ok(HttpResponse::Ok()
        .content_type("text/html")
        .body("<h1>Protected by CSP</h1>"))
}

#[actix_web::main]

async fn main() -> std::io::Result<()> {
    let policy = CspPolicyBuilder::new()
        .default_src([Source::Self_])
        .script_src([Source::Self_])
        .style_src([Source::Self_])
        .img_src([Source::Self_, Source::Scheme("https".into())])
        .build_unchecked();

    HttpServer::new(move || {
        App::new()
            .wrap(csp_middleware(policy.clone()))
            .route("/", web::get().to(index))
    })
    .bind("127.0.0.1:8080")?
    .run()
    .await
}
```

## Configuration Examples


### Strict Security Policy


For applications requiring maximum security:

```rust
let policy = CspPolicyBuilder::new()
    .default_src([Source::None])
    .script_src([Source::Self_])
    .style_src([Source::Self_])
    .img_src([Source::Self_])
    .connect_src([Source::Self_])
    .font_src([Source::Self_])
    .object_src([Source::None])
    .media_src([Source::None])
    .frame_src([Source::None])
    .base_uri([Source::Self_])
    .form_action([Source::Self_])
    .build_unchecked();
```

### Development-Friendly Policy


For development environments:

```rust
let policy = CspPolicyBuilder::new()
    .default_src([Source::Self_])
    .script_src([
        Source::Self_,
        Source::Host("localhost:3000".into()),
        Source::Host("cdn.jsdelivr.net".into())
    ])
    .style_src([
        Source::Self_,
        Source::UnsafeInline, // Only for development!
        Source::Host("fonts.googleapis.com".into())
    ])
    .img_src([
        Source::Self_,
        Source::Scheme("data".into()),
        Source::Scheme("https".into())
    ])
    .connect_src([
        Source::Self_,
        Source::Scheme("https".into()),
        Source::Scheme("ws".into()) // WebSocket support
    ])
    .font_src([
        Source::Self_,
        Source::Scheme("data".into()),
        Source::Host("fonts.gstatic.com".into())
    ])
    .report_uri("/csp-violations")
    .build_unchecked();
```

### E-commerce Application


Secure configuration for online stores:

```rust
let policy = CspPolicyBuilder::new()
    .default_src([Source::Self_])
    .script_src([
        Source::Self_,
        Source::Host("js.stripe.com".into()),
        Source::Host("checkout.paypal.com".into())
    ])
    .style_src([
        Source::Self_,
        Source::Host("fonts.googleapis.com".into())
    ])
    .img_src([
        Source::Self_,
        Source::Scheme("https".into()),
        Source::Scheme("data".into()) // For product images
    ])
    .connect_src([
        Source::Self_,
        Source::Host("api.stripe.com".into()),
        Source::Host("api.paypal.com".into()),
        Source::Scheme("https".into())
    ])
    .frame_src([
        Source::Host("js.stripe.com".into()),
        Source::Host("checkout.paypal.com".into())
    ])
    .font_src([
        Source::Self_,
        Source::Scheme("data".into()),
        Source::Host("fonts.gstatic.com".into())
    ])
    .report_uri("/security/csp-report")
    .build_unchecked();
```

## Advanced Features


### Nonce-Based CSP


For dynamic content with inline scripts:

```rust
use actix_web_csp::{csp_middleware_with_nonce, RequestNonce};

async fn secure_page(req: HttpRequest) -> Result<HttpResponse> {
    let nonce = req.extensions()
        .get::<RequestNonce>()
        .map(|n| n.to_string())
        .unwrap_or_default();

    let html = format!(r#"
        <!DOCTYPE html>
        <html>
        <head>
            <script nonce="{}">
                console.log('This script is allowed');
            </script>
        </head>
        <body>
            <h1>Secure Page</h1>
        </body>
        </html>
    "#, nonce);

    Ok(HttpResponse::Ok()
        .content_type("text/html")
        .body(html))
}

let policy = CspPolicyBuilder::new()
    .default_src([Source::Self_])
    .script_src([Source::Self_]) // Nonce will be added automatically
    .build_unchecked();

let app = App::new()
    .wrap(csp_middleware_with_nonce(policy, 32)) // 32-byte nonce
    .route("/secure", web::get().to(secure_page));
```

### Violation Reporting


Handle CSP violations in real-time:

```rust
use actix_web_csp::{csp_with_reporting, CspViolationReport};

fn handle_violation(report: CspViolationReport) {
    println!("๐Ÿšจ CSP Violation Detected:");
    println!("  Document: {}", report.document_uri);
    println!("  Violated: {}", report.violated_directive);
    println!("  Blocked: {}", report.blocked_uri);

    // Log to security monitoring system
    // security_logger::log_csp_violation(&report);
}

let policy = CspPolicyBuilder::new()
    .default_src([Source::Self_])
    .script_src([Source::Self_])
    .report_uri("/csp-report")
    .build_unchecked();

let (middleware, configurator) = csp_with_reporting(policy, handle_violation);

let app = App::new()
    .wrap(middleware)
    .configure(configurator) // Adds /csp-report endpoint
    .route("/", web::get().to(index));
```

### Performance Monitoring


Track CSP performance metrics:

```rust
use actix_web_csp::{CspStats, csp_middleware_with_stats};

let policy = CspPolicyBuilder::new()
    .default_src([Source::Self_])
    .build_unchecked();

let (middleware, stats) = csp_middleware_with_stats(policy);

// Monitor performance
tokio::spawn(async move {
    loop {
        tokio::time::sleep(Duration::from_secs(60)).await;
        println!("CSP Stats: {} requests processed", stats.total_requests());
        println!("Average response time: {}ฮผs", stats.avg_response_time_micros());
    }
});

let app = App::new()
    .wrap(middleware)
    .route("/", web::get().to(index));
```

## Security Testing


The library includes a comprehensive security testing tool:

```rust
use actix_web_csp::{CspSecurityTester, CspPolicyBuilder, Source};

let policy = CspPolicyBuilder::new()
    .default_src([Source::Self_])
    .script_src([Source::Self_])
    .build_unchecked();

let mut tester = CspSecurityTester::new(policy);
let results = tester.run_comprehensive_test();

// Results show:
// โœ… XSS Protection - 4/4 XSS payloads blocked
// โœ… Inline Script Protection - Inline scripts blocked
// โœ… External Script Protection - 4/4 malicious domains blocked
// โœ… Overall Assessment: ๐ŸŸข Your CSP configuration looks secure!
```

Run the security tester:

```bash
cargo run --example csp_security_tester
```

## Policy Builder API


The `CspPolicyBuilder` provides a fluent interface for policy construction:

```rust
let policy = CspPolicyBuilder::new()
    // Content sources
    .default_src([Source::Self_])
    .script_src([Source::Self_, Source::Host("cdn.example.com".into())])
    .style_src([Source::Self_, Source::UnsafeInline])
    .img_src([Source::Self_, Source::Scheme("data".into())])
    .connect_src([Source::Self_, Source::Scheme("https".into())])
    .font_src([Source::Self_, Source::Host("fonts.gstatic.com".into())])
    .object_src([Source::None])
    .media_src([Source::Self_])
    .frame_src([Source::None])

    // Navigation sources
    .base_uri([Source::Self_])
    .form_action([Source::Self_])

    // Reporting
    .report_uri("/csp-violations")
    .report_to("csp-endpoint")

    // Build policy (validates configuration)
    .build()
    .expect("Invalid CSP policy");
```

### Source Types


```rust
use actix_web_csp::Source;

// Special keywords
Source::Self_           // 'self'
Source::None           // 'none'
Source::UnsafeInline   // 'unsafe-inline'
Source::UnsafeEval     // 'unsafe-eval'
Source::StrictDynamic  // 'strict-dynamic'

// Schemes
Source::Scheme("https".into())  // https:
Source::Scheme("data".into())   // data:

// Hosts
Source::Host("example.com".into())        // example.com
Source::Host("*.example.com".into())      // *.example.com
Source::Host("example.com:443".into())    // example.com:443

// Nonces (auto-generated)
Source::Nonce("random-value".into())      // 'nonce-random-value'

// Hashes (auto-calculated)
Source::Hash {
    algorithm: HashAlgorithm::Sha256,
    value: "base64-hash".into()
}  // 'sha256-base64-hash'
```

## Real-World Examples


### Production Web Application


```rust
#[actix_web::main]

async fn main() -> std::io::Result<()> {
    let policy = CspPolicyBuilder::new()
        .default_src([Source::Self_])
        .script_src([
            Source::Self_,
            Source::Host("cdnjs.cloudflare.com".into()),
            Source::Host("cdn.jsdelivr.net".into())
        ])
        .style_src([
            Source::Self_,
            Source::Host("fonts.googleapis.com".into()),
            Source::Host("cdnjs.cloudflare.com".into())
        ])
        .img_src([
            Source::Self_,
            Source::Scheme("https".into()),
            Source::Scheme("data".into())
        ])
        .connect_src([
            Source::Self_,
            Source::Host("api.example.com".into()),
            Source::Scheme("https".into())
        ])
        .font_src([
            Source::Self_,
            Source::Host("fonts.gstatic.com".into()),
            Source::Scheme("data".into())
        ])
        .frame_ancestors([Source::None])
        .report_uri("/security/csp-violations")
        .build_unchecked();

    HttpServer::new(move || {
        App::new()
            .wrap(Logger::default())
            .wrap(csp_middleware(policy.clone()))
            .service(
                web::scope("/api")
                    .route("/users", web::get().to(get_users))
                    .route("/products", web::get().to(get_products))
            )
            .service(Files::new("/", "./static").index_file("index.html"))
    })
    .bind("0.0.0.0:8080")?
    .run()
    .await
}
```

### API Server with CORS


```rust
use actix_cors::Cors;

let policy = CspPolicyBuilder::new()
    .default_src([Source::None])
    .connect_src([
        Source::Self_,
        Source::Host("api.frontend.com".into())
    ])
    .report_uri("/api/csp-violations")
    .build_unchecked();

let app = App::new()
    .wrap(
        Cors::default()
            .allowed_origin("https://frontend.com")
            .allowed_methods(vec!["GET", "POST"])
            .max_age(3600)
    )
    .wrap(csp_middleware(policy))
    .route("/api/data", web::get().to(api_handler));
```

## Performance


Benchmark results on a modern system:

- **Overhead**: < 0.1ms per request
- **Memory usage**: ~50KB per 1000 concurrent requests
- **Throughput**: Handles 50,000+ requests/second
- **Nonce generation**: 2M nonces/second

Run benchmarks:

```bash
cargo bench
```

## License


Licensed under the MIT License. See [LICENSE](LICENSE) for details.

## Contributing


Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details.

---

**Note**: This middleware is production-ready and actively maintained. For security issues, please email ekemenms@gmail.com.