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/svcauth.h
3 *
4 * RPC server-side authentication stuff.
5 *
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
7 */
8
9#ifndef _LINUX_SUNRPC_SVCAUTH_H_
10#define _LINUX_SUNRPC_SVCAUTH_H_
11
12#ifdef __KERNEL__
13
14#include <linux/string.h>
15#include <linux/sunrpc/msg_prot.h>
16#include <linux/sunrpc/cache.h>
17#include <linux/sunrpc/gss_api.h>
18#include <linux/hash.h>
19#include <linux/stringhash.h>
20#include <linux/cred.h>
21
22struct svc_cred {
23 kuid_t cr_uid;
24 kgid_t cr_gid;
25 struct group_info *cr_group_info;
26 u32 cr_flavor; /* pseudoflavor */
27 /* name of form servicetype/hostname@REALM, passed down by
28 * gss-proxy: */
29 char *cr_raw_principal;
30 /* name of form servicetype@hostname, passed down by
31 * rpc.svcgssd, or computed from the above: */
32 char *cr_principal;
33 struct gss_api_mech *cr_gss_mech;
34};
35
36static inline void init_svc_cred(struct svc_cred *cred)
37{
38 cred->cr_group_info = NULL;
39 cred->cr_raw_principal = NULL;
40 cred->cr_principal = NULL;
41 cred->cr_gss_mech = NULL;
42}
43
44static inline void free_svc_cred(struct svc_cred *cred)
45{
46 if (cred->cr_group_info)
47 put_group_info(cred->cr_group_info);
48 kfree(cred->cr_raw_principal);
49 kfree(cred->cr_principal);
50 gss_mech_put(cred->cr_gss_mech);
51 init_svc_cred(cred);
52}
53
54struct svc_rqst; /* forward decl */
55struct in6_addr;
56
57/* Authentication is done in the context of a domain.
58 *
59 * Currently, the nfs server uses the auth_domain to stand
60 * for the "client" listed in /etc/exports.
61 *
62 * More generally, a domain might represent a group of clients using
63 * a common mechanism for authentication and having a common mapping
64 * between local identity (uid) and network identity. All clients
65 * in a domain have similar general access rights. Each domain can
66 * contain multiple principals which will have different specific right
67 * based on normal Discretionary Access Control.
68 *
69 * A domain is created by an authentication flavour module based on name
70 * only. Userspace then fills in detail on demand.
71 *
72 * In the case of auth_unix and auth_null, the auth_domain is also
73 * associated with entries in another cache representing the mapping
74 * of ip addresses to the given client.
75 */
76struct auth_domain {
77 struct kref ref;
78 struct hlist_node hash;
79 char *name;
80 struct auth_ops *flavour;
81};
82
83/*
84 * Each authentication flavour registers an auth_ops
85 * structure.
86 * name is simply the name.
87 * flavour gives the auth flavour. It determines where the flavour is registered
88 * accept() is given a request and should verify it.
89 * It should inspect the authenticator and verifier, and possibly the data.
90 * If there is a problem with the authentication *authp should be set.
91 * The return value of accept() can indicate:
92 * OK - authorised. client and credential are set in rqstp.
93 * reqbuf points to arguments
94 * resbuf points to good place for results. verfier
95 * is (probably) already in place. Certainly space is
96 * reserved for it.
97 * DROP - simply drop the request. It may have been deferred
98 * GARBAGE - rpc garbage_args error
99 * SYSERR - rpc system_err error
100 * DENIED - authp holds reason for denial.
101 * COMPLETE - the reply is encoded already and ready to be sent; no
102 * further processing is necessary. (This is used for processing
103 * null procedure calls which are used to set up encryption
104 * contexts.)
105 *
106 * accept is passed the proc number so that it can accept NULL rpc requests
107 * even if it cannot authenticate the client (as is sometimes appropriate).
108 *
109 * release() is given a request after the procedure has been run.
110 * It should sign/encrypt the results if needed
111 * It should return:
112 * OK - the resbuf is ready to be sent
113 * DROP - the reply should be quitely dropped
114 * DENIED - authp holds a reason for MSG_DENIED
115 * SYSERR - rpc system_err
116 *
117 * domain_release()
118 * This call releases a domain.
119 * set_client()
120 * Givens a pending request (struct svc_rqst), finds and assigns
121 * an appropriate 'auth_domain' as the client.
122 */
123struct auth_ops {
124 char * name;
125 struct module *owner;
126 int flavour;
127 int (*accept)(struct svc_rqst *rq, __be32 *authp);
128 int (*release)(struct svc_rqst *rq);
129 void (*domain_release)(struct auth_domain *);
130 int (*set_client)(struct svc_rqst *rq);
131};
132
133#define SVC_GARBAGE 1
134#define SVC_SYSERR 2
135#define SVC_VALID 3
136#define SVC_NEGATIVE 4
137#define SVC_OK 5
138#define SVC_DROP 6
139#define SVC_CLOSE 7 /* Like SVC_DROP, but request is definitely
140 * lost so if there is a tcp connection, it
141 * should be closed
142 */
143#define SVC_DENIED 8
144#define SVC_PENDING 9
145#define SVC_COMPLETE 10
146
147struct svc_xprt;
148
149extern int svc_authenticate(struct svc_rqst *rqstp, __be32 *authp);
150extern int svc_authorise(struct svc_rqst *rqstp);
151extern int svc_set_client(struct svc_rqst *rqstp);
152extern int svc_auth_register(rpc_authflavor_t flavor, struct auth_ops *aops);
153extern void svc_auth_unregister(rpc_authflavor_t flavor);
154
155extern struct auth_domain *unix_domain_find(char *name);
156extern void auth_domain_put(struct auth_domain *item);
157extern int auth_unix_add_addr(struct net *net, struct in6_addr *addr, struct auth_domain *dom);
158extern struct auth_domain *auth_domain_lookup(char *name, struct auth_domain *new);
159extern struct auth_domain *auth_domain_find(char *name);
160extern struct auth_domain *auth_unix_lookup(struct net *net, struct in6_addr *addr);
161extern int auth_unix_forget_old(struct auth_domain *dom);
162extern void svcauth_unix_purge(struct net *net);
163extern void svcauth_unix_info_release(struct svc_xprt *xpt);
164extern int svcauth_unix_set_client(struct svc_rqst *rqstp);
165
166extern int unix_gid_cache_create(struct net *net);
167extern void unix_gid_cache_destroy(struct net *net);
168
169/*
170 * The <stringhash.h> functions are good enough that we don't need to
171 * use hash_32() on them; just extracting the high bits is enough.
172 */
173static inline unsigned long hash_str(char const *name, int bits)
174{
175 return hashlen_hash(hashlen_string(NULL, name)) >> (32 - bits);
176}
177
178static inline unsigned long hash_mem(char const *buf, int length, int bits)
179{
180 return full_name_hash(NULL, buf, length) >> (32 - bits);
181}
182
183#endif /* __KERNEL__ */
184
185#endif /* _LINUX_SUNRPC_SVCAUTH_H_ */