2 * Copyright (c) 2008 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <kgssapi/gssapi.h>
35 #define MAX_GSS_MECH 64
39 * Define the types of security service required for rpc_gss_seccreate().
42 rpc_gss_svc_default = 0,
44 rpc_gss_svc_integrity = 2,
45 rpc_gss_svc_privacy = 3
49 * Structure containing options for rpc_gss_seccreate().
52 int req_flags; /* GSS request bits */
53 int time_req; /* requested credential lifetime */
54 gss_cred_id_t my_cred; /* GSS credential */
55 gss_channel_bindings_t input_channel_bindings;
56 } rpc_gss_options_req_t;
59 * Structure containing options returned by rpc_gss_seccreate().
67 gss_ctx_id_t gss_context;
68 char actual_mechanism[MAX_GSS_MECH];
69 } rpc_gss_options_ret_t;
72 * Client principal type. Used as an argument to
73 * rpc_gss_get_principal_name(). Also referenced by the
74 * rpc_gss_rawcred_t structure.
79 } *rpc_gss_principal_t;
82 * Structure for raw credentials used by rpc_gss_getcred() and
83 * rpc_gss_set_callback().
86 u_int version; /* RPC version number */
87 const char *mechanism; /* security mechanism */
88 const char *qop; /* quality of protection */
89 rpc_gss_principal_t client_principal; /* client name */
90 const char *svc_principal; /* server name */
91 rpc_gss_service_t service; /* service type */
95 * Unix credentials derived from raw credentials. Returned by
99 uid_t uid; /* user ID */
100 gid_t gid; /* group ID */
102 gid_t *gidlist; /* list of groups */
106 * Structure used to enforce a particular QOP and service.
110 rpc_gss_rawcred_t *raw_cred;
114 * Callback structure used by rpc_gss_set_callback().
117 u_int program; /* RPC program number */
118 u_int version; /* RPC version number */
119 /* user defined callback */
120 bool_t (*callback)(struct svc_req *req,
122 gss_ctx_id_t gss_context,
123 rpc_gss_lock_t *lock,
125 } rpc_gss_callback_t;
128 * Structure used to return error information by rpc_gss_get_error()
132 int system_error; /* same as errno */
136 * Values for rpc_gss_error
138 #define RPC_GSS_ER_SUCCESS 0 /* no error */
139 #define RPC_GSS_ER_SYSTEMERROR 1 /* system error */
145 * Set up a structure of entry points for the kgssapi module and inline
146 * functions named rpc_gss_XXX_call() to use them, so that the kgssapi
147 * module doesn't need to be loaded for the NFS modules to work using
148 * AUTH_SYS. The kgssapi modules will be loaded by the gssd(8) daemon
149 * when it is started up and the entry points will then be filled in.
151 typedef AUTH *rpc_gss_secfind_ftype(CLIENT *clnt, struct ucred *cred,
152 const char *principal, gss_OID mech_oid,
153 rpc_gss_service_t service);
154 typedef void rpc_gss_secpurge_ftype(CLIENT *clnt);
155 typedef AUTH *rpc_gss_seccreate_ftype(CLIENT *clnt, struct ucred *cred,
156 const char *principal, const char *mechanism,
157 rpc_gss_service_t service, const char *qop,
158 rpc_gss_options_req_t *options_req,
159 rpc_gss_options_ret_t *options_ret);
160 typedef bool_t rpc_gss_set_defaults_ftype(AUTH *auth,
161 rpc_gss_service_t service, const char *qop);
162 typedef int rpc_gss_max_data_length_ftype(AUTH *handle,
163 int max_tp_unit_len);
164 typedef void rpc_gss_get_error_ftype(rpc_gss_error_t *error);
165 typedef bool_t rpc_gss_mech_to_oid_ftype(const char *mech, gss_OID *oid_ret);
166 typedef bool_t rpc_gss_oid_to_mech_ftype(gss_OID oid, const char **mech_ret);
167 typedef bool_t rpc_gss_qop_to_num_ftype(const char *qop, const char *mech,
169 typedef const char **rpc_gss_get_mechanisms_ftype(void);
170 typedef bool_t rpc_gss_get_versions_ftype(u_int *vers_hi, u_int *vers_lo);
171 typedef bool_t rpc_gss_is_installed_ftype(const char *mech);
172 typedef bool_t rpc_gss_set_svc_name_ftype(const char *principal,
173 const char *mechanism, u_int req_time, u_int program,
175 typedef void rpc_gss_clear_svc_name_ftype(u_int program, u_int version);
176 typedef bool_t rpc_gss_getcred_ftype(struct svc_req *req,
177 rpc_gss_rawcred_t **rcred,
178 rpc_gss_ucred_t **ucred, void **cookie);
179 typedef bool_t rpc_gss_set_callback_ftype(rpc_gss_callback_t *cb);
180 typedef void rpc_gss_clear_callback_ftype(rpc_gss_callback_t *cb);
181 typedef bool_t rpc_gss_get_principal_name_ftype(rpc_gss_principal_t *principal,
182 const char *mech, const char *name, const char *node,
184 typedef int rpc_gss_svc_max_data_length_ftype(struct svc_req *req,
185 int max_tp_unit_len);
187 struct rpc_gss_entries {
188 rpc_gss_secfind_ftype *rpc_gss_secfind;
189 rpc_gss_secpurge_ftype *rpc_gss_secpurge;
190 rpc_gss_seccreate_ftype *rpc_gss_seccreate;
191 rpc_gss_set_defaults_ftype *rpc_gss_set_defaults;
192 rpc_gss_max_data_length_ftype *rpc_gss_max_data_length;
193 rpc_gss_get_error_ftype *rpc_gss_get_error;
194 rpc_gss_mech_to_oid_ftype *rpc_gss_mech_to_oid;
195 rpc_gss_oid_to_mech_ftype *rpc_gss_oid_to_mech;
196 rpc_gss_qop_to_num_ftype *rpc_gss_qop_to_num;
197 rpc_gss_get_mechanisms_ftype *rpc_gss_get_mechanisms;
198 rpc_gss_get_versions_ftype *rpc_gss_get_versions;
199 rpc_gss_is_installed_ftype *rpc_gss_is_installed;
200 rpc_gss_set_svc_name_ftype *rpc_gss_set_svc_name;
201 rpc_gss_clear_svc_name_ftype *rpc_gss_clear_svc_name;
202 rpc_gss_getcred_ftype *rpc_gss_getcred;
203 rpc_gss_set_callback_ftype *rpc_gss_set_callback;
204 rpc_gss_clear_callback_ftype *rpc_gss_clear_callback;
205 rpc_gss_get_principal_name_ftype *rpc_gss_get_principal_name;
206 rpc_gss_svc_max_data_length_ftype *rpc_gss_svc_max_data_length;
208 extern struct rpc_gss_entries rpc_gss_entries;
210 /* Functions to access the entry points. */
211 static __inline AUTH *
212 rpc_gss_secfind_call(CLIENT *clnt, struct ucred *cred, const char *principal,
213 gss_OID mech_oid, rpc_gss_service_t service)
217 if (rpc_gss_entries.rpc_gss_secfind != NULL)
218 ret = (*rpc_gss_entries.rpc_gss_secfind)(clnt, cred, principal,
224 rpc_gss_secpurge_call(CLIENT *clnt)
227 if (rpc_gss_entries.rpc_gss_secpurge != NULL)
228 (*rpc_gss_entries.rpc_gss_secpurge)(clnt);
231 static __inline AUTH *
232 rpc_gss_seccreate_call(CLIENT *clnt, struct ucred *cred, const char *principal,
233 const char *mechanism, rpc_gss_service_t service, const char *qop,
234 rpc_gss_options_req_t *options_req, rpc_gss_options_ret_t *options_ret)
238 if (rpc_gss_entries.rpc_gss_seccreate != NULL)
239 ret = (*rpc_gss_entries.rpc_gss_seccreate)(clnt, cred,
240 principal, mechanism, service, qop, options_req,
245 static __inline bool_t
246 rpc_gss_set_defaults_call(AUTH *auth, rpc_gss_service_t service,
251 if (rpc_gss_entries.rpc_gss_set_defaults != NULL)
252 ret = (*rpc_gss_entries.rpc_gss_set_defaults)(auth, service,
258 rpc_gss_max_data_length_call(AUTH *handle, int max_tp_unit_len)
262 if (rpc_gss_entries.rpc_gss_max_data_length != NULL)
263 ret = (*rpc_gss_entries.rpc_gss_max_data_length)(handle,
269 rpc_gss_get_error_call(rpc_gss_error_t *error)
272 if (rpc_gss_entries.rpc_gss_get_error != NULL)
273 (*rpc_gss_entries.rpc_gss_get_error)(error);
276 static __inline bool_t
277 rpc_gss_mech_to_oid_call(const char *mech, gss_OID *oid_ret)
281 if (rpc_gss_entries.rpc_gss_mech_to_oid != NULL)
282 ret = (*rpc_gss_entries.rpc_gss_mech_to_oid)(mech, oid_ret);
286 static __inline bool_t
287 rpc_gss_oid_to_mech_call(gss_OID oid, const char **mech_ret)
291 if (rpc_gss_entries.rpc_gss_oid_to_mech != NULL)
292 ret = (*rpc_gss_entries.rpc_gss_oid_to_mech)(oid, mech_ret);
296 static __inline bool_t
297 rpc_gss_qop_to_num_call(const char *qop, const char *mech, u_int *num_ret)
301 if (rpc_gss_entries.rpc_gss_qop_to_num != NULL)
302 ret = (*rpc_gss_entries.rpc_gss_qop_to_num)(qop, mech, num_ret);
306 static __inline const char **
307 rpc_gss_get_mechanisms_call(void)
309 const char **ret = NULL;
311 if (rpc_gss_entries.rpc_gss_get_mechanisms != NULL)
312 ret = (*rpc_gss_entries.rpc_gss_get_mechanisms)();
316 static __inline bool_t
317 rpc_gss_get_versions_call(u_int *vers_hi, u_int *vers_lo)
321 if (rpc_gss_entries.rpc_gss_get_versions != NULL)
322 ret = (*rpc_gss_entries.rpc_gss_get_versions)(vers_hi, vers_lo);
326 static __inline bool_t
327 rpc_gss_is_installed_call(const char *mech)
331 if (rpc_gss_entries.rpc_gss_is_installed != NULL)
332 ret = (*rpc_gss_entries.rpc_gss_is_installed)(mech);
336 static __inline bool_t
337 rpc_gss_set_svc_name_call(const char *principal, const char *mechanism,
338 u_int req_time, u_int program, u_int version)
342 if (rpc_gss_entries.rpc_gss_set_svc_name != NULL)
343 ret = (*rpc_gss_entries.rpc_gss_set_svc_name)(principal,
344 mechanism, req_time, program, version);
349 rpc_gss_clear_svc_name_call(u_int program, u_int version)
352 if (rpc_gss_entries.rpc_gss_clear_svc_name != NULL)
353 (*rpc_gss_entries.rpc_gss_clear_svc_name)(program, version);
356 static __inline bool_t
357 rpc_gss_getcred_call(struct svc_req *req, rpc_gss_rawcred_t **rcred,
358 rpc_gss_ucred_t **ucred, void **cookie)
362 if (rpc_gss_entries.rpc_gss_getcred != NULL)
363 ret = (*rpc_gss_entries.rpc_gss_getcred)(req, rcred, ucred,
368 static __inline bool_t
369 rpc_gss_set_callback_call(rpc_gss_callback_t *cb)
373 if (rpc_gss_entries.rpc_gss_set_callback != NULL)
374 ret = (*rpc_gss_entries.rpc_gss_set_callback)(cb);
379 rpc_gss_clear_callback_call(rpc_gss_callback_t *cb)
382 if (rpc_gss_entries.rpc_gss_clear_callback != NULL)
383 (*rpc_gss_entries.rpc_gss_clear_callback)(cb);
386 static __inline bool_t
387 rpc_gss_get_principal_name_call(rpc_gss_principal_t *principal,
388 const char *mech, const char *name, const char *node, const char *domain)
392 if (rpc_gss_entries.rpc_gss_get_principal_name != NULL)
393 ret = (*rpc_gss_entries.rpc_gss_get_principal_name)(principal,
394 mech, name, node, domain);
399 rpc_gss_svc_max_data_length_call(struct svc_req *req, int max_tp_unit_len)
403 if (rpc_gss_entries.rpc_gss_svc_max_data_length != NULL)
404 ret = (*rpc_gss_entries.rpc_gss_svc_max_data_length)(req,
409 AUTH *rpc_gss_secfind(CLIENT *clnt, struct ucred *cred,
410 const char *principal, gss_OID mech_oid, rpc_gss_service_t service);
411 void rpc_gss_secpurge(CLIENT *clnt);
413 AUTH *rpc_gss_seccreate(CLIENT *clnt, struct ucred *cred,
414 const char *principal, const char *mechanism, rpc_gss_service_t service,
415 const char *qop, rpc_gss_options_req_t *options_req,
416 rpc_gss_options_ret_t *options_ret);
417 bool_t rpc_gss_set_defaults(AUTH *auth, rpc_gss_service_t service,
419 int rpc_gss_max_data_length(AUTH *handle, int max_tp_unit_len);
420 void rpc_gss_get_error(rpc_gss_error_t *error);
422 bool_t rpc_gss_mech_to_oid(const char *mech, gss_OID *oid_ret);
423 bool_t rpc_gss_oid_to_mech(gss_OID oid, const char **mech_ret);
424 bool_t rpc_gss_qop_to_num(const char *qop, const char *mech, u_int *num_ret);
425 const char **rpc_gss_get_mechanisms(void);
426 const char **rpc_gss_get_mech_info(const char *mech, rpc_gss_service_t *service);
427 bool_t rpc_gss_get_versions(u_int *vers_hi, u_int *vers_lo);
428 bool_t rpc_gss_is_installed(const char *mech);
430 bool_t rpc_gss_set_svc_name(const char *principal, const char *mechanism,
431 u_int req_time, u_int program, u_int version);
432 void rpc_gss_clear_svc_name(u_int program, u_int version);
433 bool_t rpc_gss_getcred(struct svc_req *req, rpc_gss_rawcred_t **rcred,
434 rpc_gss_ucred_t **ucred, void **cookie);
435 bool_t rpc_gss_set_callback(rpc_gss_callback_t *cb);
436 void rpc_gss_clear_callback(rpc_gss_callback_t *cb);
437 bool_t rpc_gss_get_principal_name(rpc_gss_principal_t *principal,
438 const char *mech, const char *name, const char *node, const char *domain);
439 int rpc_gss_svc_max_data_length(struct svc_req *req, int max_tp_unit_len);
442 * Internal interface from the RPC implementation.
445 bool_t __rpc_gss_wrap(AUTH *auth, void *header, size_t headerlen,
446 XDR* xdrs, xdrproc_t xdr_args, void *args_ptr);
447 bool_t __rpc_gss_unwrap(AUTH *auth, XDR* xdrs, xdrproc_t xdr_args,
450 bool_t __rpc_gss_set_error(int rpc_gss_error, int system_error);
454 #endif /* !_RPCSEC_GSS_H */