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