safe

Documentation

Index

• type GenericRequest
• type GenericResponse
• type KeyInputRequest
• type KeystoneStatusRequest
• type KeystoneStatusResponse
• type SecretDeleteRequest
• type SecretDeleteResponse
• type SecretEncryptedListResponse
• type SecretFetchRequest
• type SecretFetchResponse
• type SecretListRequest
• type SecretListResponse
• type SecretUpsertRequest
• type SecretUpsertResponse
• type SentinelInitCompleteRequest
• type SentinelInitCompleteResponse

Types

type GenericRequest

type GenericRequest struct {
	Err string `json:"err,omitempty"`
}

GenericRequest is the request for generic operations.

type GenericResponse

type GenericResponse struct {
	Err string `json:"err,omitempty"`
}

GenericResponse is the response for generic operations.

type KeyInputRequest

type KeyInputRequest struct {
	AgeSecretKey string `json:"ageSecretKey"`
	AgePublicKey string `json:"agePublicKey"`
	AesCipherKey string `json:"aesCipherKey"`
	Err          string `json:"err,omitempty"`
}

KeyInputRequest is the request to provide new root encryption keys to VSecM Safe.

type KeystoneStatusRequest

type KeystoneStatusRequest struct {
	Err string `json:"err,omitempty"`
}

KeystoneStatusRequest is the request to check the status of VSecM Keystone.

type KeystoneStatusResponse

type KeystoneStatusResponse struct {
	Status data.InitStatus `json:"status"`
	Err    string          `json:"err,omitempty"`
}

KeystoneStatusResponse is the response to a KeystoneStatusRequest.

type SecretDeleteRequest

type SecretDeleteRequest struct {
	WorkloadIds []string `json:"workloads"`
	Err         string   `json:"err,omitempty"`
}

SecretDeleteRequest is the request to delete a secret.

type SecretDeleteResponse

type SecretDeleteResponse struct {
	Err string `json:"err,omitempty"`
}

SecretDeleteResponse is the response to a SecretDeleteRequest.

type SecretEncryptedListResponse

type SecretEncryptedListResponse struct {
	Secrets   []data.SecretEncrypted `json:"secrets"`
	Algorithm crypto.Algorithm       `json:"algorithm"`
	Err       string                 `json:"err,omitempty"`
}

SecretEncryptedListResponse is the response that lists secrets The secret values will be encrypted.

type SecretFetchRequest

type SecretFetchRequest struct {
	Err string `json:"err,omitempty"`
}

SecretFetchRequest is the request to fetch a secret.

type SecretFetchResponse

type SecretFetchResponse struct {
	Data    string `json:"data"`
	Created string `json:"created"`
	Updated string `json:"updated"`
	Err     string `json:"err,omitempty"`
}

SecretFetchResponse is the response to a SecretFetchRequest.

type SecretListRequest

type SecretListRequest struct {
	Err string `json:"err,omitempty"`
}

SecretListRequest is the request to list secrets. The response will not contain the secret values.

type SecretListResponse

type SecretListResponse struct {
	Secrets []data.Secret `json:"secrets"`
	Err     string        `json:"err,omitempty"`
}

SecretListResponse is the response to a SecretListRequest.

type SecretUpsertRequest

type SecretUpsertRequest struct {
	WorkloadIds []string          `json:"workloads"`
	Namespaces  []string          `json:"namespaces"`
	Value       string            `json:"value"`
	Template    string            `json:"template"`
	Format      data.SecretFormat `json:"format"`
	Encrypt     bool              `json:"encrypt"`
	AppendValue bool              `json:"appendValue"`
	NotBefore   string            `json:"notBefore"`
	Expires     string            `json:"expires"`

	Err string `json:"err,omitempty"`
}

SecretUpsertRequest is the request to upsert a secret.

type SecretUpsertResponse

type SecretUpsertResponse struct {
	Err string `json:"err,omitempty"`
}

SecretUpsertResponse is the response to upsert a secret.

type SentinelInitCompleteRequest

type SentinelInitCompleteRequest struct {
	Err string `json:"err,omitempty"`
}

SentinelInitCompleteRequest is the request to notify that VSecM Sentinel has completed initialization.

type SentinelInitCompleteResponse

type SentinelInitCompleteResponse struct {
	Err string `json:"err,omitempty"`
}

SentinelInitCompleteResponse is the response to SentinelInitCompleteRequest.