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 };
30
31 /*
32 * Client user credentials
33 */
34 struct rpc_auth;
35 struct rpc_credops;
36 struct rpc_cred {
37 struct hlist_node cr_hash; /* hash chain */
38 struct list_head cr_lru; /* lru garbage collection */
39 struct rcu_head cr_rcu;
40 struct rpc_auth * cr_auth;
41 const struct rpc_credops *cr_ops;
42 #ifdef RPC_DEBUG
43 unsigned long cr_magic; /* 0x0f4aa4f0 */
44 #endif
45 unsigned long cr_expire; /* when to gc */
46 unsigned long cr_flags; /* various flags */
47 atomic_t cr_count; /* ref count */
48
49 uid_t cr_uid;
50
51 /* per-flavor data */
52 };
53 #define RPCAUTH_CRED_NEW 0
54 #define RPCAUTH_CRED_UPTODATE 1
55 #define RPCAUTH_CRED_HASHED 2
56
57 #define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
58
59 /*
60 * Client authentication handle
61 */
62 #define RPC_CREDCACHE_NR 8
63 #define RPC_CREDCACHE_MASK (RPC_CREDCACHE_NR - 1)
64 struct rpc_cred_cache {
65 struct hlist_head hashtable[RPC_CREDCACHE_NR];
66 spinlock_t lock;
67 };
68
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 #define RPCAUTH_LOOKUP_ROOTCREDS 0x02 /* This really ought to go! */
93
94 /*
95 * Client authentication ops
96 */
97 struct rpc_authops {
98 struct module *owner;
99 rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */
100 #ifdef RPC_DEBUG
101 char * au_name;
102 #endif
103 struct rpc_auth * (*create)(struct rpc_clnt *, rpc_authflavor_t);
104 void (*destroy)(struct rpc_auth *);
105
106 struct rpc_cred * (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
107 struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int);
108 };
109
110 struct rpc_credops {
111 const char * cr_name; /* Name of the auth flavour */
112 int (*cr_init)(struct rpc_auth *, struct rpc_cred *);
113 void (*crdestroy)(struct rpc_cred *);
114
115 int (*crmatch)(struct auth_cred *, 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 void __init rpc_init_authunix(void);
129 void __init rpcauth_init_module(void);
130 void __exit rpcauth_remove_module(void);
131
132 int rpcauth_register(const struct rpc_authops *);
133 int rpcauth_unregister(const struct rpc_authops *);
134 struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
135 void rpcauth_release(struct rpc_auth *);
136 struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
137 void rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *);
138 struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
139 struct rpc_cred * rpcauth_bindcred(struct rpc_task *);
140 void rpcauth_holdcred(struct rpc_task *);
141 void put_rpccred(struct rpc_cred *);
142 void rpcauth_unbindcred(struct rpc_task *);
143 __be32 * rpcauth_marshcred(struct rpc_task *, __be32 *);
144 __be32 * rpcauth_checkverf(struct rpc_task *, __be32 *);
145 int rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, __be32 *data, void *obj);
146 int rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, __be32 *data, void *obj);
147 int rpcauth_refreshcred(struct rpc_task *);
148 void rpcauth_invalcred(struct rpc_task *);
149 int rpcauth_uptodatecred(struct rpc_task *);
150 int rpcauth_init_credcache(struct rpc_auth *);
151 void rpcauth_destroy_credcache(struct rpc_auth *);
152 void rpcauth_clear_credcache(struct rpc_cred_cache *);
153
154 static inline
155 struct rpc_cred * get_rpccred(struct rpc_cred *cred)
156 {
157 atomic_inc(&cred->cr_count);
158 return cred;
159 }
160
161 #endif /* __KERNEL__ */
162 #endif /* _LINUX_SUNRPC_AUTH_H */
163
|
This page was automatically generated by the
LXR engine.
|