pem-read Function

Summary

An interface to the SSL PEM_read_bio_… functions. This should only be called when using the :openssl implementation.

Package

comm

Signature

pem-read thing-to-read filename &key pass-phrase callback errorp => result

Arguments

thing-to-read⇩	A string.
filename⇩	A pathname designator.
pass-phrase⇩	A string, or nil.
callback⇩	A function designator, or nil.
errorp⇩	A generalized boolean.

Values

result

A foreign pointer or nil.

Description

The function pem-read is an interface to the PEM_read_bio_… set of functions. See the manual entry for pem for specifications of these functions.

thing-to-read defines which function is required. pem-read concatenates thing-to-read with the string " PEM_read_bio_" to form the name of the pem function to call.

filename specifies the file to load.

If pass-phrase is non-nil, it must be a string, which is passed to the pem function. The default value of pass-phrase is nil.

If callback is non-nil, it must be a function with signature:

callback maximum-length rwflag => pass-phrase

where maximum-length is an integer, rwflag is a boolean and pass-phrase is the pass-phrase to use. The default value of callback is nil, but you cannot pass non-nil values for both pass-phrase and callback.

If it succeeds, pem-read returns a foreign pointer to the structure that was returned by the pem function. If pem-read fails, if errorp is non-nil it signals an error, otherwise it returns nil. The default value of errorp is nil.

See also

25 TCP and UDP socket communication and SSL