lib/hdb/hdb.h

   1 /*
   2  * Copyright (c) 1997, 1998, 1999 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 /* flags for various functions */
  51 #define HDB_F_DECRYPT   1 /* decrypt keys */
  52 #define HDB_F_REPLACE   2 /* replace entry */
  53
  54 typedef struct HDB{
  55     void *db;
  56     char *name;
  57     int master_key_set;
  58     krb5_data master_key;
  59     int master_key_version;
  60     int openp;
  61
  62     krb5_error_code (*open)(krb5_context, struct HDB*, int, mode_t);
  63     krb5_error_code (*close)(krb5_context, struct HDB*);
  64     krb5_error_code (*fetch)(krb5_context, struct HDB*, unsigned, hdb_entry*);
  65     krb5_error_code (*store)(krb5_context, struct HDB*, unsigned, hdb_entry*);
  66     krb5_error_code (*remove)(krb5_context, struct HDB*, hdb_entry*);
  67     krb5_error_code (*firstkey)(krb5_context, struct HDB*,
  68                                 unsigned, hdb_entry*);
  69     krb5_error_code (*nextkey)(krb5_context, struct HDB*,
  70                                unsigned, hdb_entry*);
  71     krb5_error_code (*lock)(krb5_context, struct HDB*, int operation);
  72     krb5_error_code (*unlock)(krb5_context, struct HDB*);
  73     krb5_error_code (*rename)(krb5_context, struct HDB*, const char*);
  74     krb5_error_code (*_get)(krb5_context, struct HDB*, krb5_data, krb5_data*);
  75     krb5_error_code (*_put)(krb5_context, struct HDB*, int,
  76                             krb5_data, krb5_data);
  77     krb5_error_code (*_del)(krb5_context, struct HDB*, krb5_data);
  78     krb5_error_code (*destroy)(krb5_context, struct HDB*);
  79 }HDB;
  80
  81 #define HDB_DB_DIR "/var/heimdal"
  82 #define HDB_DEFAULT_DB HDB_DB_DIR "/heimdal"
  83 #define HDB_DB_FORMAT_ENTRY "hdb/db-format"
  84
  85 typedef krb5_error_code (*hdb_foreach_func_t)(krb5_context, HDB*,
  86                                               hdb_entry*, void*);
  87 #include <hdb-protos.h>
  88
  89 #endif /* __HDB_H__ */