lib/libgssapi/gss_inquire_mechs_for_name.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2005 Doug Rabson
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\"     $FreeBSD$
  28 .\"
  29 .\" The following commands are required for all man pages.
  30 .Dd November 12, 2005
  31 .Os
  32 .Dt GSS_INQUIRE_MECHS_FOR_NAME 3 PRM
  33 .Sh NAME
  34 .Nm gss_inquire_mechs_for_name
  35 .Nd List mechanisms that support the specified name-type
  36 .\" This next command is for sections 2 and 3 only.
  37 .\" .Sh LIBRARY
  38 .Sh SYNOPSIS
  39 .In "gssapi/gssapi.h"
  40 .Ft OM_uint32
  41 .Fo gss_inquire_mechs_for_name
  42 .Fa "OM_uint32 *minor_status"
  43 .Fa "const gss_name_t input_name"
  44 .Fa "gss_OID_set *mech_types"
  45 .Fc
  46 .Sh DESCRIPTION
  47 Returns the set of mechanisms supported by the GSS-API implementation
  48 that may be able to process the specified name.
  49 .Pp
  50
  51 Each mechanism returned will recognize at least one element within the
  52 name.
  53 It is permissible for this routine to be implemented within a
  54 mechanism-independent GSS-API layer,
  55 using the type information contained within the presented name,
  56 and based on registration information provided by individual mechanism
  57 implementations.
  58 This means that the returned
  59 .Fa mech_types
  60 set may indicate that a particular mechanism will understand the name
  61 when in fact it would refuse to accept the name as input to
  62 .Fn gss_canonicalize_name ,
  63 .Fn gss_init_sec_context ,
  64 .Fn gss_acquire_cred
  65 or
  66 .Fn gss_add_cred
  67 (due to some property of the specific name, as opposed to the name
  68 type).
  69 Thus this routine should be used only as a pre-filter for a call to a
  70 subsequent mechanism-specific routine.
  71 .Sh PARAMETERS
  72 .Bl -tag
  73 .It minor_status
  74 Mechanism specific status code.
  75 .It input_name
  76 The name to which the inquiry relates.
  77 .It mech_types
  78 Set of mechanisms that may support the specified name.
  79 The returned OID set must be freed by the caller after use with a call
  80 to
  81 .Fn gss_release_oid_set .
  82 .El
  83 .Sh RETURN VALUES
  84 .Bl -tag
  85 .It GSS_S_COMPLETE
  86 Successful completion
  87 .It GSS_S_BAD_NAME
  88 The
  89 .Fa input_name
  90 parameter was ill-formed
  91 .El
  92 .Sh SEE ALSO
  93 .Xr gss_release_oid_set 3
  94 .Sh STANDARDS
  95 .Bl -tag
  96 .It RFC 2743
  97 Generic Security Service Application Program Interface Version 2, Update 1
  98 .It RFC 2744
  99 Generic Security Service API Version 2 : C-bindings
 100 .\" .Sh HISTORY
 101 .El
 102 .Sh HISTORY
 103 The
 104 .Nm
 105 manual page example first appeared in
 106 .Fx 7.0 .
 107 .Sh AUTHORS
 108 John Wray, Iris Associates
 109 .Sh COPYRIGHT
 110 Copyright (C) The Internet Society (2000).  All Rights Reserved.
 111 .Pp
 112 This document and translations of it may be copied and furnished to
 113 others, and derivative works that comment on or otherwise explain it
 114 or assist in its implementation may be prepared, copied, published
 115 and distributed, in whole or in part, without restriction of any
 116 kind, provided that the above copyright notice and this paragraph are
 117 included on all such copies and derivative works.  However, this
 118 document itself may not be modified in any way, such as by removing
 119 the copyright notice or references to the Internet Society or other
 120 Internet organizations, except as needed for the purpose of
 121 developing Internet standards in which case the procedures for
 122 copyrights defined in the Internet Standards process must be
 123 followed, or as required to translate it into languages other than
 124 English.
 125 .Pp
 126 The limited permissions granted above are perpetual and will not be
 127 revoked by the Internet Society or its successors or assigns.
 128 .Pp
 129 This document and the information contained herein is provided on an
 130 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 131 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 132 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 133 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 134 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.