Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

nkeys

package module

Go to main page

Versions in this module

v0

v0.3.2

Jul 20, 2021

v0.3.1

Jul 19, 2021

Changes in this version

+ const SignatureSize

+ var ErrIncompatibleKey = errors.New("nkeys: incompatible key")

+ var SeedSize = curve.Params().BitSize/8 + 8

+ func CompatibleKeyPair(kp KeyPair, expected ...PrefixByte) error

+ func GenerateKey(raw []byte) (PublicKey, PrivateKey, error)

+ func ParseDecoratedJWT(contents []byte) (string, error)

+ func Sign(priv PrivateKey, input []byte) ([]byte, error)

+ func Verify(pub PublicKey, message, sig []byte) bool

type KeyPair

+ func ParseDecoratedNKey(contents []byte) (KeyPair, error)

+ func ParseDecoratedUserNKey(contents []byte) (KeyPair, error)

type PrefixByte

+ const PrefixByteUnknown

+ type PrivateKey []byte

+ type PublicKey []byte

v0.0.1

Nov 27, 2018

Changes in this version

+ const Version

+ var ErrCannotSign = errors.New("nkeys: can not sign, no private key available")

+ var ErrInvalidChecksum = errors.New("nkeys: invalid checksum")

+ var ErrInvalidEncoding = errors.New("nkeys: invalid encoded key")

+ var ErrInvalidKey = errors.New("nkeys: invalid key")

+ var ErrInvalidPrefixByte = errors.New("nkeys: invalid prefix byte")

+ var ErrInvalidPublicKey = errors.New("nkeys: invalid public key")

+ var ErrInvalidSeed = errors.New("nkeys: invalid seed")

+ var ErrInvalidSeedLen = errors.New("nkeys: invalid seed length")

+ var ErrInvalidSignature = errors.New("nkeys: signature verification failed")

+ var ErrPublicKeyOnly = errors.New("nkeys: no seed or private key available")

+ func Decode(expectedPrefix PrefixByte, src []byte) ([]byte, error)

+ func Encode(prefix PrefixByte, src []byte) ([]byte, error)

+ func EncodeSeed(public PrefixByte, src []byte) ([]byte, error)

+ func IsValidEncoding(src []byte) bool

+ func IsValidPublicAccountKey(src string) bool

+ func IsValidPublicClusterKey(src string) bool

+ func IsValidPublicKey(src string) bool

+ func IsValidPublicOperatorKey(src string) bool

+ func IsValidPublicServerKey(src string) bool

+ func IsValidPublicUserKey(src string) bool

+ type KeyPair interface

+ PrivateKey func() ([]byte, error)

+ PublicKey func() (string, error)

+ Seed func() ([]byte, error)

+ Sign func(input []byte) ([]byte, error)

+ Verify func(input []byte, sig []byte) error

+ Wipe func()

+ func CreateAccount() (KeyPair, error)

+ func CreateCluster() (KeyPair, error)

+ func CreateOperator() (KeyPair, error)

+ func CreatePair(prefix PrefixByte) (KeyPair, error)

+ func CreateServer() (KeyPair, error)

+ func CreateUser() (KeyPair, error)

+ func FromPublicKey(public string) (KeyPair, error)

+ func FromRawSeed(prefix PrefixByte, rawSeed []byte) (KeyPair, error)

+ func FromSeed(seed []byte) (KeyPair, error)

+ type PrefixByte byte

+ const PrefixByteAccount

+ const PrefixByteCluster

+ const PrefixByteOperator

+ const PrefixBytePrivate

+ const PrefixByteSeed

+ const PrefixByteServer

+ const PrefixByteUknown

+ const PrefixByteUser

+ func DecodeSeed(src []byte) (PrefixByte, []byte, error)

+ func Prefix(src string) PrefixByte

+ func (p PrefixByte) String() string