CkPrivateKey C++ Reference Documentation

CkPrivateKey

Contains an RSA, DSA, or ECC private key. Provides methods for importing and exporting to/from PEM, DER, PKCS8, PKCS1, PVK, and XML formats. Private keys can be imported/exported to both memory and files.

Properties

int get_BitLength(void);

Introduced in version 9.5.0.49

The bit length (strength) of the private key.

void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);

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.

void get_KeyType(CkString &str);
const char *keyType(void);

Introduced in version 9.5.0.52

The type of private key. Can be "empty", "rsa", "dsa", or "ecc".

void get_LastErrorHtml(CkString &str);
const char *lastErrorHtml(void);

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.

void get_LastErrorText(CkString &str);
const char *lastErrorText(void);

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.

Concept of LastErrorText

LastErrorText Standard Information

void get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

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.

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

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.

void get_Pkcs8EncryptAlg(CkString &str);
const char *pkcs8EncryptAlg(void);
void put_Pkcs8EncryptAlg(const char *ansiOrUtf8Str);

Introduced in version 9.5.0.49

The encryption algorithm to be used when exporting the key to encrypted PKCS8. The default value is "3des". Possible choices also include "aes128", "aes192", and "aes256". All of the encryption algorithm choices use CBC mode.

bool get_Utf8(void);
void put_Utf8(bool newVal);

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

bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

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.

void get_Version(CkString &str);
const char *version(void);

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

Methods

bool GetJwk(CkString &outStr);
const char *getJwk(void);

Introduced in version 9.5.0.66

Gets the private key in JWK (JSON Web Key) format.

RSA keys have this JWK format:

         {"kty":"RSA",
          "n":"0vx7agoebGcQ ... JzKnqDKgw",
          "e":"AQAB",
          "d":"X4cTteJY_gn4F ... 4jfcKoAC8Q",
          "p":"83i-7IvMGXoMX ... vn7O0nVbfs",
          "q":"3dfOR9cuYq-0S ... 4vIcb6yelxk",
          "dp":"G4sPXkc6Ya9 ... 8YeiKkTiBj0",
          "dq":"s9lAH9fggBso ... w494Q_cgk",
          "qi":"GyM_p6JrXySi ... zTKhAVRU"}

ECC keys have this JWK format.

         {"kty":"EC",
          "crv":"P-256",
          "x":"MKBCTNIcKUSDii11ySs3526iDZ8AiTo7Tu6KPAqv7D4",
          "y":"4Etl6SRW2YiLUrN5vfvVHuhp7x8PxltmWWlbbM4IFyM",
          "d":"870MB6gfuTJ4HtUnUvYMyJpr5eUZNP4Bk43bVdj3eAE"}

Returns true for success, false for failure.

(C++) Get RSA Private Key in JWK Format (JSON Web Key)

(MFC) Get RSA Private Key in JWK Format (JSON Web Key)

(C++) Get ECC Private Key in JWK Format (JSON Web Key)

(MFC) Get ECC Private Key in JWK Format (JSON Web Key)

bool GetJwkThumbprint(const char *hashAlg, CkString &outStr);
const char *getJwkThumbprint(const char *hashAlg);

Introduced in version 9.5.0.66

Returns the JWK thumbprint for the private key. This is the thumbprint of the JSON Web Key (JWK) as per RFC 7638.

Returns true for success, false for failure.

(C++) Compute JWK Thumbprint for RSA and EC Private Keys

(MFC) Compute JWK Thumbprint for RSA and EC Private Keys

bool GetPkcs1(CkByteData &outBytes);

Introduced in version 9.5.0.58

Gets the private key in unencrypted binary DER format, preferring PKCS1 if possible.

RSA keys are returned in PKCS1 ASN.1 DER format:

