kssl.h 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  1. /* ssl/kssl.h */
  2. /*
  3. * Written by Vern Staats <staatsvr@asc.hpc.mil> for the OpenSSL project
  4. * 2000. project 2000.
  5. */
  6. /* ====================================================================
  7. * Copyright (c) 2000 The OpenSSL Project. All rights reserved.
  8. *
  9. * Redistribution and use in source and binary forms, with or without
  10. * modification, are permitted provided that the following conditions
  11. * are met:
  12. *
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions and the following disclaimer.
  15. *
  16. * 2. Redistributions in binary form must reproduce the above copyright
  17. * notice, this list of conditions and the following disclaimer in
  18. * the documentation and/or other materials provided with the
  19. * distribution.
  20. *
  21. * 3. All advertising materials mentioning features or use of this
  22. * software must display the following acknowledgment:
  23. * "This product includes software developed by the OpenSSL Project
  24. * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25. *
  26. * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27. * endorse or promote products derived from this software without
  28. * prior written permission. For written permission, please contact
  29. * licensing@OpenSSL.org.
  30. *
  31. * 5. Products derived from this software may not be called "OpenSSL"
  32. * nor may "OpenSSL" appear in their names without prior written
  33. * permission of the OpenSSL Project.
  34. *
  35. * 6. Redistributions of any form whatsoever must retain the following
  36. * acknowledgment:
  37. * "This product includes software developed by the OpenSSL Project
  38. * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39. *
  40. * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41. * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46. * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51. * OF THE POSSIBILITY OF SUCH DAMAGE.
  52. * ====================================================================
  53. *
  54. * This product includes cryptographic software written by Eric Young
  55. * (eay@cryptsoft.com). This product includes software written by Tim
  56. * Hudson (tjh@cryptsoft.com).
  57. *
  58. */
  59. /*
  60. ** 19990701 VRS Started.
  61. */
  62. #ifndef KSSL_H
  63. # define KSSL_H
  64. # include <openssl/opensslconf.h>
  65. # ifndef OPENSSL_NO_KRB5
  66. # include <stdio.h>
  67. # include <ctype.h>
  68. # include <krb5.h>
  69. # ifdef OPENSSL_SYS_WIN32
  70. /*
  71. * These can sometimes get redefined indirectly by krb5 header files after
  72. * they get undefed in ossl_typ.h
  73. */
  74. # undef X509_NAME
  75. # undef X509_EXTENSIONS
  76. # undef OCSP_REQUEST
  77. # undef OCSP_RESPONSE
  78. # endif
  79. #ifdef __cplusplus
  80. extern "C" {
  81. #endif
  82. /*
  83. * Depending on which KRB5 implementation used, some types from
  84. * the other may be missing. Resolve that here and now
  85. */
  86. # ifdef KRB5_HEIMDAL
  87. typedef unsigned char krb5_octet;
  88. # define FAR
  89. # else
  90. # ifndef FAR
  91. # define FAR
  92. # endif
  93. # endif
  94. /*-
  95. * Uncomment this to debug kssl problems or
  96. * to trace usage of the Kerberos session key
  97. *
  98. * #define KSSL_DEBUG
  99. */
  100. # ifndef KRB5SVC
  101. # define KRB5SVC "host"
  102. # endif
  103. # ifndef KRB5KEYTAB
  104. # define KRB5KEYTAB "/etc/krb5.keytab"
  105. # endif
  106. # ifndef KRB5SENDAUTH
  107. # define KRB5SENDAUTH 1
  108. # endif
  109. # ifndef KRB5CHECKAUTH
  110. # define KRB5CHECKAUTH 1
  111. # endif
  112. # ifndef KSSL_CLOCKSKEW
  113. # define KSSL_CLOCKSKEW 300;
  114. # endif
  115. # define KSSL_ERR_MAX 255
  116. typedef struct kssl_err_st {
  117. int reason;
  118. char text[KSSL_ERR_MAX + 1];
  119. } KSSL_ERR;
  120. /*- Context for passing
  121. * (1) Kerberos session key to SSL, and
  122. * (2) Config data between application and SSL lib
  123. */
  124. typedef struct kssl_ctx_st {
  125. /* used by: disposition: */
  126. char *service_name; /* C,S default ok (kssl) */
  127. char *service_host; /* C input, REQUIRED */
  128. char *client_princ; /* S output from krb5 ticket */
  129. char *keytab_file; /* S NULL (/etc/krb5.keytab) */
  130. char *cred_cache; /* C NULL (default) */
  131. krb5_enctype enctype;
  132. int length;
  133. krb5_octet FAR *key;
  134. } KSSL_CTX;
  135. # define KSSL_CLIENT 1
  136. # define KSSL_SERVER 2
  137. # define KSSL_SERVICE 3
  138. # define KSSL_KEYTAB 4
  139. # define KSSL_CTX_OK 0
  140. # define KSSL_CTX_ERR 1
  141. # define KSSL_NOMEM 2
  142. /* Public (for use by applications that use OpenSSL with Kerberos 5 support */
  143. krb5_error_code kssl_ctx_setstring(KSSL_CTX *kssl_ctx, int which, char *text);
  144. KSSL_CTX *kssl_ctx_new(void);
  145. KSSL_CTX *kssl_ctx_free(KSSL_CTX *kssl_ctx);
  146. void kssl_ctx_show(KSSL_CTX *kssl_ctx);
  147. krb5_error_code kssl_ctx_setprinc(KSSL_CTX *kssl_ctx, int which,
  148. krb5_data *realm, krb5_data *entity,
  149. int nentities);
  150. krb5_error_code kssl_cget_tkt(KSSL_CTX *kssl_ctx, krb5_data **enc_tktp,
  151. krb5_data *authenp, KSSL_ERR *kssl_err);
  152. krb5_error_code kssl_sget_tkt(KSSL_CTX *kssl_ctx, krb5_data *indata,
  153. krb5_ticket_times *ttimes, KSSL_ERR *kssl_err);
  154. krb5_error_code kssl_ctx_setkey(KSSL_CTX *kssl_ctx, krb5_keyblock *session);
  155. void kssl_err_set(KSSL_ERR *kssl_err, int reason, char *text);
  156. void kssl_krb5_free_data_contents(krb5_context context, krb5_data *data);
  157. krb5_error_code kssl_build_principal_2(krb5_context context,
  158. krb5_principal *princ, int rlen,
  159. const char *realm, int slen,
  160. const char *svc, int hlen,
  161. const char *host);
  162. krb5_error_code kssl_validate_times(krb5_timestamp atime,
  163. krb5_ticket_times *ttimes);
  164. krb5_error_code kssl_check_authent(KSSL_CTX *kssl_ctx, krb5_data *authentp,
  165. krb5_timestamp *atimep,
  166. KSSL_ERR *kssl_err);
  167. unsigned char *kssl_skip_confound(krb5_enctype enctype, unsigned char *authn);
  168. void SSL_set0_kssl_ctx(SSL *s, KSSL_CTX *kctx);
  169. KSSL_CTX *SSL_get0_kssl_ctx(SSL *s);
  170. char *kssl_ctx_get0_client_princ(KSSL_CTX *kctx);
  171. #ifdef __cplusplus
  172. }
  173. #endif
  174. # endif /* OPENSSL_NO_KRB5 */
  175. #endif /* KSSL_H */