lib/librpcsec_gss/rpc_gss_mech_to_oid.3

   1 .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/
   2 .\" Authors: Doug Rabson <dfr@rabson.org>
   3 .\" Developed with Red Inc: Alfred Perlstein <alfred@FreeBSD.org>
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .Dd January 26, 2010
  28 .Dt RPC_GSS_MECH_TO_OID 3
  29 .Os
  30 .Sh NAME
  31 .Nm rpc_gss_mech_to_oid
  32 .Nd "Convert a mechanism name to a GSS-API oid"
  33 .Sh LIBRARY
  34 .Lb librpcsec_gss
  35 .Sh SYNOPSIS
  36 .In rpc/rpcsec_gss.h
  37 .Ft bool_t
  38 .Fn rpc_gss_mech_to_oid "const char *mech" "gss_OID *oid_ret"
  39 .Sh DESCRIPTION
  40 This function looks up a mechanism by name by reading the file
  41 /etc/gss/mech.
  42 .Sh PARAMETERS
  43 .Bl -tag -width ".It oid_ret"
  44 .It mech
  45 The mechanism name to search for
  46 .It oid_ret
  47 If the mechanism is found, the corresponding GSS-API oid is returned
  48 in
  49 .Fa *oid_ret
  50 .El
  51 .Sh RETURN VALUES
  52 If the mechanism is found,
  53 .Dv TRUE
  54 is returned, otherwise
  55 .Dv FALSE .
  56 .Sh SEE ALSO
  57 .Xr rpc 3 ,
  58 .Xr gssapi 3 ,
  59 .Xr rpcset_gss 3
  60 .Sh HISTORY
  61 The
  62 .Nm
  63 function first appeared in
  64 .Fx 8.0 .
  65 .Sh AUTHORS
  66 This
  67 manual page was written by
  68 .An Doug Rabson Aq dfr@FreeBSD.org .