Index: ChangeLog
==================================================================
--- ChangeLog
+++ ChangeLog
@@ -1,5 +1,12 @@
+TclTLS 1.7.22
+==========
+
+Release Date: Mon Oct 12 15:40:16 CDT 2020
+
+https://tcltls.rkeene.org/
+
2015-05-01 Andreas Kupries <andreask@activestate.com>
* configure.in: Bump to version 1.6.5.
* win/makefile.vc:
* configure: regen with ac-2.59
Index: Makefile.in
==================================================================
--- Makefile.in
+++ Makefile.in
@@ -214,11 +214,11 @@
@echo "If you have documentation to create, place the commands to"
@echo "build the docs in the 'doc:' target. For example:"
@echo " xml2nroff sample.xml > sample.n"
@echo " xml2html sample.xml > sample.html"
-install: all install-binaries install-libraries install-doc
+install: all install-binaries install-libraries install-doc-n install-doc-html
install-binaries: binaries install-lib-binaries install-bin-binaries
#========================================================================
# This rule installs platform-independent files, such as header files.
@@ -229,23 +229,34 @@
@$(INSTALL_DATA_DIR) "$(DESTDIR)$(includedir)"
@echo "Installing header files in $(DESTDIR)$(includedir)"
@list='$(PKG_HEADERS)'; for i in $$list; do \
echo "Installing $(srcdir)/$$i" ; \
$(INSTALL_DATA) $(srcdir)/$$i "$(DESTDIR)$(includedir)" ; \
- done;
+ done
#========================================================================
# Install documentation. Unix manpages should go in the $(mandir)
# directory.
#========================================================================
+
+install-doc-html: doc
+ @$(INSTALL_DATA_DIR) "$(DESTDIR)$(pkglibdir)/html"
+ @list='$(srcdir)/doc/*.html'; for i in $$list; do \
+ if test -f $$i ; then \
+ echo "Installing $$i"; \
+ $(INSTALL_DATA) $$i "$(DESTDIR)$(pkglibdir)/html"; \
+ fi; \
+ done
-install-doc: doc
+install-doc-n: doc
@$(INSTALL_DATA_DIR) "$(DESTDIR)$(mandir)/mann"
@echo "Installing documentation in $(DESTDIR)$(mandir)"
@list='$(srcdir)/doc/*.n'; for i in $$list; do \
- echo "Installing $$i"; \
- $(INSTALL_DATA) $$i "$(DESTDIR)$(mandir)/mann" ; \
+ if test -f $$i ; then \
+ echo "Installing $$i"; \
+ $(INSTALL_DATA) $$i "$(DESTDIR)$(mandir)/mann" ; \
+ fi; \
done
test: binaries libraries
$(TCLSH) `@CYGPATH@ $(srcdir)/tests/all.tcl` $(TESTFLAGS) \
-load "package ifneeded $(PACKAGE_NAME) $(PACKAGE_VERSION) \
@@ -308,24 +319,19 @@
# As necessary, add $(srcdir):$(srcdir)/compat:....
#========================================================================
VPATH = $(srcdir):$(srcdir)/generic:$(srcdir)/unix:$(srcdir)/win:$(srcdir)/macosx
-.c.@OBJEXT@:
- $(COMPILE) -c `@CYGPATH@ $<` -o $@
-
# Create a C-source-ified version of the script resources
# for TclTLS so that we only need a single file to enable
# this extension
tls.tcl.h: @srcdir@/library/tls.tcl Makefile
od -A n -v -t xC < '@srcdir@/library/tls.tcl' > tls.tcl.h.new.1
sed 's@[^0-9A-Fa-f]@@g;s@..@0x&, @g' < tls.tcl.h.new.1 > tls.tcl.h.new.2
rm -f tls.tcl.h.new.1
mv tls.tcl.h.new.2 @srcdir@/generic/tls.tcl.h
-tls.o: tlsUuid.h
-
$(srcdir)/manifest.uuid:
printf "git-" >$(srcdir)/manifest.uuid
(cd $(srcdir); git rev-parse HEAD >>$(srcdir)/manifest.uuid || \
(printf "svn-r" >$(srcdir)/manifest.uuid ; \
svn info --show-item last-changed-revision >>$(srcdir)/manifest.uuid) || \
@@ -334,10 +340,15 @@
tlsUuid.h: $(srcdir)/manifest.uuid
echo "#define TLS_VERSION_UUID \\" >$@
cat $(srcdir)/manifest.uuid >>$@
echo "" >>$@
+tls.@OBJEXT@: tlsUuid.h tls.tcl.h
+
+.c.@OBJEXT@:
+ $(COMPILE) -c `@CYGPATH@ $<` -o $@
+
#========================================================================
# Create the pkgIndex.tcl file.
# It is usually easiest to let Tcl do this for you with pkg_mkIndex, but
# you may find that you need to customize the package. If so, either
# modify the -hand version, or create a pkgIndex.tcl.in file and have
@@ -361,13 +372,13 @@
DIST_INSTALL_DATA = CPPROG='cp -p' $(INSTALL) -m 644
DIST_INSTALL_DATA_RECUR = CPPROG='cp -p -R' $(INSTALL)
DIST_INSTALL_SCRIPT = CPPROG='cp -p' $(INSTALL) -m 755
dist-clean:
- rm -rf $(DIST_DIR) $(DIST_ROOT)/$(PKG_DIR).tar.*
+ rm -rf $(DIST_DIR) $(top_builddir)/$(PKG_DIR).tar.*
-dist: dist-clean
+dist: dist-clean $(srcdir)/manifest.uuid
# TEA files
$(INSTALL_DATA_DIR) $(DIST_DIR)
$(DIST_INSTALL_DATA) $(srcdir)/Makefile.in \
$(srcdir)/acinclude.m4 $(srcdir)/aclocal.m4 \
$(srcdir)/configure.ac $(DIST_DIR)/
@@ -396,12 +407,12 @@
$(DIST_INSTALL_DATA_RECUR) $(srcdir)/$$p/* $(DIST_DIR)/$$p/; \
fi; \
done
(cd $(DIST_ROOT); $(COMPRESS);)
+ mv $(PKG_DIR).tar.gz $(top_builddir)
cd $(top_builddir)
- mv $(DIST_ROOT)/$(PKG_DIR).tar.gz $(top_builddir)
#========================================================================
# End of user-definable section
#========================================================================
Index: configure.ac
==================================================================
--- configure.ac
+++ configure.ac
@@ -1,19 +1,16 @@
#!/bin/bash -norc
dnl This file is an input file used by the GNU "autoconf" program to
dnl generate the file "configure", which is run during Tcl installation
dnl to configure the system for the local environment.
-#
#-----------------------------------------------------------------------
# This is the configure.ac for the TclTLS extension. The only places you
# should need to modify this file are marked by the string __CHANGE__.
#-----------------------------------------------------------------------
#-----------------------------------------------------------------------
-# Set your package name and version numbers here.
-#
# This initializes the environment with PACKAGE_NAME and PACKAGE_VERSION
# set as provided. These will also be added as -D defs in your Makefile
# so you can encode the package version directly into the source files.
# This will also define a special symbol for Windows (BUILD_<PACKAGE_NAME>
# so that we create the export library with the dll.
@@ -60,11 +57,10 @@
#-----------------------------------------------------------------------
TEA_SETUP_COMPILER
#-----------------------------------------------------------------------
-# __CHANGE__
# Specify the C source files to compile in TEA_ADD_SOURCES,
# public headers that need to be installed in TEA_ADD_HEADERS,
# stub library C source files to compile in TEA_ADD_STUB_SOURCES,
# and runtime Tcl library files in TEA_ADD_TCL_SOURCES.
# This defines PKG(_STUB)_SOURCES, PKG(_STUB)_OBJECTS, PKG_HEADERS
@@ -75,30 +71,29 @@
TEA_ADD_HEADERS([generic/tls.h])
TEA_ADD_INCLUDES([])
TEA_ADD_LIBS([])
TEA_ADD_CFLAGS([])
TEA_ADD_STUB_SOURCES([])
-TEA_ADD_TCL_SOURCES([library/tls.tcl])
+TEA_ADD_TCL_SOURCES([library/tls.tcl license.terms README.txt])
#--------------------------------------------------------------------
-#
# You can add more files to clean if your extension creates any extra
# files by extending CLEANFILES.
# Add pkgIndex.tcl if it is generated in the Makefile instead of ./configure
# and change Makefile.in to move it from CONFIG_CLEAN_FILES to BINARIES var.
#
# A few miscellaneous platform-specific items:
# TEA_ADD_* any platform specific compiler/build info here.
#--------------------------------------------------------------------
-CONFIG_CLEAN_FILES="$CONFIG_CLEAN_FILES tls.tcl.h.* config.log config.status Makefile pkgIndex.tcl tcltls.a.linkadd tcltls.syms"
+TEA_ADD_CLEANFILES([pkgIndex.tcl tls.tcl.h.*])
+
if test "${TEA_PLATFORM}" = "windows" ; then
AC_DEFINE(BUILD_tls)
- AC_DEFINE(WINDOWS)
- CLEANFILES="pkgIndex.tcl *.lib *.dll *.exp *.ilk *.pdb vc*.pch"
+ TEA_ADD_CLEANFILES([*.lib *.dll *.exp *.ilk *.pdb vc*.pch])
else
- CLEANFILES="pkgIndex.tcl *.so"
+ TEA_ADD_CLEANFILES([*.so])
fi
AC_SUBST(CLEANFILES)
#--------------------------------------------------------------------
# Choose which headers you need. Extension authors should try very
Index: doc/tls.html
==================================================================
--- doc/tls.html
+++ doc/tls.html
@@ -7,37 +7,37 @@
<link rel="stylesheet" href="docs.css" type="text/css" media="all">
</head>
<body class="vsc-initialized">
-<h2>Tcl Tls Extension Documentation</h2>
+<h2>TCL Tls Extension Documentation</h2>
<dl>
<dd><a href="#NAME">NAME</a>
<dl>
<dd><b>tls</b> - binding to <b>OpenSSL</b> library
- for socket and I/O channel communications.</dd>
+ for encrypted socket and I/O channel communications.</dd>
</dl>
</dd>
<dd><a href="#SYNOPSIS">SYNOPSIS</a> </dd>
<dd><dl>
- <dd><b>package require Tcl</b> <em>?<b>8.5</b>?</em></dd>
- <dd><b>package require tls</b></dd>
- <dt> </dt>
- <dd><b>tls::init</b> <em>?options?</em> </dd>
- <dd><b>tls::socket</b> <em>?options? host port</em></dd>
- <dd><b>tls::socket</b> <em>?-server command? ?options? port</em></dd>
- <dd><b>tls::handshake</b> <em> channel</em></dd>
- <dd><b>tls::status</b> <em>?-local? channel</em></dd>
- <dd><b>tls::connection</b> <em>channel</em></dd>
- <dd><b>tls::import</b> <em>channel ?options?</em></dd>
- <dd><b>tls::unimport</b> <em>channel</em></dd>
- <dt> </dt>
- <dd><b>tls::protocols</b></dd>
- <dd><b>tls::version</b></dd>
- </dl>
- </dd>
+ <dd><b>package require Tcl</b> <em>?<b>8.5-</b>?</em></dd>
+ <dd><b>package require tls</b> <em>?<b>1.8-</b>?</em></dd>
+ <dt> </dt>
+ <dd><b>tls::init</b> <em>?options?</em> </dd>
+ <dd><b>tls::socket</b> <em>?options? host port</em></dd>
+ <dd><b>tls::socket</b> <em>?-server command? ?options? port</em></dd>
+ <dd><b>tls::handshake</b> <em> channel</em></dd>
+ <dd><b>tls::status</b> <em>?-local? channel</em></dd>
+ <dd><b>tls::connection</b> <em>channel</em></dd>
+ <dd><b>tls::import</b> <em>channel ?options?</em></dd>
+ <dd><b>tls::unimport</b> <em>channel</em></dd>
+ <dt> </dt>
+ <dd><b>tls::ciphers</b> <em>?protocol? ?verbose? ?supported?</em></dd>
+ <dd><b>tls::protocols</b></dd>
+ <dd><b>tls::version</b></dd>
+ </dl></dd>
<dd><a href="#COMMANDS">COMMANDS</a></dd>
<dd><a href="#CALLBACK OPTIONS">CALLBACK OPTIONS</a></dd>
<dd><a href="#HTTPS EXAMPLE">HTTPS EXAMPLE</a></dd>
<dd><a href="#SEE ALSO">SPECIAL CONSIDERATIONS</a></dd>
<dd><a href="#SEE ALSO">SEE ALSO</a></dd>
@@ -46,16 +46,18 @@
<hr>
<h3><a name="NAME">NAME</a></h3>
<p><strong>tls</strong> - binding to <strong>OpenSSL</strong> library
-for socket and I/O channel communications.</p>
+for encrypted socket and I/O channel communications.</p>
+
+<hr>
<h3><a name="SYNOPSIS">SYNOPSIS</a></h3>
-<p><b>package require Tcl</b> <em>?<b>8.5</b>?</em><br>
-<b>package require tls</b><br>
+<p><b>package require Tcl</b> <em>?<b>8.5-</b>?</em><br>
+<b>package require tls</b> <em>?<b>1.8-</b>?</em><br>
<br>
<a href="#tls::init"><b>tls::init</b> <i>?options?</i></a><br>
<a href="#tls::socket"><b>tls::socket</b> <i>?options? host port</i><br>
<a href="#tls::socket"><b>tls::socket</b> <i>?-server command? ?options? port</i></a><br>
<a href="#tls::status"><b>tls::status</b> <i>?-local? channel</i></a><br>
@@ -62,149 +64,140 @@
<a href="#tls::connection"><b>tls::connection</b> <i>channel</i></a><br>
<a href="#tls::handshake"><b>tls::handshake</b> <i>channel</i></a><br>
<a href="#tls::import"><b>tls::import</b> <i>channel ?options?</i></a><br>
<a href="#tls::unimport"><b>tls::unimport</b> <i>channel</i></a><br>
<br>
+<a href="#tls::ciphers"><b>tls::ciphers</b> <i>?protocol? ?verbose? ?supported?</i></a><br>
<a href="#tls::protocols"><b>tls::protocols</b></a><br>
<a href="#tls::version"><b>tls::version</b></a><br>
</p>
+
+<hr>
<h3><a name="DESCRIPTION">DESCRIPTION</a></h3>
<p>This extension provides TCL script access to secure socket communications
using the Transport Layer Security (TLS) protocol. It provides a generic
-binding to <a href="http://www.openssl.org/">OpenSSL</a>, utilizing the
-<strong>Tcl_StackChannel</strong> API in Tcl 8.4 and higher.
+binding to <a href="https://www.openssl.org/">OpenSSL</a>, utilizing the
+<strong>Tcl_StackChannel</strong> API in TCL 8.4 and higher.
These sockets behave exactly the same as channels created using the built-in
<strong>socket</strong> command, along with additional options for controlling
-the SSL session.
+the SSL/TLS session.
</p>
+
+<hr>
<h3><a name="COMMANDS">COMMANDS</a></h3>
<p>Typically one would use the <strong>tls::socket </strong>command
-which provides compatibility with the native Tcl <strong>socket</strong>
+which provides compatibility with the native TCL <strong>socket</strong>
command. In such cases <strong>tls::import</strong> should not be
used directly.</p>
-
<dl>
<dt><a name="tls::init"><b>tls::init </b><i>?options?</i></a></dt>
<dd>Optional function to set the default options used by
<strong>tls::socket</strong>. If you call <strong>tls::import</strong>
- directly this routine has no effect. Any of the options
- that <strong>tls::socket</strong> accepts can be set
- using this command, though you should limit your options
- to only TLS related ones.</dd>
+ directly, this command has no effect. This command supports all of the
+ same options as the <strong>tls::socket</strong> command, though you
+ should limit your options to only TLS related ones.</dd>
<dt> </dt>
<dt><a name="tls::socket"><b>tls::socket </b><em>?options?
host port</em></a></dt>
<dt><b>tls::socket</b><em> ?-server command? ?options? port</em></dt>
- <dd>This is a helper function that utilizes the underlying
- commands (<strong>tls::import</strong>). It behaves
- exactly the same as the native Tcl <strong>socket</strong>
- command except the options can also include any of the
- applicable <a href="#tls::import"><strong>tls:import</strong></a>
- options with one additional option:</dd>
-<blockquote>
- <dl>
+ <dd>This is a helper function that utilizes the underlying commands
+ (<strong>socket</strong> and <strong>tls::import</strong>) to create
+ the connection. It behaves the same as the native TCL <strong>socket</strong>
+ command, but also supports the <a href="#tls::import"><strong>tls:import</strong></a>
+ command options and one additional option:</dd>
+ <dl><blockquote>
<dt><strong>-autoservername</strong> <em>bool</em></dt>
<dd>Automatically set the -servername argument to the <em>host</em>
- argument (default is <em>false</em>).</dd>
- </dl>
-</blockquote>
+ argument (default is <em>false</em>).</dd>
+ </blockquote></dl>
<dt><a name="tls::import"><b>tls::import </b><i>channel
?options?</i></a></dt>
- <dd>Add SSL/TLS encryption to a regular Tcl channel. It need
+ <dd>Add SSL/TLS encryption to a regular TCL channel. It need
not be a socket, but must provide bi-directional flow. Also
set session parameters for SSL handshake.</dd>
-
-<blockquote>
- <dl>
+ <dl><blockquote>
<dt><strong>-alpn</strong> <em>list</em></dt>
<dd>List of protocols to offer during Application-Layer
Protocol Negotiation (ALPN). For example: <em>h2</em> and
<em>http/1.1</em>, but not <em>h3</em> or <em>quic</em>.</dd>
<dt><strong>-cadir</strong> <em>dir</em></dt>
- <dd>Set the CA certificates path. The default directory is platform
- specific and can be set at compile time. This can be overridden
- via the <b>SSL_CERT_DIR</b> environment variable.</dd>
+ <dd>Specifies the directory where the Certificate Authority (CA)
+ certificates are stored. The default is platform specific and can be
+ set at compile time. This can be overridden via the <b>SSL_CERT_DIR</b>
+ environment variable.</dd>
<dt><strong>-cafile </strong><em>filename</em></dt>
- <dd>Set the certificate authority (CA) certificates file. The default
- is the cert.pem file in the OpsnSSL directory. This can also be
- overridden via the <b>SSL_CERT_FILE</b> environment variable.</dd>
+ <dd>Specifies the file with the Certificate Authority (CA) certificates
+ to use. The default is <b>cert.pem</b>, in the OpenSSL directory. This can
+ also be overridden via the <b>SSL_CERT_FILE</b> environment variable.</dd>
<dt><strong>-certfile</strong> <em>filename</em></dt>
- <dd>Specify the filename with the certificate to use.</dd>
- <dt><strong>-cert</strong> <em>filename</em></dt>
- <dd>Specify the contents of a certificate to use, as a DER
- encoded binary value (X.509 DER).</dd>
+ <dd>Specifies the file with the certificate to use in PEM format.
+ This also contains the public key.</dd>
+ <dt><strong>-cert</strong> <em>binary_string</em></dt>
+ <dd>Specifies the certificate to use as a DER encoded string (X.509 DER).</dd>
<dt><strong>-cipher</strong> <em>string</em></dt>
- <dd>List of ciphers to use. String is a colon (":") separated list
- of ciphers. Ciphers can be combined
- using the <b>+</b> character. Prefixes can be used to permanently
- remove ("!"), delete ("-"), or move a cypher to the end of
- the list ("+"). Keywords <b>@STRENGTH</b> (sort by algorithm
- key length), <b>@SECLEVEL=</b><i>n</i> (set security level to
- n), and <b>DEFAULT</b> (use default cipher list, at start only)
- can also be specified. See OpenSSL documentation for the full
- list of valid values. (TLS 1.2 and earlier only)</dd>
+ <dd>Specifies the list of ciphers to use for TLS 1.2 and earlier. String is a
+ colon (":") separated list of ciphers. Ciphers can be combined using the
+ <b>+</b> character. Prefixes can be used to permanently remove ("!"),
+ delete ("-"), or move a cipher to the end of the list ("+"). Keywords
+ <b>@STRENGTH</b> (sort by algorithm key length), <b>@SECLEVEL=</b><i>n</i>
+ (set security level to n), and <b>DEFAULT</b> (use default cipher list,
+ at start only) can also be specified. See OpenSSL documentation for the
+ full list of valid values.</dd>
<dt><strong>-ciphersuites</strong> <em>string</em></dt>
- <dd>List of cipher suites to use. String is a colon (":")
- separated list of cipher suite names. (TLS 1.3 only)</dd>
+ <dd>Specifies the list of cipher suites to use for TLS 1.3. String is a colon
+ (":") separated list of cipher suite names.</dd>
<dt><strong>-command</strong> <em>callback</em></dt>
- <dd>Callback command to invoke at several points during the handshake.
- This is used to pass errors and tracing information, and
- it can allow Tcl scripts to perform their own certificate
- validation in place of the default validation provided by
- OpenSSL. See <a href="#CALLBACK OPTIONS">CALLBACK OPTIONS</a>
- for further discussion.</dd>
+ <dd>Specifies the callback command to be invoked at several points during the
+ handshake to pass errors, tracing information, and protocol messages.
+ See <a href="#CALLBACK OPTIONS">CALLBACK OPTIONS</a> for more info.</dd>
<dt><strong>-dhparams </strong><em>filename</em></dt>
- <dd>Specify the Diffie-Hellman parameters file.</dd>
+ <dd>Specifies the Diffie-Hellman (DH) parameters file.</dd>
<dt><strong>-keyfile</strong> <em>filename</em></dt>
- <dd>Specify the private key file. (default is
- value of -certfile)</dd>
+ <dd>Specifies the private key file. (default is value of -certfile).</dd>
<dt><strong>-key</strong> <em>filename</em></dt>
- <dd>Specify the private key to use as a DER encoded value (PKCS#1 DER)</dd>
+ <dd>Specifies the private key to use as a DER encoded string (PKCS#1 DER).</dd>
<dt><strong>-model</strong> <em>channel</em></dt>
<dd>Force this channel to share the same <em><strong>SSL_CTX</strong></em>
structure as the specified <em>channel</em>, and
therefore share callbacks etc.</dd>
<dt><strong>-password</strong> <em>callback</em></dt>
- <dd>Callback command to invoke when OpenSSL needs to obtain a password.
- Typically used to unlock the private key of a certificate. The
- callback should return a string which represents the password
- to be used. See <a href="#CALLBACK OPTIONS">CALLBACK OPTIONS</a>
- for further discussion.</dd>
+ <dd>Specifies the callback command to invoke when OpenSSL needs to
+ obtain a password. This is typically used to unlock the private key of
+ a certificate. The callback should return a password string.
+ See <a href="#CALLBACK OPTIONS">CALLBACK OPTIONS</a> for more info.</dd>
<dt><strong>-post_handshake</strong> <em>bool</em></dt>
- <dd>Allow post-handshake ticket updates.</dd>
+ <dd>Allow post-handshake session ticket updates.</dd>
<dt><strong>-request </strong><em>bool</em></dt>
- <dd>Request a certificate from peer during SSL handshake.
- (default is <em>true</em>)</dd>
+ <dd>Request a certificate from peer during the SSL handshake. This is
+ needed to do certificate validation. (default is <em>true</em>)</dd>
<dt><strong>-require</strong> <em>bool</em></dt>
- <dd>Require a valid certificate from peer during SSL handshake.
- If this is set to true, then <strong>-request</strong> must
- also be set to true and a either a -cadir, -cafile, or platform
- default must be provided in order to validate against.
- (default is <em>false</em>)</dd>
+ <dd>Require a valid certificate from peer during SSL handshake. If this
+ is set to true, then <strong>-request</strong> must also be set to true
+ and a either a -cadir, -cafile, or platform default must be provided in
+ order to validate against. (default is <em>false</em>)</dd>
<dt><strong>-security_level</strong> <em>integer</em></dt>
- <dd>Set security level. Must be 0 to 5. The security level affects
- the cipher suite encryption algorithms, supported ECC curves,
- supported signature algorithms, DH parameter sizes, certificate
- key sizes and signature algorithms. The default is 1.
- Level 3 and higher disable support for session tickets and only
- accept cipher suites that provide forward secrecy.</dd>
+ <dd>Specifies the security level (value from 0 to 5). The security level
+ affects the cipher suite encryption algorithms, supported ECC curves,
+ supported signature algorithms, DH parameter sizes, certificate key
+ sizes and signature algorithms. The default is 1. Level 3 and higher
+ disable support for session tickets and only accept cipher suites that
+ provide forward secrecy.</dd>
<dt><strong>-server</strong> <em>bool</em></dt>
- <dd>Set to act as a server and respond with a server handshake when
- a client connects and provides a client handshake.
+ <dd>Specifies whether to act as a server and respond with a server
+ handshake when a client connects and provides a client handshake.
(default is <em>false</em>)</dd>
<dt><strong>-servername</strong> <em>host</em></dt>
- <dd>Specify server's hostname. Used to set the TLS 'Server Name
- Indication' (SNI) extension. Set to the expected servername
- in the server's certificate or one of the subjectAltName
- alternates.</dd>
+ <dd>Specify server's hostname. This is used to set the TLS Server Name
+ Indication (SNI) extension. Set this to the expected servername in the
+ server's certificate or one of the subjectAltName alternates.</dd>
<dt><strong>-session_id</strong> <em>string</em></dt>
- <dd>Session id to resume session.</dd>
+ <dd>Specifies the session id to resume session.</dd>
<dt><strong>-ssl2</strong> <em>bool</em></dt>
<dd>Enable use of SSL v2. (default is <em>false</em>)</dd>
<dt><strong>-ssl3 </strong><em>bool</em></dt>
<dd>Enable use of SSL v3. (default is <em>false</em>)</dd>
<dt>-<strong>tls1</strong> <em>bool</em></dt>
@@ -214,44 +207,44 @@
<dt>-<strong>tls1.2</strong> <em>bool</em></dt>
<dd>Enable use of TLS v1.2 (default is <em>true</em>)</dd>
<dt>-<strong>tls1.3</strong> <em>bool</em></dt>
<dd>Enable use of TLS v1.3 (default is <em>true</em>)</dd>
<dt><strong>-validatecommand</strong> <em>callback</em></dt>
- <dd>Callback command to invoke to verify or validate protocol config
- parameters during the protocol negotiation phase. See
- <a href="#CALLBACK OPTIONS">CALLBACK OPTIONS</a>
- for further discussion.</dd>
- </dl>
-</blockquote>
-
+ <dd>Specifies the callback command to invoke to validate protocol
+ config parameters during the protocol negotiation phase. This can be
+ used by TCL scripts to perform their own certificate validation to
+ supplement the default validation provided by OpenSSL. The script must
+ return a boolean true to continue the negotiation. See
+ <a href="#CALLBACK OPTIONS">CALLBACK OPTIONS</a> for more info.</dd>
+ </blockquote></dl>
<dt><a name="tls::unimport"><b>tls::unimport </b><i>channel</i></a></dt>
<dd>Provided for symmetry to <strong>tls::import</strong>, this
- unstacks the encryption of a regular Tcl channel. An error
- is thrown if TLS is not the top stacked channel type.</dd>
+ unstacks the encryption of a regular TCL channel. An error
+ is thrown if TLS is not the top stacked channel type.</dd>
<dt> </dt>
<dt><a name="tls::handshake"><strong>tls::handshake</strong>
<em>channel</em></a></dt>
<dd>Forces handshake to take place, and returns 0 if
handshake is still in progress (non-blocking), or 1 if
the handshake was successful. If the handshake failed
this routine will throw an error.</dd>
<dt> </dt>
<dt><a name="tls::status"><strong>tls::status</strong>
- <em>?</em><b>-local</b><em>? channel</em></a></dt>
+ <em>?</em><b>-local</b><em>? channel</em></a></dt>
<dd>Returns the current status of an SSL channel. The result is a list
of key-value pairs describing the SSL, certificate, and certificate
verification status. If the SSL handshake has not yet completed,
an empty list is returned. If <b>-local</b> is specified, then the
local certificate is used.</dd>
-<blockquote>
- <b>SSL Status</b>
+ <blockquote>
+ <b>SSL Status</b>
<dl>
<dt><strong>alpn</strong> <em>protocol</em></dt>
<dd>The protocol selected after Application-Layer Protocol
Negotiation (ALPN).</dd>
<dt><strong>cipher</strong> <em>cipher</em></dt>
- <dd>The current cipher in use between for the channel.</dd>
+ <dd>The current cipher in use for the session.</dd>
<dt><strong>peername</strong> <em>name</em></dt>
<dd>The peername from the certificate.</dd>
<dt><strong>protocol</strong> <em>version</em></dt>
<dd>The protocol version used for the connection:
SSL2, SSL3, TLS1, TLS1.1, TLS1.2, TLS1.3, or unknown.</dd>
@@ -269,38 +262,34 @@
<dt><strong>verifyResult</strong> <em>result</em></dt>
<dd>Certificate verification result.</dd>
<dt><strong>ca_names</strong> <em>list</em></dt>
<dd>List of the Certificate Authorities used to create the certificate.</dd>
</dl>
-</blockquote>
-<blockquote>
- <b>Certificate Status</b>
+ <b>Certificate Status</b>
<dl>
<dt><strong>all</strong> <em>string</em></dt>
<dd>Dump of all certificate info.</dd>
-
<dt><strong>version</strong> <em>value</em></dt>
<dd>The certificate version.</dd>
<dt><strong>serialNumber</strong> <em>n</em></dt>
<dd>The serial number of the certificate as a hex string.</dd>
<dt><strong>signature</strong> <em>algorithm</em></dt>
<dd>Cipher algorithm used for certificate signature.</dd>
<dt><strong>issuer</strong> <em>dn</em></dt>
<dd>The distinguished name (DN) of the certificate issuer.</dd>
<dt><strong>notBefore</strong> <em>date</em></dt>
- <dd>The begin date for the validity of the certificate.</dd>
+ <dd>The beginning date of the certificate validity.</dd>
<dt><strong>notAfter</strong> <em>date</em></dt>
- <dd>The expiration date for the certificate.</dd>
+ <dd>The expiration date of the certificate validity.</dd>
<dt><strong>subject</strong> <em>dn</em></dt>
<dd>The distinguished name (DN) of the certificate subject.
Fields include: Common Name (CN), Organization (O), Locality
or City (L), State or Province (S), and Country Name (C).</dd>
<dt><strong>issuerUniqueID</strong> <em>string</em></dt>
<dd>The issuer unique id.</dd>
<dt><strong>subjectUniqueID</strong> <em>string</em></dt>
<dd>The subject unique id.</dd>
-
<dt><strong>num_extensions</strong> <em>n</em></dt>
<dd>Number of certificate extensions.</dd>
<dt><strong>extensions</strong> <em>list</em></dt>
<dd>List of certificate extension names.</dd>
<dt><strong>authorityKeyIdentifier</strong> <em>string</em></dt>
@@ -307,21 +296,19 @@
<dd>(AKI) Key identifier of the Issuing CA certificate that signed
the SSL certificate as a hex string. This value matches the SKI
value of the Intermediate CA certificate.</dd>
<dt><strong>subjectKeyIdentifier</strong> <em>string</em></dt>
<dd>(SKI) Hash of the public key inside the certificate as a hex
- string. Used to identify certificates that contain a particular
- public key.</dd>
+ string. Used to identify certificates that contain a particular
+ public key.</dd>
<dt><strong>subjectAltName</strong> <em>list</em></dt>
<dd>List of all of the alternative domain names, sub domains,
and IP addresses that are secured by the certificate.</dd>
<dt><strong>ocsp</strong> <em>list</em></dt>
<dd>List of all Online Certificate Status Protocol (OCSP) URLs.</dd>
-
<dt><strong>certificate</strong> <em>cert</em></dt>
<dd>The PEM encoded certificate.</dd>
-
<dt><strong>signatureAlgorithm</strong> <em>algorithm</em></dt>
<dd>Cipher algorithm used for the certificate signature.</dd>
<dt><strong>signatureValue</strong> <em>string</em></dt>
<dd>Certificate signature as a hex string.</dd>
<dt><strong>signatureDigest</strong> <em>version</em></dt>
@@ -332,24 +319,23 @@
<dd>Certificate signature public key as a hex string.</dd>
<dt><strong>bits</strong> <em>n</em></dt>
<dd>Number of bits used for certificate signature key.</dd>
<dt><strong>self_signed</strong> <em>boolean</em></dt>
<dd>Whether the certificate signature is self signed.</dd>
-
<dt><strong>sha1_hash</strong> <em>hash</em></dt>
<dd>The SHA1 hash of the certificate as a hex string.</dd>
<dt><strong>sha256_hash</strong> <em>hash</em></dt>
<dd>The SHA256 hash of the certificate as a hex string.</dd>
</dl>
-</blockquote>
+ </blockquote>
<dt><a name="tls::connection"><strong>tls::connection</strong>
<em>channel</em></a></dt>
<dd>Returns the current connection status of an SSL channel. The
result is a list of key-value pairs describing the connection.</dd>
-<blockquote>
- <b>SSL Status</b>
+ <blockquote>
+ <b>SSL Status</b>
<dl>
<dt><strong>state</strong> <em>state</em></dt>
<dd>State of the connection.</dd>
<dt><strong>servername</strong> <em>name</em></dt>
<dd>The name of the connected to server.</dd>
@@ -369,13 +355,11 @@
<dt><strong>expansion</strong> <em>mode</em></dt>
<dd>Expansion method.</dd>
<dt><strong>caList</strong> <em>list</em></dt>
<dd>List of Certificate Authorities (CA) for X.509 certificate.</dd>
</dl>
-</blockquote>
-<blockquote>
- <b>Cipher Info</b>
+ <b>Cipher Info</b>
<dl>
<dt><strong>cipher</strong> <em>cipher</em></dt>
<dd>The current cipher in use for the connection.</dd>
<dt><strong>standard_name</strong> <em>name</em></dt>
<dd>The standard RFC name of cipher.</dd>
@@ -385,21 +369,19 @@
<dd>The number of secret bits used for cipher.</dd>
<dt><strong>min_version</strong> <em>version</em></dt>
<dd>The minimum protocol version for cipher.</dd>
<dt><strong>cipher_is_aead</strong> <em>boolean</em></dt>
<dd>Whether the cipher is Authenticated Encryption with
- Associated Data (AEAD).</dd>
+ Associated Data (AEAD).</dd>
<dt><strong>cipher_id</strong> <em>id</em></dt>
<dd>The OpenSSL cipher id.</dd>
<dt><strong>description</strong> <em>string</em></dt>
<dd>A text description of the cipher.</dd>
<dt><strong>handshake_digest</strong> <em>boolean</em></dt>
<dd>Digest used during handshake.</dd>
</dl>
-</blockquote>
-<blockquote>
- <b>Session Info</b>
+ <b>Session Info</b>
<dl>
<dt><strong>alpn</strong> <em>protocol</em></dt>
<dd>The protocol selected after Application-Layer Protocol
Negotiation (ALPN).</dd>
<dt><strong>resumable</strong> <em>boolean</em></dt>
@@ -419,21 +401,34 @@
<dt><strong>master_key</strong> <em>binary_string</em></dt>
<dd>Unique session master key.</dd>
<dt><strong>session_cache_mode</strong> <em>mode</em></dt>
<dd>Server cache mode (client, server, or both).</dd>
</dl>
-</blockquote>
+ </blockquote>
+ <dt><a name="tls::ciphers"><strong>tls::ciphers</strong>
+ <em>?protocol? ?verbose? ?supported?</em></a></dt>
+ <dd>Without any args, returns a list of all symmetric ciphers for use
+ with the <strong>-cipher</strong> option. With <em>protocol</em>,
+ only the ciphers supported for that protocol are returned. See
+ <a href="#tls::protocols"><strong>tls::protocols</strong></a> command
+ for the supported protocols. If <em>verbose</em> is specified as true
+ then a verbose, human readable list is returned with additional
+ information on the cipher. If <em>supported</em> is specified as true,
+ then only the ciphers supported for protocol will be listed.</dd>
+ <dt> </dt>
<dt><a name="tls::protocols"><strong>tls::protocols</strong></a></dt>
- <dd>Returns a list of the supported protocols. Valid values are:
+ <dd>Returns a list of the supported SSL/TLS protocols. Valid values are:
<b>ssl2</b>, <b>ssl3</b>, <b>tls1</b>, <b>tls1.1</b>, <b>tls1.2</b>,
and <b>tls1.3</b>. Exact list depends on OpenSSL version and
compile time flags.</dd>
-
+ <dt> </dt>
<dt><a name="tls::version"><strong>tls::version</strong></a></dt>
<dd>Returns the OpenSSL version string.</dd>
</dl>
+
+<hr>
<h3><a name="CALLBACK OPTIONS">CALLBACK OPTIONS</a></h3>
<p>
As indicated above, individual channels can be given their own callbacks
@@ -443,251 +438,223 @@
<strong>tls::socket</strong> or <strong>tls::import</strong>.
If the callback generates an error, the <b>bgerror</b> command will be
invoked with the error information.
</p>
-<blockquote>
<dl>
-
<dt><strong>-command</strong> <em>callback</em></dt>
<dd>
Invokes the specified <em>callback</em> script at several points
during the OpenSSL handshake and use. See below for the possible
arguments passed to the callback script. Values returned from the
callback are ignored.
-
- <br>
- <br>
-
- <dl>
-
- <dt>
- <strong>error</strong> <em>channelId message</em>
- </dt>
- <dd>
- This form of callback is invoked whenever an error occurs during the
- initial connection, handshake, or I/O operations. The <em>message</em>
- argument can be from the Tcl_ErrnoMsg, OpenSSL function
- <code>ERR_reason_error_string()</code>, or a custom message.
- </dd>
-
- <br>
-
- <dt>
- <strong>info</strong> <em>channelId major minor message type</em>
- </dt>
- <dd>
- This form of callback is invoked by the OpenSSL function
- <code>SSL_set_info_callback()</code> during the initial connection
- and handshake operations. The <em>type</em> argument is new for
- TLS 1.8. The arguments are:
- <br>
- <ul>
- <li>Possible values for <em>major</em> are:
- <code>handshake, alert, connect, accept</code>.</li>
- <li>Possible values for <em>minor</em> are:
- <code>start, done, read, write, loop, exit</code>.</li>
- <li>The <em>message</em> argument is a descriptive string which may
- be generated either by <code>SSL_state_string_long()</code> or by
- <code>SSL_alert_desc_string_long()</code>, depending on the context.</li>
- <li>For alerts, the possible values for <em>type</em> are:
- <code>warning, fatal, and unknown</code>. For others,
- <code>info</code> is used.</li>
- </ul>
- </dd>
-
- <dt>
- <strong>message</strong> <em>channelId direction version content_type message</em>
- </dt>
- <dd>
- This form of callback is invoked by the OpenSSL function
- <code>SSL_set_msg_callback()</code> whenever a message is sent or
- received during the initial connection, handshake, or I/O operations.
- It is only available when OpenSSL is complied with the
- <em>enable-ssl-trace</em> option. Arguments are: <em>direction</em>
- is <b>Sent</b> or <b>Received</b>, <em>version</em> is the protocol
- version, <em>content_type</em> is the message content type, and
- <em>message</em> is more info from the <code>SSL_trace</code> API.
- This callback is new for TLS 1.8.
- </dd>
- <br>
-
- <dt>
- <strong>session</strong> <em>channelId session_id ticket lifetime</em>
- </dt>
- <dd>
- This form of callback is invoked by the OpenSSL function
- <code>SSL_CTX_sess_set_new_cb()</code> whenever a new session id is
- sent by the server during the initial connection and handshake, but
- can also be received later if the <b>-post_handshake</b> option is
- used. Arguments are: <em>session_id</em> is the current
- session identifier, <em>ticket</em> is the session ticket info, and
- <em>lifetime</em> is the the ticket lifetime in seconds.
- This callback is new for TLS 1.8.
- </dd>
- <br>
- </dl>
- </dd>
-
- <br>
-
+ <br>
+ <dl>
+ <dt>
+ <strong>error</strong> <em>channelId message</em>
+ </dt>
+ <dd>
+ This form of callback is invoked whenever an error occurs during the
+ initial connection, handshake, or I/O operations. The <em>message</em>
+ argument can be from the Tcl_ErrnoMsg, OpenSSL function
+ <code>ERR_reason_error_string()</code>, or a custom message.
+ </dd>
+ <br>
+ <dt>
+ <strong>info</strong> <em>channelId major minor message type</em>
+ </dt>
+ <dd>
+ This form of callback is invoked by the OpenSSL function
+ <code>SSL_set_info_callback()</code> during the initial connection
+ and handshake operations. The <em>type</em> argument is new for
+ TLS 1.8. The arguments are:
+ <br>
+ <ul>
+ <li>Possible values for <em>major</em> are:
+ <code>handshake, alert, connect, accept</code>.</li>
+ <li>Possible values for <em>minor</em> are:
+ <code>start, done, read, write, loop, exit</code>.</li>
+ <li>The <em>message</em> argument is a descriptive string which may
+ be generated either by <code>SSL_state_string_long()</code> or by
+ <code>SSL_alert_desc_string_long()</code>, depending on the context.</li>
+ <li>For alerts, the possible values for <em>type</em> are:
+ <code>warning, fatal, and unknown</code>. For others,
+ <code>info</code> is used.</li>
+ </ul>
+ </dd>
+ <dt>
+ <strong>message</strong> <em>channelId direction version content_type message</em>
+ </dt>
+ <dd>
+ This form of callback is invoked by the OpenSSL function
+ <code>SSL_set_msg_callback()</code> whenever a message is sent or
+ received during the initial connection, handshake, or I/O operations.
+ It is only available when OpenSSL is complied with the
+ <em>enable-ssl-trace</em> option. Arguments are: <em>direction</em>
+ is <b>Sent</b> or <b>Received</b>, <em>version</em> is the protocol
+ version, <em>content_type</em> is the message content type, and
+ <em>message</em> is more info from the <code>SSL_trace</code> API.
+ This callback is new for TLS 1.8.
+ </dd>
+ <br>
+ <dt>
+ <strong>session</strong> <em>channelId session_id ticket lifetime</em>
+ </dt>
+ <dd>
+ This form of callback is invoked by the OpenSSL function
+ <code>SSL_CTX_sess_set_new_cb()</code> whenever a new session id is
+ sent by the server during the initial connection and handshake, but
+ can also be received later if the <b>-post_handshake</b> option is
+ used. Arguments are: <em>session_id</em> is the current
+ session identifier, <em>ticket</em> is the session ticket info, and
+ <em>lifetime</em> is the the ticket lifetime in seconds.
+ This callback is new for TLS 1.8.
+ </dd>
+ </dl>
+ </dd>
+</dl>
+<br>
+<dl>
<dt><strong>-password</strong> <em>callback</em></dt>
<dd>
Invokes the specified <em>callback</em> script when OpenSSL needs to
obtain a password. See below for the possible arguments passed to
the callback script. See below for valid return values.
-
<br>
- <br>
-
<dl>
-
- <dt>
- <strong>password</strong> <em>rwflag size</em>
- </dt>
- <dd>
- Invoked when loading or storing a PEM certificate with encryption.
- Where <em>rwflag</em> is 0 for reading/decryption or 1 for
- writing/encryption (can prompt user to confirm) and
- <em>size</em> is the max password length in bytes.
- The callback should return the password as a string.
- Both arguments are new for TLS 1.8.
- </dd>
- </dd>
-
- <br>
-
-
+ <dt>
+ <strong>password</strong> <em>rwflag size</em>
+ </dt>
+ <dd>
+ Invoked when loading or storing a PEM certificate with encryption.
+ Where <em>rwflag</em> is 0 for reading/decryption or 1 for
+ writing/encryption (can prompt user to confirm) and <em>size</em> is
+ the max password length in bytes. The callback should return the
+ password as a string. Both arguments are new for TLS 1.8.
+ </dd>
+ </dl>
+ </dd>
+</dl>
+<br>
+<dl>
<dt><strong>-validatecommand</strong> <em>callback</em></dt>
<dd>
Invokes the specified <em>callback</em> script during handshake in
order to validate the provided value(s). See below for the possible
arguments passed to the callback script. If not specified, OpenSSL
will accept valid certificates and extensions.
To reject the value and abort the connection, the callback should return 0.
To accept the value and continue the connection, it should return 1.
To reject the value, but continue the connection, it should return 2.
-
<br>
- <br>
-
<dl>
-
- <dt>
- <strong>alpn</strong> <em>channelId protocol match</em>
- </dt>
- <dd>
- For servers, this form of callback is invoked when the client ALPN
- extension is received. If <em>match</em> is true, <em>protocol</em>
- is the first <b>-alpn</b> option specified protocol common to both
- the client and server. If not, the first client specified protocol is
- used. It is called after the hello and ALPN callbacks.
- This callback is new for TLS 1.8.
- </dd>
-
- <br>
-
- <dt>
- <strong>hello</strong> <em>channelId servername</em>
- </dt>
- <dd>
- For servers, this form of callback is invoked during client hello
- message processing. The purpose is so the server can select the
- appropriate certificate to present to the client, and to make other
- configuration adjustments relevant to that server name and its
- configuration. It is called before the SNI and ALPN callbacks.
- This callback is new for TLS 1.8.
- </dd>
-
- <br>
-
- <dt>
- <strong>sni</strong> <em>channelId servername</em>
- </dt>
- <dd>
- For servers, this form of callback is invoked when the Server Name
- Indication (SNI) extension is received. The <em>servername</em>
- argument is the client provided server name in the <b>-servername</b>
- option. The purpose is so when a server supports multiple names, the
- right certificate can be used. It is called after the hello callback
- but before the ALPN callback.
- This callback is new for TLS 1.8.
- </dd>
-
- <br>
-
- <dt>
- <strong>verify</strong> <em>channelId depth cert status error</em>
- </dt>
- <dd>
- This form of callback is invoked by OpenSSL when a new certificate
- is received from the peer. It allows the client to check the
- certificate verification results and choose whether to continue
- or not. It is called for each certificate in the certificate chain.
- <ul>
- <li>The <em>depth</em> argument is the integer depth of the
- certificate in the certificate chain, where 0 is the peer certificate
- and higher values going up to the Certificate Authority (CA).</li>
- <li>The <em>cert</em> argument is a list of key-value pairs similar
- to those returned by
- <a href="#tls::status"><strong>tls::status</strong></a>.</li>
- <li>The <em>status</em> argument is the boolean validity of the
- current certificate where 0 is invalid and 1 is valid.</li>
- <li>The <em>error</em> argument is the error message, if any, generated
- by <code>X509_STORE_CTX_get_error()</code>.</li>
- </ul>
- </dd>
- <br>
+ <dt>
+ <strong>alpn</strong> <em>channelId protocol match</em>
+ </dt>
+ <dd>
+ For servers, this form of callback is invoked when the client ALPN
+ extension is received. If <em>match</em> is true, <em>protocol</em>
+ is the first <b>-alpn</b> option specified protocol common to both
+ the client and server. If not, the first client specified protocol is
+ used. It is called after the hello and ALPN callbacks.
+ This callback is new for TLS 1.8.
+ </dd>
+ <br>
+ <dt>
+ <strong>hello</strong> <em>channelId servername</em>
+ </dt>
+ <dd>
+ For servers, this form of callback is invoked during client hello
+ message processing. The purpose is so the server can select the
+ appropriate certificate to present to the client, and to make other
+ configuration adjustments relevant to that server name and its
+ configuration. It is called before the SNI and ALPN callbacks.
+ This callback is new for TLS 1.8.
+ </dd>
+ <br>
+ <dt>
+ <strong>sni</strong> <em>channelId servername</em>
+ </dt>
+ <dd>
+ For servers, this form of callback is invoked when the Server Name
+ Indication (SNI) extension is received. The <em>servername</em>
+ argument is the client provided server name in the <b>-servername</b>
+ option. The purpose is so when a server supports multiple names, the
+ right certificate can be used. It is called after the hello callback
+ but before the ALPN callback.
+ This callback is new for TLS 1.8.
+ </dd>
+ <br>
+ <dt>
+ <strong>verify</strong> <em>channelId depth cert status error</em>
+ </dt>
+ <dd>
+ This form of callback is invoked by OpenSSL when a new certificate
+ is received from the peer. It allows the client to check the
+ certificate verification results and choose whether to continue
+ or not. It is called for each certificate in the certificate chain.
+ <ul>
+ <li>The <em>depth</em> argument is the integer depth of the
+ certificate in the certificate chain, where 0 is the peer certificate
+ and higher values going up to the Certificate Authority (CA).</li>
+ <li>The <em>cert</em> argument is a list of key-value pairs similar
+ to those returned by
+ <a href="#tls::status"><strong>tls::status</strong></a>.</li>
+ <li>The <em>status</em> argument is the boolean validity of the
+ current certificate where 0 is invalid and 1 is valid.</li>
+ <li>The <em>error</em> argument is the error message, if any, generated
+ by <code>X509_STORE_CTX_get_error()</code>.</li>
+ </ul>
+ </dd>
+ <br>
</dl>
</dd>
</dl>
-</blockquote>
<p>
Reference implementations of these callbacks are provided in the
distribution as <strong>tls::callback</strong>, <strong>tls::password</strong>,
-and <strong>tls::validate_command</strong> respectively. Note that these are
-<em>sample</em> implementations only. In a more realistic deployment
+and <strong>tls::validate_command</strong> respectively. Note that these are
+<em>sample</em> implementations only. In a more realistic deployment
you would specify your own callback scripts on each TLS channel using the
-<strong>-command</strong>, <strong>-password</strong>, and <strong>-validate_command</strong> options.
+<strong>-command</strong>, <strong>-password</strong>, and
+<strong>-validate_command</strong> options.
</p>
-
<p>
The default behavior when the <strong>-command</strong> and <strong>-validate_command</strong>
options are not specified is for TLS to process the associated library callbacks
internally. The default behavior when the <strong>-password</strong> option is not
specified is for TLS to process the associated library callbacks by attempting
to call <strong>tls::password</strong>.
The difference between these two behaviors is a consequence of maintaining
compatibility with earlier implementations.
</p>
-
<p>
<em>
The use of the reference callbacks <strong>tls::callback</strong>,
<strong>tls::password</strong>, and <strong>tls::validate_command</strong>
-is not recommended. They may be removed from future releases.
+is not recommended. They may be removed from future releases.
</em>
</p>
+
+<hr>
<h3><a name="DEBUG">DEBUG</a></h3>
TLS key logging can be enabled by setting the environment variable
<b>SSLKEYLOGFILE</b> to the name of the file to log to. Then whenever TLS
key material is generated or received it will be logged to the file. This
is useful for logging key data for network logging tools to use to
decrypt the data.
-
<p>
The <strong>tls::debug</strong> variable provides some additional
-control over these reference callbacks. Its value is zero by default.
+control over these reference callbacks. Its value is zero by default.
Higher values produce more diagnostic output, and will also force the
verify method in <strong>tls::callback</strong> to accept the
certificate, even when it is invalid if the <b>tls::validate_command</b>
callback is used for the <b>-validatecommand</b> option.
</p>
-
<p>
<em>
The use of the variable <strong>tls::debug</strong> is not recommended.
It may be removed from future releases.
</em>
@@ -697,13 +664,12 @@
<p>These examples use the default Unix platform SSL certificates. For standard
installations, -cadir and -cafile should not be needed. If your certificates
are in non-standard locations, update -cadir or use -cafile as needed.</p>
<br>
-Example #1: Use HTTP package
-
+<p>Example #1: Use HTTP package</p>
<pre><code>
package require http
package require tls
set url "https://www.tcl.tk/"
@@ -722,11 +688,11 @@
# Cleanup
::http::cleanup $token
</code></pre>
-Example #2: Use raw socket
+<p>Example #2: Use raw socket</p>
<pre><code>
package require tls
set url "www.tcl-lang.org"
set port 443
@@ -749,19 +715,19 @@
parray status
parray conn
parray chan
</code></pre>
+<hr>
<h3><a name="HTTPS EXAMPLE">HTTPS EXAMPLE</a></h3>
<p>These examples use the default Unix platform SSL certificates. For standard
installations, -cadir and -cafile should not be needed. If your certificates
are in non-standard locations, update -cadir or use -cafile as needed.</p>
-Example #1: Get web page
-
+<p>Example #1: Get web page</p>
<pre><code>
package require http
package require tls
set url "https://www.tcl.tk/"
@@ -779,12 +745,11 @@
# Cleanup
::http::cleanup $token
</code></pre>
-Example #2: Download file
-
+<p>Example #2: Download file</p>
<pre><code>
package require http
package require tls
set url "https://wiki.tcl-lang.org/sitemap.xml"
@@ -798,23 +763,27 @@
# Cleanup
close $ch
::http::cleanup $token
</code></pre>
+
+<hr>
<h3><a name="SPECIAL CONSIDERATIONS">SPECIAL CONSIDERATIONS</a></h3>
<p>The capabilities of this package can vary enormously based upon how the
linked to OpenSSL library was configured and built. New versions may obsolete
older protocol versions, add or remove ciphers, change default values, etc.
Use the <strong>tls::protocols</strong> commands to obtain the supported
protocol versions.</p>
+
+<hr>
<h3><a name="SEE ALSO">SEE ALSO</a></h3>
<p><strong>socket</strong>, <strong>fileevent</strong>, <strong>http</strong>,
-<a href="http://www.openssl.org/"><strong>OpenSSL</strong></a></p>
+<a href="https://www.openssl.org/"><strong>OpenSSL</strong></a></p>
<hr>
<pre>
Copyright © 1999 Matt Newman.
Index: generic/tls.c
==================================================================
--- generic/tls.c
+++ generic/tls.c
@@ -158,11 +158,11 @@
static void
InfoCallback(const SSL *ssl, int where, int ret) {
State *statePtr = (State*)SSL_get_app_data((SSL *)ssl);
Tcl_Interp *interp = statePtr->interp;
Tcl_Obj *cmdPtr;
- char *major; char *minor;
+ char *major, *minor;
dprintf("Called");
if (statePtr->callback == (Tcl_Obj*)NULL)
return;
@@ -2188,17 +2188,20 @@
res = SSL_get_signature_nid(statePtr->ssl, &nid);
}
if (!res) {nid = 0;}
LAPPEND_STR(interp, objPtr, "signatureHashAlgorithm", OBJ_nid2ln(nid), -1);
+ /* Added in OpenSSL 1.1.1a */
+#if OPENSSL_VERSION_NUMBER > 0x10101000L
if (objc == 2) {
res = SSL_get_peer_signature_type_nid(statePtr->ssl, &nid);
} else {
res = SSL_get_signature_type_nid(statePtr->ssl, &nid);
}
if (!res) {nid = 0;}
LAPPEND_STR(interp, objPtr, "signatureType", OBJ_nid2ln(nid), -1);
+#endif
Tcl_SetObjResult(interp, objPtr);
return TCL_OK;
}
@@ -3018,36 +3021,11 @@
OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS | OPENSSL_INIT_LOAD_CRYPTO_STRINGS
| OPENSSL_INIT_ADD_ALL_CIPHERS | OPENSSL_INIT_ADD_ALL_DIGESTS, NULL);
BIO_new_tcl(NULL, 0);
-#if 0
- /*
- * XXX:TODO: Remove this code and replace it with a check
- * for enough entropy and do not try to create our own
- * terrible entropy
- */
- /*
- * Seed the random number generator in the SSL library,
- * using the do/while construct because of the bug note in the
- * OpenSSL FAQ at http://www.openssl.org/support/faq.html#USER1
- *
- * The crux of the problem is that Solaris 7 does not have a
- * /dev/random or /dev/urandom device so it cannot gather enough
- * entropy from the RAND_seed() when TLS initializes and refuses
- * to go further. Earlier versions of OpenSSL carried on regardless.
- */
- srand((unsigned int) time((time_t *) NULL));
- do {
- for (i = 0; i < 16; i++) {
- rnd_seed[i] = 1 + (char) (255.0 * rand()/(RAND_MAX+1.0));
- }
- RAND_seed(rnd_seed, sizeof(rnd_seed));
- } while (RAND_status() != 1);
-#endif
-
#if defined(OPENSSL_THREADS) && defined(TCL_THREADS)
Tcl_MutexUnlock(&init_mx);
#endif
return status;
}
Index: generic/tlsInt.h
==================================================================
--- generic/tlsInt.h
+++ generic/tlsInt.h
@@ -40,15 +40,21 @@
/*
* Backwards compatibility for size type change
*/
#if TCL_MAJOR_VERSION < 9 && TCL_MINOR_VERSION < 7
+ #include <limits.h>
+ #define TCL_SIZE_MAX INT_MAX
+
#ifndef Tcl_Size
typedef int Tcl_Size;
#endif
#define TCL_SIZE_MODIFIER ""
+ #define Tcl_GetSizeIntFromObj Tcl_GetIntFromObj
+ #define Tcl_NewSizeIntObj Tcl_NewIntObj
+ #define Tcl_NewSizeIntFromObj Tcl_NewWideIntObj
#endif
#include <openssl/ssl.h>
#include <openssl/err.h>
#include <openssl/rand.h>
Index: win/makefile.vc
==================================================================
--- win/makefile.vc
+++ win/makefile.vc
@@ -1,8 +1,8 @@
#------------------------------------------------------------- -*- makefile -*-
#
-# Makefile for TclTLS extensions.
+# Makefile for TCL TLS extension
#
# Basic build, test and install
# nmake /f makefile.vc INSTALLDIR=c:\path\to\tcl
# nmake /f makefile.vc INSTALLDIR=c:\path\to\tcl test
# nmake /f makefile.vc INSTALLDIR=c:\path\to\tcl install
@@ -30,11 +30,11 @@
$(TMP_DIR)\tlsIO.obj \
$(TMP_DIR)\tlsX509.obj
# Define any additional project include flags
# SSL_INSTALL_FOLDER = with the OpenSSL installation folder following.
-PRJ_INCLUDES = -I"$(SSL_INSTALL_FOLDER)\include" -I"$(OPENSSL_INSTALL_DIR)\include"
+PRJ_INCLUDES = -I"$(SSL_INSTALL_FOLDER)\include" -I"$(OPENSSL_INSTALL_DIR)\include" -I"$(TMP_DIR)"
# Define any additional compiler flags that might be required for the project
PRJ_DEFINES = -D NO_SSL2 -D NO_SSL3 -D _CRT_SECURE_NO_WARNINGS
#
@@ -57,26 +57,32 @@
# Project specific targets
all: default-target
clean: default-clean
- @if exist $(WIN_DIR)\tlsUuid.h del $(WIN_DIR)\tlsUuid.h
realclean: default-hose
- @if exist $(WIN_DIR)\tlsUuid.h del $(WIN_DIR)\tlsUuid.h
# We must define a pkgindex target that will create a pkgIndex.tcl
# file in the $(OUT_DIR) directory. We can just redirect to the
# default-pkgindex target for our sample extension.
pkgindex: default-pkgindex-tea
$(ROOT)\manifest.uuid:
- copy $(WIN_DIR)\gitmanifest.in $(ROOT)\manifest.uuid
- git rev-parse HEAD >>$(ROOT)\manifest.uuid
+ if not exist $(ROOT)\manifest.uuid (
+ copy $(WIN_DIR)\gitmanifest.in $(ROOT)\manifest.uuid
+ where git
+ if ERRORLEVEL 0 (
+ git rev-parse HEAD >>$(ROOT)\manifest.uuid
+ ) else (
+ echo unknown >>$(ROOT)\manifest.uuid
+ )
+ )
-$(WIN_DIR)\tlsUuid.h: $(ROOT)\manifest.uuid
- copy $(WIN_DIR)\tlsUuid.h.in+$(ROOT)\manifest.uuid $(WIN_DIR)\tlsUuid.h
+$(TMP_DIR)\tlsUuid.h: $(ROOT)\manifest.uuid
+ copy $(WIN_DIR)\tlsUuid.h.in+$(ROOT)\manifest.uuid $(TMP_DIR)\tlsUuid.h
+ echo: >>$(TMP_DIR)\tlsUuid.h
# The default install target only installs binaries and scripts so add
# an additional target for our documentation. Note this *adds* a target
# since no commands are listed after it. The original targets for
@@ -88,9 +94,9 @@
if exist "$(SSL_INSTALL_FOLDER)\bin\libssl-*-x64.dll" (
xcopy /c /y "$(SSL_INSTALL_FOLDER)\bin\libssl-*-x64.dll" "$(PRJ_INSTALL_DIR)"
)
# Explicit dependency rules
-$(GENERICDIR)\tls.c: $(WIN_DIR)\tlsUuid.h
+$(GENERICDIR)\tls.c: $(TMP_DIR)\tlsUuid.h
# Test package
test: default-test