270 lines
7.7 KiB
Groff
270 lines
7.7 KiB
Groff
|
.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
|
||
|
|
.\"
|
||
|
|
.\" Standard preamble:
|
||
|
|
.\" ========================================================================
|
||
|
|
.de Sh \" Subsection heading
|
||
|
|
.br
|
||
|
|
.if t .Sp
|
||
|
|
.ne 5
|
||
|
|
.PP
|
||
|
|
\fB\\$1\fR
|
||
|
|
.PP
|
||
|
|
..
|
||
|
|
.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. | will give a
|
||
|
|
.\" real vertical bar. \*(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-|\(bv\*(Tr
|
||
|
|
.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" ''
|
||
|
|
'br\}
|
||
|
|
.\"
|
||
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
||
|
|
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
|
||
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
||
|
|
.\" output yourself in some meaningful fashion.
|
||
|
|
.if \nF \{\
|
||
|
|
. de IX
|
||
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
||
|
|
..
|
||
|
|
. nr % 0
|
||
|
|
. rr F
|
||
|
|
.\}
|
||
|
|
.\"
|
||
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
||
|
|
.\" way too many mistakes in technical documents.
|
||
|
|
.hy 0
|
||
|
|
.if n .na
|
||
|
|
.\"
|
||
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
||
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
||
|
|
. \" fudge factors for nroff and troff
|
||
|
|
.if n \{\
|
||
|
|
. ds #H 0
|
||
|
|
. ds #V .8m
|
||
|
|
. ds #F .3m
|
||
|
|
. ds #[ \f1
|
||
|
|
. ds #] \fP
|
||
|
|
.\}
|
||
|
|
.if t \{\
|
||
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
||
|
|
. ds #V .6m
|
||
|
|
. ds #F 0
|
||
|
|
. ds #[ \&
|
||
|
|
. ds #] \&
|
||
|
|
.\}
|
||
|
|
. \" simple accents for nroff and troff
|
||
|
|
.if n \{\
|
||
|
|
. ds ' \&
|
||
|
|
. ds ` \&
|
||
|
|
. ds ^ \&
|
||
|
|
. ds , \&
|
||
|
|
. ds ~ ~
|
||
|
|
. ds /
|
||
|
|
.\}
|
||
|
|
.if t \{\
|
||
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
||
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
||
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
||
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
||
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
||
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
||
|
|
.\}
|
||
|
|
. \" troff and (daisy-wheel) nroff accents
|
||
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
||
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
||
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
||
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
||
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
||
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
||
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
||
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
||
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
||
|
|
. \" corrections for vroff
|
||
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
||
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
||
|
|
. \" for low resolution devices (crt and lpr)
|
||
|
|
.if \n(.H>23 .if \n(.V>19 \
|
||
|
|
\{\
|
||
|
|
. ds : e
|
||
|
|
. ds 8 ss
|
||
|
|
. ds o a
|
||
|
|
. ds d- d\h'-1'\(ga
|
||
|
|
. ds D- D\h'-1'\(hy
|
||
|
|
. ds th \o'bp'
|
||
|
|
. ds Th \o'LP'
|
||
|
|
. ds ae ae
|
||
|
|
. ds Ae AE
|
||
|
|
.\}
|
||
|
|
.rm #[ #] #H #V #F C
|
||
|
|
.\" ========================================================================
|
||
|
|
.\"
|
||
|
|
.IX Title "Handle 3"
|
||
|
|
.TH Handle 3 "2002-06-07" "perl v5.8.0" "User Contributed Perl Documentation"
|
||
|
|
.SH "NAME"
|
||
|
|
Net::SSLeay::Handle \- Perl module that lets SSL (HTTPS) sockets be
|
||
|
|
handled as standard file handles.
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.IX Header "SYNOPSIS"
|
||
|
|
.Vb 2
|
||
|
|
\& use Net::SSLeay::Handle qw/shutdown/;
|
||
|
|
\& my ($host, $port) = ("localhost", 443);
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& tie(*SSL, "Net::SSLeay::Handle", $host, $port);
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
.Vb 4
|
||
|
|
\& print SSL "GET / HTTP/1.0\er\en";
|
||
|
|
\& shutdown(\e*SSL, 1);
|
||
|
|
\& print while (<SSL>);
|
||
|
|
\& close SSL;
|
||
|
|
.Ve
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.IX Header "DESCRIPTION"
|
||
|
|
Net::SSLeay::Handle allows you to request and receive \s-1HTTPS\s0 web pages
|
||
|
|
using \*(L"old\-fashion\*(R" file handles as in:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& print SSL "GET / HTTP/1.0\er\en";
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
and
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& print while (<SSL>);
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
If you export the shutdown routine, then the only extra code that
|
||
|
|
you need to add to your program is the tie function as in:
|
||
|
|
.PP
|
||
|
|
.Vb 9
|
||
|
|
\& my $socket;
|
||
|
|
\& if ($scheme eq "https") {
|
||
|
|
\& tie(*S2, "Net::SSLeay::Handle", host, $port);
|
||
|
|
\& $socket = \e*S2;
|
||
|
|
\& else {
|
||
|
|
\& $socket = Net::SSLeay::Handle->make_socket(host, $port);
|
||
|
|
\& }
|
||
|
|
\& print $socket $request_headers;
|
||
|
|
\& ...
|
||
|
|
.Ve
|
||
|
|
.Sh "\s-1USING\s0 \s-1EXISTING\s0 \s-1SOCKETS\s0"
|
||
|
|
.IX Subsection "USING EXISTING SOCKETS"
|
||
|
|
One of the motivations for writing this module was to avoid
|
||
|
|
duplicating socket creation code (which is mostly error handling).
|
||
|
|
The calls to \fItie()\fR above where it is passed a \f(CW$host\fR and \f(CW$port\fR is
|
||
|
|
provided for convenience testing. If you already have a socket
|
||
|
|
connected to the right host and port, S1, then you can do something
|
||
|
|
like:
|
||
|
|
.PP
|
||
|
|
.Vb 8
|
||
|
|
\& my $socket \e*S1;
|
||
|
|
\& if ($scheme eq "https") {
|
||
|
|
\& tie(*S2, "Net::SSLeay::Handle", $socket);
|
||
|
|
\& $socket = \e*S2;
|
||
|
|
\& }
|
||
|
|
\& my $last_sel = select($socket); $| = 1; select($last_sel);
|
||
|
|
\& print $socket $request_headers;
|
||
|
|
\& ...
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Note: As far as I know you must be careful with the globs in the \fItie()\fR
|
||
|
|
function. The first parameter must be a glob (*SOMETHING) and the
|
||
|
|
last parameter must be a reference to a glob (\e*SOMETHING_ELSE) or a
|
||
|
|
scaler that was assigned to a reference to a glob (as in the example
|
||
|
|
above)
|
||
|
|
.PP
|
||
|
|
Also, the two globs must be different. When I tried to use the same
|
||
|
|
glob, I got a core dump.
|
||
|
|
.Sh "\s-1EXPORT\s0"
|
||
|
|
.IX Subsection "EXPORT"
|
||
|
|
None by default.
|
||
|
|
.PP
|
||
|
|
You can export the \fIshutdown()\fR function.
|
||
|
|
.PP
|
||
|
|
It is suggested that you do export \fIshutdown()\fR or use the fully
|
||
|
|
qualified \fINet::SSLeay::Handle::shutdown()\fR function to shutdown \s-1SSL\s0
|
||
|
|
sockets. It should be smart enough to distinguish between \s-1SSL\s0 and
|
||
|
|
non-SSL sockets and do the right thing.
|
||
|
|
.SH "EXAMPLES"
|
||
|
|
.IX Header "EXAMPLES"
|
||
|
|
.Vb 2
|
||
|
|
\& use Net::SSLeay::Handle qw/shutdown/;
|
||
|
|
\& my ($host, $port) = ("localhost", 443);
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& tie(*SSL, "Net::SSLeay::Handle", $host, $port);
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
.Vb 4
|
||
|
|
\& print SSL "GET / HTTP/1.0\er\en";
|
||
|
|
\& shutdown(\e*SSL, 1);
|
||
|
|
\& print while (<SSL>);
|
||
|
|
\& close SSL;
|
||
|
|
.Ve
|
||
|
|
.SH "TODO"
|
||
|
|
.IX Header "TODO"
|
||
|
|
Better error handling. Callback routine?
|
||
|
|
.SH "CAVEATS"
|
||
|
|
.IX Header "CAVEATS"
|
||
|
|
Tying to a file handle is a little tricky (for me at least).
|
||
|
|
.PP
|
||
|
|
The first parameter to \fItie()\fR must be a glob (*SOMETHING) and the last
|
||
|
|
parameter must be a reference to a glob (\e*SOMETHING_ELSE) or a scaler
|
||
|
|
that was assigned to a reference to a glob ($s = \e*SOMETHING_ELSE).
|
||
|
|
Also, the two globs must be different. When I tried to use the same
|
||
|
|
glob, I got a core dump.
|
||
|
|
.PP
|
||
|
|
I was able to associate attributes to globs created by this module
|
||
|
|
(like *SSL above) by making a hash of hashes keyed by the file head1.
|
||
|
|
.PP
|
||
|
|
Support for old perls may not be 100%. If in trouble try 5.6.0 or
|
||
|
|
newer.
|
||
|
|
.SH "CHANGES"
|
||
|
|
.IX Header "CHANGES"
|
||
|
|
Please see Net\-SSLeay\-Handle\-0.50/Changes file.
|
||
|
|
.SH "KNOWN BUGS"
|
||
|
|
.IX Header "KNOWN BUGS"
|
||
|
|
If you let this module construct sockets for you with Perl versions
|
||
|
|
below v.5.6 then there is a slight memory leak. Other upgrade your
|
||
|
|
Perl, or create the sockets yourself. The leak was created to let
|
||
|
|
these older versions of Perl access more than one Handle at a time.
|
||
|
|
.SH "AUTHOR"
|
||
|
|
.IX Header "AUTHOR"
|
||
|
|
Jim Bowlin jbowlin@linklint.org
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.IX Header "SEE ALSO"
|
||
|
|
Net::SSLeay, \fIperl\fR\|(1), http://openssl.org/
|