Bindings to the OpenSSL SSL/TLS library
None, except for the openssl C library of course.
This reference is basically a copy of the documentation of PLT Scheme's openssl module. The API provided here is largely compatible with that one. The exceptions are the missing .../enable-break and ssl-available? procedures and the missing reuse? argument to ssl-listen.
Please note that all the procedures described here may fail and raise a non-continuable exception of the composite type (exn i/o net openssl). The openssl property condition contains a property called status which will be bound to a symbol corresponding to the OpenSSL error code that was encountered. It may have the following values:
- The SSL/TLS connection was shut down unexpectedly but in a controlled way
- The operation didn't finish because data must be read from a nonblocking socket. This error condition only occurs though, when it could not be handled automatically because there is actually no socket involved or some other strange thing happended in the OpenSSL library.
- The operation didn't finish because data must be read from a nonblocking socket. The same comment as for 'want-read applies.
- The operation didn't finish because a nonblocking socket must first be connected. The same comment as for 'want-read applies.
- The operation didn't finish because a nonblocking socket must first be acepted. The same comment as for 'want-read applies.
- The operation failed because an application callback that could not even have been registered through this API was apparently registered anyway and has asked to be called again.
- Some low-level I/O error occurred.
- Something went wrong in the OpenSSL library itself.
- The error is not classified
Of course the exception that is thrown also has an appropriate message set. If you feel that this documentation lacks some information, please also consider the manual pages of OpenSSL itself.
For read and write timeouts, tcp-read-timeout and tcp-write-timeout are honored.
- (ssl-handshake-timeout [TIMEOUT]) parameter
The time in milliseconds to wait for a SSL handshake to complete (after ssl-connect or ssl-accept). Defaults to 120000, ie two minutes.
note: The handshake is only initiated after the first read or the first write action occurs on the connection, so the timer is started upon that first action.
- (ssl-shutdown-timeout [TIMEOUT]) parameter
The time in milliseconds to wait for a SSL shutdown operation to complete (after closing a port). Defaults to 120000, ie two minutes.
- (ssl-connect (hostname <string>) #!optional (port <exact>) ((ctx <ssl-client-context|symbol>) 'sslv2-or-v3)) => <input-port>, <output-port> procedure
Connect to the given host on the given port (a number from 1 to 65535). This connection will be encrypted using SSL. The return values are as tcp-connect; an input port and an output port.
The optional ctx argument determines which encryption protocol is used, whether the server's certificate is checked, etc. The argument can be either a client context created by ssl-make-client-context (see below), or one of the following symbols: 'sslv2-or-v3 (the default), 'sslv2, 'sslv3, or 'tls. See ssl-make-client-context for further details, including the meanings of the protocol symbols.
- (ssl-make-client-context #!optional ((protocol <symbol>) 'sslv2-or-v3)) => <ssl-client-context> procedure
Creates a context to be supplied to ssl-connect. The context identifies a communication protocol (as selected by protocol), and also holds certificate information (i.e., the client's identity, its trusted certificate authorities, etc.). See the "Certificate procedures" section below for more information on certificates.
The protocol must be one of the following:
- SSL protocol versions 2 or 3, as appropriate
- SSL protocol version 2
- SSL protocol version 3
- the TLS protocol version 1
By default, the context returned by ssl-make-client-context does not request verification of a server's certificate. Use ssl-set-verify! to enable such verification.
- (ssl-client-context? (obj <top>)) => <bool> procedure
Returns #t if obj is a value produced by ssl-make-client-context, #f otherwise.
- (ssl-listen (port <exact>) #!optional ((backlog <exact>) 4) ((hostname <string>) #f) ((ctx <ssl-client-context|symbol>) 'sslv2-or-v3)) => <ssl-listener> procedure
Like tcp-listen, but the result is an SSL listener. The extra optional ctx argument is as for ssl-connect.
Call ssl-load-certificate-chain! and ssl-load-private-key! to avoid a "no shared cipher" error on accepting connections.
- (ssl-close (listener <ssl-listener>)) => <void> procedure
- (ssl-listener? (obj <top>)) => <bool> procedure
- (ssl-listener-port (listener <ssl-listener>)) => <exact> procedure
- (ssl-listener-fileno (listener <ssl-listener>)) => <exact> procedure
- (ssl-listener-accept-ready? (listener <ssl-listener>)) => <bool> procedure
- (ssl-accept (listener <ssl-listener>)) => <input-port>, <output-port> procedure
Analogous to tcp-close, tcp-listener?, tcp-listener-port, tcp-listener-fileno, tcp-accept-ready? and tcp-accept.
- (ssl-load-certificate-chain! (obj <ssl-client-context|ssl-listener>) (pathname <string>)) => <void> procedure
Loads a PEM-format certification chain file for connections to be made with the given context (created by ssl-make-context) or listener (created by ssl-listener).
This chain is used to identify the client or server when it connects or accepts connections. Loading a chain overwrites the old chain. Also call ssl-load-private-key! to load the certificate's corresponding key.
- (ssl-load-private-key! (obj <ssl-client-context|ssl-listener>) (pathname <string>) #!optional ((rsa? <bool>) #t) ((asn1? <bool>) #f)) => <void> procedure
Loads the first private key from pathname for the given client context or listener. The key goes with the certificate that identifies the client or server.
If rsa? is #t, the first RSA key is read (i.e., non-RSA keys are skipped).
If asn1? is #t, the file is parsed as ASN1 format instead of PEM.
- (ssl-set-verify! (obj <ssl-client-context|ssl-listener>) (v <bool>)) => <void> procedure
Enables or disables verification of a connection peer's certificates. By default, verification is disabled.
Enabling verification also requires, at a minimum, designating trusted certificate authorities with ssl-load-verify-root-certificates!.
- (ssl-load-verify-root-certificates! (obj <ssl-client-context|ssl-listener>) (pathname <string>) #!optional ((dirname <string>) #f)) => <void> procedure
Loads a PEM-format file containing trusted certificates that are used to verify the certificates of a connection peer. Call this procedure multiple times to load multiple sets of trusted certificates.
The optional second argument specifies a directory in which certificates are automatically looked up. You may also only pass a path in this argument and pass #f as the first argument to this procedure. See the OpenSSL documentation on SSL_CTX_load_verify_locations for more details.
- (ssl-load-suggested-certificate-authorities! (obj <ssl-client-context|ssl-listener>) (pathname <string>)) => <void> procedure
Loads a PEM-format file containing certificates that are used by a server. The certificate list is sent to a client when the server requests a certificate as an indication of which certificates the server trusts.
Loading the suggested certificates does not imply trust, however; any certificate presented by the client will be checked using the trusted roots loaded by ssl-load-verify-root-certificates!.
- (ssl-port? obj) => <boolean> procedure
Predicate for SSL ports; returns #t if obj is an SSL port, #f if it isn't.
- (ssl-port->tcp-port p) => <tcp-port> procedure
Convert SSL port p to the raw underlying TCP port.
This is mostly useful if you need to obtain extra information about the connection, like for example tcp-addresses. Note that you generally cannot safely send data over the port, as that would interfere with OpenSSL's operation.
- 1.6.2 Correct read-byte of chars with high bit set; fixes #954
- 1.5.1 Small bugfixes by Mario Domenech Goulart
- 1.5 Do not let ssl-accept or ssl-connect block immediately but defer it until reading or writing to the ports. Add ssl-handshake-timeout and ssl-shutdown-timeout options.
- 1.4 Fix intermittent bug in ssl-write caused by the GC's moving around of memory locations
- 1.3 Make ssl ports completely distinct from tcp ports. Add ssl-port? and ssl-port->tcp-port procedures.
- 1.1.7 fix for vector deref crash (elf, reported by glogic)
- 1.1.6 windows linking fixes by Alex Queiroz
- 1.1.5 added static linking support [felix]
- 1.1.4 fixed problems with the shutdown sequence
- 1.1.3 fixes problem with older chickens and missing newline before `<#' in blocks of foreign code [Thanks to Dan Muresan]
- 1.1.2 uses foreign-code macro insead of obsolete read syntax
- 1.1.1 Output that would block properly suspends threads now
- 1.1.0 ##sys#tcp-port->fileno and tcp-addresses are now supported on SSL ports
- 1.0.0 Corrections, tests against openssl s_server, openssl s_client and comparison with the PLT module
- 0.4.0 Server functionality added
- 0.3.1 Client-only with certificate functions
- 0.2.0 Client-only prerelease
Copyright (c) 2005, Thomas Chust <email@example.com>. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.