PublicKey Delphi DLL Reference Documentation
PublicKey
Current Version: 10.0.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
var myObject: HCkPublicKey; begin myObject := CkPublicKey_Create(); // ... CkPublicKey_Dispose(myObject); end;
Creates an instance of the HCkPublicKey object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkPublicKey_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.
Properties
DebugLogFilePath
procedure CkPublicKey_putDebugLogFilePath(objHandle: HCkPublicKey; newPropVal: PWideChar); stdcall;
function CkPublicKey__debugLogFilePath(objHandle: HCkPublicKey): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
Empty
Indicates whether this object is empty or holds a public key.
topKeySize
Gets the size (in bits) of the public key. For example: 1024, 2048, etc.
topKeyType
function CkPublicKey__keyType(objHandle: HCkPublicKey): PWideChar; stdcall;
The type of public key. Can be "empty", "rsa", "dsa", or "ecc".
See the notes about PWideChar memory ownership and validity.
topLastErrorHtml
function CkPublicKey__lastErrorHtml(objHandle: HCkPublicKey): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastErrorText
function CkPublicKey__lastErrorText(objHandle: HCkPublicKey): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
LastErrorXml
function CkPublicKey__lastErrorXml(objHandle: HCkPublicKey): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastMethodSuccess
procedure CkPublicKey_putLastMethodSuccess(objHandle: HCkPublicKey; newPropVal: wordbool); stdcall;
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.
topVerboseLogging
procedure CkPublicKey_putVerboseLogging(objHandle: HCkPublicKey; newPropVal: wordbool); stdcall;
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.
topVersion
function CkPublicKey__version(objHandle: HCkPublicKey): PWideChar; stdcall;
Version of the component/library, such as "9.5.0.94"
See the notes about PWideChar memory ownership and validity.
Methods
GetDer
preferPkcs1: wordbool;
outBytes: HCkByteData): wordbool; stdcall;
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.
topGetEncoded
preferPkcs1: wordbool;
encoding: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkPublicKey__getEncoded(objHandle: HCkPublicKey;
preferPkcs1: wordbool;
encoding: PWideChar): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topGetJwk
outStr: HCkString): wordbool; stdcall;
function CkPublicKey__getJwk(objHandle: HCkPublicKey): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
GetJwkThumbprint
hashAlg: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkPublicKey__getJwkThumbprint(objHandle: HCkPublicKey;
hashAlg: PWideChar): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
GetPem
preferPkcs1: wordbool;
outStr: HCkString): wordbool; stdcall;
function CkPublicKey__getPem(objHandle: HCkPublicKey;
preferPkcs1: wordbool): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topGetXml
outStr: HCkString): wordbool; stdcall;
function CkPublicKey__getXml(objHandle: HCkPublicKey): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLoadBase64
keyStr: PWideChar): wordbool; stdcall;
Loads a public key from base64-encoded DER (can be PKCS1 or PKCS8).
Returns True for success, False for failure.
topLoadBd
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.
topLoadEcdsa
curveName: PWideChar;
Qx: PWideChar;
Qy: PWideChar): wordbool; stdcall;
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.
LoadEd25519
pubKey: PWideChar): wordbool; stdcall;
Loads the public key object from a 32-byte ed25519 key specified as a hex string.
Returns True for success, False for failure.
topLoadFromBinary
keyBytes: HCkByteData): wordbool; stdcall;
Loads a public key from binary DER. Auto-recognizes both PKCS1 and PKCS8 formats.
Returns True for success, False for failure.
topLoadFromFile
path: PWideChar): wordbool; stdcall;
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.
topLoadFromString
keyString: PWideChar): wordbool; stdcall;
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.
SaveDerFile
preferPkcs1: wordbool;
path: PWideChar): wordbool; stdcall;
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.
topSavePemFile
preferPkcs1: wordbool;
path: PWideChar): wordbool; stdcall;
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.
SaveXmlFile
path: PWideChar): wordbool; stdcall;