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