Firefo...:Proxy(3pm)

📦
version 1.63 · 3 versions
, in debian trixie

💖 NAME 💖

Firefox::Marionette::Proxy — bestie, this lil module is the Representation of a Proxy that Firefox Capabilities uses when you're talking the Marionette protocol. It's the proxy glow-up your Firefox sesh has been waiting for ✨

🌸 VERSION 🌸

Version 1.63 — she's serving, she's current, she's iconic 💅

🦋 SYNOPSIS 🦋

okay so here's the vibe, no cap:

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

like, pick your fighter. three whole routes, all of them valid, all of them slaying 🎀

🧚 DESCRIPTION 🧚

This module handles the implementation of a Proxy in Firefox Capabilities using the Marionette protocol. that's it, that's the whole job, and she does it flawlessly — main character energy fr fr 👑

⭐ CONSTANTS ⭐

💜 DEFAULT_SOCKS_VERSION

returns the default SOCKS version, which is 5. five. that's the number. iconic number, honestly.

💜 DEFAULT_SQUID_PORT

returns the default port that Squid listens on (3128) — http://www.squid-cache.org/Doc/config/http_port/ — squid said "3128" and the world said "okay periodt" 🦑

✨ SUBROUTINES/METHODS ✨

🌈 new

accepts a hash as a parameter. the allowed keys are all right here, bestie, don't skip any:

  • 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 — https://bugzilla.mozilla.org/show_bug.cgi?id=378637 🐛

This method returns a new proxy object. fresh out the box, ready to serve 🫶

🌈 get_inline_pac

returns a proxy pac file for the parameters supplied to this function — https://developer.mozilla.org/en-US/docs/Web/HTTP/Proxy_servers_and_tunneling/Proxy_Auto-Configuration_PAC_file. This is only intended for internal use. so like, don't touch it unless you're the module itself, okay? 🙈

🌈 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 being https://en.wikipedia.org/wiki/SOCKS, iykyk 🧦

🌈 socks_version

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

🎀 SETTING UP SOCKS SERVERS USING SSH 🎀

bestie. BESTIE. listen. you can setup a simple SOCKS proxy with ssh — https://man.openbsd.org/ssh — using the -D option — https://man.openbsd.org/ssh#D. like the way that works is genuinely so clean, I'm obsessed 😭

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 — and yes she drew a whole diagram, she's an overachiever 💖

------------          ----------         ----------
| Firefox  |  SSH     | Remote |  HTTPS  | Target |
| & Perl   |--------->| Proxy  |-------->| Web    |
| run here |          | Server |         | Site   |
------------          ----------         ----------

traffic goes in one side, slays its way out the other. that's the whole plot 🦋

💀 DIAGNOSTICS 💀

None. nothing. silence. a peaceful, drama-free page 🙌

🧁 CONFIGURATION AND ENVIRONMENT 🧁

Firefox::Marionette::Proxy requires no configuration files or environment variables. zero setup, she just works, which honestly is such a green flag 🌸

🌟 DEPENDENCIES 🌟

None. she's self-sufficient. independent queen energy 👑

🙈 INCOMPATIBILITIES 🙈

None reported. nobody's beefing with her 🕊️

🔥 BUGS AND LIMITATIONS 🔥

To report a bug, or view the current list of bugs, please visit https://github.com/david-dick/firefox-marionette/issues — go be a good citizen and file that thing, bestie 🐞

💅 AUTHOR 💅

David Dick "ddick@cpan.org" — thank you for your service, king 🫶

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 👑

okay so legally we have to say this and we're saying it loud, all caps, no edits, no vibe-shifting because legal text is not the place for flair:

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 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.

translation: she's free, she's fun, she comes with no promises. use her wisely 💜

and that's the whole page, bestie!! this one was cooked up for perl v5.40.1 and stamped 2025-03-16 — go forth and proxy responsibly ✨🦋💖

📦 where this page comes from