xref: /freebsd/sys/rpc/svc_auth_unix.c (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2009, Sun Microsystems, Inc.
5  * All rights reserved.
6  *
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.
17  *
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.
29  */
30 
31 #if defined(LIBC_SCCS) && !defined(lint)
32 static char *sccsid2 = "@(#)svc_auth_unix.c 1.28 88/02/08 Copyr 1984 Sun Micro";
33 static char *sccsid = "@(#)svc_auth_unix.c	2.3 88/08/01 4.0 RPCSRC";
34 #endif
35 #include <sys/cdefs.h>
36 /*
37  * svc_auth_unix.c
38  * Handles UNIX flavor authentication parameters on the service side of rpc.
39  * There are two svc auth implementations here: AUTH_UNIX and AUTH_SHORT.
40  * _svcauth_unix does full blown unix style uid,gid+gids auth,
41  * _svcauth_short uses a shorthand auth to index into a cache of longhand auths.
42  * Note: the shorthand has been gutted for efficiency.
43  *
44  * Copyright (C) 1984, Sun Microsystems, Inc.
45  */
46 
47 #include <sys/param.h>
48 #include <sys/lock.h>
49 #include <sys/mutex.h>
50 #include <sys/systm.h>
51 #include <sys/ucred.h>
52 
53 #include <rpc/rpc.h>
54 
55 #include <rpc/rpc_com.h>
56 
57 #define MAX_MACHINE_NAME	255
58 #define NGRPS			16
59 
60 /*
61  * Unix longhand authenticator
62  */
63 enum auth_stat
64 _svcauth_unix(struct svc_req *rqst, struct rpc_msg *msg)
65 {
66 	enum auth_stat stat;
67 	XDR xdrs;
68 	int32_t *buf;
69 	uint32_t time;
70 	struct xucred *xcr;
71 	u_int auth_len;
72 	size_t str_len, gid_len;
73 	u_int i;
74 
75 	xcr = rqst->rq_clntcred;
76 	auth_len = (u_int)msg->rm_call.cb_cred.oa_length;
77 	xdrmem_create(&xdrs, msg->rm_call.cb_cred.oa_base, auth_len,
78 	    XDR_DECODE);
79 	buf = XDR_INLINE(&xdrs, auth_len);
80 	if (buf != NULL) {
81 		time = IXDR_GET_UINT32(buf);
82 		str_len = (size_t)IXDR_GET_UINT32(buf);
83 		if (str_len > MAX_MACHINE_NAME) {
84 			stat = AUTH_BADCRED;
85 			goto done;
86 		}
87 		str_len = RNDUP(str_len);
88 		buf += str_len / sizeof (int32_t);
89 		xcr->cr_uid = IXDR_GET_UINT32(buf);
90 		xcr->cr_groups[0] = IXDR_GET_UINT32(buf);
91 		gid_len = (size_t)IXDR_GET_UINT32(buf);
92 		if (gid_len > NGRPS) {
93 			stat = AUTH_BADCRED;
94 			goto done;
95 		}
96 		for (i = 0; i < gid_len; i++) {
97 			if (i + 1 < XU_NGROUPS)
98 				xcr->cr_groups[i + 1] = IXDR_GET_INT32(buf);
99 			else
100 				buf++;
101 		}
102 		if (gid_len + 1 > XU_NGROUPS)
103 			xcr->cr_ngroups = XU_NGROUPS;
104 		else
105 			xcr->cr_ngroups = gid_len + 1;
106 
107 		/*
108 		 * five is the smallest unix credentials structure -
109 		 * timestamp, hostname len (0), uid, gid, and gids len (0).
110 		 */
111 		if ((5 + gid_len) * BYTES_PER_XDR_UNIT + str_len > auth_len) {
112 			(void) printf("bad auth_len gid %ld str %ld auth %u\n",
113 			    (long)gid_len, (long)str_len, auth_len);
114 			stat = AUTH_BADCRED;
115 			goto done;
116 		}
117 	} else if (! xdr_authunix_parms(&xdrs, &time, xcr)) {
118 		stat = AUTH_BADCRED;
119 		goto done;
120 	}
121 
122 	rqst->rq_verf = _null_auth;
123 	stat = AUTH_OK;
124 done:
125 	XDR_DESTROY(&xdrs);
126 
127 	return (stat);
128 }
129 
130 
131 /*
132  * Shorthand unix authenticator
133  * Looks up longhand in a cache.
134  */
135 /*ARGSUSED*/
136 enum auth_stat
137 _svcauth_short(struct svc_req *rqst, struct rpc_msg *msg)
138 {
139 	return (AUTH_REJECTEDCRED);
140 }
141