You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix(docs): Update kas-registry docs with new shape. (#154)
1.) Update kas-registry docs to fit the new `key_management` way of
importing/creating key and connecting an attribute to a specific key.
---------
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Copy file name to clipboardExpand all lines: docs/components/policy/key_access_registry.md
+8-40Lines changed: 8 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,43 +5,11 @@ The Key Access Server (KAS) Registry within the platform policy is a store of kn
5
5
Within platform policy, a registered KAS instance has the following key attributes:
6
6
7
7
1.**URI**: The location where the KAS is accessible. This must be unique among all KAS instances registered in the platform.
8
-
2.**Public Key Location**:
9
-
1.**Remote**: A public key available at an endpoint, such as `https://kas-one.com/public_key`.
10
-
2.**Cached**: One or more public keys stored within the platform policy database (see the example below).
11
-
12
-
These traits are essential for managing KAS Grants to attributes and their associated key splits in encryption and decryption processes.
13
-
14
-
#### Cached Key Example
15
-
16
-
```json5
17
-
{
18
-
"cached": {
19
-
// One or more known public keys for the KAS
20
-
"keys": [
21
-
{
22
-
// x509 ASN.1 content in PEM format
23
-
"pem":"<your PEM certificate>",
24
-
// key identifier
25
-
"kid":"<your key id>",
26
-
// key algorithm (see below)
27
-
"alg":1
28
-
}
29
-
]
30
-
}
31
-
}
32
-
```
33
-
34
-
1. The `"pem"` field should contain the full certificate, for example:
35
-
`-----BEGIN CERTIFICATE-----
36
-
MIIB...5Q=
37
-
-----END CERTIFICATE-----
38
-
`.
39
-
40
-
2. The `"kid"` field represents the key identifier, which is primarily used for key rotation.
41
-
42
-
3. The `"alg"` field specifies the key algorithm used:
43
-
44
-
| Key Algorithm |`alg` Value |
45
-
| ----------------- | ----------- |
46
-
|`rsa:2048`| 1 |
47
-
|`ec:secp256r1`| 5 |
8
+
2.**Source Type**: Indicates whether the KAS is managed by the organization or imported from an external party. (Defaults to unspecified)
9
+
3.**Name**: A friendly name for the registered KAS. (Optional)
10
+
11
+
:::important
12
+
**PublicKey** is deprecated and no longer used as of `v0.7.0` of service. Instead, import public keys with [key management](./keymanagement/quickstart.md).
13
+
The ability to assign grants was deprecated in [v0.7.0 of service](https://github.com/opentdf/platform/releases/tag/service%2Fv0.7.0),
14
+
in favor of [key mappings](./keymanagement/key_mappings.md).
0 commit comments