xref: /freebsd/crypto/heimdal/lib/gssapi/mech/mech.5 (revision 81ad6265)
1.\" Copyright (c) 2005 Doug Rabson
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD: src/lib/libgssapi/mech.5,v 1.1 2005/12/29 14:40:20 dfr Exp $
26.Dd November 14, 2005
27.Dt MECH 5
28.Os
29.Sh NAME
30.Nm mech ,
31.Nm qop
32.Nd "GSS-API Mechanism and QOP files"
33.Sh SYNOPSIS
34.Pa "/etc/gss/mech"
35.Pa "/etc/gss/qop"
36.Sh DESCRIPTION
37The
38.Pa "/etc/gss/mech"
39file contains a list of installed GSS-API security mechanisms.
40Each line of the file either contains a comment if the first character
41is '#' or it contains five fields with the following meanings:
42.Bl -tag
43.It Name
44The name of this GSS-API mechanism.
45.It Object identifier
46The OID for this mechanism.
47.It Library
48A shared library containing the implementation of this mechanism.
49.It Kernel module (optional)
50A kernel module containing the implementation of this mechanism (not
51yet supported in FreeBSD).
52.It Library options (optional)
53Optionsal parameters interpreted by the mechanism. Library options
54must be enclosed in brackets ([ ]) to differentiate them from the
55optional kernel module entry.
56.El
57.Pp
58The
59.Pa "/etc/gss/qop"
60file contains a list of Quality of Protection values for use with
61GSS-API.
62Each line of the file either contains a comment if the first character
63is '#' or it contains three fields with the following meanings:
64.Bl -tag
65.It QOP string
66The name of this Quality of Protection algorithm.
67.It QOP value
68The numeric value used to select this algorithm for use with GSS-API
69functions such as
70.Xr gss_get_mic 3 .
71.It Mechanism name
72The GSS-API mechanism name that corresponds to this algorithm.
73.El
74.Sh EXAMPLES
75This is a typical entry from
76.Pa "/etc/gss/mech" :
77.Bd -literal
78kerberosv5	1.2.840.113554.1.2.2	/usr/lib/libgssapi_krb5.so.8	-
79.Ed
80.Pp
81This is a typical entry from
82.Pa "/etc/gss/qop" :
83.Bd -literal
84GSS_KRB5_CONF_C_QOP_DES		0x0100	kerberosv5
85.Ed
86.Sh HISTORY
87The
88.Nm
89manual page example first appeared in
90.Fx 7.0 .
91.Sh AUTHORS
92This
93manual page was written by
94.An Doug Rabson Aq dfr@FreeBSD.org .
95