xref: /freebsd/sys/rpc/svc_auth.c (revision b0d29bc47dba79f6f38e67eabadfb4b32ffd9390)
1 /*	$NetBSD: svc_auth.c,v 1.12 2000/07/06 03:10:35 christos Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  * Copyright (c) 2009, Sun Microsystems, Inc.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions are met:
11  * - Redistributions of source code must retain the above copyright notice,
12  *   this list of conditions and the following disclaimer.
13  * - Redistributions in binary form must reproduce the above copyright notice,
14  *   this list of conditions and the following disclaimer in the documentation
15  *   and/or other materials provided with the distribution.
16  * - Neither the name of Sun Microsystems, Inc. nor the names of its
17  *   contributors may be used to endorse or promote products derived
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 /*
33  * Copyright (c) 1986-1991 by Sun Microsystems Inc.
34  */
35 
36 #if defined(LIBC_SCCS) && !defined(lint)
37 #ident	"@(#)svc_auth.c	1.16	94/04/24 SMI"
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 <sys/param.h>
49 #include <sys/lock.h>
50 #include <sys/mutex.h>
51 #include <sys/systm.h>
52 #include <sys/jail.h>
53 #include <sys/ucred.h>
54 
55 #include <rpc/rpc.h>
56 
57 static enum auth_stat (*_svcauth_rpcsec_gss)(struct svc_req *,
58     struct rpc_msg *) = NULL;
59 static int (*_svcauth_rpcsec_gss_getcred)(struct svc_req *,
60     struct ucred **, int *);
61 
62 static struct svc_auth_ops svc_auth_null_ops;
63 
64 /*
65  * The call rpc message, msg has been obtained from the wire.  The msg contains
66  * the raw form of credentials and verifiers.  authenticate returns AUTH_OK
67  * if the msg is successfully authenticated.  If AUTH_OK then the routine also
68  * does the following things:
69  * set rqst->rq_xprt->verf to the appropriate response verifier;
70  * sets rqst->rq_client_cred to the "cooked" form of the credentials.
71  *
72  * NB: rqst->rq_cxprt->verf must be pre-alloctaed;
73  * its length is set appropriately.
74  *
75  * The caller still owns and is responsible for msg->u.cmb.cred and
76  * msg->u.cmb.verf.  The authentication system retains ownership of
77  * rqst->rq_client_cred, the cooked credentials.
78  *
79  * There is an assumption that any flavour less than AUTH_NULL is
80  * invalid.
81  */
82 enum auth_stat
83 _authenticate(struct svc_req *rqst, struct rpc_msg *msg)
84 {
85 	int cred_flavor;
86 	enum auth_stat dummy;
87 
88 	rqst->rq_cred = msg->rm_call.cb_cred;
89 	rqst->rq_auth.svc_ah_ops = &svc_auth_null_ops;
90 	rqst->rq_auth.svc_ah_private = NULL;
91 	cred_flavor = rqst->rq_cred.oa_flavor;
92 	switch (cred_flavor) {
93 	case AUTH_NULL:
94 		dummy = _svcauth_null(rqst, msg);
95 		return (dummy);
96 	case AUTH_SYS:
97 		dummy = _svcauth_unix(rqst, msg);
98 		return (dummy);
99 	case AUTH_SHORT:
100 		dummy = _svcauth_short(rqst, msg);
101 		return (dummy);
102 	case RPCSEC_GSS:
103 		if (!_svcauth_rpcsec_gss)
104 			return (AUTH_REJECTEDCRED);
105 		dummy = _svcauth_rpcsec_gss(rqst, msg);
106 		return (dummy);
107 	default:
108 		break;
109 	}
110 
111 	return (AUTH_REJECTEDCRED);
112 }
113 
114 /*
115  * A set of null auth methods used by any authentication protocols
116  * that don't need to inspect or modify the message body.
117  */
118 static bool_t
119 svcauth_null_wrap(SVCAUTH *auth, struct mbuf **mp)
120 {
121 
122 	return (TRUE);
123 }
124 
125 static bool_t
126 svcauth_null_unwrap(SVCAUTH *auth, struct mbuf **mp)
127 {
128 
129 	return (TRUE);
130 }
131 
132 static void
133 svcauth_null_release(SVCAUTH *auth)
134 {
135 
136 }
137 
138 static struct svc_auth_ops svc_auth_null_ops = {
139 	svcauth_null_wrap,
140 	svcauth_null_unwrap,
141 	svcauth_null_release,
142 };
143 
144 /*ARGSUSED*/
145 enum auth_stat
146 _svcauth_null(struct svc_req *rqst, struct rpc_msg *msg)
147 {
148 
149 	rqst->rq_verf = _null_auth;
150 	return (AUTH_OK);
151 }
152 
153 int
154 svc_auth_reg(int flavor,
155     enum auth_stat (*svcauth)(struct svc_req *, struct rpc_msg *),
156     int (*getcred)(struct svc_req *, struct ucred **, int *))
157 {
158 
159 	if (flavor == RPCSEC_GSS) {
160 		_svcauth_rpcsec_gss = svcauth;
161 		_svcauth_rpcsec_gss_getcred = getcred;
162 	}
163 	return (TRUE);
164 }
165 
166 int
167 svc_getcred(struct svc_req *rqst, struct ucred **crp, int *flavorp)
168 {
169 	struct ucred *cr = NULL;
170 	int flavor;
171 	struct xucred *xcr;
172 
173 	flavor = rqst->rq_cred.oa_flavor;
174 	if (flavorp)
175 		*flavorp = flavor;
176 
177 	switch (flavor) {
178 	case AUTH_UNIX:
179 		xcr = (struct xucred *) rqst->rq_clntcred;
180 		cr = crget();
181 		cr->cr_uid = cr->cr_ruid = cr->cr_svuid = xcr->cr_uid;
182 		crsetgroups(cr, xcr->cr_ngroups, xcr->cr_groups);
183 		cr->cr_rgid = cr->cr_svgid = cr->cr_groups[0];
184 		cr->cr_prison = &prison0;
185 		prison_hold(cr->cr_prison);
186 		*crp = cr;
187 		return (TRUE);
188 
189 	case RPCSEC_GSS:
190 		if (!_svcauth_rpcsec_gss_getcred)
191 			return (FALSE);
192 		return (_svcauth_rpcsec_gss_getcred(rqst, crp, flavorp));
193 
194 	default:
195 		return (FALSE);
196 	}
197 }
198 
199