Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIKey ¶
type APIKey struct { // creator Creator *Contact `json:"creator,omitempty"` // key // Required: true Key *string `json:"key"` // org Id // Required: true OrgID *string `json:"orgId"` }
APIKey API key swagger:model APIKey
func (*APIKey) MarshalBinary ¶
MarshalBinary interface implementation
func (*APIKey) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Client ¶
type Client struct { // id // Required: true ID *string `json:"id"` // public key // Required: true PublicKey *PublicKey `json:"publicKey"` // sdk Sdk string `json:"sdk,omitempty"` }
Client client swagger:model Client
func (*Client) MarshalBinary ¶
MarshalBinary interface implementation
func (*Client) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Contact ¶
type Contact struct { // email // Required: true Email *string `json:"email"` // name // Required: true Name *string `json:"name"` // phone Phone string `json:"phone,omitempty"` }
Contact contact swagger:model Contact
func (*Contact) MarshalBinary ¶
MarshalBinary interface implementation
func (*Contact) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type CryptoConfig ¶
type CryptoConfig struct { // the bit length of all new client keys, for example, 2048 ClientKeyBitlength int64 `json:"clientKeyBitlength,omitempty"` // the TTL on the client's local asymetric key ClientKeyTTL int64 `json:"clientKeyTTL,omitempty"` // the type of key that should be associated with clients, for example, rsa ClientKeyType string `json:"clientKeyType,omitempty"` // id // Required: true ID *string `json:"id"` // the org id of the organization that owns these symmetric keys // Required: true OwnerOrgID *string `json:"ownerOrgId"` // to guide SDK's on how to select an encryption domain, a selectorScheme helps an SDK map a encryption request to a set of keys and encryption algoritm // Required: true SymmetricKeyUseDomainSelectorScheme *string `json:"symmetricKeyUseDomainSelectorScheme"` // every application layer encryption must select a key to use from one specific active semmetric key encryption domain. this is an array of encryption domains id's that are currently available for encryption // Required: true SymmetricKeyUseDomains []*SymmetricKeyUseDomain `json:"symmetricKeyUseDomains"` }
CryptoConfig crypto config swagger:model CryptoConfig
func (*CryptoConfig) MarshalBinary ¶
func (m *CryptoConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CryptoConfig) UnmarshalBinary ¶
func (m *CryptoConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EncryptedSymmetricKey ¶
type EncryptedSymmetricKey struct { // id's of the symmetric keys encrypted in packedCiphertext // Required: true KeyIds []string `json:"keyIds"` // length of the keys encrypted in packedCiphertext // Required: true KeyLength *int64 `json:"keyLength"` // the actual packaged ciphertext of the encrypted symmetric key, of key // Required: true PackagedCiphertext *string `json:"packagedCiphertext"` // id of the symmetric key use domain which contains this key // Required: true SymmetricKeyUseDomainID *string `json:"symmetricKeyUseDomainId"` }
EncryptedSymmetricKey encrypted symmetric key swagger:model EncryptedSymmetricKey
func (*EncryptedSymmetricKey) MarshalBinary ¶
func (m *EncryptedSymmetricKey) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EncryptedSymmetricKey) UnmarshalBinary ¶
func (m *EncryptedSymmetricKey) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HeatbeatResponse ¶
type HeatbeatResponse struct { // an array of symmetri key requests for this ker deriver instance // Required: true Requests []*SymmetricKeyRequest `json:"requests"` }
HeatbeatResponse heatbeat response swagger:model HeatbeatResponse
func (*HeatbeatResponse) MarshalBinary ¶
func (m *HeatbeatResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HeatbeatResponse) UnmarshalBinary ¶
func (m *HeatbeatResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KeyDerivationInstance ¶
type KeyDerivationInstance struct { // currently online and accepting requests for key derivation // Required: true Active *bool `json:"active"` // base URL from which this key deriver instance will respond to new key derivation job requests BaseURL string `json:"baseUrl,omitempty"` // instance id (concrete instance) // Required: true ID *string `json:"id"` // service id (virtual service id) // Required: true ServiceIds []string `json:"serviceIds"` // version // Required: true Version *string `json:"version"` }
KeyDerivationInstance key derivation instance swagger:model KeyDerivationInstance
func (*KeyDerivationInstance) MarshalBinary ¶
func (m *KeyDerivationInstance) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KeyDerivationInstance) UnmarshalBinary ¶
func (m *KeyDerivationInstance) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Log ¶
type Log struct { // client Id // Required: true ClientID *string `json:"clientId"` // event // Required: true Event *string `json:"event"` }
Log log swagger:model Log
func (*Log) MarshalBinary ¶
MarshalBinary interface implementation
func (*Log) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type LoginResponse ¶
type LoginResponse struct { // org Org *Organization `json:"Org,omitempty"` // if set, please display this message to the user on login MessageOftheDay string `json:"messageOftheDay,omitempty"` // if true, then the user is not attached to an existing org, and must create a new org MustCreateOrg bool `json:"mustCreateOrg,omitempty"` }
LoginResponse login response swagger:model LoginResponse
func (*LoginResponse) MarshalBinary ¶
func (m *LoginResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LoginResponse) UnmarshalBinary ¶
func (m *LoginResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Organization ¶
type Organization struct { // Array of api keys registered to this org // Required: true APIKeys []*APIKey `json:"apiKeys"` // Array of client id's registered to this org // Required: true ClientIds []string `json:"clientIds"` // contacts // Required: true Contacts []*Contact `json:"contacts"` // cryptoconfigId of this org // Required: true CryptoConfigID *string `json:"cryptoConfigId"` // id // Required: true ID *string `json:"id"` // name // Required: true Name *string `json:"name"` // Identifies the the customer in Stripe associated with this org // Required: true StripeCustomerID *string `json:"stripeCustomerId"` }
Organization organization swagger:model Organization
func (*Organization) MarshalBinary ¶
func (m *Organization) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Organization) UnmarshalBinary ¶
func (m *Organization) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PublicKey ¶
type PublicKey struct { // creation time // Required: true CreationTime *int64 `json:"creationTime"` // encoding // Required: true Encoding *string `json:"encoding"` // id // Required: true ID *string `json:"id"` // key // Required: true Key *string `json:"key"` // key type // Required: true KeyType *string `json:"keyType"` }
PublicKey public key swagger:model PublicKey
func (*PublicKey) MarshalBinary ¶
MarshalBinary interface implementation
func (*PublicKey) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SymmetricKeyRequest ¶
type SymmetricKeyRequest struct { // Epoch time of the symmetric key requestion request time. // Required: true CreationTime *int64 `json:"creationTime"` // These are the keyId's to deliver all of the derived symmetric keys. // Required: true DeliveryPublicKeyIds []string `json:"deliveryPublicKeyIds"` // These are the keyId's of for the symmetric keys to actually derive. // Required: true DeriveSymmetricKeyIds []string `json:"deriveSymmetricKeyIds"` // Id of the symmetric key request. // Required: true ID *string `json:"id"` // The serviceId that must generate these keys. // Required: true KeyDerivationServiceID *string `json:"keyDerivationServiceId"` // If true the key deriver must sign delivered symmetric keys ciphertext blobs // Required: true MustSignDeliveredSymmetricKeys *bool `json:"mustSignDeliveredSymmetricKeys"` // After deriving symmetric keys, this determines the ciphertext packaging scheme required for encrypted key delivery. // Required: true PackagedCiphertextVersion *int64 `json:"packagedCiphertextVersion"` // Length in bytes of the derived symmetric keys. // Required: true SymmetricKeyLength *int64 `json:"symmetricKeyLength"` }
SymmetricKeyRequest symmetric key request swagger:model SymmetricKeyRequest
func (*SymmetricKeyRequest) MarshalBinary ¶
func (m *SymmetricKeyRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SymmetricKeyRequest) UnmarshalBinary ¶
func (m *SymmetricKeyRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SymmetricKeyUseDomain ¶
type SymmetricKeyUseDomain struct { // creation time // Required: true CreationTime *int64 `json:"creationTime"` // after encrypting new plaintexts, package the ciphertext with this version of the packaged ciphertext // Required: true EncryptingPackagedCiphertextVersion *int64 `json:"encryptingPackagedCiphertextVersion"` // these are the semmetric key id's that belong to this use domain - these keys never belong to any other use domain // Required: true EncryptionKeyIds []string `json:"encryptionKeyIds"` // if all registered kds service become unreachable, then incoming requests for new and existing keys may fallback to the cloud provided KDS // Required: true EndableKDSFallbackToCloud *bool `json:"endableKDSFallbackToCloud"` // id // Required: true ID *string `json:"id"` // name Name string `json:"name,omitempty"` // the org id of the organization that owns these symmetric keys // Required: true OwnerOrgID *string `json:"ownerOrgId"` // if required, all clients must receive these keys in a signed symmetric key delivery from the key deriver // Required: true RequireSignedKeyDelivery *bool `json:"requireSignedKeyDelivery"` // number of seconds since key creation that the key will be available for decryption // Required: true SymmetricKeyDecryptionUseTTL *int64 `json:"symmetricKeyDecryptionUseTTL"` // the symmetric key derivation serivce id that can derive and wrap these keys // Required: true SymmetricKeyDerivationServiceID *string `json:"symmetricKeyDerivationServiceId"` // the specific encryption alg to encrypt new plaintexts for application layer encryption operations // Required: true SymmetricKeyEncryptionAlg *string `json:"symmetricKeyEncryptionAlg"` // number of seconds since key creation that the key will be available for encryption // Required: true SymmetricKeyEncryptionUseTTL *int64 `json:"symmetricKeyEncryptionUseTTL"` // number of seconds since key creation that the key will be available for encryption // Required: true SymmetricKeyInceptionTTL *int64 `json:"symmetricKeyInceptionTTL"` // the number of bits of all symmetric keys in this use domain // Required: true SymmetricKeyLength *int64 `json:"symmetricKeyLength"` // number of seconds since key creation that the key will be available for retention purposes // Required: true SymmetricKeyRetentionUseTTL *int64 `json:"symmetricKeyRetentionUseTTL"` }
SymmetricKeyUseDomain symmetric key use domain swagger:model SymmetricKeyUseDomain
func (*SymmetricKeyUseDomain) MarshalBinary ¶
func (m *SymmetricKeyUseDomain) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SymmetricKeyUseDomain) UnmarshalBinary ¶
func (m *SymmetricKeyUseDomain) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation