source4/heimdal/kdc/gss_preauth_authorizer_plugin.h

   1 /*
   2  * Copyright (c) 2019 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 #ifndef HEIMDAL_KDC_GSS_PREAUTH_AUTHORIZER_PLUGIN_H
  35 #define HEIMDAL_KDC_GSS_PREAUTH_AUTHORIZER_PLUGIN_H 1
  36
  37 #define KDC_GSS_PREAUTH_AUTHORIZER "kdc_gss_preauth_authorizer"
  38 #define KDC_GSS_PREAUTH_AUTHORIZER_VERSION_1 1
  39
  40 #include <krb5.h>
  41 #include <gssapi/gssapi.h>
  42
  43 /*
  44  * @param init          Plugin initialization function (see krb5-plugin(7))
  45  * @param minor_version The plugin minor version number (1)
  46  * @param fini          Plugin finalization function
  47  * @param authorize     Plugin name authorization function
  48  *
  49  * -# plug_ctx, the context value output by the plugin's init function
  50  * -# context, a krb5_context
  51  * -# req, the AS-REQ request
  52  * -# client_name, the requested client principal name
  53  * -# client, the requested client HDB entry
  54  * -# initiator_name, the authenticated GSS initiator name
  55  * -# ret_flags, the flags returned by GSS_Init_sec_context()
  56  * -# authorized, indicate whether the initiator was authorized
  57  * -# mapped_name, the mapped principal name
  58  *
  59  * @ingroup krb5_support
  60  */
  61
  62 typedef struct krb5plugin_gss_preauth_authorizer_ftable_desc {
  63     int                 minor_version;
  64     krb5_error_code     (KRB5_LIB_CALL *init)(krb5_context, void **);
  65     void                (KRB5_LIB_CALL *fini)(void *);
  66     krb5_error_code     (KRB5_LIB_CALL *authorize)(void *,              /*plug_ctx*/
  67                                                    astgs_request_t,     /*r*/
  68                                                    gss_const_name_t,    /*initiator_name*/
  69                                                    gss_const_OID,       /*mech_type*/
  70                                                    OM_uint32,           /*ret_flags*/
  71                                                    krb5_boolean *,      /*authorized*/
  72                                                    krb5_principal *,    /*mapped_name*/
  73                                                    krb5_data *);        /*pac_data*/
  74     krb5_error_code     (KRB5_LIB_CALL *finalize_pac)(void *,           /*plug_ctx*/
  75                                                       astgs_request_t,  /*r*/
  76                                                       krb5_data *);     /*pac_data*/
  77 } krb5plugin_gss_preauth_authorizer_ftable;
  78
  79 #endif /* HEIMDAL_KDC_GSS_PREAUTH_AUTHORIZER_PLUGIN_H */