@@ -196,20 +196,20 @@ Referencing Encryption Keys by an Alternative Name
196
196
197
197
While it is possible to create an encryption key every time data is encrypted,
198
198
this is not the recommended approach. Instead, you should create your encryption
199
- keys depending on your use- case, e.g. by creating a user-specific encryption
199
+ keys depending on your use case, e.g. by creating a user-specific encryption
200
200
key. To reference keys in your software, you can use the keyAltName attribute
201
201
specified when creating the key. The following example creates an encryption key
202
202
with an alternative name, which could be done when deploying the application.
203
203
The software then encrypts data by referencing the key by its alternative name.
204
204
205
- Creating the encryption key
205
+ Creating the Encryption Key
206
206
~~~~~~~~~~~~~~~~~~~~~~~~~~~
207
207
208
208
To create the encryption key, create a client instance with encryption options
209
209
and create a new data key. You can pass multiple alternate names for this key
210
210
and later reference the key by these alternate names instead of the key ID.
211
211
Creating a new data encryption key would typically be done on initial deployment,
212
- but depending on your use- case you may want to use more than one encryption key.
212
+ but depending on your use case you may want to use more than one encryption key.
213
213
214
214
.. code-block:: php
215
215
@@ -231,10 +231,10 @@ but depending on your use-case you may want to use more than one encryption key.
231
231
$client = new Client();
232
232
$clientEncryption = $client->createClientEncryption($clientEncryptionOpts);
233
233
234
- // Create an encryption key with an alternate name.
234
+ // Create an encryption key with an alternate name
235
235
$keyId = $clientEncryption->createDataKey('local', ['keyAltNames' => ['altname']]);
236
236
237
- Using an encryption key by alternate name
237
+ Using an Encryption Key by Alternate Name
238
238
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
239
239
240
240
To use an alternate name when referencing an encryption key, use the
0 commit comments