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