lib/hdb/hdb.h

   1 /*
   2  * Copyright (c) 1997 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. All advertising materials mentioning features or use of this software
  18  *    must display the following acknowledgement:
  19  *      This product includes software developed by Kungliga Tekniska
  20  *      Högskolan and its contributors.
  21  *
  22  * 4. Neither the name of the Institute nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  */
  38
  39 /* $Id$ */
  40
  41 #ifndef __HDB_H__
  42 #define __HDB_H__
  43
  44 #include <hdb_err.h>
  45
  46 #include <hdb_asn1.h>
  47
  48 enum hdb_lockop{ HDB_RLOCK, HDB_WLOCK };
  49
  50 typedef struct HDB{
  51     void *db;
  52     char *name;
  53     int master_key_set;
  54     krb5_data master_key;
  55     int openp;
  56
  57     krb5_error_code (*open)(krb5_context, struct HDB*, int, mode_t);
  58     krb5_error_code (*close)(krb5_context, struct HDB*);
  59     krb5_error_code (*fetch)(krb5_context, struct HDB*, hdb_entry*);
  60     krb5_error_code (*store)(krb5_context, struct HDB*, int, hdb_entry*);
  61     krb5_error_code (*delete)(krb5_context, struct HDB*, hdb_entry*);
  62     krb5_error_code (*firstkey)(krb5_context, struct HDB*, hdb_entry*);
  63     krb5_error_code (*nextkey)(krb5_context, struct HDB*, hdb_entry*);
  64     krb5_error_code (*lock)(krb5_context, struct HDB*, int operation);
  65     krb5_error_code (*unlock)(krb5_context, struct HDB*);
  66     krb5_error_code (*rename)(krb5_context, struct HDB*, const char*);
  67     krb5_error_code (*_get)(krb5_context, struct HDB*, krb5_data, krb5_data*);
  68     krb5_error_code (*_put)(krb5_context, struct HDB*, int,
  69                             krb5_data, krb5_data);
  70     krb5_error_code (*_del)(krb5_context, struct HDB*, krb5_data);
  71     krb5_error_code (*destroy)(krb5_context, struct HDB*);
  72 }HDB;
  73
  74 void hdb_free_entry(krb5_context, hdb_entry*);
  75
  76 krb5_error_code hdb_create(krb5_context, HDB**, const char*);
  77 krb5_error_code hdb_db_create(krb5_context, HDB**, const char*);
  78 krb5_error_code hdb_ndbm_create(krb5_context, HDB**, const char*);
  79
  80
  81 krb5_error_code hdb_etype2key(krb5_context, hdb_entry*,
  82                               krb5_enctype, Key**);
  83 krb5_error_code hdb_next_etype2key(krb5_context, hdb_entry*,
  84                                    krb5_enctype, Key**);
  85 krb5_error_code hdb_keytype2key(krb5_context, hdb_entry*,
  86                                 krb5_keytype, Key**);
  87 krb5_error_code hdb_next_keytype2key(krb5_context, hdb_entry*,
  88                                      krb5_keytype, Key**);
  89
  90 typedef krb5_error_code (*hdb_foreach_func_t)(krb5_context, HDB*,
  91                                               hdb_entry*, void*);
  92 krb5_error_code hdb_foreach(krb5_context context, HDB *db,
  93                             hdb_foreach_func_t func, void *data);
  94
  95 krb5_error_code hdb_check_db_format(krb5_context, HDB*);
  96 krb5_error_code hdb_init_db(krb5_context, HDB*);
  97
  98 krb5_error_code hdb_set_master_key (krb5_context context,
  99                                     HDB *db,
 100                                     const char *keyfile);
 101
 102 krb5_error_code hdb_clear_master_key (krb5_context context,
 103                                       HDB *db);
 104
 105 krb5_error_code
 106 hdb_process_master_key(krb5_context context, EncryptionKey key,
 107                        krb5_data *schedule);
 108
 109 krb5_error_code
 110 hdb_read_master_key(krb5_context context, const char *filename,
 111                     EncryptionKey *key);
 112
 113 Key *hdb_unseal_key(Key*, krb5_data);
 114 void hdb_seal_key(Key*, krb5_data);
 115 void hdb_unseal_keys(hdb_entry*, krb5_data);
 116 void hdb_seal_keys(hdb_entry*, krb5_data);
 117 void hdb_free_key(Key*);
 118
 119 int hdb_entry2value(krb5_context context, hdb_entry *ent, krb5_data *value);
 120 int hdb_value2entry(krb5_context context, krb5_data *value, hdb_entry *ent);
 121
 122
 123 #define HDB_DB_DIR "/var/heimdal"
 124 #define HDB_DEFAULT_DB HDB_DB_DIR "/heimdal"
 125 #define HDB_DB_FORMAT_ENTRY "hdb/db-format"
 126
 127 #endif /* __HDB_H__ */