The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/rpc/rpcsec_gss.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright (c) 2008 Doug Rabson
    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  * 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.
   13  *
   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
   24  * SUCH DAMAGE.
   25  *
   26  *      $FreeBSD: releng/8.0/sys/rpc/rpcsec_gss.h 184588 2008-11-03 10:38:00Z dfr $
   27  */
   28 
   29 #ifndef _RPCSEC_GSS_H
   30 #define _RPCSEC_GSS_H
   31 
   32 #include <kgssapi/gssapi.h>
   33 
   34 #ifndef MAX_GSS_MECH
   35 #define MAX_GSS_MECH    64
   36 #endif
   37 
   38 /*
   39  * Define the types of security service required for rpc_gss_seccreate().
   40  */
   41 typedef enum {
   42         rpc_gss_svc_default     = 0,
   43         rpc_gss_svc_none        = 1,
   44         rpc_gss_svc_integrity   = 2,
   45         rpc_gss_svc_privacy     = 3
   46 } rpc_gss_service_t;
   47 
   48 /*
   49  * Structure containing options for rpc_gss_seccreate().
   50  */
   51 typedef struct {
   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;
   57 
   58 /*
   59  * Structure containing options returned by rpc_gss_seccreate().
   60  */
   61 typedef struct {
   62         int             major_status;
   63         int             minor_status;
   64         u_int           rpcsec_version;
   65         int             ret_flags;
   66         int             time_req;
   67         gss_ctx_id_t    gss_context;
   68         char            actual_mechanism[MAX_GSS_MECH];
   69 } rpc_gss_options_ret_t;
   70 
   71 /*
   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.
   75  */
   76 typedef struct {
   77         int             len;
   78         char            name[1];
   79 } *rpc_gss_principal_t;
   80 
   81 /*
   82  * Structure for raw credentials used by rpc_gss_getcred() and
   83  * rpc_gss_set_callback().
   84  */
   85 typedef struct {
   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 */
   92 } rpc_gss_rawcred_t;
   93 
   94 /*
   95  * Unix credentials derived from raw credentials. Returned by
   96  * rpc_gss_getcred().
   97  */
   98 typedef struct {
   99         uid_t           uid;            /* user ID */
  100         gid_t           gid;            /* group ID */
  101         short           gidlen;
  102         gid_t           *gidlist;       /* list of groups */
  103 } rpc_gss_ucred_t;
  104 
  105 /*
  106  * Structure used to enforce a particular QOP and service.
  107  */
  108 typedef struct {
  109         bool_t          locked;
  110         rpc_gss_rawcred_t *raw_cred;
  111 } rpc_gss_lock_t;
  112 
  113 /*
  114  * Callback structure used by rpc_gss_set_callback().
  115  */
  116 typedef struct {
  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,
  121                                     gss_cred_id_t deleg,
  122                                     gss_ctx_id_t gss_context,
  123                                     rpc_gss_lock_t *lock,
  124                                     void **cookie);
  125 } rpc_gss_callback_t;
  126 
  127 /*
  128  * Structure used to return error information by rpc_gss_get_error()
  129  */
  130 typedef struct {
  131         int             rpc_gss_error;
  132         int             system_error;   /* same as errno */
  133 } rpc_gss_error_t;
  134 
  135 /*
  136  * Values for rpc_gss_error
  137  */
  138 #define RPC_GSS_ER_SUCCESS      0       /* no error */
  139 #define RPC_GSS_ER_SYSTEMERROR  1       /* system error */
  140 
  141 __BEGIN_DECLS
  142 
  143 #ifdef _KERNEL
  144 AUTH    *rpc_gss_secfind(CLIENT *clnt, struct ucred *cred,
  145     const char *principal, gss_OID mech_oid, rpc_gss_service_t service);
  146 void    rpc_gss_secpurge(CLIENT *clnt);
  147 #endif
  148 AUTH    *rpc_gss_seccreate(CLIENT *clnt, struct ucred *cred,
  149     const char *principal, const char *mechanism, rpc_gss_service_t service,
  150     const char *qop, rpc_gss_options_req_t *options_req,
  151     rpc_gss_options_ret_t *options_ret);
  152 bool_t  rpc_gss_set_defaults(AUTH *auth, rpc_gss_service_t service,
  153     const char *qop);
  154 int     rpc_gss_max_data_length(AUTH *handle, int max_tp_unit_len);
  155 void    rpc_gss_get_error(rpc_gss_error_t *error);
  156 
  157 bool_t  rpc_gss_mech_to_oid(const char *mech, gss_OID *oid_ret);
  158 bool_t  rpc_gss_oid_to_mech(gss_OID oid, const char **mech_ret);
  159 bool_t  rpc_gss_qop_to_num(const char *qop, const char *mech, u_int *num_ret);
  160 const char **rpc_gss_get_mechanisms(void);
  161 const char **rpc_gss_get_mech_info(const char *mech, rpc_gss_service_t *service);
  162 bool_t  rpc_gss_get_versions(u_int *vers_hi, u_int *vers_lo);
  163 bool_t  rpc_gss_is_installed(const char *mech);
  164 
  165 bool_t  rpc_gss_set_svc_name(const char *principal, const char *mechanism,
  166     u_int req_time, u_int program, u_int version);
  167 void rpc_gss_clear_svc_name(u_int program, u_int version);
  168 bool_t  rpc_gss_getcred(struct svc_req *req, rpc_gss_rawcred_t **rcred,
  169     rpc_gss_ucred_t **ucred, void **cookie);
  170 bool_t  rpc_gss_set_callback(rpc_gss_callback_t *cb);
  171 void rpc_gss_clear_callback(rpc_gss_callback_t *cb);
  172 bool_t  rpc_gss_get_principal_name(rpc_gss_principal_t *principal,
  173     const char *mech, const char *name, const char *node, const char *domain);
  174 int     rpc_gss_svc_max_data_length(struct svc_req *req, int max_tp_unit_len);
  175 
  176 /*
  177  * Internal interface from the RPC implementation.
  178  */
  179 #ifndef _KERNEL
  180 bool_t  __rpc_gss_wrap(AUTH *auth, void *header, size_t headerlen,
  181     XDR* xdrs, xdrproc_t xdr_args, void *args_ptr);
  182 bool_t  __rpc_gss_unwrap(AUTH *auth, XDR* xdrs, xdrproc_t xdr_args,
  183     void *args_ptr);
  184 #endif
  185 bool_t __rpc_gss_set_error(int rpc_gss_error, int system_error);
  186 
  187 __END_DECLS
  188 
  189 #endif /* !_RPCSEC_GSS_H */

Cache object: 838d4e3bad537698776750a651e4b522


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.