Skip to content

Commit 2eb5b5f

Browse files
fix: Replace “children keyrings” with “child keyrings” (#152)
Also a couple of minor grammar/readability fixes Co-authored-by: Matt Bullock <[email protected]>
1 parent eacc169 commit 2eb5b5f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

framework/multi-keyring.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ in this document are to be interpreted as described in [RFC 2119](https://tools.
3636
On keyring initialization, a keyring MUST define at least one of the following:
3737

3838
- [Generator Keyring](#generator-keyring)
39-
- [Children Keyrings](#children-keyrings)
39+
- [Child Keyrings](#child-keyrings)
4040

4141
### Generator Keyring
4242

@@ -47,10 +47,10 @@ during [OnEncrypt](keyring-interface.md#onencrypt).
4747
This means that this keyring MUST return [encryption materials](structures.md#encryption-materials) containing
4848
a plaintext data key on [OnEncrypt](keyring-interface.md#onencrypt).
4949

50-
If the list of [children keyrings](#children-keyrings) is empty,
50+
If the list of [child keyrings](#child-keyrings) is empty,
5151
a [generator keyring](#generator-keyring) MUST be defined for the keyring.
5252

53-
### Children Keyrings
53+
### Child Keyrings
5454

5555
A list of [keyrings](keyring-interface.md) to be used to modify the [encryption](structures.md#encryption-materials)
5656
or [decryption materials](structures.md#decryption-materials).
@@ -72,7 +72,7 @@ If this keyring does not have a [generator keyring](#generator-keyring),
7272
and the input [encryption materials](structures.md#encryption-materials)
7373
does not include a plaintext data key, OnEncrypt MUST fail.
7474

75-
Next, for each [keyring](keyring-interface.md) in this keyring's [children keyrings](#children-keyrings),
75+
Next, for each [keyring](keyring-interface.md) in this keyring's list of [child keyrings](#child-keyrings),
7676
the keyring MUST call [OnEncrypt](keyring-interface.md#onencrypt).
7777
The [encryption materials](structures.md#encryption-materials) inputted into OnEncrypt is the
7878
input encryption materials if this is the first OnEncrypt call.
@@ -90,7 +90,7 @@ OnDecrypt MUST immediately return the unmodified decryption materials.
9090

9191
Otherwise, OnDecrypt MUST attempt to decrypt the [encrypted data keys](structures.md#encrypted-data-keys-1)
9292
in the input [decryption materials](structures.md#decryption-materials) using it's
93-
[children keyrings](#children-keyrings) and, if it is specified, [generator keyring](#generator-keyring).
93+
[child keyrings](#child-keyrings) and, if it is specified, [generator keyring](#generator-keyring).
9494
It MUST attempt to decrypt using these keyrings until it either succeeds in decryption,
9595
or it has no more child keyrings or generator keyring to attempt decryption with.
9696
If a generator keyring is specified, it MUST be used first.
@@ -102,7 +102,7 @@ the unmodified [decryption materials](structures.md#decryption-materials) and in
102102
If [OnDecrypt](keyring-interface.md#ondecrypt) returns [decryption materials](structures.md#decryption-materials)
103103
containing a plaintext data key, the keyring MUST immediately return the modified decryption materials.
104104

105-
If, after calling [OnDecrypt](keyring-interface.md#ondecrypt) on every one of this keyring's [children keyrings](#children-keyrings)
105+
If, after calling [OnDecrypt](keyring-interface.md#ondecrypt) on every one of this keyring's [child keyrings](#child-keyrings)
106106
(and possibly the [generator keyring](#generator-keyring)), the [decryption materials](structures.md#decryption-materials)
107107
still do not contain a plaintext data key:
108108

@@ -124,7 +124,7 @@ In more detail:
124124

125125
Multi-keyrings will produce a set of [encrypted data keys](structures.md#encrypted-data-key) on
126126
[OnEncrypt](keyring-interface.md#onencrypt) that includes the encrypted data keys of every sub-keyring
127-
(a keyring which is either the [generator keyring](#generator-keyring) or a member of [children keyrings](#children-keyrings))
127+
(a keyring which is either the [generator keyring](#generator-keyring) or a member of [child keyrings](#child-keyrings))
128128
that is capable of producing encrypted data keys.
129129

130130
As such, any [keyring](keyring-interface.md) that is capable of obtaining the plaintext data key from

0 commit comments

Comments
 (0)