Skip to content

Commit

Permalink
fixup! docs: add docs for Sealed Secrets
Browse files Browse the repository at this point in the history
  • Loading branch information
Xynnn007 committed Jul 27, 2023
1 parent cb2f747 commit bdda230
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions confidential-datahub/docs/SEALED_SECRET.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Secrets.
This kind of secret uses envelope encryption scheme. A wrapping key is used
to encrypt the plaintext secret value. A sealing key insde a KMS is used to
seal the wrapping key. That is

$```
Sealed Secret := \{Enc_{kms key}(Wrapping Key), Enc_{Wrapping Key}(secret value)\}
```$
Expand Down Expand Up @@ -54,7 +55,7 @@ Here,
- `provider`: indicates the provider of the __kms key__. This field determines
how to use the `annotations` field and `key_id` field to decrypt the `encrypted_key`
- `key_id`: To uniquely distinguish the __kms key__ used to encrypt the __wrapping key__,
which is always used by the provider plugin.
which is always used by the provider d'r'i'v'e'r.
- `encrypted_key`: Encrypted __wrapping key__ by the `provider`. Base64 encoded.
- `encrypted_data`: Encrypted __secret value__ by the `encrypted_key`. Base64 encoded.
- `wrap_type`: The algorithm used by __wrapping key__ to encrypt the __secret value__.
Expand Down Expand Up @@ -86,7 +87,7 @@ Here,
- `type`: MUST be `vault`, indicating this is a Vault type Sealed Secret.
- `provider`: indicates the provider of the __secret value__. This field determines
how to use the `annotations` field and `name` field to get the plaintext of __secret value__.
- `name`: To uniquely distinguish the __secret value__, which is always used by the provider plugin.
- `name`: To uniquely distinguish the __secret value__, which is always used by the provider driver.
- `annotations`: A key-value Map. Vault specific information used by the provider driver to
get the plaintext of the __secret value__.

Expand Down

0 comments on commit bdda230

Please sign in to comment.