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/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 */
31 struct group_info *group_info;
35 * Client user credentials
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 */
44 unsigned long cr_magic; /* 0x0f4aa4f0 */
51 #define RPCAUTH_CRED_LOCKED 0x0001
52 #define RPCAUTH_CRED_UPTODATE 0x0002
53 #define RPCAUTH_CRED_NEW 0x0004
55 #define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
58 * Client authentication handle
60 #define RPC_CREDCACHE_NR 8
61 #define RPC_CREDCACHE_MASK (RPC_CREDCACHE_NR - 1)
62 struct rpc_cred_cache {
63 struct hlist_head hashtable[RPC_CREDCACHE_NR];
64 unsigned long nextgc; /* next garbage collection */
65 unsigned long expire; /* cache expiry interval */
69 unsigned int au_cslack; /* call cred size estimate */
70 /* guess at number of u32's auth adds before
71 * reply data; normally the verifier size: */
72 unsigned int au_rslack;
73 /* for gss, used to calculate au_rslack: */
74 unsigned int au_verfsize;
76 unsigned int au_flags; /* various flags */
77 struct rpc_authops * au_ops; /* operations */
78 rpc_authflavor_t au_flavor; /* pseudoflavor (note may
79 * differ from the flavor in
80 * au_ops->au_flavor in gss
82 atomic_t au_count; /* Reference counter */
84 struct rpc_cred_cache * au_credcache;
87 #define RPC_AUTH_PROC_CREDS 0x0010 /* process creds (including
88 * uid/gid, fs[ug]id, gids)
91 /* Flags for rpcauth_lookupcred() */
92 #define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
93 #define RPCAUTH_LOOKUP_ROOTCREDS 0x02 /* This really ought to go! */
96 * Client authentication ops
100 rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */
104 struct rpc_auth * (*create)(struct rpc_clnt *, rpc_authflavor_t);
105 void (*destroy)(struct rpc_auth *);
107 struct rpc_cred * (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
108 struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int);
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 *);
116 int (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
117 u32 * (*crmarshal)(struct rpc_task *, u32 *);
118 int (*crrefresh)(struct rpc_task *);
119 u32 * (*crvalidate)(struct rpc_task *, u32 *);
120 int (*crwrap_req)(struct rpc_task *, kxdrproc_t,
121 void *, u32 *, void *);
122 int (*crunwrap_resp)(struct rpc_task *, kxdrproc_t,
123 void *, u32 *, void *);
126 extern struct rpc_authops authunix_ops;
127 extern struct rpc_authops authnull_ops;
128 #ifdef CONFIG_SUNRPC_SECURE
129 extern struct rpc_authops authdes_ops;
132 int rpcauth_register(struct rpc_authops *);
133 int rpcauth_unregister(struct rpc_authops *);
134 struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
135 void rpcauth_destroy(struct rpc_auth *);
136 struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
137 struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
138 struct rpc_cred * rpcauth_bindcred(struct rpc_task *);
139 void rpcauth_holdcred(struct rpc_task *);
140 void put_rpccred(struct rpc_cred *);
141 void rpcauth_unbindcred(struct rpc_task *);
142 u32 * rpcauth_marshcred(struct rpc_task *, u32 *);
143 u32 * rpcauth_checkverf(struct rpc_task *, u32 *);
144 int rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, u32 *data, void *obj);
145 int rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, u32 *data, void *obj);
146 int rpcauth_refreshcred(struct rpc_task *);
147 void rpcauth_invalcred(struct rpc_task *);
148 int rpcauth_uptodatecred(struct rpc_task *);
149 int rpcauth_init_credcache(struct rpc_auth *, unsigned long);
150 void rpcauth_free_credcache(struct rpc_auth *);
153 struct rpc_cred * get_rpccred(struct rpc_cred *cred)
155 atomic_inc(&cred->cr_count);
159 #endif /* __KERNEL__ */
160 #endif /* _LINUX_SUNRPC_AUTH_H */