System i: Programming Secure Sockets APIs - IBM

Service Program Name: QSOSSLSR
Default Public Authority: *USE
Threadsafe: Yes
The SSL_Destroy() function is used by a program to end SSL support for the specified SSL session. The
SSL session to be ended is identified by the handle parameter.
Parameters
SSLHandle* handle (input)
The pointer to an SSLHandle for an active SSL session, which is being ended. An SSLHandle is a
typedef for a buffer of type struct SSLHandleStr. In , struct SSLHandleStr is defined as
the following:
struct SSLHandleStr { /* SSLHandleStr */
int fd; /* Socket descriptor */
int createFlags; /* SSL_Create flags value */
unsigned protocol; /* SSL protocol version */
unsigned timeout; /* Timeout value in seconds */
unsigned char cipherKind[3]; /* Current 2.0 cipher suite*/
unsigned short int cipherSuite; /* Current 3.0 cipher suite */
unsigned short int* cipherSuiteList; /* List of cipher suites */
unsigned int cipherSuiteListLen; /* Number of entries in
the cipher suites list */
unsigned char* peerCert; /* Peer certificate */
unsigned peerCertLen; /* Peer certificate length */
int peerCertValidateRc; /* Return code from
validation of certficate */
int (*exitPgm)(struct SSLHandleStr* sslh);
/* Authentication exit
program called when a
certificate is received
during SSL handshake */
};
Authorities
No authorization is required.
Return Value
The SSL_Destroy() API returns an integer. Possible values are:
[0] Successful return
[SSL_ERROR_IO] An error occurred in SSL processing; check the errno value.
Error Conditions
When the SSL_Destroy() API fails with return code [SSL_ERROR_IO], errno can be set to:
[EBADF]
[EFAULT]
[EIO]
Descriptor not valid.
Bad address.
The system detected an address that was not valid while attempting to access the handle
parameter or a field within the structure pointed to by the handle parameter.
Input/output error.
72 System i: Programming Secure Sockets APIs