source4/heimdal/lib/hdb/hdb.h

   1 /*
   2  * Copyright (c) 1997 - 2000 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: hdb.h,v 1.33 2003/09/19 00:19:36 lha Exp $ */
  35
  36 #ifndef __HDB_H__
  37 #define __HDB_H__
  38
  39 #include <hdb_err.h>
  40
  41 #include <hdb_asn1.h>
  42
  43 enum hdb_lockop{ HDB_RLOCK, HDB_WLOCK };
  44
  45 /* flags for various functions */
  46 #define HDB_F_DECRYPT   1 /* decrypt keys */
  47 #define HDB_F_REPLACE   2 /* replace entry */
  48
  49 /* key usage for master key */
  50 #define HDB_KU_MKEY     0x484442
  51
  52 enum hdb_ent_type{ HDB_ENT_TYPE_CLIENT, HDB_ENT_TYPE_SERVER, HDB_ENT_TYPE_ANY };
  53
  54 typedef struct hdb_master_key_data *hdb_master_key;
  55
  56 typedef struct HDB{
  57     void *hdb_db;
  58     void *hdb_dbc;
  59     char *hdb_name;
  60     int hdb_master_key_set;
  61     hdb_master_key hdb_master_key;
  62     void *hdb_openp;
  63
  64     krb5_error_code (*hdb_open)(krb5_context, struct HDB*, int, mode_t);
  65     krb5_error_code (*hdb_close)(krb5_context, struct HDB*);
  66     krb5_error_code (*hdb_fetch)(krb5_context,struct HDB*,unsigned hdb_flags, krb5_const_principal principal,
  67                                  enum hdb_ent_type ent_type, hdb_entry*);
  68     krb5_error_code (*hdb_store)(krb5_context,struct HDB*,unsigned,hdb_entry*);
  69     krb5_error_code (*hdb_remove)(krb5_context, struct HDB*, hdb_entry*);
  70     krb5_error_code (*hdb_firstkey)(krb5_context, struct HDB*,
  71                                 unsigned, hdb_entry*);
  72     krb5_error_code (*hdb_nextkey)(krb5_context, struct HDB*,
  73                                unsigned, hdb_entry*);
  74     krb5_error_code (*hdb_lock)(krb5_context, struct HDB*, int operation);
  75     krb5_error_code (*hdb_unlock)(krb5_context, struct HDB*);
  76     krb5_error_code (*hdb_rename)(krb5_context, struct HDB*, const char*);
  77     krb5_error_code (*hdb__get)(krb5_context,struct HDB*,krb5_data,krb5_data*);
  78     krb5_error_code (*hdb__put)(krb5_context, struct HDB*, int,
  79                             krb5_data, krb5_data);
  80     krb5_error_code (*hdb__del)(krb5_context, struct HDB*, krb5_data);
  81     krb5_error_code (*hdb_destroy)(krb5_context, struct HDB*);
  82 }HDB;
  83
  84 #define HDB_INTERFACE_VERSION   1
  85
  86 struct hdb_so_method {
  87     int version;
  88     const char *prefix;
  89     krb5_error_code (*create)(krb5_context, HDB **, const char *filename);
  90 };
  91
  92 #define HDB_DB_DIR "/var/heimdal"
  93 #define HDB_DEFAULT_DB HDB_DB_DIR "/heimdal"
  94 #define HDB_DB_FORMAT_ENTRY "hdb/db-format"
  95
  96 typedef krb5_error_code (*hdb_foreach_func_t)(krb5_context, HDB*,
  97                                               hdb_entry*, void*);
  98 extern krb5_kt_ops hdb_kt_ops;
  99
 100 #include <hdb-protos.h>
 101
 102 #endif /* __HDB_H__ */