784e78c73ec519817f92b4d7b68298e3d3ad954b
[linux-2.6.git] / 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 #include <linux/rcupdate.h>
20
21 /* size of the nodename buffer */
22 #define UNX_MAXNODENAME 32
23
24 /* Work around the lack of a VFS credential */
25 struct auth_cred {
26         uid_t   uid;
27         gid_t   gid;
28         struct group_info *group_info;
29         unsigned char machine_cred : 1;
30 };
31
32 /*
33  * Client user credentials
34  */
35 struct rpc_auth;
36 struct rpc_credops;
37 struct rpc_cred {
38         struct hlist_node       cr_hash;        /* hash chain */
39         struct list_head        cr_lru;         /* lru garbage collection */
40         struct rcu_head         cr_rcu;
41         struct rpc_auth *       cr_auth;
42         const struct rpc_credops *cr_ops;
43 #ifdef RPC_DEBUG
44         unsigned long           cr_magic;       /* 0x0f4aa4f0 */
45 #endif
46         unsigned long           cr_expire;      /* when to gc */
47         unsigned long           cr_flags;       /* various flags */
48         atomic_t                cr_count;       /* ref count */
49
50         uid_t                   cr_uid;
51
52         /* per-flavor data */
53 };
54 #define RPCAUTH_CRED_NEW        0
55 #define RPCAUTH_CRED_UPTODATE   1
56 #define RPCAUTH_CRED_HASHED     2
57 #define RPCAUTH_CRED_NEGATIVE   3
58
59 #define RPCAUTH_CRED_MAGIC      0x0f4aa4f0
60
61 /*
62  * Client authentication handle
63  */
64 #define RPC_CREDCACHE_HASHBITS  4
65 #define RPC_CREDCACHE_NR        (1 << RPC_CREDCACHE_HASHBITS)
66 struct rpc_cred_cache {
67         struct hlist_head       hashtable[RPC_CREDCACHE_NR];
68         spinlock_t              lock;
69 };
70
71 struct rpc_authops;
72 struct rpc_auth {
73         unsigned int            au_cslack;      /* call cred size estimate */
74                                 /* guess at number of u32's auth adds before
75                                  * reply data; normally the verifier size: */
76         unsigned int            au_rslack;
77                                 /* for gss, used to calculate au_rslack: */
78         unsigned int            au_verfsize;
79
80         unsigned int            au_flags;       /* various flags */
81         const struct rpc_authops *au_ops;               /* operations */
82         rpc_authflavor_t        au_flavor;      /* pseudoflavor (note may
83                                                  * differ from the flavor in
84                                                  * au_ops->au_flavor in gss
85                                                  * case) */
86         atomic_t                au_count;       /* Reference counter */
87
88         struct rpc_cred_cache * au_credcache;
89         /* per-flavor data */
90 };
91
92 /* Flags for rpcauth_lookupcred() */
93 #define RPCAUTH_LOOKUP_NEW              0x01    /* Accept an uninitialised cred */
94
95 /*
96  * Client authentication ops
97  */
98 struct rpc_authops {
99         struct module           *owner;
100         rpc_authflavor_t        au_flavor;      /* flavor (RPC_AUTH_*) */
101         char *                  au_name;
102         struct rpc_auth *       (*create)(struct rpc_clnt *, rpc_authflavor_t);
103         void                    (*destroy)(struct rpc_auth *);
104
105         struct rpc_cred *       (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
106         struct rpc_cred *       (*crcreate)(struct rpc_auth*, struct auth_cred *, int);
107 };
108
109 struct rpc_credops {
110         const char *            cr_name;        /* Name of the auth flavour */
111         int                     (*cr_init)(struct rpc_auth *, struct rpc_cred *);
112         void                    (*crdestroy)(struct rpc_cred *);
113
114         int                     (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
115         void                    (*crbind)(struct rpc_task *, struct rpc_cred *, int);
116         __be32 *                (*crmarshal)(struct rpc_task *, __be32 *);
117         int                     (*crrefresh)(struct rpc_task *);
118         __be32 *                (*crvalidate)(struct rpc_task *, __be32 *);
119         int                     (*crwrap_req)(struct rpc_task *, kxdrproc_t,
120                                                 void *, __be32 *, void *);
121         int                     (*crunwrap_resp)(struct rpc_task *, kxdrproc_t,
122                                                 void *, __be32 *, void *);
123 };
124
125 extern const struct rpc_authops authunix_ops;
126 extern const struct rpc_authops authnull_ops;
127
128 int __init              rpc_init_authunix(void);
129 int __init              rpc_init_generic_auth(void);
130 int __init              rpcauth_init_module(void);
131 void __exit             rpcauth_remove_module(void);
132 void __exit             rpc_destroy_generic_auth(void);
133 void                    rpc_destroy_authunix(void);
134
135 struct rpc_cred *       rpc_lookup_cred(void);
136 struct rpc_cred *       rpc_lookup_machine_cred(void);
137 int                     rpcauth_register(const struct rpc_authops *);
138 int                     rpcauth_unregister(const struct rpc_authops *);
139 struct rpc_auth *       rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
140 void                    rpcauth_release(struct rpc_auth *);
141 struct rpc_cred *       rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
142 void                    rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *);
143 struct rpc_cred *       rpcauth_lookupcred(struct rpc_auth *, int);
144 void                    rpcauth_bindcred(struct rpc_task *, struct rpc_cred *, int);
145 void                    rpcauth_generic_bind_cred(struct rpc_task *, struct rpc_cred *, int);
146 void                    put_rpccred(struct rpc_cred *);
147 void                    rpcauth_unbindcred(struct rpc_task *);
148 __be32 *                rpcauth_marshcred(struct rpc_task *, __be32 *);
149 __be32 *                rpcauth_checkverf(struct rpc_task *, __be32 *);
150 int                     rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, __be32 *data, void *obj);
151 int                     rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, __be32 *data, void *obj);
152 int                     rpcauth_refreshcred(struct rpc_task *);
153 void                    rpcauth_invalcred(struct rpc_task *);
154 int                     rpcauth_uptodatecred(struct rpc_task *);
155 int                     rpcauth_init_credcache(struct rpc_auth *);
156 void                    rpcauth_destroy_credcache(struct rpc_auth *);
157 void                    rpcauth_clear_credcache(struct rpc_cred_cache *);
158
159 static inline
160 struct rpc_cred *       get_rpccred(struct rpc_cred *cred)
161 {
162         atomic_inc(&cred->cr_count);
163         return cred;
164 }
165
166 #endif /* __KERNEL__ */
167 #endif /* _LINUX_SUNRPC_AUTH_H */