System i: Programming Secure Sockets APIs - IBM

gsk_attribute_get_enum()—Get enumerated information about a secure
session or an SSL environment
Syntax
#include
int gsk_attribute_get_enum(gsk_handle my_gsk_handle,
GSK_ENUM_ID enumID,
GSK_ENUM_VALUE *enumValue);
Service Program Name: QSYS/QSOSSLSR
Default Public Authority: *USE
Threadsafe: Yes
The gsk_attribute_get_enum() function is used to obtain values for specific enumerated data for a secure
session or an SSL environment.
Parameters
my_gsk_handle (Input)
Indicates one of the following handles:
v The handle for the secure session. (my_session_handle)
v The handle for the SSL environment. (my_env_handle)
enumID (Input)
The following values can be used to retrieve information about the secure session or SSL
environment that is either defaulted or explicitly set:
v GSK_PROTOCOL_SSLV2 (403) - Whether the SSL Version 2 protocol is enabled or disabled
for this secure session or SSL environment. The enumValue returned will be one of the
following values:
– GSK_PROTOCOL_SSLV2_ON (510) - SSL Version 2 ciphers are enabled.
– GSK_PROTOCOL_SSLV2_OFF (511) - SSL Version 2 ciphers are disabled.
v GSK_PROTOCOL_SSLV3 (404) - Whether the SSL Version 3 protocol is enabled or disabled
for this secure session or SSL environment. The enumValue returned will be one of the
following values:
– GSK_PROTOCOL_SSLV3_ON (512) - SSL Version 3 ciphers are enabled.
– GSK_PROTOCOL_SSLV3_OFF (513) - SSL Version 3 ciphers are disabled.
v GSK_PROTOCOL_TLSV1 (407) - Whether the TLS Version 1 protocol is enabled or disabled
for this secure session or SSL environment. The enumValue returned will be one of the
following values:
– GSK_PROTOCOL_TLSV1_ON (518) - TLS Version 1 ciphers are enabled.
– GSK_PROTOCOL_TLSV1_OFF (519) - TLS Version 1 ciphers are disabled.
v GSK_SESSION_TYPE (402) - Type of handshake to be used for this secure session or SSL
environment. enumValue returned will be one of the following values:
– GSK_CLIENT_SESSION (507) - Secure sessions act as clients.
– GSK_SERVER_SESSION (508) - Secure sessions act as a server with no client
authentication. The client certificate is not requested.
– GSK_SERVER_SESSION_WITH_CL_AUTH (509) - Secure sessions act as a server that
requests the client to send a certificate. The value for GSK_CLIENT_AUTH_TYPE will
determine what happens if the client certificate is not valid or not provided.
10 System i: Programming Secure Sockets APIs