package Firefox::Marionette::Proxy; use strict; use warnings; our $VERSION = '1.70'; sub DEFAULT_SOCKS_VERSION { return 5 } sub DEFAULT_SQUID_PORT { return 3128 } sub new { my ( $class, %parameters ) = @_; if ( $parameters{pac} ) { $parameters{pac} = "$parameters{pac}"; } elsif ( $parameters{host} ) { $parameters{type} = 'manual'; my $host = "$parameters{host}"; if ( $host !~ /:\d+$/smx ) { $host .= q[:] . DEFAULT_SQUID_PORT(); } $parameters{http} = $host; $parameters{https} = $host; } elsif ( $parameters{tls} ) { $parameters{pac} = $class->get_inline_pac( 'https://' . $parameters{tls} ); } else { if ( $parameters{socks} ) { $parameters{type} = 'manual'; if ( !defined $parameters{socks_version} ) { $parameters{socks_version} = DEFAULT_SOCKS_VERSION(); } } } my $element = bless {%parameters}, $class; return $element; } sub get_inline_pac { my ( $class, @proxies ) = @_; my $body = join q[;], map { ( uc $_->scheme() eq 'HTTP' ? 'PROXY' : uc $_->scheme() ) . q[ ] . $_->host_port() } map { URI->new($_) } @proxies; return qq[data:text/plain,function FindProxyForURL(){return "$body"}]; } sub type { my ($self) = @_; return $self->{type}; } sub pac { my ($self) = @_; return URI->new( $self->{pac} ); } sub ftp { my ($self) = @_; return $self->{ftp}; } sub http { my ($self) = @_; return $self->{http}; } sub none { my ($self) = @_; if ( defined $self->{none} ) { if ( ref $self->{none} ) { return @{ $self->{none} }; } else { return ( $self->{none} ); } } else { return (); } } sub https { my ($self) = @_; return $self->{https}; } sub socks { my ($self) = @_; return $self->{socks}; } sub socks_version { my ($self) = @_; return $self->{socks_version}; } 1; # Magic true value required at end of module __END__ =head1 NAME Firefox::Marionette::Proxy - Represents a Proxy used by Firefox Capabilities using the Marionette protocol =head1 VERSION Version 1.70 =head1 SYNOPSIS use Firefox::Marionette(); use v5.10; my $proxy = Firefox::Marionette::Proxy->new( pac => 'http://gateway.example.com/' ); my $firefox = Firefox::Marionette->new( capabilities => Firefox::Marionette::Capabilities->new( proxy => $proxy ) ); foreach my $address ($firefox->capabilities->proxy()->none()) { say "Browser will ignore the proxy for $address"; } # OR my $proxy = Firefox::Marionette::Proxy->new( host => 'squid.example.com:3128' ); my $firefox = Firefox::Marionette->new( capabilities => Firefox::Marionette::Capabilities->new( proxy => $proxy ) ); # OR my $proxy = Firefox::Marionette::Proxy->new( tls => "squid.example.org:443" ); my $firefox = Firefox::Marionette->new(capabilities => Firefox::Marionette::Capabilities->new(proxy => $proxy)); =head1 DESCRIPTION This module handles the implementation of a Proxy in Firefox Capabilities using the Marionette protocol =head1 CONSTANTS =head2 DEFAULT_SOCKS_VERSION returns the default SOCKS version which is 5. =head2 DEFAULT_SQUID_PORT returns the L =head1 SUBROUTINES/METHODS =head2 new accepts a hash as a parameter. Allowed keys are below; =over 4 =item * type - indicates the type of proxy configuration. Must be one of 'pac', 'direct', 'autodetect', 'system', or 'manual'. =item * pac - defines the L for a proxy auto-config file if the L is equal to 'pac'. =item * host - defines the host for FTP, HTTP, and HTTPS traffic and sets the L to 'manual'. If the port is not specified it defaults to L, which is 3128. =item * http - defines the proxy host for HTTP traffic when the L is 'manual'. =item * https - defines the proxy host for encrypted TLS traffic when the L is 'manual'. =item * none - lists the addresses for which the proxy should be bypassed when the L is 'manual'. This may be a list of domains, IPv4 addresses, or IPv6 addresses. =item * socks - defines the proxy host for a SOCKS proxy traffic when the L is 'manual'. =item * socks_version - defines the SOCKS proxy version when the L is 'manual'. It must be any integer between 0 and 255 inclusive, but it defaults to '5'. =item * tls - defines a L function pointing to a TLS secured proxy for FTP, HTTP, and HTTPS traffic. This was derived from L =back This method returns a new L object. =head2 get_inline_pac returns a L file for the parameters supplied to this function. This is only intended for internal use. =head2 type returns the type of proxy configuration. Must be one of 'pac', 'direct', 'autodetect', 'system', or 'manual'. =head2 pac returns the L for a proxy auto-config file if the L is equal to 'pac'. =head2 http returns the proxy host for HTTP traffic when the L is 'manual'. =head2 https returns the proxy host for encrypted TLS traffic when the L is 'manual'. =head2 none returns a list of the addresses for which the proxy should be bypassed when the L is 'manual'. This may be a list of domains, IPv4 addresses, or IPv6 addresses. =head2 socks returns the proxy host for a L proxy traffic when the L is 'manual'. =head2 socks_version returns the SOCKS proxy version when the L is 'manual'. =head1 SETTING UP SOCKS SERVERS USING SSH You can setup a simple SOCKS proxy with L, using the L<-D option|https://man.openbsd.org/ssh#D>. If you setup such a server with the following command ssh -ND localhost:8080 user@Remote.Proxy.Server and then connect to it like so; my $firefox = Firefox::Marionette->new( proxy => Firefox::Marionette::Proxy->new(socks => 'localhost:8080') )->go('https://Target.Web.Site'); the following network diagram describes what will happen ------------ ---------- ---------- | Firefox | SSH | Remote | HTTPS | Target | | & Perl |--------->| Proxy |-------->| Web | | run here | | Server | | Site | ------------ ---------- ---------- =head1 DIAGNOSTICS None. =head1 CONFIGURATION AND ENVIRONMENT Firefox::Marionette::Proxy requires no configuration files or environment variables. =head1 DEPENDENCIES None. =head1 INCOMPATIBILITIES None reported. =head1 BUGS AND LIMITATIONS To report a bug, or view the current list of bugs, please visit L =head1 AUTHOR David Dick C<< >> =head1 LICENSE AND COPYRIGHT Copyright (c) 2024, David Dick C<< >>. All rights reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See L. =head1 DISCLAIMER OF WARRANTY BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.