Download the PHP package elhebert/laravel-sri without Composer
On this page you can find all versions of the php package elhebert/laravel-sri. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download elhebert/laravel-sri
More information about elhebert/laravel-sri
Files in elhebert/laravel-sri
Package laravel-sri
Short Description Subresource Integrity hash generator for laravel
License MIT
Informations about the package laravel-sri
Laravel Subresource Integrity
Small Laravel 8+ package that'll generate the integrity hashes for your style and script files.
For Laravel 5.5+ support, use the v1 branch. For Laravel 6+ support, use the v2 branch.
About Subresources Integrity
From MDN:
Subresource Integrity (SRI) is a security feature that enables browsers to verify that files they fetch (for example, from a CDN) are delivered without unexpected manipulation. It works by allowing you to provide a cryptographic hash that a fetched file must match.
Troy Hunt wrote an article speaking on the subject, you can read it here
Installation
This package uses auto-discovery, so you don't have to do anything. It works out of the box.
Config
If you want to make changes in the configuration you can publish the config file using
Content of the configuration
key | default value | possible values |
---|---|---|
base_path | base_path('/public') |
|
algorithm | sha256 | sha256, sha384 and sha512 |
hashes | [] |
(see "How to get a hash) |
mix_sri_path | public_path('mix-sri.json') |
(see "How to get a hash) |
enabled | true |
|
dangerously_allow_third_party_assets | false |
Usage
To only get a hash, use Sri::hash
:
To generate the HTML for the integrity
and the crossorigin
attributes, use Sri::html
. It accepts two parameters:
- first one is the path;
- second one (default is
false
) tells if you want to pass the credentials when fetching the resource.
Blade Component
Alternatively you can use blade components:
If you add a mix
attributet to the component it'll use mix()
instead of asset()
to generate the link to the assets:
Improve performance
You should wrap your <link>
and <script>
tags with the @once
directive to ensure that your tags are only rendered once. This will help with performances as it'll avoid a potential re-hashing of the files (in case you want to hash them on the fly).
Be careful that this should only be use for production as it won't re-render the html tag. Thus preventing new cache busting id to be added to the path by mix
.
How to get a hash
Store hashes in the configuration
You can references the assets in the configuration like this:
This means, you have to calculate the hashes yourself. To do this, you can use report-uri.io, mozilla hash generator or any other resource available.
Using a webpack (or Mix) plugin to generate hashes on build
It expect a mix-sri.json
file with a similar structure to the mix-manifest.json
:
The filename and path can be changed in the configuration at any time.
Self promotion: I made a Laravel Mix extension laravel-mix-sri for this purpose.
Generate them on the fly
If it can't find the asset hash in the config file nor in the mix-sri.json file, it'll generate the hash on each reload of the page.
This method is the least recommended, because it reduce performance and make your page load slower.
Remote resources
This package also work for remote resources. Be careful that resources like Google Fonts won't work.
Contributing
Please see CONTRIBUTING for more details.
License
This project and the Laravel framework are open-sourced software licensed under the MIT license.