make-ssl-server-stream

Function

Package: socket

ToC

DocOverview

CGDoc

RelNotes

Index

PermutedIndex

Allegro CL version 6.2
Object described on page has changed in 6.2

make-ssl-server-stream

Arguments: socket &key certificate key certificate-password other-certificates

This function is not available in all versions. Generally, you must have an Enterprise license to use this function. Also, you must have the OpenSSL libraries installed for this facility to work. Note that shared library versions of the OpenSSL libraries (required by Allegro CL) are not available on all platforms. The SSL functionality is in the ssl module. To ensure it is loaded, evaluate (require :ssl). Calling this function automatically loads the module.

This function creates a new ssl socket stream that communicates via SSL via the given socket. Once this function is called and an ssl socket stream is returned, no I/O calls should be done directly to socket.

The certificate argument is a string naming a file containing the server certificate in PEM format.

The key argument is a string naming the file containing the private RSA key corresponding the the public key in the certificate. The file is in PEM format. The key cannot be stored in an encrypted form which would require a pass phrase to read. If the key is stored in the certificate file, then you needn't specify the key argument.

The certificate-password argument, if specified, should be a string. If the private key stored with the certificate inside the file named by the certificate argument is encrypted, then this value is used as the key to decrypt it.

The other-certificates argument is a string naming a file of other certificates (in PEM format) that are needed to establish a trust hierarchy reaching up to a certificate that is implicitly trusted by the browser. If the certificate was obtained from a well known root certificate authority then you won't need to specify anything for this argument. Note that Netscape 4's implementation of SSL has problems reading the data generated by this argument.

See the example in [Allegro directory]/examples/ssl/, particularly the file server.pem.

The server side of an SSL connection should not send data until it receives data from the client.

See make-ssl-server-stream. See also socket.htm for information on sockets. For information on Secure Sockets, see the section Secure Socket Layer (SSL) in that document.