EdDSA Unicode C Reference Documentation
EdDSA
Current Version: 10.0.0
Class for generating Ed25519 keys and creating/validating Ed25519 signatures. This class was added in v9.5.0.83.
Create/Dispose
HCkEdDSAW instance = CkEdDSAW_Create(); // ... CkEdDSAW_Dispose(instance);
Creates an instance of the HCkEdDSAW 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 CkEdDSAW_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 CkEdDSAW_Dispose.
Properties
Algorithm
void CkEdDSAW_putAlgorithm(HCkEdDSAW cHandle, const wchar_t *newVal);
const wchar_t *CkEdDSAW_algorithm(HCkEdDSAW 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 CkEdDSAW_putContext(HCkEdDSAW cHandle, const wchar_t *newVal);
const wchar_t *CkEdDSAW_context(HCkEdDSAW cHandle);
The context bytes (in hex string format) to be used for Ed25519ctx or Ed25519ph.
topDebugLogFilePath
void CkEdDSAW_putDebugLogFilePath(HCkEdDSAW cHandle, const wchar_t *newVal);
const wchar_t *CkEdDSAW_debugLogFilePath(HCkEdDSAW 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:
- 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.
LastErrorHtml
const wchar_t *CkEdDSAW_lastErrorHtml(HCkEdDSAW 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.
topLastErrorText
const wchar_t *CkEdDSAW_lastErrorText(HCkEdDSAW 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.
LastErrorXml
const wchar_t *CkEdDSAW_lastErrorXml(HCkEdDSAW 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.
topLastMethodSuccess
void CkEdDSAW_putLastMethodSuccess(HCkEdDSAW cHandle, BOOL newVal);
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
void CkEdDSAW_putVerboseLogging(HCkEdDSAW 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 wchar_t *CkEdDSAW_version(HCkEdDSAW 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 wchar_t *CkEdDSAW_sharedSecretENC(HCkEdDSAW cHandle, HCkPrivateKeyW privkey, HCkPublicKeyW pubkey, const wchar_t *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 wchar_t *CkEdDSAW_signBdENC(HCkEdDSAW cHandle, HCkBinDataW bd, const wchar_t *encoding, HCkPrivateKeyW 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.