.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::Proxy::Connector::connect 3pm"
.TH Net::Proxy::Connector::connect 3pm "2023-06-26" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::Proxy::Connector::connect \- Create CONNECT tunnels through HTTP proxies
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    # sample proxy using Net::Proxy::Connector::tcp
\&    #                and Net::Proxy::Connector::connect
\&    use Net::Proxy;
\&
\&    # listen on localhost:6789
\&    # and proxy to remotehost:9876 through proxy.company.com:8080
\&    # using the given credentials
\&    my $proxy = Net::Proxy\->new(
\&        in  => { type => \*(Aqtcp\*(Aq, port => \*(Aq6789\*(Aq },
\&        out => {
\&            type        => \*(Aqconnect\*(Aq,
\&            host        => \*(Aqremotehost\*(Aq,
\&            port        => \*(Aq9876\*(Aq,
\&            proxy_host  => \*(Aqproxy.company.com\*(Aq,
\&            proxy_port  => \*(Aq8080\*(Aq,
\&            proxy_user  => \*(Aqjrandom\*(Aq,
\&            proxy_pass  => \*(Aqs3kr3t\*(Aq,
\&            proxy_agent => \*(AqMozilla/4.04 (X11; I; SunOS 5.4 sun4m)\*(Aq,
\&        },
\&    );
\&    $proxy\->register();
\&
\&    Net::Proxy\->mainloop();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Net::Proxy::Connecter::connect is a Net::Proxy::Connector that
uses the \s-1HTTP CONNECT\s0 method to ask the proxy to create a tunnel to
an outside server.
.PP
Be aware that some proxies are set up to deny the creation of some
outside tunnels (either to ports other than 443 or outside a specified
set of outside hosts).
.PP
This connector is only an \*(L"out\*(R" connector.
.SH "CONNECTOR OPTIONS"
.IX Header "CONNECTOR OPTIONS"
Net::Proxy::Connector::connect accepts the following options:
.ie n .SH """out"""
.el .SH "\f(CWout\fP"
.IX Header "out"
.IP "host" 4
.IX Item "host"
The destination host.
.IP "port" 4
.IX Item "port"
The destination port.
.IP "proxy_host" 4
.IX Item "proxy_host"
The web proxy name or address.
.IP "proxy_port" 4
.IX Item "proxy_port"
The web proxy port.
.IP "proxy_user" 4
.IX Item "proxy_user"
The authentication username for the proxy.
.IP "proxy_pass" 4
.IX Item "proxy_pass"
The authentication password for the proxy.
.IP "proxy_agent" 4
.IX Item "proxy_agent"
The user-agent string to use when connecting to the proxy.
.SH "AUTHOR"
.IX Header "AUTHOR"
Philippe 'BooK' Bruhat, \f(CW\*(C`<book@cpan.org>\*(C'\fR.
.SH "BUGS"
.IX Header "BUGS"
All the authentication schemes supported by \f(CW\*(C`LWP::UserAgent\*(C'\fR should be
supported (we use an \f(CW\*(C`LWP::UserAgent\*(C'\fR internally to contact the proxy).
.PP
This means we should also support \s-1NTLM,\s0 since it is supported as from
\&\f(CW\*(C`libwww\-perl\*(C'\fR 5.66. \f(CW\*(C`Net::Proxy::Connector::connect\*(C'\fR has not been
actually tested with \s-1NTLM,\s0 though. Any report of success or failure
with a \s-1NTLM\s0 proxy will be appreciated.
.SH "HISTORY"
.IX Header "HISTORY"
This module is based on my script \f(CW\*(C`connect\-tunnel\*(C'\fR, that provided
a command-line interface to create tunnels though \s-1HTTP\s0 proxies.
It was first published on \s-1CPAN\s0 on March 2003.
.PP
A better version of \f(CW\*(C`connect\-tunnel\*(C'\fR (using \f(CW\*(C`Net::Proxy\*(C'\fR) is provided
this distribution.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2006\-2014 Philippe 'BooK' Bruhat, All Rights Reserved.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.