Skip to content

Commit f1b7f7b

Browse files
committed
Fix some typos and formatting issues
1 parent 08113eb commit f1b7f7b

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

v2.1/encryption.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Encryption at rest allows encryption of all files on disk using AES in counter m
1717
sizes allowed.
1818

1919
Encryption is performed in the [storage layer](architecture/storage-layer.html) and configured per store.
20-
All files used by the store, regarless of contents, are encrypted with the desired algorithm.
20+
All files used by the store, regardless of contents, are encrypted with the desired algorithm.
2121

2222
To allow arbitrary rotation schedules and ensure security of the keys, we use two layers of keys:
2323

@@ -39,6 +39,7 @@ CockroachDB does not currently force re-encryption of older files but instead re
3939
## Key rotation
4040

4141
Key rotation is necessary for encryption at rest for multiple reasons:
42+
4243
* prevent key reuse with the same encryption parameters (after many files)
4344
* reduce the risk of key exposure
4445

@@ -47,6 +48,7 @@ This is done by setting the `key` parameter of the `--enterprise-encryption` fla
4748
and `old-key` to the previously-used key.
4849

4950
Data keys will automatically be rotated at startup if any of the following conditions are met:
51+
5052
* the active store key changed
5153
* the encryption type changed (different key size, or plaintext to/from encryption)
5254
* the current data key is `rotation-period` old or more.
@@ -69,15 +71,17 @@ and encrypted.
6971

7072
## Recommendations
7173

72-
There are a number of considerations to keep in mind when running with encryption:
74+
There are a number of considerations to keep in mind when running with encryption.
7375

7476
Key management is the most dangerous aspect of encryption. The following rules should be kept in mind:
77+
7578
* make sure only the unix user running the `cockroach` process has access to the keys
7679
* do not store the keys on the same partition/drive as the cockroach data. It is best to load keys at run time from a separate system (eg: keywhiz, vault)
7780
* rotate store keys frequently (every few weeks to months)
7881
* keep the data key rotation period low (default is one week)
7982

8083
A few other recommendations apply for best security practices:
84+
8185
* do not switch from encrypted to plaintext, this leaks data keys. Once transitioned to plaintext, all data must be considered reachable.
8286
* do not copy the encrypted files as the data keys are not easily available.
8387
* if encryption is desired, start a node with it enabled from first run without ever running in plaintext.
@@ -130,7 +134,7 @@ The allowed components in the flag are:
130134
The `key` and `old-key` components must **always** be specified. They allow for transitions between
131135
encryption algorithms, and between plaintext and encrypted.
132136

133-
Starting node for the first time using AES-128 encryption can be done using:
137+
Starting a node for the first time using AES-128 encryption can be done using:
134138
{% include copy-clipboard.html %}
135139
~~~ shell
136140
$ cockroach start --store=cockroach-data --enterprise-encryption=path=cockroach-data,key=/path/to/my/aes-128.key,old-key=plain
@@ -165,9 +169,10 @@ The new key can be seen as active in the admin UI under the stores report page.
165169

166170
To disable encryption, specify `key=plain`. The data keys will be stored in plaintext and new data will not be encrypted.
167171

168-
To rotate keys, specify `key=/path/to/my/new-aes-128.key` and `key=/path/to/my/old-aes-128.key`. The data keys
172+
To rotate keys, specify `key=/path/to/my/new-aes-128.key` and `old-key=/path/to/my/old-aes-128.key`. The data keys
169173
will be decrypted using the old key then encrypted using the new key. A new data key will also be generated.
170174

171175
## See Also
172176

173-
TODO(mberhault): links to external resources, report page details, flag descriptions.
177+
+ [Enterprise Licensing](enterprise-licensing.html)
178+
+ [`BACKUP`](backup.html)

0 commit comments

Comments
 (0)