Skip to content

Commit 8b267b5

Browse files
martin-gpyigaw
authored andcommitted
nvme: update the tls 'compat' option documentation
There are discrepancies in the tls 'compat' option documentation across gen-tls-key and check-tls-key. Also the actual 'compat' option description text is a little vague to the end user. Update the same for better clarity. Signed-off-by: Martin George <[email protected]>
1 parent c5023e7 commit 8b267b5

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

Documentation/nvme-check-tls-key.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ OPTIONS
6565

6666
-C:
6767
--compat:
68-
Use the original algorithm when deriving TLS keys for
69-
compatibility with older implentations.
68+
Use the original non-RFC 8446 compliant algorithm when
69+
checking TLS keys for compatibility with older implentations.
7070

7171
-f <keyfile>
7272
--keyfile=<keyfile>

nvme.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9769,7 +9769,7 @@ static int gen_tls_key(int argc, char **argv, struct command *command, struct pl
97699769
const char *keytype = "Key type of the retained key.";
97709770
const char *insert = "Insert retained key into the keyring.";
97719771
const char *keyfile = "Update key file with the derive TLS PSK.";
9772-
const char *compat = "Use compatibility algorithm for HKDF-Expand-Label.";
9772+
const char *compat = "Use non-RFC 8446 compliant algorithm for deriving TLS PSK for older implementations";
97739773

97749774
_cleanup_free_ unsigned char *raw_secret = NULL;
97759775
_cleanup_free_ char *encoded_key = NULL;
@@ -9913,7 +9913,7 @@ static int check_tls_key(int argc, char **argv, struct command *command, struct
99139913
const char *keytype = "Key type of the retained key.";
99149914
const char *insert = "Insert retained key into the keyring.";
99159915
const char *keyfile = "Update key file with the derive TLS PSK.";
9916-
const char *compat = "Use compatibility algorithm for HKDF-Expand-Label.";
9916+
const char *compat = "Use non-RFC 8446 compliant algorithm for checking TLS PSK for older implementations.";
99179917

99189918
_cleanup_free_ unsigned char *decoded_key = NULL;
99199919
_cleanup_free_ char *hnqn = NULL;

0 commit comments

Comments
 (0)