Merge pull request #197 from libtom/update/doc

Update documentation

Author: sjaeckel

README.md

@@ -89,8 +89,8 @@ The following list does not claim to be complete resp. to be available across al
 | `sizes` | builds the `sizes` binary, printing all internal data sizes on invocation *\*4* |
 | `constants` | builds the `constants` binary, printing all internal constants on invocation *\*4* |
 | `openssl-enc` | builds the `openssl-enc` binary, which is more or less compatible to [`openssl enc`](https://linux.die.net/man/1/enc) *\*4* *\*5* |
-| `test` | builds the `test` binary, which runs all algorithm self-tests + some extended tests *\*4* *\*6* |
-| `timing` | builds the `timing` binary, which can be used to measure timings for algorithms and modes *\*4* *\*6* |
+| `test` | builds the `test` binary, which runs all algorithm self-tests + some extended tests *\*4* |
+| `timing` | builds the `timing` binary, which can be used to measure timings for algorithms and modes *\*4* |
 | `bins` | builds `hashsum` *\*4* |
 | `all_test` | builds `test`, `hashsum`, `ltcrypt`, `small`, `tv_gen`, `sizes` & `constants` *\*4* |
 | `docs` | builds the developer documentation `doc/crypt.pdf` |
@@ -105,8 +105,6 @@ The following list does not claim to be complete resp. to be available across al
 
 *\*5* broken build in some configurations, therefore not built by default
 
-*\*6* requires define of one of `USE_GMP`, `USE_LTM` or `USE_TFM` (+ the appropriate MPI provider)
-
 *\*7* also builds the necessary artifact(s) before installing it
 
 *\*8* also have a look at the 'Installation' section of this file

TODO

@@ -22,6 +22,8 @@ v1.18.0
          XTS mode and RSA private key operations with keys without CRT parameters
       -- RC2 now also works with smaller key-sizes
       -- Improved/extended several tests & demos
+      -- Hardened DSA and RSA by testing (through Karel's perl-CryptX)
+         against Google's "Wycheproof" and Kudelski Security's "CDF"
       -- Fixed all compiler warnings
       -- Fixed several build issues on FreeBSD, NetBSD, Linux x32 ABI, HP-UX/IA64,
          Mac OS X, Windows (32&64bit, MingW&MSVC) ...
@@ -33,7 +35,7 @@ v1.18.0
       -- Add Base64-URL de-/encoding and some strict variants
       -- Add Blake2b & Blake2s (hash & mac), thanks to Kelvin Sherlock
       -- Add Camellia block cipher
-      -- Add ChaCha20 (stream cipher), Poly1305 (mac), ChaCha20Poly1305 (encauth)
+      -- Add ChaCha (stream cipher), Poly1305 (mac), ChaCha20Poly1305 (encauth)
       -- Add constant-time mem-compare mem_neq()
       -- Add DER GeneralizedTime de-/encoding
       -- Add DSA and ECC key generation FIPS-186-4 compliance

changes

@@ -55,6 +55,9 @@ docdvi: crypt.tex
 	latex crypt $(silent_stdout)
 	latex crypt $(silent_stdout)
 
+termdoc: docdvi
+	dvi2tty crypt.dvi -w120
+
 clean:
 	rm -f $(LEFTOVERS)
 	rm -rf doxygen/

doc/crypt.tex

@@ -15,8 +15,8 @@
   Process an entire GCM packet in one call.
   @param key               The secret key
   @param keylen            The length of the secret key
-  @param iv                The initial vector
-  @param ivlen             The length of the initial vector
+  @param iv                The initialization vector
+  @param ivlen             The length of the initialization vector
   @param aad               The additional authentication data (header)
   @param aadlen            The length of the aad
   @param in                The plaintext

doc/makefile

@@ -20,8 +20,8 @@
   @param cipher            Index of cipher to use
   @param key               The secret key
   @param keylen            The length of the secret key
-  @param IV                The initial vector
-  @param IVlen             The length of the initial vector
+  @param IV                The initialization vector
+  @param IVlen             The length of the initialization vector
   @param adata             The additional authentication data (header)
   @param adatalen          The length of the adata
   @param pt                The plaintext

src/encauth/chachapoly/chacha20poly1305_memory.c

@@ -499,8 +499,8 @@ extern struct ltc_cipher_descriptor {
    /** Accelerated GCM packet (one shot)
        @param key        The secret key
        @param keylen     The length of the secret key
-       @param IV         The initial vector
-       @param IVlen      The length of the initial vector
+       @param IV         The initialization vector
+       @param IVlen      The length of the initialization vector
        @param adata      The additional authentication data (header)
        @param adatalen   The length of the adata
        @param pt         The plaintext

src/encauth/gcm/gcm_memory.c

@@ -75,7 +75,7 @@ int hmac_init(hmac_state *hmac, int hash, const unsigned char *key, unsigned lon
        zeromem((hmac->key) + keylen, (size_t)(LTC_HMAC_BLOCKSIZE - keylen));
     }
 
-    /* Create the initial vector for step (3) */
+    /* Create the initialization vector for step (3) */
     for(i=0; i < LTC_HMAC_BLOCKSIZE;   i++) {
        buf[i] = hmac->key[i] ^ 0x36;
     }

src/headers/tomcrypt_cipher.h

@@ -16,9 +16,9 @@
 #ifdef LTC_CBC_MODE
 
 /**
-   Get the current initial vector
-   @param IV   [out] The destination of the initial vector
-   @param len  [in/out]  The max size and resulting size of the initial vector
+   Get the current initialization vector
+   @param IV   [out] The destination of the initialization vector
+   @param len  [in/out]  The max size and resulting size of the initialization vector
    @param cbc  The CBC state
    @return CRYPT_OK if successful
 */