key

Documentation

Index

• Constants
• func EncodeWithBlockType(b []byte, blockType string) []byte
• type EcdsaKey
  • func NewEcdsaKey(curve elliptic.Curve) *EcdsaKey
  • func (g *EcdsaKey) Gen() (crypto.Signer, error)
  • func (g *EcdsaKey) Marshal(pkey crypto.Signer, opts *MarshalOptions) ([]byte, error)
  • func (g *EcdsaKey) MarshalECPrivateKey(pkey *ecdsa.PrivateKey, password []byte) ([]byte, error)
  • func (g *EcdsaKey) MarshalPKCS8PrivateKey(pkey interface{}) ([]byte, error)
• type Generator
• type MarshalOptions
• type RsaKey
  • func NewRsaKey(bits int) *RsaKey
  • func (g *RsaKey) Gen() (crypto.Signer, error)
  • func (g *RsaKey) Marshal(pkey crypto.Signer, opts *MarshalOptions) ([]byte, error)
  • func (g *RsaKey) MarshalPKCS1PrivateKey(pkey *rsa.PrivateKey, password []byte) ([]byte, error)
  • func (g *RsaKey) MarshalPKCS8PrivateKey(pkey any) ([]byte, error)

Constants

const (
	RsaBlockType         = "RSA PRIVATE KEY"
	EcdsaBlockType       = "EC PRIVATE KEY"
	PKCCS8BlockType      = "PRIVATE KEY"
	DefaultKeyLength     = 2048
	RecommendedKeyLength = 4096
)

Functions

func EncodeWithBlockType

func EncodeWithBlockType(b []byte, blockType string) []byte

EncodeWithBlockType returns the PEM encoding of b with the given block type. If b has invalid headers and cannot be encoded, Encode returns nil.

Types

type EcdsaKey

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

func NewEcdsaKey

func NewEcdsaKey(curve elliptic.Curve) *EcdsaKey

NewEcdsaKey return an Ecdsa key generator.

func (*EcdsaKey) Gen

func (g *EcdsaKey) Gen() (crypto.Signer, error)

Gen generates a public and private key pair. And returns a crypto.Singer.

func (*EcdsaKey) Marshal

func (g *EcdsaKey) Marshal(pkey crypto.Signer, opts *MarshalOptions) ([]byte, error)

Marshal converts an EC private key to SEC 1 or PKCS#8, ASN.1 DER form. And returns the private key encoded in PEM blocks.

func (*EcdsaKey) MarshalECPrivateKey

func (g *EcdsaKey) MarshalECPrivateKey(pkey *ecdsa.PrivateKey, password []byte) ([]byte, error)

MarshalECPrivateKey converts an EC private key to SEC 1, ASN.1 DER form. And returns the private key encoded in PEM blocks.

func (*EcdsaKey) MarshalPKCS8PrivateKey

func (g *EcdsaKey) MarshalPKCS8PrivateKey(pkey interface{}) ([]byte, error)

MarshalPKCS8PrivateKey converts a private key to PKCS #8, ASN.1 DER form. And returns the private key encoded in PEM blocks.

type Generator

type Generator interface {
	// Gen generates a public and private key pair.
	// And returns a crypto.Singer.
	Gen() (crypto.Signer, error)
	// Marshal converts a private key to ASN.1 DER form.
	// And returns the private key encoded in PEM blocks.
	// The opts is optional.
	Marshal(pkey crypto.Signer, opts *MarshalOptions) ([]byte, error)
}

type MarshalOptions

type MarshalOptions struct {
	// Password can be nil, otherwise use it to encrypt the private key.
	// If the IsPKCS8 is true, the Password will be ignored.
	// See https://github.com/golang/go/commit/57af9745bfad2c20ed6842878e373d6c5b79285a.
	Password []byte
	// IsPKCS8 whether to convert the private key to PKCS #8, ASN.1 DER form.
	IsPKCS8 bool
}

type RsaKey

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

func NewRsaKey

func NewRsaKey(bits int) *RsaKey

NewRsaKey return an RSA key generator. If the bit size less than 2048 bits, set to 2048 bits.

func (*RsaKey) Gen

func (g *RsaKey) Gen() (crypto.Signer, error)

Gen generates a public and private key pair. And returns a crypto.Singer.

func (*RsaKey) Marshal

func (g *RsaKey) Marshal(pkey crypto.Signer, opts *MarshalOptions) ([]byte, error)

Marshal converts an RSA private key to PKCS #1 or PKCS #8, ASN.1 DER form. And returns the private key encoded in PEM blocks.

func (*RsaKey) MarshalPKCS1PrivateKey

func (g *RsaKey) MarshalPKCS1PrivateKey(pkey *rsa.PrivateKey, password []byte) ([]byte, error)

MarshalPKCS1PrivateKey converts an RSA private key to PKCS #1, ASN.1 DER form. And returns the private key encoded in PEM blocks.

func (*RsaKey) MarshalPKCS8PrivateKey

func (g *RsaKey) MarshalPKCS8PrivateKey(pkey any) ([]byte, error)

MarshalPKCS8PrivateKey converts a private key to PKCS #8, ASN.1 DER form. And returns the private key encoded in PEM blocks.