EdDSA Chilkat2 PHP Reference Documentation
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\EdDSA;
try {
$edDSA = new EdDSA();
// ... use $edDSA ...
} catch (\Chilkat2\Exception $e) {
echo $e->getClass(), '::', $e->getMethod(), " failed\n";
echo $e->getMessage(), "\n"; // the LastErrorText of the failed call
}Creates the object. The optional array sets properties in order, as if assigned one by one (new EdDSA(['VerboseLogging' => true, 'RaiseError' => false])); an unknown or read-only name throws Error. The class is defined by the chilkat2 extension (extension=chilkat2 in php.ini): there is no PHP file to include.
There is no close(): PHP frees the object when its last reference goes (unset($edDSA), $edDSA = null, or the end of the function or request). Objects returned by methods are independent and freed the same way. The class may be extended (class MyEdDSA extends \Chilkat2\EdDSA); objects cannot be cloned or serialized.
When true (the default), a method that fails throws Chilkat2\Exception. When false, it returns false (or null) instead, and the reason is in LastErrorText. Objects returned by a method inherit the value of the object that returned them.
Errors
Chilkat2\Exception extends RuntimeException: getMessage() is the failed call's full LastErrorText, getClass() its class ('Chilkat2\EdDSA') and getMethod() the method name. The object remains usable. Methods that look something up and find nothing return null without throwing (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain bool, and property reads and writes do not throw for Chilkat reasons.
Misuse always throws, whatever RaiseError is: a wrong argument type is a TypeError (exact types under declare(strict_types=1)), a missing or extra argument an ArgumentCountError, a string containing a NUL byte or an out-of-range integer a ValueError, and an unknown property (properties are case-sensitive) or a write to a read-only one an Error. Named arguments work with the parameter names shown.
Strings are passed and returned as UTF-8; binary data is a PHP string of bytes. Unlocking: call (new \Chilkat2\GlobalSettings())->UnlockBundle('...') once at startup.
Properties
Algorithm
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
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
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
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
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
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
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.
VerboseLogging
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.
Version
Methods
GenEd25519Key
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 truefalseLastErrorText for details.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
SharedSecretENC
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.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
SignBdENC
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.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
VerifyBdENC
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 truefalseLastErrorText for diagnostic information.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.