1 /* $NetBSD: svc_auth.c,v 1.12 2000/07/06 03:10:35 christos Exp $ */
4 * Copyright (c) 2009, Sun Microsystems, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * - Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 * - Neither the name of Sun Microsystems, Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
31 * Copyright (c) 1986-1991 by Sun Microsystems Inc.
34 #if defined(LIBC_SCCS) && !defined(lint)
35 #ident "@(#)svc_auth.c 1.16 94/04/24 SMI"
36 static char sccsid[] = "@(#)svc_auth.c 1.26 89/02/07 Copyr 1984 Sun Micro";
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
42 * svc_auth.c, Server-side rpc authenticator interface.
46 #include "namespace.h"
47 #include "reentrant.h"
48 #include <sys/types.h>
51 #include "un-namespace.h"
55 * svcauthsw is the bdevsw of server side authentication.
57 * Server side authenticators are called from authenticate by
58 * using the client auth struct flavor field to index into svcauthsw.
59 * The server auth flavors must implement a routine that looks
63 * flavorx_auth(rqst, msg)
64 * struct svc_req *rqst;
65 * struct rpc_msg *msg;
69 /* declarations to allow servers to specify new authentication flavors */
72 enum auth_stat (*handler)(struct svc_req *, struct rpc_msg *);
75 static struct authsvc *Auths = NULL;
77 struct svc_auth_ops svc_auth_null_ops;
80 * The call rpc message, msg has been obtained from the wire. The msg contains
81 * the raw form of credentials and verifiers. authenticate returns AUTH_OK
82 * if the msg is successfully authenticated. If AUTH_OK then the routine also
83 * does the following things:
84 * set rqst->rq_xprt->verf to the appropriate response verifier;
85 * sets rqst->rq_client_cred to the "cooked" form of the credentials.
87 * NB: rqst->rq_cxprt->verf must be pre-alloctaed;
88 * its length is set appropriately.
90 * The caller still owns and is responsible for msg->u.cmb.cred and
91 * msg->u.cmb.verf. The authentication system retains ownership of
92 * rqst->rq_client_cred, the cooked credentials.
94 * There is an assumption that any flavour less than AUTH_NULL is
98 _authenticate(struct svc_req *rqst, struct rpc_msg *msg)
102 enum auth_stat dummy;
104 /* VARIABLES PROTECTED BY authsvc_lock: asp, Auths */
106 rqst->rq_cred = msg->rm_call.cb_cred;
107 SVC_AUTH(rqst->rq_xprt).svc_ah_ops = &svc_auth_null_ops;
108 SVC_AUTH(rqst->rq_xprt).svc_ah_private = NULL;
109 rqst->rq_xprt->xp_verf.oa_flavor = _null_auth.oa_flavor;
110 rqst->rq_xprt->xp_verf.oa_length = 0;
111 cred_flavor = rqst->rq_cred.oa_flavor;
112 switch (cred_flavor) {
114 dummy = _svcauth_null(rqst, msg);
117 dummy = _svcauth_unix(rqst, msg);
120 dummy = _svcauth_short(rqst, msg);
124 dummy = _svcauth_des(rqst, msg);
131 /* flavor doesn't match any of the builtin types, so try new ones */
132 mutex_lock(&authsvc_lock);
133 for (asp = Auths; asp; asp = asp->next) {
134 if (asp->flavor == cred_flavor) {
137 as = (*asp->handler)(rqst, msg);
138 mutex_unlock(&authsvc_lock);
142 mutex_unlock(&authsvc_lock);
144 return (AUTH_REJECTEDCRED);
148 * A set of null auth methods used by any authentication protocols
149 * that don't need to inspect or modify the message body.
152 svcauth_null_wrap(SVCAUTH *auth, XDR *xdrs, xdrproc_t xdr_func, caddr_t xdr_ptr)
155 return (xdr_func(xdrs, xdr_ptr));
158 struct svc_auth_ops svc_auth_null_ops = {
165 _svcauth_null(struct svc_req *rqst, struct rpc_msg *msg)
171 * Allow the rpc service to register new authentication types that it is
172 * prepared to handle. When an authentication flavor is registered,
173 * the flavor is checked against already registered values. If not
174 * registered, then a new Auths entry is added on the list.
176 * There is no provision to delete a registration once registered.
178 * This routine returns:
179 * 0 if registration successful
180 * 1 if flavor already registered
181 * -1 if can't register (errno set)
185 svc_auth_reg(int cred_flavor,
186 enum auth_stat (*handler)(struct svc_req *, struct rpc_msg *))
190 switch (cred_flavor) {
197 /* already registered */
201 mutex_lock(&authsvc_lock);
202 for (asp = Auths; asp; asp = asp->next) {
203 if (asp->flavor == cred_flavor) {
204 /* already registered */
205 mutex_unlock(&authsvc_lock);
210 /* this is a new one, so go ahead and register it */
211 asp = mem_alloc(sizeof (*asp));
213 mutex_unlock(&authsvc_lock);
216 asp->flavor = cred_flavor;
217 asp->handler = handler;
220 mutex_unlock(&authsvc_lock);