CkPublicKey C++ Reference Documentation

CkPublicKey

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

Properties

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.

int get_KeySize(void);

Introduced in version 9.5.0.67

Gets the size (in bits) of the public key. For example: 1024, 2048, etc.

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

Introduced in version 9.5.0.52

The type of public 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.

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 GetDer(bool preferPkcs1, CkByteData &outBytes);

Introduced in version 9.5.0.58

Returns the public key in binary DER format. If the key type (such as RSA) supports both PKCS1 and PKCS8 formats, then preferPkcs1 determine which format is returned.

Returns true for success, false for failure.

bool GetEncoded(bool preferPkcs1, const char *encoding, CkString &outStr);
const char *getEncoded(bool preferPkcs1, const char *encoding);

Introduced in version 9.5.0.58

Returns the public key in DER format as an encoded string (such as base64 or hex). If the key type (such as RSA) supports both PKCS1 and PKCS8 formats, then preferPkcs1 determine which format is returned. The encoding specifies the encoding, which is typically "base64".

Returns true for success, false for failure.

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

Introduced in version 9.5.0.66

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

RSA public keys have this JWK format:

         {"kty":"RSA",
          "n": "0vx7agoebGcQSuuPiLJXZptN9 ... U8awapJzKnqDKgw",
          "e":"AQAB"}

ECC public keys have this JWK format:

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

Returns true for success, false for failure.

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

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

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

(MFC) Get RSA Public 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 public 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 Public Keys

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

bool GetOpenSslDer(CkByteData &outData);

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

This method is deprecated. Applications should call GetDer with preference for PKCS8 instead.

Gets the public key in PKCS8 DER format.

Returns true for success, false for failure.

bool GetOpenSslPem(CkString &outStr);
const char *getOpenSslPem(void);

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

This method is deprecated. Applications should call GetPem with preference for PKCS8 instead.

Gets the public key in PKCS8 PEM format.

Returns true for success, false for failure.

bool GetPem(bool preferPkcs1, CkString &outStr);
const char *getPem(bool preferPkcs1);

Introduced in version 9.5.0.58

Returns the public key in PEM format. If the key type (such as RSA) supports both PKCS1 and PKCS8 formats, then preferPkcs1 determine which format is returned.

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
This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call GetEncoded with preference for PKCS1 instead.

Gets the public key in PKCS1 format and returns in an encoded string, as specified by the encoding argument.

Returns true for success, false for failure.

Supported Binary Encodings

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

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

This method is deprecated. Applications should call GetEncoded with preference for PKCS8 instead.

Gets the public key in PKCS8 format and returns in an encoded string, as specified by the encoding argument.

Returns true for success, false for failure.

Supported Binary Encodings

bool GetRsaDer(CkByteData &outData);

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

This method is deprecated. Applications should call GetDer with preference for PKCS1 instead.

Gets the public key in PKCS1 DER format.

Returns true for success, false for failure.

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

Gets the public key in XML format. The format depends on the key type. The key parts indicated by "..." are base64 encoded.

RSA public keys have this XML format:

<RSAKeyValue>
  <Modulus>...</Modulus>
  <Exponent>...</Exponent>
</RSAKeyValue>

DSA public keys have this XML format:

<DSAPublicKey>
    <P>...</P>
    <Q>...</Q>
    <G>...</G>
    <Y>...</Y>
</DSAPublicKey>

ECC public keys have this XML format:

<ECCPublicKey curve="CURVE_NAME" x="HEX_DATA" y="HEX_DATA">...</ECCPublicKey>

Returns true for success, false for failure.

bool LoadBase64(const char *keyStr);

Introduced in version 9.5.0.47

Loads a public key from base64-encoded DER (can be PKCS1 or PKCS8).

Returns true for success, false for failure.

bool LoadFromBinary(CkByteData &keyBytes);

Introduced in version 9.5.0.58

