xref: /freebsd/crypto/heimdal/lib/hdb/hdb.h (revision 4f29da19bd44f0e99f021510460a81bf754c21d2)
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.31 2000/07/08 16:03:37 joda 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 typedef struct hdb_master_key_data *hdb_master_key;
53 
54 typedef struct HDB{
55     void *db;
56     void *dbc;
57     char *name;
58     int master_key_set;
59     hdb_master_key master_key;
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 extern krb5_kt_ops hdb_kt_ops;
88 
89 #include <hdb-protos.h>
90 
91 #endif /* __HDB_H__ */
92