File Coverage

blib/lib/Perlbal/Plugin/XFFExtras.pm

Criterion	Covered	Total	%
statement	44	44	100.0
branch	4	8	50.0
condition	3	8	37.5
subroutine	11	11	100.0
pod	0	2	0.0
total	62	73	84.9

package Perlbal::Plugin::XFFExtras;

use strict;
use warnings;

use Danga::Socket 1.53;  # Need newer Danga::Socket than perlbal to have local_port
use Perlbal 1.74;        # is_ssl support was added in 1.74
use Perlbal::BackendHTTP ();
use Perlbal::Service ();

sub load {
    Perlbal::Service::add_tunable(
        send_backend_port => {
            check_role => 'reverse_proxy',
            des => "Send an X-Forwarded-Port header to backends to indicate the peer's remote address",
            check_type => 'bool',
            default => 0,
        }
    );
    Perlbal::Service::add_tunable(
        send_backend_proto => {
            check_role => 'reverse_proxy',
            des => "Send an X-Forwarded-Proto header to backends to indicate the peers connecting protocol",
            check_type => 'bool',
            default => 0,
        }
    );
}

# magical Perlbal hook return value constants
use constant HANDLE_REQUEST             => 0;
use constant IGNORE_REQUEST             => 1;

sub register {
    my ($class, $svc) = @_;

    my $cfg   = $svc->{extra_config}    ||= {};

    $svc->register_hook(XFFExtras => backend_client_assigned => sub {
        my Perlbal::BackendHTTP $be = shift;
        my $hds       = $be->{req_headers};
        my $client    = $be->{client};
        my $client_ip = $client->peer_ip_string;

        my $trusted = $svc->trusted_ip($client_ip);
        my $blind   = $svc->{blind_proxy};
        if (($trusted && !$blind) || !$trusted) {
            if ($cfg->{send_backend_port}) {
                # Danga::Socket has no accessor for the peer_port, so we break object
                # boundaries for now to implement this. Force to integer because D::S
                # also likes to store string error messages in this field too.
                $client->local_ip_string;
                my $local_port = $client->{local_port} + 0;
                $hds->header("X-Forwarded-Port", $local_port);
            }
            if ($cfg->{send_backend_proto}) {
                my $proto = $client->{is_ssl} ? 'https' : 'http';
                $hds->header("X-Forwarded-Proto", $proto);
            }
        }

        return HANDLE_REQUEST;
    });
}

1;

__END__