auth.h 6.6 KB

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