304 lines
11 KiB
HTML
304 lines
11 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>ictxAuthenticationInfo - Authentication Context Authentication Info</TITLE>
|
||
|
|
<!-- Begin Header Records ========================================= -->
|
||
|
|
<!-- 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. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- Edited by Kersten Jan 02 -->
|
||
|
|
<!-- Created by Therese Dalton on 17 July 2001 -->
|
||
|
|
<!--File edited for Tidy July 2001 -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</HEAD>
|
||
|
|
<BODY>
|
||
|
|
<!--Java sync-link-->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<H2>ictxAuthenticationInfo--Authentication Context Authentication Info</H2>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- D E S C R I P T I O N -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<P>This describes the authentication information that will be added to the
|
||
|
|
authentication context, or was parsed from the authentication context.
|
||
|
|
See <a href="#eserver_notes">eServer Implementation
|
||
|
|
Notes</a> for details on platform-specific details.
|
||
|
|
|
||
|
|
</P>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- S T R U C T U R E -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<H3>
|
||
|
|
<A name=Header_41>Authentication Information</A>
|
||
|
|
</H3>
|
||
|
|
|
||
|
|
<P>The structure ictxAuthenticationInfo_t describes the
|
||
|
|
authentication information used for authentication
|
||
|
|
tokens that support authentication information.
|
||
|
|
New fields may be added to the end of this structure.
|
||
|
|
On a parse operation the fields will be returned if they exist
|
||
|
|
in the authentication context. Code that has been rebuilt with
|
||
|
|
the new structure may access these new fields.
|
||
|
|
A version supplied with the build information indicates which new
|
||
|
|
fields have been provided.
|
||
|
|
</P>
|
||
|
|
<P>
|
||
|
|
The layout for ictxAuthenticationInfo_t follows:</P>
|
||
|
|
<PRE>
|
||
|
|
typedef struct ictxAuthenticationInfo_t
|
||
|
|
{
|
||
|
|
char * user; /* Authenticated user
|
||
|
|
char * registry; /* Registry for the authenticated
|
||
|
|
user */
|
||
|
|
char * hostName; /* DNS host name */
|
||
|
|
char * authMech; /* Authentication mechanism */
|
||
|
|
char * securityLabel; /* Security Label */
|
||
|
|
char * implemSpecific; /* Additional data, optional */
|
||
|
|
|
||
|
|
} ictxAuthenticationInfo_t;
|
||
|
|
</PRE>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- F I E L D D E S C R I P T I O N S -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<H4>
|
||
|
|
<A name=Header_41>Field Descriptions</A>
|
||
|
|
</H4>
|
||
|
|
|
||
|
|
<DL>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- user -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<DT>
|
||
|
|
<STRONG>user</STRONG>
|
||
|
|
<DD>The name of the user that has been authenticated by the caller.
|
||
|
|
This user name may be used by a mapping lookup
|
||
|
|
operation for the endpoint application. <BR><BR>
|
||
|
|
</DD>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- registry -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<DT>
|
||
|
|
<STRONG>registry</STRONG>
|
||
|
|
<DD>The name of the user registry for the authenticated user. This
|
||
|
|
registry name may be used by a mapping lookup operation
|
||
|
|
for the endpoint application.<BR><BR>
|
||
|
|
</DD>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- hostName -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<DT>
|
||
|
|
<STRONG>hostName</STRONG>
|
||
|
|
<DD>The DNS name of the host system where the user was authenticated.
|
||
|
|
<BR><BR>
|
||
|
|
</DD>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- authMech -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<DT>
|
||
|
|
<STRONG>authMech</STRONG>
|
||
|
|
<DD>The mechanism used to authenticate the user.
|
||
|
|
<BR><BR>
|
||
|
|
</DD>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- securityLabel -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<DT>
|
||
|
|
<STRONG>securityLabel</STRONG>
|
||
|
|
<DD>The security label associated with this user.
|
||
|
|
<BR><BR>
|
||
|
|
</DD>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- implemSpecific -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<DT>
|
||
|
|
<STRONG>implemSpecific</STRONG>
|
||
|
|
<DD>This is implementation specific data that would be added to
|
||
|
|
an authentication context.
|
||
|
|
The sender and the receiver must agree on format and content of this data.
|
||
|
|
The recommended layout for this data would be a series of the following:
|
||
|
|
<PRE>
|
||
|
|
<LABEL>xxxxx</LABEL><DATA>yyyyy</DATA>
|
||
|
|
</PRE>
|
||
|
|
An example would be:
|
||
|
|
<PRE>
|
||
|
|
<LABEL>TCPIP address</LABEL><DATA>9.5.6.132</DATA>
|
||
|
|
</PRE>
|
||
|
|
<BR>
|
||
|
|
</DD>
|
||
|
|
|
||
|
|
</DL>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- B U I L D I N F O R M A T I O N -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<H3>
|
||
|
|
<A name=Header_41>Build Information</A>
|
||
|
|
</H3>
|
||
|
|
|
||
|
|
<P>The authentication information used for building of an
|
||
|
|
authentication context is contained in the ictxAuthInfo
|
||
|
|
structure.
|
||
|
|
The layout for ictxAuthInfo follows:</P>
|
||
|
|
<PRE>
|
||
|
|
typedef struct ictxAuthInfo
|
||
|
|
{
|
||
|
|
enum ictxAuthInfoFormat format;
|
||
|
|
union
|
||
|
|
{
|
||
|
|
ictxAuthInfoFormat0_t * format0;
|
||
|
|
} authInfo;
|
||
|
|
} ictxAuthInfo_t;
|
||
|
|
</PRE>
|
||
|
|
<P>
|
||
|
|
<BR>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- F I E L D D E S C R I P T I O N S -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<H4>
|
||
|
|
<A name=Header_41>Field Descriptions</A>
|
||
|
|
</H4>
|
||
|
|
<DL>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- format -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<DT>
|
||
|
|
<STRONG>format</STRONG>
|
||
|
|
<DD>Valid values for the format are:
|
||
|
|
<PRE>
|
||
|
|
enum ictxAuthInfoFormat {
|
||
|
|
ICTX_AUTH_INFO_FORMAT_0
|
||
|
|
|
||
|
|
};
|
||
|
|
</PRE>
|
||
|
|
<P>When format is ICTX_AUTH_INFO_FORMAT_0 (0), the <em>authInfo</em> field
|
||
|
|
must contain an ictxAuthInfoFormat0_t structure. <BR>
|
||
|
|
<PRE>
|
||
|
|
typedef struct ictxAuthInfoFormat0
|
||
|
|
{
|
||
|
|
int version;
|
||
|
|
ictxAuthenticationInfo_t * authInfo;
|
||
|
|
} ictxAuthInfoFormat0_t;
|
||
|
|
</PRE>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- version -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<DT>
|
||
|
|
<STRONG>version</STRONG>
|
||
|
|
<DD>The version indicates which fields are available in the
|
||
|
|
the <em>authInfo</em> field. Version 0 corresponds to the initial structure
|
||
|
|
defined here. In the future if new fields are added to the authInfo
|
||
|
|
structure and the users wants to pass that information in for
|
||
|
|
a build they can indicate the new version of the structure that
|
||
|
|
they are providing.
|
||
|
|
<BR>
|
||
|
|
<BR>
|
||
|
|
</DD>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- authInfo -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<DT>
|
||
|
|
<STRONG>authInfo</STRONG>
|
||
|
|
<DD>This is the structure that contains the authentication
|
||
|
|
information fields.
|
||
|
|
<BR>
|
||
|
|
</DD>
|
||
|
|
|
||
|
|
</DL>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- E S E R V E R N O T E S -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
|
||
|
|
<h3>
|
||
|
|
<a name="eserver_notes">eServer Implementation Notes</a>
|
||
|
|
</h3>
|
||
|
|
<ol>
|
||
|
|
<li>
|
||
|
|
<strong>AIX implementation details:</strong>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
None.
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<strong>Linux implementation details:</strong>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
None.
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<strong>i5/OS implementation details:</strong><br>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
None.
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<strong>Windows implementation details:</strong>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
None.
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<strong>z/OS implementation notes:</strong><br>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
None.
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ol>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- The End -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center">
|
||
|
|
<a href="#Top_Of_Page">Top</a> |
|
||
|
|
<a href="sec.htm">Security APIs</a> |
|
||
|
|
<a href="aplist.htm">APIs by category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</BODY>
|
||
|
|
</HTML>
|