Skip to content

Commit a8fd011

Browse files
authored
Update TACACSPLUS_PASSKEY_ENCRYPTION.md
1 parent 59755b4 commit a8fd011

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

doc/TACACSPLUS_PASSKEY_ENCRYPTION.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,14 @@ The implementation as follows
7474
4. sonic_utilities extended to passkey encyption using the master key/passwd manager.
7575
5. User has to enter master key/passwd at the time of configuring the passkey, this is mandatory requirement only if "key_encrypt" run time flag is enabled.
7676
6. The encrypted passkey stored in config_db
77-
7. The master key/paswd used for encryption/decryption and will be stored in the same device with root access previleges.
77+
7. The master key/paswd used for encryption/decryption and will be stored in the same device with root access previleges (/etc/cipher_pass).
7878
8. HostCfg will use the master key/passwd to decrypt the encrypted passkey and further store it in PAM configuration files.
7979

8080
#### CLI Changes
81-
config tacacs passkey TEST1
82-
81+
config tacacs passkey TEST1 --encrypt
8382
Password:
84-
Note: It will ask for a master key/password only when the 'key_encrypt' flag is set under respective feature table (ex: TACPLUS) in config_db.
83+
84+
Note: It will ask for a master key/password only when '--encrypt' flag is set.
8585

8686
#### Show CLI changes
8787
Furthermore, aside from encrypting the passkey stored within CONFIG_DB, this infrastructure ensures that the passkey itself remains concealed from any of the displayed CLI outputs. Consequently, the passkey field has been eliminated from the "show tacacs" output, and it will now solely indicate the status whether the passkey is configured or not. For instance,
@@ -95,6 +95,16 @@ Create a new leaf for newly introduced run time flag 'key_encrypt'.
9595
### Config DB changes
9696
A new run time flag to enable/disable the tacacs passkey encryption feature - "key_encrypt".
9797

98+
### Schema changes
99+
```
100+
"TACPLUS": {
101+
"global": {
102+
"auth_type": "login",
103+
"key_encrypt": "true",
104+
"passkey": "<Entrypted_Passkey>"
105+
}
106+
}
107+
```
98108
### Benefits
99109
TACACS passkey encryption adds an extra layer of security to safeguard the passkey on each device throughout the network. Furthermore, the implementation of master key/password manager encryption ensures that encrypted passkeys can be reused across network nodes without any complications. Consequently, there are no obstacles when it comes to utilizing the config_db.json file from one device on another. Additionally, the use of a root protected config file effectively reduces the risk of exposing the encryption/decryption master key/passwd since it is only accessible to root users and remains inaccessible to external entities.
100110

0 commit comments

Comments
 (0)