EdDSA C Reference Documentation
EdDSA
Current Version: 10.1.2
Class for generating Ed25519 keys and creating/validating Ed25519 signatures. This class was added in v9.5.0.83.
Create/Dispose
HCkEdDSA instance = CkEdDSA_Create(); // ... CkEdDSA_Dispose(instance);
Creates an instance of the HCkEdDSA object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkEdDSA_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 CkEdDSA_Dispose.
Properties
Algorithm
void CkEdDSA_putAlgorithm(HCkEdDSA cHandle, const char *newVal);
const char *CkEdDSA_algorithm(HCkEdDSA cHandle);
Can be "Ed25519", "Ed25519ph", or "Ed25519ctx". The default is "Ed25519". This property was introduced in v9.5.0.91. Prior to this version, "Ed25519" was the only EdDSA instance supported.
topContext
void CkEdDSA_putContext(HCkEdDSA cHandle, const char *newVal);
const char *CkEdDSA_context(HCkEdDSA cHandle);
The context bytes (in hex string format) to be used for Ed25519ctx or Ed25519ph.
topDebugLogFilePath
void CkEdDSA_putDebugLogFilePath(HCkEdDSA cHandle, const char *newVal);
const char *CkEdDSA_debugLogFilePath(HCkEdDSA 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.
LastErrorHtml
const char *CkEdDSA_lastErrorHtml(HCkEdDSA 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.
topLastErrorText
const char *CkEdDSA_lastErrorText(HCkEdDSA 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.
LastErrorXml
const char *CkEdDSA_lastErrorXml(HCkEdDSA 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.
topLastMethodSuccess
void CkEdDSA_putLastMethodSuccess(HCkEdDSA 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.
topUtf8
void CkEdDSA_putUtf8(HCkEdDSA cHandle, 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.
topVerboseLogging
void CkEdDSA_putVerboseLogging(HCkEdDSA 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.
topVersion
const char *CkEdDSA_version(HCkEdDSA cHandle);
Methods
GenEd25519Key
Generates an Ed25519 key. privKey is an output argument. The generated key is created in privKey.
Returns TRUE for success, FALSE for failure.
SharedSecretENC
const char *CkEdDSA_sharedSecretENC(HCkEdDSA cHandle, HCkPrivateKey privkey, HCkPublicKey pubkey, const char *encoding);
Computes a shared secret given a private and public key. For example, Alice and Bob can compute the identical shared secret by doing the following: Alice sends Bob her public key, and Bob calls SharedSecretENC with his private key and Alice's public key. Bob sends Alice his public key, and Alice calls SharedSecretENC with her private key and Bob's public key. Both calls to SharedSecretENC will produce the same result. The resulting bytes are returned in encoded string form (hex, base64, etc) as specified by encoding.
Returns TRUE for success, FALSE for failure.
SignBdENC
const char *CkEdDSA_signBdENC(HCkEdDSA cHandle, HCkBinData bd, const char *encoding, HCkPrivateKey privkey);
Signs the contents of bd and returns the signature according to encoding. The encoding can be any encoding supported by Chilkat, such as "hex", "base64", etc.
Returns TRUE for success, FALSE for failure.
VerifyBdENC
Verifies the signature against the contents of bd. The encodedSig is passed as an encoded string (such as hex, base64, etc.) using the encoding specified by enocding. The pubkey contains the Ed25519 public key used to verify.
Returns TRUE for success, FALSE for failure.