Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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/config.h>
15#include <linux/sunrpc/sched.h>
16#include <linux/sunrpc/msg_prot.h>
17#include <linux/sunrpc/xdr.h>
18
19#include <asm/atomic.h>
20
21/* size of the nodename buffer */
22#define UNX_MAXNODENAME 32
23
24/* Maximum size (in bytes) of an rpc credential or verifier */
25#define RPC_MAX_AUTH_SIZE (400)
26
27/* Work around the lack of a VFS credential */
28struct auth_cred {
29 uid_t uid;
30 gid_t gid;
31 struct group_info *group_info;
32};
33
34/*
35 * Client user credentials
36 */
37struct 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
46
47 uid_t cr_uid;
48
49 /* per-flavor data */
50};
51#define RPCAUTH_CRED_LOCKED 0x0001
52#define RPCAUTH_CRED_UPTODATE 0x0002
53
54#define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
55
56/*
57 * Client authentication handle
58 */
59#define RPC_CREDCACHE_NR 8
60#define RPC_CREDCACHE_MASK (RPC_CREDCACHE_NR - 1)
61struct 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 */
65};
66
67struct 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;
74
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 */
82
83 struct rpc_cred_cache * au_credcache;
84 /* per-flavor data */
85};
86#define RPC_AUTH_PROC_CREDS 0x0010 /* process creds (including
87 * uid/gid, fs[ug]id, gids)
88 */
89
90/*
91 * Client authentication ops
92 */
93struct 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 *);
101
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);
104};
105
106struct rpc_credops {
107 const char * cr_name; /* Name of the auth flavour */
108 void (*crdestroy)(struct rpc_cred *);
109
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 *);
118};
119
120extern struct rpc_authops authunix_ops;
121extern struct rpc_authops authnull_ops;
122#ifdef CONFIG_SUNRPC_SECURE
123extern struct rpc_authops authdes_ops;
124#endif
125
126int rpcauth_register(struct rpc_authops *);
127int rpcauth_unregister(struct rpc_authops *);
128struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
129void rpcauth_destroy(struct rpc_auth *);
130struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
131struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
132struct rpc_cred * rpcauth_bindcred(struct rpc_task *);
133void rpcauth_holdcred(struct rpc_task *);
134void put_rpccred(struct rpc_cred *);
135void rpcauth_unbindcred(struct rpc_task *);
136u32 * rpcauth_marshcred(struct rpc_task *, u32 *);
137u32 * rpcauth_checkverf(struct rpc_task *, u32 *);
138int rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, u32 *data, void *obj);
139int rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, u32 *data, void *obj);
140int rpcauth_refreshcred(struct rpc_task *);
141void rpcauth_invalcred(struct rpc_task *);
142int rpcauth_uptodatecred(struct rpc_task *);
143int rpcauth_init_credcache(struct rpc_auth *, unsigned long);
144void rpcauth_free_credcache(struct rpc_auth *);
145
146static inline
147struct rpc_cred * get_rpccred(struct rpc_cred *cred)
148{
149 atomic_inc(&cred->cr_count);
150 return cred;
151}
152
153#endif /* __KERNEL__ */
154#endif /* _LINUX_SUNRPC_AUTH_H */