Overview
Comment: | Updated documentation for digest, cmac, and hmac command changes. |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | crypto |
Files: | files | file ages | folders |
SHA3-256: |
220a9947b77db51ed0059d2656cda297 |
User & Date: | bohagan on 2023-11-18 06:58:23 |
Other Links: | branch diff | manifest | tags |
Context
2023-11-18
| ||
18:55 | Added get digest info command to return properties of a digest check-in: e47bd35656 user: bohagan tags: crypto | |
06:58 | Updated documentation for digest, cmac, and hmac command changes. check-in: 220a9947b7 user: bohagan tags: crypto | |
06:26 | Updated test cases for new command syntax and added more tests cases check-in: eb618c73d8 user: bohagan tags: crypto | |
Changes
Modified doc/tls.html
from [cf50cb73f4]
to [939cd85094].
︙ | ︙ | |||
33 34 35 36 37 38 39 | <dt> </dt> <dd><b>tls::ciphers</b> <em>?protocol? ?verbose? ?supported?</em></dd> <dd><b>tls::digests</b></dd> <dd><b>tls::macs</b></dd> <dd><b>tls::protocols</b></dd> <dd><b>tls::version</b></dd> <dt> </dt> | | | | | 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | <dt> </dt> <dd><b>tls::ciphers</b> <em>?protocol? ?verbose? ?supported?</em></dd> <dd><b>tls::digests</b></dd> <dd><b>tls::macs</b></dd> <dd><b>tls::protocols</b></dd> <dd><b>tls::version</b></dd> <dt> </dt> <dd><b>tls::digest</b> <b>-digest</b> <em>name ?options?</em></dd> <dd><b>tls::cmac</b> <b>-cipher</b> <em>name</em> <b>-key</b> <em>key ?options?</em></dd> <dd><b>tls::hmac</b> <b>-digest</b> <em>name</em> <b>-key</b> <em>key ?options?</em></dd> <dd><b>tls::md4</b> <em>data</em></dd> <dd><b>tls::md5</b> <em>data</em></dd> <dd><b>tls::sha1</b> <em>data</em></dd> <dd><b>tls::sha256</b> <em>data</em></dd> <dd><b>tls::sha512</b> <em>data</em></dd> </dl> </dd> |
︙ | ︙ | |||
77 78 79 80 81 82 83 | <br> <a href="#tls::ciphers"><b>tls::ciphers</b> <i>?protocol? ?verbose? ?supported?</i></a><br> <a href="#tls::digests"><b>tls::digests</b></a><br> <a href="#tls::macs"><b>tls::macs</b></a><br> <a href="#tls::protocols"><b>tls::protocols</b></a><br> <a href="#tls::version"><b>tls::version</b></a><br> <br> | | | | | 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | <br> <a href="#tls::ciphers"><b>tls::ciphers</b> <i>?protocol? ?verbose? ?supported?</i></a><br> <a href="#tls::digests"><b>tls::digests</b></a><br> <a href="#tls::macs"><b>tls::macs</b></a><br> <a href="#tls::protocols"><b>tls::protocols</b></a><br> <a href="#tls::version"><b>tls::version</b></a><br> <br> <a href="#tls::digest"><b>tls::digest</b> <b>-digest</b> <i>name ?options?</i></a><br> <a href="#tls::cmac"><b>tls::cmac</b> <b>-cipher</b> <i>name</i> <b>-key</b> <i>key ?options?</i></a><br> <a href="#tls::hmac"><b>tls::hmac</b> <b>-digest</b> <i>name</i> <b>-key</b> <i>key ?options?</i></a><br> <a href="#tls::md4"><b>tls::md4</b> <i>data</i></a><br> <a href="#tls::md5"><b>tls::md5</b> <i>data</i></a><br> <a href="#tls::sha1"><b>tls::sha1</b> <i>data</i></a><br> <a href="#tls::sha256"><b>tls::sha256</b> <i>data</i></a><br> <a href="#tls::sha512"><b>tls::sha512</b> <i>data</i></a><br> </p> |
︙ | ︙ | |||
434 435 436 437 438 439 440 | <dt><strong>session_cache_mode</strong> <em>mode</em></dt> <dd>Server cache mode (client, server, or both).</dd> </dl> </blockquote> <dt><a name="tls::ciphers"><strong>tls::ciphers</strong> <em>?protocol? ?verbose? ?supported?</em></a></dt> | | | | < | | | | | | > | | | | > | | | | | | | | | | | 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 | <dt><strong>session_cache_mode</strong> <em>mode</em></dt> <dd>Server cache mode (client, server, or both).</dd> </dl> </blockquote> <dt><a name="tls::ciphers"><strong>tls::ciphers</strong> <em>?protocol? ?verbose? ?supported?</em></a></dt> <dd>Without any args, returns a list of all ciphers. With <em>protocol</em>, only the ciphers supported for that protocol are returned. See <b>tls::protocols</b> command for the supported protocols. If <em>verbose</em> is specified as true then a verbose, human readable list is returned with additional information on the cipher. If <em>supported</em> is specified as true, then only the ciphers supported for protocol will be listed.</dd> <dt><a name="tls::digests"><strong>tls::digests</strong></a></dt> <dd>Returns a list of the hash algorithms for <b>tls::digest</b> command.</dd> <dt><a name="tls::macs"><strong>tls::macs</strong></a></dt> <dd>Returns a list of the available Message Authentication Codes (MAC) for the <b>tls::digest</b> command.</dd> <dt><a name="tls::protocols"><strong>tls::protocols</strong></a></dt> <dd>Returns a list of supported protocols. Valid values are: <b>ssl2</b>, <b>ssl3</b>, <b>tls1</b>, <b>tls1.1</b>, <b>tls1.2</b>, and <b>tls1.3</b>. Exact list depends on OpenSSL version and compile time flags.</dd> <dt><a name="tls::version"><strong>tls::version</strong></a></dt> <dd>Returns the OpenSSL version string.</dd> <br> <dt><a name="tls::digest"><strong>tls::digest</strong> <b>-digest</b> <em>name ?-bin|-hex? [-file filename | -command cmdName | -chan channelId | -data data]</em></a></dt> <dd>Calculate the message digest for data using <em>digest</em> hash function. Returns value as a hex string (default) or as a binary value with <b>-bin</b> or <b>-binary</b> option. Digest can be any OpenSSL supported hash function including: <b>md4</b>, <b>md5</b>, <b>sha1</b>, <b>sha256</b>, <b>sha512</b>, <b>sha3-256</b>, etc. See <b>tls::digests</b> command for a full list. <br> Using the <b>-data</b> option will immediately return the message digest for <em>data</em> in the specified format. <br> Using the <b>-file</b> or <b>-filename</b> option will open file <em>filename</em>, 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. <br> Using the <b>-chan</b> or <b>-channel</b> option, a stacked channel is created for <em>channelId</em> 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. <br> Using the <b>-command</b> option, a new command <em>cmdName</em> is created and returned. To add data to the hash function, call "<em>cmdName</em> <b>update</b> <em>data</em>", where data is the data to add. When done, call "<em>cmdName</em> <b>finalize</b>" to return the message digest. </dd> <dt><a name="tls::cmac"><strong>tls::cmac</strong> <b>-cipher</b> <em>name</em> <b>-key</b> <em>key ?-bin|-hex? [-file filename | -command cmdName | -chan channelId | -data data]</em></a></dt> <dd>Calculate the Cipher-based Message Authentication Code (CMAC). Same arguments as <b>tls::digest</b> with additional option <b>-cipher</b> to specify the cipher to use and for certain ciphers, <b>-key</b> to specify the key.</dd> <dt><a name="tls::hmac"><strong>tls::hmac</strong> <b>-digest</b> <em>name</em> <b>-key</b> <em>key ?-bin|-hex? [-file filename | -command cmdName | -chan channelId | -data data]</em></a></dt> <dd>Calculate the Hashed Message Authentication Code (HMAC). Same arguments as <b>tls::digest</b> with additional option <b>-key</b> to specify the key to use. To salt a password, append or prepend the salt data to the password. </dd> <dt><a name="tls::md4"><strong>tls::md4</strong> <em>data</em></a></dt> <dd>Returns the MD4 message-digest for <em>data</em> as a hex string.</dd> |
︙ | ︙ |