RSAPrivateKey ::= SEQUENCE {
    version           Version,
    modulus           INTEGER,  -- n
    publicExponent    INTEGER,  -- e
    privateExponent   INTEGER,  -- d
    prime1            INTEGER,  -- p
    prime2            INTEGER,  -- q
    exponent1         INTEGER,  -- d mod (p-1)
    exponent2         INTEGER,  -- d mod (q-1)
    coefficient       INTEGER,  -- (inverse of q) mod p
    otherPrimeInfos   OtherPrimeInfos OPTIONAL
}

DSA keys are returned in this ASN.1 DER format:

SEQUENCE(6 elem)
    INTEGER 0
    INTEGER(2048 bit) (p) 
    INTEGER(160 bit) (q) 
    INTEGER(2044 bit) (g) 
    INTEGER(2040 bit) (y - public key) 
    INTEGER(156 bit) (x - private key) 

ECC keys are returned in this ASN.1 DER format:

(from RFC 5915)
ECPrivateKey ::= SEQUENCE {
    version        INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
    privateKey     OCTET STRING,
    parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
    publicKey  [1] BIT STRING OPTIONAL (This is the ANSI X9.63 public key format.)

Returns true for success, false for failure.

bool GetPkcs1ENC(const char *encoding, CkString &outStr);
const char *getPkcs1ENC(const char *encoding);

Introduced in version 9.5.0.52

Gets the private key in unencrypted binary DER format, preferring PKCS1 if possible, and returns in an encoded string, as specified by the encoding argument.

RSA keys are returned in PKCS1 ASN.1 DER format:

RSAPrivateKey ::= SEQUENCE {
    version           Version,
    modulus           INTEGER,  -- n
    publicExponent    INTEGER,  -- e
    privateExponent   INTEGER,  -- d
    prime1            INTEGER,  -- p
    prime2            INTEGER,  -- q
    exponent1         INTEGER,  -- d mod (p-1)
    exponent2         INTEGER,  -- d mod (q-1)
    coefficient       INTEGER,  -- (inverse of q) mod p
    otherPrimeInfos   OtherPrimeInfos OPTIONAL
}

DSA keys are returned in this ASN.1 DER format:

SEQUENCE(6 elem)
    INTEGER 0
    INTEGER(2048 bit) (p) 
    INTEGER(160 bit) (q) 
    INTEGER(2044 bit) (g) 
    INTEGER(2040 bit) (y - public key) 
    INTEGER(156 bit) (x - private key) 

ECC keys are returned in this ASN.1 DER format:

(from RFC 5915)
ECPrivateKey ::= SEQUENCE {
    version        INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
    privateKey     OCTET STRING,
    parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
    publicKey  [1] BIT STRING OPTIONAL (This is the ANSI X9.63 public key format.)

Returns true for success, false for failure.

Supported Binary Encodings

bool GetPkcs1Pem(CkString &outStr);
const char *getPkcs1Pem(void);

Introduced in version 9.5.0.58

Gets the private key in non-encrypted PEM format, preferring PKCS1 over PKCS8 if possible for the key type.

Returns true for success, false for failure.

bool GetPkcs8(CkByteData &outData);

Gets the private key in unencrypted PKCS8 format.

RSA keys are returned in PKCS8 ASN.1 DER format:

SEQUENCE                  // PrivateKeyInfo
+- INTEGER                // Version - 0 (v1998)
+- SEQUENCE               // AlgorithmIdentifier
   +- OID                 // 1.2.840.113549.1.1.1
   +- NULL                // Optional Parameters
+- OCTETSTRING            // PrivateKey
   +- SEQUENCE            // RSAPrivateKey
      +- INTEGER(0)       // Version - v1998(0)
      +- INTEGER(N)       // N
      +- INTEGER(E)       // E
      +- INTEGER(D)       // D
      +- INTEGER(P)       // P
      +- INTEGER(Q)       // Q
      +- INTEGER(DP)      // d mod p-1
      +- INTEGER(DQ)      // d mod q-1
      +- INTEGER(Inv Q)   // INV(q) mod p

DSA keys are returned in this ASN.1 DER format:

SEQUENCE                 // PrivateKeyInfo
+- INTEGER                 // Version
+- SEQUENCE              // AlgorithmIdentifier
    +- OID                       // 1.2.840.10040.4.1
    +- SEQUENCE           // DSS-Params (Optional Parameters)
	+- INTEGER(P)      // P
	+- INTEGER(Q)      // Q
	+- INTEGER(G)      // G
    +- OCTETSTRING             // PrivateKey
	+- INTEGER(X)      // DSAPrivateKey X

ECC keys are returned in this ASN.1 DER format:

(from RFC 5915)
ECPrivateKey ::= SEQUENCE {
    version        INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
    privateKey     OCTET STRING,
    parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
    publicKey  [1] BIT STRING OPTIONAL (This is the ANSI X9.63 public key format.)

Returns true for success, false for failure.

bool GetPkcs8ENC(const char *encoding, CkString &outStr);
const char *getPkcs8ENC(const char *encoding);

Introduced in version 9.5.0.52

Gets the private key in unencrypted PKCS8 format and returned in an encoded string, as specified by the encoding argument.

Returns true for success, false for failure.

Supported Binary Encodings

(C++) Generate RSA Key and return Base64 PKCS8 Private Key

(MFC) Generate RSA Key and return Base64 PKCS8 Private Key

bool GetPkcs8Encrypted(const char *password, CkByteData &outBytes);

Writes the private key to password-protected PKCS8 format. The Pkcs8EncryptAlg property controls the encryption algorithm used to encrypt.

Returns true for success, false for failure.

bool GetPkcs8EncryptedENC(const char *encoding, const char *password, CkString &outStr);
const char *getPkcs8EncryptedENC(const char *encoding, const char *password);

Introduced in version 9.5.0.52

Writes the private key to password-protected PKCS8 format and returns as an encoded string as specified by the encoding argument. The Pkcs8EncryptAlg property controls the encryption algorithm used to encrypt.

Returns true for success, false for failure.

Supported Binary Encodings

bool GetPkcs8EncryptedPem(const char *password, CkString &outStr);
const char *getPkcs8EncryptedPem(const char *password);

Writes the private key to password-protected PKCS8 PEM format. The Pkcs8EncryptAlg property controls the encryption algorithm used to encrypt.

Returns true for success, false for failure.

(C++) Generate RSA Key and Export to Encrypted PEM

(MFC) Generate RSA Key and Export to Encrypted PEM

bool GetPkcs8Pem(CkString &outStr);
const char *getPkcs8Pem(void);

Gets the private key in PKCS8 PEM format.

Returns true for success, false for failure.

CkPublicKey *GetPublicKey(void);

Introduced in version 9.5.0.52

Returns the public key portion of the private key as a public key object.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

(C++) Convert RSA Private Key to Public Key

(MFC) Convert RSA Private Key to Public Key

(C++) Get ECC Public Key from ECC Private Key

(MFC) Get ECC Public Key from ECC Private Key

bool GetRsaDer(CkByteData &outData);

This method is deprecated. It will be removed in a future version.

Gets the private key in PKCS1 DER format. This method is deprecated and is replaced by the GetPkcs1Der method (given that this object may contain a non-RSA key).

Returns true for success, false for failure.

bool GetRsaPem(CkString &outStr);
const char *getRsaPem(void);

This method is deprecated. It will be removed in a future version.

Gets the private key in PKCS1 PEM format. This method is deprecated and is replaced by the GetPkcs1Pem and GetPkcs8Pem methods (given that this object may contain a non-RSA key).

Returns true for success, false for failure.

bool GetXml(CkString &outStr);
const char *getXml(void);

Returns the private key in XML format. The private key is returned unencrypted and the parts are base64 encoded.

RSA keys have this XML format:

<RSAKeyValue>
  <Modulus>...</Modulus>
  <Exponent>...</Exponent>
  <P>...</P>
  <Q>...</Q>
  <DP>...</DP>
  <DQ>...</DQ>
  <InverseQ>...</InverseQ>
  <D>...</D>
</RSAKeyValue>

DSA keys have this XML format:

<DSAKeyValue>
	<P>...</P>
	<Q>...</Q>
	<G>...</G>
	<Y>...</Y>
	<X>...</X>
</DSAKeyValue>

ECC keys have this XML format. The CURVE_NAME could be one of secp256r1, secp384r1, secp521r1, secp256k1 (or others as new curves are supported.)

<ECCKeyValue curve="CURVE_NAME">...</ECCKeyValue>

Returns true for success, false for failure.

(C++) Get RSA Key Modulus from .cer or .key

(MFC) Get RSA Key Modulus from .cer or .key

bool LoadEncryptedPem(const char *pemStr, const char *password);

Loads the private key from an in-memory encrypted PEM string. An encrypted PEM contains the private key in encrypted PKCS#8 format, where the data begins and ends with the following tags:

-----BEGIN ENCRYPTED PRIVATE KEY-----
BASE64 ENCODED DATA
-----END ENCRYPTED PRIVATE KEY-----

For those requiring a deeper understanding: The base64 data contains ASN.1 DER with the following structure:

EncryptedPrivateKeyInfo ::= SEQUENCE {
  encryptionAlgorithm  EncryptionAlgorithmIdentifier,
  encryptedData        EncryptedData
}

EncryptionAlgorithmIdentifier ::= AlgorithmIdentifier

EncryptedData ::= OCTET STRING

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

(C++) Compute JWK Thumbprint for RSA and EC Private Keys

(MFC) Compute JWK Thumbprint for RSA and EC Private Keys

bool LoadEncryptedPemFile(const char *path, const char *password);

Loads a private key from an encrypted PEM file.

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

bool LoadJwk(const char *jsonStr);

Introduced in version 9.5.0.66

Loads a private key from an JWK (JSON Web Key) string.

RSA keys have this JWK format:

         {"kty":"RSA",
          "n":"0vx7agoebGcQ ... JzKnqDKgw",
          "e":"AQAB",
          "d":"X4cTteJY_gn4F ... 4jfcKoAC8Q",
          "p":"83i-7IvMGXoMX ... vn7O0nVbfs",
          "q":"3dfOR9cuYq-0S ... 4vIcb6yelxk",
          "dp":"G4sPXkc6Ya9 ... 8YeiKkTiBj0",
          "dq":"s9lAH9fggBso ... w494Q_cgk",
          "qi":"GyM_p6JrXySi ... zTKhAVRU"}

ECC keys have this JWK format.

         {"kty":"EC",
          "crv":"P-256",
          "x":"MKBCTNIcKUSDii11ySs3526iDZ8AiTo7Tu6KPAqv7D4",
          "y":"4Etl6SRW2YiLUrN5vfvVHuhp7x8PxltmWWlbbM4IFyM",
          "d":"870MB6gfuTJ4HtUnUvYMyJpr5eUZNP4Bk43bVdj3eAE"}

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

(C++) Load RSA Private Key from JWK Format (JSON Web Key)

(MFC) Load RSA Private Key from JWK Format (JSON Web Key)

(C++) Load ECC Private Key from JWK Format (JSON Web Key)

(MFC) Load ECC Private Key from JWK Format (JSON Web Key)

(C++) JWE using RSAES-OAEP and AES GCM

(MFC) JWE using RSAES-OAEP and AES GCM

bool LoadPem(const char *str);

Loads the private key from an in-memory PEM string. If the PEM contains an encrypted private key, then the LoadEncryptedPem method should instead be called. This method is for loading an unencrypted private key stored in PEM using PKCS#1 or PKCS#8.

A private key stored in PKCS#1 format begins and ends with the tags:

-----BEGIN RSA PRIVATE KEY-----
BASE64 ENCODED DATA
-----END RSA PRIVATE KEY-----

For those requiring a deeper understanding, the PKCS1 base64 contains ASN.1 in DER encoding with the following structure:

RSAPrivateKey ::= SEQUENCE {
  version           Version,
  modulus           INTEGER,  -- n
  publicExponent    INTEGER,  -- e
  privateExponent   INTEGER,  -- d
  prime1            INTEGER,  -- p
  prime2            INTEGER,  -- q
  exponent1         INTEGER,  -- d mod (p-1)
  exponent2         INTEGER,  -- d mod (q-1)
  coefficient       INTEGER,  -- (inverse of q) mod p
  otherPrimeInfos   OtherPrimeInfos OPTIONAL
}

A private key stored in PKCS#8 format begins and ends with the tags:

-----BEGIN PRIVATE KEY-----
BASE64 ENCODED DATA
-----END PRIVATE KEY-----

For those requiring a deeper understanding, the PKCS8 base64 contains ASN.1 in DER encoding with the following structure:

PrivateKeyInfo ::= SEQUENCE {
  version         Version,
  algorithm       AlgorithmIdentifier,
  PrivateKey      BIT STRING
}

AlgorithmIdentifier ::= SEQUENCE {
  algorithm       OBJECT IDENTIFIER,
  parameters      ANY DEFINED BY algorithm OPTIONAL
}

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

(C++) Compute JWK Thumbprint for RSA and EC Private Keys

(MFC) Compute JWK Thumbprint for RSA and EC Private Keys

bool LoadPemFile(const char *path);

Loads a private key from a PEM file.

Returns true for success, false for failure.

(C++) Create PKCS1 RSA Signature with PEM Private Key

(MFC) Create PKCS1 RSA Signature with PEM Private Key

bool LoadPkcs1(CkByteData &data);

Introduced in version 9.5.0.58

Loads an RSA, ECC, or DSA private key from binary DER.

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

bool LoadPkcs1File(const char *path);

Introduced in version 9.5.0.58

Loads a private key from a PKCS1 file.

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

bool LoadPkcs8(CkByteData &data);

Loads a private key from in-memory PKCS8 byte data.

For those requiring a deeper understanding, the PKCS8 contains ASN.1 in DER encoding with the following structure:

PrivateKeyInfo ::= SEQUENCE {
  version         Version,
  algorithm       AlgorithmIdentifier,
  PrivateKey      BIT STRING
}

AlgorithmIdentifier ::= SEQUENCE {
  algorithm       OBJECT IDENTIFIER,
  parameters      ANY DEFINED BY algorithm OPTIONAL
}

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

bool LoadPkcs8Encrypted(CkByteData &data, const char *password);

Loads a private key from in-memory password-protected PKCS8 byte data.

For those requiring a deeper understanding, the encrypted PKCS8 contains ASN.1 in DER encoding with the following structure:

EncryptedPrivateKeyInfo ::= SEQUENCE {
  encryptionAlgorithm  EncryptionAlgorithmIdentifier,
  encryptedData        EncryptedData
}

EncryptionAlgorithmIdentifier ::= AlgorithmIdentifier

EncryptedData ::= OCTET STRING

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

bool LoadPkcs8EncryptedFile(const char *path, const char *password);

Loads a private key from an encrypted PKCS8 file.

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

(C++) RSA Sign with PKCS8 Encrypted Key

(MFC) RSA Sign with PKCS8 Encrypted Key

bool LoadPkcs8File(const char *path);

Loads a private key from a PKCS8 file.

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

bool LoadPvk(CkByteData &data, const char *password);

Loads a private key from in-memory PVK byte data.

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

bool LoadPvkFile(const char *path, const char *password);

Loads a private key from a PVK format file.

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

bool LoadRsaDer(CkByteData &data);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Deprecated methods will be removed at some point in the future. Applications should instead call LoadPkcs1.

Loads a private key from in-memory RSA PKCS#1 DER byte data.

For those requiring a deeper understanding, the PKCS1 contains ASN.1 in DER encoding with the following structure:

RSAPrivateKey ::= SEQUENCE {
  version           Version,
  modulus           INTEGER,  -- n
  publicExponent    INTEGER,  -- e
  privateExponent   INTEGER,  -- d
  prime1            INTEGER,  -- p
  prime2            INTEGER,  -- q
  exponent1         INTEGER,  -- d mod (p-1)
  exponent2         INTEGER,  -- d mod (q-1)
  coefficient       INTEGER,  -- (inverse of q) mod p
  otherPrimeInfos   OtherPrimeInfos OPTIONAL
}

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

bool LoadRsaDerFile(const char *path);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Deprecated methods will be removed at some point in the future. Applications should instead call LoadPkcs1File.

Loads a private key from an RSA DER format file.

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

(C++) About RSA Public/Private Keys

(MFC) About RSA Public/Private Keys

bool LoadXml(const char *xml);

Loads a private key from an XML string.

RSA keys have this XML format:

<RSAKeyValue>
  <Modulus>...</Modulus>
  <Exponent>...</Exponent>
  <P>...</P>
  <Q>...</Q>
  <DP>...</DP>
  <DQ>...</DQ>
  <InverseQ>...</InverseQ>
  <D>...</D>
</RSAKeyValue>

DSA keys have this XML format:

<DSAKeyValue>
	<P>...</P>
	<Q>...</Q>
	<G>...</G>
	<Y>...</Y>
	<X>...</X>
</DSAKeyValue>

ECC keys have this XML format. The CURVE_NAME could be one of secp256r1, secp384r1, secp521r1, secp256k1 (or others as new curves are supported.)

<ECCKeyValue curve="CURVE_NAME">...</ECCKeyValue>

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

bool LoadXmlFile(const char *path);

Loads a private key from an XML file.

Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.

Returns true for success, false for failure.

bool SaveLastError(const char *path);

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

Returns true for success, false for failure.

bool SavePemFile(const char *path);

Introduced in version 9.5.0.58

Saves the private key to an unencrypted PKCS1 PEM format file.

Returns true for success, false for failure.

bool SavePkcs1File(const char *path);

Introduced in version 9.5.0.58

Saves the private key to an unencrypted binary PKCS1 format file.

Returns true for success, false for failure.

bool SavePkcs8EncryptedFile(const char *password, const char *path);

Saves the private key to a password-protected PKCS8 format file. The Pkcs8EncryptAlg property controls the encryption algorithm used to encrypt.

Returns true for success, false for failure.

bool SavePkcs8EncryptedPemFile(const char *password, const char *path);

Saves the private key to a password-protected PKCS8 PEM format file. The Pkcs8EncryptAlg property controls the encryption algorithm used to encrypt.

Returns true for success, false for failure.

bool SavePkcs8File(const char *path);

Saves the private key to an unencrypted binary PKCS8 format file.

Returns true for success, false for failure.

bool SavePkcs8PemFile(const char *path);

Saves the private key to a PKCS8 PEM format file.

Returns true for success, false for failure.

bool SaveRsaDerFile(const char *path);

This method is deprecated. It will be removed in a future version.

This method is deprecated and applications should instead call SavePkcs1File.

Saves the private key to a binary PKCS1 DER format file.

Returns true for success, false for failure.

bool SaveRsaPemFile(const char *path);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should instead call SavePemFile.

Saves the private key to a PKCS1 PEM format file.

Returns true for success, false for failure.

(C++) Generate RSA Public/Private Key Pair and Export to PEM

(MFC) Generate RSA Public/Private Key Pair and Export to PEM

bool SaveXmlFile(const char *path);

Saves the private key to an XML file.

Returns true for success, false for failure.