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 23420 2008-07-26 18:37:48Z lha $ */
  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 GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_NT_PRINCIPAL_NAME;
  50 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_NT_USER_NAME;
  51 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_NT_MACHINE_UID_NAME;
  52 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_NT_STRING_UID_NAME;
  53
  54 extern GSSAPI_LIB_VARIABLE 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 GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_COPY_CCACHE_X;
  63 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_COMPAT_DES3_MIC_X;
  64 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_REGISTER_ACCEPTOR_IDENTITY_X;
  65 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_SET_DNS_CANONICALIZE_X;
  66 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_SEND_TO_KDC_X;
  67 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_SET_DEFAULT_REALM_X;
  68 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_CCACHE_NAME_X;
  69 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_SET_TIME_OFFSET_X;
  70 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_GET_TIME_OFFSET_X;
  71 /* Extensions inquire context */
  72 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_GET_TKT_FLAGS_X;
  73 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_EXTRACT_AUTHZ_DATA_FROM_SEC_CONTEXT_X;
  74 extern GSSAPI_LIB_VARIABLE gss_OID GSS_C_PEER_HAS_UPDATED_SPNEGO;
  75 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_EXPORT_LUCID_CONTEXT_X;
  76 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_EXPORT_LUCID_CONTEXT_V1_X;
  77 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_GET_SUBKEY_X;
  78 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_GET_INITIATOR_SUBKEY_X;
  79 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_GET_ACCEPTOR_SUBKEY_X;
  80 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_GET_AUTHTIME_X;
  81 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_GET_SERVICE_KEYBLOCK_X;
  82 /* Extensions creds */
  83 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_IMPORT_CRED_X;
  84 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_SET_ALLOWABLE_ENCTYPES_X;
  85 extern GSSAPI_LIB_VARIABLE gss_OID GSS_KRB5_CRED_NO_CI_FLAGS_X;
  86
  87 /*
  88  * kerberos mechanism specific functions
  89  */
  90
  91 struct krb5_keytab_data;
  92 struct krb5_ccache_data;
  93 struct Principal;
  94
  95 OM_uint32 GSSAPI_LIB_FUNCTION
  96 gss_krb5_ccache_name(OM_uint32 * /*minor_status*/,
  97                      const char * /*name */,
  98                      const char ** /*out_name */);
  99
 100 OM_uint32 GSSAPI_LIB_FUNCTION gsskrb5_register_acceptor_identity
 101         (const char */*identity*/);
 102
 103 OM_uint32 GSSAPI_LIB_FUNCTION krb5_gss_register_acceptor_identity
 104         (const char */*identity*/);
 105
 106 OM_uint32 GSSAPI_LIB_FUNCTION gss_krb5_copy_ccache
 107         (OM_uint32 */*minor*/,
 108          gss_cred_id_t /*cred*/,
 109          struct krb5_ccache_data */*out*/);
 110
 111 OM_uint32 GSSAPI_LIB_FUNCTION
 112 gss_krb5_import_cred(OM_uint32 */*minor*/,
 113                      struct krb5_ccache_data * /*in*/,
 114                      struct Principal * /*keytab_principal*/,
 115                      struct krb5_keytab_data * /*keytab*/,
 116                      gss_cred_id_t */*out*/);
 117
 118 OM_uint32 GSSAPI_LIB_FUNCTION gss_krb5_get_tkt_flags
 119         (OM_uint32 */*minor*/,
 120          gss_ctx_id_t /*context_handle*/,
 121          OM_uint32 */*tkt_flags*/);
 122
 123 OM_uint32 GSSAPI_LIB_FUNCTION
 124 gsskrb5_extract_authz_data_from_sec_context
 125         (OM_uint32 * /*minor_status*/,
 126          gss_ctx_id_t /*context_handle*/,
 127          int /*ad_type*/,
 128          gss_buffer_t /*ad_data*/);
 129
 130 OM_uint32 GSSAPI_LIB_FUNCTION
 131 gsskrb5_set_dns_canonicalize(int);
 132
 133 struct gsskrb5_send_to_kdc {
 134     void *func;
 135     void *ptr;
 136 };
 137
 138 OM_uint32 GSSAPI_LIB_FUNCTION
 139 gsskrb5_set_send_to_kdc(struct gsskrb5_send_to_kdc *);
 140
 141 OM_uint32 GSSAPI_LIB_FUNCTION
 142 gsskrb5_set_default_realm(const char *);
 143
 144 OM_uint32 GSSAPI_LIB_FUNCTION
 145 gsskrb5_extract_authtime_from_sec_context(OM_uint32 *, gss_ctx_id_t, time_t *);
 146
 147 struct EncryptionKey;
 148
 149 OM_uint32 GSSAPI_LIB_FUNCTION
 150 gsskrb5_extract_service_keyblock(OM_uint32 *minor_status,
 151                                  gss_ctx_id_t context_handle,
 152                                  struct EncryptionKey **out);
 153 OM_uint32 GSSAPI_LIB_FUNCTION
 154 gsskrb5_get_initiator_subkey(OM_uint32 *minor_status,
 155                                  gss_ctx_id_t context_handle,
 156                                  struct EncryptionKey **out);
 157 OM_uint32 GSSAPI_LIB_FUNCTION
 158 gsskrb5_get_subkey(OM_uint32 *minor_status,
 159                    gss_ctx_id_t context_handle,
 160                    struct EncryptionKey **out);
 161
 162 OM_uint32 GSSAPI_LIB_FUNCTION
 163 gsskrb5_set_time_offset(int);
 164
 165 OM_uint32 GSSAPI_LIB_FUNCTION
 166 gsskrb5_get_time_offset(int *);
 167
 168 /*
 169  * Lucid - NFSv4 interface to GSS-API KRB5 to expose key material to
 170  * do GSS content token handling in-kernel.
 171  */
 172
 173 typedef struct gss_krb5_lucid_key {
 174         OM_uint32       type;
 175         OM_uint32       length;
 176         void *          data;
 177 } gss_krb5_lucid_key_t;
 178
 179 typedef struct gss_krb5_rfc1964_keydata {
 180         OM_uint32               sign_alg;
 181         OM_uint32               seal_alg;
 182         gss_krb5_lucid_key_t    ctx_key;
 183 } gss_krb5_rfc1964_keydata_t;
 184
 185 typedef struct gss_krb5_cfx_keydata {
 186         OM_uint32               have_acceptor_subkey;
 187         gss_krb5_lucid_key_t    ctx_key;
 188         gss_krb5_lucid_key_t    acceptor_subkey;
 189 } gss_krb5_cfx_keydata_t;
 190
 191 typedef struct gss_krb5_lucid_context_v1 {
 192         OM_uint32       version;
 193         OM_uint32       initiate;
 194         OM_uint32       endtime;
 195         OM_uint64       send_seq;
 196         OM_uint64       recv_seq;
 197         OM_uint32       protocol;
 198         gss_krb5_rfc1964_keydata_t rfc1964_kd;
 199         gss_krb5_cfx_keydata_t     cfx_kd;
 200 } gss_krb5_lucid_context_v1_t;
 201
 202 typedef struct gss_krb5_lucid_context_version {
 203         OM_uint32       version;        /* Structure version number */
 204 } gss_krb5_lucid_context_version_t;
 205
 206 /*
 207  * Function declarations
 208  */
 209
 210 OM_uint32 GSSAPI_LIB_FUNCTION
 211 gss_krb5_export_lucid_sec_context(OM_uint32 *minor_status,
 212                                   gss_ctx_id_t *context_handle,
 213                                   OM_uint32 version,
 214                                   void **kctx);
 215
 216
 217 OM_uint32 GSSAPI_LIB_FUNCTION
 218 gss_krb5_free_lucid_sec_context(OM_uint32 *minor_status,
 219                                 void *kctx);
 220
 221
 222 OM_uint32 GSSAPI_LIB_FUNCTION
 223 gss_krb5_set_allowable_enctypes(OM_uint32 *minor_status,
 224                                 gss_cred_id_t cred,
 225                                 OM_uint32 num_enctypes,
 226                                 int32_t *enctypes);
 227
 228 #ifdef __cplusplus
 229 }
 230 #endif
 231
 232 #endif /* GSSAPI_SPNEGO_H_ */