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

207 lines
5.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>gss_canonicalize_name()--Reduce GSS Internal Name to Mechanism
Name</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: -->
<!-- Edited by Kersten Jan 02 -->
<!-- Created by Kent Hofer for V5R1 -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- End Header Records ============================================ -->
<!--Java sync-link-->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>gss_canonicalize_name()--Reduce GSS Internal Name to Mechanism Name</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax
<pre>
#include &lt;gssapi.h&gt;
OM_uint32 gss_canonicalize_name(
OM_uint32 * <em>minor_status</em>,
gss_name_t <em>input_name</em>,
gss_OID <em>mech_type</em>,
gss_name_t * <em>output_name</em>);
</pre>
&nbsp;&nbsp;Service Program Name: QSYS/QKRBGSS<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default public authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>gss_canonicalize_name()</strong> routine takes a GSS internal
name that contains multiple internal representations and returns a new GSS
internal name with a single name representation that corresponds to the
specified security mechanism. A name that represents a single security
mechanism is called a <strong>mechanism name</strong>.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>minor_status</strong>&nbsp;&nbsp;(Output)</dt>
<dd>A status code from the security mechanism.<br>
<br>
</dd>
<dt><strong>input_name</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The name to be processed. An error is returned if
<strong>GSS_C_NO_NAME</strong> is specified for this parameter.<br>
<br>
</dd>
<dt><strong>mech_type</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The security mechanism to be used.<br>
<br>
<p>The following security mechanisms are supported:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>gss_mech_krb5_old</em></td>
<td align="left" valign="top">Beta Kerberos V5 mechanism</td>
</tr>
<tr>
<td align="left" valign="top"><em>gss_mech_krb5</em></td>
<td align="left" valign="top">Kerberos V5 mechanism</td>
</tr>
</table>
<br>
<br>
</dd>
<dt><strong>output_name</strong>&nbsp;&nbsp;(Output)</dt>
<dd>The mechanism name. The gss_name_t returned by this parameter should be
released by calling the <strong>gss_release_name()</strong> function when it is
no longer needed.</dd>
</dl>
<br>
<h3>Return Value</h3>
<p>The return value is one of the following status codes:</p>
<dl>
<dt><strong>GSS_S_BAD_MECH</strong></dt>
<dd>The specified mechanism is not supported.<br>
<br>
</dd>
<dt><strong>GSS_S_BAD_NAME</strong></dt>
<dd>The input name is not valid.<br>
<br>
</dd>
<dt><strong>GSS_S_BAD_NAMETYPE</strong></dt>
<dd>The input name does not contain an element for the mechanism.<br>
<br>
</dd>
<dt><strong>GSS_S_COMPLETE</strong></dt>
<dd>The routine completed successfully.<br>
<br>
</dd>
<dt><strong>GSS_S_FAILURE</strong></dt>
<dd>The routine failed for reasons that are not defined at the GSS level. The
<em>minor_status</em> return parameter contains a mechanism-dependent error
code describing the reason for the failure.</dd>
</dl>
<br>
<h3>Authorities</h3>
<table border width="80%">
<tr>
<th align="left" valign="bottom">Object Referred to</th>
<th align="center" valign="bottom">Data Authority Required</th>
</tr>
<tr>
<td align="left" valign="top">Each directory in the path name preceding the
configuration file</td>
<td align="center" valign="top">*X</td>
</tr>
<tr>
<td align="left" valign="top">Configuration file</td>
<td align="center" valign="top">*R</td>
</tr>
</table>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPE3418 E</td>
<td width="85%" valign="top">Possible APAR condition or hardware failure.</td>
</tr>
</table>
<br>
<hr>
API introduced: V5R1
<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> <br>
<a href="unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by
category</a> </td>
</tr>
</table>
</center>
</body>
</html>