Linux v2.6.15-rc6
[pohmelfs.git] / include / linux / sunrpc / auth.h
blobb68c11a2d6dd912274b146df30d17bc4045800a9
1 /*
2 * linux/include/linux/sunrpc/auth.h
4 * Declarations for the RPC client authentication machinery.
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
7 */
9 #ifndef _LINUX_SUNRPC_AUTH_H
10 #define _LINUX_SUNRPC_AUTH_H
12 #ifdef __KERNEL__
14 #include <linux/config.h>
15 #include <linux/sunrpc/sched.h>
16 #include <linux/sunrpc/msg_prot.h>
17 #include <linux/sunrpc/xdr.h>
19 #include <asm/atomic.h>
21 /* size of the nodename buffer */
22 #define UNX_MAXNODENAME 32
24 /* Maximum size (in bytes) of an rpc credential or verifier */
25 #define RPC_MAX_AUTH_SIZE (400)
27 /* Work around the lack of a VFS credential */
28 struct auth_cred {
29 uid_t uid;
30 gid_t gid;
31 struct group_info *group_info;
35 * Client user credentials
37 struct rpc_cred {
38 struct hlist_node cr_hash; /* hash chain */
39 struct rpc_credops * cr_ops;
40 unsigned long cr_expire; /* when to gc */
41 atomic_t cr_count; /* ref count */
42 unsigned short cr_flags; /* various flags */
43 #ifdef RPC_DEBUG
44 unsigned long cr_magic; /* 0x0f4aa4f0 */
45 #endif
47 uid_t cr_uid;
49 /* per-flavor data */
51 #define RPCAUTH_CRED_LOCKED 0x0001
52 #define RPCAUTH_CRED_UPTODATE 0x0002
54 #define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
57 * Client authentication handle
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 */
67 struct rpc_auth {
68 unsigned int au_cslack; /* call cred size estimate */
69 /* guess at number of u32's auth adds before
70 * reply data; normally the verifier size: */
71 unsigned int au_rslack;
72 /* for gss, used to calculate au_rslack: */
73 unsigned int au_verfsize;
75 unsigned int au_flags; /* various flags */
76 struct rpc_authops * au_ops; /* operations */
77 rpc_authflavor_t au_flavor; /* pseudoflavor (note may
78 * differ from the flavor in
79 * au_ops->au_flavor in gss
80 * case) */
81 atomic_t au_count; /* Reference counter */
83 struct rpc_cred_cache * au_credcache;
84 /* per-flavor data */
86 #define RPC_AUTH_PROC_CREDS 0x0010 /* process creds (including
87 * uid/gid, fs[ug]id, gids)
91 * Client authentication ops
93 struct rpc_authops {
94 struct module *owner;
95 rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */
96 #ifdef RPC_DEBUG
97 char * au_name;
98 #endif
99 struct rpc_auth * (*create)(struct rpc_clnt *, rpc_authflavor_t);
100 void (*destroy)(struct rpc_auth *);
102 struct rpc_cred * (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
103 struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int);
106 struct rpc_credops {
107 const char * cr_name; /* Name of the auth flavour */
108 void (*crdestroy)(struct rpc_cred *);
110 int (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
111 u32 * (*crmarshal)(struct rpc_task *, u32 *);
112 int (*crrefresh)(struct rpc_task *);
113 u32 * (*crvalidate)(struct rpc_task *, u32 *);
114 int (*crwrap_req)(struct rpc_task *, kxdrproc_t,
115 void *, u32 *, void *);
116 int (*crunwrap_resp)(struct rpc_task *, kxdrproc_t,
117 void *, u32 *, void *);
120 extern struct rpc_authops authunix_ops;
121 extern struct rpc_authops authnull_ops;
122 #ifdef CONFIG_SUNRPC_SECURE
123 extern struct rpc_authops authdes_ops;
124 #endif
126 int rpcauth_register(struct rpc_authops *);
127 int rpcauth_unregister(struct rpc_authops *);
128 struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
129 void rpcauth_destroy(struct rpc_auth *);
130 struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
131 struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
132 struct rpc_cred * rpcauth_bindcred(struct rpc_task *);
133 void rpcauth_holdcred(struct rpc_task *);
134 void put_rpccred(struct rpc_cred *);
135 void rpcauth_unbindcred(struct rpc_task *);
136 u32 * rpcauth_marshcred(struct rpc_task *, u32 *);
137 u32 * rpcauth_checkverf(struct rpc_task *, u32 *);
138 int rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, u32 *data, void *obj);
139 int rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, u32 *data, void *obj);
140 int rpcauth_refreshcred(struct rpc_task *);
141 void rpcauth_invalcred(struct rpc_task *);
142 int rpcauth_uptodatecred(struct rpc_task *);
143 int rpcauth_init_credcache(struct rpc_auth *, unsigned long);
144 void rpcauth_free_credcache(struct rpc_auth *);
146 static inline
147 struct rpc_cred * get_rpccred(struct rpc_cred *cred)
149 atomic_inc(&cred->cr_count);
150 return cred;
153 #endif /* __KERNEL__ */
154 #endif /* _LINUX_SUNRPC_AUTH_H */