-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathContentSecurityPolicy.php
More file actions
1077 lines (922 loc) · 29.4 KB
/
ContentSecurityPolicy.php
File metadata and controls
1077 lines (922 loc) · 29.4 KB
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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
declare(strict_types=1);
/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace CodeIgniter\HTTP;
use CodeIgniter\Exceptions\InvalidArgumentException;
use Config\App;
use Config\ContentSecurityPolicy as ContentSecurityPolicyConfig;
/**
* Provides tools for working with the Content-Security-Policy header
* to help defeat XSS attacks.
*
* @see http://www.w3.org/TR/CSP/
* @see http://www.html5rocks.com/en/tutorials/security/content-security-policy/
* @see http://content-security-policy.com/
* @see https://www.owasp.org/index.php/Content_Security_Policy
* @see \CodeIgniter\HTTP\ContentSecurityPolicyTest
*/
class ContentSecurityPolicy
{
private const DIRECTIVES_ALLOWING_SOURCE_LISTS = [
'base-uri' => 'baseURI',
'child-src' => 'childSrc',
'connect-src' => 'connectSrc',
'default-src' => 'defaultSrc',
'font-src' => 'fontSrc',
'form-action' => 'formAction',
'frame-ancestors' => 'frameAncestors',
'frame-src' => 'frameSrc',
'img-src' => 'imageSrc',
'media-src' => 'mediaSrc',
'object-src' => 'objectSrc',
'plugin-types' => 'pluginTypes',
'script-src' => 'scriptSrc',
'style-src' => 'styleSrc',
'sandbox' => 'sandbox',
'manifest-src' => 'manifestSrc',
'script-src-elem' => 'scriptSrcElem',
'script-src-attr' => 'scriptSrcAttr',
'style-src-elem' => 'styleSrcElem',
'style-src-attr' => 'styleSrcAttr',
'worker-src' => 'workerSrc',
];
/**
* Map of CSP directives to this class's properties.
*
* @var array<string, string>
*/
protected array $directives = [
...self::DIRECTIVES_ALLOWING_SOURCE_LISTS,
'report-uri' => 'reportURI',
'report-to' => 'reportTo',
];
/**
* The `base-uri` directive restricts the URLs that can be used to specify the document base URL.
*
* @var array<string, bool>|string|null
*/
protected $baseURI = [];
/**
* The `child-src` directive governs the creation of nested browsing contexts as well
* as Worker execution contexts.
*
* @var array<string, bool>|string
*/
protected $childSrc = [];
/**
* The `connect-src` directive restricts which URLs the protected resource can load using script interfaces.
*
* @var array<string, bool>|string
*/
protected $connectSrc = [];
/**
* The `default-src` directive sets a default source list for a number of directives.
*
* @var array<string, bool>|string|null
*/
protected $defaultSrc = [];
/**
* The `font-src` directive restricts from where the protected resource can load fonts.
*
* @var array<string, bool>|string
*/
protected $fontSrc = [];
/**
* The `form-action` directive restricts which URLs can be used as the action of HTML form elements.
*
* @var array<string, bool>|string
*/
protected $formAction = [];
/**
* The `frame-ancestors` directive indicates whether the user agent should allow embedding
* the resource using a `frame`, `iframe`, `object`, `embed` or `applet` element,
* or equivalent functionality in non-HTML resources.
*
* @var array<string, bool>|string
*/
protected $frameAncestors = [];
/**
* The `frame-src` directive restricts the URLs which may be loaded into child navigables.
*
* @var array<string, bool>|string
*/
protected $frameSrc = [];
/**
* The `img-src` directive restricts from where the protected resource can load images.
*
* @var array<string, bool>|string
*/
protected $imageSrc = [];
/**
* The `media-src` directive restricts from where the protected resource can load video,
* audio, and associated text tracks.
*
* @var array<string, bool>|string
*/
protected $mediaSrc = [];
/**
* The `object-src` directive restricts from where the protected resource can load plugins.
*
* @var array<string, bool>|string
*/
protected $objectSrc = [];
/**
* The `plugin-types` directive restricts the set of plugins that can be invoked by the
* protected resource by limiting the types of resources that can be embedded.
*
* @var array<string, bool>|string
*/
protected $pluginTypes = [];
/**
* The `script-src` directive restricts which scripts the protected resource can execute.
*
* @var array<string, bool>|string
*/
protected $scriptSrc = [];
/**
* The `style-src` directive restricts which styles the user may applies to the protected resource.
*
* @var array<string, bool>|string
*/
protected $styleSrc = [];
/**
* The `sandbox` directive specifies an HTML sandbox policy that the user agent applies to the protected resource.
*
* @var array<string, bool>|string
*/
protected $sandbox = [];
/**
* The `report-uri` directive specifies a URL to which the user agent sends reports about policy violation.
*
* @var string|null
*/
protected $reportURI;
/**
* The `report-to` directive specifies a named group in a Reporting API
* endpoint to which the user agent sends reports about policy violation.
*/
protected ?string $reportTo = null;
// --------------------------------------------------------------
// CSP Level 3 Directives
// --------------------------------------------------------------
/**
* The `manifest-src` directive restricts the URLs from which application manifests may be loaded.
*
* @var array<string, bool>|string
*/
protected $manifestSrc = [];
/**
* The `script-src-elem` directive applies to all script requests and script blocks.
*
* @var array<string, bool>|string
*/
protected array|string $scriptSrcElem = [];
/**
* The `script-src-attr` directive applies to event handlers and, if present,
* it will override the `script-src` directive for relevant checks.
*
* @var array<string, bool>|string
*/
protected array|string $scriptSrcAttr = [];
/**
* The `style-src-elem` directive governs the behaviour of styles except
* for styles defined in inline attributes.
*
* @var array<string, bool>|string
*/
protected array|string $styleSrcElem = [];
/**
* The `style-src-attr` directive governs the behaviour of style attributes.
*
* @var array<string, bool>|string
*/
protected array|string $styleSrcAttr = [];
/**
* The `worker-src` directive restricts the URLs which may be loaded as a `Worker`,
* `SharedWorker`, or `ServiceWorker`.
*
* @var array<string, bool>|string
*/
protected array|string $workerSrc = [];
/**
* Instructs user agents to rewrite URL schemes by changing HTTP to HTTPS.
*
* @var bool
*/
protected $upgradeInsecureRequests = false;
/**
* Set to `true` to make all directives report-only instead of enforced.
*
* @var bool
*/
protected $reportOnly = false;
/**
* Set of valid keyword-sources.
*
* @see https://www.w3.org/TR/CSP3/#source-expression
*
* @var list<string>
*/
protected $validSources = [
// CSP2 keywords
'self',
'none',
'unsafe-inline',
'unsafe-eval',
// CSP3 keywords
'strict-dynamic',
'unsafe-hashes',
'report-sample',
'unsafe-allow-redirects',
'wasm-unsafe-eval',
'trusted-types-eval',
'report-sha256',
'report-sha384',
'report-sha512',
];
/**
* Set of nonces generated.
*
* @var list<string>
*
* @deprecated 4.7.0 Never used.
*/
protected $nonces = [];
/**
* Nonce for style tags.
*
* @var string|null
*/
protected $styleNonce;
/**
* Nonce for script tags.
*
* @var string|null
*/
protected $scriptNonce;
/**
* Nonce placeholder for style tags.
*
* @var string
*/
protected $styleNonceTag = '{csp-style-nonce}';
/**
* Nonce placeholder for script tags.
*
* @var string
*/
protected $scriptNonceTag = '{csp-script-nonce}';
/**
* Replace nonce tags automatically?
*
* @var bool
*/
protected $autoNonce = true;
/**
* An array of header info since we have to build
* ourselves before passing to a Response object.
*
* @var array<string, string>
*/
protected $tempHeaders = [];
/**
* An array of header info to build that should only be reported.
*
* @var array<string, string>
*/
protected $reportOnlyHeaders = [];
/**
* Whether Content Security Policy is being enforced.
*
* @var bool
*/
protected $CSPEnabled = false;
/**
* Map of reporting endpoints to their URLs.
*
* @var array<string, string>
*/
private array $reportingEndpoints = [];
/**
* Stores our default values from the Config file.
*/
public function __construct(ContentSecurityPolicyConfig $config)
{
$this->CSPEnabled = config(App::class)->CSPEnabled;
foreach (get_object_vars($config) as $setting => $value) {
if (! property_exists($this, $setting)) {
continue;
}
if (
in_array($setting, self::DIRECTIVES_ALLOWING_SOURCE_LISTS, true)
&& is_array($value)
&& array_is_list($value)
) {
// Config sets these directives as `list<string>|string`
// but we need them as `array<string, bool>` internally.
$this->{$setting} = array_combine($value, array_fill(0, count($value), $this->reportOnly));
continue;
}
$this->{$setting} = $value;
}
if (! is_array($this->styleSrc)) {
$this->styleSrc = [$this->styleSrc => $this->reportOnly];
}
if (! is_array($this->scriptSrc)) {
$this->scriptSrc = [$this->scriptSrc => $this->reportOnly];
}
}
/**
* Whether Content Security Policy is being enforced.
*/
public function enabled(): bool
{
return $this->CSPEnabled;
}
/**
* Get the nonce for the style tag.
*/
public function getStyleNonce(): string
{
if ($this->styleNonce === null) {
$this->styleNonce = base64_encode(random_bytes(12));
$this->addStyleSrc('nonce-' . $this->styleNonce);
if ($this->styleSrcElem !== []) {
$this->addStyleSrcElem('nonce-' . $this->styleNonce);
}
}
return $this->styleNonce;
}
/**
* Get the nonce for the script tag.
*/
public function getScriptNonce(): string
{
if ($this->scriptNonce === null) {
$this->scriptNonce = base64_encode(random_bytes(12));
$this->addScriptSrc('nonce-' . $this->scriptNonce);
if ($this->scriptSrcElem !== []) {
$this->addScriptSrcElem('nonce-' . $this->scriptNonce);
}
}
return $this->scriptNonce;
}
/**
* Compiles and sets the appropriate headers in the request.
*
* Should be called just prior to sending the response to the user agent.
*
* @return void
*/
public function finalize(ResponseInterface $response)
{
$this->generateNonces($response);
$this->buildHeaders($response);
}
/**
* If TRUE, nothing will be restricted. Instead all violations will
* be reported to the reportURI for monitoring. This is useful when
* you are just starting to implement the policy, and will help
* determine what errors need to be addressed before you turn on
* all filtering.
*
* @return $this
*/
public function reportOnly(bool $value = true)
{
$this->reportOnly = $value;
return $this;
}
/**
* Adds a new value to the `base-uri` directive.
*
* `base-uri` restricts the URLs that can appear in a page's <base> element.
*
* @see http://www.w3.org/TR/CSP/#directive-base-uri
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addBaseURI($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'baseURI', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `child-src` directive.
*
* `child-src` lists the URLs for workers and embedded frame contents.
* For example: child-src https://youtube.com would enable embedding
* videos from YouTube but not from other origins.
*
* @see http://www.w3.org/TR/CSP/#directive-child-src
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addChildSrc($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'childSrc', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `connect-src` directive.
*
* `connect-src` limits the origins to which you can connect
* (via XHR, WebSockets, and EventSource).
*
* @see http://www.w3.org/TR/CSP/#directive-connect-src
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addConnectSrc($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'connectSrc', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `default-src` directive.
*
* `default-src` is the URI that is used for many of the settings when
* no other source has been set.
*
* @see http://www.w3.org/TR/CSP/#directive-default-src
*
* @param list<string>|string $uri
*
* @return $this
*/
public function setDefaultSrc($uri, ?bool $explicitReporting = null)
{
$this->defaultSrc = [(string) $uri => $explicitReporting ?? $this->reportOnly];
return $this;
}
/**
* Adds a new value to the `font-src` directive.
*
* `font-src` specifies the origins that can serve web fonts.
*
* @see http://www.w3.org/TR/CSP/#directive-font-src
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addFontSrc($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'fontSrc', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `form-action` directive.
*
* @see http://www.w3.org/TR/CSP/#directive-form-action
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addFormAction($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'formAction', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `frame-ancestors` directive.
*
* @see http://www.w3.org/TR/CSP/#directive-frame-ancestors
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addFrameAncestor($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'frameAncestors', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `frame-src` directive.
*
* @see http://www.w3.org/TR/CSP/#directive-frame-src
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addFrameSrc($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'frameSrc', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `img-src` directive.
*
* @see http://www.w3.org/TR/CSP/#directive-img-src
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addImageSrc($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'imageSrc', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `media-src` directive.
*
* @see http://www.w3.org/TR/CSP/#directive-media-src
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addMediaSrc($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'mediaSrc', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `manifest-src` directive.
*
* @see https://www.w3.org/TR/CSP/#directive-manifest-src
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addManifestSrc($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'manifestSrc', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `object-src` directive.
*
* @see http://www.w3.org/TR/CSP/#directive-object-src
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addObjectSrc($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'objectSrc', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `plugin-types` directive.
*
* @see http://www.w3.org/TR/CSP/#directive-plugin-types
*
* @param list<string>|string $mime
*
* @return $this
*/
public function addPluginType($mime, ?bool $explicitReporting = null)
{
$this->addOption($mime, 'pluginTypes', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `sandbox` directive.
*
* @see http://www.w3.org/TR/CSP/#directive-sandbox
*
* @param list<string>|string $flags
*
* @return $this
*/
public function addSandbox($flags, ?bool $explicitReporting = null)
{
$this->addOption($flags, 'sandbox', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `script-src` directive.
*
* @see http://www.w3.org/TR/CSP/#directive-script-src
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addScriptSrc($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'scriptSrc', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `script-src-elem` directive.
*
* @see https://www.w3.org/TR/CSP/#directive-script-src-elem
*
* @param list<string>|string $uri
*/
public function addScriptSrcElem(array|string $uri, ?bool $explicitReporting = null): static
{
$this->addOption($uri, 'scriptSrcElem', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `script-src-attr` directive.
*
* @see https://www.w3.org/TR/CSP/#directive-script-src-attr
*
* @param list<string>|string $uri
*/
public function addScriptSrcAttr(array|string $uri, ?bool $explicitReporting = null): static
{
$this->addOption($uri, 'scriptSrcAttr', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `style-src` directive.
*
* @see http://www.w3.org/TR/CSP/#directive-style-src
*
* @param list<string>|string $uri
*
* @return $this
*/
public function addStyleSrc($uri, ?bool $explicitReporting = null)
{
$this->addOption($uri, 'styleSrc', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `style-src-elem` directive.
*
* @see https://www.w3.org/TR/CSP/#directive-style-src-elem
*
* @param list<string>|string $uri
*/
public function addStyleSrcElem(array|string $uri, ?bool $explicitReporting = null): static
{
$this->addOption($uri, 'styleSrcElem', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `style-src-attr` directive.
*
* @see https://www.w3.org/TR/CSP/#directive-style-src-attr
*
* @param list<string>|string $uri
*/
public function addStyleSrcAttr(array|string $uri, ?bool $explicitReporting = null): static
{
$this->addOption($uri, 'styleSrcAttr', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Adds a new value to the `worker-src` directive.
*
* @see https://www.w3.org/TR/CSP/#directive-worker-src
*
* @param list<string>|string $uri
*/
public function addWorkerSrc($uri, ?bool $explicitReporting = null): static
{
$this->addOption($uri, 'workerSrc', $explicitReporting ?? $this->reportOnly);
return $this;
}
/**
* Sets whether the user agents should rewrite URL schemes, changing HTTP to HTTPS.
*
* @return $this
*/
public function upgradeInsecureRequests(bool $value = true)
{
$this->upgradeInsecureRequests = $value;
return $this;
}
/**
* Specifies a URL where a browser will send reports when a content
* security policy is violated.
*
* @see http://www.w3.org/TR/CSP/#directive-report-uri
*
* @param string $uri URL to send reports. Set `''` if you want to remove
* this directive at runtime.
*
* @return $this
*/
public function setReportURI(string $uri)
{
$this->reportURI = $uri;
return $this;
}
/**
* Specifies a named group in a Reporting API endpoint to which the user
* agent sends reports about policy violation.
*
* @see https://www.w3.org/TR/CSP/#directive-report-to
*
* @param string $endpoint The name of the reporting endpoint. Set `''` if you
* want to remove this directive at runtime.
*/
public function setReportToEndpoint(string $endpoint): static
{
if ($endpoint === '') {
$this->reportURI = null;
$this->reportTo = null;
return $this;
}
if (! array_key_exists($endpoint, $this->reportingEndpoints)) {
throw new InvalidArgumentException(sprintf('The reporting endpoint "%s" has not been defined.', $endpoint));
}
$this->reportURI = $this->reportingEndpoints[$endpoint]; // for BC with browsers that do not support `report-to`
$this->reportTo = $endpoint;
return $this;
}
/**
* Adds reporting endpoints to the `Reporting-Endpoints` header.
*
* @param array<string, string> $endpoint
*/
public function addReportingEndpoints(array $endpoint): static
{
foreach ($endpoint as $name => $url) {
$this->reportingEndpoints[$name] = $url;
}
return $this;
}
/**
* DRY method to add an string or array to a class property.
*
* @param list<string>|string $options
*
* @return void
*/
protected function addOption($options, string $target, ?bool $explicitReporting = null)
{
// Ensure we have an array to work with...
if (is_string($this->{$target})) {
$this->{$target} = [$this->{$target} => $this->reportOnly];
}
$options = is_array($options) ? $options : [$options];
foreach ($options as $option) {
$this->{$target}[$option] = $explicitReporting ?? $this->reportOnly;
}
}
/**
* Scans the body of the request message and replaces any nonce
* placeholders with actual nonces, that we'll then add to our
* headers.
*
* @return void
*/
protected function generateNonces(ResponseInterface $response)
{
if ($this->enabled() && ! $this->autoNonce) {
return;
}
$body = (string) $response->getBody();
if ($body === '') {
return;
}
// Escape quotes for JSON responses to prevent corrupting the JSON body
$jsonEscape = str_contains($response->getHeaderLine('Content-Type'), 'json');
// Replace style and script placeholders with nonces
$pattern = sprintf('/(%s|%s)/', preg_quote($this->styleNonceTag, '/'), preg_quote($this->scriptNonceTag, '/'));
$body = preg_replace_callback($pattern, function ($match) use ($jsonEscape): string {
if (! $this->enabled()) {
return '';
}
$nonce = $match[0] === $this->styleNonceTag ? $this->getStyleNonce() : $this->getScriptNonce();
$attr = 'nonce="' . $nonce . '"';
return $jsonEscape ? str_replace('"', '\\"', $attr) : $attr;
}, $body);
$response->setBody($body);
}
/**
* Based on the current state of the elements, will add the appropriate
* Content-Security-Policy and Content-Security-Policy-Report-Only headers
* with their values to the response object.
*
* @return void
*/
protected function buildHeaders(ResponseInterface $response)
{
if (! $this->enabled()) {
return;
}
$response->setHeader('Content-Security-Policy', []);
$response->setHeader('Content-Security-Policy-Report-Only', []);
$response->setHeader('Reporting-Endpoints', []);
if (in_array($this->baseURI, ['', null, []], true)) {
$this->baseURI = 'self';
}
if (in_array($this->defaultSrc, ['', null, []], true)) {
$this->defaultSrc = 'self';
}
foreach ($this->directives as $name => $property) {
if ($name === 'report-uri' && (string) $this->reportURI === '') {
continue;
}
if ($name === 'report-to' && (string) $this->reportTo === '') {
continue;
}
if ($this->{$property} !== null) {
$this->addToHeader($name, $this->{$property});
}
}
// Compile our own header strings here since if we just
// append it to the response, it will be joined with
// commas, not semi-colons as we need.
if ($this->reportingEndpoints !== []) {
$endpoints = [];
foreach ($this->reportingEndpoints as $name => $url) {
$endpoints[] = trim("{$name}=\"{$url}\"");
}
$response->appendHeader('Reporting-Endpoints', implode(', ', $endpoints));
$this->reportingEndpoints = [];
}
if ($this->tempHeaders !== []) {
$header = [];
foreach ($this->tempHeaders as $name => $value) {
$header[] = trim("{$name} {$value}");
}
if ($this->upgradeInsecureRequests) {
$header[] = 'upgrade-insecure-requests';
}
$response->appendHeader('Content-Security-Policy', implode('; ', $header));
$this->tempHeaders = [];
}
if ($this->reportOnlyHeaders !== []) {
$header = [];