xref: /freebsd/lib/libc/rpc/svc_auth.c (revision 74bf4e164ba5851606a27d4feff27717452583e5)
1 /*	$NetBSD: svc_auth.c,v 1.12 2000/07/06 03:10:35 christos Exp $	*/
2 
3 /*
4  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
5  * unrestricted use provided that this legend is included on all tape
6  * media and as a part of the software program in whole or part.  Users
7  * may copy or modify Sun RPC without charge, but are not authorized
8  * to license or distribute it to anyone else except as part of a product or
9  * program developed by the user.
10  *
11  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
12  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
13  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
14  *
15  * Sun RPC is provided with no support and without any obligation on the
16  * part of Sun Microsystems, Inc. to assist in its use, correction,
17  * modification or enhancement.
18  *
19  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
20  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
21  * OR ANY PART THEREOF.
22  *
23  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
24  * or profits or other special, indirect and consequential damages, even if
25  * Sun has been advised of the possibility of such damages.
26  *
27  * Sun Microsystems, Inc.
28  * 2550 Garcia Avenue
29  * Mountain View, California  94043
30  */
31 /*
32  * Copyright (c) 1986-1991 by Sun Microsystems Inc.
33  */
34 
35 /* #ident	"@(#)svc_auth.c	1.16	94/04/24 SMI" */
36 
37 #if !defined(lint) && defined(SCCSIDS)
38 static char sccsid[] = "@(#)svc_auth.c 1.26 89/02/07 Copyr 1984 Sun Micro";
39 #endif
40 #include <sys/cdefs.h>
41 __FBSDID("$FreeBSD$");
42 
43 /*
44  * svc_auth.c, Server-side rpc authenticator interface.
45  *
46  */
47 
48 #include "namespace.h"
49 #include "reentrant.h"
50 #include <sys/types.h>
51 #include <rpc/rpc.h>
52 #include <stdlib.h>
53 #include "un-namespace.h"
54 
55 /*
56  * svcauthsw is the bdevsw of server side authentication.
57  *
58  * Server side authenticators are called from authenticate by
59  * using the client auth struct flavor field to index into svcauthsw.
60  * The server auth flavors must implement a routine that looks
61  * like:
62  *
63  *	enum auth_stat
64  *	flavorx_auth(rqst, msg)
65  *		struct svc_req *rqst;
66  *		struct rpc_msg *msg;
67  *
68  */
69 
70 /* declarations to allow servers to specify new authentication flavors */
71 struct authsvc {
72 	int	flavor;
73 	enum	auth_stat (*handler)(struct svc_req *, struct rpc_msg *);
74 	struct	authsvc	  *next;
75 };
76 static struct authsvc *Auths = NULL;
77 
78 /*
79  * The call rpc message, msg has been obtained from the wire.  The msg contains
80  * the raw form of credentials and verifiers.  authenticate returns AUTH_OK
81  * if the msg is successfully authenticated.  If AUTH_OK then the routine also
82  * does the following things:
83  * set rqst->rq_xprt->verf to the appropriate response verifier;
84  * sets rqst->rq_client_cred to the "cooked" form of the credentials.
85  *
86  * NB: rqst->rq_cxprt->verf must be pre-alloctaed;
87  * its length is set appropriately.
88  *
89  * The caller still owns and is responsible for msg->u.cmb.cred and
90  * msg->u.cmb.verf.  The authentication system retains ownership of
91  * rqst->rq_client_cred, the cooked credentials.
92  *
93  * There is an assumption that any flavour less than AUTH_NULL is
94  * invalid.
95  */
96 enum auth_stat
97 _authenticate(rqst, msg)
98 	struct svc_req *rqst;
99 	struct rpc_msg *msg;
100 {
101 	int cred_flavor;
102 	struct authsvc *asp;
103 	enum auth_stat dummy;
104 	extern mutex_t authsvc_lock;
105 
106 /* VARIABLES PROTECTED BY authsvc_lock: asp, Auths */
107 
108 	rqst->rq_cred = msg->rm_call.cb_cred;
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) {
113 	case AUTH_NULL:
114 		dummy = _svcauth_null(rqst, msg);
115 		return (dummy);
116 	case AUTH_SYS:
117 		dummy = _svcauth_unix(rqst, msg);
118 		return (dummy);
119 	case AUTH_SHORT:
120 		dummy = _svcauth_short(rqst, msg);
121 		return (dummy);
122 #ifdef DES_BUILTIN
123 	case AUTH_DES:
124 		dummy = _svcauth_des(rqst, msg);
125 		return (dummy);
126 #endif
127 	default:
128 		break;
129 	}
130 
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) {
135 			enum auth_stat as;
136 
137 			as = (*asp->handler)(rqst, msg);
138 			mutex_unlock(&authsvc_lock);
139 			return (as);
140 		}
141 	}
142 	mutex_unlock(&authsvc_lock);
143 
144 	return (AUTH_REJECTEDCRED);
145 }
146 
147 /*ARGSUSED*/
148 enum auth_stat
149 _svcauth_null(rqst, msg)
150 	struct svc_req *rqst;
151 	struct rpc_msg *msg;
152 {
153 	return (AUTH_OK);
154 }
155 
156 /*
157  *  Allow the rpc service to register new authentication types that it is
158  *  prepared to handle.  When an authentication flavor is registered,
159  *  the flavor is checked against already registered values.  If not
160  *  registered, then a new Auths entry is added on the list.
161  *
162  *  There is no provision to delete a registration once registered.
163  *
164  *  This routine returns:
165  *	 0 if registration successful
166  *	 1 if flavor already registered
167  *	-1 if can't register (errno set)
168  */
169 
170 int
171 svc_auth_reg(cred_flavor, handler)
172 	int cred_flavor;
173 	enum auth_stat (*handler)(struct svc_req *, struct rpc_msg *);
174 {
175 	struct authsvc *asp;
176 	extern mutex_t authsvc_lock;
177 
178 	switch (cred_flavor) {
179 	    case AUTH_NULL:
180 	    case AUTH_SYS:
181 	    case AUTH_SHORT:
182 #ifdef DES_BUILTIN
183 	    case AUTH_DES:
184 #endif
185 		/* already registered */
186 		return (1);
187 
188 	    default:
189 		mutex_lock(&authsvc_lock);
190 		for (asp = Auths; asp; asp = asp->next) {
191 			if (asp->flavor == cred_flavor) {
192 				/* already registered */
193 				mutex_unlock(&authsvc_lock);
194 				return (1);
195 			}
196 		}
197 
198 		/* this is a new one, so go ahead and register it */
199 		asp = mem_alloc(sizeof (*asp));
200 		if (asp == NULL) {
201 			mutex_unlock(&authsvc_lock);
202 			return (-1);
203 		}
204 		asp->flavor = cred_flavor;
205 		asp->handler = handler;
206 		asp->next = Auths;
207 		Auths = asp;
208 		mutex_unlock(&authsvc_lock);
209 		break;
210 	}
211 	return (0);
212 }
213