xref: /netbsd-src/crypto/external/bsd/heimdal/dist/lib/gssapi/gssapi.3 (revision 7a6a7ae08ac6c612f0fbb0d4425825c6be2a9050)
1.\"	$NetBSD: gssapi.3,v 1.1.1.1 2011/04/13 18:14:43 elric Exp $
2.\"
3.\" Copyright (c) 2003 - 2005 Kungliga Tekniska Högskolan
4.\" (Royal Institute of Technology, Stockholm, Sweden).
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" 3. Neither the name of the Institute nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" $Id: gssapi.3,v 1.1.1.1 2011/04/13 18:14:43 elric Exp $
35.\"
36.Dd April 20, 2005
37.Dt GSSAPI 3
38.Os
39.Sh NAME
40.Nm gssapi
41.Nd Generic Security Service Application Program Interface library
42.Sh LIBRARY
43GSS-API Library (libgssapi, -lgssapi)
44.Sh DESCRIPTION
45The Generic Security Service Application Program Interface (GSS-API)
46provides security services to callers in a generic fashion,
47supportable with a range of underlying mechanisms and technologies and
48hence allowing source-level portability of applications to different
49environments.
50.Pp
51The GSS-API implementation in Heimdal implements the Kerberos 5 and
52the SPNEGO GSS-API security mechanisms.
53.Sh LIST OF FUNCTIONS
54These functions constitute the gssapi library,
55.Em libgssapi .
56Declarations for these functions may be obtained from the include file
57.Pa gssapi/gssapi.h .
58.sp 2
59.nf
60.ta \w'gss_inquire_names_for_mech'u+2n +\w'Description goes here'u
61\fIName/Page\fP	\fIDescription\fP
62.ta \w'gss_inquire_names_for_mech'u+2n +\w'Description goes here'u+6nC
63.sp 5p
64gss_accept_sec_context.3
65gss_acquire_cred.3
66gss_add_cred.3
67gss_add_oid_set_member.3
68gss_canonicalize_name.3
69gss_compare_name.3
70gss_context_time.3
71gss_create_empty_oid_set.3
72gss_delete_sec_context.3
73gss_display_name.3
74gss_display_status.3
75gss_duplicate_name.3
76gss_export_name.3
77gss_export_sec_context.3
78gss_get_mic.3
79gss_import_name.3
80gss_import_sec_context.3
81gss_indicate_mechs.3
82gss_init_sec_context.3
83gss_inquire_context.3
84gss_inquire_cred.3
85gss_inquire_cred_by_mech.3
86gss_inquire_mechs_for_name.3
87gss_inquire_names_for_mech.3
88gss_krb5_ccache_name.3
89gss_krb5_compat_des3_mic.3
90gss_krb5_copy_ccache.3
91gss_krb5_extract_authz_data_from_sec_context.3
92gss_krb5_import_ccache.3
93gss_process_context_token.3
94gss_release_buffer.3
95gss_release_cred.3
96gss_release_name.3
97gss_release_oid_set.3
98gss_seal.3
99gss_sign.3
100gss_test_oid_set_member.3
101gss_unseal.3
102gss_unwrap.3
103gss_verify.3
104gss_verify_mic.3
105gss_wrap.3
106gss_wrap_size_limit.3
107.ta
108.Fi
109.Sh COMPATIBILITY
110The
111.Nm Heimdal
112GSS-API implementation had a bug in releases before 0.6 that made it
113fail to inter-operate when using DES3 with other GSS-API
114implementations when using
115.Fn gss_get_mic
116/
117.Fn gss_verify_mic .
118It is possible to modify the behavior of the generator of the MIC with
119the
120.Pa krb5.conf
121configuration file so that old clients/servers will still
122work.
123.Pp
124New clients/servers will try both the old and new MIC in Heimdal 0.6.
125In 0.7 it will check only if configured - the compatibility code will
126be removed in 0.8.
127.Pp
128Heimdal 0.6 still generates by default the broken GSS-API DES3 mic,
129this will change in 0.7 to generate correct des3 mic.
130.Pp
131To turn on compatibility with older clients and servers, change the
132.Nm [gssapi]
133.Ar broken_des3_mic
134in
135.Pa krb5.conf
136that contains a list of globbing expressions that will be matched
137against the server name.
138To turn off generation of the old (incompatible) mic of the MIC use
139.Nm [gssapi]
140.Ar correct_des3_mic .
141.Pp
142If a match for a entry is in both
143.Nm [gssapi]
144.Ar correct_des3_mic
145and
146.Nm [gssapi]
147.Ar broken_des3_mic ,
148the later will override.
149.Pp
150This config option modifies behaviour for both clients and servers.
151.Pp
152Microsoft implemented SPNEGO to Windows2000, however, they manage to
153get it wrong, their implementation didn't fill in the MechListMIC in
154the reply token with the right content.
155There is a work around for this problem, but not all implementation
156support it.
157.Pp
158Heimdal defaults to correct SPNEGO when the the kerberos
159implementation uses CFX, or when it is configured by the user.
160To turn on compatibility with peers, use option
161.Nm [gssapi]
162.Ar require_mechlist_mic .
163.Sh EXAMPLES
164.Bd -literal -offset indent
165[gssapi]
166	broken_des3_mic = cvs/*@SU.SE
167	broken_des3_mic = host/*@E.KTH.SE
168	correct_des3_mic = host/*@SU.SE
169	require_mechlist_mic = host/*@SU.SE
170.Ed
171.Sh BUGS
172All of 0.5.x versions of
173.Nm heimdal
174had broken token delegations in the client side, the server side was
175correct.
176.Sh SEE ALSO
177.Xr krb5 3 ,
178.Xr krb5.conf 5 ,
179.Xr kerberos 8
180