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>
9 #ifndef _LINUX_SUNRPC_AUTH_H
10 #define _LINUX_SUNRPC_AUTH_H
14 #include <linux/sunrpc/sched.h>
15 #include <linux/sunrpc/msg_prot.h>
16 #include <linux/sunrpc/xdr.h>
18 #include <asm/atomic.h>
20 /* size of the nodename buffer */
21 #define UNX_MAXNODENAME 32
23 /* Work around the lack of a VFS credential */
27 struct group_info *group_info;
31 * Client user credentials
36 struct hlist_node cr_hash; /* hash chain */
37 struct rpc_auth * cr_auth;
38 const struct rpc_credops *cr_ops;
40 unsigned long cr_magic; /* 0x0f4aa4f0 */
42 unsigned long cr_expire; /* when to gc */
43 unsigned long cr_flags; /* various flags */
44 atomic_t cr_count; /* ref count */
50 #define RPCAUTH_CRED_NEW 0
51 #define RPCAUTH_CRED_UPTODATE 1
53 #define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
56 * Client authentication handle
58 #define RPC_CREDCACHE_NR 8
59 #define RPC_CREDCACHE_MASK (RPC_CREDCACHE_NR - 1)
60 struct rpc_cred_cache {
61 struct hlist_head hashtable[RPC_CREDCACHE_NR];
62 unsigned long nextgc; /* next garbage collection */
63 unsigned long expire; /* cache expiry interval */
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 const 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
81 atomic_t au_count; /* Reference counter */
83 struct rpc_cred_cache * au_credcache;
87 /* Flags for rpcauth_lookupcred() */
88 #define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
89 #define RPCAUTH_LOOKUP_ROOTCREDS 0x02 /* This really ought to go! */
92 * Client authentication ops
96 rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */
100 struct rpc_auth * (*create)(struct rpc_clnt *, rpc_authflavor_t);
101 void (*destroy)(struct rpc_auth *);
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);
108 const char * cr_name; /* Name of the auth flavour */
109 int (*cr_init)(struct rpc_auth *, struct rpc_cred *);
110 void (*crdestroy)(struct rpc_cred *);
112 int (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
113 __be32 * (*crmarshal)(struct rpc_task *, __be32 *);
114 int (*crrefresh)(struct rpc_task *);
115 __be32 * (*crvalidate)(struct rpc_task *, __be32 *);
116 int (*crwrap_req)(struct rpc_task *, kxdrproc_t,
117 void *, __be32 *, void *);
118 int (*crunwrap_resp)(struct rpc_task *, kxdrproc_t,
119 void *, __be32 *, void *);
122 extern const struct rpc_authops authunix_ops;
123 extern const struct rpc_authops authnull_ops;
125 int rpcauth_register(const struct rpc_authops *);
126 int rpcauth_unregister(const struct rpc_authops *);
127 struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
128 void rpcauth_release(struct rpc_auth *);
129 struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
130 void rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *);
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 __be32 * rpcauth_marshcred(struct rpc_task *, __be32 *);
137 __be32 * rpcauth_checkverf(struct rpc_task *, __be32 *);
138 int rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, __be32 *data, void *obj);
139 int rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, __be32 *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_destroy_credcache(struct rpc_auth *);
145 void rpcauth_clear_credcache(struct rpc_cred_cache *);
148 struct rpc_cred * get_rpccred(struct rpc_cred *cred)
150 atomic_inc(&cred->cr_count);
154 #endif /* __KERNEL__ */
155 #endif /* _LINUX_SUNRPC_AUTH_H */