rpcsec_gss.h revision 184588
1145247Sdamien/*- 2145247Sdamien * Copyright (c) 2008 Doug Rabson 3145247Sdamien * All rights reserved. 4156599Sdamien * 5145247Sdamien * Redistribution and use in source and binary forms, with or without 6172567Sthompsa * modification, are permitted provided that the following conditions 7172567Sthompsa * are met: 8145247Sdamien * 1. Redistributions of source code must retain the above copyright 9145247Sdamien * notice, this list of conditions and the following disclaimer. 10145247Sdamien * 2. Redistributions in binary form must reproduce the above copyright 11145247Sdamien * notice, this list of conditions and the following disclaimer in the 12145247Sdamien * documentation and/or other materials provided with the distribution. 13145247Sdamien * 14145247Sdamien * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15145247Sdamien * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16145247Sdamien * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17145247Sdamien * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18145247Sdamien * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19145247Sdamien * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20145247Sdamien * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21145247Sdamien * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22145247Sdamien * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23145247Sdamien * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24145247Sdamien * SUCH DAMAGE. 25145247Sdamien * 26145247Sdamien * $FreeBSD: head/sys/rpc/rpcsec_gss.h 184588 2008-11-03 10:38:00Z dfr $ 27145247Sdamien */ 28145247Sdamien 29145247Sdamien#ifndef _RPCSEC_GSS_H 30145247Sdamien#define _RPCSEC_GSS_H 31145247Sdamien 32145247Sdamien#include <kgssapi/gssapi.h> 33145247Sdamien 34145247Sdamien#ifndef MAX_GSS_MECH 35145247Sdamien#define MAX_GSS_MECH 64 36145247Sdamien#endif 37145247Sdamien 38145247Sdamien/* 39145247Sdamien * Define the types of security service required for rpc_gss_seccreate(). 40145247Sdamien */ 41145247Sdamientypedef enum { 42145247Sdamien rpc_gss_svc_default = 0, 43145247Sdamien rpc_gss_svc_none = 1, 44145247Sdamien rpc_gss_svc_integrity = 2, 45145247Sdamien rpc_gss_svc_privacy = 3 46145247Sdamien} rpc_gss_service_t; 47145247Sdamien 48156599Sdamien/* 49156599Sdamien * Structure containing options for rpc_gss_seccreate(). 50145247Sdamien */ 51145247Sdamientypedef struct { 52145247Sdamien int req_flags; /* GSS request bits */ 53156599Sdamien int time_req; /* requested credential lifetime */ 54156599Sdamien gss_cred_id_t my_cred; /* GSS credential */ 55145247Sdamien gss_channel_bindings_t input_channel_bindings; 56145247Sdamien} rpc_gss_options_req_t; 57145247Sdamien 58145247Sdamien/* 59145247Sdamien * Structure containing options returned by rpc_gss_seccreate(). 60145247Sdamien */ 61145247Sdamientypedef struct { 62145247Sdamien int major_status; 63145247Sdamien int minor_status; 64145247Sdamien u_int rpcsec_version; 65145247Sdamien int ret_flags; 66145247Sdamien int time_req; 67145247Sdamien gss_ctx_id_t gss_context; 68145247Sdamien char actual_mechanism[MAX_GSS_MECH]; 69145247Sdamien} rpc_gss_options_ret_t; 70145247Sdamien 71156599Sdamien/* 72156599Sdamien * Client principal type. Used as an argument to 73156599Sdamien * rpc_gss_get_principal_name(). Also referenced by the 74145247Sdamien * rpc_gss_rawcred_t structure. 75145247Sdamien */ 76145247Sdamientypedef struct { 77145247Sdamien int len; 78145247Sdamien char name[1]; 79145247Sdamien} *rpc_gss_principal_t; 80145247Sdamien 81145247Sdamien/* 82145247Sdamien * Structure for raw credentials used by rpc_gss_getcred() and 83172567Sthompsa * rpc_gss_set_callback(). 84145247Sdamien */ 85145247Sdamientypedef struct { 86145247Sdamien u_int version; /* RPC version number */ 87145247Sdamien const char *mechanism; /* security mechanism */ 88145247Sdamien const char *qop; /* quality of protection */ 89145247Sdamien rpc_gss_principal_t client_principal; /* client name */ 90145247Sdamien const char *svc_principal; /* server name */ 91145247Sdamien rpc_gss_service_t service; /* service type */ 92145247Sdamien} rpc_gss_rawcred_t; 93145247Sdamien 94145247Sdamien/* 95145247Sdamien * Unix credentials derived from raw credentials. Returned by 96156599Sdamien * rpc_gss_getcred(). 97145247Sdamien */ 98145247Sdamientypedef struct { 99145247Sdamien uid_t uid; /* user ID */ 100145247Sdamien gid_t gid; /* group ID */ 101145247Sdamien short gidlen; 102145247Sdamien gid_t *gidlist; /* list of groups */ 103145247Sdamien} rpc_gss_ucred_t; 104145247Sdamien 105145247Sdamien/* 106145247Sdamien * Structure used to enforce a particular QOP and service. 107145247Sdamien */ 108145247Sdamientypedef struct { 109145247Sdamien bool_t locked; 110178354Ssam rpc_gss_rawcred_t *raw_cred; 111234753Sdim} rpc_gss_lock_t; 112234753Sdim 113234753Sdim/* 114178354Ssam * Callback structure used by rpc_gss_set_callback(). 115145247Sdamien */ 116145247Sdamientypedef struct { 117145247Sdamien u_int program; /* RPC program number */ 118178354Ssam u_int version; /* RPC version number */ 119145247Sdamien /* user defined callback */ 120172567Sthompsa bool_t (*callback)(struct svc_req *req, 121172567Sthompsa gss_cred_id_t deleg, 122172567Sthompsa gss_ctx_id_t gss_context, 123145247Sdamien rpc_gss_lock_t *lock, 124145247Sdamien void **cookie); 125145247Sdamien} rpc_gss_callback_t; 126145247Sdamien 127145247Sdamien/* 128145247Sdamien * Structure used to return error information by rpc_gss_get_error() 129172567Sthompsa */ 130145247Sdamientypedef struct { 131145247Sdamien int rpc_gss_error; 132145247Sdamien int system_error; /* same as errno */ 133178354Ssam} rpc_gss_error_t; 134178354Ssam 135145247Sdamien/* 136172567Sthompsa * Values for rpc_gss_error 137172567Sthompsa */ 138145247Sdamien#define RPC_GSS_ER_SUCCESS 0 /* no error */ 139145247Sdamien#define RPC_GSS_ER_SYSTEMERROR 1 /* system error */ 140172567Sthompsa 141172567Sthompsa__BEGIN_DECLS 142145247Sdamien 143156599Sdamien#ifdef _KERNEL 144156599SdamienAUTH *rpc_gss_secfind(CLIENT *clnt, struct ucred *cred, 145145247Sdamien const char *principal, gss_OID mech_oid, rpc_gss_service_t service); 146191746Sthompsavoid rpc_gss_secpurge(CLIENT *clnt); 147191746Sthompsa#endif 148156599SdamienAUTH *rpc_gss_seccreate(CLIENT *clnt, struct ucred *cred, 149145247Sdamien const char *principal, const char *mechanism, rpc_gss_service_t service, 150178354Ssam const char *qop, rpc_gss_options_req_t *options_req, 151145247Sdamien rpc_gss_options_ret_t *options_ret); 152172567Sthompsabool_t rpc_gss_set_defaults(AUTH *auth, rpc_gss_service_t service, 153145247Sdamien const char *qop); 154145247Sdamienint rpc_gss_max_data_length(AUTH *handle, int max_tp_unit_len); 155145247Sdamienvoid rpc_gss_get_error(rpc_gss_error_t *error); 156145247Sdamien 157172567Sthompsabool_t rpc_gss_mech_to_oid(const char *mech, gss_OID *oid_ret); 158145247Sdamienbool_t rpc_gss_oid_to_mech(gss_OID oid, const char **mech_ret); 159145247Sdamienbool_t rpc_gss_qop_to_num(const char *qop, const char *mech, u_int *num_ret); 160145247Sdamienconst char **rpc_gss_get_mechanisms(void); 161145247Sdamienconst char **rpc_gss_get_mech_info(const char *mech, rpc_gss_service_t *service); 162172567Sthompsabool_t rpc_gss_get_versions(u_int *vers_hi, u_int *vers_lo); 163156599Sdamienbool_t rpc_gss_is_installed(const char *mech); 164156599Sdamien 165172567Sthompsabool_t rpc_gss_set_svc_name(const char *principal, const char *mechanism, 166172567Sthompsa u_int req_time, u_int program, u_int version); 167172567Sthompsavoid rpc_gss_clear_svc_name(u_int program, u_int version); 168172567Sthompsabool_t rpc_gss_getcred(struct svc_req *req, rpc_gss_rawcred_t **rcred, 169178354Ssam rpc_gss_ucred_t **ucred, void **cookie); 170178354Ssambool_t rpc_gss_set_callback(rpc_gss_callback_t *cb); 171178354Ssamvoid rpc_gss_clear_callback(rpc_gss_callback_t *cb); 172145247Sdamienbool_t rpc_gss_get_principal_name(rpc_gss_principal_t *principal, 173145247Sdamien const char *mech, const char *name, const char *node, const char *domain); 174145247Sdamienint rpc_gss_svc_max_data_length(struct svc_req *req, int max_tp_unit_len); 175145247Sdamien 176145247Sdamien/* 177145247Sdamien * Internal interface from the RPC implementation. 178145247Sdamien */ 179145247Sdamien#ifndef _KERNEL 180145247Sdamienbool_t __rpc_gss_wrap(AUTH *auth, void *header, size_t headerlen, 181145247Sdamien XDR* xdrs, xdrproc_t xdr_args, void *args_ptr); 182145247Sdamienbool_t __rpc_gss_unwrap(AUTH *auth, XDR* xdrs, xdrproc_t xdr_args, 183145247Sdamien void *args_ptr); 184145247Sdamien#endif 185145247Sdamienbool_t __rpc_gss_set_error(int rpc_gss_error, int system_error); 186145247Sdamien 187145247Sdamien__END_DECLS 188145247Sdamien 189145247Sdamien#endif /* !_RPCSEC_GSS_H */ 190145247Sdamien