Changes To Documentation
Bounty program for improvements to Tcl and certain Tcl packages.

Changes to "Documentation" between 2019-04-25 18:02:56 and 2020-10-12 20:37:52

     4      4               <dd><strong>tls</strong> - binding to <strong>OpenSSL</strong>
     5      5                   toolkit.</dd>
     6      6           </dl>
     7      7       </dd>
     8      8       <dd><a href="#SYNOPSIS">SYNOPSIS</a> </dd>
     9      9       <dd><dl>
    10     10               <dd><b>package require Tcl </b><em>?8.4?</em></dd>
    11         -            <dd><b>package require tls </b><em>?1.7.18?</em></dd>
           11  +            <dd><b>package require tls </b><em>?1.8.0?</em></dd>
    12     12               <dt>&nbsp;</dt>
    13     13               <dd><b>tls::init </b><i>?options?</i> </dd>
    14     14               <dd><b>tls::socket </b><em>?options? host port</em></dd>
    15     15               <dd><b>tls::socket</b><em> ?-server command?
    16     16                   ?options? port</em></dd>
    17     17               <dd><b>tls::handshake</b><em> channel</em></dd>
    18     18               <dd><b>tls::status </b><em>?-local? channel</em></dd>
................................................................................
    35     35   
    36     36   <p><strong>tls</strong> - binding to <strong>OpenSSL</strong>
    37     37   toolkit.</p>
    38     38   
    39     39   <h3><a name="SYNOPSIS">SYNOPSIS</a></h3>
    40     40   
    41     41   <p><b>package require Tcl 8.4</b><br>
    42         -<b>package require tls 1.7.18</b><br>
           42  +<b>package require tls 1.8.0</b><br>
    43     43   <br>
    44     44   <a href="#tls::init"><b>tls::init </b><i>?options?</i><br>
    45     45   </a><a href="#tls::socket"><b>tls::socket </b><em>?options? host
    46     46   port</em><br>
    47     47   <b>tls::socket</b><em> ?-server command? ?options? port</em><br>
    48     48   </a><a href="#tls::status"><b>tls::status </b><em>?-local? channel</em><br>
    49     49   </a><a href="#tls::handshake"><b>tls::handshake</b><em> channel</em></a><br>
................................................................................
   133    133           <dt><strong>cipher</strong> <em>cipher</em></dt>
   134    134           <dd>The current cipher in use between the client and
   135    135               server channels.</dd>
   136    136           <dt><strong>sbits</strong> <em>n</em></dt>
   137    137           <dd>The number of bits used for the session key.</dd>
   138    138           <dt><strong>certificate</strong> <em>n</em></dt>
   139    139           <dd>The PEM encoded certificate.</dd>
          140  +        <dt><strong>version</strong> <em>value</em></dt>
          141  +        <dd>The protocol version used for the connection:
          142  +	  SSLv2, SSLv3, TLSv1, TLSv1.1, TLSv1.2, unknown</dd>
   140    143       </dl>
   141    144   </blockquote>
   142    145   
   143    146   <dl>
   144    147       <dt><a name="tls::import"><b>tls::import </b><i>channel
   145    148           ?options?</i></a></dt>
   146    149       <dd>SSL-enable a regular Tcl channel - it need not be a
................................................................................
   151    154   <blockquote>
   152    155       <dl>
   153    156           <dt><strong>-cadir</strong> <em>dir</em></dt>
   154    157           <dd>Provide the directory containing the CA certificates.</dd>
   155    158           <dt><strong>-cafile </strong><em>filename</em></dt>
   156    159           <dd>Provide the CA file.</dd>
   157    160           <dt><strong>-certfile</strong> <em>filename</em></dt>
   158         -        <dd>Provide the certificate to use.</dd>
          161  +        <dd>Provide the name of a file containing certificate to use.</dd>
          162  +        <dt><strong>-cert</strong> <em>filename</em></dt>
          163  +        <dd>Provide the contents of a certificate to use, as a DER encoded binary value (X.509 DER).</dd>
   159    164           <dt><strong>-cipher </strong><em>string</em></dt>
   160    165           <dd>Provide the cipher suites to use. Syntax is as per
   161    166               OpenSSL.</dd>
   162    167           <dt><strong>-command</strong> <em>callback</em></dt>
   163    168           <dd>If specified, this callback will be invoked at several points
   164    169               during the OpenSSL handshake.  It can pass errors and tracing
   165    170               information, and it can allow Tcl scripts to perform
................................................................................
   169    174               See <a href="#CALLBACK OPTIONS">CALLBACK OPTIONS</a> for
   170    175               further discussion.</dd>
   171    176           <dt><strong>-dhparams </strong><em>filename</em></dt>
   172    177           <dd>Provide a Diffie-Hellman parameters file.</dd>
   173    178           <dt><strong>-keyfile</strong> <em>filename</em></dt>
   174    179           <dd>Provide the private key file. (<strong>default</strong>:
   175    180               value of -certfile)</dd>
          181  +        <dt><strong>-key</strong> <em>filename</em></dt>
          182  +        <dd>Provide the private key to use as a DER encoded value (PKCS#1 DER)</dd>
   176    183           <dt><strong>-model</strong> <em>channel</em></dt>
   177    184           <dd>This will force this channel to share the same <em><strong>SSL_CTX</strong></em>
   178    185               structure as the specified <em>channel</em>, and
   179    186               therefore share callbacks etc.</dd>
   180    187           <dt><strong>-password</strong> <em>callback</em></dt>
   181    188           <dd>If supplied, this callback will be invoked when OpenSSL needs
   182    189               to obtain a password, typically to unlock the private key of