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