ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaik_5.4.0.1/rzaikcwbcousesecuresockets.htm

103 lines
5.8 KiB
HTML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="reference" />
<meta name="DC.Title" content="cwbCO_UseSecureSockets" />
<meta name="DC.Relation" scheme="URI" content="rzaikcommapilist4.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="cwbco_usesecuresockets" />
<meta name="DC.Language" content="en-us" />
<!-- 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. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>cwbCO_UseSecureSockets</title>
</head>
<body id="cwbco_usesecuresockets"><a name="cwbco_usesecuresockets"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_UseSecureSockets</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Specify that all communication to the iSeries™ system
that uses the specified system object either must use secure sockets or must
not use secure sockets.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
UINT CWB_ENTRY cwbCO_UseSecureSockets(
cwbCO_SysHandle system,
cwb_Boolean useSecureSockets );</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysHandle system - input</dt>
<dd>Handle that previously was returned from <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span>.
It identifies the iServer system.</dd>
<dt class="dlterm">cwb_Boolean useSecureSockets - input</dt>
<dd>Specifies whether to require secure sockets use when communicating with
the iSeries system
that the specified system object handle represents. Use the appropriate value: <dl><dt class="dlterm">CWB_TRUE</dt>
<dd>Require secure sockets use for communication</dd>
<dt class="dlterm">CWB_FALSE</dt>
<dd>Do not use secure sockets for communication</dd>
<dt class="dlterm">CWB_USER_TIMEOUT</dt>
<dd>The connect timeout value associated with the system object expired before
the connection verification attempt completed, so we stopped waiting.</dd>
</dl>
</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Return Codes</h4><p>The following list shows common return
values:</p>
<dl><dt class="dlterm">CWB_OK</dt>
<dd>Successful completion.</dd>
<dt class="dlterm">CWB_INVALID_API_HANDLE</dt>
<dd>Invalid system handle.</dd>
<dt class="dlterm">CWB_SECURE_SOCKETS_NOTAVAIL</dt>
<dd>Secure sockets is not available. It may not be installed on the PC, prohibited
for this user, or not available on the iServer system.</dd>
<dt class="dlterm">CWB_RESTRICTED_BY_POLICY</dt>
<dd>A policy exists that prohibits the user from changing this value.</dd>
<dt class="dlterm">CWB_INV_AFTER_SIGNON</dt>
<dd>Signon has successfully occurred by using the specified system object,
so this setting no longer may be changed.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>Even if a connection to the specified service
already exists for the given system object, a new connection is attempted.
The attributes of the given system object, such as whether to use secure sockets,
are used for this connection attempt. It is therefore possible that connection
verification may fail given the passed system object, but might succeed to
the same system given a system object whose attributes are set differently.
The most obvious example of this is where secure sockets use is concerned,
since the non-secure-sockets version of the service may be running on the iSeries system,
while the secure-sockets version of the service might not be running, or vice-versa.</p>
<p>iSeries Access
for Windows<sup>®</sup> may
or may not be able to detect at the time this API is called if Secure Sockets
will be available for use at connect time for this iSeries system. Even if CWB_SECURE_SOCKETS_NOTAVAIL
is NOT returned, it may be determined at a later time that secure sockets
is not available.</p>
<p><img src="./delta.gif" alt="Start of change" />Although with limitations, iSeries Access
for Windows enforces
Federal Information Processing Standards (FIPS) compliance when SSL is used,
this API does not return an indication of whether FIPS compliance is on or
off. The only way to verify that FIPS-compliance is on or off is to visually
inspect the FIPS compliance checkbox in iSeries Access for Windows Properties.
For more information about FIPS and its use, see the User's Guide installed
with iSeries Access
for Windows. <img src="./deltaend.gif" alt="End of change" /></p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikcommapilist4.htm" title="Use the APIs to get and set other system object attributes, or determine if the attributes are restricted by policies.">Communications and security: Get and set attribute APIs</a></div>
</div>
</div>
</body>
</html>