EdDSA Chilkat2 Perl Reference Documentation
Chilkat2::EdDSA
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.EdDSA
Create Ed25519 private keys for signing, verification, and compatible
key-agreement workflows.
Sign binary data directly from a
Verify encoded EdDSA signatures using the corresponding public key and
the original message data.
Use Ed25519, Ed25519ph, or Ed25519ctx depending on the protocol or
interoperability requirements.
Supply optional context bytes as a hex string for workflows that use the
Ed25519ctx or related context-aware signing modes.
Compute encoded shared secrets from compatible private and public key
pairs for protocols that require this operation.
For an extended overview, see
EdDSA Class Overview.
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
Sign BinData
Chilkat.BinData object
using an Ed25519 private key.
Verify signatures
Ed25519 variants
Context support
Shared-secret output
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
use Chilkat2;
my $edDSA = Chilkat2::EdDSA->new;
# or set properties (and RaiseError) at creation:
# my $edDSA = Chilkat2::EdDSA->new(VerboseLogging => 1, RaiseError => 1);Creates the object. The optional pairs set writable properties (and RaiseError) in order, as if set one by one; an unknown or read-only name croaks. use Chilkat2; loads every class; the Chilkat2/EdDSA.pm file holds only this class's documentation (perldoc Chilkat2::EdDSA).
Perl frees the object when its last reference goes (undef $edDSA, or the variable going out of scope); there is nothing to close. Objects returned by methods are independent and freed the same way. The class may be subclassed (use parent -norequire, 'Chilkat2::EdDSA';): an object is a blessed hash reference whose hash is free for the subclass's own fields.
When false (the default), a method that fails returns false (or undef), and the reason is in LastErrorText. When true, it dies with a Chilkat2::Error instead, as DBI does with its RaiseError. Objects returned by a method inherit the value of the object that returned them.
Errors
A Chilkat2::Error stringifies to the failed call's full LastErrorText, and has the methods text, class ('Chilkat2::EdDSA'), method (the method name) and object. Methods that look something up and find nothing return undef without dying (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain boolean, and property reads and writes never fail for Chilkat reasons.
Misuse always croaks, with your file and line, whatever RaiseError is: a wrong number of arguments, a reference or undef where a string or number is expected, an object of the wrong class, an out-of-range integer, a string containing a NUL character, a wide character in a byte string, or a write to a read-only property.
Strings are Perl character strings in both directions (length, regexes and :encoding layers see characters); binary data (BinData) is a byte string. Unlocking: call Chilkat2::Global->new->UnlockBundle('...') once at startup.
Properties
Algorithm
my $strVal = $edDSA->Algorithm;
$edDSA->Algorithm($strVal);
Selects the Ed25519 signature variant used by SignBdENC and VerifyBdENC. The default is Ed25519.
| Value | Behavior | Context |
|---|---|---|
Ed25519 | The standard pure Ed25519 signature scheme. The complete message is signed directly by the Ed25519 algorithm. | A context is not part of this variant and should be empty. |
Ed25519ctx | Pure Ed25519 with domain separation supplied by a context string. | The context should normally be nonempty and must match exactly during verification. |
Ed25519ph | Prehash Ed25519. Chilkat first hashes the message with SHA-512 as defined for this variant. | May be empty or contain up to 255 context bytes; it must match exactly during verification. |
GenEd25519Key and does not affect SharedSecretENC.Context
my $strVal = $edDSA->Context;
$edDSA->Context($strVal);
Gets or sets the context bytes used by the Ed25519ctx and Ed25519ph signature variants. Supply the bytes as a hexadecimal string. The default is an empty string.
A context may contain at most 255 bytes, which corresponds to at most 510 hexadecimal characters. The same context bytes must be supplied byte-for-byte when verifying the signature. An invalid hexadecimal value or an oversized context causes the signing or verification operation to fail.
Algorithm is Ed25519ctx or Ed25519ph. Standard Ed25519 does not include a context.DebugLogFilePath
my $strVal = $edDSA->DebugLogFilePath;
$edDSA->DebugLogFilePath($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
my $strVal = $edDSA->LastErrorHtml;
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
my $strVal = $edDSA->LastErrorText;
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
my $strVal = $edDSA->LastErrorXml;
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
my $boolVal = $edDSA->LastMethodSuccess;
$edDSA->LastMethodSuccess($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. 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.
VerboseLogging
my $boolVal = $edDSA->VerboseLogging;
$edDSA->VerboseLogging($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.
Version
my $strVal = $edDSA->Version;
Methods
GenEd25519Key
# $privKey is a Chilkat2::PrivateKey
# $success is true or false
my $success = $edDSA->GenEd25519Key($prng, $privKey);
Generates a new Ed25519 key pair using $prng as the source of cryptographically secure random bytes. On success, the generated private key and its corresponding public key are stored in the existing PrivateKey object passed in $privKey.
Returns 10LastErrorText for details.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
SharedSecretENC
# $pubkey is a Chilkat2::PublicKey
# $encoding is a string
# $str is a string or undef
my $str = $edDSA->SharedSecretENC($privkey, $pubkey, $encoding);
Computes a 32-byte X25519 shared secret from the private key in $privkey and the peer's public key in $pubkey. The resulting bytes are returned as text using the binary encoding named by $encoding, such as hex, hexlower, or base64.
Each participant supplies its own private key and the other participant's public key. When Alice computes the secret from Alice's private key and Bob's public key, and Bob computes it from Bob's private key and Alice's public key, both obtain the same result.
Algorithm and Context properties do not apply.This is a string-returning method. Check LastMethodSuccess before using the returned value; on failure, inspect LastErrorText.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
SignBdENC
# $encoding is a string
# $privkey is a Chilkat2::PrivateKey
# $str is a string or undef
my $str = $edDSA->SignBdENC($bd, $encoding, $privkey);
Creates an EdDSA signature over the exact byte sequence contained in $bd, using the Ed25519 private key in $privkey. The 64-byte signature is returned as text using the binary encoding named by $encoding, such as hex, hexlower, or base64.
The selected Algorithm and Context properties determine whether the operation uses Ed25519, Ed25519ctx, or Ed25519ph. For Ed25519ph, pass the original message bytes in $bd; Chilkat performs the required SHA-512 prehash as part of the Ed25519ph operation.
This is a string-returning method. Check LastMethodSuccess before using the returned value; on failure, inspect LastErrorText.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
VerifyBdENC
# $encodedSig is a string
# $enocding is a string
# $pubkey is a Chilkat2::PublicKey
# $success is true or false
my $success = $edDSA->VerifyBdENC($bd, $encodedSig, $enocding, $pubkey);
Verifies the encoded EdDSA signature in $encodedSig against the exact byte sequence contained in $bd, using the Ed25519 public key in $pubkey. $enocding names the binary encoding of $encodedSig, such as hex, hexlower, or base64.
The verifier must use the same Algorithm and Context values that were used to create the signature. Any change to the message, signature, public key, algorithm variant, or context causes verification to fail.
Returns 10LastErrorText for diagnostic information.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.