Documentation
¶
Index ¶
- Variables
- type CertificateAuthority
- func (*CertificateAuthority) Descriptor() ([]byte, []int)deprecated
- func (x *CertificateAuthority) GetPrivateId() string
- func (x *CertificateAuthority) GetVersion() uint32
- func (*CertificateAuthority) ProtoMessage()
- func (x *CertificateAuthority) ProtoReflect() protoreflect.Message
- func (x *CertificateAuthority) Reset()
- func (x *CertificateAuthority) String() string
- type Controller
- func (*Controller) Descriptor() ([]byte, []int)deprecated
- func (x *Controller) GetAddress() string
- func (x *Controller) GetCreateTime() *timestamp.Timestamp
- func (x *Controller) GetDescription() string
- func (x *Controller) GetPrivateId() string
- func (x *Controller) GetUpdateTime() *timestamp.Timestamp
- func (*Controller) ProtoMessage()
- func (x *Controller) ProtoReflect() protoreflect.Message
- func (x *Controller) Reset()
- func (x *Controller) String() string
- func (Controller) TableName() string
- type RootCertificate
- func (*RootCertificate) Descriptor() ([]byte, []int)deprecated
- func (x *RootCertificate) GetCertificate() []byte
- func (x *RootCertificate) GetIssuingCa() string
- func (x *RootCertificate) GetKeyId() string
- func (x *RootCertificate) GetNotValidAfter() *timestamp.Timestamp
- func (x *RootCertificate) GetNotValidBefore() *timestamp.Timestamp
- func (x *RootCertificate) GetPrivateKey() []byte
- func (x *RootCertificate) GetPublicKey() []byte
- func (x *RootCertificate) GetSerialNumber() uint64
- func (x *RootCertificate) GetState() string
- func (*RootCertificate) ProtoMessage()
- func (x *RootCertificate) ProtoReflect() protoreflect.Message
- func (x *RootCertificate) Reset()
- func (x *RootCertificate) String() string
- type Worker
- func (*Worker) Descriptor() ([]byte, []int)deprecated
- func (x *Worker) GetAddress() string
- func (x *Worker) GetCreateTime() *timestamp.Timestamp
- func (x *Worker) GetDescription() string
- func (x *Worker) GetLastStatusTime() *timestamp.Timestamp
- func (x *Worker) GetName() string
- func (x *Worker) GetPublicId() string
- func (x *Worker) GetScopeId() string
- func (x *Worker) GetType() string
- func (x *Worker) GetUpdateTime() *timestamp.Timestamp
- func (x *Worker) GetVersion() uint32
- func (*Worker) ProtoMessage()
- func (x *Worker) ProtoReflect() protoreflect.Message
- func (x *Worker) Reset()
- func (x *Worker) String() string
- type WorkerAuth
- func (*WorkerAuth) Descriptor() ([]byte, []int)deprecated
- func (x *WorkerAuth) GetControllerEncryptionPrivKey() []byte
- func (x *WorkerAuth) GetKeyId() string
- func (x *WorkerAuth) GetNonce() []byte
- func (x *WorkerAuth) GetWorkerEncryptionPubKey() []byte
- func (x *WorkerAuth) GetWorkerId() string
- func (x *WorkerAuth) GetWorkerKeyIdentifier() string
- func (x *WorkerAuth) GetWorkerSigningPubKey() []byte
- func (*WorkerAuth) ProtoMessage()
- func (x *WorkerAuth) ProtoReflect() protoreflect.Message
- func (x *WorkerAuth) Reset()
- func (x *WorkerAuth) String() string
- type WorkerCertBundle
- func (*WorkerCertBundle) Descriptor() ([]byte, []int)deprecated
- func (x *WorkerCertBundle) GetCertBundle() []byte
- func (x *WorkerCertBundle) GetRootCertificatePublicKey() []byte
- func (x *WorkerCertBundle) GetWorkerKeyIdentifier() string
- func (*WorkerCertBundle) ProtoMessage()
- func (x *WorkerCertBundle) ProtoReflect() protoreflect.Message
- func (x *WorkerCertBundle) Reset()
- func (x *WorkerCertBundle) String() string
- type WorkerTag
- func (*WorkerTag) Descriptor() ([]byte, []int)deprecated
- func (x *WorkerTag) GetKey() string
- func (x *WorkerTag) GetSource() string
- func (x *WorkerTag) GetValue() string
- func (x *WorkerTag) GetWorkerId() string
- func (*WorkerTag) ProtoMessage()
- func (x *WorkerTag) ProtoReflect() protoreflect.Message
- func (x *WorkerTag) Reset()
- func (x *WorkerTag) String() string
- func (WorkerTag) TableName() string
Constants ¶
This section is empty.
Variables ¶
var File_controller_storage_servers_store_v1_controller_proto protoreflect.FileDescriptor
var File_controller_storage_servers_store_v1_root_certificate_proto protoreflect.FileDescriptor
var File_controller_storage_servers_store_v1_worker_auth_proto protoreflect.FileDescriptor
var File_controller_storage_servers_store_v1_worker_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type CertificateAuthority ¶
type CertificateAuthority struct {
// @inject_tag: `gorm:"primary_key"`
PrivateId string `protobuf:"bytes,10,opt,name=private_id,json=privateId,proto3" json:"private_id,omitempty" gorm:"primary_key"`
// version allows optimistic locking of the resource.
// @inject_tag: `gorm:"default:null"`
Version uint32 `protobuf:"varint,20,opt,name=version,proto3" json:"version,omitempty" gorm:"default:null"`
// contains filtered or unexported fields
}
CertificateAuthority is a versioned entity used to lock the database when rotation RootCertificates
func (*CertificateAuthority) Descriptor
deprecated
func (*CertificateAuthority) Descriptor() ([]byte, []int)
Deprecated: Use CertificateAuthority.ProtoReflect.Descriptor instead.
func (*CertificateAuthority) GetPrivateId ¶
func (x *CertificateAuthority) GetPrivateId() string
func (*CertificateAuthority) GetVersion ¶
func (x *CertificateAuthority) GetVersion() uint32
func (*CertificateAuthority) ProtoMessage ¶
func (*CertificateAuthority) ProtoMessage()
func (*CertificateAuthority) ProtoReflect ¶
func (x *CertificateAuthority) ProtoReflect() protoreflect.Message
func (*CertificateAuthority) Reset ¶
func (x *CertificateAuthority) Reset()
func (*CertificateAuthority) String ¶
func (x *CertificateAuthority) String() string
type Controller ¶
type Controller struct {
// Private ID of the resource
PrivateId string `protobuf:"bytes,10,opt,name=private_id,json=privateId,proto3" json:"private_id,omitempty"`
// Address for the controller
Address string `protobuf:"bytes,20,opt,name=address,proto3" json:"address,omitempty"`
// Description of the resource (optional)
// @inject_tag: `gorm:"default:null"`
Description string `protobuf:"bytes,30,opt,name=description,proto3" json:"description,omitempty" gorm:"default:null"`
// First seen time from the RDBMS
CreateTime *timestamp.Timestamp `protobuf:"bytes,40,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Last time there was an update
UpdateTime *timestamp.Timestamp `protobuf:"bytes,50,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
Controller contains all fields related to a Controller resource
func (*Controller) Descriptor
deprecated
func (*Controller) Descriptor() ([]byte, []int)
Deprecated: Use Controller.ProtoReflect.Descriptor instead.
func (*Controller) GetAddress ¶
func (x *Controller) GetAddress() string
func (*Controller) GetCreateTime ¶
func (x *Controller) GetCreateTime() *timestamp.Timestamp
func (*Controller) GetDescription ¶
func (x *Controller) GetDescription() string
func (*Controller) GetPrivateId ¶
func (x *Controller) GetPrivateId() string
func (*Controller) GetUpdateTime ¶
func (x *Controller) GetUpdateTime() *timestamp.Timestamp
func (*Controller) ProtoMessage ¶
func (*Controller) ProtoMessage()
func (*Controller) ProtoReflect ¶
func (x *Controller) ProtoReflect() protoreflect.Message
func (*Controller) Reset ¶
func (x *Controller) Reset()
func (*Controller) String ¶
func (x *Controller) String() string
func (Controller) TableName ¶
func (Controller) TableName() string
TableName overrides the table name used by Controller to `server_controller`
type RootCertificate ¶
type RootCertificate struct {
// The serial number of the root certificate
// @inject_tag: `gorm:"not_null"`
SerialNumber uint64 `protobuf:"varint,10,opt,name=serial_number,json=serialNumber,proto3" json:"serial_number,omitempty" gorm:"not_null"`
// Certificate is the PEM encoded certificate.
// @inject_tag: `gorm:"not_null"`
Certificate []byte `protobuf:"bytes,20,opt,name=certificate,proto3" json:"certificate,omitempty" gorm:"not_null"`
// Not valid before is the timestamp at which this certificate's validity period starts
NotValidBefore *timestamp.Timestamp `protobuf:"bytes,30,opt,name=not_valid_before,json=notValidBefore,proto3" json:"not_valid_before,omitempty"`
// Not valid after is the timestamp at which this certificate's validity period ends
NotValidAfter *timestamp.Timestamp `protobuf:"bytes,40,opt,name=not_valid_after,json=notValidAfter,proto3" json:"not_valid_after,omitempty"`
// The public key associated with this certificate
// @inject_tag: `gorm:"not_null"`
PublicKey []byte `protobuf:"bytes,50,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty" gorm:"not_null"`
// The private key associated with this certificate
// This is a ciphertext field
// @inject_tag: `gorm:"not_null"`
PrivateKey []byte `protobuf:"bytes,60,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty" gorm:"not_null"`
// The id of the kms database key used for encrypting this entry.
// @inject_tag: `gorm:"not_null"`
KeyId string `protobuf:"bytes,70,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty" gorm:"not_null"`
// State is an enum value indicating if this is the next or current root cert
// @inject_tag: `gorm:"not_null"`
State string `protobuf:"bytes,80,opt,name=state,proto3" json:"state,omitempty" gorm:"not_null"`
// A reference to the CertificateAuthority
// @inject_tag: `gorm:"not_null"`
IssuingCa string `protobuf:"bytes,90,opt,name=issuing_ca,json=issuingCa,proto3" json:"issuing_ca,omitempty" gorm:"not_null"`
// contains filtered or unexported fields
}
RootCertificate contains all fields related to a RootCertificate resource
func (*RootCertificate) Descriptor
deprecated
func (*RootCertificate) Descriptor() ([]byte, []int)
Deprecated: Use RootCertificate.ProtoReflect.Descriptor instead.
func (*RootCertificate) GetCertificate ¶
func (x *RootCertificate) GetCertificate() []byte
func (*RootCertificate) GetIssuingCa ¶
func (x *RootCertificate) GetIssuingCa() string
func (*RootCertificate) GetKeyId ¶
func (x *RootCertificate) GetKeyId() string
func (*RootCertificate) GetNotValidAfter ¶
func (x *RootCertificate) GetNotValidAfter() *timestamp.Timestamp
func (*RootCertificate) GetNotValidBefore ¶
func (x *RootCertificate) GetNotValidBefore() *timestamp.Timestamp
func (*RootCertificate) GetPrivateKey ¶
func (x *RootCertificate) GetPrivateKey() []byte
func (*RootCertificate) GetPublicKey ¶
func (x *RootCertificate) GetPublicKey() []byte
func (*RootCertificate) GetSerialNumber ¶
func (x *RootCertificate) GetSerialNumber() uint64
func (*RootCertificate) GetState ¶
func (x *RootCertificate) GetState() string
func (*RootCertificate) ProtoMessage ¶
func (*RootCertificate) ProtoMessage()
func (*RootCertificate) ProtoReflect ¶
func (x *RootCertificate) ProtoReflect() protoreflect.Message
func (*RootCertificate) Reset ¶
func (x *RootCertificate) Reset()
func (*RootCertificate) String ¶
func (x *RootCertificate) String() string
type Worker ¶
type Worker struct {
// public_id is a surrogate key suitable for use in a public API
// @inject_tag: `gorm:"primary_key"`
PublicId string `protobuf:"bytes,10,opt,name=public_id,json=publicId,proto3" json:"public_id,omitempty" gorm:"primary_key"`
// Name of the resource (optional)
// @inject_tag: `gorm:"default:null"`
Name string `protobuf:"bytes,20,opt,name=name,proto3" json:"name,omitempty" gorm:"default:null"`
// Description of the resource (optional)
// @inject_tag: `gorm:"default:null"`
Description string `protobuf:"bytes,30,opt,name=description,proto3" json:"description,omitempty" gorm:"default:null"`
// Address for the worker. This is optional.
// @inject_tag: `gorm:"default:null"`
Address string `protobuf:"bytes,40,opt,name=address,proto3" json:"address,omitempty" gorm:"default:null"`
// The create_time is set by the database.
// @inject_tag: `gorm:"default:current_timestamp"`
CreateTime *timestamp.Timestamp `protobuf:"bytes,50,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty" gorm:"default:current_timestamp"`
// The update_time is set by the database.
// @inject_tag: `gorm:"default:current_timestamp"`
UpdateTime *timestamp.Timestamp `protobuf:"bytes,60,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty" gorm:"default:current_timestamp"`
// The scope_id of the owning scope and must be set.
// @inject_tag: `gorm:"not_null"`
ScopeId string `protobuf:"bytes,70,opt,name=scope_id,json=scopeId,proto3" json:"scope_id,omitempty" gorm:"not_null"`
// version allows optimistic locking of the resource.
// @inject_tag: `gorm:"default:null"`
Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty" gorm:"default:null"`
// The last_status_time is the last time a worker daemon sent a status update.
// @inject_tag: `gorm:"default:null"`
LastStatusTime *timestamp.Timestamp `` /* 127-byte string literal not displayed */
// The type of the worker, denoted by how it authenticates: pki or kms.
// @inject_tag: `gorm:"not_null"`
Type string `protobuf:"bytes,130,opt,name=type,proto3" json:"type,omitempty" gorm:"not_null"`
// contains filtered or unexported fields
}
Worker contains all fields related to a Worker resource
func (*Worker) Descriptor
deprecated
func (*Worker) GetAddress ¶
func (*Worker) GetCreateTime ¶
func (*Worker) GetDescription ¶
func (*Worker) GetLastStatusTime ¶
func (*Worker) GetPublicId ¶
func (*Worker) GetScopeId ¶
func (*Worker) GetUpdateTime ¶
func (*Worker) GetVersion ¶
func (*Worker) ProtoMessage ¶
func (*Worker) ProtoMessage()
func (*Worker) ProtoReflect ¶
func (x *Worker) ProtoReflect() protoreflect.Message
type WorkerAuth ¶
type WorkerAuth struct {
// The key id for this worker auth record, generated from the signing pub key
// @inject_tag: `gorm:"primary_key"`
WorkerKeyIdentifier string `` /* 140-byte string literal not displayed */
// The worker id this worker authentication record is for
// @inject_tag: `gorm:"not_null"`
WorkerId string `protobuf:"bytes,20,opt,name=worker_id,json=workerId,proto3" json:"worker_id,omitempty" gorm:"not_null"`
// The worker's public signing key
// @inject_tag: `gorm:"not_null"`
WorkerSigningPubKey []byte `` /* 139-byte string literal not displayed */
// The worker's public encryption key
// @inject_tag: `gorm:"not_null"`
WorkerEncryptionPubKey []byte `` /* 148-byte string literal not displayed */
// The private key associated with this certificate
// This is a ciphertext field
// @inject_tag: `gorm:"not_null"`
ControllerEncryptionPrivKey []byte `` /* 163-byte string literal not displayed */
// The id of the kms database key used for encrypting this entry.
// @inject_tag: `gorm:"not_null"`
KeyId string `protobuf:"bytes,60,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty" gorm:"not_null"`
// Nonce used by a worker in authenticating
// @inject_tag: `gorm:"default:null"`
Nonce []byte `protobuf:"bytes,70,opt,name=nonce,proto3" json:"nonce,omitempty" gorm:"default:null"`
// contains filtered or unexported fields
}
WorkerAuth contains all fields related to an authorized Worker resource
func (*WorkerAuth) Descriptor
deprecated
func (*WorkerAuth) Descriptor() ([]byte, []int)
Deprecated: Use WorkerAuth.ProtoReflect.Descriptor instead.
func (*WorkerAuth) GetControllerEncryptionPrivKey ¶
func (x *WorkerAuth) GetControllerEncryptionPrivKey() []byte
func (*WorkerAuth) GetKeyId ¶
func (x *WorkerAuth) GetKeyId() string
func (*WorkerAuth) GetNonce ¶
func (x *WorkerAuth) GetNonce() []byte
func (*WorkerAuth) GetWorkerEncryptionPubKey ¶
func (x *WorkerAuth) GetWorkerEncryptionPubKey() []byte
func (*WorkerAuth) GetWorkerId ¶
func (x *WorkerAuth) GetWorkerId() string
func (*WorkerAuth) GetWorkerKeyIdentifier ¶
func (x *WorkerAuth) GetWorkerKeyIdentifier() string
func (*WorkerAuth) GetWorkerSigningPubKey ¶
func (x *WorkerAuth) GetWorkerSigningPubKey() []byte
func (*WorkerAuth) ProtoMessage ¶
func (*WorkerAuth) ProtoMessage()
func (*WorkerAuth) ProtoReflect ¶
func (x *WorkerAuth) ProtoReflect() protoreflect.Message
func (*WorkerAuth) Reset ¶
func (x *WorkerAuth) Reset()
func (*WorkerAuth) String ¶
func (x *WorkerAuth) String() string
type WorkerCertBundle ¶
type WorkerCertBundle struct {
// The public key of the issuing root certificate
// @inject_tag: `gorm:"primary_key"`
RootCertificatePublicKey []byte `` /* 157-byte string literal not displayed */
// The WorkerAuth worker_key_identifier this cert bundle record is for
// @inject_tag: `gorm:"primary_key"`
WorkerKeyIdentifier string `` /* 140-byte string literal not displayed */
// CertBundle is the marshaled protobuf certificate bundle for a WorkerAuth
// @inject_tag: `gorm:"not_null"`
CertBundle []byte `protobuf:"bytes,30,opt,name=cert_bundle,json=certBundle,proto3" json:"cert_bundle,omitempty" gorm:"not_null"`
// contains filtered or unexported fields
}
WorkerCertBundle contains all fields related to a WorkerCertBundle resource
func (*WorkerCertBundle) Descriptor
deprecated
func (*WorkerCertBundle) Descriptor() ([]byte, []int)
Deprecated: Use WorkerCertBundle.ProtoReflect.Descriptor instead.
func (*WorkerCertBundle) GetCertBundle ¶
func (x *WorkerCertBundle) GetCertBundle() []byte
func (*WorkerCertBundle) GetRootCertificatePublicKey ¶
func (x *WorkerCertBundle) GetRootCertificatePublicKey() []byte
func (*WorkerCertBundle) GetWorkerKeyIdentifier ¶
func (x *WorkerCertBundle) GetWorkerKeyIdentifier() string
func (*WorkerCertBundle) ProtoMessage ¶
func (*WorkerCertBundle) ProtoMessage()
func (*WorkerCertBundle) ProtoReflect ¶
func (x *WorkerCertBundle) ProtoReflect() protoreflect.Message
func (*WorkerCertBundle) Reset ¶
func (x *WorkerCertBundle) Reset()
func (*WorkerCertBundle) String ¶
func (x *WorkerCertBundle) String() string
type WorkerTag ¶
type WorkerTag struct {
// worker_id is the public key that key of the worker this tag is for.
// @inject_tag: `gorm:"primary_key"`
WorkerId string `protobuf:"bytes,10,opt,name=worker_id,json=workerId,proto3" json:"worker_id,omitempty" gorm:"primary_key"`
// key is the key of the tag. This must be set.
// @inject_tag: `gorm:"primary_key"`
Key string `protobuf:"bytes,20,opt,name=key,proto3" json:"key,omitempty" gorm:"primary_key"`
// value is the value
// @inject_tag: `gorm:"primary_key"`
Value string `protobuf:"bytes,30,opt,name=value,proto3" json:"value,omitempty" gorm:"primary_key"`
// source is the source of the tag. Either 'configuration' or 'api'.
// @inject_tag: `gorm:"primary_key"`
Source string `protobuf:"bytes,40,opt,name=source,proto3" json:"source,omitempty" gorm:"primary_key"`
// contains filtered or unexported fields
}
WorkerTag is a tag for a worker. The primary key is comprised of the worker_id, key, value, and source.
func (*WorkerTag) Descriptor
deprecated
func (*WorkerTag) GetWorkerId ¶
func (*WorkerTag) ProtoMessage ¶
func (*WorkerTag) ProtoMessage()
func (*WorkerTag) ProtoReflect ¶
func (x *WorkerTag) ProtoReflect() protoreflect.Message