Pfx C# WinRT Reference Documentation

Pfx

Current Version: 9.5.0.90

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

Chilkat.Pfx obj = new Chilkat.Pfx();

Properties

AlgorithmId

public string AlgorithmId {get; set; }

Introduced in version 9.5.0.83

The encryption algorithm to be used when writing a PFX. After loading a PFX, this property is set to the encryption algorithm used by the loaded PFX. (This is the algorithm used for the "shrouded key bag", which is internal to the PFX.)

The default value (for backward compatibility) is "pbeWithSHAAnd3_KeyTripleDES_CBC". Can be set to "pbes2", in which case the Pbes2CryptAlg and Pbes2HmacAlg properies will be set to the algorithms to be used when writing, or the algorithms used by the loaded PFX.

More Information and Examples

Rewrite PFX using AES256-SHA256

DebugLogFilePath

public string DebugLogFilePath {get; set; }

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:

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

LastErrorHtml

public string LastErrorHtml {get; }

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.

LastErrorText

public string LastErrorText {get; }

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

public string LastErrorXml {get; }

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.

LastMethodSuccess

public bool LastMethodSuccess {get; set; }

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false 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 = true and failure = false.
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 true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

NumCerts

public int NumCerts {get; }

Introduced in version 9.5.0.40

The number of certificates contained in the PFX.

NumPrivateKeys

public int NumPrivateKeys {get; }

Introduced in version 9.5.0.40

The number of private keys contained in the PFX.

Pbes2CryptAlg

public string Pbes2CryptAlg {get; set; }

Introduced in version 9.5.0.83

If the AlgorithmId property equals "pbes2", then this is the encryption algorithm to be used when writing the PFX, or used by the PFX that was loaded. If the AlgorithmId is not equal to "pbes2", then the value of this property is meaningless.

Possible values are:

aes256-cbc
aes192-cbc
aes128-cbc
3des-cbc

The default value (for writing) is "aes256-cbc". Note: The algorithm specified by this property is only used when the Algorithmid = "pbes2".

More Information and Examples

Rewrite PFX using AES256-SHA256

Pbes2HmacAlg

public string Pbes2HmacAlg {get; set; }

Introduced in version 9.5.0.83

If the AlgorithmId property equals "pbes2", then this is the HMAC hash algorithm to be used when writing the PFX, or used by the PFX that was loaded. If the AlgorithmId is not equal to "pbes2", then the value of this property is meaningless.

Possible values are:

hmacWithSha256
hmacWithSha384
hmacWithSha512
hmacWithSha1

The default value (for writing) is "hmacWithSha256". Note: The algorithm specified by this property is only used when the Algorithmid = "pbes2".

More Information and Examples

Rewrite PFX using AES256-SHA256

UncommonOptions

public string UncommonOptions {get; set; }

Introduced in version 9.5.0.83

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

Can be set to a list of the following comma separated keywords:

"LegacyOrder" - Introduced in v9.5.0.83. Write the internal ContentInfos in the order Chilkat traditionally used in previous versions.
"NoTruncatePfxPassword64" - Introduced in v9.5.0.87. Microsoft systems/tools such as certmgr.msc would typically truncate extremely long passwords to 64 bytes/chars. Other systems did not. Chilkat will by default truncate passwords to 64 chars. Add this keyword to prevent truncation.

VerboseLogging

public bool VerboseLogging {get; set; }

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

Version

public string Version {get; }

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

Methods

AddCert

