package kms

Get desktop application:
View/edit binary Protocol Buffers messages

The keyhouse service definition

• rpc EncodeDataKey (EncodeDataKeyRequest, EncodeDataKeyResponse)

  keyhouse.proto:11

  message EncodeDataKeyRequest

  keyhouse.proto:21

  The request message for encoding services

  • string token = 1

  • string alias = 2

    Key Alias is a semantic reference to a unique key. It consists of a 8 or more ASCII characters limited to alphanum and (_) and (-) characters followed by the version, prefixed with the KeyRing ID that key belongs to. Key Alias is an optional field and is defaulted to Key ID.

  • bool prefer_channel_identity = 3

  • bytes custom_raw_key = 4

  message EncodeDataKeyResponse

  keyhouse.proto:36

  The response message for encoding services

  • int32 error_code = 1

  • bytes encoded_key = 2

    encoded key with metadata

  • bytes decoded_key = 3

    256-bit key

• rpc DecodeDataKey (DecodeDataKeyRequest, DecodeDataKeyResponse)

  keyhouse.proto:12

  message DecodeDataKeyRequest

  keyhouse.proto:29

  The request message for decoding services

  • string token = 1

  • bytes encoded_key = 2

    encoded key with metadata

  • bool prefer_channel_identity = 3

  message DecodeDataKeyResponse

  keyhouse.proto:43

  The response message for encoding services

  • int32 error_code = 1

  • bytes decoded_key = 2

    256-bit key

• rpc PingPong (PingPongRequest, PingPongResponse)

  keyhouse.proto:13

  message PingPongRequest

  keyhouse.proto:49

  The request message for Ping Pong service

  • string token = 1

  • bytes timestamp = 2

    unix ms epoch for creation time

  • bool prefer_channel_identity = 3

  message PingPongResponse

  keyhouse.proto:56

  The response message for Ping Pong service

  • int32 error_code = 1

  • bytes timestamp = 2

    unix ms epoch for creation time

• rpc GetSecret (GetSecretRequest, GetSecretResponse)

  keyhouse.proto:14

  message GetSecretRequest

  keyhouse.proto:76

  The request message for GetSecret

  • string token = 1

  • string alias = 2

    Key Alias is a semantic reference to a unique secret. It consists of a 8 or more ASCII characters limited to alphanum and (_) and (-) characters, prefixed with the KeyRing Alias and Customer Key Alias that key belongs to.

  • bool prefer_channel_identity = 3

  message GetSecretResponse

  keyhouse.proto:83

  The response message for GetSecret

  • int32 error_code = 1

  • string secret = 2

• rpc GetSecrets (GetSecretsRequest, GetSecretsResponse)

  keyhouse.proto:15

  message GetSecretsRequest

  keyhouse.proto:89

  The request message for GetSecrets

  • string token = 1

  • string alias = 2

    Key Alias is a semantic reference to a unique customer key. It consists of a 8 or more ASCII characters limited to alphanum and (_) and (-) characters, prefixed with the KeyRing Alias that key belongs to.

  • bool prefer_channel_identity = 3

  message GetSecretsResponse

  keyhouse.proto:96

  The response message for GetSecrets

  • int32 error_code = 1

  • map<string, string> secrets = 2

    map of secret alias (without customer key or keyring alias) to secret values for the given customer key

• rpc StoreSecret (StoreSecretRequest, StoreSecretResponse)

  keyhouse.proto:16

  message StoreSecretRequest

  keyhouse.proto:102

  The request message for StoreSecret

  • string token = 1

  • string alias = 2

    Key Alias is a semantic reference to a unique secret. It consists of a 8 or more ASCII characters limited to alphanum and (_) and (-) characters, prefixed with the KeyRing Alias and Customer Key Alias that key belongs to.

  • string secret = 3

  • bool prefer_channel_identity = 4

  message StoreSecretResponse

  keyhouse.proto:110

  The response message for StoreSecret

  • int32 error_code = 1

• rpc GetLegacyKey (GetLegacyKeyRequest, GetLegacyKeyResponse)

  keyhouse.proto:17

  message GetLegacyKeyRequest

  keyhouse.proto:115

  The request message for decoding services

  • string token = 1

  • string alias = 2

    Key Alias is a semantic reference to a unique key. It consists of a 8 or more ASCII characters limited to alphanum and (_) and (-) characters followed by the version, prefixed with the KeyRing ID that key belongs to. Key Alias is an optional field and is defaulted to Key ID.

  • bool prefer_channel_identity = 3

  message GetLegacyKeyResponse

  keyhouse.proto:122

  The response message for encoding services

  • int32 error_code = 1

  • bytes data_key = 2

The request message for Sign

• string token = 1

• string alias = 2

  Key Alias is a semantic reference to a unique key. It consists of a 8 or more ASCII characters limited to alphanum and (_) and (-) characters followed by the version, prefixed with the KeyRing ID that key belongs to. Key Alias is an optional field and is defaulted to Key ID.

• bytes orig_hash = 3

  SHA512 hash of they key id that has given alias

• bool prefer_channel_identity = 4

The response message for Sign and Verify services

• int32 error_code = 1

• bool verified = 2

  status of the verification