keyspb

Documentation

Overview

Package keyspb is a generated protocol buffer package.

It is generated from these files:

crypto/keyspb/keyspb.proto

It has these top-level messages:

Specification
PEMKeyFile
PrivateKey
PublicKey
PKCS11Config

Index

• Variables
• type PEMKeyFile
  • func (*PEMKeyFile) Descriptor() ([]byte, []int)
  • func (m *PEMKeyFile) GetPassword() string
  • func (m *PEMKeyFile) GetPath() string
  • func (*PEMKeyFile) ProtoMessage()
  • func (m *PEMKeyFile) Reset()
  • func (m *PEMKeyFile) String() string
• type PKCS11Config
  • func (*PKCS11Config) Descriptor() ([]byte, []int)
  • func (m *PKCS11Config) GetPin() string
  • func (m *PKCS11Config) GetPublicKey() string
  • func (m *PKCS11Config) GetTokenLabel() string
  • func (*PKCS11Config) ProtoMessage()
  • func (m *PKCS11Config) Reset()
  • func (m *PKCS11Config) String() string
• type PrivateKey
  • func (*PrivateKey) Descriptor() ([]byte, []int)
  • func (m *PrivateKey) GetDer() []byte
  • func (*PrivateKey) ProtoMessage()
  • func (m *PrivateKey) Reset()
  • func (m *PrivateKey) String() string
• type PublicKey
  • func (*PublicKey) Descriptor() ([]byte, []int)
  • func (m *PublicKey) GetDer() []byte
  • func (*PublicKey) ProtoMessage()
  • func (m *PublicKey) Reset()
  • func (m *PublicKey) String() string
• type Specification
  • func (*Specification) Descriptor() ([]byte, []int)
  • func (m *Specification) GetEcdsaParams() *Specification_ECDSA
  • func (m *Specification) GetParams() isSpecification_Params
  • func (m *Specification) GetRsaParams() *Specification_RSA
  • func (*Specification) ProtoMessage()
  • func (m *Specification) Reset()
  • func (m *Specification) String() string
  • func (*Specification) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
• type Specification_ECDSA
  • func (*Specification_ECDSA) Descriptor() ([]byte, []int)
  • func (m *Specification_ECDSA) GetCurve() Specification_ECDSA_Curve
  • func (*Specification_ECDSA) ProtoMessage()
  • func (m *Specification_ECDSA) Reset()
  • func (m *Specification_ECDSA) String() string
• type Specification_ECDSA_Curve
  • func (Specification_ECDSA_Curve) EnumDescriptor() ([]byte, []int)
  • func (x Specification_ECDSA_Curve) String() string
• type Specification_EcdsaParams
• type Specification_RSA
  • func (*Specification_RSA) Descriptor() ([]byte, []int)
  • func (m *Specification_RSA) GetBits() int32
  • func (*Specification_RSA) ProtoMessage()
  • func (m *Specification_RSA) Reset()
  • func (m *Specification_RSA) String() string
• type Specification_RsaParams

Variables

var Specification_ECDSA_Curve_name = map[int32]string{
	0: "DEFAULT_CURVE",
	1: "P256",
	2: "P384",
	3: "P521",
}

var Specification_ECDSA_Curve_value = map[string]int32{
	"DEFAULT_CURVE": 0,
	"P256":          1,
	"P384":          2,
	"P521":          3,
}

Types

type PEMKeyFile

type PEMKeyFile struct {
	// File path of the private key.
	Path string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
	// Password for decrypting the private key.
	// If empty, indicates that the private key is not encrypted.
	Password string `protobuf:"bytes,2,opt,name=password" json:"password,omitempty"`
}

PEMKeyFile identifies a private key stored in a PEM-encoded file.

func (*PEMKeyFile) Descriptor

func (*PEMKeyFile) Descriptor() ([]byte, []int)

func (*PEMKeyFile) GetPassword

func (m *PEMKeyFile) GetPassword() string

func (*PEMKeyFile) GetPath

func (m *PEMKeyFile) GetPath() string

func (*PEMKeyFile) ProtoMessage

func (*PEMKeyFile) ProtoMessage()

func (*PEMKeyFile) Reset

func (m *PEMKeyFile) Reset()

func (*PEMKeyFile) String

func (m *PEMKeyFile) String() string

type PKCS11Config

type PKCS11Config struct {
	// The label of the PKCS#11 token.
	TokenLabel string `protobuf:"bytes,1,opt,name=token_label,json=tokenLabel" json:"token_label,omitempty"`
	// The PIN for the specific token.
	Pin string `protobuf:"bytes,2,opt,name=pin" json:"pin,omitempty"`
	// The PEM public key assosciated with the private key to be used.
	PublicKey string `protobuf:"bytes,3,opt,name=public_key,json=publicKey" json:"public_key,omitempty"`
}

PKCS11Config identifies a private key accessed using PKCS #11.

func (*PKCS11Config) Descriptor

func (*PKCS11Config) Descriptor() ([]byte, []int)

func (*PKCS11Config) GetPin

func (m *PKCS11Config) GetPin() string

func (*PKCS11Config) GetPublicKey

func (m *PKCS11Config) GetPublicKey() string

func (*PKCS11Config) GetTokenLabel

func (m *PKCS11Config) GetTokenLabel() string

func (*PKCS11Config) ProtoMessage

func (*PKCS11Config) ProtoMessage()

