source/heimdal/lib/gssapi/gssapi/gssapi_krb5.h

   1 /*
   2  * Copyright (c) 1997 - 2006 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /* $Id: gssapi_krb5.h,v 1.10 2006/10/20 22:04:03 lha Exp $ */
  35
  36 #ifndef GSSAPI_KRB5_H_
  37 #define GSSAPI_KRB5_H_
  38
  39 #include <gssapi/gssapi.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /*
  46  * This is for kerberos5 names.
  47  */
  48
  49 extern gss_OID GSS_KRB5_NT_PRINCIPAL_NAME;
  50 extern gss_OID GSS_KRB5_NT_USER_NAME;
  51 extern gss_OID GSS_KRB5_NT_MACHINE_UID_NAME;
  52 extern gss_OID GSS_KRB5_NT_STRING_UID_NAME;
  53
  54 extern gss_OID GSS_KRB5_MECHANISM;
  55
  56 /* for compatibility with MIT api */
  57
  58 #define gss_mech_krb5 GSS_KRB5_MECHANISM
  59 #define gss_krb5_nt_general_name GSS_KRB5_NT_PRINCIPAL_NAME
  60
  61 /* Extensions set contexts options */
  62 extern gss_OID GSS_KRB5_COPY_CCACHE_X;
  63 extern gss_OID GSS_KRB5_COMPAT_DES3_MIC_X;
  64 extern gss_OID GSS_KRB5_REGISTER_ACCEPTOR_IDENTITY_X;
  65 extern gss_OID GSS_KRB5_SET_DNS_CANONICALIZE_X;
  66 extern gss_OID GSS_KRB5_SEND_TO_KDC_X;
  67 /* Extensions inquire context */
  68 extern gss_OID GSS_KRB5_GET_TKT_FLAGS_X;
  69 extern gss_OID GSS_KRB5_EXTRACT_AUTHZ_DATA_FROM_SEC_CONTEXT_X;
  70 extern gss_OID GSS_C_PEER_HAS_UPDATED_SPNEGO;
  71 extern gss_OID GSS_KRB5_EXPORT_LUCID_CONTEXT_X;
  72 extern gss_OID GSS_KRB5_EXPORT_LUCID_CONTEXT_V1_X;
  73 extern gss_OID GSS_KRB5_GET_SUBKEY_X;
  74 extern gss_OID GSS_KRB5_GET_INITIATOR_SUBKEY_X;
  75 extern gss_OID GSS_KRB5_GET_ACCEPTOR_SUBKEY_X;
  76 extern gss_OID GSS_KRB5_GET_AUTHTIME_X;
  77 extern gss_OID GSS_KRB5_GET_SERVICE_KEYBLOCK_X;
  78 /* Extensions creds */
  79 extern gss_OID GSS_KRB5_IMPORT_CRED_X;
  80
  81 /*
  82  * kerberos mechanism specific functions
  83  */
  84
  85 struct krb5_keytab_data;
  86 struct krb5_ccache_data;
  87 struct Principal;
  88
  89 OM_uint32
  90 gss_krb5_ccache_name(OM_uint32 * /*minor_status*/,
  91                      const char * /*name */,
  92                      const char ** /*out_name */);
  93
  94 OM_uint32 gsskrb5_register_acceptor_identity
  95         (const char */*identity*/);
  96
  97 OM_uint32 gss_krb5_copy_ccache
  98         (OM_uint32 */*minor*/,
  99          gss_cred_id_t /*cred*/,
 100          struct krb5_ccache_data */*out*/);
 101
 102 OM_uint32
 103 gss_krb5_import_cred(OM_uint32 */*minor*/,
 104                      struct krb5_ccache_data * /*in*/,
 105                      struct Principal * /*keytab_principal*/,
 106                      struct krb5_keytab_data * /*keytab*/,
 107                      gss_cred_id_t */*out*/);
 108
 109 OM_uint32 gss_krb5_get_tkt_flags
 110         (OM_uint32 */*minor*/,
 111          gss_ctx_id_t /*context_handle*/,
 112          OM_uint32 */*tkt_flags*/);
 113
 114 OM_uint32
 115 gsskrb5_extract_authz_data_from_sec_context
 116         (OM_uint32 * /*minor_status*/,
 117          gss_ctx_id_t /*context_handle*/,
 118          int /*ad_type*/,
 119          gss_buffer_t /*ad_data*/);
 120
 121 OM_uint32
 122 gsskrb5_set_dns_canonicalize(int);
 123
 124 struct gsskrb5_send_to_kdc {
 125     void *func;
 126     void *ptr;
 127 };
 128
 129 OM_uint32
 130 gsskrb5_set_send_to_kdc(struct gsskrb5_send_to_kdc *);
 131
 132 OM_uint32
 133 gsskrb5_extract_authtime_from_sec_context(OM_uint32 *, gss_ctx_id_t, time_t *);
 134
 135 struct EncryptionKey;
 136
 137 OM_uint32
 138 gsskrb5_extract_service_keyblock(OM_uint32 *minor_status,
 139                                  gss_ctx_id_t context_handle,
 140                                  struct EncryptionKey **out);
 141 OM_uint32
 142 gsskrb5_get_initiator_subkey(OM_uint32 *minor_status,
 143                                  gss_ctx_id_t context_handle,
 144                                  struct EncryptionKey **out);
 145 OM_uint32
 146 gsskrb5_get_subkey(OM_uint32 *minor_status,
 147                    gss_ctx_id_t context_handle,
 148                    struct EncryptionKey **out);
 149
 150 /*
 151  * Lucid - NFSv4 interface to GSS-API KRB5 to expose key material to
 152  * do GSS content token handling in-kernel.
 153  */
 154
 155 typedef struct gss_krb5_lucid_key {
 156         OM_uint32       type;
 157         OM_uint32       length;
 158         void *          data;
 159 } gss_krb5_lucid_key_t;
 160
 161 typedef struct gss_krb5_rfc1964_keydata {
 162         OM_uint32               sign_alg;
 163         OM_uint32               seal_alg;
 164         gss_krb5_lucid_key_t    ctx_key;
 165 } gss_krb5_rfc1964_keydata_t;
 166
 167 typedef struct gss_krb5_cfx_keydata {
 168         OM_uint32               have_acceptor_subkey;
 169         gss_krb5_lucid_key_t    ctx_key;
 170         gss_krb5_lucid_key_t    acceptor_subkey;
 171 } gss_krb5_cfx_keydata_t;
 172
 173 typedef struct gss_krb5_lucid_context_v1 {
 174         OM_uint32       version;
 175         OM_uint32       initiate;
 176         OM_uint32       endtime;
 177         OM_uint64       send_seq;
 178         OM_uint64       recv_seq;
 179         OM_uint32       protocol;
 180         gss_krb5_rfc1964_keydata_t rfc1964_kd;
 181         gss_krb5_cfx_keydata_t     cfx_kd;
 182 } gss_krb5_lucid_context_v1_t;
 183
 184 typedef struct gss_krb5_lucid_context_version {
 185         OM_uint32       version;        /* Structure version number */
 186 } gss_krb5_lucid_context_version_t;
 187
 188 /*
 189  * Function declarations
 190  */
 191
 192 OM_uint32
 193 gss_krb5_export_lucid_sec_context(OM_uint32 *minor_status,
 194                                   gss_ctx_id_t *context_handle,
 195                                   OM_uint32 version,
 196                                   void **kctx);
 197
 198
 199 OM_uint32
 200 gss_krb5_free_lucid_sec_context(OM_uint32 *minor_status,
 201                                 void *kctx);
 202
 203
 204
 205 #ifdef __cplusplus
 206 }
 207 #endif
 208
 209 #endif /* GSSAPI_SPNEGO_H_ */