kdc/kdc-plugin.h

   1 /*
   2  * Copyright (c) 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$ */
  35
  36 #ifndef HEIMDAL_KDC_KDC_PLUGIN_H
  37 #define HEIMDAL_KDC_KDC_PLUGIN_H 1
  38
  39 #include <krb5.h>
  40 #include <kdc.h>
  41 #include <hdb.h>
  42
  43 /*
  44  * Allocate a PAC for the given client with krb5_pac_init(),
  45  * and fill its contents in with krb5_pac_add_buffer().
  46  */
  47
  48 typedef krb5_error_code
  49 (KRB5_CALLCONV *krb5plugin_kdc_pac_generate)(void *,
  50                                              krb5_context, /* context */
  51                                              krb5_kdc_configuration *, /* configuration */
  52                                              hdb_entry *, /* client */
  53                                              hdb_entry *, /* server */
  54                                              const krb5_keyblock *, /* pk_replykey */
  55                                              uint64_t,        /* pac_attributes */
  56                                              krb5_pac *);
  57
  58 /*
  59  * Verify the PAC KDC signatures by fetching the appropriate TGS key
  60  * and calling krb5_pac_verify() with that key. Optionally update the
  61  * PAC buffers on success.
  62  */
  63
  64 typedef krb5_error_code
  65 (KRB5_CALLCONV *krb5plugin_kdc_pac_verify)(void *,
  66                                            krb5_context, /* context */
  67                                            krb5_kdc_configuration *, /* configuration */
  68                                            const krb5_principal, /* new ticket client */
  69                                            const krb5_principal, /* delegation proxy */
  70                                            hdb_entry *,/* client */
  71                                            hdb_entry *,/* server */
  72                                            hdb_entry *,/* krbtgt */
  73                                            krb5_pac *);
  74
  75 /*
  76  * Authorize the client principal's access to the Authentication Service (AS).
  77  * This function is called after any pre-authentication has completed.
  78  */
  79
  80 typedef krb5_error_code
  81 (KRB5_CALLCONV *krb5plugin_kdc_client_access)(void *, astgs_request_t);
  82
  83 /*
  84  * A referral policy plugin can either rewrite the server principal
  85  * by resetting priv->server_princ, or it can disable referral
  86  * processing entirely by returning an error.
  87  *
  88  * The error code from the previous server lookup is available as r->ret.
  89  *
  90  * If the function returns KRB5_PLUGIN_NO_HANDLE, the TGS will continue
  91  * with its default referral handling.
  92  *
  93  * Note well: the plugin should free priv->server_princ is replacing.
  94  */
  95
  96 typedef krb5_error_code
  97 (KRB5_CALLCONV *krb5plugin_kdc_referral_policy)(void *, astgs_request_t);
  98
  99 /*
 100  * Update the AS or TGS reply immediately prior to encoding.
 101  */
 102
 103 typedef krb5_error_code
 104 (KRB5_CALLCONV *krb5plugin_kdc_finalize_reply)(void *, astgs_request_t);
 105
 106 /*
 107  * Audit an AS or TGS request. This function is called after encoding the
 108  * reply (on success), or before encoding the error message. If a HDB audit
 109  * function is also present, it is called after this one.
 110  *
 111  * The request should not be modified by the plugin.
 112  */
 113
 114 typedef krb5_error_code
 115 (KRB5_CALLCONV *krb5plugin_kdc_audit)(void *, astgs_request_t);
 116
 117 /*
 118  * Plugins should carefully check API contract notes for changes
 119  * between plugin API versions.
 120  */
 121 #define KRB5_PLUGIN_KDC_VERSION_10      10
 122
 123 typedef struct krb5plugin_kdc_ftable {
 124     int                 minor_version;
 125     krb5_error_code     (KRB5_CALLCONV *init)(krb5_context, void **);
 126     void                (KRB5_CALLCONV *fini)(void *);
 127     krb5plugin_kdc_pac_generate         pac_generate;
 128     krb5plugin_kdc_pac_verify           pac_verify;
 129     krb5plugin_kdc_client_access        client_access;
 130     krb5plugin_kdc_referral_policy      referral_policy;
 131     krb5plugin_kdc_finalize_reply       finalize_reply;
 132     krb5plugin_kdc_audit                audit;
 133 } krb5plugin_kdc_ftable;
 134
 135 #endif /* HEIMDAL_KDC_KDC_PLUGIN_H */