tkatype

Documentation

Overview

Package tkatype defines types for working with the tka package.

Do not add extra dependencies to this package unless they are tiny, because this package encodes wire types that should be lightweight to use.

Index

• type AUMSigHash
• type KeyID
• type MarshaledAUM
• type MarshaledSignature
• type NKSSigHash
• type Signature

Types

type AUMSigHash

type AUMSigHash [32]byte

AUMSigHash represents the BLAKE2s digest of an Authority Update Message (AUM), sans any signatures.

type KeyID

type KeyID []byte

KeyID references a verification key stored in the key authority. A keyID uniquely identifies a key. KeyIDs are all 32 bytes.

For 25519 keys: We just use the 32-byte public key.

Even though this is a 32-byte value, we use a byte slice because CBOR-encoded byte slices have a different prefix to CBOR-encoded arrays. Encoding as a byte slice allows us to change the size in the future if we ever need to.

type MarshaledAUM

type MarshaledAUM []byte

MarshaledAUM represents a marshaled tka.AUM.

type MarshaledSignature

type MarshaledSignature []byte

MarshaledSignature represents a marshaled tka.NodeKeySignature.

type NKSSigHash

type NKSSigHash [32]byte

NKSSigHash represents the BLAKE2s digest of a Node-Key Signature (NKS), sans the Signature field if present.

type Signature

type Signature struct {
	KeyID     KeyID  `cbor:"1,keyasint"`
	Signature []byte `cbor:"2,keyasint"`
}

Signature describes a signature over an AUM, which can be verified using the key referenced by KeyID.