encryptionkey

Documentation

Overview

Package encryptionkey manages encryption keys for users

Index

• Constants
• func DecodeTurnkeyPrivateKey(encodedPrivateKey string) (*kem.PrivateKey, error)
• func DecodeTurnkeyPublicKey(encodedPublicKey string) (*kem.PublicKey, error)
• func EncodePrivateKey(privateKey kem.PrivateKey) (string, error)
• func EncodePublicKey(publicKey kem.PublicKey) (string, error)
• type Key
  • func FromKemPrivateKey(privateKey kem.PrivateKey) (*Key, error)
  • func FromTurnkeyPrivateKey(encodedPrivateKey string) (*Key, error)
  • func New(userID string, organizationID string) (*Key, error)
  • func (k Key) GetCurve() string
  • func (k Key) GetMetadata() Metadata
  • func (k Key) GetPrivateKey() string
  • func (k Key) GetPublicKey() string
  • func (k Key) LoadMetadata(fn string) (*Metadata, error)
  • func (k *Key) MergeMetadata(md Metadata) error
• type Metadata

Constants

const KemID hpke.KEM = hpke.KEM_P256_HKDF_SHA256

KemID for HPKE protocol.

Functions

func DecodeTurnkeyPrivateKey

func DecodeTurnkeyPrivateKey(encodedPrivateKey string) (*kem.PrivateKey, error)

DecodeTurnkeyPrivateKey takes a Turnkey-encoded private key and creates a KEM private key.

func DecodeTurnkeyPublicKey

func DecodeTurnkeyPublicKey(encodedPublicKey string) (*kem.PublicKey, error)

DecodeTurnkeyPublicKey takes a Turnkey-encoded public key and creates a KEM public key.

func EncodePrivateKey

func EncodePrivateKey(privateKey kem.PrivateKey) (string, error)

EncodePrivateKey encodes a KEM private key into the Turnkey format. For now, "Turnkey format" = raw DER form.

func EncodePublicKey

func EncodePublicKey(publicKey kem.PublicKey) (string, error)

EncodePublicKey encodes a KEM public key into the Turnkey format. For now, "Turnkey format" = raw DER form.

Types

type Key

type Key struct {
	Metadata

	TkPrivateKey string `json:"-"` // do not store the private key in the metadata file
	TkPublicKey  string `json:"public_key"`
	// contains filtered or unexported fields
}

Key defines a structure in which to hold both serialized and ecdh-lib-friendly versions of a Turnkey Encryption keypair.

func FromKemPrivateKey

func FromKemPrivateKey(privateKey kem.PrivateKey) (*Key, error)

FromKemPrivateKey takes a HPKE KEM keypair and forms a Turnkey encryption key from it. Assumes that privateKey.Public() has already been derived.

func FromTurnkeyPrivateKey

func FromTurnkeyPrivateKey(encodedPrivateKey string) (*Key, error)

FromTurnkeyPrivateKey takes a Turnkey-encoded private key, derives a public key from it, and then returns the corresponding Turnkey API key.

func New

func New(userID string, organizationID string) (*Key, error)

New generates a new Turnkey encryption key.

func (Key) GetCurve

func (k Key) GetCurve() string

GetCurve returns the curve used.

func (Key) GetMetadata

func (k Key) GetMetadata() Metadata

GetMetadata gets the key's metadata.

func (Key) GetPrivateKey

func (k Key) GetPrivateKey() string

GetPrivateKey gets the key's private key.

func (Key) GetPublicKey

func (k Key) GetPublicKey() string

GetPublicKey gets the key's public key.

func (Key) LoadMetadata

func (k Key) LoadMetadata(fn string) (*Metadata, error)

LoadMetadata loads a JSON metadata file.

func (*Key) MergeMetadata

func (k *Key) MergeMetadata(md Metadata) error

MergeMetadata merges the given metadata with the api key.

type Metadata

type Metadata struct {
	Name         string `json:"name"`
	Organization string `json:"organization"`
	User         string `json:"user"`
	PublicKey    string `json:"public_key"`
}

Metadata stores non-secret metadata about the Encryption key.