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/auth.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*      $NetBSD: auth.h,v 1.15 2000/06/02 22:57:55 fvdl Exp $   */
    2 
    3 /*
    4  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
    5  * unrestricted use provided that this legend is included on all tape
    6  * media and as a part of the software program in whole or part.  Users
    7  * may copy or modify Sun RPC without charge, but are not authorized
    8  * to license or distribute it to anyone else except as part of a product or
    9  * program developed by the user.
   10  *
   11  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
   12  * WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   13  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
   14  *
   15  * Sun RPC is provided with no support and without any obligation on the
   16  * part of Sun Microsystems, Inc. to assist in its use, correction,
   17  * modification or enhancement.
   18  *
   19  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
   20  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
   21  * OR ANY PART THEREOF.
   22  *
   23  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
   24  * or profits or other special, indirect and consequential damages, even if
   25  * Sun has been advised of the possibility of such damages.
   26  *
   27  * Sun Microsystems, Inc.
   28  * 2550 Garcia Avenue
   29  * Mountain View, California  94043
   30  *
   31  *      from: @(#)auth.h 1.17 88/02/08 SMI
   32  *      from: @(#)auth.h        2.3 88/08/07 4.0 RPCSRC
   33  *      from: @(#)auth.h        1.43    98/02/02 SMI
   34  * $FreeBSD$
   35  */
   36 
   37 /*
   38  * auth.h, Authentication interface.
   39  *
   40  * Copyright (C) 1984, Sun Microsystems, Inc.
   41  *
   42  * The data structures are completely opaque to the client.  The client
   43  * is required to pass an AUTH * to routines that create rpc
   44  * "sessions".
   45  */
   46 
   47 #ifndef _RPC_AUTH_H
   48 #define _RPC_AUTH_H
   49 #include <rpc/xdr.h>
   50 #include <rpc/clnt_stat.h>
   51 #include <sys/cdefs.h>
   52 #include <sys/socket.h>
   53 
   54 #define MAX_AUTH_BYTES  400
   55 #define MAXNETNAMELEN   255     /* maximum length of network user's name */
   56 
   57 /*
   58  *  Client side authentication/security data
   59  */
   60 
   61 typedef struct sec_data {
   62         u_int   secmod;         /* security mode number e.g. in nfssec.conf */
   63         u_int   rpcflavor;      /* rpc flavors:AUTH_UNIX,AUTH_DES,RPCSEC_GSS */
   64         int     flags;          /* AUTH_F_xxx flags */
   65         caddr_t data;           /* opaque data per flavor */
   66 } sec_data_t;
   67 
   68 #ifdef _SYSCALL32_IMPL
   69 struct sec_data32 {
   70         uint32_t secmod;        /* security mode number e.g. in nfssec.conf */
   71         uint32_t rpcflavor;     /* rpc flavors:AUTH_UNIX,AUTH_DES,RPCSEC_GSS */
   72         int32_t flags;          /* AUTH_F_xxx flags */
   73         caddr32_t data;         /* opaque data per flavor */
   74 };
   75 #endif /* _SYSCALL32_IMPL */
   76 
   77 /*
   78  * AUTH_DES flavor specific data from sec_data opaque data field.
   79  * AUTH_KERB has the same structure.
   80  */
   81 typedef struct des_clnt_data {
   82         struct netbuf   syncaddr;       /* time sync addr */
   83         struct knetconfig *knconf;      /* knetconfig info that associated */
   84                                         /* with the syncaddr. */
   85         char            *netname;       /* server's netname */
   86         int             netnamelen;     /* server's netname len */
   87 } dh_k4_clntdata_t;
   88 
   89 #ifdef _SYSCALL32_IMPL
   90 struct des_clnt_data32 {
   91         struct netbuf32 syncaddr;       /* time sync addr */
   92         caddr32_t knconf;               /* knetconfig info that associated */
   93                                         /* with the syncaddr. */
   94         caddr32_t netname;              /* server's netname */
   95         int32_t netnamelen;             /* server's netname len */
   96 };
   97 #endif /* _SYSCALL32_IMPL */
   98 
   99 #ifdef KERBEROS
  100 /*
  101  * flavor specific data to hold the data for AUTH_DES/AUTH_KERB(v4)
  102  * in sec_data->data opaque field.
  103  */
  104 typedef struct krb4_svc_data {
  105         int             window;         /* window option value */
  106 } krb4_svcdata_t;
  107  
  108 typedef struct krb4_svc_data    des_svcdata_t;
  109 #endif /* KERBEROS */
  110 
  111 /*
  112  * authentication/security specific flags
  113  */
  114 #define AUTH_F_RPCTIMESYNC      0x001   /* use RPC to do time sync */
  115 #define AUTH_F_TRYNONE          0x002   /* allow fall back to AUTH_NONE */
  116 
  117 
  118 /*
  119  * Status returned from authentication check
  120  */
  121 enum auth_stat {
  122         AUTH_OK=0,
  123         /*
  124          * failed at remote end
  125          */
  126         AUTH_BADCRED=1,                 /* bogus credentials (seal broken) */
  127         AUTH_REJECTEDCRED=2,            /* client should begin new session */
  128         AUTH_BADVERF=3,                 /* bogus verifier (seal broken) */
  129         AUTH_REJECTEDVERF=4,            /* verifier expired or was replayed */
  130         AUTH_TOOWEAK=5,                 /* rejected due to security reasons */
  131         /*
  132          * failed locally
  133         */
  134         AUTH_INVALIDRESP=6,             /* bogus response verifier */
  135         AUTH_FAILED=7                   /* some unknown reason */
  136 #ifdef KERBEROS
  137         /*
  138          * kerberos errors
  139          */
  140         ,
  141         AUTH_KERB_GENERIC = 8,          /* kerberos generic error */
  142         AUTH_TIMEEXPIRE = 9,            /* time of credential expired */
  143         AUTH_TKT_FILE = 10,             /* something wrong with ticket file */
  144         AUTH_DECODE = 11,                       /* can't decode authenticator */
  145         AUTH_NET_ADDR = 12              /* wrong net address in ticket */
  146 #endif /* KERBEROS */
  147 };
  148 
  149 union des_block {
  150         struct {
  151                 uint32_t high;
  152                 uint32_t low;
  153         } key;
  154         char c[8];
  155 };
  156 typedef union des_block des_block;
  157 __BEGIN_DECLS
  158 extern bool_t xdr_des_block(XDR *, des_block *);
  159 __END_DECLS
  160 
  161 /*
  162  * Authentication info.  Opaque to client.
  163  */
  164 struct opaque_auth {
  165         enum_t  oa_flavor;              /* flavor of auth */
  166         caddr_t oa_base;                /* address of more auth stuff */
  167         u_int   oa_length;              /* not to exceed MAX_AUTH_BYTES */
  168 };
  169 
  170 
  171 /*
  172  * Auth handle, interface to client side authenticators.
  173  */
  174 typedef struct __auth {
  175         struct  opaque_auth     ah_cred;
  176         struct  opaque_auth     ah_verf;
  177         union   des_block       ah_key;
  178         struct auth_ops {
  179                 void    (*ah_nextverf) (struct __auth *);
  180                 /* nextverf & serialize */
  181                 int     (*ah_marshal) (struct __auth *, XDR *);
  182                 /* validate verifier */
  183                 int     (*ah_validate) (struct __auth *,
  184                             struct opaque_auth *);
  185                 /* refresh credentials */
  186                 int     (*ah_refresh) (struct __auth *, void *);
  187                 /* destroy this structure */
  188                 void    (*ah_destroy) (struct __auth *);
  189         } *ah_ops;
  190         void *ah_private;
  191 } AUTH;
  192 
  193 
  194 /*
  195  * Authentication ops.
  196  * The ops and the auth handle provide the interface to the authenticators.
  197  *
  198  * AUTH *auth;
  199  * XDR  *xdrs;
  200  * struct opaque_auth verf;
  201  */
  202 #define AUTH_NEXTVERF(auth)             \
  203                 ((*((auth)->ah_ops->ah_nextverf))(auth))
  204 #define auth_nextverf(auth)             \
  205                 ((*((auth)->ah_ops->ah_nextverf))(auth))
  206 
  207 #define AUTH_MARSHALL(auth, xdrs)       \
  208                 ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
  209 #define auth_marshall(auth, xdrs)       \
  210                 ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
  211 
  212 #define AUTH_VALIDATE(auth, verfp)      \
  213                 ((*((auth)->ah_ops->ah_validate))((auth), verfp))
  214 #define auth_validate(auth, verfp)      \
  215                 ((*((auth)->ah_ops->ah_validate))((auth), verfp))
  216 
  217 #define AUTH_REFRESH(auth, msg)         \
  218                 ((*((auth)->ah_ops->ah_refresh))(auth, msg))
  219 #define auth_refresh(auth, msg)         \
  220                 ((*((auth)->ah_ops->ah_refresh))(auth, msg))
  221 
  222 #define AUTH_DESTROY(auth)              \
  223                 ((*((auth)->ah_ops->ah_destroy))(auth))
  224 #define auth_destroy(auth)              \
  225                 ((*((auth)->ah_ops->ah_destroy))(auth))
  226 
  227 
  228 __BEGIN_DECLS
  229 extern struct opaque_auth _null_auth;
  230 __END_DECLS
  231 
  232 /*
  233  * These are the various implementations of client side authenticators.
  234  */
  235 
  236 /*
  237  * System style authentication
  238  * AUTH *authunix_create(machname, uid, gid, len, aup_gids)
  239  *      char *machname;
  240  *      int uid;
  241  *      int gid;
  242  *      int len;
  243  *      int *aup_gids;
  244  */
  245 __BEGIN_DECLS
  246 #ifdef _KERNEL
  247 struct ucred;
  248 extern AUTH *authunix_create(struct ucred *);
  249 #else
  250 extern AUTH *authunix_create(char *, int, int, int,
  251     int *);
  252 extern AUTH *authunix_create_default(void);     /* takes no parameters */
  253 #endif
  254 extern AUTH *authnone_create(void);             /* takes no parameters */
  255 __END_DECLS
  256 /*
  257  * DES style authentication
  258  * AUTH *authsecdes_create(servername, window, timehost, ckey)
  259  *      char *servername;               - network name of server
  260  *      u_int window;                   - time to live
  261  *      const char *timehost;                   - optional hostname to sync with
  262  *      des_block *ckey;                - optional conversation key to use
  263  */
  264 __BEGIN_DECLS
  265 extern AUTH *authdes_create (char *, u_int, struct sockaddr *, des_block *);
  266 extern AUTH *authdes_seccreate (const char *, const u_int, const  char *,
  267     const  des_block *);
  268 __END_DECLS
  269 
  270 __BEGIN_DECLS
  271 extern bool_t xdr_opaque_auth           (XDR *, struct opaque_auth *);
  272 __END_DECLS
  273 
  274 #define authsys_create(c,i1,i2,i3,ip) authunix_create((c),(i1),(i2),(i3),(ip))
  275 #define authsys_create_default() authunix_create_default()
  276 
  277 /*
  278  * Netname manipulation routines.
  279  */
  280 __BEGIN_DECLS
  281 extern int getnetname(char *);
  282 extern int host2netname(char *, const char *, const char *);
  283 extern int user2netname(char *, const uid_t, const char *);
  284 extern int netname2user(char *, uid_t *, gid_t *, int *, gid_t *);
  285 extern int netname2host(char *, char *, const int);
  286 extern void passwd2des ( char *, char * );
  287 __END_DECLS
  288 
  289 /*
  290  *
  291  * These routines interface to the keyserv daemon
  292  *
  293  */
  294 __BEGIN_DECLS
  295 extern int key_decryptsession(const char *, des_block *);
  296 extern int key_encryptsession(const char *, des_block *);
  297 extern int key_gendes(des_block *);
  298 extern int key_setsecret(const char *);
  299 extern int key_secretkey_is_set(void);
  300 __END_DECLS
  301 
  302 /*
  303  * Publickey routines.
  304  */
  305 __BEGIN_DECLS
  306 extern int getpublickey (const char *, char *);
  307 extern int getpublicandprivatekey (const char *, char *);
  308 extern int getsecretkey (char *, char *, char *);
  309 __END_DECLS
  310 
  311 #ifdef KERBEROS
  312 /*
  313  * Kerberos style authentication
  314  * AUTH *authkerb_seccreate(service, srv_inst, realm, window, timehost, status)
  315  *      const char *service;                    - service name
  316  *      const char *srv_inst;                   - server instance
  317  *      const char *realm;                      - server realm
  318  *      const u_int window;                     - time to live
  319  *      const char *timehost;                   - optional hostname to sync with
  320  *      int *status;                            - kerberos status returned
  321  */
  322 __BEGIN_DECLS
  323 extern AUTH     *authkerb_seccreate(const char *, const char *, const  char *,
  324                     const u_int, const char *, int *);
  325 __END_DECLS
  326 
  327 /*
  328  * Map a kerberos credential into a unix cred.
  329  *
  330  *      authkerb_getucred(rqst, uid, gid, grouplen, groups)
  331  *      const struct svc_req *rqst;             - request pointer
  332  *      uid_t *uid;
  333  *      gid_t *gid;
  334  *      short *grouplen;
  335  *      int *groups;
  336  *
  337  */
  338 __BEGIN_DECLS
  339 extern int      authkerb_getucred(/* struct svc_req *, uid_t *, gid_t *,
  340                     short *, int * */);
  341 __END_DECLS
  342 #endif /* KERBEROS */
  343 
  344 __BEGIN_DECLS
  345 struct svc_req;
  346 struct rpc_msg;
  347 enum auth_stat _svcauth_null (struct svc_req *, struct rpc_msg *);
  348 enum auth_stat _svcauth_short (struct svc_req *, struct rpc_msg *);
  349 enum auth_stat _svcauth_unix (struct svc_req *, struct rpc_msg *);
  350 __END_DECLS
  351 
  352 #define AUTH_NONE       0               /* no authentication */
  353 #define AUTH_NULL       0               /* backward compatibility */
  354 #define AUTH_SYS        1               /* unix style (uid, gids) */
  355 #define AUTH_UNIX       AUTH_SYS
  356 #define AUTH_SHORT      2               /* short hand unix style */
  357 #define AUTH_DH         3               /* for Diffie-Hellman mechanism */
  358 #define AUTH_DES        AUTH_DH         /* for backward compatibility */
  359 #define AUTH_KERB       4               /* kerberos style */
  360 
  361 #endif /* !_RPC_AUTH_H */

Cache object: 26340fc01452047701de2465e2be87d5


[ 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.