1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Modifications for Lustre
6 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
8 * Author: Eric Mei <ericm@clusterfs.com>
12 * Adapted from MIT Kerberos 5-1.2.1 include/gssapi/gssapi.h
14 * Copyright (c) 2002 The Regents of the University of Michigan.
15 * All rights reserved.
17 * Andy Adamson <andros@umich.edu>
21 * Copyright 1993 by OpenVision Technologies, Inc.
23 * Permission to use, copy, modify, distribute, and sell this software
24 * and its documentation for any purpose is hereby granted without fee,
25 * provided that the above copyright notice appears in all copies and
26 * that both that copyright notice and this permission notice appear in
27 * supporting documentation, and that the name of OpenVision not be used
28 * in advertising or publicity pertaining to distribution of the software
29 * without specific, written prior permission. OpenVision makes no
30 * representations about the suitability of this software for any
31 * purpose. It is provided "as is" without express or implied warranty.
33 * OPENVISION DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
34 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
35 * EVENT SHALL OPENVISION BE LIABLE FOR ANY SPECIAL, INDIRECT OR
36 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
37 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
38 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
39 * PERFORMANCE OF THIS SOFTWARE.
42 #ifndef __PTLRPC_GSS_GSS_ERR_H_
43 #define __PTLRPC_GSS_GSS_ERR_H_
45 typedef unsigned int OM_uint32;
48 * Flag bits for context-level services.
50 #define GSS_C_DELEG_FLAG (1)
51 #define GSS_C_MUTUAL_FLAG (2)
52 #define GSS_C_REPLAY_FLAG (4)
53 #define GSS_C_SEQUENCE_FLAG (8)
54 #define GSS_C_CONF_FLAG (16)
55 #define GSS_C_INTEG_FLAG (32)
56 #define GSS_C_ANON_FLAG (64)
57 #define GSS_C_PROT_READY_FLAG (128)
58 #define GSS_C_TRANS_FLAG (256)
61 * Credential usage options
63 #define GSS_C_BOTH (0)
64 #define GSS_C_INITIATE (1)
65 #define GSS_C_ACCEPT (2)
68 * Status code types for gss_display_status
70 #define GSS_C_GSS_CODE (1)
71 #define GSS_C_MECH_CODE (2)
75 * Define the default Quality of Protection for per-message services. Note
76 * that an implementation that offers multiple levels of QOP may either reserve
77 * a value (for example zero, as assumed here) to mean "default protection", or
78 * alternatively may simply equate GSS_C_QOP_DEFAULT to a specific explicit
79 * QOP value. However a value of 0 should always be interpreted by a GSSAPI
80 * implementation as a request for the default protection level.
82 #define GSS_C_QOP_DEFAULT (0)
85 * Expiration time of 2^32-1 seconds means infinite lifetime for a
86 * credential or security context
88 #define GSS_C_INDEFINITE ((OM_uint32) 0xfffffffful)
91 /* Major status codes */
93 #define GSS_S_COMPLETE (0)
96 * Some "helper" definitions to make the status code macros obvious.
98 #define GSS_C_CALLING_ERROR_OFFSET (24)
99 #define GSS_C_ROUTINE_ERROR_OFFSET (16)
100 #define GSS_C_SUPPLEMENTARY_OFFSET (0)
101 #define GSS_C_CALLING_ERROR_MASK ((OM_uint32) 0377ul)
102 #define GSS_C_ROUTINE_ERROR_MASK ((OM_uint32) 0377ul)
103 #define GSS_C_SUPPLEMENTARY_MASK ((OM_uint32) 0177777ul)
106 * The macros that test status codes for error conditions. Note that the
107 * GSS_ERROR() macro has changed slightly from the V1 GSSAPI so that it now
108 * evaluates its argument only once.
110 #define GSS_CALLING_ERROR(x) \
111 ((x) & (GSS_C_CALLING_ERROR_MASK << GSS_C_CALLING_ERROR_OFFSET))
112 #define GSS_ROUTINE_ERROR(x) \
113 ((x) & (GSS_C_ROUTINE_ERROR_MASK << GSS_C_ROUTINE_ERROR_OFFSET))
114 #define GSS_SUPPLEMENTARY_INFO(x) \
115 ((x) & (GSS_C_SUPPLEMENTARY_MASK << GSS_C_SUPPLEMENTARY_OFFSET))
116 #define GSS_ERROR(x) \
117 ((x) & ((GSS_C_CALLING_ERROR_MASK << GSS_C_CALLING_ERROR_OFFSET) | \
118 (GSS_C_ROUTINE_ERROR_MASK << GSS_C_ROUTINE_ERROR_OFFSET)))
121 * Now the actual status code definitions
127 #define GSS_S_CALL_INACCESSIBLE_READ \
128 (((OM_uint32) 1ul) << GSS_C_CALLING_ERROR_OFFSET)
129 #define GSS_S_CALL_INACCESSIBLE_WRITE \
130 (((OM_uint32) 2ul) << GSS_C_CALLING_ERROR_OFFSET)
131 #define GSS_S_CALL_BAD_STRUCTURE \
132 (((OM_uint32) 3ul) << GSS_C_CALLING_ERROR_OFFSET)
137 #define GSS_S_BAD_MECH \
138 (((OM_uint32) 1ul) << GSS_C_ROUTINE_ERROR_OFFSET)
139 #define GSS_S_BAD_NAME \
140 (((OM_uint32) 2ul) << GSS_C_ROUTINE_ERROR_OFFSET)
141 #define GSS_S_BAD_NAMETYPE \
142 (((OM_uint32) 3ul) << GSS_C_ROUTINE_ERROR_OFFSET)
143 #define GSS_S_BAD_BINDINGS \
144 (((OM_uint32) 4ul) << GSS_C_ROUTINE_ERROR_OFFSET)
145 #define GSS_S_BAD_STATUS \
146 (((OM_uint32) 5ul) << GSS_C_ROUTINE_ERROR_OFFSET)
147 #define GSS_S_BAD_SIG \
148 (((OM_uint32) 6ul) << GSS_C_ROUTINE_ERROR_OFFSET)
149 #define GSS_S_NO_CRED \
150 (((OM_uint32) 7ul) << GSS_C_ROUTINE_ERROR_OFFSET)
151 #define GSS_S_NO_CONTEXT \
152 (((OM_uint32) 8ul) << GSS_C_ROUTINE_ERROR_OFFSET)
153 #define GSS_S_DEFECTIVE_TOKEN \
154 (((OM_uint32) 9ul) << GSS_C_ROUTINE_ERROR_OFFSET)
155 #define GSS_S_DEFECTIVE_CREDENTIAL \
156 (((OM_uint32) 10ul) << GSS_C_ROUTINE_ERROR_OFFSET)
157 #define GSS_S_CREDENTIALS_EXPIRED \
158 (((OM_uint32) 11ul) << GSS_C_ROUTINE_ERROR_OFFSET)
159 #define GSS_S_CONTEXT_EXPIRED \
160 (((OM_uint32) 12ul) << GSS_C_ROUTINE_ERROR_OFFSET)
161 #define GSS_S_FAILURE \
162 (((OM_uint32) 13ul) << GSS_C_ROUTINE_ERROR_OFFSET)
163 #define GSS_S_BAD_QOP \
164 (((OM_uint32) 14ul) << GSS_C_ROUTINE_ERROR_OFFSET)
165 #define GSS_S_UNAUTHORIZED \
166 (((OM_uint32) 15ul) << GSS_C_ROUTINE_ERROR_OFFSET)
167 #define GSS_S_UNAVAILABLE \
168 (((OM_uint32) 16ul) << GSS_C_ROUTINE_ERROR_OFFSET)
169 #define GSS_S_DUPLICATE_ELEMENT \
170 (((OM_uint32) 17ul) << GSS_C_ROUTINE_ERROR_OFFSET)
171 #define GSS_S_NAME_NOT_MN \
172 (((OM_uint32) 18ul) << GSS_C_ROUTINE_ERROR_OFFSET)
175 * Supplementary info bits:
177 #define GSS_S_CONTINUE_NEEDED (1 << (GSS_C_SUPPLEMENTARY_OFFSET + 0))
178 #define GSS_S_DUPLICATE_TOKEN (1 << (GSS_C_SUPPLEMENTARY_OFFSET + 1))
179 #define GSS_S_OLD_TOKEN (1 << (GSS_C_SUPPLEMENTARY_OFFSET + 2))
180 #define GSS_S_UNSEQ_TOKEN (1 << (GSS_C_SUPPLEMENTARY_OFFSET + 3))
181 #define GSS_S_GAP_TOKEN (1 << (GSS_C_SUPPLEMENTARY_OFFSET + 4))
183 /* XXXX these are not part of the GSSAPI C bindings! (but should be) */
185 #define GSS_CALLING_ERROR_FIELD(x) \
186 (((x) >> GSS_C_CALLING_ERROR_OFFSET) & GSS_C_CALLING_ERROR_MASK)
187 #define GSS_ROUTINE_ERROR_FIELD(x) \
188 (((x) >> GSS_C_ROUTINE_ERROR_OFFSET) & GSS_C_ROUTINE_ERROR_MASK)
189 #define GSS_SUPPLEMENTARY_INFO_FIELD(x) \
190 (((x) >> GSS_C_SUPPLEMENTARY_OFFSET) & GSS_C_SUPPLEMENTARY_MASK)
192 /* XXXX This is a necessary evil until the spec is fixed */
193 #define GSS_S_CRED_UNAVAIL GSS_S_FAILURE
195 #endif /* __PTLRPC_GSS_GSS_ERR_H_ */