EdDSA C# Reference Documentation

EdDSA

Current Version: 11.5.0

Chilkat.EdDSA

Generate Ed25519 keys, sign data, verify signatures, and compute shared secrets.

Chilkat.EdDSA is the Chilkat class for Ed25519-based EdDSA operations. It can generate Ed25519 private keys, sign data contained in BinData, verify encoded signatures with public keys, and compute encoded shared secrets from compatible private/public key pairs. It supports the Ed25519, Ed25519ph, and Ed25519ctx variants, with optional context bytes supplied as a hex string when the selected variant requires them.

Generate Ed25519 keys

Create Ed25519 private keys for signing, verification, and compatible key-agreement workflows.

Sign BinData

Sign binary data directly from a Chilkat.BinData object using an Ed25519 private key.

Verify signatures

Verify encoded EdDSA signatures using the corresponding public key and the original message data.

Ed25519 variants

Use Ed25519, Ed25519ph, or Ed25519ctx depending on the protocol or interoperability requirements.

Context support

Supply optional context bytes as a hex string for workflows that use the Ed25519ctx or related context-aware signing modes.

Shared-secret output

Compute encoded shared secrets from compatible private and public key pairs for protocols that require this operation.

Common pattern: Generate or load an Ed25519 key, choose the required EdDSA variant, provide context bytes when needed, then sign or verify the BinData content. For shared-secret workflows, compute the encoded secret and pass it through the key derivation or formatting step required by the protocol.

Object Creation

Chilkat.EdDSA obj = new Chilkat.EdDSA();

Properties

Algorithm
public string Algorithm {get; set; }
Introduced in version 9.5.0.91

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.

top
Context
public string Context {get; set; }
Introduced in version 9.5.0.91

The context bytes (in hex string format) to be used for Ed25519ctx or Ed25519ph.

top
DebugLogFilePath
public string DebugLogFilePath {get; set; }

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.

top
LastErrorHtml
public string LastErrorHtml {get; }

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.

top
LastErrorText
public string LastErrorText {get; }

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.

top
LastErrorXml
public string LastErrorXml {get; }

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.

top
LastMethodSuccess
public bool LastMethodSuccess {get; set; }

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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top
VerboseLogging
public bool VerboseLogging {get; set; }

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.

top
Version
public string Version {get; }

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

top

Methods

GenEd25519Key
public bool GenEd25519Key(Prng prng, PrivateKey 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 true for success, false for failure.

top
SharedSecretENC
public string SharedSecretENC(PrivateKey privkey, PublicKey pubkey, string 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 null on failure

top
SignBdENC
public string SignBdENC(BinData bd, string encoding, PrivateKey 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 null on failure

top
VerifyBdENC
public bool VerifyBdENC(BinData bd, string encodedSig, string enocding, PublicKey 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 true for success, false for failure.

top