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/sunrpc/sched.h>
15 #include <linux/sunrpc/msg_prot.h>
16 #include <linux/sunrpc/xdr.h>
17
18 #include <linux/atomic.h>
19 #include <linux/rcupdate.h>
20 #include <linux/uidgid.h>
21
22 /* size of the nodename buffer */
23 #define UNX_MAXNODENAME 32
24
25 struct rpcsec_gss_info;
26
27 /* auth_cred ac_flags bits */
28 enum {
29 RPC_CRED_NO_CRKEY_TIMEOUT = 0, /* underlying cred has no key timeout */
30 RPC_CRED_KEY_EXPIRE_SOON = 1, /* underlying cred key will expire soon */
31 RPC_CRED_NOTIFY_TIMEOUT = 2, /* nofity generic cred when underlying
32 key will expire soon */
33 };
34
35 /* Work around the lack of a VFS credential */
36 struct auth_cred {
37 kuid_t uid;
38 kgid_t gid;
39 struct group_info *group_info;
40 const char *principal;
41 unsigned long ac_flags;
42 unsigned char machine_cred : 1;
43 };
44
45 /*
46 * Client user credentials
47 */
48 struct rpc_auth;
49 struct rpc_credops;
50 struct rpc_cred {
51 struct hlist_node cr_hash; /* hash chain */
52 struct list_head cr_lru; /* lru garbage collection */
53 struct rcu_head cr_rcu;
54 struct rpc_auth * cr_auth;
55 const struct rpc_credops *cr_ops;
56 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
57 unsigned long cr_magic; /* 0x0f4aa4f0 */
58 #endif
59 unsigned long cr_expire; /* when to gc */
60 unsigned long cr_flags; /* various flags */
61 atomic_t cr_count; /* ref count */
62
63 kuid_t cr_uid;
64
65 /* per-flavor data */
66 };
67 #define RPCAUTH_CRED_NEW 0
68 #define RPCAUTH_CRED_UPTODATE 1
69 #define RPCAUTH_CRED_HASHED 2
70 #define RPCAUTH_CRED_NEGATIVE 3
71
72 #define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
73
74 /*
75 * Client authentication handle
76 */
77 struct rpc_cred_cache;
78 struct rpc_authops;
79 struct rpc_auth {
80 unsigned int au_cslack; /* call cred size estimate */
81 /* guess at number of u32's auth adds before
82 * reply data; normally the verifier size: */
83 unsigned int au_rslack;
84 /* for gss, used to calculate au_rslack: */
85 unsigned int au_verfsize;
86
87 unsigned int au_flags; /* various flags */
88 const struct rpc_authops *au_ops; /* operations */
89 rpc_authflavor_t au_flavor; /* pseudoflavor (note may
90 * differ from the flavor in
91 * au_ops->au_flavor in gss
92 * case) */
93 atomic_t au_count; /* Reference counter */
94
95 struct rpc_cred_cache * au_credcache;
96 /* per-flavor data */
97 };
98
99 struct rpc_auth_create_args {
100 rpc_authflavor_t pseudoflavor;
101 const char *target_name;
102 };
103
104 /* Flags for rpcauth_lookupcred() */
105 #define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
106 #define RPCAUTH_LOOKUP_RCU 0x02 /* lock-less lookup */
107
108 /*
109 * Client authentication ops
110 */
111 struct rpc_authops {
112 struct module *owner;
113 rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */
114 char * au_name;
115 struct rpc_auth * (*create)(struct rpc_auth_create_args *, struct rpc_clnt *);
116 void (*destroy)(struct rpc_auth *);
117
118 struct rpc_cred * (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
119 struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int);
120 int (*list_pseudoflavors)(rpc_authflavor_t *, int);
121 rpc_authflavor_t (*info2flavor)(struct rpcsec_gss_info *);
122 int (*flavor2info)(rpc_authflavor_t,
123 struct rpcsec_gss_info *);
124 int (*key_timeout)(struct rpc_auth *,
125 struct rpc_cred *);
126 };
127
128 struct rpc_credops {
129 const char * cr_name; /* Name of the auth flavour */
130 int (*cr_init)(struct rpc_auth *, struct rpc_cred *);
131 void (*crdestroy)(struct rpc_cred *);
132
133 int (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
134 struct rpc_cred * (*crbind)(struct rpc_task *, struct rpc_cred *, int);
135 __be32 * (*crmarshal)(struct rpc_task *, __be32 *);
136 int (*crrefresh)(struct rpc_task *);
137 __be32 * (*crvalidate)(struct rpc_task *, __be32 *);
138 int (*crwrap_req)(struct rpc_task *, kxdreproc_t,
139 void *, __be32 *, void *);
140 int (*crunwrap_resp)(struct rpc_task *, kxdrdproc_t,
141 void *, __be32 *, void *);
142 int (*crkey_timeout)(struct rpc_cred *);
143 bool (*crkey_to_expire)(struct rpc_cred *);
144 char * (*crstringify_acceptor)(struct rpc_cred *);
145 };
146
147 extern const struct rpc_authops authunix_ops;
148 extern const struct rpc_authops authnull_ops;
149
150 int __init rpc_init_authunix(void);
151 int __init rpc_init_generic_auth(void);
152 int __init rpcauth_init_module(void);
153 void rpcauth_remove_module(void);
154 void rpc_destroy_generic_auth(void);
155 void rpc_destroy_authunix(void);
156
157 struct rpc_cred * rpc_lookup_cred(void);
158 struct rpc_cred * rpc_lookup_cred_nonblock(void);
159 struct rpc_cred * rpc_lookup_machine_cred(const char *service_name);
160 int rpcauth_register(const struct rpc_authops *);
161 int rpcauth_unregister(const struct rpc_authops *);
162 struct rpc_auth * rpcauth_create(struct rpc_auth_create_args *,
163 struct rpc_clnt *);
164 void rpcauth_release(struct rpc_auth *);
165 rpc_authflavor_t rpcauth_get_pseudoflavor(rpc_authflavor_t,
166 struct rpcsec_gss_info *);
167 int rpcauth_get_gssinfo(rpc_authflavor_t,
168 struct rpcsec_gss_info *);
169 int rpcauth_list_flavors(rpc_authflavor_t *, int);
170 struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
171 void rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *);
172 struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
173 struct rpc_cred * rpcauth_generic_bind_cred(struct rpc_task *, struct rpc_cred *, int);
174 void put_rpccred(struct rpc_cred *);
175 __be32 * rpcauth_marshcred(struct rpc_task *, __be32 *);
176 __be32 * rpcauth_checkverf(struct rpc_task *, __be32 *);
177 int rpcauth_wrap_req(struct rpc_task *task, kxdreproc_t encode, void *rqstp, __be32 *data, void *obj);
178 int rpcauth_unwrap_resp(struct rpc_task *task, kxdrdproc_t decode, void *rqstp, __be32 *data, void *obj);
179 int rpcauth_refreshcred(struct rpc_task *);
180 void rpcauth_invalcred(struct rpc_task *);
181 int rpcauth_uptodatecred(struct rpc_task *);
182 int rpcauth_init_credcache(struct rpc_auth *);
183 void rpcauth_destroy_credcache(struct rpc_auth *);
184 void rpcauth_clear_credcache(struct rpc_cred_cache *);
185 int rpcauth_key_timeout_notify(struct rpc_auth *,
186 struct rpc_cred *);
187 bool rpcauth_cred_key_to_expire(struct rpc_cred *);
188 char * rpcauth_stringify_acceptor(struct rpc_cred *);
189
190 static inline
get_rpccred(struct rpc_cred * cred)191 struct rpc_cred * get_rpccred(struct rpc_cred *cred)
192 {
193 atomic_inc(&cred->cr_count);
194 return cred;
195 }
196
197 #endif /* __KERNEL__ */
198 #endif /* _LINUX_SUNRPC_AUTH_H */
199