keyring

Documentation

Overview

keyring provides utilities for loading and using crypto keys in different formats

Index

• type Key
  • func From(raw interface{}) (Key, error)
  • func Open(path string) (Key, error)
  • func OpenWithPassphrase(path string, passphrase []byte) (Key, error)
  • func Parse(bytes []byte) (Key, error)
  • func ParseString(s string) (Key, error)
  • func ParseWithPassphrase(bytes []byte, passphrase []byte) (Key, error)

Types

type Key

type Key interface {
	Comment() string
	IsPrivate() bool
	JWASignatureAlgorithm() (jwa.SignatureAlgorithm, error)
	JWK() jwk.Key
	JWKThumbprintSHA256() (string, error)
	JWKThumbprintURI() (string, error)
	PublicKey() (Key, error)
	Raw() (interface{}, error)
	SignJWT(jwt.Token) ([]byte, error)
	SignJWTWithAgent(agent.ExtendedAgent, jwt.Token) ([]byte, error)
	SSHFingerprintSHA256() (string, error)
	SSHPublicKey() (ssh.PublicKey, error)
}

func From

func From(raw interface{}) (Key, error)

From creates a Key from go crypto/* types

func Open

func Open(path string) (Key, error)

Open reads a key from file, returning a Key

func OpenWithPassphrase

func OpenWithPassphrase(path string, passphrase []byte) (Key, error)

Open reads a key from file using the provided passphrase, returning a Key

func Parse

func Parse(bytes []byte) (Key, error)

Parse parses raw key bytes

func ParseString

func ParseString(s string) (Key, error)

ParseString is a shortcut for calling Parse with a string

func ParseWithPassphrase

func ParseWithPassphrase(bytes []byte, passphrase []byte) (Key, error)

Parse parses raw key bytes using the provided passphrase