EdDSA Tcl 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.
Object Creation
set myEdDSA [new CkEdDSA]
Properties
Algorithm
# ckStr is a CkString
CkEdDSA_get_Algorithm $myEdDSA $ckStr
set strVal [CkEdDSA_get_algorithm $myEdDSA]
CkEdDSA_put_Algorithm $myEdDSA $strVal
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
# ckStr is a CkString
CkEdDSA_get_Context $myEdDSA $ckStr
set strVal [CkEdDSA_get_context $myEdDSA]
CkEdDSA_put_Context $myEdDSA $strVal
The context bytes (in hex string format) to be used for Ed25519ctx or Ed25519ph.
topDebugLogFilePath
# ckStr is a CkString
CkEdDSA_get_DebugLogFilePath $myEdDSA $ckStr
set strVal [CkEdDSA_get_debugLogFilePath $myEdDSA]
CkEdDSA_put_DebugLogFilePath $myEdDSA $strVal
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
# ckStr is a CkString
CkEdDSA_get_LastErrorHtml $myEdDSA $ckStr
set strVal [CkEdDSA_get_lastErrorHtml $myEdDSA]
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
# ckStr is a CkString
CkEdDSA_get_LastErrorText $myEdDSA $ckStr
set strVal [CkEdDSA_get_lastErrorText $myEdDSA]
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
# ckStr is a CkString
CkEdDSA_get_LastErrorXml $myEdDSA $ckStr
set strVal [CkEdDSA_get_lastErrorXml $myEdDSA]
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
set boolVal [CkEdDSA_get_LastMethodSuccess $myEdDSA]
CkEdDSA_put_LastMethodSuccess $myEdDSA $boolVal
Indicates the success or failure of the most recent method call: 1 means success, 0 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
set boolVal [CkEdDSA_get_Utf8 $myEdDSA]
CkEdDSA_put_Utf8 $myEdDSA $boolVal
When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.
topVerboseLogging
set boolVal [CkEdDSA_get_VerboseLogging $myEdDSA]
CkEdDSA_put_VerboseLogging $myEdDSA $boolVal
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
# ckStr is a CkString
CkEdDSA_get_Version $myEdDSA $ckStr
set strVal [CkEdDSA_get_version $myEdDSA]
Methods
GenEd25519Key
# privKey is a CkPrivateKey
set status [CkEdDSA_GenEd25519Key $prng $privKey]
Generates an Ed25519 key. privKey is an output argument. The generated key is created in privKey.
Returns 1 for success, 0 for failure.
SharedSecretENC
# pubkey is a CkPublicKey
# encoding is a string
# outStr is a CkString (output)
set status [CkEdDSA_SharedSecretENC $privkey $pubkey $encoding $outStr]
set retStr [CkEdDSA_sharedSecretENC $myEdDSA $privkey $pubkey $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 1 for success, 0 for failure.
SignBdENC
# encoding is a string
# privkey is a CkPrivateKey
# outStr is a CkString (output)
set status [CkEdDSA_SignBdENC $bd $encoding $privkey $outStr]
set retStr [CkEdDSA_signBdENC $myEdDSA $bd $encoding $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 1 for success, 0 for failure.
VerifyBdENC
# encodedSig is a string
# enocding is a string
# pubkey is a CkPublicKey
set status [CkEdDSA_VerifyBdENC $bd $encodedSig $enocding $pubkey]
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 1 for success, 0 for failure.