fingerprint

Documentation

Overview

Package fingerprint provides a way to generate a visually verifiable fingerprint of keys.

Index

• type Display
  • func NewDisplay() *Display
  • func (d *Display) CreateFor(localIdentityKey, remoteIdentityKey []byte) string
• type Fingerprint
  • func NewFingerprint(displayFingerprint *Display) *Fingerprint
  • func (f *Fingerprint) Display() *Display
  • func (f *Fingerprint) Scan() string
• type FingerprintGenerator

Types

type Display

type Display struct{}

Display is a structure for displayable fingerprints.

func NewDisplay

func NewDisplay() *Display

NewDisplay will return a new displayable fingerprint.

func (*Display) CreateFor

func (d *Display) CreateFor(localIdentityKey, remoteIdentityKey []byte) string

CreateFor create

type Fingerprint

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

Fingerprint is a structure for returning a displayable and scannable fingerprint for identity verification.

func NewFingerprint

func NewFingerprint(displayFingerprint *Display) *Fingerprint

NewFingerprint will return a new Fingerprint structure.

func (*Fingerprint) Display

func (f *Fingerprint) Display() *Display

Display will return a fingerprint display structure for getting a string representation of given keys.

func (*Fingerprint) Scan

func (f *Fingerprint) Scan() string

Scan will return a fingerprint scan structure for getting a scannable representation of given keys.

type FingerprintGenerator

type FingerprintGenerator interface {
	CreateFor(localStableIdentifier, remoteStableIdentifier string, localIdentityKey, remoteIdentityKey *identity.Key) *Fingerprint
	CreateForMultiple(localStableIdentifier, remoteStableIdentifier string, localIdentityKey, remoteIdentityKey []*identity.Key) *Fingerprint
}

FingerprintGenerator is an interface for fingerprint generators.