System i: Programming Secure Sockets APIs - IBM

unsigned int cipherSuiteListLen The number of cipher suite entries specified in the list pointed to by the
(input)
cipherSuiteList field.
unsigned char* peerCert (output) The pointer to the certificate received from the peer system. For a client, this is a
pointer to the server’s certificate. For a server with client authentication enabled,
this is a pointer to the client’s certificate. For a server without client
authentication this pointer value remains unchanged.
unsigned peerCertLen (output) The length of the certificate pointed to by the peerCert field.
int (*exitPgm)(SSLHandle* sslh)
(input)
A pointer to a user supplied function that is called whenever a certificate is
received during handshake processing. The exitPgm will be passed the pointer to
the handle, which could include the peer’s certificate. The exitPgm returns a
nonzero value if the peer’s certificate is accepted. The return of a zero value by
the exitPgm will cause the handshake processing to fail. Users of this function do
not need to provide an exit program. The pointer should be a NULL value if
there is not a user-supplied exit program. The exit program should be written in
a threadsafe manner.
int how (input) The type of SSL handshake to be performed. The following values may be
specified for handshake type and are defined in .
SSL_HANDSHAKE_AS_CLIENT (0)
Perform the handshake as a client.
SSL_HANDSHAKE_AS_SERVER (1)
Perform the handshake as a server.
SSL_HANDSHAKE_AS_SERVER_WITH_CLIENT_AUTH (2)
Perform the handshake as a server with client authentication.
SSL_HANDSHAKE_AS_SERVER_WITH_OPTIONAL_CLIENT_AUTH (3)
Perform the handshake as a server with optional client authentication.
Authorities
Authorization of *R (allow access to the object) to the key ring file and its associated files is required.
Return Value
The SSL_Handshake() API returns an integer. Possible values are:
[0]
Successful return
[SSL_ERROR_BAD_CERTIFICATE]
The certificate is bad.
[SSL_ERROR_BAD_CERT_SIG]
The certificate’s signature is not valid.
[SSL_ERROR_BAD_CERTIFICATE]
The certificate is bad.
[SSL_ERROR_BAD_CIPHER_SUITE]
A cipher suite that is not valid was specified.
[SSL_ERROR_BAD_MAC]
A bad message authentication code was received.
[SSL_ERROR_BAD_MALLOC]
Unable to allocate storage required for SSL processing.
76 System i: Programming Secure Sockets APIs