[unix-history] / lib / librpc / rpc / auth.h

/*
 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
 * unrestricted use provided that this legend is included on all tape
 * media and as a part of the software program in whole or part.  Users
 * may copy or modify Sun RPC without charge, but are not authorized
 * to license or distribute it to anyone else except as part of a product or
 * program developed by the user.
 * 
 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
 * 
 * Sun RPC is provided with no support and without any obligation on the
 * part of Sun Microsystems, Inc. to assist in its use, correction,
 * modification or enhancement.
 * 
 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
 * OR ANY PART THEREOF.
 * 
 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
 * or profits or other special, indirect and consequential damages, even if
 * Sun has been advised of the possibility of such damages.
 * 
 * Sun Microsystems, Inc.
 * 2550 Garcia Avenue
 * Mountain View, California  94043
 *
 *	from: @(#)auth.h 1.17 88/02/08 SMI
 *	from: @(#)auth.h	2.3 88/08/07 4.0 RPCSRC
 *	$Id: auth.h,v 1.3 1993/08/01 18:46:00 mycroft Exp $
 */

/*
 * auth.h, Authentication interface.
 *
 * Copyright (C) 1984, Sun Microsystems, Inc.
 *
 * The data structures are completely opaque to the client.  The client
 * is required to pass a AUTH * to routines that create rpc
 * "sessions".
 */

#ifndef _RPC_AUTH_H
#define _RPC_AUTH_H
#include <sys/cdefs.h>

#define MAX_AUTH_BYTES	400
#define MAXNETNAMELEN	255	/* maximum length of network user's name */

/*
 * Status returned from authentication check
 */
enum auth_stat {
	AUTH_OK=0,
	/*
	 * failed at remote end
	 */
	AUTH_BADCRED=1,			/* bogus credentials (seal broken) */
	AUTH_REJECTEDCRED=2,		/* client should begin new session */
	AUTH_BADVERF=3,			/* bogus verifier (seal broken) */
	AUTH_REJECTEDVERF=4,		/* verifier expired or was replayed */
	AUTH_TOOWEAK=5,			/* rejected due to security reasons */
	/*
	 * failed locally
	*/
	AUTH_INVALIDRESP=6,		/* bogus response verifier */
	AUTH_FAILED=7			/* some unknown reason */
};

#if (mc68000 || sparc || vax || i386 || tahoe || hp300)
typedef u_long u_int32;	/* 32-bit unsigned integers */
#endif

union des_block {
	struct {
		u_int32 high;
		u_int32 low;
	} key;
	char c[8];
};
typedef union des_block des_block;
__BEGIN_DECLS
extern bool_t xdr_des_block __P((XDR *, des_block *));
__END_DECLS

/*
 * Authentication info.  Opaque to client.
 */
struct opaque_auth {
	enum_t	oa_flavor;		/* flavor of auth */
	caddr_t	oa_base;		/* address of more auth stuff */
	u_int	oa_length;		/* not to exceed MAX_AUTH_BYTES */
};


/*
 * Auth handle, interface to client side authenticators.
 */
typedef struct {
	struct	opaque_auth	ah_cred;
	struct	opaque_auth	ah_verf;
	union	des_block	ah_key;
	struct auth_ops {
		void	(*ah_nextverf)();
		int	(*ah_marshal)();	/* nextverf & serialize */
		int	(*ah_validate)();	/* validate varifier */
		int	(*ah_refresh)();	/* refresh credentials */
		void	(*ah_destroy)();	/* destroy this structure */
	} *ah_ops;
	caddr_t ah_private;
} AUTH;


/*
 * Authentication ops.
 * The ops and the auth handle provide the interface to the authenticators.
 *
 * AUTH	*auth;
 * XDR	*xdrs;
 * struct opaque_auth verf;
 */
#define AUTH_NEXTVERF(auth)		\
		((*((auth)->ah_ops->ah_nextverf))(auth))
#define auth_nextverf(auth)		\
		((*((auth)->ah_ops->ah_nextverf))(auth))