Loads a public key from binary DER. Auto-recognizes both PKCS1 and PKCS8 formats.

Returns true for success, false for failure.

bool LoadFromFile(const char *path);

Introduced in version 9.5.0.58

Loads a public key from a file. The file can be in any string or binary format such as binary DER (PKCS1 or PKCS8), PEM, XML, or encoded binary DER (such as base64 encoded binary DER). The format of the contents of the file is auto-recognized.

Starting in version 9.5.0.66, this method also supports loading the JWK (JSON Web Key) format.

Returns true for success, false for failure.

bool LoadFromString(const char *keyString);

Introduced in version 9.5.0.58

Loads a public key from any string format, such as PEM, XML, or encoded binary DER (such as base64 encoded binary DER). The format of the keyString is auto-recognized.

Starting in version 9.5.0.66, this method also supports loading the JWK (JSON Web Key) format.

Returns true for success, false for failure.

bool LoadOpenSslDer(CkByteData &data);

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

This method is deprecated. Applications should call LoadFromBinary instead.

Loads a public key from in-memory PKCS8 DER formatted byte data.

Returns true for success, false for failure.

bool LoadOpenSslDerFile(const char *path);

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

This method is deprecated. Applications should call LoadFromFile instead.

Loads a public key from an PKCS8 DER format file.

Returns true for success, false for failure.

bool LoadOpenSslPem(const char *str);

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

This method is deprecated. Applications should call LoadFromString instead.

Loads a public key from an PKCS8 PEM string.

Returns true for success, false for failure.

bool LoadOpenSslPemFile(const char *path);

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

This method is deprecated. Applications should call LoadFromFile instead.

Loads a public key from an PKCS8 PEM file.

Returns true for success, false for failure.

bool LoadPkcs1Pem(const char *str);

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

This method is deprecated. Applications should call LoadFromString instead.

Loads an RSA public key from PKCS#1 PEM format.

bool LoadRsaDer(CkByteData &data);

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

This method is deprecated. Applications should call LoadFromBinary instead.

Loads a public key from in-memory PKCS1 DER formatted byte data.

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. Applications should call LoadFromFile instead.

Loads a public key from an PKCS1 DER formatted file.

Returns true for success, false for failure.

bool LoadXml(const char *xml);

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

This method is deprecated. Applications should call LoadFromString instead.

Loads a public key from an XML string.

Returns true for success, false for failure.

bool LoadXmlFile(const char *path);

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

This method is deprecated. Applications should call LoadFromFile instead.

Loads a public key from an XML file.

Returns true for success, false for failure.

bool SaveDerFile(bool preferPkcs1, const char *path);

Introduced in version 9.5.0.58

Saves the public key to a file in binary DER format. If the key type (such as RSA) supports both PKCS1 and PKCS8 formats, then preferPkcs1 determine which format is returned.

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 SaveOpenSslDerFile(const char *path);

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

This method is deprecated. Applications should call SaveDerFile with preference for PKCS8 instead.

Saves the public key to an PKCS8 DER format file.

Returns true for success, false for failure.

bool SaveOpenSslPemFile(const char *path);

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

This method is deprecated. Applications should call SavePemFile with preference for PKCS8 instead.

Saves the public key to an PKCS8 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 SavePemFile(bool preferPkcs1, const char *path);

Introduced in version 9.5.0.58

Saves the public key to a file in PEM format. If the key type (such as RSA) supports both PKCS1 and PKCS8 formats, then preferPkcs1 determine which format is returned.

Returns true for success, false for failure.

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

(MFC) Convert RSA Private Key to Public Key

bool SaveRsaDerFile(const char *path);

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

This method is deprecated. Applications should call SaveDerFile with preference for PKCS1 instead.

Saves the public key to an PKCS1 DER format file.

Returns true for success, false for failure.

bool SaveXmlFile(const char *path);

Saves the public key to an XML file.

Returns true for success, false for failure.