This section describes advanced issue that related to using OpenSSL. Read the previous sections before using anything descibed here.
The configuration interface contains mostly FLI function definitions that map directly to OpenSSL calls. See below for a list of those provided.
The Lisp constants
SSL_FILETYPE_PEM representing file types are provided.
This section describes the mapping between OpenSSL function names and the corresponding Lisp names.
For functions that map directly to OpenSSL calls, the convention is to create the LISP name from the C name by replacing underscores by hyphens.
To find the C name from the LISP function name:
The following functions map directly to the OpenSSL functions. Check the OpenSSL documentation for details.
Where an OpenSSL function takes an
SSL_CTX*, the Lisp function's argument must be a foreign pointer of type ssl-pointer, ssl-ctx-pointer or ssl-cipher-pointer. Where an OpenSSL function takes a
int, the Lisp function's argument must be a string or integer. Where an OpenSSL function takes other kinds of pointers, the Lisp function's argument must be a foreign pointer. The return values are integers or foreign pointers unless stated otherwise.
If an error occurs in one of these functions, an error code is returned. They do not signal any Common Lisp conditions and so you should check the return value carefully.
|Lisp function||Return values|
First value is number of bits the cipher actually uses.
If you need OpenSSL functionality that is not provided here, you can define your own foreign functions via the LispWorks Foreign Language Interface.
If you do this, an important point to note is that on Microsoft Windows, the
:calling-convention must be
:cdecl (it defaults to
:stdcall). If using OpenSSL suddenly causes mysterious crashes, the calling-convention in your foreign function definitions is the first thing to check.
The C objects SSL and SSL_CTX are represented in LispWorks by foreign pointers with type ssl-pointer and ssl-ctx-pointer, which correspond to the C types
SSL_CTX*. These foreign types should be used for any foreign function that takes or returns these C types, and must be used when passing a foreign pointer as the value of the
Making SSL objects is a way of getting access to them to perform configuration, but, especially in the case of the SSL_CTX, it is a useful way to avoid repeated calls to the configuration routines which may be time consuming. For example, if we have defined a function
configure-a-ctx, and we want to read once every 60 seconds from some URL, we can write:
(loop (with-open-stream (str (comm:open-tcp-stream some-url 443 :ssl-ctx t :ctx-configure-callback 'configure-a-ctx)) (read-something str)) (sleep 60))
This will cause
configure-a-ctx to be called each time. If it is expensive, we can call it only once by changing the code to:
(let ((ctx (comm:make-ssl-ctx :ssl-side :client))) (configure-a-ctx ctx) (loop (with-open-stream (str (comm:open-tcp-stream some-url 443 :ssl-ctx ctx)) (read-something str)) (sleep 60)) (comm:destroy-ssl-ctx ctx))
The SSL objects could be made either by make-ssl-ctx or ssl-new or by user code that calls the C functions SSL_CTX_new and SSL_new. destroy-ssl-ctx frees the SSL_CTX object. To free an SSL object you would call destroy-ssl. See the manual entries for full descriptions of these functions.
Alternatively, the SSL objects can be obtained from a socket-stream by calling socket-stream-ssl or socket-stream-ctx and from an async-io-state by calling async-io-state-ssl or async-io-state-ctx. You can also find the ssl-side value that was passed to the interface call that created the SSL objects by calling socket-stream-ssl-side or async-io-state-ssl-side.
All the functions that make a SSL_CTX first call ensure-ssl, so normally you do not need to initialize the library. If your code makes a SSL_CTX itself (that is, not by calling any of the LispWorks interface functions), it needs to initialize the library first. Normally that should be done by an explicit call to ensure-ssl, which loads the SSL library and calls SSL_library_init and SSL_load_error_strings, and also does some LispWorks specific initializations. If your code must do the initialization, ensure-ssl should still be called with the argument
:already-done t, which tells it that the library is already loaded and initialized.
LispWorks® User Guide and Reference Manual - 01 Dec 2021 19:30:24