18f55a568SDoug Rabson /*- 2*4d846d26SWarner Losh * SPDX-License-Identifier: BSD-2-Clause 3e58eb3c4SPedro F. Giffuni * 48f55a568SDoug Rabson * Copyright (c) 2008 Doug Rabson 58f55a568SDoug Rabson * All rights reserved. 68f55a568SDoug Rabson * 78f55a568SDoug Rabson * Redistribution and use in source and binary forms, with or without 88f55a568SDoug Rabson * modification, are permitted provided that the following conditions 98f55a568SDoug Rabson * are met: 108f55a568SDoug Rabson * 1. Redistributions of source code must retain the above copyright 118f55a568SDoug Rabson * notice, this list of conditions and the following disclaimer. 128f55a568SDoug Rabson * 2. Redistributions in binary form must reproduce the above copyright 138f55a568SDoug Rabson * notice, this list of conditions and the following disclaimer in the 148f55a568SDoug Rabson * documentation and/or other materials provided with the distribution. 158f55a568SDoug Rabson * 168f55a568SDoug Rabson * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 178f55a568SDoug Rabson * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 188f55a568SDoug Rabson * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 198f55a568SDoug Rabson * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 208f55a568SDoug Rabson * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 218f55a568SDoug Rabson * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 228f55a568SDoug Rabson * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 238f55a568SDoug Rabson * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 248f55a568SDoug Rabson * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 258f55a568SDoug Rabson * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 268f55a568SDoug Rabson * SUCH DAMAGE. 278f55a568SDoug Rabson */ 288f55a568SDoug Rabson 298f55a568SDoug Rabson #ifndef _RPCSEC_GSS_H 308f55a568SDoug Rabson #define _RPCSEC_GSS_H 318f55a568SDoug Rabson 328f55a568SDoug Rabson #include <gssapi/gssapi.h> 338f55a568SDoug Rabson 348f55a568SDoug Rabson #ifndef MAX_GSS_MECH 358f55a568SDoug Rabson #define MAX_GSS_MECH 64 368f55a568SDoug Rabson #endif 378f55a568SDoug Rabson 388f55a568SDoug Rabson /* 398f55a568SDoug Rabson * Define the types of security service required for rpc_gss_seccreate(). 408f55a568SDoug Rabson */ 418f55a568SDoug Rabson typedef enum { 428f55a568SDoug Rabson rpc_gss_svc_default = 0, 438f55a568SDoug Rabson rpc_gss_svc_none = 1, 448f55a568SDoug Rabson rpc_gss_svc_integrity = 2, 458f55a568SDoug Rabson rpc_gss_svc_privacy = 3 468f55a568SDoug Rabson } rpc_gss_service_t; 478f55a568SDoug Rabson 488f55a568SDoug Rabson /* 498f55a568SDoug Rabson * Structure containing options for rpc_gss_seccreate(). 508f55a568SDoug Rabson */ 518f55a568SDoug Rabson typedef struct { 528f55a568SDoug Rabson int req_flags; /* GSS request bits */ 538f55a568SDoug Rabson int time_req; /* requested credential lifetime */ 548f55a568SDoug Rabson gss_cred_id_t my_cred; /* GSS credential */ 558f55a568SDoug Rabson gss_channel_bindings_t input_channel_bindings; 568f55a568SDoug Rabson } rpc_gss_options_req_t; 578f55a568SDoug Rabson 588f55a568SDoug Rabson /* 598f55a568SDoug Rabson * Structure containing options returned by rpc_gss_seccreate(). 608f55a568SDoug Rabson */ 618f55a568SDoug Rabson typedef struct { 628f55a568SDoug Rabson int major_status; 638f55a568SDoug Rabson int minor_status; 648f55a568SDoug Rabson u_int rpcsec_version; 658f55a568SDoug Rabson int ret_flags; 668f55a568SDoug Rabson int time_req; 678f55a568SDoug Rabson gss_ctx_id_t gss_context; 688f55a568SDoug Rabson char actual_mechanism[MAX_GSS_MECH]; 698f55a568SDoug Rabson } rpc_gss_options_ret_t; 708f55a568SDoug Rabson 718f55a568SDoug Rabson /* 728f55a568SDoug Rabson * Client principal type. Used as an argument to 738f55a568SDoug Rabson * rpc_gss_get_principal_name(). Also referenced by the 748f55a568SDoug Rabson * rpc_gss_rawcred_t structure. 758f55a568SDoug Rabson */ 768f55a568SDoug Rabson typedef struct { 778f55a568SDoug Rabson int len; 788f55a568SDoug Rabson char name[1]; 798f55a568SDoug Rabson } *rpc_gss_principal_t; 808f55a568SDoug Rabson 818f55a568SDoug Rabson /* 828f55a568SDoug Rabson * Structure for raw credentials used by rpc_gss_getcred() and 838f55a568SDoug Rabson * rpc_gss_set_callback(). 848f55a568SDoug Rabson */ 858f55a568SDoug Rabson typedef struct { 868f55a568SDoug Rabson u_int version; /* RPC version number */ 878f55a568SDoug Rabson const char *mechanism; /* security mechanism */ 888f55a568SDoug Rabson const char *qop; /* quality of protection */ 898f55a568SDoug Rabson rpc_gss_principal_t client_principal; /* client name */ 908f55a568SDoug Rabson const char *svc_principal; /* server name */ 918f55a568SDoug Rabson rpc_gss_service_t service; /* service type */ 928f55a568SDoug Rabson } rpc_gss_rawcred_t; 938f55a568SDoug Rabson 948f55a568SDoug Rabson /* 958f55a568SDoug Rabson * Unix credentials derived from raw credentials. Returned by 968f55a568SDoug Rabson * rpc_gss_getcred(). 978f55a568SDoug Rabson */ 988f55a568SDoug Rabson typedef struct { 998f55a568SDoug Rabson uid_t uid; /* user ID */ 1008f55a568SDoug Rabson gid_t gid; /* group ID */ 1018f55a568SDoug Rabson short gidlen; 1028f55a568SDoug Rabson gid_t *gidlist; /* list of groups */ 1038f55a568SDoug Rabson } rpc_gss_ucred_t; 1048f55a568SDoug Rabson 1058f55a568SDoug Rabson /* 1068f55a568SDoug Rabson * Structure used to enforce a particular QOP and service. 1078f55a568SDoug Rabson */ 1088f55a568SDoug Rabson typedef struct { 1098f55a568SDoug Rabson bool_t locked; 1108f55a568SDoug Rabson rpc_gss_rawcred_t *raw_cred; 1118f55a568SDoug Rabson } rpc_gss_lock_t; 1128f55a568SDoug Rabson 1138f55a568SDoug Rabson /* 1148f55a568SDoug Rabson * Callback structure used by rpc_gss_set_callback(). 1158f55a568SDoug Rabson */ 1168f55a568SDoug Rabson typedef struct { 1178f55a568SDoug Rabson u_int program; /* RPC program number */ 1188f55a568SDoug Rabson u_int version; /* RPC version number */ 1198f55a568SDoug Rabson /* user defined callback */ 1208f55a568SDoug Rabson bool_t (*callback)(struct svc_req *req, 1218f55a568SDoug Rabson gss_cred_id_t deleg, 1228f55a568SDoug Rabson gss_ctx_id_t gss_context, 1238f55a568SDoug Rabson rpc_gss_lock_t *lock, 1248f55a568SDoug Rabson void **cookie); 1258f55a568SDoug Rabson } rpc_gss_callback_t; 1268f55a568SDoug Rabson 1278f55a568SDoug Rabson /* 1288f55a568SDoug Rabson * Structure used to return error information by rpc_gss_get_error() 1298f55a568SDoug Rabson */ 1308f55a568SDoug Rabson typedef struct { 1318f55a568SDoug Rabson int rpc_gss_error; 1328f55a568SDoug Rabson int system_error; /* same as errno */ 1338f55a568SDoug Rabson } rpc_gss_error_t; 1348f55a568SDoug Rabson 1358f55a568SDoug Rabson /* 1368f55a568SDoug Rabson * Values for rpc_gss_error 1378f55a568SDoug Rabson */ 1388f55a568SDoug Rabson #define RPC_GSS_ER_SUCCESS 0 /* no error */ 1398f55a568SDoug Rabson #define RPC_GSS_ER_SYSTEMERROR 1 /* system error */ 1408f55a568SDoug Rabson 1418f55a568SDoug Rabson __BEGIN_DECLS 1428f55a568SDoug Rabson 1438f55a568SDoug Rabson AUTH *rpc_gss_seccreate(CLIENT *clnt, const char *principal, 1448f55a568SDoug Rabson const char *mechanism, rpc_gss_service_t service, const char *qop, 1458f55a568SDoug Rabson rpc_gss_options_req_t *options_req, rpc_gss_options_ret_t *options_ret); 1468f55a568SDoug Rabson bool_t rpc_gss_set_defaults(AUTH *auth, rpc_gss_service_t service, 1478f55a568SDoug Rabson const char *qop); 1488f55a568SDoug Rabson int rpc_gss_max_data_length(AUTH *handle, int max_tp_unit_len); 1498f55a568SDoug Rabson void rpc_gss_get_error(rpc_gss_error_t *error); 1508f55a568SDoug Rabson 1518f55a568SDoug Rabson bool_t rpc_gss_mech_to_oid(const char *mech, gss_OID *oid_ret); 1528f55a568SDoug Rabson bool_t rpc_gss_oid_to_mech(gss_OID oid, const char **mech_ret); 1538f55a568SDoug Rabson bool_t rpc_gss_qop_to_num(const char *qop, const char *mech, u_int *num_ret); 1548f55a568SDoug Rabson const char **rpc_gss_get_mechanisms(void); 1558f55a568SDoug Rabson const char **rpc_gss_get_mech_info(const char *mech, rpc_gss_service_t *service); 1568f55a568SDoug Rabson bool_t rpc_gss_get_versions(u_int *vers_hi, u_int *vers_lo); 1578f55a568SDoug Rabson bool_t rpc_gss_is_installed(const char *mech); 1588f55a568SDoug Rabson 1598f55a568SDoug Rabson bool_t rpc_gss_set_svc_name(const char *principal, const char *mechanism, 1608f55a568SDoug Rabson u_int req_time, u_int program, u_int version); 1618f55a568SDoug Rabson bool_t rpc_gss_getcred(struct svc_req *req, rpc_gss_rawcred_t **rcred, 1628f55a568SDoug Rabson rpc_gss_ucred_t **ucred, void **cookie); 1638f55a568SDoug Rabson bool_t rpc_gss_set_callback(rpc_gss_callback_t *cb); 1648f55a568SDoug Rabson bool_t rpc_gss_get_principal_name(rpc_gss_principal_t *principal, 1658f55a568SDoug Rabson const char *mech, const char *name, const char *node, const char *domain); 1668f55a568SDoug Rabson int rpc_gss_svc_max_data_length(struct svc_req *req, int max_tp_unit_len); 1678f55a568SDoug Rabson 1688f55a568SDoug Rabson /* 1698f55a568SDoug Rabson * Internal interface from the RPC implementation. 1708f55a568SDoug Rabson */ 1718f55a568SDoug Rabson bool_t __rpc_gss_wrap(AUTH *auth, void *header, size_t headerlen, 1728f55a568SDoug Rabson XDR* xdrs, xdrproc_t xdr_args, void *args_ptr); 1738f55a568SDoug Rabson bool_t __rpc_gss_unwrap(AUTH *auth, XDR* xdrs, xdrproc_t xdr_args, 1748f55a568SDoug Rabson void *args_ptr); 1758f55a568SDoug Rabson bool_t __rpc_gss_set_error(int rpc_gss_error, int system_error); 1768f55a568SDoug Rabson 1778f55a568SDoug Rabson __END_DECLS 1788f55a568SDoug Rabson 1798f55a568SDoug Rabson #endif /* !_RPCSEC_GSS_H */ 180