System i: Programming Secure Sockets APIs - IBM

v “SSL_Read()—Receive Data from an SSL-Enabled Socket Descriptor” on page 91 (Receive data from an
SSL-enabled socket descriptor) is used by a program to receive data from an SSL-enabled socket
descriptor.
v “SSL_Strerror()—Retrieve SSL Runtime Error Message” on page 95 (Retrieve SSL runtime error
message) is used to retrieve an error message and associated text string which describes an SSL return
value.
v “SSL_Write()—Write Data to an SSL-Enabled Socket Descriptor” on page 97 (Write data to an
SSL-enabled socket descriptor) is used by a program to write data to an SSL-enabled socket descriptor.
Note: These functions use header (include) files from the library QSYSINC, which is optionally
installable. Make sure QSYSINC is installed on your system before using any of the functions. See
“Header Files for UNIX-Type Functions” on page 100 for the file and member name of each header file.
See the following examples for more information:
v Example: Establishing a secure server with SSL_ APIs
v Example: Establishing a secure client with SSL_ APIs
Top | UNIX-Type APIs | APIs by category
QlgSSL_Init()—Initialize the Current Job for SSL (using NLS-enabled
path name)
Syntax
#include
int QlgSSL_Init(QlgSSLInit* init)
Service Program Name: *SRVPGM
Default Public Authority: *USE
Threadsafe: Yes
The QlgSSL_Init() function is used to establish the SSL security information to be used for all SSL sessions
for the current job. The QlgSSL_Init() API establishes a certificate and private key for use by the
handshake protocol processing when acting as a server. The QlgSSL_Init() API establishes a certificate for
use by the handshake protocol processing when acting as a client that is connected to a server performing
client authentication.
Parameters
QlgSSLInit * init (input)
The pointer to a QlgSSLInit structure. QlgSSLInit is a typedef for a buffer of type struct
QlgSSLInitStr. In , struct QlgSSLInitStr is defined as the following:
struct QlgSSLInitStr { /* QlgSSLInitStr */
Qlg_Path_Name* keyringFileName; /* Key ring file name */
char* keyringPassword; /* Key ring file password */
unsigned short int* cipherSuiteList; /* List of cipher suites */
unsigned int cipherSuiteListLen; /* number of entries in
the cipher suites list */
};
The fields within the QlgSSLInit structure as pointed to by init are defined as follows:
Secure Sockets APIs 65