Need help with TrustedProxy?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

fideloper
7.0K Stars 93 Forks MIT License 230 Commits 23 Opened issues

Description

Laravel Proxy Package for handling sessions when behind load balancers or other intermediaries.

Services available

!
?

Need anything else?

Contributors list

# 24,038
Laravel
PHP
axios
Shell
67 commits
# 1,565
PHP
Laravel
Compose...
framewo...
34 commits
# 93,021
CSS
PHP
Laravel
facade
5 commits
# 273,412
PHP
5 commits
# 55
PHP
vuejs
Laravel
sns
4 commits
# 135,732
Atom
Symfony
excel
d3-modu...
3 commits
# 177,655
PHP
Laravel
Shell
HTML
3 commits
# 128,047
PHP
slug
Laravel
eloquen...
3 commits
# 38,539
front-e...
web-dev...
HTML
PHP
3 commits
# 25,321
dotfile...
macOS
PHP
Laravel
2 commits
# 350,547
PHP
2 commits
# 30,994
laravel...
php7
Nette
zend-fr...
1 commit
# 226,803
React
lightbo...
Redux
web-dev...
1 commit
# 192,068
PHP
Symfony
framewo...
cloudfl...
1 commit
# 248,384
PHP
HTML
Shell
Laravel
1 commit
# 182,519
PHP
Python
Laravel
eloquen...
1 commit
# 33,735
PHP
Laravel
eloquen...
Crystal
1 commit
# 6,812
PHP
Laravel
axios
shortco...
1 commit
# 9,422
PHP
Laravel
PHPUnit
phpstan
1 commit
# 2,104
PHP
CSS
Laravel
chatbot...
1 commit

Laravel Trusted Proxies

Build Status Total Downloads

Setting a trusted proxy allows for correct URL generation, redirecting, session handling and logging in Laravel when behind a reverse proxy such as a load balancer or cache.


Installation

Laravel 5.5+ comes with this package. If you are using Laravel 5.5 or greater, you do not need to add this to your project separately.

Laravel 5.0 - 5.4

To install Trusted Proxy, use:

composer require fideloper/proxy:^3.3

Laravel 4

composer require fideloper/proxy:^2.0

Setup

Refer to the docs above for using Trusted Proxy in Laravel 5.5+. For Laravel 4.0 - 5.4, refer to the wiki.

What Does This Do?

Setting a trusted proxy allows for correct URL generation, redirecting, session handling and logging in Laravel when behind a reverse proxy.

This is useful if your web servers sit behind a load balancer (Nginx, HAProxy, Envoy, ELB/ALB, etc), HTTP cache (CloudFlare, Squid, Varnish, etc), or other intermediary (reverse) proxy.

How Does This Work?

Applications behind a reverse proxy typically read some HTTP headers such as

X-Forwarded
,
X-Forwarded-For
,
X-Forwarded-Proto
(and more) to know about the real end-client making an HTTP request.

If those headers were not set, then the application code would think every incoming HTTP request would be from the proxy.

Laravel (technically the Symfony HTTP base classes) have a concept of a "trusted proxy", where those

X-Forwarded
headers will only be used if the source IP address of the request is known. In other words, it only trusts those headers if the proxy is trusted.

This package creates an easier interface to that option. You can set the IP addresses of the proxies (that the application would see, so it may be a private network IP address), and the Symfony HTTP classes will know to use the

X-Forwarded
headers if an HTTP requets containing those headers was from the trusted proxy.

Why Does This Matter?

A very common load balancing approach is to send

https://
requests to a load balancer, but send
http://
requests to the application servers behind the load balancer.

For example, you may send a request in your browser to

https://example.org
. The load balancer, in turn, might send requests to an application server at
http://192.168.1.23
.

What if that server returns a redirect, or generates an asset url? The users's browser would get back a redirect or HTML that includes

http://192.168.1.23
in it, which is clearly wrong.

What happens is that the application thinks its hostname is

192.168.1.23
and the schema is
http://
. It doesn't know that the end client used
https://example.org
for its web request.

So the application needs to know to read the

X-Forwarded
headers to get the correct request details (schema
https://
, host
example.org
).

Laravel/Symfony automatically reads those headers, but only if the trusted proxy configuration is set to "trust" the load balancer/reverse proxy.

Note: Many of us use hosted load balancers/proxies such as AWS ELB/ALB, etc. We don't know the IP address of those reverse proxies, and so you need to trusted all proxies in that case.

The trade-off there is running the security risk of allowing people to potentially spoof the

X-Forwarded
headers.

IP Addresses by Service

This Wiki page has a list of popular services and their IP addresses of their servers, if available. Any updates or suggestions are welcome!

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.