xref: /freebsd/crypto/heimdal/lib/gssapi/gssapi.3 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1.\" Copyright (c) 2003 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,v 1.5.2.2 2003/04/30 09:56:26 lha Exp $
33.\"
34.Dd January 23, 2003
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.Sh LIST OF FUNCTIONS
49These functions constitute the gssapi library,
50.Em libgssapi .
51Declarations for these functions may be obtained from the include file
52.Pa gssapi.h .
53.sp 2
54.nf
55.ta \w'gss_inquire_names_for_mech'u+2n +\w'Description goes here'u
56\fIName/Page\fP	\fIDescription\fP
57.ta \w'gss_inquire_names_for_mech'u+2n +\w'Description goes here'u+6nC
58.sp 5p
59gss_accept_sec_context.3
60gss_acquire_cred.3
61gss_add_cred.3
62gss_add_oid_set_member.3
63gss_canonicalize_name.3
64gss_compare_name.3
65gss_context_time.3
66gss_create_empty_oid_set.3
67gss_delete_sec_context.3
68gss_display_name.3
69gss_display_status.3
70gss_duplicate_name.3
71gss_export_name.3
72gss_export_sec_context.3
73gss_get_mic.3
74gss_import_name.3
75gss_import_sec_context.3
76gss_indicate_mechs.3
77gss_init_sec_context.3
78gss_inquire_context.3
79gss_inquire_cred.3
80gss_inquire_cred_by_mech.3
81gss_inquire_mechs_for_name.3
82gss_inquire_names_for_mech.3
83gss_krb5_copy_ccache.3
84gss_process_context_token.3
85gss_release_buffer.3
86gss_release_cred.3
87gss_release_name.3
88gss_release_oid_set.3
89gss_seal.3
90gss_sign.3
91gss_test_oid_set_member.3
92gss_unseal.3
93gss_unwrap.3
94gss_verify.3
95gss_verify_mic.3
96gss_wrap.3
97gss_wrap_size_limit.3
98.ta
99.Fi
100.Sh COMPATIBILITY
101The
102.Nm Heimdal
103GSS-API implementation had a bug in releases before 0.6 that made it
104fail to inter-operate when using DES3 with other GSS-API
105implementations when using
106.Fn gss_get_mic
107/
108.Fn gss_verify_mic .
109Its possible to modify the behavior of the generator of the MIC with
110the
111.Pa krb5.conf
112configuration file so that old clients/servers will still
113work.
114.Pp
115New clients/servers will try both the old and new MIC in Heimdal 0.6.
116In 0.7 it will check only if configured and the compatibility code
117will be removed in 0.8.
118.Pp
119Heimdal 0.6 still generates by default the broken GSS-API DES3 mic,
120this will change in 0.7 to generate correct des3 mic.
121.Pp
122To turn on compatibility with older clients and servers, change the
123.Nm [gssapi]
124.Ar broken_des3_mic
125in
126.Pa krb5.conf
127that contains a list of globbing expressions that will be matched
128against the server name.
129To turn off generation of the old (incompatible) mic of the MIC use
130.Nm [gssapi]
131.Ar correct_des3_mic .
132.Pp
133If a match for a entry is in both
134.Nm [gssapi]
135.Ar correct_des3_mic
136and
137.Nm [gssapi]
138.Ar correct_des3_mic ,
139the later will override.
140.Pp
141This config option modifies behaviour for both clients and servers.
142.Pp
143Example:
144.Bd -literal -offset indent
145[gssapi]
146	broken_des3_mic = cvs/*@SU.SE
147	broken_des3_mic = host/*@E.KTH.SE
148	correct_des3_mic = host/*@SU.SE
149.Ed
150.Sh BUGS
151All of 0.5.x versions of
152.Nm heimdal
153had broken token delegations in the client side, the server side was
154correct.
155.Sh SEE ALSO
156.Xr krb5 3 ,
157.Xr krb5.conf 5 ,
158.Xr kerberos 8
159