EdDSA Tcl Reference Documentation

EdDSA

Current Version: 9.5.0.88

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

DebugLogFilePath
string
# 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, 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:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
string
# ckStr is a CkString
CkEdDSA_get_LastErrorHtml $myEdDSA $ckStr
set strVal [CkEdDSA_get_lastErrorHtml $myEdDSA]

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.

top
LastErrorText
string
# ckStr is a CkString
CkEdDSA_get_LastErrorText $myEdDSA $ckStr
set strVal [CkEdDSA_get_lastErrorText $myEdDSA]

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.

top
LastErrorXml
string
# ckStr is a CkString
CkEdDSA_get_LastErrorXml $myEdDSA $ckStr
set strVal [CkEdDSA_get_lastErrorXml $myEdDSA]

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.

top
LastMethodSuccess
boolean 1/0
set boolVal [CkEdDSA_get_LastMethodSuccess $myEdDSA]
CkEdDSA_put_LastMethodSuccess $myEdDSA $boolVal
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Utf8
boolean 1/0
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.

top
VerboseLogging
boolean 1/0
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.

top
Version
string
# ckStr is a CkString
CkEdDSA_get_Version $myEdDSA $ckStr
set strVal [CkEdDSA_get_version $myEdDSA]

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

top

Methods

GenEd25519Key
# prng is a CkPrng
# privKey is a CkPrivateKey
set status [CkEdDSA_GenEd25519Key $prng $privKey]
Introduced in version 9.5.0.83

Generates an Ed25519 key. privKey is an output argument. The generated key is created in privKey.

Returns 1 for success, 0 for failure.

More Information and Examples
top
SharedSecretENC
# privkey is a CkPrivateKey
# 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]
Introduced in version 9.5.0.83

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.

top
SignBdENC
# bd is a CkBinData
# 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]
Introduced in version 9.5.0.83

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.

top
VerifyBdENC
# bd is a CkBinData
# encodedSig is a string
# enocding is a string
# pubkey is a CkPublicKey
set status [CkEdDSA_VerifyBdENC $bd $encodedSig $enocding $pubkey]
Introduced in version 9.5.0.83

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.

More Information and Examples
top