CkPfx Perl Reference Documentation

CkPfx

Current Version: 9.5.0.75

Provides the ability to manage, parse, and read PFX (PKCS12) files. To create PFX (PKCS12) files, use the certificate object's ExportToPfxFile or ExportToPfxData methods.

Object Creation

$obj = chilkat::CkPfx->new();

Properties

DebugLogFilePath
# $strVal is a string
# $ckStr is a CkString
$pfx->get_DebugLogFilePath($ckStr);
$strVal = $pfx->debugLogFilePath();
$pfx->put_DebugLogFilePath($strVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
# $strVal is a string
# $ckStr is a CkString
$pfx->get_LastErrorHtml($ckStr);
$strVal = $pfx->lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
# $strVal is a string
# $ckStr is a CkString
$pfx->get_LastErrorText($ckStr);
$strVal = $pfx->lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
# $strVal is a string
# $ckStr is a CkString
$pfx->get_LastErrorXml($ckStr);
$strVal = $pfx->lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
# $boolVal is a boolean
$boolVal = $pfx->get_LastMethodSuccess();
$pfx->put_LastMethodSuccess($boolVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumCerts
# $intVal is an integer
$intVal = $pfx->get_NumCerts();
Introduced in version 9.5.0.40

The number of certificates contained in the PFX.

top
NumPrivateKeys
# $intVal is an integer
$intVal = $pfx->get_NumPrivateKeys();
Introduced in version 9.5.0.40

The number of private keys contained in the PFX.

top
Utf8
# $boolVal is a boolean
$boolVal = $pfx->get_Utf8();
$pfx->put_Utf8($boolVal);

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
# $boolVal is a boolean
$boolVal = $pfx->get_VerboseLogging();
$pfx->put_VerboseLogging($boolVal);

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
# $strVal is a string
# $ckStr is a CkString
$pfx->get_Version($ckStr);
$strVal = $pfx->version();

Version of the component/library, such as "9.5.0.63"

top

Methods

AddCert
# $cert is a CkCert
# $includeChain is a boolean
$status = $pfx->AddCert($cert, $includeChain);
Introduced in version 9.5.0.44

Adds a certificate, its private key (if it exists), and potentially its certificate chain to the PFX. If includeChain is 1, then the certificate must have a private key. The certificate's private key is automatically obtained (internally) via the cert's ExportPrivateKey method. If the certificate's chain of authentication is to be added, it is automatically constructed and added using whatever resources are at hand (such as certs provided via the UseCertVault method, the trusted roots from Chilkat's TrustedRoots class, etc. If a certificate chain is to be added, which is the typical case, then the chain must be completed to the root to succeed.

Returns 1 for success, 0 for failure.

top
AddPrivateKey
# $privKey is a CkPrivateKey
# $certChain is a CkCertChain
$status = $pfx->AddPrivateKey($privKey, $certChain);
Introduced in version 9.5.0.44

Adds a private key and certificate chain to the PFX. The private key should be such that it is associated with the 1st certificate in the chain. In other words, the 1st certificate in the chain has a public key (embedded within the X.509 structure of the cert itself) that is the counterpart to the private key.

Returns 1 for success, 0 for failure.

top
GetCert
# returns a CkCert
# $index is an integer
$ret_cert = $pfx->GetCert($index);
Introduced in version 9.5.0.40

Returns the Nth certificate in the PFX. (The 1st certificate is at index 0.)

Returns null on failure

top
GetPrivateKey
# returns a CkPrivateKey
# $index is an integer
$ret_privateKey = $pfx->GetPrivateKey($index);
Introduced in version 9.5.0.40

Returns the Nth private key in the PFX. (The 1st private key is at index 0.)

Returns null on failure

top
LoadPem
# $pemStr is a string
# $password is a string
$status = $pfx->LoadPem($pemStr, $password);
Introduced in version 9.5.0.47

Loads a PFX from a PEM formatted string. The PEM can contain the private key, the certificate, and certificates in the chain of authentication up to the CA root. For example:

 -----BEGIN RSA PRIVATE KEY-----
...
... the private key associated with the main certificate.
...
-----END RSA PRIVATE KEY-----
-----BEGIN CERTIFICATE-----
...
... the main certificate
...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
...
... an intermediate CA certificate (if present)
...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
...
... the root CA certificate
...
-----END CERTIFICATE----- 

Returns 1 for success, 0 for failure.

top
LoadPfxBytes
# $pfxData is a CkByteData
# $password is a string
$status = $pfx->LoadPfxBytes($pfxData, $password);
Introduced in version 9.5.0.40

Loads a PFX from in-memory bytes.

If the .pfx/.p12 uses different passwords for integrity and private keys, then the password argument may contain JSON to specify the passwords. See the LoadPfxFile method (below) for details.

Returns 1 for success, 0 for failure.

top
LoadPfxEncoded
# $encodedData is a string
# $encoding is a string
# $password is a string
$status = $pfx->LoadPfxEncoded($encodedData, $encoding, $password);
Introduced in version 9.5.0.40

Loads a PFX from encoded byte data. The encoding can by any encoding, such as "Base64", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986".

If the .pfx/.p12 uses different passwords for integrity and private keys, then the encoding argument may contain JSON to specify the passwords. See the LoadPfxFile method (below) for details.

Returns 1 for success, 0 for failure.

top
LoadPfxFile
# $path is a string
# $password is a string
$status = $pfx->LoadPfxFile($path, $password);
Introduced in version 9.5.0.40

Loads a PFX from a file.

Starting in v9.5.0.75, a .pfx/.p12 file with different passwords for integrity and private keys can be loaded by passing the following JSON for the password.

    {
      "integrity": "password1",
      "privKeys": "password2",
     }
If it is desired to open the .pfx/.p12 without access to the private keys, then add "skipPrivateKeys" like this:
    {
      "integrity": "password1",
      "privKeys": "not used",
       "skipPrivateKeys": true
     }

Returns 1 for success, 0 for failure.

top
SaveLastError
# $path is a string
$status = $pfx->SaveLastError($path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

top
ToBinary
# $password is a string
# $outBytes is a CkByteData (output)
$status = $pfx->ToBinary($password, $outData);
Introduced in version 9.5.0.44

Write the PFX to in-memory bytes.

Returns 1 for success, 0 for failure.

top
ToEncodedString
# $password is a string
# $encoding is a string
# $outStr is a CkString (output)
$status = $pfx->ToEncodedString($password, $encoding, $outStr);
$retStr = $pfx->toEncodedString($password, $encoding);
Introduced in version 9.5.0.44

Write the PFX to an encoded string. The encoding can be any encoding such as "base64" or "hex".

Returns 1 for success, 0 for failure.

top
ToFile
# $password is a string
# $path is a string
$status = $pfx->ToFile($password, $path);
Introduced in version 9.5.0.44

Write the PFX to a file. PFX and PKCS12 are essentially the same. Standard filename extensions are ".pfx" or ".p12".

Returns 1 for success, 0 for failure.

top
ToJavaKeyStore
# returns a CkJavaKeyStore
# $alias is a string
# $password is a string
$ret_javaKeyStore = $pfx->ToJavaKeyStore($alias, $password);
Introduced in version 9.5.0.44

Converts the PFX (PKCS12) to a JavaKeyStore object. One JKS entry per private key found in the PKCS12 is added. The certs found within the PCKS12 are used to build the certificate chains for each private key. (A typical PFX file contains a single private key along with its associated certificate, and the certificates in the chain of authentication to the root CA cert.)

The specified alias is applied to the 1st private key found. If the alias is empty, then the alias is obtained from the cert/PFX in the following order of preference:

  1. Certificate's subject common name
  2. Certificate's subject email address
  3. Certificate's friendly name found in the PKCS9 attributes of the PKCS12
  4. Certificate's serial number

If multiple private keys are found in the PKCS12, then all but the first will automaticallly be assigned aliases using the preference just described.

Returns null on failure

top
ToPem
# $outStr is a CkString (output)
$status = $pfx->ToPem($outStr);
$retStr = $pfx->toPem();
Introduced in version 9.5.0.47

Write the PFX to a PEM formatted string. The resultant PEM will contain the private key, as well as the certs in the chain of authentication (or whatever certs are available in the PFX). For example:

 -----BEGIN RSA PRIVATE KEY-----
...
... the private key associated with the main certificate.
...
-----END RSA PRIVATE KEY-----
-----BEGIN CERTIFICATE-----
...
... the main certificate
...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
...
... an intermediate CA certificate (if present)
...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
...
... the root CA certificate
...
-----END CERTIFICATE----- 

Returns 1 for success, 0 for failure.

top
ToPemEx
# $extendedAttrs is a boolean
# $noKeys is a boolean
# $noCerts is a boolean
# $noCaCerts is a boolean
# $encryptAlg is a string
# $password is a string
# $outStr is a CkString (output)
$status = $pfx->ToPemEx($extendedAttrs, $noKeys, $noCerts, $noCaCerts, $encryptAlg, $password, $outStr);
$retStr = $pfx->toPemEx($extendedAttrs, $noKeys, $noCerts, $noCaCerts, $encryptAlg, $password);
Introduced in version 9.5.0.49

Write the PFX to a PEM formatted string. If extendedAttrs is 1, then extended properties (Bag Attributes and Key Attributes) are output. If noKeys is 1, then no private keys are output. If noCerts is 1, then no certificates are output. If noCaCerts is 1, then no CA certs or intermediate CA certs are output. If encryptAlg is not empty, it indicates the encryption algorithm to be used for encrypting the private keys (otherwise the private keys are output unencrypted). The possible choices for the encryptAlg are "des3", "aes128", "aes192", and "aes256". (All encryption algorithm choices use CBC mode.) If the private keys are to be encrypted, then password is the password to be used. Otherwise, password may be left empty. For example:

Bag Attributes
    Microsoft Local Key set: <No Values>
    localKeyID: 01 00 00 00 
    friendlyName: le-2b09a3d2-9037-4a05-95cc-4d44518e8607
    Microsoft CSP Name: Microsoft RSA SChannel Cryptographic Provider
Key Attributes
    X509v3 Key Usage: 10 
 -----BEGIN RSA PRIVATE KEY-----
...
... the private key associated with the main certificate.
...
-----END RSA PRIVATE KEY-----
Bag Attributes
    localKeyID: 01 00 00 00 
    1.3.6.1.4.1.311.17.3.92: 00 08 00 00 
    1.3.6.1.4.1.311.17.3.20: C2 53 54 F3 ...
    1.3.6.1.4.1.311.17.3.71: 49 00 43 00 ...
    1.3.6.1.4.1.311.17.3.75: 31 00 42 00 ...
subject=/OU=Domain Control Validated/OU=PositiveSSL/CN=something.com
issuer=/C=GB/ST=Greater Manchester/L=Salford/O=COMODO CA Limited/CN=COMODO RSA Domain Validation Secure Server CA
-----BEGIN CERTIFICATE-----
...
... the main certificate
...
-----END CERTIFICATE-----
...
-----BEGIN CERTIFICATE-----
...
... an intermediate CA certificate (if present)
...
-----END CERTIFICATE-----
...
-----BEGIN CERTIFICATE-----
...
... the root CA certificate
...
-----END CERTIFICATE----- 

Returns 1 for success, 0 for failure.

top
UseCertVault
# $vault is a CkXmlCertVault
$status = $pfx->UseCertVault($vault);
Introduced in version 9.5.0.44

Adds an XML certificate vault to the object's internal list of sources to be searched for certificates for help in building certificate chains to a root certificate.

Returns 1 for success, 0 for failure.

top