Zero the premaster secret after deriving the master secret in DH
[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 #ifndef NO_KRB5
67
68 #include <stdio.h>
69 #include <ctype.h>
70 #include <krb5.h>
71
72 #ifdef  __cplusplus
73 extern "C" {
74 #endif
75
76 /*
77 **      Depending on which KRB5 implementation used, some types from
78 **      the other may be missing.  Resolve that here and now
79 */
80 #ifdef KRB5_HEIMDAL
81 typedef unsigned char krb5_octet;
82 #define FAR
83 #endif
84
85 /*      Uncomment this to debug kssl problems or
86 **      to trace usage of the Kerberos session key
87 **
88 **      #define         KSSL_DEBUG
89 */
90
91 #ifndef KRB5SVC
92 #define KRB5SVC "host"
93 #endif
94
95 #ifndef KRB5KEYTAB
96 #define KRB5KEYTAB      "/etc/krb5.keytab"
97 #endif
98
99
100 #define KSSL_ERR_MAX    255
101 typedef struct kssl_err_st  {
102         int  reason;
103         char text[KSSL_ERR_MAX+1];
104         } KSSL_ERR;
105
106
107 /*      Context for passing
108 **              (1) Kerberos session key to SSL, and
109 **              (2)     Config data between application and SSL lib
110 */
111 typedef struct kssl_ctx_st
112         {
113                                 /*      used by:    disposition:            */
114         char *service_name;     /*      C,S         default ok (kssl)       */
115         char *service_host;     /*      C           input, REQUIRED         */
116         char *client_princ;     /*      S           output from krb5 ticket */
117         char *keytab_file;      /*      S           NULL (/etc/krb5.keytab) */
118         char *cred_cache;       /*      C           NULL (default)          */
119         krb5_enctype enctype;
120         int length;
121         krb5_octet FAR *key;
122         } KSSL_CTX;
123
124 #define KSSL_CLIENT     1
125 #define KSSL_SERVER     2
126 #define KSSL_SERVICE    3
127 #define KSSL_KEYTAB     4
128
129 #define KSSL_CTX_OK     0
130 #define KSSL_CTX_ERR    1
131 #define KSSL_NOMEM      2
132
133
134 /* Private (internal to OpenSSL) */
135 void print_krb5_data(char *label, krb5_data *kdata);
136 void print_krb5_authdata(char *label, krb5_authdata **adata);
137 void print_krb5_keyblock(char *label, krb5_keyblock *keyblk);
138
139 char *kstring(char *string);
140 char *knumber(int len, krb5_octet *contents);
141
142
143 /* Public (for use by applications that use OpenSSL with Kerberos 5 support */
144 krb5_error_code kssl_ctx_setstring(KSSL_CTX *kssl_ctx, int which, char *text);
145 KSSL_CTX *kssl_ctx_new(void);
146 KSSL_CTX *kssl_ctx_free(KSSL_CTX *kssl_ctx);
147 void kssl_ctx_show(KSSL_CTX *kssl_ctx);
148 krb5_error_code kssl_ctx_setprinc(KSSL_CTX *kssl_ctx, int which,
149         krb5_data *realm, krb5_data *entity);
150 krb5_error_code kssl_cget_tkt(KSSL_CTX *kssl_ctx,  krb5_data *ap_req,
151         KSSL_ERR *kssl_err);
152 krb5_error_code kssl_sget_tkt(KSSL_CTX *kssl_ctx,  char *msg, int msglen,
153         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
158 #ifdef  __cplusplus
159 }
160 #endif
161 #endif  /* NO_KRB5      */
162 #endif  /* KSSL_H       */