Skip to content

Commit bcad732

Browse files
committed
Removed double-spaces between sentences.
1 parent f2552cd commit bcad732

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

UPGRADING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ these currently default to `'OpenSSL'` and `'SHA512'` respectively.
6464
#### Encrypt Existing Keys
6565

6666
After updating the `$hmacEncryption['key']` value, you will need to run `php spark shield:hmac encrypt` in order to encrypt
67-
any existing HMAC tokens. This only needs to be run if you have existing unencrypted HMAC secretKeys in stored in the
67+
any existing HMAC tokens. This only needs to be run if you have existing unencrypted HMAC secretKeys in stored in the
6868
database.
6969

7070
## Version 1.0.0-beta.6 to 1.0.0-beta.7

docs/guides/api_hmac_keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ $user->revokeAllHmacTokens();
9090

9191
## HMAC Secret Key Encryption
9292

93-
The HMAC Secret Key is stored encrypted. Before you start using HMAC, you will need to set/override the encryption key
93+
The HMAC Secret Key is stored encrypted. Before you start using HMAC, you will need to set/override the encryption key
9494
`$hmacEncryption['key']` in **app/Config/AuthToken.php**. This should be set using **.env** and/or system environment variables.
9595
Instructions on how to do that can be found in the
9696
[Setting Your Encryption Key](https://codeigniter.com/user_guide/libraries/encryption.html#setting-your-encryption-key)

docs/references/authentication/hmac.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ instance of `CodeIgniters\Shield\Authentication\Entities\AccessToken`. The field
7272
`rawSecretKey` is the shared '**secretKey**'. Both are required to when using this authentication method.
7373

7474
**The plain text version of these keys should be displayed to the user immediately, so they can copy it for
75-
their use.** It is recommended that after that only the '**key**' field is displayed to a user. If a user loses the
75+
their use.** It is recommended that after that only the '**key**' field is displayed to a user. If a user loses the
7676
'**secretKey**', they should be required to generate a new set of keys to use.
7777

7878
```php
@@ -159,8 +159,8 @@ if ($user->hmacTokenCant('forums.manage')) {
159159

160160
## HMAC Secret Key Encryption
161161

162-
The HMAC Secret Key is stored encrypted. Before you start using HMAC, you will need to set/override the encryption key
163-
`$hmacEncryption['key']` in **app/Config/AuthToken.php**. This should be set using .env and/or system environment variables.
162+
The HMAC Secret Key is stored encrypted. Before you start using HMAC, you will need to set/override the encryption key
163+
`$hmacEncryption['key']` in **app/Config/AuthToken.php**. This should be set using **.env** and/or system environment variables.
164164
Instructions on how to do that can be found in the
165165
[Setting Your Encryption Key](https://codeigniter.com/user_guide/libraries/encryption.html#setting-your-encryption-key)
166166
section of the CodeIgniter 4 documentation.
@@ -210,13 +210,13 @@ php spark shield:hmac reencrypt
210210
You can (and should) set these values using environment variable and/or the `.env` file. To do this you will need to set
211211
the values as JSON strings:
212212

213-
```dotenv
213+
```text
214214
authtoken.hmacEncryption.key = '{"k1":"hex2bin:923dfab5ddca0c7784c2c388a848a704f5e048736c1a852c862959da62ade8c7","k2":"hex2bin:451df599363b19be1434605fff8556a0bbfc50bede1bb33793dcde4d97fce4b0"}'
215215
authtoken.hmacEncryption.driver = '{"k1":"OpenSSL","k2":"OpenSSL"}'
216216
authtoken.hmacEncryption.digest = '{"k1":"SHA512","k2":"SHA512"}'
217217
authtoken.hmacEncryption.currentKey = k2
218218
```
219219

220220
Depending on the set length of the Secret Key and the type of encryption used, it is possible for the encrypted value to
221-
exceed the database column character limit of 255 characters. If this happens, creation of a new HMAC identity will
221+
exceed the database column character limit of 255 characters. If this happens, creation of a new HMAC identity will
222222
throw a `RuntimeException`.

src/Config/AuthToken.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,18 +85,18 @@ class AuthToken extends BaseAuthToken
8585
* - OpenSSL
8686
* - Sodium
8787
*
88-
* This is an array of drivers values. The keys MUST match and correlate
88+
* This is an array of drivers values. The keys MUST match and correlate
8989
* to the 'key' array keys.
9090
*
9191
* 'digest' is used when encrypting HMAC Secret Key for storage.
9292
* e.g. 'SHA512' or 'SHA256'. Default value is 'SHA512'.
9393
*
94-
* This is an array of digest values. The keys MUST match and correlate
94+
* This is an array of digest values. The keys MUST match and correlate
9595
* to the 'key' array keys.
9696
*
9797
* The valid/current key is identified using 'currentKey'
9898
*
99-
* Old keys will are used to decrypt existing Secret Keys. It is encouraged
99+
* Old keys will are used to decrypt existing Secret Keys. It is encouraged
100100
* to run 'php spark shield:hmac reencrypt' to update existing Secret
101101
* Key encryptions.
102102
*

0 commit comments

Comments
 (0)