Hex Artifact Content

Artifact e65cf767465b38a08dcbbf3818f2ca13d7b8eba78cb149d293379436273807b7:


0000: 3c 21 64 6f 63 74 79 70 65 20 68 74 6d 6c 20 70  <!doctype html p
0010: 75 62 6c 69 63 20 22 2d 2f 2f 57 33 43 2f 2f 44  ublic "-//W3C//D
0020: 54 44 20 48 54 4d 4c 20 34 2e 30 20 54 72 61 6e  TD HTML 4.0 Tran
0030: 73 69 74 69 6f 6e 61 6c 2f 2f 45 4e 22 3e 20 0a  sitional//EN"> .
0040: 0a 3c 68 74 6d 6c 3e 0a 0a 3c 68 65 61 64 3e 0a  .<html>..<head>.
0050: 3c 6d 65 74 61 20 68 74 74 70 2d 65 71 75 69 76  <meta http-equiv
0060: 3d 22 43 6f 6e 74 65 6e 74 2d 54 79 70 65 22 0a  ="Content-Type".
0070: 63 6f 6e 74 65 6e 74 3d 22 74 65 78 74 2f 68 74  content="text/ht
0080: 6d 6c 3b 20 63 68 61 72 73 65 74 3d 69 73 6f 2d  ml; charset=iso-
0090: 38 38 35 39 2d 31 22 3e 0a 3c 6d 65 74 61 20 6e  8859-1">.<meta n
00a0: 61 6d 65 3d 22 43 6f 70 79 72 69 67 68 74 22 20  ame="Copyright" 
00b0: 63 6f 6e 74 65 6e 74 3d 22 31 39 39 39 20 4d 61  content="1999 Ma
00c0: 74 74 20 4e 65 77 6d 61 6e 20 2f 20 32 30 30 34  tt Newman / 2004
00d0: 20 53 74 61 72 66 69 73 68 20 53 79 73 74 65 6d   Starfish System
00e0: 73 22 3e 0a 3c 74 69 74 6c 65 3e 54 4c 53 20 28  s">.<title>TLS (
00f0: 53 53 4c 29 20 54 63 6c 20 43 6f 6d 6d 61 6e 64  SSL) Tcl Command
0100: 73 3c 2f 74 69 74 6c 65 3e 0a 3c 2f 68 65 61 64  s</title>.</head
0110: 3e 0a 0a 3c 62 6f 64 79 20 62 67 63 6f 6c 6f 72  >..<body bgcolor
0120: 3d 22 23 46 46 46 46 46 46 22 3e 0a 0a 3c 64 6c  ="#FFFFFF">..<dl
0130: 3e 0a 20 20 20 20 3c 64 64 3e 3c 61 20 68 72 65  >.    <dd><a hre
0140: 66 3d 22 23 4e 41 4d 45 22 3e 4e 41 4d 45 3c 2f  f="#NAME">NAME</
0150: 61 3e 20 3c 64 6c 3e 0a 20 20 20 20 20 20 20 20  a> <dl>.        
0160: 3c 64 64 3e 3c 62 3e 74 6c 73 3c 2f 62 3e 20 2d  <dd><b>tls</b> -
0170: 20 62 69 6e 64 69 6e 67 20 74 6f 20 3c 62 3e 4f   binding to <b>O
0180: 70 65 6e 53 53 4c 3c 2f 62 3e 20 74 6f 6f 6c 6b  penSSL</b> toolk
0190: 69 74 2e 3c 2f 64 64 3e 0a 20 20 20 20 3c 2f 64  it.</dd>.    </d
01a0: 6c 3e 0a 20 20 20 20 3c 2f 64 64 3e 0a 20 20 20  l>.    </dd>.   
01b0: 20 3c 64 64 3e 3c 61 20 68 72 65 66 3d 22 23 53   <dd><a href="#S
01c0: 59 4e 4f 50 53 49 53 22 3e 53 59 4e 4f 50 53 49  YNOPSIS">SYNOPSI
01d0: 53 3c 2f 61 3e 20 3c 2f 64 64 3e 0a 20 20 20 20  S</a> </dd>.    
01e0: 3c 64 64 3e 3c 64 6c 3e 0a 20 20 20 20 20 20 20  <dd><dl>.       
01f0: 20 20 20 20 20 3c 64 64 3e 3c 62 3e 70 61 63 6b       <dd><b>pack
0200: 61 67 65 20 72 65 71 75 69 72 65 20 54 63 6c 3c  age require Tcl<
0210: 2f 62 3e 20 3c 65 6d 3e 3f 38 2e 34 3f 3c 2f 65  /b> <em>?8.4?</e
0220: 6d 3e 3c 2f 64 64 3e 0a 20 20 20 20 20 20 20 20  m></dd>.        
0230: 20 20 20 20 3c 64 64 3e 3c 62 3e 70 61 63 6b 61      <dd><b>packa
0240: 67 65 20 72 65 71 75 69 72 65 20 74 6c 73 3c 2f  ge require tls</
0250: 62 3e 3c 2f 64 64 3e 0a 20 20 20 20 20 20 20 20  b></dd>.        
0260: 20 20 20 20 3c 64 74 3e 26 6e 62 73 70 3b 3c 2f      <dt>&nbsp;</
0270: 64 74 3e 0a 20 20 20 20 20 20 20 20 20 20 20 20  dt>.            
0280: 3c 64 64 3e 3c 62 3e 74 6c 73 3a 3a 69 6e 69 74  <dd><b>tls::init
0290: 3c 2f 62 3e 20 3c 65 6d 3e 3f 6f 70 74 69 6f 6e  </b> <em>?option
02a0: 73 3f 3c 2f 65 6d 3e 20 3c 2f 64 64 3e 0a 20 20  s?</em> </dd>.  
02b0: 20 20 20 20 20 20 20 20 20 20 3c 64 64 3e 3c 62            <dd><b
02c0: 3e 74 6c 73 3a 3a 73 6f 63 6b 65 74 3c 2f 62 3e  >tls::socket</b>
02d0: 20 3c 65 6d 3e 3f 6f 70 74 69 6f 6e 73 3f 20 68   <em>?options? h
02e0: 6f 73 74 20 70 6f 72 74 3c 2f 65 6d 3e 3c 2f 64  ost port</em></d
02f0: 64 3e 0a 20 20 20 20 20 20 20 20 20 20 20 20 3c  d>.            <
0300: 64 64 3e 3c 62 3e 74 6c 73 3a 3a 73 6f 63 6b 65  dd><b>tls::socke
0310: 74 3c 2f 62 3e 20 3c 65 6d 3e 20 3f 2d 73 65 72  t</b> <em> ?-ser
0320: 76 65 72 20 63 6f 6d 6d 61 6e 64 3f 20 3f 6f 70  ver command? ?op
0330: 74 69 6f 6e 73 3f 20 70 6f 72 74 3c 2f 65 6d 3e  tions? port</em>
0340: 3c 2f 64 64 3e 0a 20 20 20 20 20 20 20 20 20 20  </dd>.          
0350: 20 20 3c 64 64 3e 3c 62 3e 74 6c 73 3a 3a 68 61    <dd><b>tls::ha
0360: 6e 64 73 68 61 6b 65 3c 2f 62 3e 20 3c 65 6d 3e  ndshake</b> <em>
0370: 20 63 68 61 6e 6e 65 6c 3c 2f 65 6d 3e 3c 2f 64   channel</em></d
0380: 64 3e 0a 20 20 20 20 20 20 20 20 20 20 20 20 3c  d>.            <
0390: 64 64 3e 3c 62 3e 74 6c 73 3a 3a 73 74 61 74 75  dd><b>tls::statu
03a0: 73 20 3c 2f 62 3e 20 3c 65 6d 3e 3f 2d 6c 6f 63  s </b> <em>?-loc
03b0: 61 6c 3f 20 63 68 61 6e 6e 65 6c 3c 2f 65 6d 3e  al? channel</em>
03c0: 3c 2f 64 64 3e 0a 20 20 20 20 20 20 20 20 20 20  </dd>.          
03d0: 20 20 3c 64 64 3e 3c 62 3e 74 6c 73 3a 3a 63 6f    <dd><b>tls::co
03e0: 6e 6e 65 63 74 69 6f 6e 20 3c 2f 62 3e 20 3c 65  nnection </b> <e
03f0: 6d 3e 63 68 61 6e 6e 65 6c 3c 2f 65 6d 3e 3c 2f  m>channel</em></
0400: 64 64 3e 0a 20 20 20 20 20 20 20 20 20 20 20 20  dd>.            
0410: 3c 64 64 3e 3c 62 3e 74 6c 73 3a 3a 69 6d 70 6f  <dd><b>tls::impo
0420: 72 74 3c 2f 62 3e 20 3c 65 6d 3e 63 68 61 6e 6e  rt</b> <em>chann
0430: 65 6c 20 3f 6f 70 74 69 6f 6e 73 3f 3c 2f 65 6d  el ?options?</em
0440: 3e 3c 2f 64 64 3e 0a 20 20 20 20 20 20 20 20 20  ></dd>.         
0450: 20 20 20 3c 64 64 3e 3c 62 3e 74 6c 73 3a 3a 75     <dd><b>tls::u
0460: 6e 69 6d 70 6f 72 74 3c 2f 62 3e 20 3c 65 6d 3e  nimport</b> <em>
0470: 63 68 61 6e 6e 65 6c 3c 2f 65 6d 3e 3c 2f 64 64  channel</em></dd
0480: 3e 0a 20 20 20 20 20 20 20 20 20 20 20 20 3c 64  >.            <d
0490: 74 3e 26 6e 62 73 70 3b 3c 2f 64 74 3e 0a 20 20  t>&nbsp;</dt>.  
04a0: 20 20 20 20 20 20 20 20 20 20 3c 64 64 3e 3c 62            <dd><b
04b0: 3e 74 6c 73 3a 3a 63 69 70 68 65 72 73 20 3c 2f  >tls::ciphers </
04c0: 62 3e 20 3c 65 6d 3e 70 72 6f 74 6f 63 6f 6c 20  b> <em>protocol 
04d0: 3f 76 65 72 62 6f 73 65 3f 3c 2f 65 6d 3e 3c 2f  ?verbose?</em></
04e0: 64 64 3e 0a 20 20 20 20 20 20 20 20 20 20 20 20  dd>.            
04f0: 3c 64 64 3e 3c 62 3e 74 6c 73 3a 3a 76 65 72 73  <dd><b>tls::vers
0500: 69 6f 6e 3c 2f 62 3e 3c 2f 64 64 3e 0a 20 20 20  ion</b></dd>.   
0510: 20 20 20 20 20 3c 2f 64 6c 3e 0a 20 20 20 20 3c       </dl>.    <
0520: 2f 64 64 3e 0a 20 20 20 20 3c 64 64 3e 3c 61 20  /dd>.    <dd><a 
0530: 68 72 65 66 3d 22 23 43 4f 4d 4d 41 4e 44 53 22  href="#COMMANDS"
0540: 3e 43 4f 4d 4d 41 4e 44 53 3c 2f 61 3e 3c 2f 64  >COMMANDS</a></d
0550: 64 3e 0a 20 20 20 20 3c 64 64 3e 3c 61 20 68 72  d>.    <dd><a hr
0560: 65 66 3d 22 23 43 41 4c 4c 42 41 43 4b 20 4f 50  ef="#CALLBACK OP
0570: 54 49 4f 4e 53 22 3e 43 41 4c 4c 42 41 43 4b 20  TIONS">CALLBACK 
0580: 4f 50 54 49 4f 4e 53 3c 2f 61 3e 3c 2f 64 64 3e  OPTIONS</a></dd>
0590: 0a 20 20 20 20 3c 64 64 3e 3c 61 20 68 72 65 66  .    <dd><a href
05a0: 3d 22 23 48 54 54 50 53 20 45 58 41 4d 50 4c 45  ="#HTTPS EXAMPLE
05b0: 22 3e 48 54 54 50 53 20 45 58 41 4d 50 4c 45 3c  ">HTTPS EXAMPLE<
05c0: 2f 61 3e 3c 2f 64 64 3e 0a 20 20 20 20 3c 64 64  /a></dd>.    <dd
05d0: 3e 3c 61 20 68 72 65 66 3d 22 23 53 45 45 20 41  ><a href="#SEE A
05e0: 4c 53 4f 22 3e 53 50 45 43 49 41 4c 20 43 4f 4e  LSO">SPECIAL CON
05f0: 53 49 44 45 52 41 54 49 4f 4e 53 3c 2f 61 3e 3c  SIDERATIONS</a><
0600: 2f 64 64 3e 0a 20 20 20 20 3c 64 64 3e 3c 61 20  /dd>.    <dd><a 
0610: 68 72 65 66 3d 22 23 53 45 45 20 41 4c 53 4f 22  href="#SEE ALSO"
0620: 3e 53 45 45 20 41 4c 53 4f 3c 2f 61 3e 3c 2f 64  >SEE ALSO</a></d
0630: 64 3e 0a 3c 2f 64 6c 3e 0a 0a 3c 68 72 3e 0a 0a  d>.</dl>..<hr>..
0640: 3c 68 33 3e 3c 61 20 6e 61 6d 65 3d 22 4e 41 4d  <h3><a name="NAM
0650: 45 22 3e 4e 41 4d 45 3c 2f 61 3e 3c 2f 68 33 3e  E">NAME</a></h3>
0660: 0a 0a 3c 70 3e 3c 73 74 72 6f 6e 67 3e 74 6c 73  ..<p><strong>tls
0670: 3c 2f 73 74 72 6f 6e 67 3e 20 2d 20 62 69 6e 64  </strong> - bind
0680: 69 6e 67 20 74 6f 20 3c 73 74 72 6f 6e 67 3e 4f  ing to <strong>O
0690: 70 65 6e 53 53 4c 3c 2f 73 74 72 6f 6e 67 3e 0a  penSSL</strong>.
06a0: 74 6f 6f 6c 6b 69 74 2e 3c 2f 70 3e 0a 0a 3c 68  toolkit.</p>..<h
06b0: 33 3e 3c 61 20 6e 61 6d 65 3d 22 53 59 4e 4f 50  3><a name="SYNOP
06c0: 53 49 53 22 3e 53 59 4e 4f 50 53 49 53 3c 2f 61  SIS">SYNOPSIS</a
06d0: 3e 3c 2f 68 33 3e 0a 0a 3c 70 3e 3c 62 3e 70 61  ></h3>..<p><b>pa
06e0: 63 6b 61 67 65 20 72 65 71 75 69 72 65 20 54 63  ckage require Tc
06f0: 6c 20 38 2e 34 3c 2f 62 3e 3c 62 72 3e 0a 3c 62  l 8.4</b><br>.<b
0700: 3e 70 61 63 6b 61 67 65 20 72 65 71 75 69 72 65  >package require
0710: 20 74 6c 73 3c 2f 62 3e 3c 62 72 3e 0a 3c 62 72   tls</b><br>.<br
0720: 3e 0a 3c 61 20 68 72 65 66 3d 22 23 74 6c 73 3a  >.<a href="#tls:
0730: 3a 69 6e 69 74 22 3e 3c 62 3e 74 6c 73 3a 3a 69  :init"><b>tls::i
0740: 6e 69 74 3c 2f 62 3e 20 3c 69 3e 3f 6f 70 74 69  nit</b> <i>?opti
0750: 6f 6e 73 3f 3c 2f 69 3e 3c 2f 61 3e 3c 62 72 3e  ons?</i></a><br>
0760: 0a 3c 61 20 68 72 65 66 3d 22 23 74 6c 73 3a 3a  .<a href="#tls::
0770: 73 6f 63 6b 65 74 22 3e 3c 62 3e 74 6c 73 3a 3a  socket"><b>tls::
0780: 73 6f 63 6b 65 74 3c 2f 62 3e 20 3c 69 3e 3f 6f  socket</b> <i>?o
0790: 70 74 69 6f 6e 73 3f 20 68 6f 73 74 20 70 6f 72  ptions? host por
07a0: 74 3c 2f 69 3e 3c 62 72 3e 0a 3c 61 20 68 72 65  t</i><br>.<a hre
07b0: 66 3d 22 23 74 6c 73 3a 3a 73 6f 63 6b 65 74 22  f="#tls::socket"
07c0: 3e 3c 62 3e 74 6c 73 3a 3a 73 6f 63 6b 65 74 3c  ><b>tls::socket<
07d0: 2f 62 3e 20 3c 69 3e 3f 2d 73 65 72 76 65 72 20  /b> <i>?-server 
07e0: 63 6f 6d 6d 61 6e 64 3f 20 3f 6f 70 74 69 6f 6e  command? ?option
07f0: 73 3f 20 70 6f 72 74 3c 2f 69 3e 3c 2f 61 3e 3c  s? port</i></a><
0800: 62 72 3e 0a 3c 61 20 68 72 65 66 3d 22 23 74 6c  br>.<a href="#tl
0810: 73 3a 3a 73 74 61 74 75 73 22 3e 3c 62 3e 74 6c  s::status"><b>tl
0820: 73 3a 3a 73 74 61 74 75 73 3c 2f 62 3e 20 3c 69  s::status</b> <i
0830: 3e 3f 2d 6c 6f 63 61 6c 3f 20 63 68 61 6e 6e 65  >?-local? channe
0840: 6c 3c 2f 69 3e 3c 2f 61 3e 3c 62 72 3e 0a 3c 61  l</i></a><br>.<a
0850: 20 68 72 65 66 3d 22 23 74 6c 73 3a 3a 63 6f 6e   href="#tls::con
0860: 6e 65 63 74 69 6f 6e 22 3e 3c 62 3e 74 6c 73 3a  nection"><b>tls:
0870: 3a 63 6f 6e 6e 65 63 74 69 6f 6e 3c 2f 62 3e 20  :connection</b> 
0880: 3c 69 3e 63 68 61 6e 6e 65 6c 3c 2f 69 3e 3c 2f  <i>channel</i></
0890: 61 3e 3c 62 72 3e 0a 3c 61 20 68 72 65 66 3d 22  a><br>.<a href="
08a0: 23 74 6c 73 3a 3a 68 61 6e 64 73 68 61 6b 65 22  #tls::handshake"
08b0: 3e 3c 62 3e 74 6c 73 3a 3a 68 61 6e 64 73 68 61  ><b>tls::handsha
08c0: 6b 65 3c 2f 62 3e 20 3c 69 3e 63 68 61 6e 6e 65  ke</b> <i>channe
08d0: 6c 3c 2f 69 3e 3c 2f 61 3e 3c 62 72 3e 0a 3c 61  l</i></a><br>.<a
08e0: 20 68 72 65 66 3d 22 23 74 6c 73 3a 3a 69 6d 70   href="#tls::imp
08f0: 6f 72 74 22 3e 3c 62 3e 74 6c 73 3a 3a 69 6d 70  ort"><b>tls::imp
0900: 6f 72 74 3c 2f 62 3e 20 3c 69 3e 63 68 61 6e 6e  ort</b> <i>chann
0910: 65 6c 20 3f 6f 70 74 69 6f 6e 73 3f 3c 2f 69 3e  el ?options?</i>
0920: 3c 2f 61 3e 3c 62 72 3e 0a 3c 61 20 68 72 65 66  </a><br>.<a href
0930: 3d 22 23 74 6c 73 3a 3a 75 6e 69 6d 70 6f 72 74  ="#tls::unimport
0940: 22 3e 3c 62 3e 74 6c 73 3a 3a 75 6e 69 6d 70 6f  "><b>tls::unimpo
0950: 72 74 3c 2f 62 3e 20 3c 69 3e 63 68 61 6e 6e 65  rt</b> <i>channe
0960: 6c 3c 2f 69 3e 3c 2f 61 3e 3c 62 72 3e 0a 3c 62  l</i></a><br>.<b
0970: 72 3e 0a 3c 61 20 68 72 65 66 3d 22 23 74 6c 73  r>.<a href="#tls
0980: 3a 3a 63 69 70 68 65 72 73 22 3e 3c 62 3e 74 6c  ::ciphers"><b>tl
0990: 73 3a 3a 63 69 70 68 65 72 73 3c 2f 62 3e 20 3c  s::ciphers</b> <
09a0: 69 3e 70 72 6f 74 6f 63 6f 6c 20 3f 76 65 72 62  i>protocol ?verb
09b0: 6f 73 65 3f 3c 2f 69 3e 3c 2f 61 3e 3c 62 72 3e  ose?</i></a><br>
09c0: 0a 3c 61 20 68 72 65 66 3d 22 23 74 6c 73 3a 3a  .<a href="#tls::
09d0: 76 65 72 73 69 6f 6e 22 3e 3c 62 3e 74 6c 73 3a  version"><b>tls:
09e0: 3a 76 65 72 73 69 6f 6e 3c 2f 62 3e 3c 2f 61 3e  :version</b></a>
09f0: 0a 3c 2f 70 3e 0a 0a 3c 68 33 3e 3c 61 20 6e 61  .</p>..<h3><a na
0a00: 6d 65 3d 22 44 45 53 43 52 49 50 54 49 4f 4e 22  me="DESCRIPTION"
0a10: 3e 44 45 53 43 52 49 50 54 49 4f 4e 3c 2f 61 3e  >DESCRIPTION</a>
0a20: 3c 2f 68 33 3e 0a 0a 3c 70 3e 54 68 69 73 20 65  </h3>..<p>This e
0a30: 78 74 65 6e 73 69 6f 6e 20 70 72 6f 76 69 64 65  xtension provide
0a40: 73 20 61 20 67 65 6e 65 72 69 63 20 62 69 6e 64  s a generic bind
0a50: 69 6e 67 20 74 6f 20 3c 61 0a 68 72 65 66 3d 22  ing to <a.href="
0a60: 68 74 74 70 3a 2f 2f 77 77 77 2e 6f 70 65 6e 73  http://www.opens
0a70: 73 6c 2e 6f 72 67 2f 22 3e 4f 70 65 6e 53 53 4c  sl.org/">OpenSSL
0a80: 3c 2f 61 3e 2c 20 75 74 69 6c 69 7a 69 6e 67 20  </a>, utilizing 
0a90: 74 68 65 0a 3c 73 74 72 6f 6e 67 3e 54 63 6c 5f  the.<strong>Tcl_
0aa0: 53 74 61 63 6b 43 68 61 6e 6e 65 6c 3c 2f 73 74  StackChannel</st
0ab0: 72 6f 6e 67 3e 0a 41 50 49 20 66 6f 72 20 54 63  rong>.API for Tc
0ac0: 6c 20 38 2e 34 20 61 6e 64 20 68 69 67 68 65 72  l 8.4 and higher
0ad0: 2e 20 54 68 65 20 73 6f 63 6b 65 74 73 20 62 65  . The sockets be
0ae0: 68 61 76 65 20 65 78 61 63 74 6c 79 20 74 68 65  have exactly the
0af0: 20 73 61 6d 65 0a 61 73 20 63 68 61 6e 6e 65 6c   same.as channel
0b00: 73 20 63 72 65 61 74 65 64 20 75 73 69 6e 67 20  s created using 
0b10: 54 63 6c 27 73 20 62 75 69 6c 74 2d 69 6e 20 3c  Tcl's built-in <
0b20: 73 74 72 6f 6e 67 3e 73 6f 63 6b 65 74 3c 2f 73  strong>socket</s
0b30: 74 72 6f 6e 67 3e 0a 63 6f 6d 6d 61 6e 64 20 77  trong>.command w
0b40: 69 74 68 20 61 64 64 69 74 69 6f 6e 61 6c 20 6f  ith additional o
0b50: 70 74 69 6f 6e 73 20 66 6f 72 20 63 6f 6e 74 72  ptions for contr
0b60: 6f 6c 6c 69 6e 67 20 74 68 65 20 53 53 4c 20 73  olling the SSL s
0b70: 65 73 73 69 6f 6e 2e 0a 3c 2f 70 3e 0a 0a 3c 68  ession..</p>..<h
0b80: 33 3e 3c 61 20 6e 61 6d 65 3d 22 43 4f 4d 4d 41  3><a name="COMMA
0b90: 4e 44 53 22 3e 43 4f 4d 4d 41 4e 44 53 3c 2f 61  NDS">COMMANDS</a
0ba0: 3e 3c 2f 68 33 3e 0a 0a 3c 70 3e 54 79 70 69 63  ></h3>..<p>Typic
0bb0: 61 6c 6c 79 20 6f 6e 65 20 77 6f 75 6c 64 20 75  ally one would u
0bc0: 73 65 20 74 68 65 20 3c 73 74 72 6f 6e 67 3e 74  se the <strong>t
0bd0: 6c 73 3a 3a 73 6f 63 6b 65 74 20 3c 2f 73 74 72  ls::socket </str
0be0: 6f 6e 67 3e 63 6f 6d 6d 61 6e 64 0a 77 68 69 63  ong>command.whic
0bf0: 68 20 70 72 6f 76 69 64 65 73 20 63 6f 6d 70 61  h provides compa
0c00: 74 69 62 69 6c 69 74 79 20 77 69 74 68 20 74 68  tibility with th
0c10: 65 20 6e 61 74 69 76 65 20 54 63 6c 20 3c 73 74  e native Tcl <st
0c20: 72 6f 6e 67 3e 73 6f 63 6b 65 74 3c 2f 73 74 72  rong>socket</str
0c30: 6f 6e 67 3e 0a 63 6f 6d 6d 61 6e 64 2e 20 49 6e  ong>.command. In
0c40: 20 73 75 63 68 20 63 61 73 65 73 20 3c 73 74 72   such cases <str
0c50: 6f 6e 67 3e 74 6c 73 3a 3a 69 6d 70 6f 72 74 3c  ong>tls::import<
0c60: 2f 73 74 72 6f 6e 67 3e 20 73 68 6f 75 6c 64 20  /strong> should 
0c70: 6e 6f 74 20 62 65 0a 75 73 65 64 20 64 69 72 65  not be.used dire
0c80: 63 74 6c 79 2e 3c 2f 70 3e 0a 0a 3c 64 6c 3e 0a  ctly.</p>..<dl>.
0c90: 20 20 20 20 3c 64 74 3e 3c 61 20 6e 61 6d 65 3d      <dt><a name=
0ca0: 22 74 6c 73 3a 3a 69 6e 69 74 22 3e 3c 62 3e 74  "tls::init"><b>t
0cb0: 6c 73 3a 3a 69 6e 69 74 20 3c 2f 62 3e 3c 69 3e  ls::init </b><i>
0cc0: 3f 6f 70 74 69 6f 6e 73 3f 3c 2f 69 3e 3c 2f 61  ?options?</i></a
0cd0: 3e 3c 2f 64 74 3e 0a 20 20 20 20 3c 64 64 3e 4f  ></dt>.    <dd>O
0ce0: 70 74 69 6f 6e 61 6c 20 66 75 6e 63 74 69 6f 6e  ptional function
0cf0: 20 74 6f 20 73 65 74 20 74 68 65 20 64 65 66 61   to set the defa
0d00: 75 6c 74 20 6f 70 74 69 6f 6e 73 20 75 73 65 64  ult options used
0d10: 20 62 79 0a 09 3c 73 74 72 6f 6e 67 3e 74 6c 73   by..<strong>tls
0d20: 3a 3a 73 6f 63 6b 65 74 3c 2f 73 74 72 6f 6e 67  ::socket</strong
0d30: 3e 2e 20 49 66 20 79 6f 75 20 63 61 6c 6c 20 3c  >. If you call <
0d40: 73 74 72 6f 6e 67 3e 74 6c 73 3a 3a 69 6d 70 6f  strong>tls::impo
0d50: 72 74 3c 2f 73 74 72 6f 6e 67 3e 0a 20 20 20 20  rt</strong>.    
0d60: 20 20 20 20 64 69 72 65 63 74 6c 79 20 74 68 69      directly thi
0d70: 73 20 72 6f 75 74 69 6e 65 20 68 61 73 20 6e 6f  s routine has no
0d80: 20 65 66 66 65 63 74 2e 20 41 6e 79 20 6f 66 20   effect. Any of 
0d90: 74 68 65 20 6f 70 74 69 6f 6e 73 0a 20 20 20 20  the options.    
0da0: 20 20 20 20 74 68 61 74 20 3c 73 74 72 6f 6e 67      that <strong
0db0: 3e 74 6c 73 3a 3a 73 6f 63 6b 65 74 3c 2f 73 74  >tls::socket</st
0dc0: 72 6f 6e 67 3e 20 61 63 63 65 70 74 73 20 63 61  rong> accepts ca
0dd0: 6e 20 62 65 20 73 65 74 0a 20 20 20 20 20 20 20  n be set.       
0de0: 20 75 73 69 6e 67 20 74 68 69 73 20 63 6f 6d 6d   using this comm
0df0: 61 6e 64 2c 20 74 68 6f 75 67 68 20 79 6f 75 20  and, though you 
0e00: 73 68 6f 75 6c 64 20 6c 69 6d 69 74 20 79 6f 75  should limit you
0e10: 72 20 6f 70 74 69 6f 6e 73 0a 20 20 20 20 20 20  r options.      
0e20: 20 20 74 6f 20 6f 6e 6c 79 20 54 4c 53 20 72 65    to only TLS re
0e30: 6c 61 74 65 64 20 6f 6e 65 73 2e 3c 2f 64 64 3e  lated ones.</dd>
0e40: 0a 20 20 20 20 3c 64 74 3e 26 6e 62 73 70 3b 3c  .    <dt>&nbsp;<
0e50: 2f 64 74 3e 0a 20 20 20 20 3c 64 74 3e 3c 61 20  /dt>.    <dt><a 
0e60: 6e 61 6d 65 3d 22 74 6c 73 3a 3a 73 6f 63 6b 65  name="tls::socke
0e70: 74 22 3e 3c 62 3e 74 6c 73 3a 3a 73 6f 63 6b 65  t"><b>tls::socke
0e80: 74 20 3c 2f 62 3e 3c 65 6d 3e 3f 6f 70 74 69 6f  t </b><em>?optio
0e90: 6e 73 3f 0a 20 20 20 20 20 20 20 20 68 6f 73 74  ns?.        host
0ea0: 20 70 6f 72 74 3c 2f 65 6d 3e 3c 2f 61 3e 3c 2f   port</em></a></
0eb0: 64 74 3e 0a 20 20 20 20 3c 64 74 3e 3c 62 3e 74  dt>.    <dt><b>t
0ec0: 6c 73 3a 3a 73 6f 63 6b 65 74 3c 2f 62 3e 3c 65  ls::socket</b><e
0ed0: 6d 3e 20 3f 2d 73 65 72 76 65 72 20 63 6f 6d 6d  m> ?-server comm
0ee0: 61 6e 64 3f 20 3f 6f 70 74 69 6f 6e 73 3f 20 70  and? ?options? p
0ef0: 6f 72 74 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20  ort</em></dt>.  
0f00: 20 20 3c 64 64 3e 54 68 69 73 20 69 73 20 61 20    <dd>This is a 
0f10: 68 65 6c 70 65 72 20 66 75 6e 63 74 69 6f 6e 20  helper function 
0f20: 74 68 61 74 20 75 74 69 6c 69 7a 65 73 20 74 68  that utilizes th
0f30: 65 20 75 6e 64 65 72 6c 79 69 6e 67 0a 20 20 20  e underlying.   
0f40: 20 20 20 20 20 63 6f 6d 6d 61 6e 64 73 20 28 3c       commands (<
0f50: 73 74 72 6f 6e 67 3e 74 6c 73 3a 3a 69 6d 70 6f  strong>tls::impo
0f60: 72 74 3c 2f 73 74 72 6f 6e 67 3e 29 2e 20 49 74  rt</strong>). It
0f70: 20 62 65 68 61 76 65 73 0a 20 20 20 20 20 20 20   behaves.       
0f80: 20 65 78 61 63 74 6c 79 20 74 68 65 20 73 61 6d   exactly the sam
0f90: 65 20 61 73 20 74 68 65 20 6e 61 74 69 76 65 20  e as the native 
0fa0: 54 63 6c 20 3c 73 74 72 6f 6e 67 3e 73 6f 63 6b  Tcl <strong>sock
0fb0: 65 74 3c 2f 73 74 72 6f 6e 67 3e 0a 20 20 20 20  et</strong>.    
0fc0: 20 20 20 20 63 6f 6d 6d 61 6e 64 20 65 78 63 65      command exce
0fd0: 70 74 20 74 68 61 74 20 74 68 65 20 6f 70 74 69  pt that the opti
0fe0: 6f 6e 73 20 63 61 6e 20 69 6e 63 6c 75 64 65 20  ons can include 
0ff0: 61 6e 79 20 6f 66 20 74 68 65 0a 20 20 20 20 20  any of the.     
1000: 20 20 20 61 70 70 6c 69 63 61 62 6c 65 20 3c 61     applicable <a
1010: 20 68 72 65 66 3d 22 23 74 6c 73 3a 3a 69 6d 70   href="#tls::imp
1020: 6f 72 74 22 3e 3c 73 74 72 6f 6e 67 3e 74 6c 73  ort"><strong>tls
1030: 3a 69 6d 70 6f 72 74 3c 2f 73 74 72 6f 6e 67 3e  :import</strong>
1040: 3c 2f 61 3e 0a 20 20 20 20 20 20 20 20 6f 70 74  </a>.        opt
1050: 69 6f 6e 73 20 77 69 74 68 20 6f 6e 65 20 61 64  ions with one ad
1060: 64 69 74 69 6f 6e 61 6c 20 6f 70 74 69 6f 6e 3a  ditional option:
1070: 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 20 20  .<blockquote>.  
1080: 20 20 3c 64 6c 3e 0a 20 20 20 20 20 20 20 20 3c    <dl>.        <
1090: 64 74 3e 3c 73 74 72 6f 6e 67 3e 2d 61 75 74 6f  dt><strong>-auto
10a0: 73 65 72 76 65 72 6e 61 6d 65 3c 2f 73 74 72 6f  servername</stro
10b0: 6e 67 3e 20 3c 65 6d 3e 62 6f 6f 6c 3c 2f 65 6d  ng> <em>bool</em
10c0: 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c  ></dt>.        <
10d0: 64 64 3e 41 75 74 6f 6d 61 74 69 63 61 6c 6c 79  dd>Automatically
10e0: 20 73 65 6e 64 20 74 68 65 20 2d 73 65 72 76 65   send the -serve
10f0: 72 6e 61 6d 65 20 61 73 20 74 68 65 20 3c 65 6d  rname as the <em
1100: 3e 68 6f 73 74 3c 2f 65 6d 3e 20 61 72 67 75 6d  >host</em> argum
1110: 65 6e 74 0a 20 20 20 20 20 20 20 20 20 20 20 20  ent.            
1120: 28 64 65 66 61 75 6c 74 20 69 73 20 3c 65 6d 3e  (default is <em>
1130: 66 61 6c 73 65 3c 2f 65 6d 3e 29 3c 2f 64 64 3e  false</em>)</dd>
1140: 0a 20 20 20 20 3c 2f 64 6c 3e 0a 3c 2f 62 6c 6f  .    </dl>.</blo
1150: 63 6b 71 75 6f 74 65 3e 0a 0a 20 20 20 20 3c 64  ckquote>..    <d
1160: 74 3e 3c 61 20 6e 61 6d 65 3d 22 74 6c 73 3a 3a  t><a name="tls::
1170: 69 6d 70 6f 72 74 22 3e 3c 62 3e 74 6c 73 3a 3a  import"><b>tls::
1180: 69 6d 70 6f 72 74 20 3c 2f 62 3e 3c 69 3e 63 68  import </b><i>ch
1190: 61 6e 6e 65 6c 0a 20 20 20 20 20 20 20 20 3f 6f  annel.        ?o
11a0: 70 74 69 6f 6e 73 3f 3c 2f 69 3e 3c 2f 61 3e 3c  ptions?</i></a><
11b0: 2f 64 74 3e 0a 20 20 20 20 3c 64 64 3e 53 53 4c  /dt>.    <dd>SSL
11c0: 2d 65 6e 61 62 6c 65 20 61 20 72 65 67 75 6c 61  -enable a regula
11d0: 72 20 54 63 6c 20 63 68 61 6e 6e 65 6c 20 2d 20  r Tcl channel - 
11e0: 69 74 20 6e 65 65 64 20 6e 6f 74 20 62 65 20 61  it need not be a
11f0: 0a 20 20 20 20 20 20 20 20 73 6f 63 6b 65 74 2c  .        socket,
1200: 20 62 75 74 20 6d 75 73 74 20 70 72 6f 76 69 64   but must provid
1210: 65 20 62 69 2d 64 69 72 65 63 74 69 6f 6e 61 6c  e bi-directional
1220: 20 66 6c 6f 77 2e 20 41 6c 73 6f 0a 20 20 20 20   flow. Also.    
1230: 20 20 20 20 73 65 74 74 69 6e 67 20 73 65 73 73      setting sess
1240: 69 6f 6e 20 70 61 72 61 6d 65 74 65 72 73 20 66  ion parameters f
1250: 6f 72 20 53 53 4c 20 68 61 6e 64 73 68 61 6b 65  or SSL handshake
1260: 2e 3c 2f 64 64 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  .</dd>..<blockqu
1270: 6f 74 65 3e 0a 20 20 20 20 3c 64 6c 3e 0a 20 20  ote>.    <dl>.  
1280: 20 20 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e        <dt><stron
1290: 67 3e 2d 61 6c 70 6e 3c 2f 73 74 72 6f 6e 67 3e  g>-alpn</strong>
12a0: 20 3c 65 6d 3e 6c 69 73 74 3c 2f 65 6d 3e 3c 2f   <em>list</em></
12b0: 64 74 3e 0a 20 20 20 20 20 20 20 20 3c 64 64 3e  dt>.        <dd>
12c0: 4c 69 73 74 20 6f 66 20 70 72 6f 74 6f 63 6f 6c  List of protocol
12d0: 73 20 74 6f 20 6f 66 66 65 72 20 64 75 72 69 6e  s to offer durin
12e0: 67 20 41 70 70 6c 69 63 61 74 69 6f 6e 2d 4c 61  g Application-La
12f0: 79 65 72 0a 09 20 20 20 20 50 72 6f 74 6f 63 6f  yer..    Protoco
1300: 6c 20 4e 65 67 6f 74 69 61 74 69 6f 6e 20 28 41  l Negotiation (A
1310: 4c 50 4e 29 2e 20 46 6f 72 20 65 78 61 6d 70 6c  LPN). For exampl
1320: 65 3a 20 68 32 2c 20 68 74 74 70 2f 31 2e 31 2c  e: h2, http/1.1,
1330: 20 65 74 63 2e 3c 2f 64 64 3e 0a 20 20 20 20 20   etc.</dd>.     
1340: 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e 2d     <dt><strong>-
1350: 63 61 64 69 72 3c 2f 73 74 72 6f 6e 67 3e 20 3c  cadir</strong> <
1360: 65 6d 3e 64 69 72 3c 2f 65 6d 3e 3c 2f 64 74 3e  em>dir</em></dt>
1370: 0a 20 20 20 20 20 20 20 20 3c 64 64 3e 53 70 65  .        <dd>Spe
1380: 63 69 66 79 20 74 68 65 20 64 69 72 65 63 74 6f  cify the directo
1390: 72 79 20 63 6f 6e 74 61 69 6e 69 6e 67 20 74 68  ry containing th
13a0: 65 20 43 41 20 63 65 72 74 69 66 69 63 61 74 65  e CA certificate
13b0: 73 2e 20 54 68 65 0a 09 20 20 20 20 64 65 66 61  s. The..    defa
13c0: 75 6c 74 20 64 69 72 65 63 74 6f 72 79 20 69 73  ult directory is
13d0: 20 70 6c 61 74 66 6f 72 6d 20 73 70 65 63 69 66   platform specif
13e0: 69 63 20 61 6e 64 20 63 61 6e 20 62 65 20 73 65  ic and can be se
13f0: 74 20 61 74 0a 09 20 20 20 20 63 6f 6d 70 69 6c  t at..    compil
1400: 65 20 74 69 6d 65 2e 20 54 68 69 73 20 63 61 6e  e time. This can
1410: 20 62 65 20 6f 76 65 72 72 69 64 64 65 6e 20 76   be overridden v
1420: 69 61 20 74 68 65 20 3c 62 3e 53 53 4c 5f 43 45  ia the <b>SSL_CE
1430: 52 54 5f 44 49 52 3c 2f 62 3e 0a 09 20 20 20 20  RT_DIR</b>..    
1440: 65 6e 76 69 72 6f 6e 6d 65 6e 74 20 76 61 72 69  environment vari
1450: 61 62 6c 65 2e 3c 2f 64 64 3e 0a 20 20 20 20 20  able.</dd>.     
1460: 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e 2d     <dt><strong>-
1470: 63 61 66 69 6c 65 20 3c 2f 73 74 72 6f 6e 67 3e  cafile </strong>
1480: 3c 65 6d 3e 66 69 6c 65 6e 61 6d 65 3c 2f 65 6d  <em>filename</em
1490: 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c  ></dt>.        <
14a0: 64 64 3e 53 70 65 63 69 66 79 20 74 68 65 20 63  dd>Specify the c
14b0: 65 72 74 69 66 69 63 61 74 65 20 61 75 74 68 6f  ertificate autho
14c0: 72 69 74 79 20 28 43 41 29 20 66 69 6c 65 20 74  rity (CA) file t
14d0: 6f 20 75 73 65 2e 3c 2f 64 64 3e 0a 20 20 20 20  o use.</dd>.    
14e0: 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e      <dt><strong>
14f0: 2d 63 65 72 74 66 69 6c 65 3c 2f 73 74 72 6f 6e  -certfile</stron
1500: 67 3e 20 3c 65 6d 3e 66 69 6c 65 6e 61 6d 65 3c  g> <em>filename<
1510: 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20  /em></dt>.      
1520: 20 20 3c 64 64 3e 53 70 65 63 69 66 79 20 74 68    <dd>Specify th
1530: 65 20 66 69 6c 65 6e 61 6d 65 20 63 6f 6e 74 61  e filename conta
1540: 69 6e 69 6e 67 20 74 68 65 20 63 65 72 74 69 66  ining the certif
1550: 69 63 61 74 65 20 74 6f 20 75 73 65 2e 20 54 68  icate to use. Th
1560: 65 0a 09 20 20 20 20 64 65 66 61 75 6c 74 20 6e  e..    default n
1570: 61 6d 65 20 69 73 20 3c 62 3e 63 65 72 74 2e 70  ame is <b>cert.p
1580: 65 6d 3c 2f 62 3e 2e 20 54 68 69 73 20 63 61 6e  em</b>. This can
1590: 20 62 65 20 6f 76 65 72 72 69 64 64 65 6e 20 76   be overridden v
15a0: 69 61 0a 09 20 20 20 20 74 68 65 20 3c 62 3e 53  ia..    the <b>S
15b0: 53 4c 5f 43 45 52 54 5f 46 49 4c 45 3c 2f 62 3e  SL_CERT_FILE</b>
15c0: 20 65 6e 76 69 72 6f 6e 6d 65 6e 74 20 76 61 72   environment var
15d0: 69 61 62 6c 65 2e 3c 2f 64 64 3e 0a 20 20 20 20  iable.</dd>.    
15e0: 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e      <dt><strong>
15f0: 2d 63 65 72 74 3c 2f 73 74 72 6f 6e 67 3e 20 3c  -cert</strong> <
1600: 65 6d 3e 66 69 6c 65 6e 61 6d 65 3c 2f 65 6d 3e  em>filename</em>
1610: 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c 64  </dt>.        <d
1620: 64 3e 53 70 65 63 69 66 79 20 74 68 65 20 63 6f  d>Specify the co
1630: 6e 74 65 6e 74 73 20 6f 66 20 61 20 63 65 72 74  ntents of a cert
1640: 69 66 69 63 61 74 65 20 74 6f 20 75 73 65 2c 20  ificate to use, 
1650: 61 73 20 61 20 44 45 52 0a 09 20 20 20 20 65 6e  as a DER..    en
1660: 63 6f 64 65 64 20 62 69 6e 61 72 79 20 76 61 6c  coded binary val
1670: 75 65 20 28 58 2e 35 30 39 20 44 45 52 29 2e 3c  ue (X.509 DER).<
1680: 2f 64 64 3e 0a 20 20 20 20 20 20 20 20 3c 64 74  /dd>.        <dt
1690: 3e 3c 73 74 72 6f 6e 67 3e 2d 63 69 70 68 65 72  ><strong>-cipher
16a0: 3c 2f 73 74 72 6f 6e 67 3e 20 3c 65 6d 3e 73 74  </strong> <em>st
16b0: 72 69 6e 67 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20  ring</em></dt>. 
16c0: 20 20 20 20 20 20 20 3c 64 64 3e 4c 69 73 74 20         <dd>List 
16d0: 6f 66 20 63 69 70 68 65 72 73 20 74 6f 20 75 73  of ciphers to us
16e0: 65 2e 20 53 65 65 20 4f 70 65 6e 53 53 4c 20 64  e. See OpenSSL d
16f0: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 6f 72  ocumentation for
1700: 20 74 68 65 20 66 75 6c 6c 0a 09 20 20 20 20 6c   the full..    l
1710: 69 73 74 20 6f 66 20 76 61 6c 69 64 20 76 61 6c  ist of valid val
1720: 75 65 73 2e 3c 2f 64 64 3e 0a 20 20 20 20 20 20  ues.</dd>.      
1730: 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e 2d 63    <dt><strong>-c
1740: 6f 6d 6d 61 6e 64 3c 2f 73 74 72 6f 6e 67 3e 20  ommand</strong> 
1750: 3c 65 6d 3e 63 61 6c 6c 62 61 63 6b 3c 2f 65 6d  <em>callback</em
1760: 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c  ></dt>.        <
1770: 64 64 3e 43 61 6c 6c 62 61 63 6b 20 74 6f 20 69  dd>Callback to i
1780: 6e 76 6f 6b 65 20 61 74 20 73 65 76 65 72 61 6c  nvoke at several
1790: 20 70 6f 69 6e 74 73 20 64 75 72 69 6e 67 20 74   points during t
17a0: 68 65 20 68 61 6e 64 73 68 61 6b 65 2e 0a 09 20  he handshake... 
17b0: 20 20 20 54 68 69 73 20 69 73 20 75 73 65 64 20     This is used 
17c0: 74 6f 20 70 61 73 73 20 65 72 72 6f 72 73 20 61  to pass errors a
17d0: 6e 64 20 74 72 61 63 69 6e 67 20 69 6e 66 6f 72  nd tracing infor
17e0: 6d 61 74 69 6f 6e 2c 20 61 6e 64 0a 09 20 20 20  mation, and..   
17f0: 20 69 74 20 63 61 6e 20 61 6c 6c 6f 77 20 54 63   it can allow Tc
1800: 6c 20 73 63 72 69 70 74 73 20 74 6f 20 70 65 72  l scripts to per
1810: 66 6f 72 6d 20 74 68 65 69 72 20 6f 77 6e 20 63  form their own c
1820: 65 72 74 69 66 69 63 61 74 65 0a 09 20 20 20 20  ertificate..    
1830: 76 61 6c 69 64 61 74 69 6f 6e 20 69 6e 20 70 6c  validation in pl
1840: 61 63 65 20 6f 66 20 74 68 65 20 64 65 66 61 75  ace of the defau
1850: 6c 74 20 76 61 6c 69 64 61 74 69 6f 6e 20 70 72  lt validation pr
1860: 6f 76 69 64 65 64 20 62 79 0a 09 20 20 20 20 4f  ovided by..    O
1870: 70 65 6e 53 53 4c 2e 20 53 65 65 20 3c 61 20 68  penSSL. See <a h
1880: 72 65 66 3d 22 23 43 41 4c 4c 42 41 43 4b 20 4f  ref="#CALLBACK O
1890: 50 54 49 4f 4e 53 22 3e 43 41 4c 4c 42 41 43 4b  PTIONS">CALLBACK
18a0: 20 4f 50 54 49 4f 4e 53 3c 2f 61 3e 0a 09 20 20   OPTIONS</a>..  
18b0: 20 20 66 6f 72 20 66 75 72 74 68 65 72 20 64 69    for further di
18c0: 73 63 75 73 73 69 6f 6e 2e 3c 2f 64 64 3e 0a 20  scussion.</dd>. 
18d0: 20 20 20 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f         <dt><stro
18e0: 6e 67 3e 2d 64 68 70 61 72 61 6d 73 20 3c 2f 73  ng>-dhparams </s
18f0: 74 72 6f 6e 67 3e 3c 65 6d 3e 66 69 6c 65 6e 61  trong><em>filena
1900: 6d 65 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20  me</em></dt>.   
1910: 20 20 20 20 20 3c 64 64 3e 53 70 65 63 69 66 79       <dd>Specify
1920: 20 74 68 65 20 44 69 66 66 69 65 2d 48 65 6c 6c   the Diffie-Hell
1930: 6d 61 6e 20 70 61 72 61 6d 65 74 65 72 73 20 66  man parameters f
1940: 69 6c 65 2e 3c 2f 64 64 3e 0a 20 20 20 20 20 20  ile.</dd>.      
1950: 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e 2d 6b    <dt><strong>-k
1960: 65 79 66 69 6c 65 3c 2f 73 74 72 6f 6e 67 3e 20  eyfile</strong> 
1970: 3c 65 6d 3e 66 69 6c 65 6e 61 6d 65 3c 2f 65 6d  <em>filename</em
1980: 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c  ></dt>.        <
1990: 64 64 3e 53 70 65 63 69 66 79 20 74 68 65 20 70  dd>Specify the p
19a0: 72 69 76 61 74 65 20 6b 65 79 20 66 69 6c 65 2e  rivate key file.
19b0: 20 28 64 65 66 61 75 6c 74 20 69 73 0a 20 20 20   (default is.   
19c0: 20 20 20 20 20 20 20 20 20 76 61 6c 75 65 20 6f           value o
19d0: 66 20 2d 63 65 72 74 66 69 6c 65 29 3c 2f 64 64  f -certfile)</dd
19e0: 3e 0a 20 20 20 20 20 20 20 20 3c 64 74 3e 3c 73  >.        <dt><s
19f0: 74 72 6f 6e 67 3e 2d 6b 65 79 3c 2f 73 74 72 6f  trong>-key</stro
1a00: 6e 67 3e 20 3c 65 6d 3e 66 69 6c 65 6e 61 6d 65  ng> <em>filename
1a10: 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20  </em></dt>.     
1a20: 20 20 20 3c 64 64 3e 53 70 65 63 69 66 79 20 74     <dd>Specify t
1a30: 68 65 20 70 72 69 76 61 74 65 20 6b 65 79 20 74  he private key t
1a40: 6f 20 75 73 65 20 61 73 20 61 20 44 45 52 20 65  o use as a DER e
1a50: 6e 63 6f 64 65 64 20 76 61 6c 75 65 20 28 50 4b  ncoded value (PK
1a60: 43 53 23 31 20 44 45 52 29 3c 2f 64 64 3e 0a 20  CS#1 DER)</dd>. 
1a70: 20 20 20 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f         <dt><stro
1a80: 6e 67 3e 2d 6d 6f 64 65 6c 3c 2f 73 74 72 6f 6e  ng>-model</stron
1a90: 67 3e 20 3c 65 6d 3e 63 68 61 6e 6e 65 6c 3c 2f  g> <em>channel</
1aa0: 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20  em></dt>.       
1ab0: 20 3c 64 64 3e 46 6f 72 63 65 20 74 68 69 73 20   <dd>Force this 
1ac0: 63 68 61 6e 6e 65 6c 20 74 6f 20 73 68 61 72 65  channel to share
1ad0: 20 74 68 65 20 73 61 6d 65 20 3c 65 6d 3e 3c 73   the same <em><s
1ae0: 74 72 6f 6e 67 3e 53 53 4c 5f 43 54 58 3c 2f 73  trong>SSL_CTX</s
1af0: 74 72 6f 6e 67 3e 3c 2f 65 6d 3e 0a 20 20 20 20  trong></em>.    
1b00: 20 20 20 20 20 20 20 20 73 74 72 75 63 74 75 72          structur
1b10: 65 20 61 73 20 74 68 65 20 73 70 65 63 69 66 69  e as the specifi
1b20: 65 64 20 3c 65 6d 3e 63 68 61 6e 6e 65 6c 3c 2f  ed <em>channel</
1b30: 65 6d 3e 2c 20 61 6e 64 0a 20 20 20 20 20 20 20  em>, and.       
1b40: 20 20 20 20 20 74 68 65 72 65 66 6f 72 65 20 73       therefore s
1b50: 68 61 72 65 20 63 61 6c 6c 62 61 63 6b 73 20 65  hare callbacks e
1b60: 74 63 2e 3c 2f 64 64 3e 0a 20 20 20 20 20 20 20  tc.</dd>.       
1b70: 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e 2d 70 61   <dt><strong>-pa
1b80: 73 73 77 6f 72 64 3c 2f 73 74 72 6f 6e 67 3e 20  ssword</strong> 
1b90: 3c 65 6d 3e 63 61 6c 6c 62 61 63 6b 3c 2f 65 6d  <em>callback</em
1ba0: 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c  ></dt>.        <
1bb0: 64 64 3e 43 61 6c 6c 62 61 63 6b 20 74 6f 20 69  dd>Callback to i
1bc0: 6e 76 6f 6b 65 20 77 68 65 6e 20 4f 70 65 6e 53  nvoke when OpenS
1bd0: 53 4c 20 6e 65 65 64 73 20 74 6f 20 6f 62 74 61  SL needs to obta
1be0: 69 6e 20 61 20 70 61 73 73 77 6f 72 64 2c 0a 09  in a password,..
1bf0: 20 20 20 20 74 79 70 69 63 61 6c 6c 79 20 74 6f      typically to
1c00: 20 75 6e 6c 6f 63 6b 20 74 68 65 20 70 72 69 76   unlock the priv
1c10: 61 74 65 20 6b 65 79 20 6f 66 20 61 20 63 65 72  ate key of a cer
1c20: 74 69 66 69 63 61 74 65 2e 20 54 68 65 0a 20 20  tificate. The.  
1c30: 20 20 20 20 20 20 20 20 20 20 63 61 6c 6c 62 61            callba
1c40: 63 6b 20 73 68 6f 75 6c 64 20 72 65 74 75 72 6e  ck should return
1c50: 20 61 20 73 74 72 69 6e 67 20 77 68 69 63 68 20   a string which 
1c60: 72 65 70 72 65 73 65 6e 74 73 20 74 68 65 20 70  represents the p
1c70: 61 73 73 77 6f 72 64 0a 20 20 20 20 20 20 20 20  assword.        
1c80: 20 20 20 20 74 6f 20 62 65 20 75 73 65 64 2e 20      to be used. 
1c90: 53 65 65 20 3c 61 20 68 72 65 66 3d 22 23 43 41  See <a href="#CA
1ca0: 4c 4c 42 41 43 4b 20 4f 50 54 49 4f 4e 53 22 3e  LLBACK OPTIONS">
1cb0: 43 41 4c 4c 42 41 43 4b 20 4f 50 54 49 4f 4e 53  CALLBACK OPTIONS
1cc0: 3c 2f 61 3e 0a 09 20 20 20 20 66 6f 72 20 66 75  </a>..    for fu
1cd0: 72 74 68 65 72 20 64 69 73 63 75 73 73 69 6f 6e  rther discussion
1ce0: 2e 3c 2f 64 64 3e 0a 20 20 20 20 20 20 20 20 3c  .</dd>.        <
1cf0: 64 74 3e 3c 73 74 72 6f 6e 67 3e 2d 72 65 71 75  dt><strong>-requ
1d00: 65 73 74 20 3c 2f 73 74 72 6f 6e 67 3e 3c 65 6d  est </strong><em
1d10: 3e 62 6f 6f 6c 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a  >bool</em></dt>.
1d20: 20 20 20 20 20 20 20 20 3c 64 64 3e 52 65 71 75          <dd>Requ
1d30: 65 73 74 20 61 20 63 65 72 74 69 66 69 63 61 74  est a certificat
1d40: 65 20 66 72 6f 6d 20 70 65 65 72 20 64 75 72 69  e from peer duri
1d50: 6e 67 20 53 53 4c 20 68 61 6e 64 73 68 61 6b 65  ng SSL handshake
1d60: 2e 0a 20 20 20 20 20 20 20 20 20 20 20 20 28 64  ..            (d
1d70: 65 66 61 75 6c 74 20 69 73 20 3c 65 6d 3e 74 72  efault is <em>tr
1d80: 75 65 3c 2f 65 6d 3e 29 3c 2f 64 64 3e 0a 20 20  ue</em>)</dd>.  
1d90: 20 20 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e        <dt><stron
1da0: 67 3e 2d 72 65 71 75 69 72 65 3c 2f 73 74 72 6f  g>-require</stro
1db0: 6e 67 3e 20 3c 65 6d 3e 62 6f 6f 6c 3c 2f 65 6d  ng> <em>bool</em
1dc0: 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c  ></dt>.        <
1dd0: 64 64 3e 52 65 71 75 69 72 65 20 61 20 76 61 6c  dd>Require a val
1de0: 69 64 20 63 65 72 74 69 66 69 63 61 74 65 20 66  id certificate f
1df0: 72 6f 6d 20 70 65 65 72 20 64 75 72 69 6e 67 20  rom peer during 
1e00: 53 53 4c 20 68 61 6e 64 73 68 61 6b 65 2e 0a 09  SSL handshake...
1e10: 20 20 20 20 49 66 20 74 68 69 73 20 69 73 20 73      If this is s
1e20: 65 74 20 74 6f 20 74 72 75 65 2c 20 74 68 65 6e  et to true, then
1e30: 20 3c 73 74 72 6f 6e 67 3e 2d 72 65 71 75 65 73   <strong>-reques
1e40: 74 3c 2f 73 74 72 6f 6e 67 3e 20 6d 75 73 74 0a  t</strong> must.
1e50: 20 20 20 20 20 20 20 20 20 20 20 20 61 6c 73 6f              also
1e60: 20 62 65 20 73 65 74 20 74 6f 20 74 72 75 65 2e   be set to true.
1e70: 20 28 64 65 66 61 75 6c 74 20 69 73 20 3c 65 6d   (default is <em
1e80: 3e 66 61 6c 73 65 3c 2f 65 6d 3e 29 3c 2f 64 64  >false</em>)</dd
1e90: 3e 0a 20 20 20 20 20 20 20 20 3c 64 74 3e 3c 73  >.        <dt><s
1ea0: 74 72 6f 6e 67 3e 2d 73 65 72 76 65 72 3c 2f 73  trong>-server</s
1eb0: 74 72 6f 6e 67 3e 20 3c 65 6d 3e 62 6f 6f 6c 3c  trong> <em>bool<
1ec0: 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20  /em></dt>.      
1ed0: 20 20 3c 64 64 3e 48 61 6e 64 73 68 61 6b 65 20    <dd>Handshake 
1ee0: 61 73 20 73 65 72 76 65 72 20 69 66 20 74 72 75  as server if tru
1ef0: 65 2c 20 65 6c 73 65 20 68 61 6e 64 73 68 61 6b  e, else handshak
1f00: 65 20 61 73 0a 20 20 20 20 20 20 20 20 20 20 20  e as.           
1f10: 20 63 6c 69 65 6e 74 2e 20 28 64 65 66 61 75 6c   client. (defaul
1f20: 74 20 69 73 20 3c 65 6d 3e 66 61 6c 73 65 3c 2f  t is <em>false</
1f30: 65 6d 3e 29 3c 2f 64 64 3e 0a 20 20 20 20 20 20  em>)</dd>.      
1f40: 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e 2d 73    <dt><strong>-s
1f50: 65 72 76 65 72 6e 61 6d 65 3c 2f 73 74 72 6f 6e  ervername</stron
1f60: 67 3e 20 3c 65 6d 3e 68 6f 73 74 3c 2f 65 6d 3e  g> <em>host</em>
1f70: 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c 64  </dt>.        <d
1f80: 64 3e 53 70 65 63 69 66 79 20 73 65 72 76 65 72  d>Specify server
1f90: 20 68 6f 73 74 6e 61 6d 65 2e 20 4f 6e 6c 79 20   hostname. Only 
1fa0: 61 76 61 69 6c 61 62 6c 65 20 69 66 20 74 68 65  available if the
1fb0: 20 4f 70 65 6e 53 53 4c 20 6c 69 62 72 61 72 79   OpenSSL library
1fc0: 0a 09 20 20 20 20 74 68 65 20 70 61 63 6b 61 67  ..    the packag
1fd0: 65 20 69 73 20 6c 69 6e 6b 65 64 20 61 67 61 69  e is linked agai
1fe0: 6e 73 74 20 73 75 70 70 6f 72 74 73 20 74 68 65  nst supports the
1ff0: 20 54 4c 53 20 68 6f 73 74 6e 61 6d 65 20 65 78   TLS hostname ex
2000: 74 65 6e 73 69 6f 6e 0a 09 20 20 20 20 66 6f 72  tension..    for
2010: 20 27 53 65 72 76 65 72 20 4e 61 6d 65 20 49 6e   'Server Name In
2020: 64 69 63 61 74 69 6f 6e 27 20 28 53 4e 49 29 2e  dication' (SNI).
2030: 20 55 73 65 20 74 6f 20 6e 61 6d 65 20 74 68 65   Use to name the
2040: 20 6c 6f 67 69 63 61 6c 20 68 6f 73 74 0a 09 20   logical host.. 
2050: 20 20 20 77 65 20 61 72 65 20 74 61 6c 6b 69 6e     we are talkin
2060: 67 20 74 6f 20 61 6e 64 20 65 78 70 65 63 74 69  g to and expecti
2070: 6e 67 20 61 20 63 65 72 74 69 66 69 63 61 74 65  ng a certificate
2080: 20 66 6f 72 2e 3c 2f 64 64 3e 0a 20 20 20 20 20   for.</dd>.     
2090: 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e 2d     <dt><strong>-
20a0: 73 73 6c 32 3c 2f 73 74 72 6f 6e 67 3e 20 3c 65  ssl2</strong> <e
20b0: 6d 3e 62 6f 6f 6c 3c 2f 65 6d 3e 3c 2f 64 74 3e  m>bool</em></dt>
20c0: 0a 20 20 20 20 20 20 20 20 3c 64 64 3e 45 6e 61  .        <dd>Ena
20d0: 62 6c 65 20 75 73 65 20 6f 66 20 53 53 4c 20 76  ble use of SSL v
20e0: 32 2e 20 28 64 65 66 61 75 6c 74 20 69 73 20 3c  2. (default is <
20f0: 65 6d 3e 66 61 6c 73 65 3c 2f 65 6d 3e 29 3c 2f  em>false</em>)</
2100: 64 64 3e 0a 20 20 20 20 20 20 20 20 3c 64 74 3e  dd>.        <dt>
2110: 3c 73 74 72 6f 6e 67 3e 2d 73 73 6c 33 20 3c 2f  <strong>-ssl3 </
2120: 73 74 72 6f 6e 67 3e 3c 65 6d 3e 62 6f 6f 6c 3c  strong><em>bool<
2130: 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20  /em></dt>.      
2140: 20 20 3c 64 64 3e 45 6e 61 62 6c 65 20 75 73 65    <dd>Enable use
2150: 20 6f 66 20 53 53 4c 20 76 33 2e 20 28 64 65 66   of SSL v3. (def
2160: 61 75 6c 74 20 69 73 20 3c 65 6d 3e 66 61 6c 73  ault is <em>fals
2170: 65 3c 2f 65 6d 3e 29 3c 2f 64 64 3e 0a 20 20 20  e</em>)</dd>.   
2180: 20 20 20 20 20 3c 64 74 3e 2d 3c 73 74 72 6f 6e       <dt>-<stron
2190: 67 3e 74 6c 73 31 3c 2f 73 74 72 6f 6e 67 3e 20  g>tls1</strong> 
21a0: 3c 65 6d 3e 62 6f 6f 6c 3c 2f 65 6d 3e 3c 2f 64  <em>bool</em></d
21b0: 74 3e 0a 20 20 20 20 20 20 20 20 3c 64 64 3e 45  t>.        <dd>E
21c0: 6e 61 62 6c 65 20 75 73 65 20 6f 66 20 54 4c 53  nable use of TLS
21d0: 20 76 31 2e 20 28 64 65 66 61 75 6c 74 20 69 73   v1. (default is
21e0: 20 3c 65 6d 3e 74 72 75 65 3c 2f 65 6d 3e 29 3c   <em>true</em>)<
21f0: 2f 64 64 3e 0a 20 20 20 20 20 20 20 20 3c 64 74  /dd>.        <dt
2200: 3e 2d 3c 73 74 72 6f 6e 67 3e 74 6c 73 31 2e 31  >-<strong>tls1.1
2210: 3c 2f 73 74 72 6f 6e 67 3e 20 3c 65 6d 3e 62 6f  </strong> <em>bo
2220: 6f 6c 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20  ol</em></dt>.   
2230: 20 20 20 20 20 3c 64 64 3e 45 6e 61 62 6c 65 20       <dd>Enable 
2240: 75 73 65 20 6f 66 20 54 4c 53 20 76 31 2e 31 20  use of TLS v1.1 
2250: 28 64 65 66 61 75 6c 74 20 69 73 20 3c 65 6d 3e  (default is <em>
2260: 74 72 75 65 3c 2f 65 6d 3e 29 3c 2f 64 64 3e 0a  true</em>)</dd>.
2270: 20 20 20 20 20 20 20 20 3c 64 74 3e 2d 3c 73 74          <dt>-<st
2280: 72 6f 6e 67 3e 74 6c 73 31 2e 32 3c 2f 73 74 72  rong>tls1.2</str
2290: 6f 6e 67 3e 20 3c 65 6d 3e 62 6f 6f 6c 3c 2f 65  ong> <em>bool</e
22a0: 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20  m></dt>.        
22b0: 3c 64 64 3e 45 6e 61 62 6c 65 20 75 73 65 20 6f  <dd>Enable use o
22c0: 66 20 54 4c 53 20 76 31 2e 32 20 28 64 65 66 61  f TLS v1.2 (defa
22d0: 75 6c 74 20 69 73 20 3c 65 6d 3e 74 72 75 65 3c  ult is <em>true<
22e0: 2f 65 6d 3e 29 3c 2f 64 64 3e 0a 20 20 20 20 20  /em>)</dd>.     
22f0: 20 20 20 3c 64 74 3e 2d 3c 73 74 72 6f 6e 67 3e     <dt>-<strong>
2300: 74 6c 73 31 2e 33 3c 2f 73 74 72 6f 6e 67 3e 20  tls1.3</strong> 
2310: 3c 65 6d 3e 62 6f 6f 6c 3c 2f 65 6d 3e 3c 2f 64  <em>bool</em></d
2320: 74 3e 0a 20 20 20 20 20 20 20 20 3c 64 64 3e 45  t>.        <dd>E
2330: 6e 61 62 6c 65 20 75 73 65 20 6f 66 20 54 4c 53  nable use of TLS
2340: 20 76 31 2e 33 20 28 64 65 66 61 75 6c 74 20 69   v1.3 (default i
2350: 73 20 3c 65 6d 3e 74 72 75 65 3c 2f 65 6d 3e 29  s <em>true</em>)
2360: 3c 2f 64 64 3e 0a 20 20 20 20 3c 2f 64 6c 3e 0a  </dd>.    </dl>.
2370: 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 20  </blockquote>.. 
2380: 20 20 20 3c 64 74 3e 3c 61 20 6e 61 6d 65 3d 22     <dt><a name="
2390: 74 6c 73 3a 3a 75 6e 69 6d 70 6f 72 74 22 3e 3c  tls::unimport"><
23a0: 62 3e 74 6c 73 3a 3a 75 6e 69 6d 70 6f 72 74 20  b>tls::unimport 
23b0: 3c 2f 62 3e 3c 69 3e 63 68 61 6e 6e 65 6c 3c 2f  </b><i>channel</
23c0: 69 3e 3c 2f 61 3e 3c 2f 64 74 3e 0a 20 20 20 20  i></a></dt>.    
23d0: 3c 64 64 3e 50 72 6f 76 69 64 65 64 20 66 6f 72  <dd>Provided for
23e0: 20 73 79 6d 6d 65 74 72 79 20 74 6f 20 3c 73 74   symmetry to <st
23f0: 72 6f 6e 67 3e 74 6c 73 3a 3a 69 6d 70 6f 72 74  rong>tls::import
2400: 3c 2f 73 74 72 6f 6e 67 3e 2c 20 74 68 69 73 0a  </strong>, this.
2410: 20 20 20 20 20 20 75 6e 73 74 61 63 6b 73 20 74        unstacks t
2420: 68 65 20 53 53 4c 2d 65 6e 61 62 6c 69 6e 67 20  he SSL-enabling 
2430: 6f 66 20 61 20 72 65 67 75 6c 61 72 20 54 63 6c  of a regular Tcl
2440: 20 63 68 61 6e 6e 65 6c 2e 20 20 41 6e 20 65 72   channel.  An er
2450: 72 6f 72 0a 20 20 20 20 20 20 69 73 20 74 68 72  ror.      is thr
2460: 6f 77 6e 20 69 66 20 54 4c 53 20 69 73 20 6e 6f  own if TLS is no
2470: 74 20 74 68 65 20 74 6f 70 20 73 74 61 63 6b 65  t the top stacke
2480: 64 20 63 68 61 6e 6e 65 6c 20 74 79 70 65 2e 3c  d channel type.<
2490: 2f 64 64 3e 0a 20 20 20 20 3c 64 74 3e 26 6e 62  /dd>.    <dt>&nb
24a0: 73 70 3b 3c 2f 64 74 3e 0a 20 20 20 20 3c 64 74  sp;</dt>.    <dt
24b0: 3e 3c 61 20 6e 61 6d 65 3d 22 74 6c 73 3a 3a 68  ><a name="tls::h
24c0: 61 6e 64 73 68 61 6b 65 22 3e 3c 73 74 72 6f 6e  andshake"><stron
24d0: 67 3e 74 6c 73 3a 3a 68 61 6e 64 73 68 61 6b 65  g>tls::handshake
24e0: 3c 2f 73 74 72 6f 6e 67 3e 20 3c 65 6d 3e 63 68  </strong> <em>ch
24f0: 61 6e 6e 65 6c 3c 2f 65 6d 3e 3c 2f 61 3e 3c 2f  annel</em></a></
2500: 64 74 3e 0a 20 20 20 20 3c 64 64 3e 46 6f 72 63  dt>.    <dd>Forc
2510: 65 73 20 68 61 6e 64 73 68 61 6b 65 20 74 6f 20  es handshake to 
2520: 74 61 6b 65 20 70 6c 61 63 65 2c 20 61 6e 64 20  take place, and 
2530: 72 65 74 75 72 6e 73 20 30 20 69 66 0a 20 20 20  returns 0 if.   
2540: 20 20 20 20 20 68 61 6e 64 73 68 61 6b 65 20 69       handshake i
2550: 73 20 73 74 69 6c 6c 20 69 6e 20 70 72 6f 67 72  s still in progr
2560: 65 73 73 20 28 6e 6f 6e 2d 62 6c 6f 63 6b 69 6e  ess (non-blockin
2570: 67 29 2c 20 6f 72 20 31 20 69 66 0a 20 20 20 20  g), or 1 if.    
2580: 20 20 20 20 74 68 65 20 68 61 6e 64 73 68 61 6b      the handshak
2590: 65 20 77 61 73 20 73 75 63 63 65 73 73 66 75 6c  e was successful
25a0: 2e 20 49 66 20 74 68 65 20 68 61 6e 64 73 68 61  . If the handsha
25b0: 6b 65 20 66 61 69 6c 65 64 0a 20 20 20 20 20 20  ke failed.      
25c0: 20 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 77    this routine w
25d0: 69 6c 6c 20 74 68 72 6f 77 20 61 6e 20 65 72 72  ill throw an err
25e0: 6f 72 2e 3c 2f 64 64 3e 0a 20 20 20 20 3c 64 74  or.</dd>.    <dt
25f0: 3e 26 6e 62 73 70 3b 3c 2f 64 74 3e 0a 20 20 20  >&nbsp;</dt>.   
2600: 20 3c 64 74 3e 3c 61 20 6e 61 6d 65 3d 22 74 6c   <dt><a name="tl
2610: 73 3a 3a 73 74 61 74 75 73 22 3e 3c 73 74 72 6f  s::status"><stro
2620: 6e 67 3e 74 6c 73 3a 3a 73 74 61 74 75 73 3c 2f  ng>tls::status</
2630: 73 74 72 6f 6e 67 3e 0a 20 20 20 20 3c 65 6d 3e  strong>.    <em>
2640: 3f 2d 6c 6f 63 61 6c 3f 20 63 68 61 6e 6e 65 6c  ?-local? channel
2650: 3c 2f 65 6d 3e 3c 2f 61 3e 3c 2f 64 74 3e 0a 20  </em></a></dt>. 
2660: 20 20 20 3c 64 64 3e 52 65 74 75 72 6e 73 20 74     <dd>Returns t
2670: 68 65 20 63 75 72 72 65 6e 74 20 63 65 72 74 69  he current certi
2680: 66 69 63 61 74 65 20 73 74 61 74 75 73 20 6f 66  ficate status of
2690: 20 61 6e 20 53 53 4c 20 63 68 61 6e 6e 65 6c 2e   an SSL channel.
26a0: 20 54 68 65 0a 20 20 20 20 20 20 20 20 72 65 73   The.        res
26b0: 75 6c 74 20 69 73 20 61 20 6c 69 73 74 20 6f 66  ult is a list of
26c0: 20 6b 65 79 2d 76 61 6c 75 65 20 70 61 69 72 73   key-value pairs
26d0: 20 64 65 73 63 72 69 62 69 6e 67 20 74 68 65 0a   describing the.
26e0: 20 20 20 20 20 20 20 20 63 6f 6e 6e 65 63 74 65          connecte
26f0: 64 20 70 65 65 72 2e 20 49 66 20 74 68 65 20 72  d peer. If the r
2700: 65 73 75 6c 74 20 69 73 20 61 6e 20 65 6d 70 74  esult is an empt
2710: 79 20 6c 69 73 74 20 74 68 65 6e 20 74 68 65 0a  y list then the.
2720: 20 20 20 20 20 20 20 20 53 53 4c 20 68 61 6e 64          SSL hand
2730: 73 68 61 6b 65 20 68 61 73 20 6e 6f 74 20 79 65  shake has not ye
2740: 74 20 63 6f 6d 70 6c 65 74 65 64 2e 0a 20 20 20  t completed..   
2750: 20 20 20 20 20 49 66 20 3c 65 6d 3e 2d 6c 6f 63       If <em>-loc
2760: 61 6c 3c 2f 65 6d 3e 20 69 73 20 67 69 76 65 6e  al</em> is given
2770: 2c 20 74 68 65 6e 20 74 68 65 20 63 65 72 74 69  , then the certi
2780: 66 69 63 61 74 65 20 69 6e 66 6f 72 6d 61 74 69  ficate informati
2790: 6f 6e 0a 20 20 20 20 20 20 20 20 69 73 20 74 68  on.        is th
27a0: 65 20 6f 6e 65 20 75 73 65 64 20 6c 6f 63 61 6c  e one used local
27b0: 6c 79 2e 3c 2f 64 64 3e 0a 0a 3c 62 6c 6f 63 6b  ly.</dd>..<block
27c0: 71 75 6f 74 65 3e 0a 20 20 20 20 3c 64 6c 3e 0a  quote>.    <dl>.
27d0: 20 20 20 20 20 20 20 20 3c 64 74 3e 3c 73 74 72          <dt><str
27e0: 6f 6e 67 3e 69 73 73 75 65 72 3c 2f 73 74 72 6f  ong>issuer</stro
27f0: 6e 67 3e 20 3c 65 6d 3e 64 6e 3c 2f 65 6d 3e 3c  ng> <em>dn</em><
2800: 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c 64 64  /dt>.        <dd
2810: 3e 54 68 65 20 64 69 73 74 69 6e 67 75 69 73 68  >The distinguish
2820: 65 64 20 6e 61 6d 65 20 28 44 4e 29 20 6f 66 20  ed name (DN) of 
2830: 74 68 65 20 63 65 72 74 69 66 69 63 61 74 65 0a  the certificate.
2840: 20 20 20 20 20 20 20 20 20 20 20 20 69 73 73 75              issu
2850: 65 72 2e 3c 2f 64 64 3e 0a 20 20 20 20 20 20 20  er.</dd>.       
2860: 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e 73 75 62   <dt><strong>sub
2870: 6a 65 63 74 3c 2f 73 74 72 6f 6e 67 3e 20 3c 65  ject</strong> <e
2880: 6d 3e 64 6e 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20  m>dn</em></dt>. 
2890: 20 20 20 20 20 20 20 3c 64 64 3e 54 68 65 20 64         <dd>The d
28a0: 69 73 74 69 6e 67 75 69 73 68 65 64 20 6e 61 6d  istinguished nam
28b0: 65 20 28 44 4e 29 20 6f 66 20 74 68 65 20 63 65  e (DN) of the ce
28c0: 72 74 69 66 69 63 61 74 65 0a 20 20 20 20 20 20  rtificate.      
28d0: 20 20 20 20 20 20 73 75 62 6a 65 63 74 2e 3c 2f        subject.</
28e0: 64 64 3e 0a 20 20 20 20 20 20 20 20 3c 64 74 3e  dd>.        <dt>
28f0: 3c 73 74 72 6f 6e 67 3e 6e 6f 74 42 65 66 6f 72  <strong>notBefor
2900: 65 3c 2f 73 74 72 6f 6e 67 3e 20 3c 65 6d 3e 64  e</strong> <em>d
2910: 61 74 65 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20  ate</em></dt>.  
2920: 20 20 20 20 20 20 3c 64 64 3e 54 68 65 20 62 65        <dd>The be
2930: 67 69 6e 20 64 61 74 65 20 66 6f 72 20 74 68 65  gin date for the
2940: 20 76 61 6c 69 64 69 74 79 20 6f 66 20 74 68 65   validity of the
2950: 20 63 65 72 74 69 66 69 63 61 74 65 2e 3c 2f 64   certificate.</d
2960: 64 3e 0a 20 20 20 20 20 20 20 20 3c 64 74 3e 3c  d>.        <dt><
2970: 73 74 72 6f 6e 67 3e 6e 6f 74 41 66 74 65 72 3c  strong>notAfter<
2980: 2f 73 74 72 6f 6e 67 3e 20 3c 65 6d 3e 64 61 74  /strong> <em>dat
2990: 65 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20  e</em></dt>.    
29a0: 20 20 20 20 3c 64 64 3e 54 68 65 20 65 78 70 69      <dd>The expi
29b0: 72 79 20 64 61 74 65 20 66 6f 72 20 74 68 65 20  ry date for the 
29c0: 63 65 72 74 69 66 69 63 61 74 65 2e 3c 2f 64 64  certificate.</dd
29d0: 3e 0a 20 20 20 20 20 20 20 20 3c 64 74 3e 3c 73  >.        <dt><s
29e0: 74 72 6f 6e 67 3e 73 65 72 69 61 6c 3c 2f 73 74  trong>serial</st
29f0: 72 6f 6e 67 3e 20 3c 65 6d 3e 6e 3c 2f 65 6d 3e  rong> <em>n</em>
2a00: 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c 64  </dt>.        <d
2a10: 64 3e 54 68 65 20 73 65 72 69 61 6c 20 6e 75 6d  d>The serial num
2a20: 62 65 72 20 6f 66 20 74 68 65 20 63 65 72 74 69  ber of the certi
2a30: 66 69 63 61 74 65 2e 3c 2f 64 64 3e 0a 20 20 20  ficate.</dd>.   
2a40: 20 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67       <dt><strong
2a50: 3e 63 69 70 68 65 72 3c 2f 73 74 72 6f 6e 67 3e  >cipher</strong>
2a60: 20 3c 65 6d 3e 63 69 70 68 65 72 3c 2f 65 6d 3e   <em>cipher</em>
2a70: 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c 64  </dt>.        <d
2a80: 64 3e 54 68 65 20 63 75 72 72 65 6e 74 20 63 69  d>The current ci
2a90: 70 68 65 72 20 69 6e 20 75 73 65 20 62 65 74 77  pher in use betw
2aa0: 65 65 6e 20 74 68 65 20 63 6c 69 65 6e 74 20 61  een the client a
2ab0: 6e 64 0a 20 20 20 20 20 20 20 20 20 20 20 20 73  nd.            s
2ac0: 65 72 76 65 72 20 63 68 61 6e 6e 65 6c 73 2e 3c  erver channels.<
2ad0: 2f 64 64 3e 0a 20 20 20 20 20 20 20 20 3c 64 74  /dd>.        <dt
2ae0: 3e 3c 73 74 72 6f 6e 67 3e 73 62 69 74 73 3c 2f  ><strong>sbits</
2af0: 73 74 72 6f 6e 67 3e 20 3c 65 6d 3e 6e 3c 2f 65  strong> <em>n</e
2b00: 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20  m></dt>.        
2b10: 3c 64 64 3e 54 68 65 20 6e 75 6d 62 65 72 20 6f  <dd>The number o
2b20: 66 20 62 69 74 73 20 75 73 65 64 20 66 6f 72 20  f bits used for 
2b30: 74 68 65 20 73 65 73 73 69 6f 6e 20 6b 65 79 2e  the session key.
2b40: 3c 2f 64 64 3e 0a 20 20 20 20 20 20 20 20 3c 64  </dd>.        <d
2b50: 74 3e 3c 73 74 72 6f 6e 67 3e 63 65 72 74 69 66  t><strong>certif
2b60: 69 63 61 74 65 3c 2f 73 74 72 6f 6e 67 3e 20 3c  icate</strong> <
2b70: 65 6d 3e 63 65 72 74 3c 2f 65 6d 3e 3c 2f 64 74  em>cert</em></dt
2b80: 3e 0a 20 20 20 20 20 20 20 20 3c 64 64 3e 54 68  >.        <dd>Th
2b90: 65 20 50 45 4d 20 65 6e 63 6f 64 65 64 20 63 65  e PEM encoded ce
2ba0: 72 74 69 66 69 63 61 74 65 2e 3c 2f 64 64 3e 0a  rtificate.</dd>.
2bb0: 20 20 20 20 20 20 20 20 3c 64 74 3e 3c 73 74 72          <dt><str
2bc0: 6f 6e 67 3e 73 68 61 31 5f 68 61 73 68 3c 2f 73  ong>sha1_hash</s
2bd0: 74 72 6f 6e 67 3e 20 3c 65 6d 3e 68 61 73 68 3c  trong> <em>hash<
2be0: 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20  /em></dt>.      
2bf0: 20 20 3c 64 64 3e 54 68 65 20 53 48 41 31 20 68    <dd>The SHA1 h
2c00: 61 73 68 20 6f 66 20 74 68 65 20 63 65 72 74 69  ash of the certi
2c10: 66 69 63 61 74 65 2e 3c 2f 64 64 3e 0a 20 20 20  ficate.</dd>.   
2c20: 20 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67       <dt><strong
2c30: 3e 73 68 61 32 35 36 5f 68 61 73 68 3c 2f 73 74  >sha256_hash</st
2c40: 72 6f 6e 67 3e 20 3c 65 6d 3e 68 61 73 68 3c 2f  rong> <em>hash</
2c50: 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20  em></dt>.       
2c60: 20 3c 64 64 3e 54 68 65 20 53 48 41 32 35 36 20   <dd>The SHA256 
2c70: 68 61 73 68 20 6f 66 20 74 68 65 20 63 65 72 74  hash of the cert
2c80: 69 66 69 63 61 74 65 2e 3c 2f 64 64 3e 0a 20 20  ificate.</dd>.  
2c90: 20 20 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e        <dt><stron
2ca0: 67 3e 61 6c 70 6e 3c 2f 73 74 72 6f 6e 67 3e 20  g>alpn</strong> 
2cb0: 3c 65 6d 3e 70 72 6f 74 6f 63 6f 6c 3c 2f 65 6d  <em>protocol</em
2cc0: 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c  ></dt>.        <
2cd0: 64 64 3e 54 68 65 20 70 72 6f 74 6f 63 6f 6c 20  dd>The protocol 
2ce0: 73 65 6c 65 63 74 65 64 20 61 66 74 65 72 20 41  selected after A
2cf0: 70 70 6c 69 63 61 74 69 6f 6e 2d 4c 61 79 65 72  pplication-Layer
2d00: 20 50 72 6f 74 6f 63 6f 6c 0a 09 20 20 20 20 4e   Protocol..    N
2d10: 65 67 6f 74 69 61 74 69 6f 6e 20 28 41 4c 50 4e  egotiation (ALPN
2d20: 29 2e 3c 2f 64 64 3e 0a 20 20 20 20 20 20 20 20  ).</dd>.        
2d30: 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e 76 65 72 73  <dt><strong>vers
2d40: 69 6f 6e 3c 2f 73 74 72 6f 6e 67 3e 20 3c 65 6d  ion</strong> <em
2d50: 3e 76 61 6c 75 65 3c 2f 65 6d 3e 3c 2f 64 74 3e  >value</em></dt>
2d60: 0a 20 20 20 20 20 20 20 20 3c 64 64 3e 54 68 65  .        <dd>The
2d70: 20 70 72 6f 74 6f 63 6f 6c 20 76 65 72 73 69 6f   protocol versio
2d80: 6e 20 75 73 65 64 20 66 6f 72 20 74 68 65 20 63  n used for the c
2d90: 6f 6e 6e 65 63 74 69 6f 6e 3a 0a 09 20 20 53 53  onnection:..  SS
2da0: 4c 76 32 2c 20 53 53 4c 76 33 2c 20 54 4c 53 76  Lv2, SSLv3, TLSv
2db0: 31 2c 20 54 4c 53 76 31 2e 31 2c 20 54 4c 53 76  1, TLSv1.1, TLSv
2dc0: 31 2e 32 2c 20 54 4c 53 76 31 2e 33 2c 20 6f 72  1.2, TLSv1.3, or
2dd0: 20 75 6e 6b 6e 6f 77 6e 3c 2f 64 64 3e 0a 20 20   unknown</dd>.  
2de0: 20 20 3c 2f 64 6c 3e 0a 3c 2f 62 6c 6f 63 6b 71    </dl>.</blockq
2df0: 75 6f 74 65 3e 0a 0a 20 20 20 20 3c 64 74 3e 3c  uote>..    <dt><
2e00: 61 20 6e 61 6d 65 3d 22 74 6c 73 3a 3a 63 6f 6e  a name="tls::con
2e10: 6e 65 63 74 69 6f 6e 22 3e 3c 73 74 72 6f 6e 67  nection"><strong
2e20: 3e 74 6c 73 3a 3a 63 6f 6e 6e 65 63 74 69 6f 6e  >tls::connection
2e30: 3c 2f 73 74 72 6f 6e 67 3e 0a 20 20 20 20 3c 65  </strong>.    <e
2e40: 6d 3e 63 68 61 6e 6e 65 6c 3c 2f 65 6d 3e 3c 2f  m>channel</em></
2e50: 61 3e 3c 2f 64 74 3e 0a 20 20 20 20 3c 64 64 3e  a></dt>.    <dd>
2e60: 52 65 74 75 72 6e 73 20 74 68 65 20 63 75 72 72  Returns the curr
2e70: 65 6e 74 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 73  ent connection s
2e80: 74 61 74 75 73 20 6f 66 20 61 6e 20 53 53 4c 20  tatus of an SSL 
2e90: 63 68 61 6e 6e 65 6c 2e 20 54 68 65 0a 20 20 20  channel. The.   
2ea0: 20 20 20 20 20 72 65 73 75 6c 74 20 69 73 20 61       result is a
2eb0: 20 6c 69 73 74 20 6f 66 20 6b 65 79 2d 76 61 6c   list of key-val
2ec0: 75 65 20 70 61 69 72 73 20 64 65 73 63 72 69 62  ue pairs describ
2ed0: 69 6e 67 20 74 68 65 0a 20 20 20 20 20 20 20 20  ing the.        
2ee0: 63 6f 6e 6e 65 63 74 65 64 20 70 65 65 72 2e 3c  connected peer.<
2ef0: 2f 64 64 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74  /dd>..<blockquot
2f00: 65 3e 0a 20 20 20 20 3c 64 6c 3e 0a 20 20 20 20  e>.    <dl>.    
2f10: 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e      <dt><strong>
2f20: 73 74 61 74 65 3c 2f 73 74 72 6f 6e 67 3e 20 3c  state</strong> <
2f30: 65 6d 3e 73 74 61 74 65 3c 2f 65 6d 3e 3c 2f 64  em>state</em></d
2f40: 74 3e 0a 20 20 20 20 20 20 20 20 3c 64 64 3e 53  t>.        <dd>S
2f50: 74 61 74 65 20 6f 66 20 74 68 65 20 63 6f 6e 6e  tate of the conn
2f60: 65 63 74 69 6f 6e 3a 20 69 6e 69 74 69 61 6c 69  ection: initiali
2f70: 7a 69 6e 67 2c 20 68 61 6e 64 73 68 61 6b 65 2c  zing, handshake,
2f80: 20 65 73 74 61 62 6c 69 73 68 65 64 3c 2f 64 64   established</dd
2f90: 3e 0a 20 20 20 20 20 20 20 20 3c 64 74 3e 3c 73  >.        <dt><s
2fa0: 74 72 6f 6e 67 3e 73 65 72 76 65 72 3c 2f 73 74  trong>server</st
2fb0: 72 6f 6e 67 3e 20 3c 65 6d 3e 6e 61 6d 65 3c 2f  rong> <em>name</
2fc0: 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20  em></dt>.       
2fd0: 20 3c 64 64 3e 54 68 65 20 6e 61 6d 65 20 6f 66   <dd>The name of
2fe0: 20 74 68 65 20 63 6f 6e 6e 65 63 74 65 64 20 74   the connected t
2ff0: 6f 20 73 65 72 76 65 72 2e 3c 2f 64 64 3e 0a 20  o server.</dd>. 
3000: 20 20 20 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f         <dt><stro
3010: 6e 67 3e 70 72 6f 74 6f 63 6f 6c 3c 2f 73 74 72  ng>protocol</str
3020: 6f 6e 67 3e 20 3c 65 6d 3e 76 65 72 73 69 6f 6e  ong> <em>version
3030: 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20  </em></dt>.     
3040: 20 20 20 3c 64 64 3e 54 68 65 20 70 72 6f 74 6f     <dd>The proto
3050: 63 6f 6c 20 76 65 72 73 69 6f 6e 20 75 73 65 64  col version used
3060: 20 66 6f 72 20 74 68 65 20 63 6f 6e 6e 65 63 74   for the connect
3070: 69 6f 6e 3a 0a 09 20 20 20 20 53 53 4c 32 2c 20  ion:..    SSL2, 
3080: 53 53 4c 33 2c 20 54 4c 53 31 2c 20 54 4c 53 31  SSL3, TLS1, TLS1
3090: 2e 31 2c 20 54 4c 53 31 2e 32 2c 20 54 4c 53 31  .1, TLS1.2, TLS1
30a0: 2e 33 2c 20 6f 72 20 75 6e 6b 6e 6f 77 6e 3c 2f  .3, or unknown</
30b0: 64 64 3e 0a 20 20 20 20 20 20 20 20 3c 64 74 3e  dd>.        <dt>
30c0: 3c 73 74 72 6f 6e 67 3e 63 69 70 68 65 72 3c 2f  <strong>cipher</
30d0: 73 74 72 6f 6e 67 3e 20 3c 65 6d 3e 63 69 70 68  strong> <em>ciph
30e0: 65 72 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20  er</em></dt>.   
30f0: 20 20 20 20 20 3c 64 64 3e 54 68 65 20 63 75 72       <dd>The cur
3100: 72 65 6e 74 20 63 69 70 68 65 72 20 69 6e 20 75  rent cipher in u
3110: 73 65 20 66 6f 72 20 74 68 65 20 63 6f 6e 6e 65  se for the conne
3120: 63 74 69 6f 6e 2e 3c 2f 64 64 3e 0a 20 20 20 20  ction.</dd>.    
3130: 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e      <dt><strong>
3140: 73 74 61 6e 64 61 72 64 5f 6e 61 6d 65 3c 2f 73  standard_name</s
3150: 74 72 6f 6e 67 3e 20 3c 65 6d 3e 6e 61 6d 65 3c  trong> <em>name<
3160: 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20  /em></dt>.      
3170: 20 20 3c 64 64 3e 54 68 65 20 73 74 61 6e 64 61    <dd>The standa
3180: 72 64 20 52 46 43 20 6e 61 6d 65 20 6f 66 20 63  rd RFC name of c
3190: 69 70 68 65 72 2e 3c 2f 64 64 3e 0a 20 20 20 20  ipher.</dd>.    
31a0: 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e      <dt><strong>
31b0: 62 69 74 73 3c 2f 73 74 72 6f 6e 67 3e 20 3c 65  bits</strong> <e
31c0: 6d 3e 6e 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20  m>n</em></dt>.  
31d0: 20 20 20 20 20 20 3c 64 64 3e 54 68 65 20 6e 75        <dd>The nu
31e0: 6d 62 65 72 20 6f 66 20 70 72 6f 63 65 73 73 65  mber of processe
31f0: 64 20 62 69 74 73 20 75 73 65 64 20 66 6f 72 20  d bits used for 
3200: 63 69 70 68 65 72 2e 3c 2f 64 64 3e 0a 20 20 20  cipher.</dd>.   
3210: 20 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67       <dt><strong
3220: 3e 73 65 63 72 65 74 5f 62 69 74 73 3c 2f 73 74  >secret_bits</st
3230: 72 6f 6e 67 3e 20 3c 65 6d 3e 6e 3c 2f 65 6d 3e  rong> <em>n</em>
3240: 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20 20 3c 64  </dt>.        <d
3250: 64 3e 54 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  d>The number of 
3260: 73 65 63 72 65 74 20 62 69 74 73 20 75 73 65 64  secret bits used
3270: 20 66 6f 72 20 63 69 70 68 65 72 2e 3c 2f 64 64   for cipher.</dd
3280: 3e 0a 20 20 20 20 20 20 20 20 3c 64 74 3e 3c 73  >.        <dt><s
3290: 74 72 6f 6e 67 3e 6d 69 6e 5f 76 65 72 73 69 6f  trong>min_versio
32a0: 6e 3c 2f 73 74 72 6f 6e 67 3e 20 3c 65 6d 3e 76  n</strong> <em>v
32b0: 65 72 73 69 6f 6e 3c 2f 65 6d 3e 3c 2f 64 74 3e  ersion</em></dt>
32c0: 0a 20 20 20 20 20 20 20 20 3c 64 64 3e 54 68 65  .        <dd>The
32d0: 20 6d 69 6e 69 6d 75 6d 20 70 72 6f 74 6f 63 6f   minimum protoco
32e0: 6c 20 76 65 72 73 69 6f 6e 20 66 6f 72 20 63 69  l version for ci
32f0: 70 68 65 72 2e 3c 2f 64 64 3e 0a 20 20 20 20 20  pher.</dd>.     
3300: 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e 64     <dt><strong>d
3310: 65 73 63 72 69 70 74 69 6f 6e 3c 2f 73 74 72 6f  escription</stro
3320: 6e 67 3e 20 3c 65 6d 3e 73 74 72 69 6e 67 3c 2f  ng> <em>string</
3330: 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20 20 20  em></dt>.       
3340: 20 3c 64 64 3e 41 20 74 65 78 74 20 64 65 73 63   <dd>A text desc
3350: 72 69 70 74 69 6f 6e 20 6f 66 20 74 68 65 20 63  ription of the c
3360: 69 70 68 65 72 2e 3c 2f 64 64 3e 0a 20 20 20 20  ipher.</dd>.    
3370: 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e      <dt><strong>
3380: 72 65 6e 65 67 6f 74 69 61 74 69 6f 6e 3c 2f 73  renegotiation</s
3390: 74 72 6f 6e 67 3e 20 3c 65 6d 3e 73 74 61 74 65  trong> <em>state
33a0: 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20 20 20 20  </em></dt>.     
33b0: 20 20 20 3c 64 64 3e 57 68 65 74 68 65 72 20 70     <dd>Whether p
33c0: 72 6f 74 6f 63 6f 6c 20 72 65 6e 65 67 6f 74 69  rotocol renegoti
33d0: 61 74 69 6f 6e 20 69 73 20 61 6c 6c 6f 77 65 64  ation is allowed
33e0: 20 6f 72 20 64 69 73 61 6c 6c 6f 77 65 64 2e 3c   or disallowed.<
33f0: 2f 64 64 3e 0a 20 20 20 20 20 20 20 20 3c 64 74  /dd>.        <dt
3400: 3e 3c 73 74 72 6f 6e 67 3e 61 6c 70 6e 3c 2f 73  ><strong>alpn</s
3410: 74 72 6f 6e 67 3e 20 3c 65 6d 3e 70 72 6f 74 6f  trong> <em>proto
3420: 63 6f 6c 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20 20  col</em></dt>.  
3430: 20 20 20 20 20 20 3c 64 64 3e 54 68 65 20 70 72        <dd>The pr
3440: 6f 74 6f 63 6f 6c 20 73 65 6c 65 63 74 65 64 20  otocol selected 
3450: 61 66 74 65 72 20 41 70 70 6c 69 63 61 74 69 6f  after Applicatio
3460: 6e 2d 4c 61 79 65 72 20 50 72 6f 74 6f 63 6f 6c  n-Layer Protocol
3470: 0a 09 20 20 20 20 4e 65 67 6f 74 69 61 74 69 6f  ..    Negotiatio
3480: 6e 20 28 41 4c 50 4e 29 2e 3c 2f 64 64 3e 0a 20  n (ALPN).</dd>. 
3490: 20 20 20 20 20 20 20 3c 64 74 3e 3c 73 74 72 6f         <dt><stro
34a0: 6e 67 3e 73 65 73 73 69 6f 6e 5f 72 65 75 73 65  ng>session_reuse
34b0: 64 3c 2f 73 74 72 6f 6e 67 3e 20 3c 65 6d 3e 62  d</strong> <em>b
34c0: 6f 6f 6c 65 61 6e 3c 2f 65 6d 3e 3c 2f 64 74 3e  oolean</em></dt>
34d0: 0a 20 20 20 20 20 20 20 20 3c 64 64 3e 57 68 65  .        <dd>Whe
34e0: 74 68 65 72 20 74 68 65 20 73 65 73 73 69 6f 6e  ther the session
34f0: 20 68 61 73 20 62 65 65 6e 20 72 65 75 73 65 64   has been reused
3500: 20 6f 72 20 6e 6f 74 2e 3c 2f 64 64 3e 0a 20 20   or not.</dd>.  
3510: 20 20 3c 2f 64 6c 3e 0a 3c 2f 62 6c 6f 63 6b 71    </dl>.</blockq
3520: 75 6f 74 65 3e 0a 0a 20 20 20 20 3c 64 74 3e 3c  uote>..    <dt><
3530: 61 20 6e 61 6d 65 3d 22 74 6c 73 3a 3a 63 69 70  a name="tls::cip
3540: 68 65 72 73 22 3e 3c 73 74 72 6f 6e 67 3e 74 6c  hers"><strong>tl
3550: 73 3a 3a 63 69 70 68 65 72 73 3c 2f 73 74 72 6f  s::ciphers</stro
3560: 6e 67 3e 20 0a 20 20 20 20 3c 65 6d 3e 70 72 6f  ng> .    <em>pro
3570: 74 6f 63 6f 6c 20 3f 76 65 72 62 6f 73 65 3f 3c  tocol ?verbose?<
3580: 2f 65 6d 3e 3c 2f 61 3e 3c 2f 64 74 3e 0a 20 20  /em></a></dt>.  
3590: 20 20 3c 64 64 3e 52 65 74 75 72 6e 73 20 61 20    <dd>Returns a 
35a0: 6c 69 73 74 20 6f 66 20 73 75 70 70 6f 72 74 65  list of supporte
35b0: 64 20 63 69 70 68 65 72 73 20 61 76 61 69 6c 61  d ciphers availa
35c0: 62 6c 65 20 66 6f 72 20 3c 65 6d 3e 70 72 6f 74  ble for <em>prot
35d0: 6f 63 6f 6c 3c 2f 65 6d 3e 2c 0a 20 20 20 20 20  ocol</em>,.     
35e0: 20 20 20 77 68 65 72 65 20 70 72 6f 74 6f 63 6f     where protoco
35f0: 6c 20 6d 75 73 74 20 62 65 20 6f 6e 65 20 6f 66  l must be one of
3600: 20 3c 62 3e 73 73 6c 32 2c 20 73 73 6c 33 2c 20   <b>ssl2, ssl3, 
3610: 74 6c 73 31 2c 20 74 6c 73 31 2e 31 2c 0a 09 74  tls1, tls1.1,..t
3620: 6c 73 31 2e 32 2c 3c 2f 62 3e 20 6f 72 20 3c 62  ls1.2,</b> or <b
3630: 3e 74 6c 73 31 2e 33 3c 2f 62 3e 2e 20 49 66 20  >tls1.3</b>. If 
3640: 3c 65 6d 3e 76 65 72 62 6f 73 65 3c 2f 65 6d 3e  <em>verbose</em>
3650: 20 69 73 20 73 70 65 63 69 66 69 65 64 20 61 73   is specified as
3660: 0a 09 74 72 75 65 20 74 68 65 6e 20 61 20 76 65  ..true then a ve
3670: 72 62 6f 73 65 2c 20 68 75 6d 61 6e 20 72 65 61  rbose, human rea
3680: 64 61 62 6c 65 20 6c 69 73 74 20 69 73 20 72 65  dable list is re
3690: 74 75 72 6e 65 64 20 77 69 74 68 0a 09 61 64 64  turned with..add
36a0: 69 74 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 74  itional informat
36b0: 69 6f 6e 20 6f 6e 20 74 68 65 20 63 69 70 68 65  ion on the ciphe
36c0: 72 2e 3c 2f 64 64 3e 0a 0a 20 20 20 20 3c 64 74  r.</dd>..    <dt
36d0: 3e 3c 61 20 6e 61 6d 65 3d 22 74 6c 73 3a 3a 76  ><a name="tls::v
36e0: 65 72 73 69 6f 6e 22 3e 3c 73 74 72 6f 6e 67 3e  ersion"><strong>
36f0: 74 6c 73 3a 3a 76 65 72 73 69 6f 6e 3c 2f 73 74  tls::version</st
3700: 72 6f 6e 67 3e 3c 2f 61 3e 3c 2f 64 74 3e 0a 20  rong></a></dt>. 
3710: 20 20 20 3c 64 64 3e 52 65 74 75 72 6e 73 20 74     <dd>Returns t
3720: 68 65 20 4f 70 65 6e 53 53 4c 20 76 65 72 73 69  he OpenSSL versi
3730: 6f 6e 20 73 74 72 69 6e 67 2e 3c 2f 64 64 3e 0a  on string.</dd>.
3740: 3c 2f 64 6c 3e 0a 0a 3c 68 33 3e 3c 61 20 6e 61  </dl>..<h3><a na
3750: 6d 65 3d 22 43 41 4c 4c 42 41 43 4b 20 4f 50 54  me="CALLBACK OPT
3760: 49 4f 4e 53 22 3e 43 41 4c 4c 42 41 43 4b 20 4f  IONS">CALLBACK O
3770: 50 54 49 4f 4e 53 3c 2f 61 3e 3c 2f 68 33 3e 0a  PTIONS</a></h3>.
3780: 0a 3c 70 3e 0a 41 73 20 69 6e 64 69 63 61 74 65  .<p>.As indicate
3790: 64 20 61 62 6f 76 65 2c 20 69 6e 64 69 76 69 64  d above, individ
37a0: 75 61 6c 20 63 68 61 6e 6e 65 6c 73 20 63 61 6e  ual channels can
37b0: 20 62 65 20 67 69 76 65 6e 20 74 68 65 69 72 20   be given their 
37c0: 6f 77 6e 20 63 61 6c 6c 62 61 63 6b 73 0a 74 6f  own callbacks.to
37d0: 20 68 61 6e 64 6c 65 20 69 6e 74 65 72 6d 65 64   handle intermed
37e0: 69 61 74 65 20 70 72 6f 63 65 73 73 69 6e 67 20  iate processing 
37f0: 62 79 20 74 68 65 20 4f 70 65 6e 53 53 4c 20 6c  by the OpenSSL l
3800: 69 62 72 61 72 79 2c 20 75 73 69 6e 67 20 74 68  ibrary, using th
3810: 65 0a 3c 65 6d 3e 2d 63 6f 6d 6d 61 6e 64 3c 2f  e.<em>-command</
3820: 65 6d 3e 20 61 6e 64 20 3c 65 6d 3e 2d 70 61 73  em> and <em>-pas
3830: 73 77 6f 72 64 3c 2f 65 6d 3e 20 6f 70 74 69 6f  sword</em> optio
3840: 6e 73 20 70 61 73 73 65 64 20 74 6f 20 65 69 74  ns passed to eit
3850: 68 65 72 20 6f 66 0a 3c 73 74 72 6f 6e 67 3e 74  her of.<strong>t
3860: 6c 73 3a 3a 73 6f 63 6b 65 74 3c 2f 73 74 72 6f  ls::socket</stro
3870: 6e 67 3e 20 6f 72 20 3c 73 74 72 6f 6e 67 3e 74  ng> or <strong>t
3880: 6c 73 3a 3a 69 6d 70 6f 72 74 3c 2f 73 74 72 6f  ls::import</stro
3890: 6e 67 3e 2e 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63  ng>..</p>..<bloc
38a0: 6b 71 75 6f 74 65 3e 0a 3c 64 6c 3e 0a 0a 20 20  kquote>.<dl>..  
38b0: 20 20 3c 64 74 3e 3c 73 74 72 6f 6e 67 3e 2d 63    <dt><strong>-c
38c0: 6f 6d 6d 61 6e 64 3c 2f 73 74 72 6f 6e 67 3e 20  ommand</strong> 
38d0: 3c 65 6d 3e 63 61 6c 6c 62 61 63 6b 3c 2f 65 6d  <em>callback</em
38e0: 3e 3c 2f 64 74 3e 0a 20 20 20 20 3c 64 64 3e 0a  ></dt>.    <dd>.
38f0: 09 49 6e 76 6f 6b 65 73 20 74 68 65 20 73 70 65  .Invokes the spe
3900: 63 69 66 69 65 64 20 3c 65 6d 3e 63 61 6c 6c 62  cified <em>callb
3910: 61 63 6b 3c 2f 65 6d 3e 20 73 63 72 69 70 74 20  ack</em> script 
3920: 61 74 0a 09 73 65 76 65 72 61 6c 20 70 6f 69 6e  at..several poin
3930: 74 73 20 64 75 72 69 6e 67 20 74 68 65 20 4f 70  ts during the Op
3940: 65 6e 53 53 4c 20 68 61 6e 64 73 68 61 6b 65 2e  enSSL handshake.
3950: 0a 09 45 78 63 65 70 74 20 61 73 20 69 6e 64 69  ..Except as indi
3960: 63 61 74 65 64 20 62 65 6c 6f 77 2c 20 76 61 6c  cated below, val
3970: 75 65 73 20 72 65 74 75 72 6e 65 64 20 66 72 6f  ues returned fro
3980: 6d 20 74 68 65 0a 09 63 61 6c 6c 62 61 63 6b 20  m the..callback 
3990: 61 72 65 20 69 67 6e 6f 72 65 64 2e 0a 09 41 72  are ignored...Ar
39a0: 67 75 6d 65 6e 74 73 20 61 70 70 65 6e 64 65 64  guments appended
39b0: 20 74 6f 20 74 68 65 20 73 63 72 69 70 74 20 75   to the script u
39c0: 70 6f 6e 20 63 61 6c 6c 62 61 63 6b 20 74 61 6b  pon callback tak
39d0: 65 20 6f 6e 65 20 6f 66 20 74 68 65 0a 09 66 6f  e one of the..fo
39e0: 6c 6c 6f 77 69 6e 67 20 66 6f 72 6d 73 3a 0a 0a  llowing forms:..
39f0: 09 3c 62 72 3e 0a 09 3c 62 72 3e 0a 0a 09 3c 64  .<br>..<br>...<d
3a00: 6c 3e 0a 0a 3c 21 2d 2d 09 54 68 69 73 20 66 6f  l>..<!--.This fo
3a10: 72 6d 20 6f 66 20 63 61 6c 6c 62 61 63 6b 20 69  rm of callback i
3a20: 73 20 64 69 73 61 62 6c 65 64 2e 0a 0a 09 3c 64  s disabled....<d
3a30: 74 3e 0a 09 20 20 3c 73 74 72 6f 6e 67 3e 65 72  t>..  <strong>er
3a40: 72 6f 72 3c 2f 73 74 72 6f 6e 67 3e 20 3c 65 6d  ror</strong> <em
3a50: 3e 63 68 61 6e 6e 65 6c 20 6d 65 73 73 61 67 65  >channel message
3a60: 3c 2f 65 6d 3e 0a 09 3c 2f 64 74 3e 0a 09 3c 64  </em>..</dt>..<d
3a70: 64 3e 0a 09 20 20 54 68 65 20 3c 65 6d 3e 6d 65  d>..  The <em>me
3a80: 73 73 61 67 65 3c 2f 65 6d 3e 20 61 72 67 75 6d  ssage</em> argum
3a90: 65 6e 74 20 63 6f 6e 74 61 69 6e 73 20 61 6e 20  ent contains an 
3aa0: 65 72 72 6f 72 20 6d 65 73 73 61 67 65 20 67 65  error message ge
3ab0: 6e 65 72 61 74 65 64 0a 09 20 20 62 79 20 74 68  nerated..  by th
3ac0: 65 20 4f 70 65 6e 53 53 4c 20 66 75 6e 63 74 69  e OpenSSL functi
3ad0: 6f 6e 0a 09 20 20 3c 63 6f 64 65 3e 45 52 52 5f  on..  <code>ERR_
3ae0: 72 65 61 73 6f 6e 5f 65 72 72 6f 72 5f 73 74 72  reason_error_str
3af0: 69 6e 67 28 29 3c 2f 63 6f 64 65 3e 2e 0a 09 3c  ing()</code>...<
3b00: 2f 64 64 3e 0a 0a 09 3c 62 72 3e 0a 2d 2d 3e 0a  /dd>...<br>.-->.
3b10: 0a 09 3c 64 74 3e 0a 09 20 20 3c 73 74 72 6f 6e  ..<dt>..  <stron
3b20: 67 3e 69 6e 66 6f 3c 2f 73 74 72 6f 6e 67 3e 20  g>info</strong> 
3b30: 3c 65 6d 3e 63 68 61 6e 6e 65 6c 20 6d 61 6a 6f  <em>channel majo
3b40: 72 20 6d 69 6e 6f 72 20 6d 65 73 73 61 67 65 3c  r minor message<
3b50: 2f 65 6d 3e 0a 09 3c 2f 64 74 3e 0a 09 3c 64 64  /em>..</dt>..<dd
3b60: 3e 0a 09 20 20 54 68 69 73 20 66 6f 72 6d 20 6f  >..  This form o
3b70: 66 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e  f callback is in
3b80: 76 6f 6b 65 64 20 62 79 20 74 68 65 20 4f 70 65  voked by the Ope
3b90: 6e 53 53 4c 20 66 75 6e 63 74 69 6f 6e 0a 09 20  nSSL function.. 
3ba0: 20 3c 63 6f 64 65 3e 53 53 4c 5f 43 54 58 5f 73   <code>SSL_CTX_s
3bb0: 65 74 5f 69 6e 66 6f 5f 63 61 6c 6c 62 61 63 6b  et_info_callback
3bc0: 28 29 3c 2f 63 6f 64 65 3e 2e 0a 09 20 20 3c 62  ()</code>...  <b
3bd0: 72 3e 0a 09 20 20 54 68 65 20 3c 65 6d 3e 6d 61  r>..  The <em>ma
3be0: 6a 6f 72 3c 2f 65 6d 3e 20 61 6e 64 20 3c 65 6d  jor</em> and <em
3bf0: 3e 6d 69 6e 6f 72 3c 2f 65 6d 3e 20 61 72 67 75  >minor</em> argu
3c00: 6d 65 6e 74 73 20 61 72 65 20 75 73 65 64 20 74  ments are used t
3c10: 6f 0a 09 20 20 72 65 70 72 65 73 65 6e 74 20 74  o..  represent t
3c20: 68 65 20 73 74 61 74 65 20 69 6e 66 6f 72 6d 61  he state informa
3c30: 74 69 6f 6e 20 62 69 74 6d 61 73 6b 2e 0a 09 20  tion bitmask... 
3c40: 20 3c 64 6c 3e 0a 09 20 20 3c 64 74 3e 50 6f 73   <dl>..  <dt>Pos
3c50: 73 69 62 6c 65 20 76 61 6c 75 65 73 20 66 6f 72  sible values for
3c60: 20 3c 65 6d 3e 6d 61 6a 6f 72 3c 2f 65 6d 3e 20   <em>major</em> 
3c70: 61 72 65 3a 3c 2f 64 74 3e 0a 09 20 20 3c 64 64  are:</dt>..  <dd
3c80: 3e 3c 63 6f 64 65 3e 68 61 6e 64 73 68 61 6b 65  ><code>handshake
3c90: 2c 20 61 6c 65 72 74 2c 20 63 6f 6e 6e 65 63 74  , alert, connect
3ca0: 2c 20 61 63 63 65 70 74 3c 2f 63 6f 64 65 3e 2e  , accept</code>.
3cb0: 3c 2f 64 64 3e 0a 09 20 20 3c 64 74 3e 50 6f 73  </dd>..  <dt>Pos
3cc0: 73 69 62 6c 65 20 76 61 6c 75 65 73 20 66 6f 72  sible values for
3cd0: 20 3c 65 6d 3e 6d 69 6e 6f 72 3c 2f 65 6d 3e 20   <em>minor</em> 
3ce0: 61 72 65 3a 3c 2f 64 74 3e 0a 09 20 20 3c 64 64  are:</dt>..  <dd
3cf0: 3e 3c 63 6f 64 65 3e 73 74 61 72 74 2c 20 64 6f  ><code>start, do
3d00: 6e 65 2c 20 72 65 61 64 2c 20 77 72 69 74 65 2c  ne, read, write,
3d10: 20 6c 6f 6f 70 2c 20 65 78 69 74 3c 2f 63 6f 64   loop, exit</cod
3d20: 65 3e 2e 3c 2f 64 64 3e 0a 09 20 20 3c 2f 64 6c  e>.</dd>..  </dl
3d30: 3e 0a 09 20 20 54 68 65 20 3c 65 6d 3e 6d 65 73  >..  The <em>mes
3d40: 73 61 67 65 3c 2f 65 6d 3e 20 61 72 67 75 6d 65  sage</em> argume
3d50: 6e 74 20 69 73 20 61 20 64 65 73 63 72 69 70 74  nt is a descript
3d60: 69 76 65 20 73 74 72 69 6e 67 20 77 68 69 63 68  ive string which
3d70: 20 6d 61 79 0a 09 20 20 62 65 20 67 65 6e 65 72   may..  be gener
3d80: 61 74 65 64 20 65 69 74 68 65 72 20 62 79 0a 09  ated either by..
3d90: 20 20 3c 63 6f 64 65 3e 53 53 4c 5f 73 74 61 74    <code>SSL_stat
3da0: 65 5f 73 74 72 69 6e 67 5f 6c 6f 6e 67 28 29 3c  e_string_long()<
3db0: 2f 63 6f 64 65 3e 20 6f 72 20 62 79 0a 09 20 20  /code> or by..  
3dc0: 3c 63 6f 64 65 3e 53 53 4c 5f 61 6c 65 72 74 5f  <code>SSL_alert_
3dd0: 64 65 73 63 5f 73 74 72 69 6e 67 5f 6c 6f 6e 67  desc_string_long
3de0: 28 29 3c 2f 63 6f 64 65 3e 2c 0a 09 20 20 64 65  ()</code>,..  de
3df0: 70 65 6e 64 69 6e 67 20 6f 6e 20 63 6f 6e 74 65  pending on conte
3e00: 78 74 2e 0a 09 3c 2f 64 64 3e 0a 0a 09 3c 62 72  xt...</dd>...<br
3e10: 3e 0a 0a 09 3c 64 74 3e 0a 09 20 20 3c 73 74 72  >...<dt>..  <str
3e20: 6f 6e 67 3e 76 65 72 69 66 79 3c 2f 73 74 72 6f  ong>verify</stro
3e30: 6e 67 3e 20 3c 65 6d 3e 63 68 61 6e 6e 65 6c 20  ng> <em>channel 
3e40: 64 65 70 74 68 20 63 65 72 74 20 73 74 61 74 75  depth cert statu
3e50: 73 20 65 72 72 6f 72 3c 2f 65 6d 3e 0a 09 3c 2f  s error</em>..</
3e60: 64 74 3e 0a 09 3c 64 64 3e 0a 09 20 20 54 68 69  dt>..<dd>..  Thi
3e70: 73 20 66 6f 72 6d 20 6f 66 20 63 61 6c 6c 62 61  s form of callba
3e80: 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 62 79  ck is invoked by
3e90: 20 74 68 65 20 4f 70 65 6e 53 53 4c 20 66 75 6e   the OpenSSL fun
3ea0: 63 74 69 6f 6e 0a 09 20 20 3c 63 6f 64 65 3e 53  ction..  <code>S
3eb0: 53 4c 5f 73 65 74 5f 76 65 72 69 66 79 28 29 3c  SL_set_verify()<
3ec0: 2f 63 6f 64 65 3e 2e 0a 09 20 20 3c 62 72 3e 0a  /code>...  <br>.
3ed0: 09 20 20 54 68 65 20 3c 65 6d 3e 64 65 70 74 68  .  The <em>depth
3ee0: 3c 2f 65 6d 3e 20 61 72 67 75 6d 65 6e 74 20 69  </em> argument i
3ef0: 73 20 61 6e 20 69 6e 74 65 67 65 72 20 72 65 70  s an integer rep
3f00: 72 65 73 65 6e 74 69 6e 67 20 74 68 65 0a 09 20  resenting the.. 
3f10: 20 63 75 72 72 65 6e 74 20 64 65 70 74 68 20 6f   current depth o
3f20: 6e 20 74 68 65 20 63 65 72 74 69 66 69 63 61 74  n the certificat
3f30: 65 20 63 68 61 69 6e 2c 20 77 69 74 68 0a 09 20  e chain, with.. 
3f40: 20 3c 63 6f 64 65 3e 30 3c 2f 63 6f 64 65 3e 20   <code>0</code> 
3f50: 61 73 20 74 68 65 20 73 75 62 6a 65 63 74 20 63  as the subject c
3f60: 65 72 74 69 66 69 63 61 74 65 20 61 6e 64 20 68  ertificate and h
3f70: 69 67 68 65 72 20 76 61 6c 75 65 73 0a 09 20 20  igher values..  
3f80: 64 65 6e 6f 74 69 6e 67 20 70 72 6f 67 72 65 73  denoting progres
3f90: 73 69 76 65 6c 79 20 6d 6f 72 65 20 69 6e 64 69  sively more indi
3fa0: 72 65 63 74 20 69 73 73 75 65 72 20 63 65 72 74  rect issuer cert
3fb0: 69 66 69 63 61 74 65 73 2e 0a 09 20 20 3c 62 72  ificates...  <br
3fc0: 3e 0a 09 20 20 54 68 65 20 3c 65 6d 3e 63 65 72  >..  The <em>cer
3fd0: 74 3c 2f 65 6d 3e 20 61 72 67 75 6d 65 6e 74 20  t</em> argument 
3fe0: 69 73 20 61 20 6c 69 73 74 20 6f 66 20 6b 65 79  is a list of key
3ff0: 2d 76 61 6c 75 65 20 70 61 69 72 73 20 73 69 6d  -value pairs sim
4000: 69 6c 61 72 0a 09 20 20 74 6f 20 74 68 6f 73 65  ilar..  to those
4010: 20 72 65 74 75 72 6e 65 64 20 62 79 0a 09 20 20   returned by..  
4020: 3c 61 20 68 72 65 66 3d 22 23 74 6c 73 3a 3a 73  <a href="#tls::s
4030: 74 61 74 75 73 22 3e 3c 73 74 72 6f 6e 67 3e 74  tatus"><strong>t
4040: 6c 73 3a 3a 73 74 61 74 75 73 3c 2f 73 74 72 6f  ls::status</stro
4050: 6e 67 3e 3c 2f 61 3e 2e 0a 09 20 20 3c 62 72 3e  ng></a>...  <br>
4060: 0a 09 20 20 54 68 65 20 3c 65 6d 3e 73 74 61 74  ..  The <em>stat
4070: 75 73 3c 2f 65 6d 3e 20 61 72 67 75 6d 65 6e 74  us</em> argument
4080: 20 69 73 20 61 6e 20 69 6e 74 65 67 65 72 20 72   is an integer r
4090: 65 70 72 65 73 65 6e 74 69 6e 67 20 74 68 65 0a  epresenting the.
40a0: 09 20 20 63 75 72 72 65 6e 74 20 76 61 6c 69 64  .  current valid
40b0: 69 74 79 20 6f 66 20 74 68 65 20 63 65 72 74 69  ity of the certi
40c0: 66 69 63 61 74 65 2e 0a 09 20 20 41 20 76 61 6c  ficate...  A val
40d0: 75 65 20 6f 66 20 3c 63 6f 64 65 3e 30 3c 2f 63  ue of <code>0</c
40e0: 6f 64 65 3e 20 6d 65 61 6e 73 20 74 68 65 20 63  ode> means the c
40f0: 65 72 74 69 66 69 63 61 74 65 20 69 73 20 64 65  ertificate is de
4100: 65 6d 65 64 20 69 6e 76 61 6c 69 64 2e 0a 09 20  emed invalid... 
4110: 20 41 20 76 61 6c 75 65 20 6f 66 20 3c 63 6f 64   A value of <cod
4120: 65 3e 31 3c 2f 63 6f 64 65 3e 20 6d 65 61 6e 73  e>1</code> means
4130: 20 74 68 65 20 63 65 72 74 69 66 69 63 61 74 65   the certificate
4140: 20 69 73 20 64 65 65 6d 65 64 20 76 61 6c 69 64   is deemed valid
4150: 2e 0a 09 20 20 3c 62 72 3e 0a 09 20 20 54 68 65  ...  <br>..  The
4160: 20 3c 65 6d 3e 65 72 72 6f 72 3c 2f 65 6d 3e 20   <em>error</em> 
4170: 61 72 67 75 6d 65 6e 74 20 73 75 70 70 6c 69 65  argument supplie
4180: 73 20 74 68 65 20 6d 65 73 73 61 67 65 2c 20 69  s the message, i
4190: 66 20 61 6e 79 2c 20 67 65 6e 65 72 61 74 65 64  f any, generated
41a0: 0a 09 20 20 62 79 0a 09 20 20 3c 63 6f 64 65 3e  ..  by..  <code>
41b0: 58 35 30 39 5f 53 54 4f 52 45 5f 43 54 58 5f 67  X509_STORE_CTX_g
41c0: 65 74 5f 65 72 72 6f 72 28 29 3c 2f 63 6f 64 65  et_error()</code
41d0: 3e 2e 0a 09 20 20 3c 62 72 3e 0a 09 20 20 3c 62  >...  <br>..  <b
41e0: 72 3e 0a 09 20 20 54 68 65 20 63 61 6c 6c 62 61  r>..  The callba
41f0: 63 6b 20 6d 61 79 20 6f 76 65 72 72 69 64 65 20  ck may override 
4200: 6e 6f 72 6d 61 6c 20 76 61 6c 69 64 61 74 69 6f  normal validatio
4210: 6e 20 70 72 6f 63 65 73 73 69 6e 67 20 62 79 20  n processing by 
4220: 65 78 70 6c 69 63 69 74 6c 79 0a 09 20 20 72 65  explicitly..  re
4230: 74 75 72 6e 69 6e 67 20 6f 6e 65 20 6f 66 20 74  turning one of t
4240: 68 65 20 61 62 6f 76 65 20 3c 65 6d 3e 73 74 61  he above <em>sta
4250: 74 75 73 3c 2f 65 6d 3e 20 76 61 6c 75 65 73 2e  tus</em> values.
4260: 0a 09 3c 2f 64 64 3e 0a 0a 09 3c 2f 64 6c 3e 0a  ..</dd>...</dl>.
4270: 20 20 20 20 3c 2f 64 64 3e 0a 0a 20 20 20 20 3c      </dd>..    <
4280: 62 72 3e 0a 0a 20 20 20 20 3c 64 74 3e 3c 73 74  br>..    <dt><st
4290: 72 6f 6e 67 3e 2d 70 61 73 73 77 6f 72 64 3c 2f  rong>-password</
42a0: 73 74 72 6f 6e 67 3e 20 3c 65 6d 3e 63 61 6c 6c  strong> <em>call
42b0: 62 61 63 6b 3c 2f 65 6d 3e 3c 2f 64 74 3e 0a 20  back</em></dt>. 
42c0: 20 20 20 3c 64 64 3e 0a 09 49 6e 76 6f 6b 65 73     <dd>..Invokes
42d0: 20 74 68 65 20 73 70 65 63 69 66 69 65 64 20 3c   the specified <
42e0: 65 6d 3e 63 61 6c 6c 62 61 63 6b 3c 2f 65 6d 3e  em>callback</em>
42f0: 20 73 63 72 69 70 74 20 77 68 65 6e 20 4f 70 65   script when Ope
4300: 6e 53 53 4c 20 6e 65 65 64 73 20 74 6f 0a 09 6f  nSSL needs to..o
4310: 62 74 61 69 6e 20 61 20 70 61 73 73 77 6f 72 64  btain a password
4320: 2e 20 20 54 68 65 20 63 61 6c 6c 62 61 63 6b 20  .  The callback 
4330: 73 68 6f 75 6c 64 20 72 65 74 75 72 6e 20 61 20  should return a 
4340: 73 74 72 69 6e 67 20 77 68 69 63 68 0a 09 72 65  string which..re
4350: 70 72 65 73 65 6e 74 73 20 74 68 65 20 70 61 73  presents the pas
4360: 73 77 6f 72 64 20 74 6f 20 62 65 20 75 73 65 64  sword to be used
4370: 2e 0a 09 4e 6f 20 61 72 67 75 6d 65 6e 74 73 20  ...No arguments 
4380: 61 72 65 20 61 70 70 65 6e 64 65 64 20 74 6f 20  are appended to 
4390: 74 68 65 20 73 63 72 69 70 74 20 75 70 6f 6e 20  the script upon 
43a0: 63 61 6c 6c 62 61 63 6b 2e 0a 20 20 20 20 3c 2f  callback..    </
43b0: 64 64 3e 0a 3c 2f 64 6c 3e 0a 3c 2f 62 6c 6f 63  dd>.</dl>.</bloc
43c0: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 0a 52 65 66  kquote>..<p>.Ref
43d0: 65 72 65 6e 63 65 20 69 6d 70 6c 65 6d 65 6e 74  erence implement
43e0: 61 74 69 6f 6e 73 20 6f 66 20 74 68 65 73 65 20  ations of these 
43f0: 63 61 6c 6c 62 61 63 6b 73 20 61 72 65 20 70 72  callbacks are pr
4400: 6f 76 69 64 65 64 20 69 6e 20 74 68 65 0a 64 69  ovided in the.di
4410: 73 74 72 69 62 75 74 69 6f 6e 20 61 73 20 3c 73  stribution as <s
4420: 74 72 6f 6e 67 3e 74 6c 73 3a 3a 63 61 6c 6c 62  trong>tls::callb
4430: 61 63 6b 3c 2f 73 74 72 6f 6e 67 3e 20 61 6e 64  ack</strong> and
4440: 0a 3c 73 74 72 6f 6e 67 3e 74 6c 73 3a 3a 70 61  .<strong>tls::pa
4450: 73 73 77 6f 72 64 3c 2f 73 74 72 6f 6e 67 3e 20  ssword</strong> 
4460: 72 65 73 70 65 63 74 69 76 65 6c 79 2e 20 20 4e  respectively.  N
4470: 6f 74 65 20 74 68 61 74 20 74 68 65 73 65 20 61  ote that these a
4480: 72 65 0a 3c 65 6d 3e 73 61 6d 70 6c 65 3c 2f 65  re.<em>sample</e
4490: 6d 3e 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f  m> implementatio
44a0: 6e 73 20 6f 6e 6c 79 2e 20 20 49 6e 20 61 20 6d  ns only.  In a m
44b0: 6f 72 65 20 72 65 61 6c 69 73 74 69 63 20 64 65  ore realistic de
44c0: 70 6c 6f 79 6d 65 6e 74 0a 79 6f 75 20 77 6f 75  ployment.you wou
44d0: 6c 64 20 73 70 65 63 69 66 79 20 79 6f 75 72 20  ld specify your 
44e0: 6f 77 6e 20 63 61 6c 6c 62 61 63 6b 20 73 63 72  own callback scr
44f0: 69 70 74 73 20 6f 6e 20 65 61 63 68 20 54 4c 53  ipts on each TLS
4500: 20 63 68 61 6e 6e 65 6c 0a 75 73 69 6e 67 20 74   channel.using t
4510: 68 65 20 3c 65 6d 3e 2d 63 6f 6d 6d 61 6e 64 3c  he <em>-command<
4520: 2f 65 6d 3e 20 61 6e 64 20 3c 65 6d 3e 2d 70 61  /em> and <em>-pa
4530: 73 73 77 6f 72 64 3c 2f 65 6d 3e 20 6f 70 74 69  ssword</em> opti
4540: 6f 6e 73 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 54  ons..</p>..<p>.T
4550: 68 65 20 64 65 66 61 75 6c 74 20 62 65 68 61 76  he default behav
4560: 69 6f 72 20 77 68 65 6e 20 74 68 65 20 3c 65 6d  ior when the <em
4570: 3e 2d 63 6f 6d 6d 61 6e 64 3c 2f 65 6d 3e 20 6f  >-command</em> o
4580: 70 74 69 6f 6e 20 69 73 20 6e 6f 74 20 73 70 65  ption is not spe
4590: 63 69 66 69 65 64 20 69 73 20 66 6f 72 0a 54 4c  cified is for.TL
45a0: 53 20 74 6f 20 70 72 6f 63 65 73 73 20 74 68 65  S to process the
45b0: 20 61 73 73 6f 63 69 61 74 65 64 20 6c 69 62 72   associated libr
45c0: 61 72 79 20 63 61 6c 6c 62 61 63 6b 73 20 69 6e  ary callbacks in
45d0: 74 65 72 6e 61 6c 6c 79 2e 0a 54 68 65 20 64 65  ternally..The de
45e0: 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 20 77  fault behavior w
45f0: 68 65 6e 20 74 68 65 20 3c 65 6d 3e 2d 70 61 73  hen the <em>-pas
4600: 73 77 6f 72 64 3c 2f 65 6d 3e 20 6f 70 74 69 6f  sword</em> optio
4610: 6e 20 69 73 20 6e 6f 74 20 73 70 65 63 69 66 69  n is not specifi
4620: 65 64 20 69 73 20 66 6f 72 0a 54 4c 53 20 74 6f  ed is for.TLS to
4630: 20 70 72 6f 63 65 73 73 20 74 68 65 20 61 73 73   process the ass
4640: 6f 63 69 61 74 65 64 20 6c 69 62 72 61 72 79 20  ociated library 
4650: 63 61 6c 6c 62 61 63 6b 73 20 62 79 20 61 74 74  callbacks by att
4660: 65 6d 70 74 69 6e 67 20 74 6f 20 63 61 6c 6c 0a  empting to call.
4670: 3c 73 74 72 6f 6e 67 3e 74 6c 73 3a 3a 70 61 73  <strong>tls::pas
4680: 73 77 6f 72 64 3c 2f 73 74 72 6f 6e 67 3e 2e 0a  sword</strong>..
4690: 54 68 65 20 64 69 66 66 65 72 65 6e 63 65 20 62  The difference b
46a0: 65 74 77 65 65 6e 20 74 68 65 73 65 20 74 77 6f  etween these two
46b0: 20 62 65 68 61 76 69 6f 72 73 20 69 73 20 61 20   behaviors is a 
46c0: 63 6f 6e 73 65 71 75 65 6e 63 65 20 6f 66 20 6d  consequence of m
46d0: 61 69 6e 74 61 69 6e 69 6e 67 0a 63 6f 6d 70 61  aintaining.compa
46e0: 74 69 62 69 6c 69 74 79 20 77 69 74 68 20 65 61  tibility with ea
46f0: 72 6c 69 65 72 20 69 6d 70 6c 65 6d 65 6e 74 61  rlier implementa
4700: 74 69 6f 6e 73 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e  tions..</p>..<p>
4710: 0a 54 68 65 20 3c 73 74 72 6f 6e 67 3e 74 6c 73  .The <strong>tls
4720: 3a 3a 64 65 62 75 67 3c 2f 73 74 72 6f 6e 67 3e  ::debug</strong>
4730: 20 76 61 72 69 61 62 6c 65 20 70 72 6f 76 69 64   variable provid
4740: 65 73 20 73 6f 6d 65 20 61 64 64 69 74 69 6f 6e  es some addition
4750: 61 6c 0a 63 6f 6e 74 72 6f 6c 20 6f 76 65 72 20  al.control over 
4760: 74 68 65 73 65 20 72 65 66 65 72 65 6e 63 65 20  these reference 
4770: 63 61 6c 6c 62 61 63 6b 73 2e 20 20 49 74 73 20  callbacks.  Its 
4780: 76 61 6c 75 65 20 69 73 20 7a 65 72 6f 20 62 79  value is zero by
4790: 20 64 65 66 61 75 6c 74 2e 0a 48 69 67 68 65 72   default..Higher
47a0: 20 76 61 6c 75 65 73 20 70 72 6f 64 75 63 65 20   values produce 
47b0: 6d 6f 72 65 20 64 69 61 67 6e 6f 73 74 69 63 20  more diagnostic 
47c0: 6f 75 74 70 75 74 2c 20 61 6e 64 20 77 69 6c 6c  output, and will
47d0: 20 61 6c 73 6f 20 66 6f 72 63 65 20 74 68 65 0a   also force the.
47e0: 76 65 72 69 66 79 20 6d 65 74 68 6f 64 20 69 6e  verify method in
47f0: 20 3c 73 74 72 6f 6e 67 3e 74 6c 73 3a 3a 63 61   <strong>tls::ca
4800: 6c 6c 62 61 63 6b 3c 2f 73 74 72 6f 6e 67 3e 20  llback</strong> 
4810: 74 6f 20 61 63 63 65 70 74 20 74 68 65 0a 63 65  to accept the.ce
4820: 72 74 69 66 69 63 61 74 65 2c 20 65 76 65 6e 20  rtificate, even 
4830: 77 68 65 6e 20 69 74 20 69 73 20 69 6e 76 61 6c  when it is inval
4840: 69 64 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 3c 65  id..</p>..<p>.<e
4850: 6d 3e 0a 54 68 65 20 75 73 65 20 6f 66 20 74 68  m>.The use of th
4860: 65 20 72 65 66 65 72 65 6e 63 65 20 63 61 6c 6c  e reference call
4870: 62 61 63 6b 73 20 3c 73 74 72 6f 6e 67 3e 74 6c  backs <strong>tl
4880: 73 3a 3a 63 61 6c 6c 62 61 63 6b 3c 2f 73 74 72  s::callback</str
4890: 6f 6e 67 3e 20 61 6e 64 0a 3c 73 74 72 6f 6e 67  ong> and.<strong
48a0: 3e 74 6c 73 3a 3a 70 61 73 73 77 6f 72 64 3c 2f  >tls::password</
48b0: 73 74 72 6f 6e 67 3e 20 69 73 20 6e 6f 74 20 72  strong> is not r
48c0: 65 63 6f 6d 6d 65 6e 64 65 64 2e 20 20 54 68 65  ecommended.  The
48d0: 79 20 6d 61 79 20 62 65 20 72 65 6d 6f 76 65 64  y may be removed
48e0: 0a 66 72 6f 6d 20 66 75 74 75 72 65 20 72 65 6c  .from future rel
48f0: 65 61 73 65 73 2e 0a 3c 2f 65 6d 3e 0a 3c 2f 70  eases..</em>.</p
4900: 3e 0a 0a 3c 70 3e 0a 3c 65 6d 3e 0a 54 68 65 20  >..<p>.<em>.The 
4910: 75 73 65 20 6f 66 20 74 68 65 20 76 61 72 69 61  use of the varia
4920: 62 6c 65 20 3c 73 74 72 6f 6e 67 3e 74 6c 73 3a  ble <strong>tls:
4930: 3a 64 65 62 75 67 3c 2f 73 74 72 6f 6e 67 3e 20  :debug</strong> 
4940: 69 73 20 6e 6f 74 20 72 65 63 6f 6d 6d 65 6e 64  is not recommend
4950: 65 64 2e 0a 49 74 20 6d 61 79 20 62 65 20 72 65  ed..It may be re
4960: 6d 6f 76 65 64 20 66 72 6f 6d 20 66 75 74 75 72  moved from futur
4970: 65 20 72 65 6c 65 61 73 65 73 2e 0a 3c 2f 65 6d  e releases..</em
4980: 3e 0a 3c 2f 70 3e 0a 0a 3c 68 33 3e 3c 61 20 6e  >.</p>..<h3><a n
4990: 61 6d 65 3d 22 44 45 42 55 47 22 3e 44 45 42 55  ame="DEBUG">DEBU
49a0: 47 3c 2f 61 3e 3c 2f 68 33 3e 0a 0a 54 4c 53 20  G</a></h3>..TLS 
49b0: 6b 65 79 20 6c 6f 67 67 69 6e 67 20 63 61 6e 20  key logging can 
49c0: 62 65 20 65 6e 61 62 6c 65 64 20 62 79 20 73 65  be enabled by se
49d0: 74 74 69 6e 67 20 74 68 65 20 65 6e 76 69 72 6f  tting the enviro
49e0: 6e 6d 65 6e 74 20 76 61 72 69 61 62 6c 65 0a 3c  nment variable.<
49f0: 62 3e 53 53 4c 4b 45 59 4c 4f 47 46 49 4c 45 3c  b>SSLKEYLOGFILE<
4a00: 2f 62 3e 20 74 6f 20 74 68 65 20 6e 61 6d 65 20  /b> to the name 
4a10: 6f 66 20 74 68 65 20 66 69 6c 65 20 74 6f 20 6c  of the file to l
4a20: 6f 67 20 74 6f 2e 20 54 68 65 6e 20 77 68 65 6e  og to. Then when
4a30: 65 76 65 72 20 54 4c 53 0a 6b 65 79 20 6d 61 74  ever TLS.key mat
4a40: 65 72 69 61 6c 20 69 73 20 67 65 6e 65 72 61 74  erial is generat
4a50: 65 64 20 6f 72 20 72 65 63 65 69 76 65 64 20 69  ed or received i
4a60: 74 20 77 69 6c 6c 20 62 65 20 6c 6f 67 67 65 64  t will be logged
4a70: 20 74 6f 20 74 68 65 20 66 69 6c 65 2e 0a 0a 3c   to the file...<
4a80: 68 33 3e 3c 61 20 6e 61 6d 65 3d 22 48 54 54 50  h3><a name="HTTP
4a90: 53 20 45 58 41 4d 50 4c 45 22 3e 48 54 54 50 53  S EXAMPLE">HTTPS
4aa0: 20 45 58 41 4d 50 4c 45 3c 2f 61 3e 3c 2f 68 33   EXAMPLE</a></h3
4ab0: 3e 0a 0a 3c 70 3e 54 68 69 73 20 65 78 61 6d 70  >..<p>This examp
4ac0: 6c 65 20 75 73 65 73 20 61 20 73 61 6d 70 6c 65  le uses a sample
4ad0: 20 73 65 72 76 65 72 2e 70 65 6d 20 70 72 6f 76   server.pem prov
4ae0: 69 64 65 64 20 77 69 74 68 20 74 68 65 20 54 4c  ided with the TL
4af0: 53 20 72 65 6c 65 61 73 65 2c 0a 63 6f 75 72 74  S release,.court
4b00: 65 73 79 20 6f 66 20 74 68 65 20 3c 73 74 72 6f  esy of the <stro
4b10: 6e 67 3e 4f 70 65 6e 53 53 4c 3c 2f 73 74 72 6f  ng>OpenSSL</stro
4b20: 6e 67 3e 20 70 72 6f 6a 65 63 74 2e 3c 2f 70 3e  ng> project.</p>
4b30: 0a 0a 3c 70 72 65 3e 3c 63 6f 64 65 3e 0a 70 61  ..<pre><code>.pa
4b40: 63 6b 61 67 65 20 72 65 71 75 69 72 65 20 68 74  ckage require ht
4b50: 74 70 0a 70 61 63 6b 61 67 65 20 72 65 71 75 69  tp.package requi
4b60: 72 65 20 74 6c 73 0a 0a 68 74 74 70 3a 3a 72 65  re tls..http::re
4b70: 67 69 73 74 65 72 20 68 74 74 70 73 20 34 34 33  gister https 443
4b80: 20 5b 6c 69 73 74 20 3a 3a 74 6c 73 3a 3a 73 6f   [list ::tls::so
4b90: 63 6b 65 74 20 2d 61 75 74 6f 73 65 72 76 65 72  cket -autoserver
4ba0: 6e 61 6d 65 20 74 72 75 65 20 2d 72 65 71 75 69  name true -requi
4bb0: 72 65 20 74 72 75 65 20 2d 63 61 64 69 72 20 2f  re true -cadir /
4bc0: 65 74 63 2f 73 73 6c 2f 63 65 72 74 73 5d 0a 0a  etc/ssl/certs]..
4bd0: 73 65 74 20 74 6f 6b 20 5b 68 74 74 70 3a 3a 67  set tok [http::g
4be0: 65 74 75 72 6c 20 68 74 74 70 73 3a 2f 2f 77 77  eturl https://ww
4bf0: 77 2e 74 63 6c 2e 74 6b 2f 5d 0a 3c 2f 63 6f 64  w.tcl.tk/].</cod
4c00: 65 3e 3c 2f 70 72 65 3e 0a 0a 3c 68 33 3e 3c 61  e></pre>..<h3><a
4c10: 20 6e 61 6d 65 3d 22 53 50 45 43 49 41 4c 20 43   name="SPECIAL C
4c20: 4f 4e 53 49 44 45 52 41 54 49 4f 4e 53 22 3e 53  ONSIDERATIONS">S
4c30: 50 45 43 49 41 4c 20 43 4f 4e 53 49 44 45 52 41  PECIAL CONSIDERA
4c40: 54 49 4f 4e 53 3c 2f 61 3e 3c 2f 68 33 3e 0a 0a  TIONS</a></h3>..
4c50: 3c 70 3e 54 68 65 20 63 61 70 61 62 69 6c 69 74  <p>The capabilit
4c60: 69 65 73 20 6f 66 20 74 68 69 73 20 70 61 63 6b  ies of this pack
4c70: 61 67 65 20 63 61 6e 20 76 61 72 79 20 65 6e 6f  age can vary eno
4c80: 72 6d 6f 75 73 6c 79 20 62 61 73 65 64 0a 75 70  rmously based.up
4c90: 6f 6e 20 68 6f 77 20 79 6f 75 72 20 4f 70 65 6e  on how your Open
4ca0: 53 53 4c 20 6c 69 62 72 61 72 79 20 77 61 73 20  SSL library was 
4cb0: 63 6f 6e 66 69 67 75 72 65 64 20 61 6e 64 20 62  configured and b
4cc0: 75 69 6c 74 2e 20 41 74 20 74 68 65 0a 6d 6f 73  uilt. At the.mos
4cd0: 74 20 6d 61 63 72 6f 2d 6c 65 76 65 6c 20 4f 70  t macro-level Op
4ce0: 65 6e 53 53 4c 20 73 75 70 70 6f 72 74 73 20 61  enSSL supports a
4cf0: 20 26 71 75 6f 74 3b 6e 6f 20 70 61 74 65 6e 74   &quot;no patent
4d00: 73 26 71 75 6f 74 3b 20 62 75 69 6c 64 2c 0a 77  s&quot; build,.w
4d10: 68 69 63 68 20 64 69 73 61 62 6c 65 73 20 52 53  hich disables RS
4d20: 41 2c 20 49 44 45 41 2c 20 52 43 28 32 2c 34 2c  A, IDEA, RC(2,4,
4d30: 35 29 20 61 6e 64 20 53 53 4c 32 20 2d 20 69 66  5) and SSL2 - if
4d40: 20 79 6f 75 72 20 4f 70 65 6e 53 53 4c 20 69 73   your OpenSSL is
4d50: 0a 63 6f 6e 66 69 67 75 72 65 64 20 74 68 69 73  .configured this
4d60: 20 77 61 79 20 74 68 65 6e 20 79 6f 75 20 77 69   way then you wi
4d70: 6c 6c 20 6e 65 65 64 20 74 6f 20 62 75 69 6c 64  ll need to build
4d80: 20 54 4c 53 20 77 69 74 68 20 74 68 65 0a 2d 44   TLS with the.-D
4d90: 4e 4f 5f 50 41 54 45 4e 54 53 20 6f 70 74 69 6f  NO_PATENTS optio
4da0: 6e 20 2d 20 61 6e 64 20 74 68 65 20 72 65 73 75  n - and the resu
4db0: 6c 74 61 6e 74 20 6d 6f 64 75 6c 65 20 77 69 6c  ltant module wil
4dc0: 6c 20 66 75 6e 63 74 69 6f 6e 0a 63 6f 72 72 65  l function.corre
4dd0: 63 74 6c 79 20 61 6e 64 20 61 6c 73 6f 20 73 75  ctly and also su
4de0: 70 70 6f 72 74 20 41 44 48 20 63 65 72 74 69 66  pport ADH certif
4df0: 69 63 61 74 65 2d 6c 65 73 73 20 65 6e 63 72 79  icate-less encry
4e00: 70 74 69 6f 6e 2c 0a 68 6f 77 65 76 65 72 20 79  ption,.however y
4e10: 6f 75 20 77 69 6c 6c 20 62 65 20 75 6e 61 62 6c  ou will be unabl
4e20: 65 20 74 6f 20 75 74 69 6c 69 7a 65 20 74 68 69  e to utilize thi
4e30: 73 20 74 6f 20 73 70 65 61 6b 20 74 6f 20 6e 6f  s to speak to no
4e40: 72 6d 61 6c 20 57 65 62 0a 53 65 72 76 65 72 73  rmal Web.Servers
4e50: 2c 20 77 68 69 63 68 20 74 79 70 69 63 61 6c 6c  , which typicall
4e60: 79 20 72 65 71 75 69 72 65 20 52 53 41 20 73 75  y require RSA su
4e70: 70 70 6f 72 74 2e 20 50 6c 65 61 73 65 20 73 65  pport. Please se
4e80: 65 20 3c 61 0a 68 72 65 66 3d 22 68 74 74 70 3a  e <a.href="http:
4e90: 2f 2f 77 77 77 2e 6f 70 65 6e 73 73 6c 2e 6f 72  //www.openssl.or
4ea0: 67 2f 22 3e 68 74 74 70 3a 2f 2f 77 77 77 2e 6f  g/">http://www.o
4eb0: 70 65 6e 73 73 6c 2e 6f 72 67 2f 3c 2f 61 3e 20  penssl.org/</a> 
4ec0: 66 6f 72 0a 6d 6f 72 65 20 69 6e 66 6f 72 6d 61  for.more informa
4ed0: 74 69 6f 6e 20 6f 6e 20 74 68 65 20 77 68 6f 6c  tion on the whol
4ee0: 65 20 69 73 73 75 65 20 6f 66 20 70 61 74 65 6e  e issue of paten
4ef0: 74 73 20 61 6e 64 20 55 53 20 65 78 70 6f 72 74  ts and US export
4f00: 0a 72 65 73 74 72 69 63 74 69 6f 6e 73 2e 20 3c  .restrictions. <
4f10: 2f 70 3e 0a 0a 3c 68 33 3e 3c 61 20 6e 61 6d 65  /p>..<h3><a name
4f20: 3d 22 53 45 45 20 41 4c 53 4f 22 3e 53 45 45 20  ="SEE ALSO">SEE 
4f30: 41 4c 53 4f 3c 2f 61 3e 3c 2f 68 33 3e 0a 0a 3c  ALSO</a></h3>..<
4f40: 70 3e 3c 73 74 72 6f 6e 67 3e 73 6f 63 6b 65 74  p><strong>socket
4f50: 3c 2f 73 74 72 6f 6e 67 3e 2c 20 3c 73 74 72 6f  </strong>, <stro
4f60: 6e 67 3e 66 69 6c 65 65 76 65 6e 74 2c 20 3c 2f  ng>fileevent, </
4f70: 73 74 72 6f 6e 67 3e 3c 61 0a 68 72 65 66 3d 22  strong><a.href="
4f80: 68 74 74 70 3a 2f 2f 77 77 77 2e 6f 70 65 6e 73  http://www.opens
4f90: 73 6c 2e 6f 72 67 2f 22 3e 3c 73 74 72 6f 6e 67  sl.org/"><strong
4fa0: 3e 4f 70 65 6e 53 53 4c 3c 2f 73 74 72 6f 6e 67  >OpenSSL</strong
4fb0: 3e 3c 2f 61 3e 3c 2f 70 3e 0a 0a 3c 68 72 3e 0a  ></a></p>..<hr>.
4fc0: 0a 3c 70 72 65 3e 0a 43 6f 70 79 72 69 67 68 74  .<pre>.Copyright
4fd0: 20 26 63 6f 70 79 3b 20 31 39 39 39 20 4d 61 74   &copy; 1999 Mat
4fe0: 74 20 4e 65 77 6d 61 6e 2e 0a 43 6f 70 79 72 69  t Newman..Copyri
4ff0: 67 68 74 20 26 63 6f 70 79 3b 20 32 30 30 34 20  ght &copy; 2004 
5000: 53 74 61 72 66 69 73 68 20 53 79 73 74 65 6d 73  Starfish Systems
5010: 2e 0a 3c 2f 70 72 65 3e 0a 3c 2f 62 6f 64 79 3e  ..</pre>.</body>
5020: 0a 3c 2f 68 74 6d 6c 3e 0a                       .</html>.