kssl.h 5.8 KB

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