Index: doc/tls.html
==================================================================
--- doc/tls.html
+++ doc/tls.html
@@ -35,13 +35,13 @@
tls::digests
tls::macs
tls::protocols
tls::version
- tls::digest type ?options?
- tls::cmac type -cipher name ?options?
- tls::hmac type -key key ?options?
+ tls::digest -digest name ?options?
+ tls::cmac -cipher name -key key ?options?
+ tls::hmac -digest name -key key ?options?
tls::md4 data
tls::md5 data
tls::sha1 data
tls::sha256 data
tls::sha512 data
@@ -79,13 +79,13 @@
tls::digests
tls::macs
tls::protocols
tls::version
-tls::digest type ?options?
-tls::cmac type -cipher name ?options?
-tls::hmac type -key key ?options?
+tls::digest -digest name ?options?
+tls::cmac -cipher name -key key ?options?
+tls::hmac -digest name -key key ?options?
tls::md4 data
tls::md5 data
tls::sha1 data
tls::sha256 data
tls::sha512 data
@@ -436,18 +436,17 @@
tls::ciphers
?protocol? ?verbose? ?supported?
- Without any args, returns a list of all ciphers. With
- protocol, only the ciphers supported for that protocol
- are returned where protocol must be one of ssl2, ssl3,
- tls1, tls1.1, tls1.2, or tls1.3. If verbose is
- specified as true then a verbose, human readable list is returned
- with additional information on the cipher. If supported
- is specified as true, then only the ciphers supported for protocol
- will be listed.
+ Without any args, returns a list of all ciphers. With protocol,
+ only the ciphers supported for that protocol are returned. See
+ tls::protocols command for the supported protocols. If
+ verbose is specified as true then a verbose, human readable
+ list is returned with additional information on the cipher. If
+ supported is specified as true, then only the ciphers
+ supported for protocol will be listed.
tls::digests
Returns a list of the hash algorithms for tls::digest command.
tls::macs
@@ -462,48 +461,50 @@
tls::version
Returns the OpenSSL version string.
- tls::digest digest ?-bin|-hex?
- [-file filename | -command cmdName | -chan channelId | ?-data? data]
+ tls::digest -digest
+ name ?-bin|-hex? [-file filename | -command cmdName |
+ -chan channelId | -data data]
Calculate the message digest for data using digest hash
function. Returns value as a hex string (default) or as a binary value
- with -bin option. Argument digest can be any OpenSSL
+ with -bin or -binary option. Digest can be any OpenSSL
supported hash function including: md4, md5, sha1,
sha256, sha512, sha3-256, etc. See
tls::digests command for a full list.
Using the -data option will immediately return the message
digest for data in the specified format.
- Using the -file option will open file filename, read
- the file data, close the file, and return the message digest in the
- specified format. This uses the TCL APIs, so VFS files are supported.
+ Using the -file or -filename option will open file
+ filename, read the file data, close the file, and return the
+ message digest in the specified format. This uses the TCL APIs, so VFS
+ files are supported.
- Using the -chan option, a stacked channel is created for
- channelId and data read from the channel is used to calculate
- a message digest with the result returned with the last read operation
- before EOF. Channel is automatically set to binary mode.
+ Using the -chan or -channel option, a stacked channel is
+ created for channelId and data read from the channel is used
+ to calculate a message digest with the result returned with the last
+ read operation before EOF. Channel is automatically set to binary mode.
Using the -command option, a new command cmdName is
created and returned. To add data to the hash function, call
"cmdName update data", where data is
the data to add. When done, call "cmdName finalize"
to return the message digest.
- tls::cmac digest
- -cipher name ?-bin|-hex? [-file filename |
- -command cmdName | -chan channelId | ?-data? data]
+ tls::cmac -cipher name
+ -key key ?-bin|-hex? [-file filename | -command cmdName |
+ -chan channelId | -data data]
Calculate the Cipher-based Message Authentication Code (CMAC). Same arguments
as tls::digest with additional option -cipher to specify the
cipher to use and for certain ciphers, -key to specify the key.
- tls::hmac digest
- -key key ?-bin|-hex? [-file filename |
- -command cmdName | -chan channelId | ?-data? data]
+ tls::hmac -digest name
+ -key key ?-bin|-hex? [-file filename | -command cmdName |
+ -chan channelId | -data data]
Calculate the Hashed Message Authentication Code (HMAC). Same arguments
as tls::digest with additional option -key to specify the
key to use. To salt a password, append or prepend the salt
data to the password.