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