PublicKey Unicode C Reference Documentation

PublicKey

Current Version: 10.1.0

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 instance = CkPublicKeyW_Create();
// ...
CkPublicKeyW_Dispose(instance);

HCkPublicKeyW CkPublicKeyW_Create(void);

Creates an instance of the HCkPublicKeyW object and returns a handle ("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

DebugLogFilePath

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, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

Empty

BOOL CkPublicKeyW_getEmpty(HCkPublicKeyW cHandle);

Introduced in version 9.5.0.87

Indicates whether this object is empty or holds a public key.

KeySize

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.

KeyType

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".

LastErrorHtml

void CkPublicKeyW_getLastErrorHtml(HCkPublicKeyW cHandle, HCkString retval);
const wchar_t *CkPublicKeyW_lastErrorHtml(HCkPublicKeyW cHandle);

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

void CkPublicKeyW_getLastErrorText(HCkPublicKeyW cHandle, HCkString retval);
const wchar_t *CkPublicKeyW_lastErrorText(HCkPublicKeyW cHandle);

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void CkPublicKeyW_getLastErrorXml(HCkPublicKeyW cHandle, HCkString retval);
const wchar_t *CkPublicKeyW_lastErrorXml(HCkPublicKeyW cHandle);

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

BOOL CkPublicKeyW_getLastMethodSuccess(HCkPublicKeyW cHandle);
void CkPublicKeyW_putLastMethodSuccess(HCkPublicKeyW cHandle, BOOL newVal);

Indicates the success or failure of the most recent method call: TRUE means success, FALSE means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

VerboseLogging

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.

Version

void CkPublicKeyW_getVersion(HCkPublicKeyW cHandle, HCkString retval);
const wchar_t *CkPublicKeyW_version(HCkPublicKeyW cHandle);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

GetDer

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.

GetEncoded

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.

GetJwk

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"}

Ed25519 public keys (added in v9.5.0.83) have this JWK format:

         {"kty":"OKP",
          "crv":"Ed25519",
          "x": "SE2Kne5xt51z1eciMH2T2ftDQp96Gl6FhY6zSQujiP0"}

Returns TRUE for success, FALSE for failure.

More Information and Examples

Get ECC Public Key in JWK Format (JSON Web Key)Get RSA Public Key in JWK Format (JSON Web Key)Create JWK Set Containing Certificates

GetJwkThumbprint

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.

More Information and Examples

Compute JWK Thumbprint for RSA and EC Public Keys

GetPem

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.

GetXml

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:

<RSAPublicKey>
  <Modulus>...</Modulus>
  <Exponent>...</Exponent>
</RSAPublicKey>

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.

LoadBase64

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.

LoadBd

BOOL CkPublicKeyW_LoadBd(HCkPublicKeyW cHandle, HCkBinDataW bd);

Introduced in version 9.5.0.83

Loads a public key from any binary or string format where the data is contained in bd. Chilkat automatically recognizes the format and key type (RSA, EC, DSA, Ed25519, ..)

Returns TRUE for success, FALSE for failure.

LoadEcdsa

BOOL CkPublicKeyW_LoadEcdsa(HCkPublicKeyW cHandle, const wchar_t *curveName, const wchar_t *Qx, const wchar_t *Qy);

Introduced in version 9.5.0.85

Loads an ECDSA public key directly from Qx, Qy values specified as a hex strings. The curveName can be one of the following:

secp256r1
secp384r1
secp521r1
secp256k1
secp192r1
secp224r1
brainpoolp256r1
brainpoolp160r1
brainpoolp192r1
brainpoolp224r1
brainpoolp320r1
brainpoolp384r1
brainpoolp512r1

Note: ECDSA public keys of various formats, such as PKCS8, PKCS1, JWK, XML, binary DER, PEM, etc., can be loaded using the LoadBd, LoadFromBinary, LoadFromFile, and LoadFromString methods.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Load EC Public Key from X,Y Values (easier)

LoadEd25519

BOOL CkPublicKeyW_LoadEd25519(HCkPublicKeyW cHandle, const wchar_t *pubKey);

Introduced in version 9.5.0.83

Loads the public key object from a 32-byte ed25519 key specified as a hex string.

Returns TRUE for success, FALSE for failure.

LoadFromBinary

BOOL CkPublicKeyW_LoadFromBinary(HCkPublicKeyW cHandle, HCkByteData 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.

LoadFromFile

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.

LoadFromString

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.

More Information and Examples

Load JWK into PublicKey Object

SaveDerFile

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.

SavePemFile

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.

More Information and Examples

Convert RSA Private Key to Public Key Export Public Key from USB Token or Smartcard using the Apple Keychain

SaveXmlFile

BOOL CkPublicKeyW_SaveXmlFile(HCkPublicKeyW cHandle, const wchar_t *path);

Saves the public key to an XML file.

Returns TRUE for success, FALSE for failure.