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         uint32_t high_id;
  53 };
  54
  55 /**
  56  * Get the range for a pair consisting of the domain sid
  57  * and a domain range. If there is no stored range for
  58  * this pair and read_only == false, a new range is
  59  * acquired by incrementing that range HWM counter in the
  60  * database.
  61  */
  62 NTSTATUS idmap_autorid_get_domainrange(struct db_context *db,
  63                                        struct autorid_range_config *range,
  64                                        bool read_only);
  65
  66 /**
  67  * get the domain range and low_id for the domain
  68  * identified by domsid and domain_range_index
  69  */
  70 NTSTATUS idmap_autorid_getrange(struct db_context *db,
  71                                 const char *domsid,
  72                                 uint32_t domain_range_index,
  73                                 uint32_t *rangenum,
  74                                 uint32_t *low_id);
  75
  76 /**
  77  * Set a range for a domain#index pair to a given
  78  * number. Fail if a different range was already stored.
  79  */
  80 NTSTATUS idmap_autorid_setrange(struct db_context *db,
  81                                 const char *domsid,
  82                                 uint32_t domain_range_index,
  83                                 uint32_t rangenum);
  84
  85 /**
  86  * Delete a domain#index <-> range maping from the database.
  87  * The mapping is specified by the sid and index.
  88  * If force == true, invalid mapping records are deleted as far
  89  * as possible, otherwise they are left untouched.
  90  */
  91 NTSTATUS idmap_autorid_delete_range_by_sid(struct db_context *db,
  92                                            const char *domsid,
  93                                            uint32_t domain_range_index,
  94                                            bool force);
  95
  96 /**
  97  * Delete a domain#index <-> range maping from the database.
  98  * The mapping is specified by the range number.
  99  * If force == true, invalid mapping records are deleted as far
 100  * as possible, otherwise they are left untouched.
 101  */
 102 NTSTATUS idmap_autorid_delete_range_by_num(struct db_context *db,
 103                                            uint32_t rangenum,
 104                                            bool force);
 105
 106 /**
 107  * Initialize a specified HWM value to 0 if it is not
 108  * yet present in the database.
 109  */
 110 NTSTATUS idmap_autorid_init_hwm(struct db_context *db, const char *hwm);
 111
 112 /**
 113  * Open and possibly create the autorid database.
 114  */
 115 NTSTATUS idmap_autorid_db_open(const char *path,
 116                                TALLOC_CTX *mem_ctx,
 117                                struct db_context **db);
 118
 119 /**
 120  * Initialize the high watermark records in the database.
 121  */
 122 NTSTATUS idmap_autorid_init_hwms(struct db_context *db);
 123
 124 /**
 125  * Initialize an idmap_autorid database.
 126  * After this function has successfully completed, the following are true:
 127  * - the database exists
 128  * - the required HWM keys exist (range, alloc-uid, alloc-gid)
 129  */
 130 NTSTATUS idmap_autorid_db_init(const char *path,
 131                                TALLOC_CTX *mem_ctx,
 132                                struct db_context **db);
 133
 134 /**
 135  * Load the configuration stored in the autorid database.
 136  */
 137 NTSTATUS idmap_autorid_loadconfig(struct db_context *db,
 138                                   TALLOC_CTX *ctx,
 139                                   struct autorid_global_config **result);
 140
 141 /**
 142  * Save the global autorid configuration into the autorid database.
 143  * The stored configuration consists of:
 144  * - the low value of the idmap range
 145  * - the rangesize
 146  * - the maximum number of ranges
 147  */
 148 NTSTATUS idmap_autorid_saveconfig(struct db_context *db,
 149                                   struct autorid_global_config *cfg);
 150
 151 /**
 152  * get the range config string stored in the database
 153  */
 154 NTSTATUS idmap_autorid_getconfigstr(struct db_context *db, TALLOC_CTX *mem_ctx,
 155                                     char **result);
 156
 157 /**
 158  * parse the handed in config string and fill the provided config structure.
 159  * return false if the string could not be parsed.
 160  */
 161 bool idmap_autorid_parse_configstr(const char *configstr,
 162                                    struct autorid_global_config *cfg);
 163
 164
 165 /**
 166  * Save the global autorid configuration into the autorid database
 167  * as provided in the config string.
 168  * First parse the configstr and validate it.
 169  */
 170 NTSTATUS idmap_autorid_saveconfigstr(struct db_context *db,
 171                                      const char *configstr);
 172
 173
 174 /**
 175  * idmap_autorid_iterate_domain_ranges:
 176  * perform an action on all domain range mappings for a given domain
 177  * specified by domain sid.
 178  */
 179 NTSTATUS idmap_autorid_iterate_domain_ranges(struct db_context *db,
 180                                         const char *domsid,
 181                                         NTSTATUS (*fn)(struct db_context *db,
 182                                                        const char *domsid,
 183                                                        uint32_t index,
 184                                                        uint32_t rangenum,
 185                                                        void *private_data),
 186                                         void *private_data,
 187                                         int *count);
 188
 189 /**
 190  * idmap_autorid_iterate_domain_ranges_read:
 191  * perform a read only action on all domain range mappings for a given domain
 192  * specified by domain sid.
 193  */
 194 NTSTATUS idmap_autorid_iterate_domain_ranges_read(struct db_context *db,
 195                                         const char *domsid,
 196                                         NTSTATUS (*fn)(struct db_context *db,
 197                                                        const char *domsid,
 198                                                        uint32_t index,
 199                                                        uint32_t rangenum,
 200                                                        void *private_data),
 201                                         void *private_data,
 202                                         int *count);
 203
 204 /**
 205  * delete all range mappings for a given domain
 206  */
 207 NTSTATUS idmap_autorid_delete_domain_ranges(struct db_context *db,
 208                                             const char *domsid,
 209                                             bool force,
 210                                             int *count);
 211
 212 #endif /* _IDMAP_AUTORID_H_ */