.\" 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::SSLGlue::FTP 3pm"
.TH Net::SSLGlue::FTP 3pm "2022-12-06" "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::SSLGlue::FTP \- extend Net::FTP for FTPS (SSL) and IPv6
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&    use Net::SSLGlue::FTP;
\&    # SSL right from start
\&    my $ftps = Net::FTP\->new( $host,
\&        SSL => 1,
\&        SSL_ca_path => ...
\&    );
\&
\&    # SSL through upgrade of plain connection
\&    my $ftp = Net::FTP\->new( $host );
\&    $ftp\->starttls( SSL_ca_path => ... );
\&
\&    # change protection mode to unencrypted|encrypted
\&    $ftp\->prot(\*(AqC\*(Aq); # clear
\&    $ftp\->prot(\*(AqP\*(Aq); # protected
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Net::SSLGlue::FTP extends Net::FTP so one can either start directly with
\&\s-1SSL\s0 or switch later to \s-1SSL\s0 using starttls method (\s-1AUTH TLS\s0 command).
If IO::Socket::IP or IO::Socket::INET6 are installed it will also transparently
use IPv6.
.PP
By default it will take care to verify the certificate according to the rules
for \s-1FTP\s0 implemented in IO::Socket::SSL.
.SH "METHODS"
.IX Header "METHODS"
.IP "new" 4
.IX Item "new"
The method \f(CW\*(C`new\*(C'\fR of Net::FTP is now able to start directly with \s-1SSL\s0 when
the argument \f(CW\*(C`<SSL =\*(C'\fR 1>> is given. One can give the usual \f(CW\*(C`SSL_*\*(C'\fR parameter
of IO::Socket::SSL to \f(CW\*(C`Net::FTP::new\*(C'\fR.
.IP "starttls" 4
.IX Item "starttls"
If the connection is not yet SSLified it will issue the \*(L"\s-1AUTH TLS\*(R"\s0 command and
change the object, so that \s-1SSL\s0 will now be used.
.IP "peer_certificate ..." 4
.IX Item "peer_certificate ..."
Once the \s-1SSL\s0 connection is established you can use this method to get
information about the certificate. See the IO::Socket::SSL documentation.
.PP
All of these methods can take the \f(CW\*(C`SSL_*\*(C'\fR parameter from IO::Socket::SSL to
change the behavior of the \s-1SSL\s0 connection. The following parameters are
especially useful:
.IP "SSL_ca_path, SSL_ca_file" 4
.IX Item "SSL_ca_path, SSL_ca_file"
Specifies the path or a file where the CAs used for checking the certificates
are located. This is typically \*(L"etc/ssl/certs\*(R" on \s-1UNIX\s0 systems.
.IP "SSL_verify_mode" 4
.IX Item "SSL_verify_mode"
If set to 0, verification of the certificate will be disabled. By default
it is set to 1 which means that the peer certificate is checked.
.IP "SSL_verifycn_name" 4
.IX Item "SSL_verifycn_name"
Usually the name given as the hostname in the constructor is used to verify the
identity of the certificate. If you want to check the certificate against
another name you can specify it with this parameter.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
IO::Socket::SSL, Net::FTP, Net::SSLGlue::Socket
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This module is copyright (c) 2013, Steffen Ullrich.
All Rights Reserved.
This module is free software. It may be used, redistributed and/or modified
under the same terms as Perl itself.