System i: Programming Secure Sockets APIs - IBM

Parameters
SSLHandle* handle (input)
The pointer to an SSLHandle for an SSL session. 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 */
};
void *buffer (input)
A pointer to the user-supplied buffer in which the data that is received on the SSL session is to be
stored.
int buffer_length (input)
The length of the buffer.
Authorities
No authorization is required.
Return Value
The SSL_Read() API returns an integer. Possible values are:
[n]
Successful, where n is the number of bytes read.
[SSL_ERROR_BAD_MESSAGE]
SSL received a badly formatted message.
[SSL_ERROR_BAD_MAC]
A bad message authentication code was received.
[SSL_ERROR_BAD_MALLOC]
Unable to allocate storage required for SSL processing.
[SSL_ERROR_BAD_STATE]
SSL detected a bad state in the SSL session.
[SSL_ERROR_CLOSED]
The SSL session ended.
92 System i: Programming Secure Sockets APIs