Tsugi

Ob3DataIntegrity
in package

Data Integrity Proof for Open Badges 3.0 (eddsa-jcs-2022 cryptosuite)

Implements W3C VC Data Integrity EdDSA Cryptosuites - eddsa-jcs-2022. Note: The 1EdTech OB3 verifier at vc.1ed.tech only accepts eddsa-rdfc-2022 for certification. This implementation uses eddsa-jcs-2022 (also in the W3C spec). For 1EdTech certification, consider filing a request to support eddsa-jcs-2022.

Tags
see
https://www.w3.org/TR/vc-di-eddsa/

Table of Contents

Constants

CRYPTOSUITE  : string = 'eddsa-jcs-2022'

Methods

createProof()  : array<string|int, mixed>|null
Create a DataIntegrityProof for an OB3 credential (eddsa-jcs-2022)
generateKeyPair()  : array<string|int, mixed>
Generate a new Ed25519 key pair for OB3 signing Returns [ 'secretKey' => string (64 bytes), 'publicKey' => string (32 bytes) ]
publicKeyToMultibase()  : string
Encode Ed25519 public key as Multikey (base58btc with 0xed01 prefix) Multikey format: 0xed01 (2 bytes) + public key (32 bytes) = 34 bytes
secretKeyToPublicKey()  : string
Extract public key from libsodium secret key (last 32 bytes)
base58Encode()  : mixed
Base58 (Bitcoin alphabet) encode - for multibase "z" prefix Alphabet: 123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz Uses GMP or BCMath extension (at least one required for large byte strings).

Constants

CRYPTOSUITE

public string CRYPTOSUITE = 'eddsa-jcs-2022'

eddsa-jcs-2022 cryptosuite

Methods

createProof()

Create a DataIntegrityProof for an OB3 credential (eddsa-jcs-2022)

public static createProof(array<string|int, mixed> $credential, string $verificationMethodId, string $secretKey) : array<string|int, mixed>|null
Parameters
$credential : array<string|int, mixed>

The credential document (without proof)

$verificationMethodId : string

URL of the verification method (e.g. issuer#key-0)

$secretKey : string

Ed25519 secret key bytes (64 bytes: 32 seed + 32 public)

Return values
array<string|int, mixed>|null —

Proof object or null on failure

generateKeyPair()

Generate a new Ed25519 key pair for OB3 signing Returns [ 'secretKey' => string (64 bytes), 'publicKey' => string (32 bytes) ]

public static generateKeyPair() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Key pair

publicKeyToMultibase()

Encode Ed25519 public key as Multikey (base58btc with 0xed01 prefix) Multikey format: 0xed01 (2 bytes) + public key (32 bytes) = 34 bytes

public static publicKeyToMultibase(string $publicKey) : string
Parameters
$publicKey : string

32-byte Ed25519 public key

Return values
string —

Multibase multikey string (z prefix + base58)

secretKeyToPublicKey()

Extract public key from libsodium secret key (last 32 bytes)

public static secretKeyToPublicKey(string $secretKey) : string
Parameters
$secretKey : string

64-byte Ed25519 secret key from sodium

Return values
string —

32-byte public key

base58Encode()

Base58 (Bitcoin alphabet) encode - for multibase "z" prefix Alphabet: 123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz Uses GMP or BCMath extension (at least one required for large byte strings).

private static base58Encode(mixed $input) : mixed
Parameters
$input : mixed

        
On this page

Search results