GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
X509(3) User Contributed Perl Documentation X509(3)

Crypt::OpenSSL::X509 - Perl extension to OpenSSL's X509 API.

  use Crypt::OpenSSL::X509;

  my $x509 = Crypt::OpenSSL::X509->new_from_file('cert.pem');

  print $x509->pubkey() . "\n";
  print $x509->subject() . "\n";
  print $x509->hash() . "\n";
  print $x509->email() . "\n";
  print $x509->issuer() . "\n";
  print $x509->issuer_hash() . "\n";
  print $x509->notBefore() . "\n";
  print $x509->notAfter() . "\n";
  print $x509->modulus() . "\n";
  print $x509->exponent() . "\n";
  print $x509->fingerprint_md5() . "\n";
  print $x509->fingerprint_sha256() . "\n";
  print $x509->as_string() . "\n";

  my $x509 = Crypt::OpenSSL::X509->new_from_string(
    $der_encoded_data, Crypt::OpenSSL::X509::FORMAT_ASN1
  );

  # given a time offset of $seconds, will the certificate be valid?
  if ($x509->checkend($seconds)) {
    # cert is expired at $seconds offset
  } else {
    # cert is ok at $seconds offset
  }

  my $exts = $x509->extensions_by_oid();

  foreach my $oid (keys %$exts) {
    my $ext = $$exts{$oid};
    print $oid, " ", $ext->object()->name(), ": ", $ext->value(), "\n";
  }

  Crypt::OpenSSL::X509 - Perl extension to OpenSSL's X509 API.

  This implement a large majority of OpenSSL's useful X509 API.

  The email() method supports both certificates where the
  subject is of the form:
  "... CN=Firstname lastname/emailAddress=user@domain", and also
  certificates where there is a X509v3 Extension of the form
  "X509v3 Subject Alternative Name: email=user@domain".

None by default.

On request:

        FORMAT_UNDEF FORMAT_ASN1 FORMAT_TEXT FORMAT_PEM
        FORMAT_PKCS12 FORMAT_SMIME FORMAT_ENGINE FORMAT_IISSGC

new ( )
Create a new X509 object.
new_from_string ( STRING [ FORMAT ] )
new_from_file ( FILENAME [ FORMAT ] )
Create a new X509 object from a string or file. "FORMAT" should be "FORMAT_ASN1" or "FORMAT_PEM".

subject
Subject name as a string.
issuer
Issuer name as a string.
issuer_hash
Issuer name hash as a string.
serial
Serial number as a string.
hash
Alias for subject_hash
subject_hash
Subject name hash as a string.
notBefore
"notBefore" time as a string.
notAfter
"notAfter" time as a string.
email
Email addresses as string, if multiple addresses found, they are seperated by a space (' ').
version
Certificate version as a string.
sig_alg_name
Signature algorithm name as a string.
key_alg_name
Public key algorithm name as a string.
curve
Name of the EC curve used in the public key.

subject_name ( )
issuer_name ( )
Return a Name object for the subject or issuer name. Methods for handling Name objects are given below.
is_selfsigned ( )
Return Boolean value if subject and issuer name are the same.
as_string ( [ FORMAT ] )
Return the certificate as a string in the specified format. "FORMAT" can be one of "FORMAT_PEM" (the default) or "FORMAT_ASN1".
modulus ( )
Return the modulus for an RSA public key as a string of hex digits. For DSA and EC return the public key. Other algorithms are not supported.
bit_length ( )
Return the length of the modulus as a number of bits.
fingerprint_md5 ( )
fingerprint_sha1 ( )
fingerprint_sha224 ( )
fingerprint_sha256 ( )
fingerprint_sha384 ( )
fingerprint_sha512 ( )
Return the specified message digest for the certificate.
checkend( OFFSET )
Given an offset in seconds, will the certificate be expired? Returns True if the certificate will be expired. False otherwise.
pubkey ( )
Return the RSA, DSA, or EC public key.
num_extensions ( )
Return the number of extensions in the certificate.
extension ( INDEX )
Return the Extension specified by the integer "INDEX". Methods for handling Extension objects are given below.
extensions_by_oid ( )
extensions_by_name ( )
extensions_by_long_name ( )
Return a hash of Extensions indexed by OID or name.
has_extension_oid ( OID )
Return true if the certificate has the extension specified by "OID".

critical ( )
Return a value indicating if the extension is critical or not. FIXME: the value is an ASN.1 BOOLEAN value.
object ( )
Return the ObjectID of the extension. Methods for handling ObjectID objects are given below.
value ( )
Return the value of the extension as an asn1parse(1) style hex dump.
as_string ( )
Return a human-readable version of the extension as formatted by X509V3_EXT_print. Note that this will return an empty string for OIDs with unknown ASN.1 encodings.

name ( )
Return the long name of the object as a string.
oid ( )
Return the numeric dot-separated form of the object identifier as a string.

as_string ( )
Return a string representation of the Name
entries ( )
Return an array of Name_Entry objects. Methods for handling Name_Entry objects are given below.
has_entry ( TYPE [ LASTPOS ] )
has_long_entry ( TYPE [ LASTPOS ] )
has_oid_entry ( TYPE [ LASTPOS ] )
Return true if a name has an entry of the specified "TYPE". Depending on the function the "TYPE" may be in the short form (e.g. "CN"), long form ("commonName") or OID (2.5.4.3). If "LASTPOS" is specified then the search is made from that index rather than from the start.
get_index_by_type ( TYPE [ LASTPOS ] )
get_index_by_long_type ( TYPE [ LASTPOS ] )
get_index_by_oid_type ( TYPE [ LASTPOS ] )
Return the index of an entry of the specified "TYPE" in a name. Depending on the function the "TYPE" may be in the short form (e.g. "CN"), long form ("commonName") or OID (2.5.4.3). If "LASTPOS" is specified then the search is made from that index rather than from the start.
get_entry_by_type ( TYPE [ LASTPOS ] )
get_entry_by_long_type ( TYPE [ LASTPOS ] )
These methods work similarly to get_index_by_* but return the Name_Entry rather than the index.

as_string ( [ LONG ] )
Return a string representation of the Name_Entry of the form "typeName=Value". If "LONG" is 1, the long form of the type is used.
type ( [ LONG ] )
Return a string representation of the type of the Name_Entry. If "LONG" is 1, the long form of the type is used.
value ( )
Return a string representation of the value of the Name_Entry.
is_printableString ( )
is_ia5string ( )
is_utf8string ( )
is_asn1_type ( [ASN1_TYPE] )
Return true if the Name_Entry value is of the specified type. The value of "ASN1_TYPE" should be as listed in OpenSSL's "asn1.h".

OpenSSL(1), Crypt::OpenSSL::RSA, Crypt::OpenSSL::Bignum

Dan Sully

  • Timonthy Legge, release 1.9.10
  • Patrick Cernko, release 1.9.9
  • Shoichi Kaji, release 1.9.3 and 1.9.8
  • Neil Bowers, release 1.8.13
  • kmx, release 1.8.9
  • Sebastian Andrzej Siewior
  • David O'Callaghan, <david.ocallaghan@cs.tcd.ie>
  • Daniel Kahn Gillmor <dkg@fifthhorseman.net>

Copyright 2004-2021 by Dan Sully

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

2021-08-01 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.