A. Sinan Ünür > OpenSSL-Versions > OpenSSL::Versions

Download:
OpenSSL-Versions-0.002.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.002   Source  

NAME ^

OpenSSL::Versions - Parse OpenSSL version number

VERSION ^

Version 0.001

SYNOPSIS ^

Parse OpenSSL version number from source code.

    use OpenSSL::Versions qw( parse_openssl_version_number );
    my $v = parse_openssl_version_number('0x0913');
    print "$v\n";

Outputs:

    0.9.1c

MOTIVATION ^

OpenSSL source code uses a hexadecimal number which encodes various bits of information. The meaning of various parts have changed over the history of the library. For example, you have

    #define OPENSSL_VERSION_NUMBER      0x0913  /* Version 0.9.1c is 0913 */

versus

    #define OPENSSL_VERSION_NUMBER      0x1000007fL /* OpenSSL 1.0.0g */

The evolution of the version number scheme is explained in the crypto/opensslv.h file in the distribution. If you have already built OpenSSL, you can determine its version by invoking the command line utility:

    $ openssl version
    OpenSSL 1.0.0g 18 Jan 2012

However, if all you have is the source code, and you want to determine exact version information on the basis of the string representation of the OPENSSL_VERSION_NUMBER macro, you have to use pattern matching and deal with a bunch of corner cases.

The Makefile.PL for Crypt::SSLeay contained a simplistic approach to parsing the value of OPENSSL_VERSION_NUMBER which people had tweaked over time to deal with changes. I added functions to deal with specific ranges of version numbers. But, I did not think those functions belonged in a Makefile.PL.

So, I put them in their own module. To test the routines, I downloaded all available versions of OpenSSL from http://www.openssl.org/source/ (excluding archives with 'fips' and 'engine' in their names, and built a mapping between the value of OPENSSL_VERSION_NUMBER in each archive and the corresponding human friendly version string in the name of the archive.

EXPORT ^

parse_openssl_version_number

By default, this module does not export anything. However, you can ask for parse_openssl_version_number to be exported.

SUBROUTINES ^

parse_openssl_version_number

Takes a hexadecimal string corresponding to the value of the macro OPENSSL_VERSION_NUMBER macro in either crypto.h or openssl/opensslv.h file in an OpenSSL distribution.

In scalar context returns a human friendly version string such as '0.9.8q'. In list context, it returns a pair of values the first of which is the human friendly version string and the second is either 'OpenSSL' or 'SSLeay'.

AUTHOR ^

A. Sinan Unur, <nanis at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-openssl-versions at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=OpenSSL-Versions. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc OpenSSL::Versions

You can also look for information at:

ACKNOWLEDGEMENTS ^

LICENSE AND COPYRIGHT ^

Copyright (c) 2012 A. Sinan Unur.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: