key

Documentation

Overview

Package key defines some types related to curve25519 keys.

Index

• type Private
  • func NewPrivate() Private
  • func (k Private) B32() *[32]byte
  • func (p Private) IsZero() bool
  • func (k Private) Public() Public
  • func (k Private) SharedSecret(pub Public) (ss [32]byte)
• type Public
  • func NewPublicFromHexMem(m mem.RO) (Public, error)
  • func (k Public) B32() *[32]byte
  • func (p Public) IsZero() bool
  • func (p Public) MarshalText() ([]byte, error)
  • func (p Public) ShortString() string
  • func (p *Public) UnmarshalText(txt []byte) error

Types

type Private

type Private [32]byte

Private represents a curve25519 private key.

func NewPrivate

func NewPrivate() Private

NewPrivate returns a new private key.

func (Private) B32

func (k Private) B32() *[32]byte

B32 returns k as the *[32]byte type that's used by the golang.org/x/crypto packages. This allocates; it might not be appropriate for performance-sensitive paths.

func (Private) IsZero

func (p Private) IsZero() bool

Private reports whether p is the zero value.

func (Private) Public

func (k Private) Public() Public

func (Private) SharedSecret

func (k Private) SharedSecret(pub Public) (ss [32]byte)

type Public

type Public [32]byte

Public represents a curve25519 public key.

func NewPublicFromHexMem

func NewPublicFromHexMem(m mem.RO) (Public, error)

NewPublicFromHexMem parses a public key in its hex form, given in m. The provided m must be exactly 64 bytes in length.

func (Public) B32

func (k Public) B32() *[32]byte

B32 returns k as the *[32]byte type that's used by the golang.org/x/crypto packages. This allocates; it might not be appropriate for performance-sensitive paths.

func (Public) IsZero

func (p Public) IsZero() bool

Public reports whether p is the zero value.

func (Public) MarshalText

func (p Public) MarshalText() ([]byte, error)

func (Public) ShortString

func (p Public) ShortString() string

ShortString returns the Tailscale conventional debug representation of a public key: the first five base64 digits of the key, in square brackets.

func (*Public) UnmarshalText

func (p *Public) UnmarshalText(txt []byte) error