include/linux/sunrpc/auth.h

   1 /*
   2  * linux/include/linux/sunrpc/auth.h
   3  *
   4  * Declarations for the RPC client authentication machinery.
   5  *
   6  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
   7  */
   8
   9 #ifndef _LINUX_SUNRPC_AUTH_H
  10 #define _LINUX_SUNRPC_AUTH_H
  11
  12 #ifdef __KERNEL__
  13
  14 #include <linux/config.h>
  15 #include <linux/sunrpc/sched.h>
  16 #include <linux/sunrpc/msg_prot.h>
  17 #include <linux/sunrpc/xdr.h>
  18
  19 #include <asm/atomic.h>
  20
  21 /* size of the nodename buffer */
  22 #define UNX_MAXNODENAME 32
  23
  24 /* Maximum size (in bytes) of an rpc credential or verifier */
  25 #define RPC_MAX_AUTH_SIZE (400)
  26
  27 /* Work around the lack of a VFS credential */
  28 struct auth_cred {
  29         uid_t   uid;
  30         gid_t   gid;
  31         xid_t   xid;
  32         struct group_info *group_info;
  33 };
  34
  35 /*
  36  * Client user credentials
  37  */
  38 struct rpc_cred {
  39         struct hlist_node       cr_hash;        /* hash chain */
  40         struct rpc_credops *    cr_ops;
  41         unsigned long           cr_expire;      /* when to gc */
  42         atomic_t                cr_count;       /* ref count */
  43         unsigned short          cr_flags;       /* various flags */
  44 #ifdef RPC_DEBUG
  45         unsigned long           cr_magic;       /* 0x0f4aa4f0 */
  46 #endif
  47
  48         uid_t                   cr_uid;
  49
  50         /* per-flavor data */
  51 };
  52 #define RPCAUTH_CRED_NEW        0x0001
  53 #define RPCAUTH_CRED_UPTODATE   0x0002
  54
  55 #define RPCAUTH_CRED_MAGIC      0x0f4aa4f0
  56
  57 /*
  58  * Client authentication handle
  59  */
  60 #define RPC_CREDCACHE_NR        8
  61 #define RPC_CREDCACHE_MASK      (RPC_CREDCACHE_NR - 1)
  62 struct rpc_cred_cache {
  63         struct hlist_head       hashtable[RPC_CREDCACHE_NR];
  64         unsigned long           nextgc;         /* next garbage collection */
  65         unsigned long           expire;         /* cache expiry interval */
  66 };
  67
  68 struct rpc_auth {
  69         unsigned int            au_cslack;      /* call cred size estimate */
  70                                 /* guess at number of u32's auth adds before
  71                                  * reply data; normally the verifier size: */
  72         unsigned int            au_rslack;
  73                                 /* for gss, used to calculate au_rslack: */
  74         unsigned int            au_verfsize;
  75
  76         unsigned int            au_flags;       /* various flags */
  77         struct rpc_authops *    au_ops;         /* operations */
  78         rpc_authflavor_t        au_flavor;      /* pseudoflavor (note may
  79                                                  * differ from the flavor in
  80                                                  * au_ops->au_flavor in gss
  81                                                  * case) */
  82         atomic_t                au_count;       /* Reference counter */
  83
  84         struct rpc_cred_cache * au_credcache;
  85         /* per-flavor data */
  86 };
  87
  88 /* Flags for rpcauth_lookupcred() */
  89 #define RPCAUTH_LOOKUP_NEW              0x01    /* Accept an uninitialised cred */
  90 #define RPCAUTH_LOOKUP_ROOTCREDS        0x02    /* This really ought to go! */
  91
  92 /*
  93  * Client authentication ops
  94  */
  95 struct rpc_authops {
  96         struct module           *owner;
  97         rpc_authflavor_t        au_flavor;      /* flavor (RPC_AUTH_*) */
  98 #ifdef RPC_DEBUG
  99         char *                  au_name;
 100 #endif
 101         struct rpc_auth *       (*create)(struct rpc_clnt *, rpc_authflavor_t);
 102         void                    (*destroy)(struct rpc_auth *);
 103
 104         struct rpc_cred *       (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
 105         struct rpc_cred *       (*crcreate)(struct rpc_auth*, struct auth_cred *, int);
 106 };
 107
 108 struct rpc_credops {
 109         const char *            cr_name;        /* Name of the auth flavour */
 110         int                     (*cr_init)(struct rpc_auth *, struct rpc_cred *);
 111         void                    (*crdestroy)(struct rpc_cred *);
 112
 113         int                     (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
 114         u32 *                   (*crmarshal)(struct rpc_task *, u32 *);
 115         int                     (*crrefresh)(struct rpc_task *);
 116         u32 *                   (*crvalidate)(struct rpc_task *, u32 *);
 117         int                     (*crwrap_req)(struct rpc_task *, kxdrproc_t,
 118                                                 void *, u32 *, void *);
 119         int                     (*crunwrap_resp)(struct rpc_task *, kxdrproc_t,
 120                                                 void *, u32 *, void *);
 121 };
 122
 123 extern struct rpc_authops       authunix_ops;
 124 extern struct rpc_authops       authnull_ops;
 125 #ifdef CONFIG_SUNRPC_SECURE
 126 extern struct rpc_authops       authdes_ops;
 127 #endif
 128
 129 int                     rpcauth_register(struct rpc_authops *);
 130 int                     rpcauth_unregister(struct rpc_authops *);
 131 struct rpc_auth *       rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
 132 void                    rpcauth_destroy(struct rpc_auth *);
 133 struct rpc_cred *       rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
 134 struct rpc_cred *       rpcauth_lookupcred(struct rpc_auth *, int);
 135 struct rpc_cred *       rpcauth_bindcred(struct rpc_task *);
 136 void                    rpcauth_holdcred(struct rpc_task *);
 137 void                    put_rpccred(struct rpc_cred *);
 138 void                    rpcauth_unbindcred(struct rpc_task *);
 139 u32 *                   rpcauth_marshcred(struct rpc_task *, u32 *);
 140 u32 *                   rpcauth_checkverf(struct rpc_task *, u32 *);
 141 int                     rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, u32 *data, void *obj);
 142 int                     rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, u32 *data, void *obj);
 143 int                     rpcauth_refreshcred(struct rpc_task *);
 144 void                    rpcauth_invalcred(struct rpc_task *);
 145 int                     rpcauth_uptodatecred(struct rpc_task *);
 146 int                     rpcauth_init_credcache(struct rpc_auth *, unsigned long);
 147 void                    rpcauth_free_credcache(struct rpc_auth *);
 148
 149 static inline
 150 struct rpc_cred *       get_rpccred(struct rpc_cred *cred)
 151 {
 152         atomic_inc(&cred->cr_count);
 153         return cred;
 154 }
 155
 156 #endif /* __KERNEL__ */
 157 #endif /* _LINUX_SUNRPC_AUTH_H */