Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/acoshift/redirecthttps
Redirect HTTP to HTTPS middleware
https://github.com/acoshift/redirecthttps
golang middleware
Last synced: about 2 months ago
JSON representation
Redirect HTTP to HTTPS middleware
- Host: GitHub
- URL: https://github.com/acoshift/redirecthttps
- Owner: acoshift
- License: mit
- Created: 2017-08-07T04:15:17.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-11T05:45:23.000Z (over 7 years ago)
- Last Synced: 2024-06-21T17:00:03.556Z (7 months ago)
- Topics: golang, middleware
- Language: Go
- Homepage:
- Size: 18.6 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
RedirectHTTPS: HTTPS Redirection Middleware
A minimalistic middleware that redirects all network traffic from the insecure HTTP protocol to the HTTPS transport, all written in Go
[](https://goreportcard.com/report/github.com/acoshift/redirecthttps)
[](https://travis-ci.org/acoshift/redirecthttps)
[](https://coveralls.io/github/acoshift/redirecthttps?branch=master)
[](https://github.com/acoshift/redirecthttps/issues?q=is%3Aopen+is%3Aissue)
[](https://github.com/acoshift/redirecthttps/releases)
[](https://gitter.im/acoshift)
[]()
### Installation
`go get github.com/acoshift/redirecthttps`
### Usage Example
This middleware can be applied in the middleware chain, as follows:
```
middlewares := middleware.Chain(
// We can put our redirection middleware right here.
redirecthttps.New(redirecthttps.Config{
// The redirection mode can be specified below.
Mode: redirecthttps.OnlyProxy
}),
)
mux.Handle("/", middlewares(app.Handler()))
```
### Configuration: Redirection Modes
There are three redirection modes, which can be specified before instantiating the middleware.
First, the `OnlyConnectionState` Mode, which only checks the connection state from request.TLS, and perform the redirection if TLS is not present in the request.
Second, the `OnlyProxy` Mode, which only checks the X-Forwarded-Proto header from the request in order to determine if it's using plain HTTP or not. If so, perform the redirection.
Finally, the `All` Mode, which checks both the X-Forwarded-Proto Header AND the request.TLS variable.
### Contribution
If you found an issue in this library, please file file an issue at https://github.com/acoshift/redirecthttps/issues.
If you wanted to help improve this middleware, feel free to fork this project and submit a pull request through GitHub. Thanks!
### License
MIT License
Copyright (c) 2017 Thanatat Tamtan
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.