public bool AddCert(Cert cert, bool 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 true, 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 true for success, false for failure.

AddPrivateKey

public bool AddPrivateKey(PrivateKey privKey, CertChain 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 true for success, false for failure.

More Information and Examples

Duplicate openssl pkcs12 –export –in certfile.cer –inkey certfile.key –out certfile.pfx

FindCertByLocalKeyId

public Cert FindCertByLocalKeyId(string localKeyId, string encoding);

Introduced in version 9.5.0.83

Finds and returns the certificate (in the PFX) that has a cert bag "localKeyId" attribute with the specified value. The localKeyId is specifid using the encoding (such as "decimal", "base64", "hex") specified by encoding.

Returns null on failure

GetCert

public Cert GetCert(int 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

GetPrivateKey

public PrivateKey GetPrivateKey(int 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

More Information and Examples

RSA Sign Using Private Key from .pfx/.p12 to Base64 Signature

GetSafeBagAttr

public string GetSafeBagAttr(bool forPrivateKey, int index, string attrName);

Introduced in version 9.5.0.83

Can be called to get one of the following safebag attributes for the Nth private key or certificate in the PFX. forPrivateKey should be true for a private key, and false for a certificate. The index is the index of the certificate or key in the PFX. The attrName can be one of the following:

"localKeyId" : Returns the decimal representation of the local key ID. The local key ID is used to associate the certificate contained in the PFX with this private key. (The certificate will include a "localKeyId" attribute in its cert bag of attributes within the PFX.)
"keyContainerName" : Returns the key container name (or key name) of the private key. For more information about the directories where the Windows OS stores private keys, see https://docs.microsoft.com/en-us/windows/win32/seccng/key-storage-and-retrieval
"storageProvider" : Returns the name of the Cryptographic Storage Provider to be used for the key.

Note: It is not required that any of the above attributes are present in the PFX.

Returns null on failure

More Information and Examples

Get a .pfx/.p12 Safe Bag Attribute

LastJsonData

public JsonObject LastJsonData();

Introduced in version 9.5.0.83

Provides information about what transpired in the last method called.

Returns null on failure

LoadPem

public bool LoadPem(string pemStr, string 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 true for success, false for failure.

More Information and Examples

Convert Let's Encrypt PEM Files to a PFX

LoadPfxBytes

public bool LoadPfxBytes(byte[] pfxData, string 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 true for success, false for failure.

LoadPfxEncoded

public bool LoadPfxEncoded(string encodedData, string encoding, string 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 true for success, false for failure.

More Information and Examples

List of Supported Encodings (Base64, Hex, etc.)Sign SOAP XML using a wsse:SecurityTokenReference Load PFX/P12 from a Base64 Encoded PFX File

LoadPfxFile

public bool LoadPfxFile(string path, string 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 true for success, false for failure.

More Information and Examples

RSA Sign Using Private Key from .pfx/.p12 to Base64 Signature Load PFX with Different Password for Private Keys

SetSafeBagAttr

public bool SetSafeBagAttr(bool forPrivateKey, int index, string name, string value, string encoding);

Introduced in version 9.5.0.83

Sets a safe bag attribute for the Nth private key or certificate in the PFX. Safe bag attributes can be added by calling this method once for each attribute to be added to each certificate or key. forPrivateKey should be true for a private key, and false for a certificate. The index is the index of the certificate or key in the PFX. (The 1st item is at index 0.) See the example below for more information. The encoding indicates a binary encoding such as "base64", "hex", "decimal", "fingerprint", etc if the value contains binary (non-text) data.

A safe bag attribute can be removed by passing an empty string for the value.

Returns true for success, false for failure.

More Information and Examples

Set .pfx/.p12 Safe Bag Attributes

ToBinary

public byte[] ToBinary(string password);

Introduced in version 9.5.0.44

Write the PFX to in-memory bytes.

Returns an empty byte array on failure

ToEncodedString

public string ToEncodedString(string password, string 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 null on failure

More Information and Examples

List of Supported Encodings (Base64, Hex, etc.)

ToFile

public bool ToFile(string password, string 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 true for success, false for failure.

More Information and Examples

Create .pfx/.p12 from Certificate and Private Key PEM Files

ToJavaKeyStore

public JavaKeyStore ToJavaKeyStore(string alias, string 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:

Certificate's subject common name
Certificate's subject email address
Certificate's friendly name found in the PKCS9 attributes of the PKCS12
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

More Information and Examples

Convert PFX to JWK Set Convert PKCS12 / PFX to Java Keystore (JKS)

ToPem

public string 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 null on failure

More Information and Examples

Convert PFX to PEM Convert PFX with ECC Private Key and Cert to PEM

ToPemEx

public string ToPemEx(bool extendedAttrs, bool noKeys, bool noCerts, bool noCaCerts, string encryptAlg, string password);

Introduced in version 9.5.0.49

Write the PFX to a PEM formatted string. If extendedAttrs is true, then extended properties (Bag Attributes and Key Attributes) are output. If noKeys is true, then no private keys are output. If noCerts is true, then no certificates are output. If noCaCerts is true, 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 null on failure

More Information and Examples

Convert PFX to Encrypted PEM Convert PFX with ECC Private Key and Cert to Encrypted PEM

UseCertVault

public bool UseCertVault(XmlCertVault 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 true for success, false for failure.