hyperia/yii2-secure-headers

Secure headers for your Yii2 app

2.3 2024-01-02 17:16 UTC

Requires

• php: >=7.2
• yiisoft/yii2: *

Requires (Dev)

• phpunit/phpunit: *
• symfony/var-dumper: *

MIT

• Lukas Hrdlicka
• Lukas Mestan

• extension
• headers
• secure
• yii2

README

Add security related headers to HTTP response. The package includes extension for easy Yii2 integration.

Installation

The preferred way to install this extension is through composer.

Either run

composer require hyperia/yii2-secure-headers:"^2.0"

or add

"hyperia/yii2-secure-headers": "^2.0"

to the require section of your composer.json.

Configuration (usage)

'bootstrap'  => [..., 'headers'],
'components' => [
    ...
    'headers' => [
        'class' => '\hyperia\security\Headers',
        'upgradeInsecureRequests' => true,
        'blockAllMixedContent' => true,
        'requireSriForScript' => false,
        'requireSriForStyle' => false,
        'xssProtection' => true,
        'contentTypeOptions' => true,
        'strictTransportSecurity' => [
            'max-age' => 10,
            'includeSubDomains' => true,
            'preload' => false
        ],
        'xFrameOptions' => 'DENY',
        'xPoweredBy' => 'Hyperia',
        'referrerPolicy' => 'no-referrer',
        'reportOnlyMode' => false
        'reportUri' => 'https://company.report-uri.com/r/d/csp/enforce',
        'reportTo' => [
            [
                'group' => 'groupName',
                'max_age' => 10886400,
                'endpoints' => [
                    [
                        'name' => 'endpointName',
                        'url' => 'https://example.com',
                        'failures' => 1
                    ]
                ]
            ]
        ]
        'cspDirectives' => [
            'connect-src' => "'self'",
            'font-src' => "'self'",
            'frame-src' => "'self'",
            'img-src' => "'self' data:",
            'manifest-src' => "'self'",
            'object-src' => "'self'",
            'prefetch-src' => false,
            'script-src' => "'self' 'unsafe-inline'",
            'style-src' => "'self' 'unsafe-inline'",
            'media-src' => "'self'",
            'form-action' => "'self'",
            'worker-src' => "'self'",
            'report-to' => 'groupname'
        ],
        // Deprecated. Use Permissions Policy instead.
        'featurePolicyDirectives' => [
            'accelerometer' => "'self'",
            'ambient-light-sensor' => "'self'",
            'autoplay' => "'self'",
            'battery' => "'self'",
            'camera' => "'self'",
            'display-capture' => "'self'",
            'document-domain' => "'self'",
            'encrypted-media' => "'self'",
            'fullscreen' => "'self'",
            'geolocation' => "'self'",
            'gyroscope' => "'self'",
            'layout-animations' => "'self'",
            'magnetometer' => "'self'",
            'microphone' => "'self'",
            'midi' => "'self'",
            'oversized-images' => "'self'",
            'payment' => "'self'",
            'picture-in-picture' => "*",
            'publickey-credentials-get' => "'self'",
            'sync-xhr' => "'self'",
            'usb' => "'self'",
            'wake-lock' => "'self'",
            'xr-spatial-tracking' => "'self'"
        ],
        'permissionsPolicyDirectives' => [
            'accelerometer' => "self",
            'ambient-light-sensor' => "self",
            'autoplay' => "self",
            'battery' => "self",
            'camera' => "self",
            'display-capture' => "self",
            'document-domain' => "self",
            'encrypted-media' => "self",
            'fullscreen' => "self",
            'geolocation' => "self",
            'gyroscope' => "self",
            'layout-animations' => "self",
            'magnetometer' => "self",
            'microphone' => "self",
            'midi' => "self",
            'oversized-images' => "self",
            'payment' => "self",
            'picture-in-picture' => "*",
            'publickey-credentials-get' => "self",
            'sync-xhr' => "self",
            'usb' => "self",
            'wake-lock' => "self",
            'xr-spatial-tracking' => "self"
        ]
    ]
]

Parameter description

Source Value	Example	Description
*	img-src *	Wildcard, allows any URL except data: blob: filesystem: schemes.
'none'	object-src 'none'	Prevents loading resources from any source.
'self'	script-src 'self'	Allows loading resources from the same origin (same scheme, host and port).
data:	img-src 'self' data:	Allows loading resources via the data scheme (eg Base64 encoded images).
domain.example.com	img-src domain.example.com	Allows loading resources from the specified domain name.
*.example.com	img-src *.example.com	Allows loading resources from any subdomain under example.com.
https://cdn.com	img-src https://cdn.com	Allows loading resources only over HTTPS matching the given domain.
https:	img-src https:	Allows loading resources only over HTTPS on any domain.
'unsafe-inline'	script-src 'unsafe-inline'	Allows use of inline source elements such as style attribute, onclick, or script tag bodies (depends on the context of the source it is applied to)
'unsafe-eval'	script-src 'unsafe-eval'	Allows unsafe dynamic code evaluation such as JavaScript eval()
false	prefetch-src false	Exclude the property from the directive array to avoid deprecated warning/error from browsers

Policy

Each header has a reference link in config file, you should read it if you do not know the header. If you want to disable a string type header, just set to null or empty string.

Content Security Policy

We use paragonie/csp-builder to help us support csp header. If you want to disable csp header, set custom-csp to empty string.

Subresource Integrity

If you want to require subresource integrity for style and script sources set requireSriForStyle and requireSriForScript to true

Feature Policy

Deprecated. Use Permissions Policy instead. Feature Policy is being created to allow site owners to enable and disable certain web platform features on their own pages and those they embed. Use same directives as for CSP

Permissions Policy

Permissions Policy is new policy which will replace Feature Policy

Additional Resources

Everything you need to know about HTTP security headers