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 */
32 struct group_info *group_info;
36 * Client user credentials
39 struct list_head cr_hash; /* hash chain */
40 struct rpc_auth * cr_auth;
41 struct rpc_credops * cr_ops;
42 unsigned long cr_expire; /* when to gc */
43 atomic_t cr_count; /* ref count */
44 unsigned short cr_flags; /* various flags */
46 unsigned long cr_magic; /* 0x0f4aa4f0 */
53 #define RPCAUTH_CRED_LOCKED 0x0001
54 #define RPCAUTH_CRED_UPTODATE 0x0002
55 #define RPCAUTH_CRED_DEAD 0x0004
57 #define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
60 * Client authentication handle
62 #define RPC_CREDCACHE_NR 8
63 #define RPC_CREDCACHE_MASK (RPC_CREDCACHE_NR - 1)
65 struct list_head au_credcache[RPC_CREDCACHE_NR];
66 unsigned long au_expire; /* cache expiry interval */
67 unsigned long au_nextgc; /* next garbage collection */
68 unsigned int au_cslack; /* call cred size estimate */
69 unsigned int au_rslack; /* reply verf size guess */
70 unsigned int au_flags; /* various flags */
71 struct rpc_authops * au_ops; /* operations */
72 rpc_authflavor_t au_flavor; /* pseudoflavor (note may
73 * differ from the flavor in
74 * au_ops->au_flavor in gss
76 atomic_t au_count; /* Reference counter */
80 #define RPC_AUTH_PROC_CREDS 0x0010 /* process creds (including
81 * uid/gid, fs[ug]id, gids)
85 * Client authentication ops
89 rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */
93 struct rpc_auth * (*create)(struct rpc_clnt *, rpc_authflavor_t);
94 void (*destroy)(struct rpc_auth *);
96 struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int);
100 void (*crdestroy)(struct rpc_cred *);
102 int (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
103 u32 * (*crmarshal)(struct rpc_task *, u32 *, int);
104 int (*crrefresh)(struct rpc_task *);
105 u32 * (*crvalidate)(struct rpc_task *, u32 *);
106 int (*crwrap_req)(struct rpc_task *, kxdrproc_t,
107 void *, u32 *, void *);
108 int (*crunwrap_resp)(struct rpc_task *, kxdrproc_t,
109 void *, u32 *, void *);
112 extern struct rpc_authops authunix_ops;
113 extern struct rpc_authops authnull_ops;
114 #ifdef CONFIG_SUNRPC_SECURE
115 extern struct rpc_authops authdes_ops;
118 u32 pseudoflavor_to_flavor(rpc_authflavor_t);
120 int rpcauth_register(struct rpc_authops *);
121 int rpcauth_unregister(struct rpc_authops *);
122 struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
123 void rpcauth_destroy(struct rpc_auth *);
124 struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
125 struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
126 struct rpc_cred * rpcauth_bindcred(struct rpc_task *);
127 void rpcauth_holdcred(struct rpc_task *);
128 void put_rpccred(struct rpc_cred *);
129 void rpcauth_unbindcred(struct rpc_task *);
130 u32 * rpcauth_marshcred(struct rpc_task *, u32 *);
131 u32 * rpcauth_checkverf(struct rpc_task *, u32 *);
132 int rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, u32 *data, void *obj);
133 int rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, u32 *data, void *obj);
134 int rpcauth_refreshcred(struct rpc_task *);
135 void rpcauth_invalcred(struct rpc_task *);
136 int rpcauth_uptodatecred(struct rpc_task *);
137 int rpcauth_deadcred(struct rpc_task *);
138 void rpcauth_init_credcache(struct rpc_auth *);
139 void rpcauth_free_credcache(struct rpc_auth *);
142 struct rpc_cred * get_rpccred(struct rpc_cred *cred)
144 atomic_inc(&cred->cr_count);
148 #endif /* __KERNEL__ */
149 #endif /* _LINUX_SUNRPC_AUTH_H */