.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "SSL 3pm"
.TH SSL 3pm "2016-12-27" "perl v5.24.1" "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"
HTTP::Daemon::SSL \- a simple http server class with SSL support
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use HTTP::Daemon::SSL;
\&  use HTTP::Status;
\&
\&  # Make sure you have a certs/ directory with "server\-cert.pem"
\&  # and "server\-key.pem" in it before running this!
\&  my $d = HTTP::Daemon::SSL\->new || die;
\&  print "Please contact me at: <URL:", $d\->url, ">\en";
\&  while (my $c = $d\->accept) {
\&      while (my $r = $c\->get_request) {
\&          if ($r\->method eq \*(AqGET\*(Aq and $r\->url\->path eq "/xyzzy") {
\&              # remember, this is *not* recommened practice :\-)
\&              $c\->send_file_response("/etc/passwd");
\&          } else {
\&              $c\->send_error(RC_FORBIDDEN)
\&          }
\&      }
\&      $c\->close;
\&      undef($c);
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Instances of the \fIHTTP::Daemon::SSL\fR class are \s-1HTTP/1.1\s0 servers that
listen on a socket for incoming requests. The \fIHTTP::Daemon::SSL\fR is a
sub-class of \fIIO::Socket::SSL\fR, so you can perform socket operations
directly on it too.
.PP
The \fIaccept()\fR method will return when a connection from a client is
available.  In a scalar context the returned value will be a reference
to a object of the \fIHTTP::Daemon::ClientConn::SSL\fR class which is another
\&\fIIO::Socket::SSL\fR subclass.  In a list context a two-element array
is returned containing the new \fIHTTP::Daemon::ClientConn::SSL\fR reference
and the peer address; the list will be empty upon failure. (Note that version
 1.02 erroneously did not honour list context). Calling
the \fIget_request()\fR method on the \fIHTTP::Daemon::ClientConn::SSL\fR object
will read data from the client and return an \fIHTTP::Request\fR object
reference.
.PP
This \s-1HTTPS\s0 daemon does not \fIfork\fR\|(2) for you.  Your application, i.e. the
user of the \fIHTTP::Daemon::SSL\fR is reponsible for forking if that is
desirable.  Also note that the user is responsible for generating
responses that conform to the \s-1HTTP/1.1\s0 protocol.  The
\&\fIHTTP::Daemon::ClientConn\fR class provides some methods that make this easier.
.SH "METHODS"
.IX Header "METHODS"
The following methods are the only differences from the \fIHTTP::Daemon\fR base class:
.ie n .IP "$d = new HTTP::Daemon::SSL" 4
.el .IP "\f(CW$d\fR = new HTTP::Daemon::SSL" 4
.IX Item "$d = new HTTP::Daemon::SSL"
The constructor takes the same parameters as the
\&\fIIO::Socket::SSL\fR constructor.  It can also be called without specifying
any parameters, but you will have to make sure that you have an \s-1SSL\s0 certificate
and key for the server in \fIcerts/server\-cert.pem\fR and \fIcerts/server\-key.pem\fR.
See the IO::Socket::SSL documentation for how to change these default locations
and specify many other aspects of \s-1SSL\s0 behavior. The daemon will then set up a
listen queue of 5 connections and allocate some random port number.  A server
that wants to bind to some specific address on the standard \s-1HTTPS\s0 port will be
constructed like this:
.Sp
.Vb 3
\&  $d = new HTTP::Daemon::SSL
\&        LocalAddr => \*(Aqwww.someplace.com\*(Aq,
\&        LocalPort => 443;
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1RFC 2068\s0
.PP
IO::Socket::SSL, HTTP::Daemon, Apache
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Code and documentation from HTTP::Daemon Copyright 1996\-2001, Gisle Aas
Changes Copyright 2003\-2004, Peter Behroozi
.PP
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.