source3/include/idmap_autorid_tdb.h

   1 /*
   2  *  idmap_autorid: static map between Active Directory/NT RIDs
   3  *  and RFC 2307 accounts. This file contains common functions
   4  *  and structures used by idmap_autorid and net idmap autorid utilities
   5  *
   6  *  Copyright (C) Christian Ambach, 2010-2012
   7  *  Copyright (C) Atul Kulkarni, 2013
   8  *  Copyright (C) Michael Adam, 2012-2013
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 3 of the License, or
  13  *  (at your option) any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  22  *
  23  */
  24
  25 #ifndef _IDMAP_AUTORID_H_
  26 #define _IDMAP_AUTORID_H_
  27
  28 #include "includes.h"
  29 #include "system/filesys.h"
  30 #include "dbwrap/dbwrap.h"
  31 #include "dbwrap/dbwrap_open.h"
  32 #include "../lib/util/util_tdb.h"
  33 #include "winbindd/idmap_tdb_common.h"
  34
  35 #define HWM "NEXT RANGE"
  36 #define ALLOC_HWM_UID "NEXT ALLOC UID"
  37 #define ALLOC_HWM_GID "NEXT ALLOC GID"
  38 #define ALLOC_RANGE "ALLOC"
  39 #define CONFIGKEY "CONFIG"
  40
  41 struct autorid_global_config {
  42         uint32_t minvalue;
  43         uint32_t rangesize;
  44         uint32_t maxranges;
  45 };
  46
  47 struct autorid_range_config {
  48         fstring domsid;
  49         uint32_t rangenum;
  50         uint32_t domain_range_index;
  51         uint32_t low_id;
  52 };
  53
  54 /**
  55  * Get the range for a pair consisting of the domain sid
  56  * and a domain range. If there is no stored range for
  57  * this pair and read_only == false, a new range is
  58  * acquired by incrementing that range HWM counter in the
  59  * database.
  60  */
  61 NTSTATUS idmap_autorid_get_domainrange(struct db_context *db,
  62                                        struct autorid_range_config *range,
  63                                        bool read_only);
  64
  65 /**
  66  * get the domain range and low_id for the domain
  67  * identified by domsid and domain_range_index
  68  */
  69 NTSTATUS idmap_autorid_getrange(struct db_context *db,
  70                                 const char *domsid,
  71                                 uint32_t domain_range_index,
  72                                 uint32_t *rangenum,
  73                                 uint32_t *low_id);
  74
  75 /**
  76  * Set a range for a domain#index pair to a given
  77  * number. Fail if a different range was already stored.
  78  */
  79 NTSTATUS idmap_autorid_setrange(struct db_context *db,
  80                                 const char *domsid,
  81                                 uint32_t domain_range_index,
  82                                 uint32_t rangenum);
  83
  84 /**
  85  * Delete a domain#index <-> range maping from the database.
  86  * The mapping is specified by the sid and index.
  87  * If force == true, invalid mapping records are deleted as far
  88  * as possible, otherwise they are left untouched.
  89  */
  90 NTSTATUS idmap_autorid_delete_range_by_sid(struct db_context *db,
  91                                            const char *domsid,
  92                                            uint32_t domain_range_index,
  93                                            bool force);
  94
  95 /**
  96  * Delete a domain#index <-> range maping from the database.
  97  * The mapping is specified by the range number.
  98  * If force == true, invalid mapping records are deleted as far
  99  * as possible, otherwise they are left untouched.
 100  */
 101 NTSTATUS idmap_autorid_delete_range_by_num(struct db_context *db,
 102                                            uint32_t rangenum,
 103                                            bool force);
 104
 105 /**
 106  * Initialize a specified HWM value to 0 if it is not
 107  * yet present in the database.
 108  */
 109 NTSTATUS idmap_autorid_init_hwm(struct db_context *db, const char *hwm);
 110
 111 /**
 112  * Open and possibly create the autorid database.
 113  */
 114 NTSTATUS idmap_autorid_db_open(const char *path,
 115                                TALLOC_CTX *mem_ctx,
 116                                struct db_context **db);
 117
 118 /**
 119  * Initialize the high watermark records in the database.
 120  */
 121 NTSTATUS idmap_autorid_init_hwms(struct db_context *db);
 122
 123 /**
 124  * Initialize an idmap_autorid database.
 125  * After this function has successfully completed, the following are true:
 126  * - the database exists
 127  * - the required HWM keys exist (range, alloc-uid, alloc-gid)
 128  */
 129 NTSTATUS idmap_autorid_db_init(const char *path,
 130                                TALLOC_CTX *mem_ctx,
 131                                struct db_context **db);
 132
 133 /**
 134  * Load the configuration stored in the autorid database.
 135  */
 136 NTSTATUS idmap_autorid_loadconfig(struct db_context *db,
 137                                   TALLOC_CTX *ctx,
 138                                   struct autorid_global_config **result);
 139
 140 /**
 141  * Save the global autorid configuration into the autorid database.
 142  * The stored configuration consists of:
 143  * - the low value of the idmap range
 144  * - the rangesize
 145  * - the maximum number of ranges
 146  */
 147 NTSTATUS idmap_autorid_saveconfig(struct db_context *db,
 148                                   struct autorid_global_config *cfg);
 149
 150 /**
 151  * get the range config string stored in the database
 152  */
 153 NTSTATUS idmap_autorid_getconfigstr(struct db_context *db, TALLOC_CTX *mem_ctx,
 154                                     char **result);
 155
 156 /**
 157  * parse the handed in config string and fill the provided config structure.
 158  * return false if the string could not be parsed.
 159  */
 160 bool idmap_autorid_parse_configstr(const char *configstr,
 161                                    struct autorid_global_config *cfg);
 162
 163
 164 /**
 165  * Save the global autorid configuration into the autorid database
 166  * as provided in the config string.
 167  * First parse the configstr and validate it.
 168  */
 169 NTSTATUS idmap_autorid_saveconfigstr(struct db_context *db,
 170                                      const char *configstr);
 171
 172
 173 /**
 174  * idmap_autorid_iterate_domain_ranges:
 175  * perform an action on all domain range mappings for a given domain
 176  * specified by domain sid.
 177  */
 178 NTSTATUS idmap_autorid_iterate_domain_ranges(struct db_context *db,
 179                                         const char *domsid,
 180                                         NTSTATUS (*fn)(struct db_context *db,
 181                                                        const char *domsid,
 182                                                        uint32_t index,
 183                                                        uint32_t rangenum,
 184                                                        void *private_data),
 185                                         void *private_data,
 186                                         int *count);
 187
 188 /**
 189  * idmap_autorid_iterate_domain_ranges_read:
 190  * perform a read only action on all domain range mappings for a given domain
 191  * specified by domain sid.
 192  */
 193 NTSTATUS idmap_autorid_iterate_domain_ranges_read(struct db_context *db,
 194                                         const char *domsid,
 195                                         NTSTATUS (*fn)(struct db_context *db,
 196                                                        const char *domsid,
 197                                                        uint32_t index,
 198                                                        uint32_t rangenum,
 199                                                        void *private_data),
 200                                         void *private_data,
 201                                         int *count);
 202
 203 /**
 204  * delete all range mappings for a given domain
 205  */
 206 NTSTATUS idmap_autorid_delete_domain_ranges(struct db_context *db,
 207                                             const char *domsid,
 208                                             bool force,
 209                                             int *count);
 210
 211 #endif /* _IDMAP_AUTORID_H_ */