ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/unix9a.htm

104 lines
8.0 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>i5/OS Global Secure Toolkit (GSKit) APIs</title>
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Begin Header Records ========================================= -->
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
<!-- File restructured December 2001 -->
<!-- 021001 JETAYLOR replaced API and/or Exit listings with -->
<!-- pagegenerator output from javascript array -->
<!-- 021014 JETAYLOR replaced API and/or Exit listings with -->
<!-- pagegenerator output from javascript array -->
<!-- 031104 JETAYLOR replaced API and Exit listings with -->
<!-- pagegenerator output from javascript array -->
<!-- 031112 JETAYLOR replaced API and/or Exit listings with -->
<!-- pagegenerator output from javascript array -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>i5/OS Global Secure Toolkit (GSKit) APIs</h2>
<p>i5/OS<SUP>(TM)</SUP> 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.</p>
<p>The Global Secure Toolkit (GSKit) APIs are:</p>
<!-- ***** NOTE ***** Do not manually update text or links in this section. -->
<!-- Updates made in this section *will* be overlaid by automated tools -->
<!-- Notify User Technologies of needed updates to be made in XML for API finder.-->
<!--***************API BEGIN PASTE***************-->
<ul>
<li><A HREF="gsk_attribute_get_buffer.htm">gsk_attribute_get_buffer()</A> (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.</li>
<li><A HREF="gsk_attribute_get_cert_info.htm">gsk_attribute_get_cert_info()</A> (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.</li>
<li><A HREF="gsk_attribute_get_enum.htm">gsk_attribute_get_enum()</A> (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.</li>
<li><A HREF="gsk_attribute_get_numeric_value.htm">gsk_attribute_get_numeric_value()</A> (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.</li>
<li><A HREF="gsk_attribute_set_buffer.htm">gsk_attribute_set_buffer()</A> (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.</li>
<li><A HREF="gsk_attribute_set_callback.htm">gsk_attribute_set_callback()</A> (Set callback pointers to routines in the user application) is used to set callback callback pointers to routines in the user application.</li>
<li><A HREF="gsk_attribute_set_enum.htm">gsk_attribute_set_enum()</A> (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.</li>
<li><A HREF="gsk_attribute_set_numeric_value.htm">gsk_attribute_set_numeric_value()</A> (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.</li>
<li><A HREF="gsk_environment_close.htm">gsk_environment_close()</A> (Close an SSL environment) is used to close the SSL environment and release all storage associated with the environment.</li>
<li><A HREF="gsk_environment_init.htm">gsk_environment_init()</A> (Initialize an SSL environment) is used to initialize the SSL environment after any required attributes are set.</li>
<li><A HREF="gsk_environment_open.htm">gsk_environment_open()</A> (Get a handle for an SSL environment) is used to get storage for the SSL environment.</li>
<li><A HREF="gsk_secure_soc_close.htm">gsk_secure_soc_close()</A> (Close a secure session) is used to close a secure session and free all the associated resources for that secure session.</li>
<li><A HREF="gsk_secure_soc_init.htm">gsk_secure_soc_init()</A> (Negotiate a secure session) is used to negotiate a secure session, using the attributes set for the SSL environment and the secure session.</li>
<li><A HREF="gsk_secure_soc_misc.htm">gsk_secure_soc_misc()</A> (Perform miscellaneous functions for a secure session) is used to perform miscellaneous functions for a secure session.</li>
<li><A HREF="gsk_secure_soc_open.htm">gsk_secure_soc_open()</A> (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.</li>
<li><A HREF="gsk_secure_soc_read.htm">gsk_secure_soc_read()</A> (Receive data on a secure session) is used by a program to receive data from a secure session.</li>
<li><A HREF="gskstartinit.htm">gsk_secure_soc_startInit()</A> (Start asynchronous operation to negotiate a secure session) initiates an asynchronous negotiation of a secure session, using the attributes set for the SSL environment and the secure session.</li>
<li><A HREF="gskstartrecv.htm">gsk_secure_soc_startRecv()</A> (Start asynchronous receive operation on a secure session) is used to initiate an asynchronous receive operation on a secure session.</li>
<li><A HREF="gskstartsend.htm">gsk_secure_soc_startSend()</A> (Start asynchronous send operation on a secure session) is used to initiate an asynchronous send operation on a secure session.</li>
<li><A HREF="gsk_secure_soc_write.htm">gsk_secure_soc_write()</A> (Send data on a secure session) is used by a program to write data on a secure session.</li>
<li><A HREF="gsk_strerror.htm">gsk_strerror()</A> (Retrieve GSKit runtime error message) is used to retrieve an error message and associated text string that describes a return value that was returned from calling a GSKit API.</li>
</ul>
<!--***************API END PASTE***************-->
<p><strong>Note:</strong> These functions use header (include) files from the
library QSYSINC, which is optionally installable. Make sure QSYSINC is
installed on your system before using any of the functions. See <a href=
"unix13.htm">Header Files for UNIX-Type Functions</a> for the file and member
name of each header file.</p>
<p>See the following examples in the Socket programming topic for more information:</p>
<ul>
<li><a href="../rzab6/xgskserver.htm">Example: GSKit secure server
with asynchronous data receive</a></li>
<li><a href="../rzab6/xgskasynch.htm">Example: GSKit secure server
with asynchronous handshake</a></li>
<li><a href="../rzab6/xgskclient.htm">Example: Establish a secure
client with GSKit APIs</a></li>
</ul>
<hr>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="unix.htm">UNIX-Type APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>