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