Home | History | Annotate | Line # | Download | only in rpc
svc_auth.c revision 1.10.6.1 
      1 /*	$NetBSD: svc_auth.c,v 1.10.6.1 2000/06/23 16:17:50 minoura 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 0
     38 #if !defined(lint) && defined(SCCSIDS)
     39 static char sccsid[] = "@(#)svc_auth.c 1.26 89/02/07 Copyr 1984 Sun Micro";
     40 #endif
     41 #endif
     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 
     54 #ifdef __weak_alias
     55 __weak_alias(svc_auth_reg,_svc_auth_reg)
     56 #endif
     57 
     58 /*
     59  * svcauthsw is the bdevsw of server side authentication.
     60  *
     61  * Server side authenticators are called from authenticate by
     62  * using the client auth struct flavor field to index into svcauthsw.
     63  * The server auth flavors must implement a routine that looks
     64  * like:
     65  *
     66  *	enum auth_stat
     67  *	flavorx_auth(rqst, msg)
     68  *		register struct svc_req *rqst;
     69  *		register struct rpc_msg *msg;
     70  *
     71  */
     72 
     73 /* declarations to allow servers to specify new authentication flavors */
     74 struct authsvc {
     75 	int	flavor;
     76 	enum	auth_stat (*handler) __P((struct svc_req *, struct rpc_msg *));
     77 	struct	authsvc	  *next;
     78 };
     79 static struct authsvc *Auths = NULL;
     80 
     81 /*
     82  * The call rpc message, msg has been obtained from the wire.  The msg contains
     83  * the raw form of credentials and verifiers.  authenticate returns AUTH_OK
     84  * if the msg is successfully authenticated.  If AUTH_OK then the routine also
     85  * does the following things:
     86  * set rqst->rq_xprt->verf to the appropriate response verifier;
     87  * sets rqst->rq_client_cred to the "cooked" form of the credentials.
     88  *
     89  * NB: rqst->rq_cxprt->verf must be pre-alloctaed;
     90  * its length is set appropriately.
     91  *
     92  * The caller still owns and is responsible for msg->u.cmb.cred and
     93  * msg->u.cmb.verf.  The authentication system retains ownership of
     94  * rqst->rq_client_cred, the cooked credentials.
     95  *
     96  * There is an assumption that any flavour less than AUTH_NULL is
     97  * invalid.
     98  */
     99 enum auth_stat
    100 _authenticate(rqst, msg)
    101 	register struct svc_req *rqst;
    102 	struct rpc_msg *msg;
    103 {
    104 	register int cred_flavor;
    105 	register struct authsvc *asp;
    106 	enum auth_stat dummy;
    107 #ifdef __REENT
    108 	extern mutex_t authsvc_lock;
    109 #endif
    110 
    111 /* VARIABLES PROTECTED BY authsvc_lock: asp, Auths */
    112 
    113 	rqst->rq_cred = msg->rm_call.cb_cred;
    114 	rqst->rq_xprt->xp_verf.oa_flavor = _null_auth.oa_flavor;
    115 	rqst->rq_xprt->xp_verf.oa_length = 0;
    116 	cred_flavor = rqst->rq_cred.oa_flavor;
    117 	switch (cred_flavor) {
    118 	case AUTH_NULL:
    119 		dummy = _svcauth_null(rqst, msg);
    120 		return (dummy);
    121 	case AUTH_SYS:
    122 		dummy = _svcauth_unix(rqst, msg);
    123 		return (dummy);
    124 	case AUTH_SHORT:
    125 		dummy = _svcauth_short(rqst, msg);
    126 		return (dummy);
    127 #if 0
    128 	case AUTH_DES:
    129 		dummy = __svcauth_des(rqst, msg);
    130 		return (dummy);
    131 #endif
    132 	default:
    133 		break;
    134 	}
    135 
    136 	/* flavor doesn't match any of the builtin types, so try new ones */
    137 	mutex_lock(&authsvc_lock);
    138 	for (asp = Auths; asp; asp = asp->next) {
    139 		if (asp->flavor == cred_flavor) {
    140 			enum auth_stat as;
    141 
    142 			as = (*asp->handler)(rqst, msg);
    143 			mutex_unlock(&authsvc_lock);
    144 			return (as);
    145 		}
    146 	}
    147 	mutex_unlock(&authsvc_lock);
    148 
    149 	return (AUTH_REJECTEDCRED);
    150 }
    151 
    152 /*ARGSUSED*/
    153 enum auth_stat
    154 _svcauth_null(rqst, msg)
    155 	struct svc_req *rqst;
    156 	struct rpc_msg *msg;
    157 {
    158 	return (AUTH_OK);
    159 }
    160 
    161 /*
    162  *  Allow the rpc service to register new authentication types that it is
    163  *  prepared to handle.  When an authentication flavor is registered,
    164  *  the flavor is checked against already registered values.  If not
    165  *  registered, then a new Auths entry is added on the list.
    166  *
    167  *  There is no provision to delete a registration once registered.
    168  *
    169  *  This routine returns:
    170  *	 0 if registration successful
    171  *	 1 if flavor already registered
    172  *	-1 if can't register (errno set)
    173  */
    174 
    175 int
    176 svc_auth_reg(cred_flavor, handler)
    177 	register int cred_flavor;
    178 	enum auth_stat (*handler) __P((struct svc_req *, struct rpc_msg *));
    179 {
    180 	register struct authsvc *asp;
    181 #ifdef __REENT
    182 	extern mutex_t authsvc_lock;
    183 #endif
    184 
    185 	switch (cred_flavor) {
    186 	    case AUTH_NULL:
    187 	    case AUTH_SYS:
    188 	    case AUTH_SHORT:
    189 #if 0
    190 	    case AUTH_DES:
    191 #endif
    192 		/* already registered */
    193 		return (1);
    194 
    195 	    default:
    196 		mutex_lock(&authsvc_lock);
    197 		for (asp = Auths; asp; asp = asp->next) {
    198 			if (asp->flavor == cred_flavor) {
    199 				/* already registered */
    200 				mutex_unlock(&authsvc_lock);
    201 				return (1);
    202 			}
    203 		}
    204 
    205 		/* this is a new one, so go ahead and register it */
    206 		asp = (struct authsvc *)mem_alloc(sizeof (*asp));
    207 		if (asp == NULL) {
    208 			mutex_unlock(&authsvc_lock);
    209 			return (-1);
    210 		}
    211 		asp->flavor = cred_flavor;
    212 		asp->handler = handler;
    213 		asp->next = Auths;
    214 		Auths = asp;
    215 		mutex_unlock(&authsvc_lock);
    216 		break;
    217 	}
    218 	return (0);
    219 }
    220