func (*PKCS11Config) Reset

func (m *PKCS11Config) Reset()

func (*PKCS11Config) String

func (m *PKCS11Config) String() string

type PrivateKey

type PrivateKey struct {
	// The key in DER-encoded form.
	// The specific format (e.g. PKCS8) is not specified.
	Der []byte `protobuf:"bytes,1,opt,name=der,proto3" json:"der,omitempty"`
}

PrivateKey is a private key, used for generating signatures.

func (*PrivateKey) Descriptor

func (*PrivateKey) Descriptor() ([]byte, []int)

func (*PrivateKey) GetDer

func (m *PrivateKey) GetDer() []byte

func (*PrivateKey) ProtoMessage

func (*PrivateKey) ProtoMessage()

func (*PrivateKey) Reset

func (m *PrivateKey) Reset()

func (*PrivateKey) String

func (m *PrivateKey) String() string

type PublicKey

type PublicKey struct {
	// The key in DER-encoded PKIX form.
	Der []byte `protobuf:"bytes,1,opt,name=der,proto3" json:"der,omitempty"`
}

PublicKey is a public key, used for verifying signatures.

func (*PublicKey) Descriptor

func (*PublicKey) Descriptor() ([]byte, []int)

func (*PublicKey) GetDer

func (m *PublicKey) GetDer() []byte

func (*PublicKey) ProtoMessage

func (*PublicKey) ProtoMessage()

func (*PublicKey) Reset

func (m *PublicKey) Reset()

func (*PublicKey) String

func (m *PublicKey) String() string

type Specification

type Specification struct {
	// The type of parameters provided determines the algorithm used for the key.
	//
	// Types that are valid to be assigned to Params:
	//	*Specification_EcdsaParams
	//	*Specification_RsaParams
	Params isSpecification_Params `protobuf_oneof:"params"`
}

Specification for a private key.

func (*Specification) Descriptor

func (*Specification) Descriptor() ([]byte, []int)

func (*Specification) GetEcdsaParams

func (m *Specification) GetEcdsaParams() *Specification_ECDSA

func (*Specification) GetParams

func (m *Specification) GetParams() isSpecification_Params

func (*Specification) GetRsaParams

func (m *Specification) GetRsaParams() *Specification_RSA

func (*Specification) ProtoMessage

func (*Specification) ProtoMessage()

func (*Specification) Reset

func (m *Specification) Reset()

func (*Specification) String

func (m *Specification) String() string

func (*Specification) XXX_OneofFuncs

func (*Specification) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type Specification_ECDSA

type Specification_ECDSA struct {
	// The elliptic curve to use.
	// Optional. If not set, the default curve will be used.
	Curve Specification_ECDSA_Curve `protobuf:"varint,1,opt,name=curve,enum=keyspb.Specification_ECDSA_Curve" json:"curve,omitempty"`
}

/ ECDSA defines parameters for an ECDSA key.

func (*Specification_ECDSA) Descriptor

func (*Specification_ECDSA) Descriptor() ([]byte, []int)

func (*Specification_ECDSA) GetCurve

func (m *Specification_ECDSA) GetCurve() Specification_ECDSA_Curve

func (*Specification_ECDSA) ProtoMessage

func (*Specification_ECDSA) ProtoMessage()

func (*Specification_ECDSA) Reset

func (m *Specification_ECDSA) Reset()

func (*Specification_ECDSA) String

func (m *Specification_ECDSA) String() string

type Specification_ECDSA_Curve

type Specification_ECDSA_Curve int32

The supported elliptic curves.

const (
	Specification_ECDSA_DEFAULT_CURVE Specification_ECDSA_Curve = 0
	Specification_ECDSA_P256          Specification_ECDSA_Curve = 1
	Specification_ECDSA_P384          Specification_ECDSA_Curve = 2
	Specification_ECDSA_P521          Specification_ECDSA_Curve = 3
)

func (Specification_ECDSA_Curve) EnumDescriptor

func (Specification_ECDSA_Curve) EnumDescriptor() ([]byte, []int)

func (Specification_ECDSA_Curve) String

func (x Specification_ECDSA_Curve) String() string

type Specification_EcdsaParams

type Specification_EcdsaParams struct {
	EcdsaParams *Specification_ECDSA `protobuf:"bytes,1,opt,name=ecdsa_params,json=ecdsaParams,oneof"`
}

type Specification_RSA

type Specification_RSA struct {
	// Size of the keys in bits. Must be sufficiently large to allow two primes
	// to be generated.
	// Optional. If not set, the key size will be chosen by Trillian.
	Bits int32 `protobuf:"varint,1,opt,name=bits" json:"bits,omitempty"`
}

RSA defines parameters for an RSA key.

func (*Specification_RSA) Descriptor

func (*Specification_RSA) Descriptor() ([]byte, []int)

func (*Specification_RSA) GetBits

func (m *Specification_RSA) GetBits() int32

func (*Specification_RSA) ProtoMessage

func (*Specification_RSA) ProtoMessage()

func (*Specification_RSA) Reset

func (m *Specification_RSA) Reset()

func (*Specification_RSA) String

func (m *Specification_RSA) String() string

type Specification_RsaParams

type Specification_RsaParams struct {
	RsaParams *Specification_RSA `protobuf:"bytes,2,opt,name=rsa_params,json=rsaParams,oneof"`
}