| 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 <stdio.h> |
| 40 |
|
| 41 |
#include <krb5.h> |
| 42 |
|
| 43 |
#include <hdb_err.h> |
| 44 |
|
| 45 |
#include <heim_asn1.h> |
| 46 |
#include <hdb_asn1.h> |
| 47 |
|
| 48 |
struct hdb_dbinfo; |
| 49 |
|
| 50 |
enum hdb_lockop{ HDB_RLOCK, HDB_WLOCK }; |
| 51 |
|
| 52 |
/* flags for various functions */ |
| 53 |
#define HDB_F_DECRYPT 1 /* decrypt keys */ |
| 54 |
#define HDB_F_REPLACE 2 /* replace entry */ |
| 55 |
#define HDB_F_GET_CLIENT 4 /* fetch client */ |
| 56 |
#define HDB_F_GET_SERVER 8 /* fetch server */ |
| 57 |
#define HDB_F_GET_KRBTGT 16 /* fetch krbtgt */ |
| 58 |
#define HDB_F_GET_ANY 28 /* fetch any of client,server,krbtgt */ |
| 59 |
#define HDB_F_CANON 32 /* want canonicalition */ |
| 60 |
#define HDB_F_ADMIN_DATA 64 /* want data that kdc don't use */ |
| 61 |
#define HDB_F_KVNO_SPECIFIED 128 /* we want a particular KVNO */ |
| 62 |
#define HDB_F_CURRENT_KVNO 256 /* we want the current KVNO */ |
| 63 |
#define HDB_F_LIVE_CLNT_KVNOS 512 /* we want all live keys for pre-auth */ |
| 64 |
#define HDB_F_LIVE_SVC_KVNOS 1024 /* we want all live keys for tix */ |
| 65 |
#define HDB_F_ALL_KVNOS 2048 /* we want all the keys, live or not */ |
| 66 |
#define HDB_F_FOR_AS_REQ 4096 /* fetch is for a AS REQ */ |
| 67 |
#define HDB_F_FOR_TGS_REQ 8192 /* fetch is for a TGS REQ */ |
| 68 |
#define HDB_F_PRECHECK 16384 /* check that the operation would succeed */ |
| 69 |
|
| 70 |
/* hdb_capability_flags */ |
| 71 |
#define HDB_CAP_F_HANDLE_ENTERPRISE_PRINCIPAL 1 |
| 72 |
#define HDB_CAP_F_HANDLE_PASSWORDS 2 |
| 73 |
#define HDB_CAP_F_PASSWORD_UPDATE_KEYS 4 |
| 74 |
#define HDB_CAP_F_SHARED_DIRECTORY 8 |
| 75 |
|
| 76 |
/* auth status values */ |
| 77 |
#define HDB_AUTH_SUCCESS 0 |
| 78 |
#define HDB_AUTH_WRONG_PASSWORD 1 |
| 79 |
#define HDB_AUTH_INVALID_SIGNATURE 2 |
| 80 |
|
| 81 |
/* key usage for master key */ |
| 82 |
#define HDB_KU_MKEY 0x484442 |
| 83 |
|
| 84 |
typedef struct hdb_master_key_data *hdb_master_key; |
| 85 |
|
| 86 |
/** |
| 87 |
* hdb_entry_ex is a wrapper structure around the hdb_entry structure |
| 88 |
* that allows backends to keep a pointer to the backing store, ie in |
| 89 |
* ->hdb_fetch_kvno(), so that we the kadmin/kpasswd backend gets around to |
| 90 |
* ->hdb_store(), the backend doesn't need to lookup the entry again. |
| 91 |
*/ |
| 92 |
|
| 93 |
typedef struct hdb_entry_ex { |
| 94 |
void *ctx; |
| 95 |
hdb_entry entry; |
| 96 |
void (*free_entry)(krb5_context, struct hdb_entry_ex *); |
| 97 |
} hdb_entry_ex; |
| 98 |
|
| 99 |
|
| 100 |
/** |
| 101 |
* HDB backend function pointer structure |
| 102 |
* |
| 103 |
* The HDB structure is what the KDC and kadmind framework uses to |
| 104 |
* query the backend database when talking about principals. |
| 105 |
*/ |
| 106 |
|
| 107 |
typedef struct HDB { |
| 108 |
void *hdb_db; |
| 109 |
void *hdb_dbc; /** don't use, only for DB3 */ |
| 110 |
char *hdb_name; |
| 111 |
int hdb_master_key_set; |
| 112 |
hdb_master_key hdb_master_key; |
| 113 |
int hdb_openp; |
| 114 |
int hdb_capability_flags; |
| 115 |
int lock_count; |
| 116 |
int lock_type; |
| 117 |
/** |
| 118 |
* Open (or create) the a Kerberos database. |
| 119 |
* |
| 120 |
* Open (or create) the a Kerberos database that was resolved with |
| 121 |
* hdb_create(). The third and fourth flag to the function are the |
| 122 |
* same as open(), thus passing O_CREAT will create the data base |
| 123 |
* if it doesn't exists. |
| 124 |
* |
| 125 |
* Then done the caller should call hdb_close(), and to release |
| 126 |
* all resources hdb_destroy(). |
| 127 |
*/ |
| 128 |
krb5_error_code (*hdb_open)(krb5_context, struct HDB*, int, mode_t); |
| 129 |
/** |
| 130 |
* Close the database for transaction |
| 131 |
* |
| 132 |
* Closes the database for further transactions, wont release any |
| 133 |
* permanant resources. the database can be ->hdb_open-ed again. |
| 134 |
*/ |
| 135 |
krb5_error_code (*hdb_close)(krb5_context, struct HDB*); |
| 136 |
/** |
| 137 |
* Free an entry after use. |
| 138 |
*/ |
| 139 |
void (*hdb_free)(krb5_context, struct HDB*, hdb_entry_ex*); |
| 140 |
/** |
| 141 |
* Fetch an entry from the backend |
| 142 |
* |
| 143 |
* Fetch an entry from the backend, flags are what type of entry |
| 144 |
* should be fetch: client, server, krbtgt. |
| 145 |
* knvo (if specified and flags HDB_F_KVNO_SPECIFIED set) is the kvno to get |
| 146 |
*/ |
| 147 |
krb5_error_code (*hdb_fetch_kvno)(krb5_context, struct HDB*, |
| 148 |
krb5_const_principal, unsigned, krb5_kvno, |
| 149 |
hdb_entry_ex*); |
| 150 |
/** |
| 151 |
* Store an entry to database |
| 152 |
*/ |
| 153 |
krb5_error_code (*hdb_store)(krb5_context, struct HDB*, |
| 154 |
unsigned, hdb_entry_ex*); |
| 155 |
/** |
| 156 |
* Remove an entry from the database. |
| 157 |
*/ |
| 158 |
krb5_error_code (*hdb_remove)(krb5_context, struct HDB*, |
| 159 |
unsigned, krb5_const_principal); |
| 160 |
/** |
| 161 |
* As part of iteration, fetch one entry |
| 162 |
*/ |
| 163 |
krb5_error_code (*hdb_firstkey)(krb5_context, struct HDB*, |
| 164 |
unsigned, hdb_entry_ex*); |
| 165 |
/** |
| 166 |
* As part of iteration, fetch next entry |
| 167 |
*/ |
| 168 |
krb5_error_code (*hdb_nextkey)(krb5_context, struct HDB*, |
| 169 |
unsigned, hdb_entry_ex*); |
| 170 |
/** |
| 171 |
* Lock database |
| 172 |
* |
| 173 |
* A lock can only be held by one consumers. Transaction can still |
| 174 |
* happen on the database while the lock is held, so the entry is |
| 175 |
* only useful for syncroning creation of the database and renaming of the database. |
| 176 |
*/ |
| 177 |
krb5_error_code (*hdb_lock)(krb5_context, struct HDB*, int); |
| 178 |
/** |
| 179 |
* Unlock database |
| 180 |
*/ |
| 181 |
krb5_error_code (*hdb_unlock)(krb5_context, struct HDB*); |
| 182 |
/** |
| 183 |
* Rename the data base. |
| 184 |
* |
| 185 |
* Assume that the database is not hdb_open'ed and not locked. |
| 186 |
*/ |
| 187 |
krb5_error_code (*hdb_rename)(krb5_context, struct HDB*, const char*); |
| 188 |
/** |
| 189 |
* Get an hdb_entry from a classical DB backend |
| 190 |
* |
| 191 |
* This function takes a principal key (krb5_data) and returns all |
| 192 |
* data related to principal in the return krb5_data. The returned |
| 193 |
* encoded entry is of type hdb_entry or hdb_entry_alias. |
| 194 |
*/ |
| 195 |
krb5_error_code (*hdb__get)(krb5_context, struct HDB*, |
| 196 |
krb5_data, krb5_data*); |
| 197 |
/** |
| 198 |
* Store an hdb_entry from a classical DB backend |
| 199 |
* |
| 200 |
* This function takes a principal key (krb5_data) and encoded |
| 201 |
* hdb_entry or hdb_entry_alias as the data to store. |
| 202 |
* |
| 203 |
* For a file-based DB, this must synchronize to disk when done. |
| 204 |
* This is sub-optimal for kadm5_s_rename_principal(), and for |
| 205 |
* kadm5_s_modify_principal() when using principal aliases; to |
| 206 |
* improve this so that only one fsync() need be done |
| 207 |
* per-transaction will require HDB API extensions. |
| 208 |
*/ |
| 209 |
krb5_error_code (*hdb__put)(krb5_context, struct HDB*, int, |
| 210 |
krb5_data, krb5_data); |
| 211 |
/** |
| 212 |
* Delete and hdb_entry from a classical DB backend |
| 213 |
* |
| 214 |
* This function takes a principal key (krb5_data) naming the record |
| 215 |
* to delete. |
| 216 |
* |
| 217 |
* Same discussion as in @ref HDB::hdb__put |
| 218 |
*/ |
| 219 |
krb5_error_code (*hdb__del)(krb5_context, struct HDB*, krb5_data); |
| 220 |
/** |
| 221 |
* Destroy the handle to the database. |
| 222 |
* |
| 223 |
* Destroy the handle to the database, deallocate all memory and |
| 224 |
* related resources. Does not remove any permanent data. Its the |
| 225 |
* logical reverse of hdb_create() function that is the entry |
| 226 |
* point for the module. |
| 227 |
*/ |
| 228 |
krb5_error_code (*hdb_destroy)(krb5_context, struct HDB*); |
| 229 |
/** |
| 230 |
* Get the list of realms this backend handles. |
| 231 |
* This call is optional to support. The returned realms are used |
| 232 |
* for announcing the realms over bonjour. Free returned array |
| 233 |
* with krb5_free_host_realm(). |
| 234 |
*/ |
| 235 |
krb5_error_code (*hdb_get_realms)(krb5_context, struct HDB *, krb5_realm **); |
| 236 |
/** |
| 237 |
* Change password. |
| 238 |
* |
| 239 |
* Will update keys for the entry when given password. The new |
| 240 |
* keys must be written into the entry and will then later be |
| 241 |
* ->hdb_store() into the database. The backend will still perform |
| 242 |
* all other operations, increasing the kvno, and update |
| 243 |
* modification timestamp. |
| 244 |
* |
| 245 |
* The backend needs to call _kadm5_set_keys() and perform password |
| 246 |
* quality checks. |
| 247 |
*/ |
| 248 |
krb5_error_code (*hdb_password)(krb5_context, struct HDB*, hdb_entry_ex*, const char *, int); |
| 249 |
|
| 250 |
/** |
| 251 |
* Auth feedback |
| 252 |
* |
| 253 |
* This is a feedback call that allows backends that provides |
| 254 |
* lockout functionality to register failure and/or successes. |
| 255 |
* |
| 256 |
* In case the entry is locked out, the backend should set the |
| 257 |
* hdb_entry.flags.locked-out flag. |
| 258 |
*/ |
| 259 |
krb5_error_code (*hdb_auth_status)(krb5_context, struct HDB *, hdb_entry_ex *, int); |
| 260 |
/** |
| 261 |
* Check if delegation is allowed. |
| 262 |
*/ |
| 263 |
krb5_error_code (*hdb_check_constrained_delegation)(krb5_context, struct HDB *, hdb_entry_ex *, krb5_const_principal); |
| 264 |
|
| 265 |
/** |
| 266 |
* Check if this name is an alias for the supplied client for PKINIT userPrinicpalName logins |
| 267 |
*/ |
| 268 |
krb5_error_code (*hdb_check_pkinit_ms_upn_match)(krb5_context, struct HDB *, hdb_entry_ex *, krb5_const_principal); |
| 269 |
|
| 270 |
/** |
| 271 |
* Check if s4u2self is allowed from this client to this server |
| 272 |
*/ |
| 273 |
krb5_error_code (*hdb_check_s4u2self)(krb5_context, struct HDB *, hdb_entry_ex *, krb5_const_principal); |
| 274 |
|
| 275 |
/** |
| 276 |
* Enable/disable synchronous updates |
| 277 |
* |
| 278 |
* Calling this with 0 disables sync. Calling it with non-zero enables |
| 279 |
* sync and does an fsync(). |
| 280 |
*/ |
| 281 |
krb5_error_code (*hdb_set_sync)(krb5_context, struct HDB *, int); |
| 282 |
}HDB; |
| 283 |
|
| 284 |
#define HDB_INTERFACE_VERSION 10 |
| 285 |
|
| 286 |
struct hdb_method { |
| 287 |
int version; |
| 288 |
krb5_error_code (*init)(krb5_context, void **); |
| 289 |
void (*fini)(void *); |
| 290 |
const char *prefix; |
| 291 |
krb5_error_code (*create)(krb5_context, HDB **, const char *filename); |
| 292 |
}; |
| 293 |
|
| 294 |
/* dump entry format, for hdb_print_entry() */ |
| 295 |
typedef enum hdb_dump_format { |
| 296 |
HDB_DUMP_HEIMDAL = 0, |
| 297 |
HDB_DUMP_MIT = 1, |
| 298 |
} hdb_dump_format_t; |
| 299 |
|
| 300 |
struct hdb_print_entry_arg { |
| 301 |
FILE *out; |
| 302 |
hdb_dump_format_t fmt; |
| 303 |
}; |
| 304 |
|
| 305 |
typedef krb5_error_code (*hdb_foreach_func_t)(krb5_context, HDB*, |
| 306 |
hdb_entry_ex*, void*); |
| 307 |
extern krb5_kt_ops hdb_kt_ops; |
| 308 |
extern krb5_kt_ops hdb_get_kt_ops; |
| 309 |
|
| 310 |
extern const int hdb_interface_version; |
| 311 |
|
| 312 |
#include <hdb-protos.h> |
| 313 |
|
| 314 |
#endif /* __HDB_H__ */ |