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