2 * linux/include/linux/sunrpc/svcauth.h
4 * RPC server-side authentication stuff.
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
9 #ifndef _LINUX_SUNRPC_SVCAUTH_H_
10 #define _LINUX_SUNRPC_SVCAUTH_H_
14 #include <linux/string.h>
15 #include <linux/sunrpc/msg_prot.h>
16 #include <linux/sunrpc/cache.h>
17 #include <linux/hash.h>
22 struct group_info *cr_group_info;
25 struct svc_rqst; /* forward decl */
28 /* Authentication is done in the context of a domain.
30 * Currently, the nfs server uses the auth_domain to stand
31 * for the "client" listed in /etc/exports.
33 * More generally, a domain might represent a group of clients using
34 * a common mechanism for authentication and having a common mapping
35 * between local identity (uid) and network identity. All clients
36 * in a domain have similar general access rights. Each domain can
37 * contain multiple principals which will have different specific right
38 * based on normal Discretionary Access Control.
40 * A domain is created by an authentication flavour module based on name
41 * only. Userspace then fills in detail on demand.
43 * In the case of auth_unix and auth_null, the auth_domain is also
44 * associated with entries in another cache representing the mapping
45 * of ip addresses to the given client.
49 struct hlist_node hash;
51 struct auth_ops *flavour;
55 * Each authentication flavour registers an auth_ops
57 * name is simply the name.
58 * flavour gives the auth flavour. It determines where the flavour is registered
59 * accept() is given a request and should verify it.
60 * It should inspect the authenticator and verifier, and possibly the data.
61 * If there is a problem with the authentication *authp should be set.
62 * The return value of accept() can indicate:
63 * OK - authorised. client and credential are set in rqstp.
64 * reqbuf points to arguments
65 * resbuf points to good place for results. verfier
66 * is (probably) already in place. Certainly space is
68 * DROP - simply drop the request. It may have been deferred
69 * GARBAGE - rpc garbage_args error
70 * SYSERR - rpc system_err error
71 * DENIED - authp holds reason for denial.
72 * COMPLETE - the reply is encoded already and ready to be sent; no
73 * further processing is necessary. (This is used for processing
74 * null procedure calls which are used to set up encryption
77 * accept is passed the proc number so that it can accept NULL rpc requests
78 * even if it cannot authenticate the client (as is sometimes appropriate).
80 * release() is given a request after the procedure has been run.
81 * It should sign/encrypt the results if needed
83 * OK - the resbuf is ready to be sent
84 * DROP - the reply should be quitely dropped
85 * DENIED - authp holds a reason for MSG_DENIED
86 * SYSERR - rpc system_err
89 * This call releases a domain.
91 * Givens a pending request (struct svc_rqst), finds and assigns
92 * an appropriate 'auth_domain' as the client.
98 int (*accept)(struct svc_rqst *rq, __be32 *authp);
99 int (*release)(struct svc_rqst *rq);
100 void (*domain_release)(struct auth_domain *);
101 int (*set_client)(struct svc_rqst *rq);
104 #define SVC_GARBAGE 1
107 #define SVC_NEGATIVE 4
110 #define SVC_CLOSE 7 /* Like SVC_DROP, but request is definitely
111 * lost so if there is a tcp connection, it
115 #define SVC_PENDING 9
116 #define SVC_COMPLETE 10
120 extern int svc_authenticate(struct svc_rqst *rqstp, __be32 *authp);
121 extern int svc_authorise(struct svc_rqst *rqstp);
122 extern int svc_set_client(struct svc_rqst *rqstp);
123 extern int svc_auth_register(rpc_authflavor_t flavor, struct auth_ops *aops);
124 extern void svc_auth_unregister(rpc_authflavor_t flavor);
126 extern struct auth_domain *unix_domain_find(char *name);
127 extern void auth_domain_put(struct auth_domain *item);
128 extern int auth_unix_add_addr(struct net *net, struct in6_addr *addr, struct auth_domain *dom);
129 extern struct auth_domain *auth_domain_lookup(char *name, struct auth_domain *new);
130 extern struct auth_domain *auth_domain_find(char *name);
131 extern struct auth_domain *auth_unix_lookup(struct net *net, struct in6_addr *addr);
132 extern int auth_unix_forget_old(struct auth_domain *dom);
133 extern void svcauth_unix_purge(struct net *net);
134 extern void svcauth_unix_info_release(struct svc_xprt *xpt);
135 extern int svcauth_unix_set_client(struct svc_rqst *rqstp);
137 extern int unix_gid_cache_create(struct net *net);
138 extern void unix_gid_cache_destroy(struct net *net);
140 static inline unsigned long hash_str(char *name, int bits)
142 unsigned long hash = 0;
147 if (unlikely(!(c = *name++))) {
148 c = (char)len; len = -1;
152 if ((len & (BITS_PER_LONG/8-1))==0)
153 hash = hash_long(hash^l, BITS_PER_LONG);
155 return hash >> (BITS_PER_LONG - bits);
158 static inline unsigned long hash_mem(char *buf, int length, int bits)
160 unsigned long hash = 0;
166 c = (char)len; len = -1;
171 if ((len & (BITS_PER_LONG/8-1))==0)
172 hash = hash_long(hash^l, BITS_PER_LONG);
174 return hash >> (BITS_PER_LONG - bits);
177 #endif /* __KERNEL__ */
179 #endif /* _LINUX_SUNRPC_SVCAUTH_H_ */