PublicKey Unicode C Reference Documentation

PublicKey

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.

Create/Dispose

HCkPublicKeyW CkPublicKeyW_Create(void);

Creates an instance of the HCkPublicKeyW object and returns a handle (i.e. a "void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkPublicKeyW_Dispose(HCkPublicKeyW handle);

Objects created by calling CkPublicKeyW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkPublicKeyW_Dispose.

Properties

void CkPublicKeyW_getDebugLogFilePath(HCkPublicKeyW cHandle, HCkString retval);

void CkPublicKeyW_putDebugLogFilePath(HCkPublicKeyW cHandle, const wchar_t *newVal);

const wchar_t *CkPublicKeyW_debugLogFilePath(HCkPublicKeyW cHandle);

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 CkPublicKeyW_getKeySize(HCkPublicKeyW cHandle);

Introduced in version 9.5.0.67

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

void CkPublicKeyW_getKeyType(HCkPublicKeyW cHandle, HCkString retval);

const wchar_t *CkPublicKeyW_keyType(HCkPublicKeyW cHandle);

Introduced in version 9.5.0.52

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

void CkPublicKeyW_getLastErrorHtml(HCkPublicKeyW cHandle, HCkString retval);

const wchar_t *CkPublicKeyW_lastErrorHtml(HCkPublicKeyW cHandle);

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 CkPublicKeyW_getLastErrorText(HCkPublicKeyW cHandle, HCkString retval);

const wchar_t *CkPublicKeyW_lastErrorText(HCkPublicKeyW cHandle);

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 CkPublicKeyW_getLastErrorXml(HCkPublicKeyW cHandle, HCkString retval);

const wchar_t *CkPublicKeyW_lastErrorXml(HCkPublicKeyW cHandle);

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 CkPublicKeyW_getLastMethodSuccess(HCkPublicKeyW cHandle);

void CkPublicKeyW_putLastMethodSuccess(HCkPublicKeyW cHandle, 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 CkPublicKeyW_getVerboseLogging(HCkPublicKeyW cHandle);

void CkPublicKeyW_putVerboseLogging(HCkPublicKeyW cHandle, 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 CkPublicKeyW_getVersion(HCkPublicKeyW cHandle, HCkString retval);

const wchar_t *CkPublicKeyW_version(HCkPublicKeyW cHandle);

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

Methods

BOOL CkPublicKeyW_GetDer(HCkPublicKeyW cHandle, BOOL preferPkcs1, const unsigned char * 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 CkPublicKeyW_GetEncoded(HCkPublicKeyW cHandle, BOOL preferPkcs1, const wchar_t *encoding, const wchar_t *outStr);

const wchar_t *CkPublicKeyW_getEncoded(HCkPublicKeyW cHandle, BOOL preferPkcs1, const wchar_t *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 CkPublicKeyW_GetJwk(HCkPublicKeyW cHandle, const wchar_t *outStr);

const wchar_t *CkPublicKeyW_getJwk(HCkPublicKeyW cHandle);

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.

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

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

BOOL CkPublicKeyW_GetJwkThumbprint(HCkPublicKeyW cHandle, const wchar_t *hashAlg, const wchar_t *outStr);

const wchar_t *CkPublicKeyW_getJwkThumbprint(HCkPublicKeyW cHandle, const wchar_t *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.

Compute JWK Thumbprint for RSA and EC Public Keys

BOOL CkPublicKeyW_GetOpenSslDer(HCkPublicKeyW cHandle, const unsigned char * 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 CkPublicKeyW_GetOpenSslPem(HCkPublicKeyW cHandle, const wchar_t *outStr);

const wchar_t *CkPublicKeyW_getOpenSslPem(HCkPublicKeyW cHandle);

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 CkPublicKeyW_GetPem(HCkPublicKeyW cHandle, BOOL preferPkcs1, const wchar_t *outStr);

const wchar_t *CkPublicKeyW_getPem(HCkPublicKeyW cHandle, 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 CkPublicKeyW_GetPkcs1ENC(HCkPublicKeyW cHandle, const wchar_t *encoding, const wchar_t *outStr);

const wchar_t *CkPublicKeyW_getPkcs1ENC(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_GetPkcs8ENC(HCkPublicKeyW cHandle, const wchar_t *encoding, const wchar_t *outStr);

const wchar_t *CkPublicKeyW_getPkcs8ENC(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_GetRsaDer(HCkPublicKeyW cHandle, const unsigned char * 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 CkPublicKeyW_GetXml(HCkPublicKeyW cHandle, const wchar_t *outStr);

const wchar_t *CkPublicKeyW_getXml(HCkPublicKeyW cHandle);

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 CkPublicKeyW_LoadBase64(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_LoadFromBinary(HCkPublicKeyW cHandle, const unsigned char * 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 CkPublicKeyW_LoadFromFile(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_LoadFromString(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_LoadOpenSslDer(HCkPublicKeyW cHandle, const unsigned char * 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 CkPublicKeyW_LoadOpenSslDerFile(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_LoadOpenSslPem(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_LoadOpenSslPemFile(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_LoadPkcs1Pem(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_LoadRsaDer(HCkPublicKeyW cHandle, const unsigned char * 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 CkPublicKeyW_LoadRsaDerFile(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_LoadXml(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_LoadXmlFile(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_SaveDerFile(HCkPublicKeyW cHandle, BOOL preferPkcs1, const wchar_t *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 CkPublicKeyW_SaveLastError(HCkPublicKeyW cHandle, const wchar_t *path);

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

Returns TRUE for success, FALSE for failure.

BOOL CkPublicKeyW_SaveOpenSslDerFile(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_SaveOpenSslPemFile(HCkPublicKeyW cHandle, const wchar_t *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.

Generate RSA Public/Private Key Pair and Export to PEM

BOOL CkPublicKeyW_SavePemFile(HCkPublicKeyW cHandle, BOOL preferPkcs1, const wchar_t *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.

Convert RSA Private Key to Public Key

BOOL CkPublicKeyW_SaveRsaDerFile(HCkPublicKeyW cHandle, const wchar_t *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 CkPublicKeyW_SaveXmlFile(HCkPublicKeyW cHandle, const wchar_t *path);

Saves the public key to an XML file.

Returns TRUE for success, FALSE for failure.