auth.h 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  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. * auth.h, Authentication interface.
  32. *
  33. * Copyright (C) 1984, Sun Microsystems, Inc.
  34. *
  35. * The data structures are completely opaque to the client. The client
  36. * is required to pass a AUTH * to routines that create rpc
  37. * "sessions".
  38. */
  39. #ifndef _RPC_AUTH_H
  40. #define _RPC_AUTH_H 1
  41. #include <features.h>
  42. #include <rpc/xdr.h>
  43. __BEGIN_DECLS
  44. #define MAX_AUTH_BYTES 400
  45. #define MAXNETNAMELEN 255 /* maximum length of network user's name */
  46. /*
  47. * Status returned from authentication check
  48. */
  49. enum auth_stat {
  50. AUTH_OK=0,
  51. /*
  52. * failed at remote end
  53. */
  54. AUTH_BADCRED=1, /* bogus credentials (seal broken) */
  55. AUTH_REJECTEDCRED=2, /* client should begin new session */
  56. AUTH_BADVERF=3, /* bogus verifier (seal broken) */
  57. AUTH_REJECTEDVERF=4, /* verifier expired or was replayed */
  58. AUTH_TOOWEAK=5, /* rejected due to security reasons */
  59. /*
  60. * failed locally
  61. */
  62. AUTH_INVALIDRESP=6, /* bogus response verifier */
  63. AUTH_FAILED=7 /* some unknown reason */
  64. };
  65. union des_block {
  66. struct {
  67. u_int32_t high;
  68. u_int32_t low;
  69. } key;
  70. char c[8];
  71. };
  72. typedef union des_block des_block;
  73. extern bool_t xdr_des_block (XDR *__xdrs, des_block *__blkp) __THROW;
  74. /*
  75. * Authentication info. Opaque to client.
  76. */
  77. struct opaque_auth {
  78. enum_t oa_flavor; /* flavor of auth */
  79. caddr_t oa_base; /* address of more auth stuff */
  80. u_int oa_length; /* not to exceed MAX_AUTH_BYTES */
  81. };
  82. /*
  83. * Auth handle, interface to client side authenticators.
  84. */
  85. typedef struct AUTH AUTH;
  86. struct AUTH {
  87. struct opaque_auth ah_cred;
  88. struct opaque_auth ah_verf;
  89. union des_block ah_key;
  90. /* not sure whether non-const-ness is a part of the spec... if it is,
  91. * enclose "const" in #ifdef _LIBC / #endif
  92. * to make it effective only for libc compile */
  93. const
  94. struct auth_ops {
  95. void (*ah_nextverf) (AUTH *);
  96. int (*ah_marshal) (AUTH *, XDR *); /* nextverf & serialize */
  97. int (*ah_validate) (AUTH *, struct opaque_auth *);
  98. /* validate verifier */
  99. int (*ah_refresh) (AUTH *); /* refresh credentials */
  100. void (*ah_destroy) (AUTH *); /* destroy this structure */
  101. } *ah_ops;
  102. caddr_t ah_private;
  103. };
  104. /*
  105. * Authentication ops.
  106. * The ops and the auth handle provide the interface to the authenticators.
  107. *
  108. * AUTH *auth;
  109. * XDR *xdrs;
  110. * struct opaque_auth verf;
  111. */
  112. #define AUTH_NEXTVERF(auth) \
  113. ((*((auth)->ah_ops->ah_nextverf))(auth))
  114. #define auth_nextverf(auth) \
  115. ((*((auth)->ah_ops->ah_nextverf))(auth))
  116. #define AUTH_MARSHALL(auth, xdrs) \
  117. ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
  118. #define auth_marshall(auth, xdrs) \
  119. ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
  120. #define AUTH_VALIDATE(auth, verfp) \
  121. ((*((auth)->ah_ops->ah_validate))((auth), verfp))
  122. #define auth_validate(auth, verfp) \
  123. ((*((auth)->ah_ops->ah_validate))((auth), verfp))
  124. #define AUTH_REFRESH(auth) \
  125. ((*((auth)->ah_ops->ah_refresh))(auth))
  126. #define auth_refresh(auth) \
  127. ((*((auth)->ah_ops->ah_refresh))(auth))
  128. #define AUTH_DESTROY(auth) \
  129. ((*((auth)->ah_ops->ah_destroy))(auth))
  130. #define auth_destroy(auth) \
  131. ((*((auth)->ah_ops->ah_destroy))(auth))
  132. extern struct opaque_auth _null_auth;
  133. /*
  134. * These are the various implementations of client side authenticators.
  135. */
  136. /*
  137. * Unix style authentication
  138. * AUTH *authunix_create(machname, uid, gid, len, aup_gids)
  139. * char *machname;
  140. * int uid;
  141. * int gid;
  142. * int len;
  143. * int *aup_gids;
  144. */
  145. extern AUTH *authunix_create (char *__machname, __uid_t __uid, __gid_t __gid,
  146. int __len, __gid_t *__aup_gids);
  147. libc_hidden_proto(authunix_create)
  148. extern AUTH *authunix_create_default (void);
  149. libc_hidden_proto(authunix_create_default)
  150. extern AUTH *authnone_create (void) __THROW;
  151. libc_hidden_proto(authnone_create)
  152. #if 0
  153. extern AUTH *authdes_create (const char *__servername, u_int __window,
  154. struct sockaddr *__syncaddr, des_block *__ckey)
  155. __THROW;
  156. extern AUTH *authdes_pk_create (const char *, netobj *, u_int,
  157. struct sockaddr *, des_block *) __THROW;
  158. #endif
  159. #define AUTH_NONE 0 /* no authentication */
  160. #define AUTH_NULL 0 /* backward compatibility */
  161. #define AUTH_SYS 1 /* unix style (uid, gids) */
  162. #define AUTH_UNIX AUTH_SYS
  163. #define AUTH_SHORT 2 /* short hand unix style */
  164. #define AUTH_DES 3 /* des style (encrypted timestamps) */
  165. #define AUTH_DH AUTH_DES /* Diffie-Hellman (this is DES) */
  166. #define AUTH_KERB 4 /* kerberos style */
  167. #if 0
  168. /*
  169. * Netname manipulating functions
  170. *
  171. */
  172. extern int getnetname (char *) __THROW;
  173. extern int host2netname (char *, __const char *, __const char *) __THROW;
  174. extern int user2netname (char *, __const uid_t, __const char *) __THROW;
  175. extern int netname2user (__const char *, uid_t *, gid_t *, int *, gid_t *)
  176. __THROW;
  177. extern int netname2host (__const char *, char *, __const int) __THROW;
  178. /*
  179. *
  180. * These routines interface to the keyserv daemon
  181. *
  182. */
  183. extern int key_decryptsession (char *, des_block *);
  184. extern int key_decryptsession_pk (char *, netobj *, des_block *);
  185. extern int key_encryptsession (char *, des_block *);
  186. extern int key_encryptsession_pk (char *, netobj *, des_block *);
  187. extern int key_gendes (des_block *);
  188. extern int key_setsecret (char *);
  189. extern int key_secretkey_is_set (void);
  190. extern int key_get_conv (char *, des_block *);
  191. #endif
  192. /*
  193. * XDR an opaque authentication struct.
  194. */
  195. extern bool_t xdr_opaque_auth (XDR *, struct opaque_auth *) __THROW;
  196. libc_hidden_proto(xdr_opaque_auth)
  197. __END_DECLS
  198. #endif /* rpc/auth.h */