crypto/external/bsd/heimdal/dist/lib/gssapi/mech/mech.5

   1 .\"     $NetBSD: mech.5,v 1.4 2014/04/24 13:45:34 pettai Exp $
   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: src/lib/libgssapi/mech.5,v 1.1 2005/12/29 14:40:20 dfr Exp $
  28 .Dd November 14, 2005
  29 .Dt MECH 5
  30 .Os
  31 .Sh NAME
  32 .Nm mech ,
  33 .Nm qop
  34 .Nd "GSS-API Mechanism and QOP files"
  35 .Sh SYNOPSIS
  36 .Pa "/etc/gss/mech"
  37 .Pa "/etc/gss/qop"
  38 .Sh DESCRIPTION
  39 The
  40 .Pa "/etc/gss/mech"
  41 file contains a list of installed GSS-API security mechanisms.
  42 Each line of the file either contains a comment if the first character
  43 is '#' or it contains five fields with the following meanings:
  44 .Bl -tag
  45 .It Name
  46 The name of this GSS-API mechanism.
  47 .It Object identifier
  48 The OID for this mechanism.
  49 .It Library
  50 A shared library containing the implementation of this mechanism.
  51 .It Kernel module (optional)
  52 A kernel module containing the implementation of this mechanism (not
  53 yet supported in FreeBSD).
  54 .It Library options (optional)
  55 Optionsal parameters interpreted by the mechanism. Library options
  56 must be enclosed in brackets ([ ]) to differentiate them from the
  57 optional kernel module entry.
  58 .El
  59 .Pp
  60 The
  61 .Pa "/etc/gss/qop"
  62 file contains a list of Quality of Protection values for use with
  63 GSS-API.
  64 Each line of the file either contains a comment if the first character
  65 is '#' or it contains three fields with the following meanings:
  66 .Bl -tag
  67 .It QOP string
  68 The name of this Quality of Protection algorithm.
  69 .It QOP value
  70 The numeric value used to select this algorithm for use with GSS-API
  71 functions such as
  72 .Xr gss_get_mic 3 .
  73 .It Mechanism name
  74 The GSS-API mechanism name that corresponds to this algorithm.
  75 .El
  76 .Sh EXAMPLES
  77 This is a typical entry from
  78 .Pa "/etc/gss/mech" :
  79 .Bd -literal
  80 kerberosv5      1.2.840.113554.1.2.2    /usr/lib/libgssapi_krb5.so.8    -
  81 .Ed
  82 .Pp
  83 This is a typical entry from
  84 .Pa "/etc/gss/qop" :
  85 .Bd -literal
  86 GSS_KRB5_CONF_C_QOP_DES         0x0100  kerberosv5
  87 .Ed
  88 .Sh HISTORY
  89 The
  90 .Nm
  91 manual page example first appeared in
  92 .Fx 7.0 .
  93 .Sh AUTHORS
  94 This
  95 manual page was written by
  96 .An Doug Rabson Aq Mt dfr@FreeBSD.org .