Proxy Support¶

    $ENV{HTTPS_PROXY} = 'http://proxy_hostname_or_ip:port';

Proxy Basic Authentication¶

    $ENV{HTTPS_PROXY_USERNAME} = 'username';
    $ENV{HTTPS_PROXY_PASSWORD} = 'password';

SSL diagnostics and Debugging¶

    $ENV{HTTPS_DEBUG} = 1;

Default SSL Version¶

    $ENV{HTTPS_VERSION} = '3';

Client Certificate Support¶

    $ENV{HTTPS_CERT_FILE} = 'certs/notacacert.pem';
    $ENV{HTTPS_KEY_FILE}  = 'certs/notacakeynopass.pem';

CA cert Peer Verification¶

    $ENV{HTTPS_CA_FILE}   = 'certs/ca-bundle.crt';
    $ENV{HTTPS_CA_DIR}    = 'certs/';

Client PKCS12 cert support¶

    $ENV{HTTPS_PKCS12_FILE}     = 'certs/pkcs12.pkcs12';
    $ENV{HTTPS_PKCS12_PASSWORD} = 'PKCS12_PASSWORD';

OpenSSL¶

You must have OpenSSL installed before compiling this module. You can get the latest OpenSSL package from <http://www.openssl.org/>. We no longer support pre-2000 versions of OpenSSL.

If you are building OpenSSL from source, please follow the directions included in the package.

If you are going to use an OpenSSL library which you built from source or whose header and library files are not in a place searched by your compiler by default, make sure you set appropriate environment variables before trying to build "Crypt::SSLeay".

For example, if you are using ActiveState Perl and MinGW installed using ppm, and you installed OpenSSL in "C:\opt\openssl-1.0.1c", then you would issue the following commands to build "Crypt::SSLeay":

    C:\...\> set LIBRARY_PATH=C:\opt\openssl-1.0.1c\lib;%LIBRARY_PATH%
    C:\...\> set CPATH=C:\opt\openssl-1.0.1c\include;%CPATH%
    C:\...\> perl Makefile.PL --live-tests
    C:\...\> dmake test

On Linux/BSD/Solaris/GNU etc systems, you would use make rather than dmake, but you would need to set the same variables if your OpenSSL library is in a custom location. If everything builds OK, but you get failures when during tests, ensure that "LD_LIBRARY_PATH" points to the location where the correct shared libraries are located.

If you are using a Microsoft compiler (keep in mind that perl and OpenSSL need to have been built using the same compiler as well), you would use:

    C:\...\> set LIB=C:\opt\openssl-1.0.1c\lib;%LIB%
    C:\...\> set INCLUDE=C:\opt\openssl-1.0.1c\include;%INCLUDE%
    C:\...\> perl Makefile.PL --live-tests
    C:\...\> nmake test

Depending on your OS, pre-built OpenSSL packages may be available. You may need to install a development version of your operating system's OpenSSL library package. The key is that "Crypt::SSLeay" makes calls to the OpenSSL library, and how to do so is specified in the C header files that come with the library. Some systems break out the header files into a separate package from that of the libraries. Once the program has been built, you don't need the headers any more.

Crypt::SSLeay¶

The latest Crypt::SSLeay can be found at your nearest CPAN, as well as <http://search.cpan.org/dist/Crypt-SSLeay/>.

Once you have downloaded it, "Crypt::SSLeay" installs easily using the standard build process:

    perl Makefile.PL
    make
    make test
    make install

On Windows systems, both Strawberry Perl and ActiveState (as a separate download via ppm) projects include a MingW based compiler distribution and dmake which can be used to build both OpenSSL and "Crypt::SSLeay". If you have such a set up, use dmake above.

Makefile.PL takes two optional arguments:

"--live-tests"

Boolean. Specifies whether we should try to connect to an HTTPS URL during testing. Default is false.

To skip live tests, you can use

    perl Makefile.PL --no-live-tests
    

and to force live tests, you can use

    perl Makefile.PL --live-tests
    

"--static"

Boolean. Default is false. (TODO: Does it work?)

For unattended (batch) installations, to be absolutely certain that Makefile.PL does not prompt for questions on STDIN, set the environment variable "PERL_MM_USE_DEFAULT=1" as with any CPAN module built using ExtUtils::MakeMaker.

Windows

"Crypt::SSLeay" builds correctly with Strawberry Perl and ActiveState Perl using the bundled MinGW.

For ActiveState Perl users, the ActiveState company does not have a permit from the Canadian Federal Government to distribute cryptographic software. This prevents "Crypt::SSLeay" from being distributed as a PPM package from their repository.

See <http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html#crypto_packages> for more information on this issue. You may be able to download a PPM for "Crypt::SSLeay" from an alternative repository (see PPM::Repositories).

VMS

I do not have any experience with VMS. If OpenSSL headers and libraries are not in standard locations searched by your build system by default, please set things up so that they are. If you have generic instructions on how to do it, please open a ticket on RT with the information so I can add it to this document.

LWP::UserAgent proxy support¶

"LWP::UserAgent" has its own methods of proxying which may work for you and is likely to be incompatible with "Crypt::SSLeay" proxy support. To use "LWP::UserAgent" proxy support, try something like:

    my $ua = LWP::UserAgent->new;
    $ua->proxy([qw( https http )], "$proxy_ip:$proxy_port");

At the time of this writing, libwww v5.6 seems to proxy https requests fine with an Apache mod_proxy server. It sends a line like:

    GET https://www.example.com HTTP/1.1

to the proxy server, which is not the "CONNECT" request that some proxies would expect, so this may not work with other proxy servers than mod_proxy. The "CONNECT" method is used by "Crypt::SSLeay"'s internal proxy support.

Crypt::SSLeay proxy support¶

For native "Crypt::SSLeay" proxy support of https requests, you need to set the environment variable "HTTPS_PROXY" to your proxy server and port, as in:

    # proxy support
    $ENV{HTTPS_PROXY} = 'http://proxy_hostname_or_ip:port';
    $ENV{HTTPS_PROXY} = '127.0.0.1:8080';

Use of the "HTTPS_PROXY" environment variable in this way is similar to "LWP::UserAgent-"env_proxy()> usage, but calling that method will likely override or break the "Crypt::SSLeay" support, so do not mix the two.

Basic auth credentials to the proxy server can be provided this way:

    # proxy_basic_auth
    $ENV{HTTPS_PROXY_USERNAME} = 'username';
    $ENV{HTTPS_PROXY_PASSWORD} = 'password';

For an example of LWP scripting with "Crypt::SSLeay" native proxy support, please look at the eg/lwp-ssl-test script in the "Crypt::SSLeay" distribution.

Creating a test certificate¶

To create simple test certificates with OpenSSL, you may run the following command:

    openssl req -config /usr/local/openssl/openssl.cnf \
        -new -days 365 -newkey rsa:1024 -x509 \
        -keyout notacakey.pem -out notacacert.pem

To remove the pass phrase from the key file, run:

    openssl rsa -in notacakey.pem -out notacakeynopass.pem

PKCS12 support¶

The directives for enabling use of PKCS12 certificates is:

    $ENV{HTTPS_PKCS12_FILE}     = 'certs/pkcs12.pkcs12';
    $ENV{HTTPS_PKCS12_PASSWORD} = 'PKCS12_PASSWORD';

Use of this type of certificate takes precedence over previous certificate settings described.

(TODO: unclear? Meaning "the presence of this type of certificate"?)