Protocol::ACME::Challenge::LocalFile(3pm)

Protocol::ACME::Challenge::LocalFile3pm

Challenge handler for simplehttp via a local file

Usage

 use Protocol::ACME::Challenge::LocalFile;
 my $args = { 'www_root' => "/path/to/htdocs/or/equivalent" };
 my $challenge = Protocol::ACME::Challenge::LocalFile->new( $args );

...

 $acme->handle_challenge( $challenges->{$domain} );

Overview

The "Protocol::ACME::Challenge::LocalFile" class is a handler intended to be run when the ACME script is run on the same local machine as the web server. This is a logical choice to use for self contained web server / Let's Encypt integration.

Constructor methods

The following constructor methods are available:

$acme = Protcol::ACME::Challenge::LocalFile->new( %options )

This method constructs a new "Protocol::ACME::Challenge::LocalFile" 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.

   KEY                     DEFAULT
   -----------             --------------------
   *www_root               path to web root that will handle the HTTP
                           challenge

Methods

handle( $challenge, $fingerprint )

This is intended to be called indirectly via the ACME driver class. "handle" will take care of all of the conditions necessary to satisfy the challenge sent by Let's Encrypt.

cleanup

"cleanup" will remove the challenge file.

Acknowledgements

Author

Stephen Ludin, "<sludin at ludin.org>"

Bugs

Please report any bugs or feature requests to "bug-protocol-acme at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Protocol-ACME-Challenge-LocalFile>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

From libprotocol-acme-perl 1.01-2 in Debian 9 (Stretch). Parsed by carta from the page's man source.