.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" 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 "Protocol::ACME::Challenge::SimpleSSH 3pm" .TH Protocol::ACME::Challenge::SimpleSSH 3pm "2018-05-18" "perl v5.26.2" "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" Protocol::ACME::Challenge::SimpleSSH \- Challenge handler for simpleHttp via SSH .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Protocol::ACME::Challenge::SimpleSSH; \& \& my $args = { \*(Aqwww_root\*(Aq => "/path/to/htdocs/or/equivalent", \& \*(Aqssh_host\*(Aq => "ssh.example.com" }; \& my $challenge = Protocol::ACME::Challenge::SimpleSSH\->new( $args ); .Ve .PP \&... .PP .Vb 1 \& $acme\->handle_challenge( $challenges\->{$domain} ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \f(CW\*(C`Protocol::ACME::Challenge::SimpleSSH\*(C'\fR class is a handler intended to be run when the \s-1ACME\s0 script is run on a different machine than the web server. It will create the challenge file in the designated location via \s-1SSH.\s0 Note that there is no attempt to escalate privleges so the location will need to be writabel by the ssh user. .SH "CONSTRUCTOR METHODS" .IX Header "CONSTRUCTOR METHODS" The following constructor methods are available: .ie n .IP "$acme = Protcol::ACME::Challenge::SimpleSSH\->new( %options )" 4 .el .IP "\f(CW$acme\fR = Protcol::ACME::Challenge::SimpleSSH\->new( \f(CW%options\fR )" 4 .IX Item "$acme = Protcol::ACME::Challenge::SimpleSSH->new( %options )" This method constructs a new \f(CW\*(C`Protocol::ACME::Challenge::SimpleSSH\*(C'\fR object and returns it. Key/value pair arguments may be provided to set up the initial state. The may be passed in as a hash or a hashref. The following options correspond to attribute methods described below. Items markes with a * are required. .Sp .Vb 5 \& KEY DEFAULT \& \-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \& *www_root Path to web root that will handle the HTTP \& challenge \& *ssh_host Hostname of the web server for ssh access .Ve .SS "\s-1METHODS\s0" .IX Subsection "METHODS" .ie n .IP "handle( $challenge, $fingerprint )" 4 .el .IP "handle( \f(CW$challenge\fR, \f(CW$fingerprint\fR )" 4 .IX Item "handle( $challenge, $fingerprint )" This is intended to be called indirectly via the \s-1ACME\s0 driver class. \&\f(CW\*(C`handle\*(C'\fR will take care of all of the conditions necessary to satisfy the challenge sent by Let's Encrypt. .IP "cleanup" 4 .IX Item "cleanup" \&\f(CW\*(C`cleanup\*(C'\fR will remove the challenge file. .SH "AUTHOR" .IX Header "AUTHOR" Stephen Ludin, \f(CW\*(C`\*(C'\fR .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \f(CW\*(C`bug\-protocol\-acme at rt.cpan.org\*(C'\fR, or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "ACKNOWLEDGEMENTS" .IX Header "ACKNOWLEDGEMENTS" .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright 2015 Stephen Ludin. .PP This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at: .PP .PP Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license. .PP If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license. .PP This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder. .PP This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed. .PP Disclaimer of Warranty: \s-1THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS\s0' \s-1AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR\s0 NON-INFRINGEMENT \s-1ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\s0