source4/heimdal/lib/hdb/hdb.h

   1 /*
   2  * Copyright (c) 1997 - 2007 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 __HDB_H__
  37 #define __HDB_H__
  38
  39 #include <krb5.h>
  40
  41 #include <hdb_err.h>
  42
  43 #include <heim_asn1.h>
  44 #include <hdb_asn1.h>
  45
  46 struct hdb_dbinfo;
  47
  48 enum hdb_lockop{ HDB_RLOCK, HDB_WLOCK };
  49
  50 /* flags for various functions */
  51 #define HDB_F_DECRYPT           1       /* decrypt keys */
  52 #define HDB_F_REPLACE           2       /* replace entry */
  53 #define HDB_F_GET_CLIENT        4       /* fetch client */
  54 #define HDB_F_GET_SERVER        8       /* fetch server */
  55 #define HDB_F_GET_KRBTGT        16      /* fetch krbtgt */
  56 #define HDB_F_GET_ANY           28      /* fetch any of client,server,krbtgt */
  57 #define HDB_F_CANON             32      /* want canonicalition */
  58 #define HDB_F_ADMIN_DATA        64      /* want data that kdc don't use  */
  59 #define HDB_F_KVNO_SPECIFIED    128     /* we want a particular KVNO */
  60 #define HDB_F_CURRENT_KVNO      256     /* we want the current KVNO */
  61 #define HDB_F_LIVE_CLNT_KVNOS   512     /* we want all live keys for pre-auth */
  62 #define HDB_F_LIVE_SVC_KVNOS    1024    /* we want all live keys for tix */
  63 #define HDB_F_ALL_KVNOS         2048    /* we want all the keys, live or not */
  64 #define HDB_F_FOR_AS_REQ        4096    /* fetch is for a AS REQ */
  65 #define HDB_F_FOR_TGS_REQ       8192    /* fetch is for a TGS REQ */
  66
  67 /* hdb_capability_flags */
  68 #define HDB_CAP_F_HANDLE_ENTERPRISE_PRINCIPAL 1
  69 #define HDB_CAP_F_HANDLE_PASSWORDS      2
  70 #define HDB_CAP_F_PASSWORD_UPDATE_KEYS  4
  71
  72 /* auth status values */
  73 #define HDB_AUTH_SUCCESS                0
  74 #define HDB_AUTH_WRONG_PASSWORD         1
  75 #define HDB_AUTH_INVALID_SIGNATURE      2
  76
  77 /* key usage for master key */
  78 #define HDB_KU_MKEY     0x484442
  79
  80 typedef struct hdb_master_key_data *hdb_master_key;
  81
  82 /**
  83  * hdb_entry_ex is a wrapper structure around the hdb_entry structure
  84  * that allows backends to keep a pointer to the backing store, ie in
  85  * ->hdb_fetch_kvno(), so that we the kadmin/kpasswd backend gets around to
  86  * ->hdb_store(), the backend doesn't need to lookup the entry again.
  87  */
  88
  89 typedef struct hdb_entry_ex {
  90     void *ctx;
  91     hdb_entry entry;
  92     void (*free_entry)(krb5_context, struct hdb_entry_ex *);
  93 } hdb_entry_ex;
  94
  95
  96 /**
  97  * HDB backend function pointer structure
  98  *
  99  * The HDB structure is what the KDC and kadmind framework uses to
 100  * query the backend database when talking about principals.
 101  */
 102
 103 typedef struct HDB{
 104     void *hdb_db;
 105     void *hdb_dbc; /** don't use, only for DB3 */
 106     char *hdb_name;
 107     int hdb_master_key_set;
 108     hdb_master_key hdb_master_key;
 109     int hdb_openp;
 110     int hdb_capability_flags;
 111     int lock_count;
 112     int lock_type;
 113     /**
 114      * Open (or create) the a Kerberos database.
 115      *
 116      * Open (or create) the a Kerberos database that was resolved with
 117      * hdb_create(). The third and fourth flag to the function are the
 118      * same as open(), thus passing O_CREAT will create the data base
 119      * if it doesn't exists.
 120      *
 121      * Then done the caller should call hdb_close(), and to release
 122      * all resources hdb_destroy().
 123      */
 124     krb5_error_code (*hdb_open)(krb5_context, struct HDB*, int, mode_t);
 125     /**
 126      * Close the database for transaction
 127      *
 128      * Closes the database for further transactions, wont release any
 129      * permanant resources. the database can be ->hdb_open-ed again.
 130      */
 131     krb5_error_code (*hdb_close)(krb5_context, struct HDB*);
 132     /**
 133      * Free an entry after use.
 134      */
 135     void            (*hdb_free)(krb5_context, struct HDB*, hdb_entry_ex*);
 136     /**
 137      * Fetch an entry from the backend
 138      *
 139      * Fetch an entry from the backend, flags are what type of entry
 140      * should be fetch: client, server, krbtgt.
 141      * knvo (if specified and flags HDB_F_KVNO_SPECIFIED set) is the kvno to get
 142      */
 143     krb5_error_code (*hdb_fetch_kvno)(krb5_context, struct HDB*,
 144                                       krb5_const_principal, unsigned, krb5_kvno,
 145                                       hdb_entry_ex*);
 146     /**
 147      * Store an entry to database
 148      */
 149     krb5_error_code (*hdb_store)(krb5_context, struct HDB*,
 150                                  unsigned, hdb_entry_ex*);
 151     /**
 152      * Remove an entry from the database.
 153      */
 154     krb5_error_code (*hdb_remove)(krb5_context, struct HDB*,
 155                                   krb5_const_principal);
 156     /**
 157      * As part of iteration, fetch one entry
 158      */
 159     krb5_error_code (*hdb_firstkey)(krb5_context, struct HDB*,
 160                                     unsigned, hdb_entry_ex*);
 161     /**
 162      * As part of iteration, fetch next entry
 163      */
 164     krb5_error_code (*hdb_nextkey)(krb5_context, struct HDB*,
 165                                    unsigned, hdb_entry_ex*);
 166     /**
 167      * Lock database
 168      *
 169      * A lock can only be held by one consumers. Transaction can still
 170      * happen on the database while the lock is held, so the entry is
 171      * only useful for syncroning creation of the database and renaming of the database.
 172      */
 173     krb5_error_code (*hdb_lock)(krb5_context, struct HDB*, int);
 174     /**
 175      * Unlock database
 176      */
 177     krb5_error_code (*hdb_unlock)(krb5_context, struct HDB*);
 178     /**
 179      * Rename the data base.
 180      *
 181      * Assume that the database is not hdb_open'ed and not locked.
 182      */
 183     krb5_error_code (*hdb_rename)(krb5_context, struct HDB*, const char*);
 184     /**
 185      * Get an hdb_entry from a classical DB backend
 186      *
 187      * If the database is a classical DB (ie BDB, NDBM, GDBM, etc)
 188      * backend, this function will take a principal key (krb5_data)
 189      * and return all data related to principal in the return
 190      * krb5_data. The returned encoded entry is of type hdb_entry or
 191      * hdb_entry_alias.
 192      */
 193     krb5_error_code (*hdb__get)(krb5_context, struct HDB*,
 194                                 krb5_data, krb5_data*);
 195     /**
 196      * Store an hdb_entry from a classical DB backend
 197      *
 198      * Same discussion as in @ref HDB::hdb__get
 199      */
 200     krb5_error_code (*hdb__put)(krb5_context, struct HDB*, int,
 201                                 krb5_data, krb5_data);
 202     /**
 203      * Delete and hdb_entry from a classical DB backend
 204      *
 205      * Same discussion as in @ref HDB::hdb__get
 206      */
 207     krb5_error_code (*hdb__del)(krb5_context, struct HDB*, krb5_data);
 208     /**
 209      * Destroy the handle to the database.
 210      *
 211      * Destroy the handle to the database, deallocate all memory and
 212      * related resources. Does not remove any permanent data. Its the
 213      * logical reverse of hdb_create() function that is the entry
 214      * point for the module.
 215      */
 216     krb5_error_code (*hdb_destroy)(krb5_context, struct HDB*);
 217     /**
 218      * Get the list of realms this backend handles.
 219      * This call is optional to support. The returned realms are used
 220      * for announcing the realms over bonjour. Free returned array
 221      * with krb5_free_host_realm().
 222      */
 223     krb5_error_code (*hdb_get_realms)(krb5_context, struct HDB *, krb5_realm **);
 224     /**
 225      * Change password.
 226      *
 227      * Will update keys for the entry when given password.  The new
 228      * keys must be written into the entry and will then later be
 229      * ->hdb_store() into the database. The backend will still perform
 230      * all other operations, increasing the kvno, and update
 231      * modification timestamp.
 232      *
 233      * The backend needs to call _kadm5_set_keys() and perform password
 234      * quality checks.
 235      */
 236     krb5_error_code (*hdb_password)(krb5_context, struct HDB*, hdb_entry_ex*, const char *, int);
 237
 238     /**
 239      * Auth feedback
 240      *
 241      * This is a feedback call that allows backends that provides
 242      * lockout functionality to register failure and/or successes.
 243      *
 244      * In case the entry is locked out, the backend should set the
 245      * hdb_entry.flags.locked-out flag.
 246      */
 247     krb5_error_code (*hdb_auth_status)(krb5_context, struct HDB *, hdb_entry_ex *, int);
 248     /**
 249      * Check if delegation is allowed.
 250      */
 251     krb5_error_code (*hdb_check_constrained_delegation)(krb5_context, struct HDB *, hdb_entry_ex *, krb5_const_principal);
 252
 253     /**
 254      * Check if this name is an alias for the supplied client for PKINIT userPrinicpalName logins
 255      */
 256     krb5_error_code (*hdb_check_pkinit_ms_upn_match)(krb5_context, struct HDB *, hdb_entry_ex *, krb5_const_principal);
 257
 258     /**
 259      * Check if s4u2self is allowed from this client to this server
 260      */
 261     krb5_error_code (*hdb_check_s4u2self)(krb5_context, struct HDB *, hdb_entry_ex *, krb5_const_principal);
 262 }HDB;
 263
 264 #define HDB_INTERFACE_VERSION   7
 265
 266 struct hdb_so_method {
 267     int version;
 268     const char *prefix;
 269     krb5_error_code (*create)(krb5_context, HDB **, const char *filename);
 270 };
 271
 272 typedef krb5_error_code (*hdb_foreach_func_t)(krb5_context, HDB*,
 273                                               hdb_entry_ex*, void*);
 274 extern krb5_kt_ops hdb_kt_ops;
 275
 276 struct hdb_method {
 277     int interface_version;
 278     const char *prefix;
 279     krb5_error_code (*create)(krb5_context, HDB **, const char *filename);
 280 };
 281
 282 extern const int hdb_interface_version;
 283
 284 #include <hdb-protos.h>
 285
 286 #endif /* __HDB_H__ */