keyrecovery

Documentation

Overview

Package keyrecovery provides utility functions and structures allowing credential management.

Package keyrecovery provides utility functions and structures allowing credential management.

Index

• func Recover(conf *internal.Configuration, ...) (clientSecretKey *group.Scalar, clientPublicKey *group.Point, export []byte, ...)
• type Credentials
• type Envelope
  • func Store(conf *internal.Configuration, randomizedPwd, serverPublicKey []byte, ...) (env *Envelope, pku *group.Point, export []byte)
  • func (e *Envelope) Serialize() []byte

Functions

func Recover

func Recover(
	conf *internal.Configuration,
	randomizedPwd, serverPublicKey, clientIdentity, serverIdentity []byte,
	envelope *Envelope,
) (clientSecretKey *group.Scalar, clientPublicKey *group.Point, export []byte, err error)

Recover returns the client's private and public key, as well as the secret export key.

Types

type Credentials

type Credentials struct {
	ClientIdentity, ServerIdentity []byte
	EnvelopeNonce, MaskingNonce    []byte // testing: integrated to support testing
}

Credentials structure is currently used for testing purposes.

type Envelope

type Envelope struct {
	Nonce   []byte
	AuthTag []byte
}

Envelope represents the OPAQUE envelope.

func Store

func Store(
	conf *internal.Configuration,
	randomizedPwd, serverPublicKey []byte,
	creds *Credentials,
) (env *Envelope, pku *group.Point, export []byte)

Store returns the client's Envelope, the masking key for the registration, and the additional export key.

func (*Envelope) Serialize

func (e *Envelope) Serialize() []byte

Serialize returns the byte serialization of the envelope.