ed25519signature2018

Documentation

Overview

Package ed25519signature2018 implements the Ed25519Signature2018 signature suite for the Linked Data Signatures [LD-SIGNATURES] specification. It uses the RDF Dataset Normalization Algorithm [RDF-DATASET-NORMALIZATION] to transform the input document into its canonical form. It uses SHA-256 [RFC6234] as the message digest algorithm and Ed25519 [ED25519] as the signature algorithm.

Index

• Constants
• type Proof
  • func New() *Proof
  • func (s *Proof) GetCanonicalDocument(doc map[string]interface{}, opts ...processor.Opts) ([]byte, error)
  • func (s *Proof) GetDigest(doc []byte) []byte
  • func (s *Proof) ProofType() string
  • func (s *Proof) SupportedVerificationMethods() []proof.SupportedVerificationMethod

Constants

const (
	// ProofType or ed25519signature2018.
	ProofType = "Ed25519Signature2018"
	// VerificationMethodType or ed25519signature2018.
	VerificationMethodType = "Ed25519VerificationKey2018"
	// JWKKeyType or ed25519signature2018.
	JWKKeyType = "OKP"
	// JWKCurve or ed25519signature2018.
	JWKCurve = "Ed25519"
)

Types

type Proof

type Proof struct {
	// contains filtered or unexported fields
}

Proof describes ed25519 proof type.

func New

func New() *Proof

New an instance of ed25519 proof type descriptor.

func (*Proof) GetCanonicalDocument

func (s *Proof) GetCanonicalDocument(doc map[string]interface{}, opts ...processor.Opts) ([]byte, error)

GetCanonicalDocument will return normalized/canonical version of the document Ed25519Signature2018 signature SignatureSuite uses RDF Dataset Normalization as canonicalization algorithm.

func (*Proof) GetDigest

func (s *Proof) GetDigest(doc []byte) []byte

GetDigest returns document digest.

func (*Proof) ProofType

func (s *Proof) ProofType() string

ProofType return proof type name.

func (*Proof) SupportedVerificationMethods

func (s *Proof) SupportedVerificationMethods() []proof.SupportedVerificationMethod

SupportedVerificationMethods returns list of verification methods supported by this proof type.