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
  57 /* hdb_capability_flags */
  58 #define HDB_CAP_F_HANDLE_ENTERPRISE_PRINCIPAL 1
  59
  60 /* key usage for master key */
  61 #define HDB_KU_MKEY     0x484442
  62
  63 typedef struct hdb_master_key_data *hdb_master_key;
  64
  65 typedef struct hdb_entry_ex {
  66     void *ctx;
  67     hdb_entry entry;
  68     void (*free_entry)(krb5_context, struct hdb_entry_ex *);
  69 } hdb_entry_ex;
  70
  71
  72 /**
  73  * HDB backend function pointer structure
  74  *
  75  * The HDB structure is what the KDC and kadmind framework uses to
  76  * query the backend database when talking about principals.
  77  */
  78
  79 typedef struct HDB{
  80     void *hdb_db;
  81     void *hdb_dbc; /** don't use, only for DB3 */
  82     char *hdb_name;
  83     int hdb_master_key_set;
  84     hdb_master_key hdb_master_key;
  85     int hdb_openp;
  86     int hdb_capability_flags;
  87     /**
  88      * Open (or create) the a Kerberos database.
  89      *
  90      * Open (or create) the a Kerberos database that was resolved with
  91      * hdb_create(). The third and fourth flag to the function are the
  92      * same as open(), thus passing O_CREAT will create the data base
  93      * if it doesn't exists.
  94      *
  95      * Then done the caller should call hdb_close(), and to release
  96      * all resources hdb_destroy().
  97      */
  98     krb5_error_code (*hdb_open)(krb5_context, struct HDB*, int, mode_t);
  99     /**
 100      * Close the database for transaction
 101      *
 102      * Closes the database for further transactions, wont release any
 103      * permanant resources. the database can be ->hdb_open-ed again.
 104      */
 105     krb5_error_code (*hdb_close)(krb5_context, struct HDB*);
 106     /**
 107      * Free an entry after use.
 108      */
 109     void            (*hdb_free)(krb5_context, struct HDB*, hdb_entry_ex*);
 110     /**
 111      * Fetch an entry from the backend
 112      *
 113      * Fetch an entry from the backend, flags are what type of entry
 114      * should be fetch: client, server, krbtgt.
 115      */
 116     krb5_error_code (*hdb_fetch)(krb5_context, struct HDB*,
 117                                  krb5_const_principal, unsigned,
 118                                  hdb_entry_ex*);
 119     /**
 120      * Store an entry to database
 121      */
 122     krb5_error_code (*hdb_store)(krb5_context, struct HDB*,
 123                                  unsigned, hdb_entry_ex*);
 124     /**
 125      * Remove an entry from the database.
 126      */
 127     krb5_error_code (*hdb_remove)(krb5_context, struct HDB*,
 128                                   krb5_const_principal);
 129     /**
 130      * As part of iteration, fetch one entry
 131      */
 132     krb5_error_code (*hdb_firstkey)(krb5_context, struct HDB*,
 133                                     unsigned, hdb_entry_ex*);
 134     /**
 135      * As part of iteration, fetch next entry
 136      */
 137     krb5_error_code (*hdb_nextkey)(krb5_context, struct HDB*,
 138                                    unsigned, hdb_entry_ex*);
 139     /**
 140      * Lock database
 141      *
 142      * A lock can only be held by one consumers. Transaction can still
 143      * happen on the database while the lock is held, so the entry is
 144      * only useful for syncroning creation of the database and renaming of the database.
 145      */
 146     krb5_error_code (*hdb_lock)(krb5_context, struct HDB*, int);
 147     /**
 148      * Unlock database
 149      */
 150     krb5_error_code (*hdb_unlock)(krb5_context, struct HDB*);
 151     /**
 152      * Rename the data base.
 153      */
 154     krb5_error_code (*hdb_rename)(krb5_context, struct HDB*, const char*);
 155     /**
 156      * Get an hdb_entry from a classical DB backend
 157      *
 158      * If the database is a classical DB (ie BDB, NDBM, GDBM, etc)
 159      * backend, this function will take a principal key (krb5_data)
 160      * and return all data related to principal in the return
 161      * krb5_data. The returned encoded entry is of type hdb_entry or
 162      * hdb_entry_alias.
 163      */
 164     krb5_error_code (*hdb__get)(krb5_context, struct HDB*,
 165                                 krb5_data, krb5_data*);
 166     /**
 167      * Store an hdb_entry from a classical DB backend
 168      *
 169      * Same discussion as in @ref HDB::hdb__get
 170      */
 171     krb5_error_code (*hdb__put)(krb5_context, struct HDB*, int,
 172                                 krb5_data, krb5_data);
 173     /**
 174      * Delete and hdb_entry from a classical DB backend
 175      *
 176      * Same discussion as in @ref HDB::hdb__get
 177      */
 178     krb5_error_code (*hdb__del)(krb5_context, struct HDB*, krb5_data);
 179     /**
 180      * Destroy the handle to the database.
 181      *
 182      * Destroy the handle to the database, deallocate all memory and
 183      * related resources. Does not remove any permanent data. Its the
 184      * logical reverse of hdb_create() function that is the entry
 185      * point for the module.
 186      */
 187     krb5_error_code (*hdb_destroy)(krb5_context, struct HDB*);
 188 }HDB;
 189
 190 #define HDB_INTERFACE_VERSION   5
 191
 192 struct hdb_so_method {
 193     int version;
 194     const char *prefix;
 195     krb5_error_code (*create)(krb5_context, HDB **, const char *filename);
 196 };
 197
 198 typedef krb5_error_code (*hdb_foreach_func_t)(krb5_context, HDB*,
 199                                               hdb_entry_ex*, void*);
 200 extern krb5_kt_ops hdb_kt_ops;
 201
 202 struct hdb_method {
 203     int interface_version;
 204     const char *prefix;
 205     krb5_error_code (*create)(krb5_context, HDB **, const char *filename);
 206 };
 207
 208 #include <hdb-protos.h>
 209
 210 #endif /* __HDB_H__ */