Blow away Makefile.ssl.
[openssl.git] / ssl / kssl.h
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 /*
60 **      19990701        VRS     Started.
61 */
62
63 #ifndef KSSL_H
64 #define KSSL_H
65
66 #include <openssl/opensslconf.h>
67
68 #ifndef OPENSSL_NO_KRB5
69
70 #include <stdio.h>
71 #include <ctype.h>
72 #include <krb5.h>
73
74 #ifdef  __cplusplus
75 extern "C" {
76 #endif
77
78 /*
79 **      Depending on which KRB5 implementation used, some types from
80 **      the other may be missing.  Resolve that here and now
81 */
82 #ifdef KRB5_HEIMDAL
83 typedef unsigned char krb5_octet;
84 #define FAR
85 #endif
86
87 /*      Uncomment this to debug kssl problems or
88 **      to trace usage of the Kerberos session key
89 **
90 **      #define         KSSL_DEBUG
91 */
92
93 #ifndef KRB5SVC
94 #define KRB5SVC "host"
95 #endif
96
97 #ifndef KRB5KEYTAB
98 #define KRB5KEYTAB      "/etc/krb5.keytab"
99 #endif
100
101 #ifndef KRB5SENDAUTH
102 #define KRB5SENDAUTH    1
103 #endif
104
105 #ifndef KRB5CHECKAUTH
106 #define KRB5CHECKAUTH   1
107 #endif
108
109 #ifndef KSSL_CLOCKSKEW
110 #define KSSL_CLOCKSKEW  300;
111 #endif
112
113 #define KSSL_ERR_MAX    255
114 typedef struct kssl_err_st  {
115         int  reason;
116         char text[KSSL_ERR_MAX+1];
117         } KSSL_ERR;
118
119
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         {
126                                 /*      used by:    disposition:            */
127         char *service_name;     /*      C,S         default ok (kssl)       */
128         char *service_host;     /*      C           input, REQUIRED         */
129         char *client_princ;     /*      S           output from krb5 ticket */
130         char *keytab_file;      /*      S           NULL (/etc/krb5.keytab) */
131         char *cred_cache;       /*      C           NULL (default)          */
132         krb5_enctype enctype;
133         int length;
134         krb5_octet FAR *key;
135         } KSSL_CTX;
136
137 #define KSSL_CLIENT     1
138 #define KSSL_SERVER     2
139 #define KSSL_SERVICE    3
140 #define KSSL_KEYTAB     4
141
142 #define KSSL_CTX_OK     0
143 #define KSSL_CTX_ERR    1
144 #define KSSL_NOMEM      2
145
146 /* Public (for use by applications that use OpenSSL with Kerberos 5 support */
147 krb5_error_code kssl_ctx_setstring(KSSL_CTX *kssl_ctx, int which, char *text);
148 KSSL_CTX *kssl_ctx_new(void);
149 KSSL_CTX *kssl_ctx_free(KSSL_CTX *kssl_ctx);
150 void kssl_ctx_show(KSSL_CTX *kssl_ctx);
151 krb5_error_code kssl_ctx_setprinc(KSSL_CTX *kssl_ctx, int which,
152         krb5_data *realm, krb5_data *entity, int nentities);
153 krb5_error_code kssl_cget_tkt(KSSL_CTX *kssl_ctx,  krb5_data **enc_tktp,
154         krb5_data *authenp, KSSL_ERR *kssl_err);
155 krb5_error_code kssl_sget_tkt(KSSL_CTX *kssl_ctx,  krb5_data *indata,
156         krb5_ticket_times *ttimes, KSSL_ERR *kssl_err);
157 krb5_error_code kssl_ctx_setkey(KSSL_CTX *kssl_ctx, krb5_keyblock *session);
158 void    kssl_err_set(KSSL_ERR *kssl_err, int reason, char *text);
159 void kssl_krb5_free_data_contents(krb5_context context, krb5_data *data);
160 krb5_error_code  kssl_build_principal_2(krb5_context context,
161                         krb5_principal *princ, int rlen, const char *realm,
162                         int slen, const char *svc, int hlen, const char *host);
163 krb5_error_code  kssl_validate_times(krb5_timestamp atime,
164                                         krb5_ticket_times *ttimes);
165 krb5_error_code  kssl_check_authent(KSSL_CTX *kssl_ctx, krb5_data *authentp,
166                                     krb5_timestamp *atimep, KSSL_ERR *kssl_err);
167 unsigned char   *kssl_skip_confound(krb5_enctype enctype, unsigned char *authn);
168
169 #ifdef  __cplusplus
170 }
171 #endif
172 #endif  /* OPENSSL_NO_KRB5      */
173 #endif  /* KSSL_H       */