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