/ 
Firefox-Marionette-1.60
River stage one • 1 direct dependent • 4 total dependents
/ Firefox::Marionette::Proxy

NAME

Firefox::Marionette::Proxy - Represents a Proxy used by Firefox Capabilities using the Marionette protocol

VERSION

Version 1.60

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));

DESCRIPTION

This module handles the implementation of a Proxy in Firefox Capabilities using the Marionette protocol

CONSTANTS

DEFAULT_SOCKS_VERSION

returns the default SOCKS version which is 5.

DEFAULT_SQUID_PORT

returns the default port that Squid listens on (3128)

SUBROUTINES/METHODS

new

accepts a hash as a parameter. Allowed keys are below;

  • type - indicates the type of proxy configuration. Must be one of 'pac', 'direct', 'autodetect', 'system', or 'manual'.

  • pac - defines the URI for a proxy auto-config file if the type is equal to 'pac'.

  • host - defines the host for FTP, HTTP, and HTTPS traffic and sets the type to 'manual'. If the port is not specified it defaults to DEFAULT_SQUID_PORT, which is 3128.

  • http - defines the proxy host for HTTP traffic when the type is 'manual'.

  • https - defines the proxy host for encrypted TLS traffic when the type is 'manual'.

  • none - lists the addresses for which the proxy should be bypassed when the type is 'manual'. This may be a list of domains, IPv4 addresses, or IPv6 addresses.

  • socks - defines the proxy host for a SOCKS proxy traffic when the type is 'manual'.

  • socks_version - defines the SOCKS proxy version when the type is 'manual'. It must be any integer between 0 and 255 inclusive, but it defaults to '5'.

  • tls - defines a pac function pointing to a TLS secured proxy for FTP, HTTP, and HTTPS traffic. This was derived from bug 378637

This method returns a new proxy object.

get_inline_pac

returns a proxy pac file for the parameters supplied to this function. This is only intended for internal use.

type

returns the type of proxy configuration. Must be one of 'pac', 'direct', 'autodetect', 'system', or 'manual'.

pac

returns the URI for a proxy auto-config file if the type is equal to 'pac'.

http

returns the proxy host for HTTP traffic when the type is 'manual'.

https

returns the proxy host for encrypted TLS traffic when the type is 'manual'.

none

returns a list of the addresses for which the proxy should be bypassed when the type is 'manual'. This may be a list of domains, IPv4 addresses, or IPv6 addresses.

socks

returns the proxy host for a SOCKS proxy traffic when the type is 'manual'.

socks_version

returns the SOCKS proxy version when the type is 'manual'.

SETTING UP SOCKS SERVERS USING SSH

You can setup a simple SOCKS proxy with ssh, using the -D option. 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   |
------------          ----------         ----------

DIAGNOSTICS

None.

CONFIGURATION AND ENVIRONMENT

Firefox::Marionette::Proxy requires no configuration files or environment variables.

DEPENDENCIES

None.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

To report a bug, or view the current list of bugs, please visit https://github.com/david-dick/firefox-marionette/issues

AUTHOR

David Dick <ddick@cpan.org>

LICENSE AND COPYRIGHT

Copyright (c) 2024, David Dick <ddick@cpan.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See "perlartistic" in perlartistic.

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.