kssl.h revision 392aa7cc7d2b122614c5393c3e357da07fd07af3
1478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project/* ssl/kssl.h -*- mode: C; c-file-style: "eay" -*- */ 2478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project/* Written by Vern Staats <staatsvr@asc.hpc.mil> for the OpenSSL project 2000. 3478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * project 2000. 4478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project */ 5478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project/* ==================================================================== 6478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * Copyright (c) 2000 The OpenSSL Project. All rights reserved. 7478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 8478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * Redistribution and use in source and binary forms, with or without 9478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * modification, are permitted provided that the following conditions 10478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * are met: 11478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 12478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 1. Redistributions of source code must retain the above copyright 13478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * notice, this list of conditions and the following disclaimer. 14478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 15478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 2. Redistributions in binary form must reproduce the above copyright 16478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * notice, this list of conditions and the following disclaimer in 17478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * the documentation and/or other materials provided with the 18478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * distribution. 19478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 20478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 3. All advertising materials mentioning features or use of this 21478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * software must display the following acknowledgment: 22478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * "This product includes software developed by the OpenSSL Project 23478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" 24478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 25478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 26478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * endorse or promote products derived from this software without 27478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * prior written permission. For written permission, please contact 28478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * licensing@OpenSSL.org. 29478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 30478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 5. Products derived from this software may not be called "OpenSSL" 31478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * nor may "OpenSSL" appear in their names without prior written 32478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * permission of the OpenSSL Project. 33478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 34478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 6. Redistributions of any form whatsoever must retain the following 35478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * acknowledgment: 36478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * "This product includes software developed by the OpenSSL Project 37478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" 38478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 39478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 40478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 41478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 42478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 43478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 44478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 45478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 46478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 47478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 48478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 49478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 50478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * OF THE POSSIBILITY OF SUCH DAMAGE. 51478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * ==================================================================== 52478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 53478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * This product includes cryptographic software written by Eric Young 54478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * (eay@cryptsoft.com). This product includes software written by Tim 55478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * Hudson (tjh@cryptsoft.com). 56478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project * 57478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project */ 58478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 59478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project/* 60478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project** 19990701 VRS Started. 61478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project*/ 62478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 63478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#ifndef KSSL_H 64478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KSSL_H 65478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 66478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#include <openssl/opensslconf.h> 67478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 68478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#ifndef OPENSSL_NO_KRB5 69478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 70478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#include <stdio.h> 71478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#include <ctype.h> 72478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#include <krb5.h> 73478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 74478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#ifdef __cplusplus 75478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectextern "C" { 76478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#endif 77478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 78478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project/* 79478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project** Depending on which KRB5 implementation used, some types from 80478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project** the other may be missing. Resolve that here and now 81478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project*/ 82478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#ifdef KRB5_HEIMDAL 83478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projecttypedef unsigned char krb5_octet; 84478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define FAR 85478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#else 86478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 87478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#ifndef FAR 88478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define FAR 89478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#endif 90478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 91478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#endif 92478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 93478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project/* Uncomment this to debug kssl problems or 94478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project** to trace usage of the Kerberos session key 95478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project** 96478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project** #define KSSL_DEBUG 97478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project*/ 98478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 99478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#ifndef KRB5SVC 100478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KRB5SVC "host" 101478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#endif 102478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 103478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#ifndef KRB5KEYTAB 104478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KRB5KEYTAB "/etc/krb5.keytab" 105478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#endif 106478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 107478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#ifndef KRB5SENDAUTH 108478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KRB5SENDAUTH 1 109478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#endif 110478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 111478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#ifndef KRB5CHECKAUTH 112478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KRB5CHECKAUTH 1 113478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#endif 114478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 115478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#ifndef KSSL_CLOCKSKEW 116478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KSSL_CLOCKSKEW 300; 117478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#endif 118478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 119478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KSSL_ERR_MAX 255 120478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projecttypedef struct kssl_err_st { 121478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project int reason; 122478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project char text[KSSL_ERR_MAX+1]; 123478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project } KSSL_ERR; 124478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 125478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 126478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project/* Context for passing 127478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project** (1) Kerberos session key to SSL, and 128478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project** (2) Config data between application and SSL lib 129478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project*/ 130478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projecttypedef struct kssl_ctx_st 131478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project { 132478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project /* used by: disposition: */ 133478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project char *service_name; /* C,S default ok (kssl) */ 134478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project char *service_host; /* C input, REQUIRED */ 135478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project char *client_princ; /* S output from krb5 ticket */ 136478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project char *keytab_file; /* S NULL (/etc/krb5.keytab) */ 137478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project char *cred_cache; /* C NULL (default) */ 138478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project krb5_enctype enctype; 139478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project int length; 140478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project krb5_octet FAR *key; 141478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project } KSSL_CTX; 142478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 143478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KSSL_CLIENT 1 144478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KSSL_SERVER 2 145478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KSSL_SERVICE 3 146478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KSSL_KEYTAB 4 147478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 148478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KSSL_CTX_OK 0 149478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KSSL_CTX_ERR 1 150478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#define KSSL_NOMEM 2 151478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 152478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project/* Public (for use by applications that use OpenSSL with Kerberos 5 support */ 153478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectkrb5_error_code kssl_ctx_setstring(KSSL_CTX *kssl_ctx, int which, char *text); 154478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source ProjectKSSL_CTX *kssl_ctx_new(void); 155478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source ProjectKSSL_CTX *kssl_ctx_free(KSSL_CTX *kssl_ctx); 156478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectvoid kssl_ctx_show(KSSL_CTX *kssl_ctx); 157478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectkrb5_error_code kssl_ctx_setprinc(KSSL_CTX *kssl_ctx, int which, 158478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project krb5_data *realm, krb5_data *entity, int nentities); 159478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectkrb5_error_code kssl_cget_tkt(KSSL_CTX *kssl_ctx, krb5_data **enc_tktp, 160478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project krb5_data *authenp, KSSL_ERR *kssl_err); 161478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectkrb5_error_code kssl_sget_tkt(KSSL_CTX *kssl_ctx, krb5_data *indata, 162478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project krb5_ticket_times *ttimes, KSSL_ERR *kssl_err); 163478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectkrb5_error_code kssl_ctx_setkey(KSSL_CTX *kssl_ctx, krb5_keyblock *session); 164478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectvoid kssl_err_set(KSSL_ERR *kssl_err, int reason, char *text); 165478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectvoid kssl_krb5_free_data_contents(krb5_context context, krb5_data *data); 166478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectkrb5_error_code kssl_build_principal_2(krb5_context context, 167478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project krb5_principal *princ, int rlen, const char *realm, 168478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project int slen, const char *svc, int hlen, const char *host); 169478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectkrb5_error_code kssl_validate_times(krb5_timestamp atime, 170478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project krb5_ticket_times *ttimes); 171478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectkrb5_error_code kssl_check_authent(KSSL_CTX *kssl_ctx, krb5_data *authentp, 172478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project krb5_timestamp *atimep, KSSL_ERR *kssl_err); 173478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectunsigned char *kssl_skip_confound(krb5_enctype enctype, unsigned char *authn); 174478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 175478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectvoid SSL_set0_kssl_ctx(SSL *s, KSSL_CTX *kctx); 176478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source ProjectKSSL_CTX * SSL_get0_kssl_ctx(SSL *s); 177478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Projectchar *kssl_ctx_get0_client_princ(KSSL_CTX *kctx); 178478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project 179478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#ifdef __cplusplus 180478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project} 181478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#endif 182478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#endif /* OPENSSL_NO_KRB5 */ 183478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project#endif /* KSSL_H */ 184478ab6c8b5bc982589be32eae1e5736efe721b58The Android Open Source Project