NAME

AppLib::CreateSelfSignedSSLCert - Create self-signed SSL certificate

VERSION

This document describes version 0.151 of AppLib::CreateSelfSignedSSLCert (from Perl distribution AppLib-CreateSelfSignedSSLCert), released on 2023-06-05.

SYNOPSIS

FUNCTIONS

create_self_signed_ssl_cert

Usage:

create_self_signed_ssl_cert(%args) -> [$status_code, $reason, $payload, \%result_meta]

Create self-signed SSL certificate.

This function is not exported.

Arguments ('*' denotes required arguments):

  • ca => str

    path to CA cert file.

  • ca_key => str

    path to CA key file.

  • csr_only => bool (default: 0)

    If set to 1 then will only generate .csr file.

    Can be useful if want to create .csr and submit it to a CA.

  • hostname* => str

    (No description)

  • interactive => bool (default: 0)

    (No description)

  • wildcard => bool (default: 0)

    If set to 1 then Common Name is set to *.hostname.

    Only when non-interactive

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

create_ssl_csr

Usage:

create_ssl_csr(%args) -> [$status_code, $reason, $payload, \%result_meta]

This function is not exported.

Arguments ('*' denotes required arguments):

  • hostname* => str

    (No description)

  • interactive => bool (default: 0)

    (No description)

  • wildcard => bool (default: 0)

    If set to 1 then Common Name is set to *.hostname.

    Only when non-interactive

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/AppLib-CreateSelfSignedSSLCert.

SOURCE

Source repository is at https://github.com/perlancar/perl-AppLib-CreateSelfSignedSSLCert.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2017 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=AppLib-CreateSelfSignedSSLCert

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.