Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samsonasik/forcehttpsmodule
:link: Configurable module for force https in your Zend Framework/Laminas Mvc and ZF Expressive/Mezzio Application.
https://github.com/samsonasik/forcehttpsmodule
force-https https laminas mezzio php psr-7 psr15 redirect redirector zend zf2 zf3-mvc
Last synced: about 1 month ago
JSON representation
:link: Configurable module for force https in your Zend Framework/Laminas Mvc and ZF Expressive/Mezzio Application.
- Host: GitHub
- URL: https://github.com/samsonasik/forcehttpsmodule
- Owner: samsonasik
- License: mit
- Created: 2017-01-17T16:46:43.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-14T02:32:27.000Z (almost 2 years ago)
- Last Synced: 2024-11-01T07:51:54.345Z (about 2 months ago)
- Topics: force-https, https, laminas, mezzio, php, psr-7, psr15, redirect, redirector, zend, zf2, zf3-mvc
- Language: PHP
- Homepage:
- Size: 306 KB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
ForceHttpsModule
================
[](https://github.com/samsonasik/ForceHttpsModule/releases)
[](https://codecov.io/gh/samsonasik/ForceHttpsModule)
[](https://github.com/phpstan/phpstan)
[](https://packagist.org/packages/samsonasik/force-https-module)
Introduction
------------
ForceHttpsModule is a configurable module for force https in your [Laminas Mvc](https://docs.laminas.dev/tutorials/) and [Mezzio](https://docs.mezzio.dev/mezzio/) Application.
> This is README for version ^4.1 which only support Laminas Mvc version 3 and Mezzio version 3 with php ^7.4|~8.0.
> For ~4.0.0, you can read at [version 4.0.x readme](https://github.com/samsonasik/ForceHttpsModule/blob/4.0.x/README.md) which only support Laminas Mvc version 3 and Mezzio version 3 with php ^7.3|~8.0
> For version ^3.0, you can read at [version 3 readme](https://github.com/samsonasik/ForceHttpsModule/tree/3.x.x) which only support Laminas Mvc version 3 and Mezzio version 3 with php ^7.1.
> For version ^2.0, you can read at [version 2 readme](https://github.com/samsonasik/ForceHttpsModule/tree/2.x.x) which only support ZF3 and ZF Expressive version 3 with php ^7.1.
> For version 1, you can read at [version 1 readme](https://github.com/samsonasik/ForceHttpsModule/tree/1.x.x) which still support ZF2 and ZF Expressive version 1 and 2 with php ^5.6|^7.0 support.
Features
--------
- [x] Enable/disable force https.
- [x] Force Https to All routes.
- [x] Force Https to All routes except exclusion list.
- [x] Force Https to specific routes only.
- [x] Keep headers, request method, and request body.
- [x] Enable/disable HTTP Strict Transport Security Header and set its value.
- [x] Allow add `www.` prefix during redirection from http or already https.
- [x] Allow remove `www.` prefix during redirection from http or already https.
- [x] Force Https for 404 pages
Installation
------------
**1. Require this module uses [composer](https://getcomposer.org/).**
```sh
composer require samsonasik/force-https-module
```
**2. Copy config**
***a. For [Laminas Mvc](https://docs.laminas.dev/tutorials/) application, copy `force-https-module.local.php.dist` config to your local's autoload and configure it***
| source | destination |
|------------------------------------------------------------------------------|---------------------------------------------|
| vendor/samsonasik/force-https-module/config/force-https-module.local.php.dist | config/autoload/force-https-module.local.php |
Or run copy command:
```sh
cp vendor/samsonasik/force-https-module/config/force-https-module.local.php.dist config/autoload/force-https-module.local.php
```
***b. For [Mezzio](https://docs.mezzio.dev/mezzio/) application, copy `mezzio-force-https-module.local.php.dist` config to your local's autoload and configure it***
| source | destination |
|------------------------------------------------------------------------------|---------------------------------------------|
| vendor/samsonasik/force-https-module/config/mezzio-force-https-module.local.php.dist | config/autoload/mezzio-force-https-module.local.php |
Or run copy command:
```sh
cp vendor/samsonasik/force-https-module/config/mezzio-force-https-module.local.php.dist config/autoload/mezzio-force-https-module.local.php
```
When done, you can modify your local config:
```php
[
'enable' => true,
'force_all_routes' => true,
'force_specific_routes' => [
// only works if previous's config 'force_all_routes' => false
'checkout',
'payment'
],
'exclude_specific_routes' => [
// a lists of specific routes to not be https
// only works if previous config 'force_all_routes' => true
'non-https-route',
],
// set HTTP Strict Transport Security Header
'strict_transport_security' => [
// set to false to disable it
'enable' => true,
'value' => 'max-age=31536000',
],
// set to true to add "www." prefix during redirection from http or already https
'add_www_prefix' => false,
// remove existing "www." prefix during redirection from http or already https
// only works if previous's config 'add_www_prefix' => false
'remove_www_prefix' => false,
// Force Https for 404 pages
'allow_404' => true,
],
// ...
];
```
**3. Lastly, enable it**
***a. For Laminas Mvc application***
```php
// config/modules.config.php or config/application.config.php
return [
'Application'
'ForceHttpsModule', // register here
],
```
***b. For Mezzio application***
For [mezzio-skeleton](https://github.com/mezzio/mezzio-skeleton) ^3.0, you need to open `config/pipeline.php` and add:
```php
$app->pipe(ForceHttpsModule\Middleware\ForceHttps::class);
```
at the very first pipeline records.
Contributing
------------
Contributions are very welcome. Please read [CONTRIBUTING.md](https://github.com/samsonasik/ForceHttpsModule/blob/master/CONTRIBUTING.md)