home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / unix / volume26 / mnl-rpc++-2.3.1 / part01 / StdHdrs / rpc / auth.h next >
Encoding:
C/C++ Source or Header  |  1993-04-24  |  4.8 KB  |  172 lines
  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.  
  42. #ifndef _rpc_auth_h
  43. #define    _rpc_auth_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__)
  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. extern bool_t xdr_des_block();
  81.  
  82. /*
  83.  * Authentication info.  Opaque to client.
  84.  */
  85. struct opaque_auth {
  86.     enum_t    oa_flavor;        /* flavor of auth */
  87.     caddr_t    oa_base;        /* address of more auth stuff */
  88.     u_int    oa_length;        /* not to exceed MAX_AUTH_BYTES */
  89. };
  90.  
  91.  
  92. /*
  93.  * Auth handle, interface to client side authenticators.
  94.  */
  95. typedef struct {
  96.     struct    opaque_auth    ah_cred;
  97.     struct    opaque_auth    ah_verf;
  98.     union    des_block    ah_key;
  99.     struct auth_ops {
  100.         void    (*ah_nextverf)();
  101.         int    (*ah_marshal)();    /* nextverf & serialize */
  102.         int    (*ah_validate)();    /* validate varifier */
  103.         int    (*ah_refresh)();    /* refresh credentials */
  104.         void    (*ah_destroy)();    /* destroy this structure */
  105.     } *ah_ops;
  106.     caddr_t ah_private;
  107. } AUTH;
  108.  
  109.  
  110. /*
  111.  * Authentication ops.
  112.  * The ops and the auth handle provide the interface to the authenticators.
  113.  *
  114.  * AUTH    *auth;
  115.  * XDR    *xdrs;
  116.  * struct opaque_auth verf;
  117.  */
  118. #define AUTH_NEXTVERF(auth)        \
  119.         ((*((auth)->ah_ops->ah_nextverf))(auth))
  120. #define auth_nextverf(auth)        \
  121.         ((*((auth)->ah_ops->ah_nextverf))(auth))
  122.  
  123. #define AUTH_MARSHALL(auth, xdrs)    \
  124.         ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
  125. #define auth_marshall(auth, xdrs)    \
  126.         ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
  127.  
  128. #define AUTH_VALIDATE(auth, verfp)    \
  129.         ((*((auth)->ah_ops->ah_validate))((auth), verfp))
  130. #define auth_validate(auth, verfp)    \
  131.         ((*((auth)->ah_ops->ah_validate))((auth), verfp))
  132.  
  133. #define AUTH_REFRESH(auth)        \
  134.         ((*((auth)->ah_ops->ah_refresh))(auth))
  135. #define auth_refresh(auth)        \
  136.         ((*((auth)->ah_ops->ah_refresh))(auth))
  137.  
  138. #define AUTH_DESTROY(auth)        \
  139.         ((*((auth)->ah_ops->ah_destroy))(auth))
  140. #define auth_destroy(auth)        \
  141.         ((*((auth)->ah_ops->ah_destroy))(auth))
  142.  
  143.  
  144. extern struct opaque_auth _null_auth;
  145.  
  146.  
  147. /*
  148.  * These are the various implementations of client side authenticators.
  149.  */
  150.  
  151. /*
  152.  * Unix style authentication
  153.  * AUTH *authunix_create(machname, uid, gid, len, aup_gids)
  154.  *    char *machname;
  155.  *    int uid;
  156.  *    int gid;
  157.  *    int len;
  158.  *    int *aup_gids;
  159.  */
  160. extern AUTH *authunix_create();
  161. extern AUTH *authunix_create_default();    /* takes no parameters */
  162. extern AUTH *authnone_create();        /* takes no parameters */
  163. extern AUTH *authdes_create();
  164.  
  165. #define AUTH_NONE    0        /* no authentication */
  166. #define    AUTH_NULL    0        /* backward compatibility */
  167. #define    AUTH_UNIX    1        /* unix style (uid, gids) */
  168. #define    AUTH_SHORT    2        /* short hand unix style */
  169. #define    AUTH_DES    3        /* des style (encrypted timestamps) */
  170.  
  171. #endif /*!_rpc_auth_h*/
  172.