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/sunrpc/sched.h>
  15 #include <linux/sunrpc/msg_prot.h>
  16 #include <linux/sunrpc/xdr.h>
  17
  18 #include <asm/atomic.h>
  19
  20 /* size of the nodename buffer */
  21 #define UNX_MAXNODENAME 32
  22
  23 /* Work around the lack of a VFS credential */
  24 struct auth_cred {
  25         uid_t   uid;
  26         gid_t   gid;
  27         struct group_info *group_info;
  28 };
  29
  30 /*
  31  * Client user credentials
  32  */
  33 struct rpc_auth;
  34 struct rpc_credops;
  35 struct rpc_cred {
  36         struct hlist_node       cr_hash;        /* hash chain */
  37         struct list_head        cr_lru;         /* lru garbage collection */
  38         struct rpc_auth *       cr_auth;
  39         const struct rpc_credops *cr_ops;
  40 #ifdef RPC_DEBUG
  41         unsigned long           cr_magic;       /* 0x0f4aa4f0 */
  42 #endif
  43         unsigned long           cr_expire;      /* when to gc */
  44         unsigned long           cr_flags;       /* various flags */
  45         atomic_t                cr_count;       /* ref count */
  46
  47         uid_t                   cr_uid;
  48
  49         /* per-flavor data */
  50 };
  51 #define RPCAUTH_CRED_NEW        0
  52 #define RPCAUTH_CRED_UPTODATE   1
  53
  54 #define RPCAUTH_CRED_MAGIC      0x0f4aa4f0
  55
  56 /*
  57  * Client authentication handle
  58  */
  59 #define RPC_CREDCACHE_NR        8
  60 #define RPC_CREDCACHE_MASK      (RPC_CREDCACHE_NR - 1)
  61 struct rpc_cred_cache {
  62         struct hlist_head       hashtable[RPC_CREDCACHE_NR];
  63         unsigned long           nextgc;         /* next garbage collection */
  64         unsigned long           expire;         /* cache expiry interval */
  65 };
  66
  67 struct rpc_authops;
  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         const 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         __be32 *                (*crmarshal)(struct rpc_task *, __be32 *);
 115         int                     (*crrefresh)(struct rpc_task *);
 116         __be32 *                (*crvalidate)(struct rpc_task *, __be32 *);
 117         int                     (*crwrap_req)(struct rpc_task *, kxdrproc_t,
 118                                                 void *, __be32 *, void *);
 119         int                     (*crunwrap_resp)(struct rpc_task *, kxdrproc_t,
 120                                                 void *, __be32 *, void *);
 121 };
 122
 123 extern const struct rpc_authops authunix_ops;
 124 extern const struct rpc_authops authnull_ops;
 125
 126 int                     rpcauth_register(const struct rpc_authops *);
 127 int                     rpcauth_unregister(const struct rpc_authops *);
 128 struct rpc_auth *       rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
 129 void                    rpcauth_release(struct rpc_auth *);
 130 struct rpc_cred *       rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
 131 void                    rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *);
 132 struct rpc_cred *       rpcauth_lookupcred(struct rpc_auth *, int);
 133 struct rpc_cred *       rpcauth_bindcred(struct rpc_task *);
 134 void                    rpcauth_holdcred(struct rpc_task *);
 135 void                    put_rpccred(struct rpc_cred *);
 136 void                    rpcauth_unbindcred(struct rpc_task *);
 137 __be32 *                rpcauth_marshcred(struct rpc_task *, __be32 *);
 138 __be32 *                rpcauth_checkverf(struct rpc_task *, __be32 *);
 139 int                     rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, __be32 *data, void *obj);
 140 int                     rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, __be32 *data, void *obj);
 141 int                     rpcauth_refreshcred(struct rpc_task *);
 142 void                    rpcauth_invalcred(struct rpc_task *);
 143 int                     rpcauth_uptodatecred(struct rpc_task *);
 144 int                     rpcauth_init_credcache(struct rpc_auth *, unsigned long);
 145 void                    rpcauth_destroy_credcache(struct rpc_auth *);
 146 void                    rpcauth_clear_credcache(struct rpc_cred_cache *);
 147
 148 static inline
 149 struct rpc_cred *       get_rpccred(struct rpc_cred *cred)
 150 {
 151         atomic_inc(&cred->cr_count);
 152         return cred;
 153 }
 154
 155 #endif /* __KERNEL__ */
 156 #endif /* _LINUX_SUNRPC_AUTH_H */