TLS encryption for Client/Server IPv6/IPv4 communication
What is ucspi-ssl?
sslserver, sslclient, and sslhandle are command-line tools for building SSL client-server applications. They conform to the UNIX Client-Server Program Interface, UCSPI.
sslserver listens for IPv6 and/or IPv4 connections, and runs a program for each connection it accepts. The program environment includes variables that hold the local and remote host names, IP addresses, and port numbers. sslserver offers a concurrency limit on acceptance of new connections, and selective handling of connections based on client identity supporting CIDR IP address notation. sslserver supports STARTTLS and STLS.
sslclient requests a connection to either a IPv6 or IPv4 TCP sockets, and runs a program. The program environment includes the same variables as for sslserver.
sslhandle is a pre-forking sslserver; though without STARTTLS/STLS capabilities.
Features & History
The current verion of ucspi-ssl (0.10.x) includs the following communication capabilities:
- Delayed TLS handshake using Scott Gifford's STARTTLS extensions,
- certificate chaining support,
- SubAltName recognition for FQDN verification, and
- CIDR support for the cdb to filter IPv4/IPv6 connections.
- IPv6/IPv4 communication and DNS resolution is based on fehQlibs.
- Version 0.10.8 employs now the dual-stack operation for sslserver in case the pseudo-IP address :0 is given as hostname. IPv4 CIDR evaluation is based on a more robust scheme now.
- Version 0.10.9 uses a refactored IPv4/IPv6 CIDR evaluation module and supports LibreSSL 2.9.x providing TLS 1.3 capabilities.
- Version 0.10.10 supports DSA/ECDSA additionally to RSA signed X.509 certs.
- Version 0.10.11 improves interoperability with different versions of OpenSSL and LibreSSL; includes SNI for sslclient and allows selection of Ciphers for TLS 1.3 and it's predecessors.
ucspi-ssl posses the following family tree:
- ucspi-ssl-0.6x was the orginal version of provided initially by SuperScript (William Baxter).
- ucspi-ssl-0.7x is the latest version (now available on GitHub).
- ucspi-ssl-0.8x is my fork including Scott Gifford's extensions for STARTTTLS and other enhancements.
- ucspi-ssl-0.9x includes IPv6 capabilites streamlined with ucspi-tcp6-0.9.x.
- ucspi-ssl-0.10.x appplies significant code refactoring while using the fehQlibs.
- Support of LibreSSL's API.
- Native TLS 1.3 is provided by means of OpenSSL 1.1.1. and LibreSSL 2.9.1.
Note: ucspi-ssl-0.10.11 has been tested and adjusted to a variety of *SLL versions.
- Required: fehQlibs. Doesn't compile without it.
- Required for Linux: libssl-dev libraries (separate package).
- Optional but indispensible: ucspi-tcp6
to build the cdb to control incoming connections for
tcprules coming with
package. Older versions of ucspi-tcp can be used as well,
but don't provide neither IPv4 CIDR nor IPv6 capabilities.
The generated cdb however, is binary compatible among all versions.
https@ and sslconnect depend on routines from ucspi-tcp6 (or earlier versions).
This is facilitated by means of the lib ucspissl.a (after compilation; located in ./compile) and the header file ucspissl.h.
ucspi-ssl can be build on top of OpenSSL or LibreSSL with two options:
- The standard way is to use the *SSL installation coming with your OS by dynamically linking it.
- The alternative way is to use a different *SSL library (perhaps more recent) while linking it statically with this.
|Version & Download||Description||Verification|
|ucspi-ssl 0.10.11||The sixth carefully checked version of ucspi-ssl (0.10.x) supports fehQlibs-12 while employing cutting edge TLS 1.3 and X.509 capabilities together with full-featured dual-stack servers.|| MD5: 5211e0d4e56dc555eb0acbc63a8310be
|ucspi-ssl 0.10.6||TLS 1.3 enabled version of ucspi-ssl depending on fehQlibs||MD5: 9bb2a08d5e18434f20e75fefc5f8425c
|ucspi-ssl 0.99e||IPv6 enabled ucspi-ssl supporting OpenSSL 1.1 together with LibreSSL|| MD5: d6d1269606834f0e1a3cfd28c142fb36
The source code of the current ucspi-ssl is provided as Doxygen documentation.
How to install ucspi-ssl
ucspi-ssl uses D.J. Bernstein's /package
conventions for installation.
Typically, un-tar the archive under /package,
change to host/superscript.com/net/ucspi-ssl-<version>
and calling package/install would be enough.
ucspi-ssl is pre-packaged to suite the AMD64 environment.
Depending on your Perl settings, you rather succeed with package/install base and package/man for the additional man-pages.
Note: The additional sslperl module may not succeed on every Unix plattform.
Documentation of the programs
|Server apps||Client apps||Miscellaneous|
The source code of the current ucspi-ssl is provided as Doxygen documentation.
- My SMTP and Transport Layer Security (TLS) tutorial (outdated).
- The original ucspi-ssl source created by W.E. Baxter.
- Scott Gifford's STARTTLS UCPSI-SSL extension (unavailable).
- A Polish translation provided by Daniela Milton can be found here.
- A French translation done by Silvia Moraru can be found here.
- An Indonesian translation has been added by Eimantas B.: ucspi-ssl-Indonesian.
Note: These sites may refer to outdated versions of ucspi-ssl.
TLS environment & security
ucspi-ssl's sslserver will display the current Cipher settings, in case the flag -V is provided. Sample of the output using multilog:
In the first case AES_256_GCM_SHA384 is the negotiated Cipher in use together
with TLS 1.3 as chosen protocol, which requires ECDH as key exchange protocol.
In the second case, TLS 1.2 is used but now with the most recent CHACHA20_POLY1305 stream cipher+authentication provided by Dan Bernstein.
Of course, this will only work with most recent versions of OpenSSL (see below), which - as can be seen - is also availalbe for unwanted visitors from the Seychelles (using IP 220.127.116.11).
TLS 1.3 with OpenSSL 1.1.1x/LibreSSL 2.9.x
TLS 1.3 is a very different protocol in comparison with it's predecessors,
- protecting large parts of the handshake material, in particular the X.509 certificates,
- providing by the same token a much faster handshake,
- using D.J. Bernstein's ChaCha20 and Poly1305 for message encryption and authentication based on the AEAD model instead of AES in broken CBC-mode and with awful hashsums (hash-then-encrypt),
- while requiring for the handshake to be always ephemeral Diffie-Hellman (ECDHE) based on Elliptic Curves.
In short, TLS 1.3 is 21st century cryptography.
Elliptic Curve Diffie-Hellman
ucspi-ssl may use one of the following curves from OpenSSL 1.1.1:
- x25519 (the Bernstein Curve)
You can verify the ECC curves, your OpenSSL version offers with the following command:
Unlike DH with the Discrete Logarithm, there is no particular DHPRAM file to generate because the ECC parms are taken from internal defaults.
Further information about OpenSSL and it's usage can be found here:
OpenSSL uses for TLS 1.3 the API SSL_set_ciphersuites since in this version the cipher suites are much more restricted. In fact, some common cipher setting nouns like DEFAULT and HIGH are not supported here; and of course make no sense.
Starting with ucspi-ssl-0.10.11 legacy and current cipher settings are supported.
In OpenSSL TLS 1.3 the standard cipher is TLS_AES256_GCM_SHA384 providing hardware acceleration on most platforms. Rather, from a security point of view, I prefer CHACHA20_POLY1305. You can enforce this usage by setting the cipher suite on the client side to:
I feel a little unhappy combing AES256 with GCM, since it GCM uses a Galois Field GF(128) and thus is well suited for AES128.
*SSL dependencies and updates
Since ucspi-ssl depends on either OpenSSL or LibreSSL, it is inherently affected by bugs and flaws in here. Thus, please check for CVEs. In case you need to upgrade the *SSL libs, proceed as follows:
- Install the updated version of *SSL from you *NIX repository -- or --
- install *SSL from the source. Make sure to use the same path as your original installation. Typically, the required header files are expected in /usr/include/openssl.
- Check for your ucspi-ssl source directory; usually /package/host/superscript/net/ucspi-ssl-x.yz.
- Remove the directory ./compile and re-run package/install. This will link ucspi-ssl with the new *SSL version.
Note: Though ucspi-ssl did suffer from the Heartbleed bug in OpenSSL it is very unlikely that this could have exploited for security relevant information. sslserver in particular raises a new address space (and containing the vulnerable SSL context) for each new connection and IP. In this sense, sslserver mitigates your risks.
The latest version of ucspi-ssl supports:
- OpenSSL 0.98, 0.99,
- OpenSSL 1.0, and now
- OpenSSL 1.1 (eg. on Debian 'Stretch' and Arch Linux with OpenSSL-1.1.0.f-2), as well as
- OpenSSL 1.1.1
- LibreSSSL 2.5.4
- LibreSSSL 2.9.1 (TLS 1.3 enabled).
Under normal circumstances, ucspi-ssl detects the respective *SSL versions and will compile and work without manual intervention.
However, you may use the most current OpenSSL (and LibreSSL) versions on your system in a 'none-destructive' mode for ucspi-ssl while adjusting
- conf-ssl including the path to header files and
- conf-ssllibs using the argument -L for determine the path of the libraries 'libssl' and 'libcrypto'.
Checking your installation
Once installed, your TLS (1.3) capabilities can be checked using this nice testssl.sh script from Dirk Wetter.
*ix specific installation instructions
Gentoo includes a ready-to-use package for ucspi-ssl. However, this package is outdated.
NetBSD includes the ucspi-ssl package (outdated).
ucspi-ssl will compile with clang in case Xcode is installed. You need to adjust conf-cc. The following include solved the situation under MacOS X 'El Capitan' in my case for conf-cc:
You can add that statement into the conf-cc file prior of compilation.
because MacOS X is missing the environ facility.
The usual loader option -m64 does not work and is erroneously detected. After package/compile edit within the compile directory the file load and remove that option. Issue the command make as usual.
Since manpath is not supported, you need to include the man-path manually in conf-man.
Proceed with package/install.
ucspi-ssl supports Raspbian Linux and the ARM architecture out-of-the box.
Within the src directory of ucspi-ssl use
to display the given SW and HW architecture. Taking some compiler flags from gcc ARM options you can fine-tune settings to your ARM system within conf-cc and conf-ld.
Together with most Linux systems, you need to install the OpenSSL development environment. On a standard Debian system (like Raspbian) you succeed with the following:
ucspi-ssl installs and works seamlessly well using clang under FreeBSD 12 for the ARM64 architecture but now in 64 bit mode!
Enjoy the ucspi-ssl package!