freebsd man page for gss_inquire_mechs_for_name

GSS_INQUIRE_MECHS_FOR_NAME(3)					Programmer's Manual				     GSS_INQUIRE_MECHS_FOR_NAME(3)

NAME
     gss_inquire_mechs_for_name -- List mechanisms that support the specified name-type

SYNOPSIS
     #include <gssapi/gssapi.h>

     OM_uint32
     gss_inquire_mechs_for_name(OM_uint32 *minor_status, const gss_name_t input_name, gss_OID_set *mech_types);

DESCRIPTION
     Returns the set of mechanisms supported by the GSS-API implementation that may be able to process the specified name.

     Each mechanism returned will recognize at least one element within the name.  It is permissible for this routine to be implemented within a
     mechanism-independent GSS-API layer, using the type information contained within the presented name, and based on registration information
     provided by individual mechanism implementations.	This means that the returned mech_types set may indicate that a particular mechanism will
     understand the name when in fact it would refuse to accept the name as input to gss_canonicalize_name(), gss_init_sec_context(),
     gss_acquire_cred() or gss_add_cred() (due to some property of the specific name, as opposed to the name type).  Thus this routine should be
     used only as a pre-filter for a call to a subsequent mechanism-specific routine.

PARAMETERS
     minor_status  Mechanism specific status code.

     input_name    The name to which the inquiry relates.

     mech_types    Set of mechanisms that may support the specified name.  The returned OID set must be freed by the caller after use with a call
		   to gss_release_oid_set().

RETURN VALUES
     GSS_S_COMPLETE  Successful completion

     GSS_S_BAD_NAME  The input_name parameter was ill-formed

SEE ALSO
     gss_release_oid_set(3)

STANDARDS
     RFC 2743  Generic Security Service Application Program Interface Version 2, Update 1

     RFC 2744  Generic Security Service API Version 2 : C-bindings

HISTORY
     The gss_inquire_mechs_for_name function first appeared in FreeBSD 7.0.

AUTHORS
     John Wray, Iris Associates

COPYRIGHT
     Copyright (C) The Internet Society (2000).  All Rights Reserved.

     This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or
     assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, pro-
     vided that the above copyright notice and this paragraph are included on all such copies and derivative works.  However, this document itself
     may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organiza-
     tions, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet
     Standards process must be followed, or as required to translate it into languages other than English.

     The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns.

     This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK
     FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT
     INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

BSD
								 January 26, 2010							       BSD