Index: doc/cryptography.html ================================================================== --- doc/cryptography.html +++ doc/cryptography.html @@ -136,11 +136,11 @@
-info string
Optional context and application specific information. Can be a binary - or text string.
+ or text string. Max length is 1024 bytes for OpenSSL 1.1 and 2048 bytes for 3.0.
-iterations count
Number (integer > 0) of iterations to use in deriving the encryption @@ -149,11 +149,12 @@
-iv string
Initialization vector (IV) to use. Required for some ciphers and GMAC. - Cipher modes CBC, CFB, and OFB all need an IV while ECB and CTR modes do not. + Other MACs use a fixed IV. + Cipher modes CBC, CFB, and OFB all need an IV, while ECB and CTR modes do not. A new, random IV should be created for each use. Think of the IV as a nonce (number used once), it's public but random and unpredictable. See the tls::cipher for iv_length and when required (length > 0). Max is 16 bytes. If not set, it will default to \x00 fill data.
@@ -327,11 +328,13 @@

The following commands provide access to the OpenSSL cryptography functions.

Info Commands

- +These commands provide information about the available ciphers, digests, etc. and their properties. +
+
tls::cipher name
Returns a list of property name and value pairs describing cipher name. Properties are:
@@ -391,11 +394,13 @@
Returns the OpenSSL version string.

Message Digest (MD) and Message Authentication Code (MAC) Commands

- +These commands calculate a message digest or message authentication code for data. +
+
tls::cmac ?-cipher? name -key key ? -bin|-hex ?[-chan channelId | -command cmdName | @@ -461,11 +466,13 @@
Removes the top level cryptographic transform from channel channelId.

Encryption and Decryption Commands

- +These commands encrypt plaintext into ciphertext or vice versa. +
+
tls::encrypt ?-cipher? name -digest name -key key ? -iv string? @@ -548,11 +555,11 @@
nidInternal id of cipher. This is the same as name.

Random Bytes Commands

-These commands provide randomly generated byte strings. +These commands provide randomly generated byte strings for use when random data is needed.

tls::random ?-private? length
Generate length random bytes using a cryptographically secure