Documentation
¶
Overview ¶
Package keyutil provides some basic PEM and JWK key handling without dependencies. It is not meant as a replacement for a full key handling library.
Index ¶
- Constants
- func MustReadPrivateKey(encodedPrivateKey []byte) crypto.PrivateKey
- func MustReadPrivateKeyFile(pkFile string) crypto.PrivateKey
- func MustReadPrivateKeyFileECDSA(pkFile string) *ecdsa.PrivateKey
- func MustReadPrivateKeyFileED25519(pkFile string) ed25519.PrivateKey
- func MustReadPublicKeyFile(pubkeyFile string) crypto.PublicKey
- func ReadPrivateKey(encodedPrivateKey []byte) (crypto.PrivateKey, error)
- func ReadPrivateKeyFile(pkFile string) (crypto.PrivateKey, error)
- func ReadPublicKey(encodedPubkey []byte) (crypto.PublicKey, error)
- func ReadPublicKeyFile(pubkeyFile string) (crypto.PublicKey, error)
- type JWK
Constants ¶
const ( KeyTypeEC = "EC" KeyTypeOct = "oct" )
Variables ¶
This section is empty.
Functions ¶
func MustReadPrivateKey ¶
func MustReadPrivateKey(encodedPrivateKey []byte) crypto.PrivateKey
func MustReadPrivateKeyFile ¶
func MustReadPrivateKeyFile(pkFile string) crypto.PrivateKey
MustReadPrivateKeyFile decodes a PEM encoded private key file and parses into a crypto.PrivateKey or panics.
func MustReadPrivateKeyFileECDSA ¶ added in v1.2.0
func MustReadPrivateKeyFileECDSA(pkFile string) *ecdsa.PrivateKey
func MustReadPrivateKeyFileED25519 ¶ added in v1.2.0
func MustReadPrivateKeyFileED25519(pkFile string) ed25519.PrivateKey
func MustReadPublicKeyFile ¶
MustReadPublicKeyFile reads a PEM encoded public key file or panics
func ReadPrivateKey ¶
func ReadPrivateKey(encodedPrivateKey []byte) (crypto.PrivateKey, error)
ReadPrivateKey decoded a PEM encoded private key and parses into a crypto.PrivateKey.
func ReadPrivateKeyFile ¶
func ReadPrivateKeyFile(pkFile string) (crypto.PrivateKey, error)
ReadPrivateKeyFile opens the given file and calls ReadPrivateKey to return a crypto.PrivateKey
func ReadPublicKey ¶
ReadPublicKey decodes a PEM encoded public key and parses into crypto.PublicKey
Types ¶
type JWK ¶ added in v1.0.3
type JWK struct {
// Common fields are duplicated as struct members for better usability.
KeyType string // 'kty' - "EC", "RSA", "oct"
Algorithm string // 'alg'
KeyID string // 'kid'
// contains filtered or unexported fields
}
JWK provides basic data and usage for a JWK.
func FromPrivateKey ¶ added in v1.0.3
func FromPrivateKey(pkey crypto.PrivateKey) (JWK, error)
FromPrivateKey creates a JWK from a crypto.PrivateKey. 'kty' is set based on the passed in PrivateKey.
func ReadJWKFile ¶ added in v1.0.3
func ReadJWKFromPEM ¶ added in v1.0.3
ReadJWKFromPEM converts a PEM encoded private key to JWK. 'kty' is set based on the passed in PrivateKey type.
func (JWK) MarshalJSON ¶ added in v1.0.3
func (*JWK) PrivateKey ¶ added in v1.0.3
func (ji *JWK) PrivateKey() (crypto.PrivateKey, error)
Source Files