#define AUTH_MARSHALL(auth, xdrs)	\
		((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
#define auth_marshall(auth, xdrs)	\
		((*((auth)->ah_ops->ah_marshal))(auth, xdrs))

#define AUTH_VALIDATE(auth, verfp)	\
		((*((auth)->ah_ops->ah_validate))((auth), verfp))
#define auth_validate(auth, verfp)	\
		((*((auth)->ah_ops->ah_validate))((auth), verfp))

#define AUTH_REFRESH(auth)		\
		((*((auth)->ah_ops->ah_refresh))(auth))
#define auth_refresh(auth)		\
		((*((auth)->ah_ops->ah_refresh))(auth))

#define AUTH_DESTROY(auth)		\
		((*((auth)->ah_ops->ah_destroy))(auth))
#define auth_destroy(auth)		\
		((*((auth)->ah_ops->ah_destroy))(auth))


extern struct opaque_auth _null_auth;


/*
 * These are the various implementations of client side authenticators.
 */

/*
 * Unix style authentication
 * AUTH *authunix_create(machname, uid, gid, len, aup_gids)
 *	char *machname;
 *	int uid;
 *	int gid;
 *	int len;
 *	int *aup_gids;
 */
__BEGIN_DECLS
extern AUTH *authunix_create		__P((char *, int, int, int, int *));
extern AUTH *authunix_create_default	__P((void));
extern AUTH *authnone_create		__P((void));
extern AUTH *authdes_create();
__END_DECLS

#define AUTH_NONE	0		/* no authentication */
#define	AUTH_NULL	0		/* backward compatibility */
#define	AUTH_UNIX	1		/* unix style (uid, gids) */
#define	AUTH_SHORT	2		/* short hand unix style */
#define AUTH_DES	3		/* des style (encrypted timestamps) */

#endif /* !_RPC_AUTH_H */
Commit	Line	Data
15637ed4 RG	1	/*
	2	* Sun RPC is a product of Sun Microsystems, Inc. and is provided for
	3	* unrestricted use provided that this legend is included on all tape
	4	* media and as a part of the software program in whole or part. Users
	5	* may copy or modify Sun RPC without charge, but are not authorized
	6	* to license or distribute it to anyone else except as part of a product or
	7	* program developed by the user.
	8	*
	9	* SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
	10	* WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
	11	* PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
	12	*
	13	* Sun RPC is provided with no support and without any obligation on the
	14	* part of Sun Microsystems, Inc. to assist in its use, correction,
	15	* modification or enhancement.
	16	*
	17	* SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
	18	* INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
	19	* OR ANY PART THEREOF.
	20	*
	21	* In no event will Sun Microsystems, Inc. be liable for any lost revenue
	22	* or profits or other special, indirect and consequential damages, even if
	23	* Sun has been advised of the possibility of such damages.
	24	*
	25	* Sun Microsystems, Inc.
	26	* 2550 Garcia Avenue
	27	* Mountain View, California 94043
78ed81a3	28	*
	29	* from: @(#)auth.h 1.17 88/02/08 SMI
	30	* from: @(#)auth.h 2.3 88/08/07 4.0 RPCSRC
	31	* $Id: auth.h,v 1.3 1993/08/01 18:46:00 mycroft Exp $
15637ed4 RG	32	*/
	33
	34	/*
	35	* auth.h, Authentication interface.
	36	*
	37	* Copyright (C) 1984, Sun Microsystems, Inc.
	38	*
	39	* The data structures are completely opaque to the client. The client
	40	* is required to pass a AUTH * to routines that create rpc
	41	* "sessions".
	42	*/
	43
78ed81a3	44	#ifndef _RPC_AUTH_H
	45	#define _RPC_AUTH_H
	46	#include <sys/cdefs.h>
15637ed4 RG	47
	48	#define MAX_AUTH_BYTES 400
	49	#define MAXNETNAMELEN 255 /* maximum length of network user's name */
	50
	51	/*
	52	* Status returned from authentication check
	53	*/
	54	enum auth_stat {
	55	AUTH_OK=0,
	56	/*
	57	* failed at remote end
	58	*/
	59	AUTH_BADCRED=1, /* bogus credentials (seal broken) */
	60	AUTH_REJECTEDCRED=2, /* client should begin new session */
	61	AUTH_BADVERF=3, /* bogus verifier (seal broken) */
	62	AUTH_REJECTEDVERF=4, /* verifier expired or was replayed */
	63	AUTH_TOOWEAK=5, /* rejected due to security reasons */
	64	/*
	65	* failed locally
	66	*/
	67	AUTH_INVALIDRESP=6, /* bogus response verifier */
	68	AUTH_FAILED=7 /* some unknown reason */
	69	};
	70
	71	#if (mc68000 \|\| sparc \|\| vax \|\| i386 \|\| tahoe \|\| hp300)
	72	typedef u_long u_int32; /* 32-bit unsigned integers */
	73	#endif
	74
	75	union des_block {
	76	struct {
	77	u_int32 high;
	78	u_int32 low;
	79	} key;
	80	char c[8];
	81	};
	82	typedef union des_block des_block;
78ed81a3	83	__BEGIN_DECLS
	84	extern bool_t xdr_des_block __P((XDR , des_block ));
	85	__END_DECLS
15637ed4 RG	86
	87	/*
	88	* Authentication info. Opaque to client.
	89	*/
	90	struct opaque_auth {
	91	enum_t oa_flavor; /* flavor of auth */
	92	caddr_t oa_base; /* address of more auth stuff */
	93	u_int oa_length; /* not to exceed MAX_AUTH_BYTES */
	94	};
	95
	96
	97	/*
	98	* Auth handle, interface to client side authenticators.
	99	*/
	100	typedef struct {
	101	struct opaque_auth ah_cred;
	102	struct opaque_auth ah_verf;
	103	union des_block ah_key;
	104	struct auth_ops {
	105	void (*ah_nextverf)();
	106	int (ah_marshal)(); / nextverf & serialize */
	107	int (ah_validate)(); / validate varifier */
	108	int (ah_refresh)(); / refresh credentials */
	109	void (ah_destroy)(); / destroy this structure */
	110	} *ah_ops;
	111	caddr_t ah_private;
	112	} AUTH;
	113
	114
	115	/*
	116	* Authentication ops.
	117	* The ops and the auth handle provide the interface to the authenticators.
	118	*
	119	* AUTH *auth;
	120	* XDR *xdrs;
	121	* struct opaque_auth verf;
	122	*/
	123	#define AUTH_NEXTVERF(auth) \
	124	((*((auth)->ah_ops->ah_nextverf))(auth))
	125	#define auth_nextverf(auth) \
	126	((*((auth)->ah_ops->ah_nextverf))(auth))
	127
	128	#define AUTH_MARSHALL(auth, xdrs) \
	129	((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
	130	#define auth_marshall(auth, xdrs) \
	131	((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
	132
	133	#define AUTH_VALIDATE(auth, verfp) \
	134	((*((auth)->ah_ops->ah_validate))((auth), verfp))
	135	#define auth_validate(auth, verfp) \
	136	((*((auth)->ah_ops->ah_validate))((auth), verfp))
	137
	138	#define AUTH_REFRESH(auth) \
	139	((*((auth)->ah_ops->ah_refresh))(auth))
	140	#define auth_refresh(auth) \
	141	((*((auth)->ah_ops->ah_refresh))(auth))
	142
	143	#define AUTH_DESTROY(auth) \
	144	((*((auth)->ah_ops->ah_destroy))(auth))
	145	#define auth_destroy(auth) \
	146	((*((auth)->ah_ops->ah_destroy))(auth))
	147
	148
	149	extern struct opaque_auth _null_auth;
150
151
152	/*
153	* These are the various implementations of client side authenticators.
154	*/
155
156	/*
157	* Unix style authentication
158	* AUTH *authunix_create(machname, uid, gid, len, aup_gids)
159	* char *machname;
160	* int uid;
161	* int gid;
162	* int len;
163	* int *aup_gids;
164	*/
78ed81a3	165	__BEGIN_DECLS
	166	extern AUTH authunix_create __P((char , int, int, int, int *));
	167	extern AUTH *authunix_create_default __P((void));
	168	extern AUTH *authnone_create __P((void));
15637ed4	169	extern AUTH *authdes_create();
78ed81a3	170	__END_DECLS
15637ed4 RG	171
	172	#define AUTH_NONE 0 /* no authentication */
	173	#define AUTH_NULL 0 /* backward compatibility */
	174	#define AUTH_UNIX 1 /* unix style (uid, gids) */
	175	#define AUTH_SHORT 2 /* short hand unix style */
	176	#define AUTH_DES 3 /* des style (encrypted timestamps) */
78ed81a3	177
78ed81a3	178	#endif /* !_RPC_AUTH_H */