.\" 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 "Twiggy::TLS 3pm"
.TH Twiggy::TLS 3pm "2023-01-29" "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"
Twiggy::TLS \- Twiggy server with TLS support.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    twiggy \-\-server Twiggy::TLS \-\-tls\-key key.pem \-\-tls\-cert cert.pem
.Ve
.PP
See \*(L"\s-1ATTRIBUTES\*(R"\s0 for more details.
.PP
.Vb 1
\&    use Twiggy::Server::TLS;
\&
\&    my $server = Twiggy::Server::TLS\->new(
\&        host     => $host,
\&        port     => $port,
\&        tls_key  => $key_filename,
\&        tls_cert => $cert_filename
\&    );
\&    $server\->register_service($app);
\&
\&    AE::cv\->recv;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Twiggy::TLS extends Twiggy with a \s-1TLS\s0 support.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
All files must be in \s-1PEM\s0 format. You can merge multiply entities in a one file
(like server key and certificate).
.SS "tls_version"
.IX Subsection "tls_version"
Sets the version of the \s-1SSL\s0 protocol used to transmit data. The default is
\&\f(CW\*(C`SSLv23:!SSLv2\*(C'\fR. See \f(CW\*(C`SSL_version\*(C'\fR of IO::Socket::SSL for other values.
.SS "tls_ciphers"
.IX Subsection "tls_ciphers"
This directive describes the list of cipher suites the server supports for
establishing a secure connection. Cipher suites are specified in the OpenSSL
cipherlist format
<http://www.openssl.org/docs/apps/ciphers.html#CIPHER_STRINGS>.
.PP
The default is \f(CW\*(C`HIGH:!aNULL:!MD5\*(C'\fR.
.SS "tls_key"
.IX Subsection "tls_key"
Path to the server private key file.
.SS "tls_cert"
.IX Subsection "tls_cert"
Path to the server certificate file.
.SS "tls_verify"
.IX Subsection "tls_verify"
Controls the verification of the peer identity. Possible values are:
.ie n .IP """off""" 4
.el .IP "\f(CWoff\fR" 4
.IX Item "off"
Default. Disable peer verification.
.ie n .IP """on""" 4
.el .IP "\f(CWon\fR" 4
.IX Item "on"
Request peer certificate and verify it against \s-1CA.\s0 You can specify \s-1CA\s0
certificate with \f(CW\*(C`tls_ca\*(C'\fR option.
.ie n .IP """optional""" 4
.el .IP "\f(CWoptional\fR" 4
.IX Item "optional"
Same as \f(CW\*(C`on\*(C'\fR, but allows users that has not passed verification.
.SS "tls_ca"
.IX Subsection "tls_ca"
Path to file that contains \s-1CA\s0 certificate. Used for peer verification.
.SH "TLS INFORMATION"
.IX Header "TLS INFORMATION"
\&\s-1TLS\s0 connection information stored in the environment key \f(CW\*(C`psgi.tls\*(C'\fR, see
Twiggy::TLS::Info.
.SH "DEBUGGING"
.IX Header "DEBUGGING"
You can set the \f(CW\*(C`TWIGGY_DEBUG\*(C'\fR environment variable to get diagnostic
information.
.SH "LICENSE"
.IX Header "LICENSE"
This module is licensed under the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
Serhii Zasenko
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Twiggy