System i: Programming Secure Sockets APIs - IBM

APIs
These are the APIs for this category.
i5/OS Global Secure Toolkit (GSKit) APIs
GSkit APIs, when used in addition to the existing i5/OS Sockets APIs, provide the functions
required for applications to establish secure communications. An application using GSKit for secure
communications basically is a client/server application written using sockets.
i5/OS ®
The GSKit APIs are:
v “gsk_attribute_get_buffer()—Get character information about a secure session or an SSL environment”
on page 3 (Get character information about a secure session or an SSL environment) is used to obtain
specific character string information about a secure session or an SSL environment.
v “gsk_attribute_get_cert_info()—Get information about a local or partner certificate” on page 6 (Get
information about a local or partner certificate) is used to obtain specific information about either the
server or client certificate for a secure session or an SSL environment.
v “gsk_attribute_get_enum()—Get enumerated information about a secure session or an SSL
environment” on page 10 (Get enumerated information for a secure session or an SSL environment) is
used to obtain values for specific enumerated data for a secure session or an SSL environment.
v “gsk_attribute_get_numeric_value()—Get numeric information about a secure session or an SSL
environment” on page 14 (Get numeric information about a secure session or an SSL environment) is
used to obtain specific numeric information about a secure session or an SSL environment.
v “gsk_attribute_set_buffer()—Set character information for a secure session or an SSL environment” on
page 16 (Set character information for a secure session or an SSL environment) is used to set a
specified buffer attribute to a value inside the specified secure session or SSL environment.
v “gsk_attribute_set_callback()—Set callback pointers to routines in the user application” on page 20 (Set
callback pointers to routines in the user application) is used to set callback callback pointers to routines
in the user application.
v “gsk_attribute_set_enum()—Set enumerated information for a secure session or an SSL environment”
on page 24 (Set enumerated information for a secure session or an SSL environment) is used to set a
specified enumerated type attribute to an enumerated value in the secure session or SSL environment.
v “gsk_attribute_set_numeric_value()—Set numeric information for a secure session or an SSL
environment” on page 28 (Set numeric information for a secure session or an SSL environment) is used
to set specific numeric information for a secure session or an SSL environment.
v “gsk_environment_close()—Close an SSL environment” on page 30 (Close an SSL environment) is used
to close the SSL environment and release all storage associated with the environment.
v “gsk_environment_init()—Initialize an SSL environment” on page 32 (Initialize an SSL environment) is
used to initialize the SSL environment after any required attributes are set.
v “gsk_environment_open()—Get a handle for an SSL environment” on page 34 (Get a handle for an SSL
environment) is used to get storage for the SSL environment.
v “gsk_secure_soc_close()—Close a secure session” on page 37 (Close a secure session) is used to close a
secure session and free all the associated resources for that secure session.
v “gsk_secure_soc_init()—Negotiate a secure session” on page 38 (Negotiate a secure session) is used to
negotiate a secure session, using the attributes set for the SSL environment and the secure session.
v “gsk_secure_soc_misc()—Perform miscellaneous functions for a secure session” on page 41 (Perform
miscellaneous functions for a secure session) is used to perform miscellaneous functions for a secure
session.
v “gsk_secure_soc_open()—Get a handle for a secure session” on page 44 (Get a handle for a secure
session) is used to get storage for a secure session, set default values for attributes, and return a handle
that must be saved and used on secure session-related function calls.
2 System i: Programming Secure Sockets APIs