symm/desx.c, symm/desx.h (desx_init): Fix documentation.
authorMark Wooding <mdw@distorted.org.uk>
Fri, 9 Nov 2018 21:46:56 +0000 (21:46 +0000)
committerMark Wooding <mdw@distorted.org.uk>
Sat, 24 Nov 2018 20:12:54 +0000 (20:12 +0000)
The two documentation comments disagreed about the orders of the key
pieces.  The implementation had it right: the DES key comes first,
followed by the whitening keys.  Fix the header, and a stupid typo.

symm/desx.c
symm/desx.h

index e9a77ed..14115a5 100644 (file)
@@ -61,7 +61,7 @@ const octet desx_keysz[] = { KSZ_SET, 23, 7, 8, 15, 16, 24, 0 };
  * Use:                Initializes a DESX key buffer.  The key buffer contains, in
  *             order, a single-DES key (either 7 or 8 bytes), an optional
  *             8-byte pre-whitening key, and an optional 8-byte
- *             port-whitening key.  If no whitening keys are specified, the
+ *             post-whitening key.  If no whitening keys are specified, the
  *             algorithm becomes the same as single-DES.
  */
 
index 62e8300..005d1c4 100644 (file)
@@ -76,10 +76,10 @@ typedef struct desx_ctx {
  * Returns:    ---
  *
  * Use:                Initializes a DESX key buffer.  The key buffer contains, in
- *             order, an optional 8-byte pre-whitening key, a single-DES key
- *             (either 7 or 8 bytes), and an optional 8-byte port-whitening
- *             key.  If no whitening keys are specified, the algorithm
- *             becomes the same as single-DES.
+ *             order, a single-DES key (either 7 or 8 bytes), an optional
+ *             8-byte pre-whitening key, and an optional 8-byte
+ *             post-whitening key.  If no whitening keys are specified, the
+ *             algorithm becomes the same as single-DES.
  */
 
 extern void desx_init(desx_ctx */*k*/, const void */*buf*/, size_t /*sz*/);