source3/winbindd/idmap_rw.h

   1 /*
   2  * Unix SMB/CIFS implementation.
   3  *
   4  * ID mapping: abstract r/w new-mapping mechanism
   5  *
   6  * Copyright (C) Michael Adam 2010
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 /*
  23  * This module implements the abstract logic for creating a new
  24  * SID<->Unix-ID mapping. It can be used by idmap backends that
  25  * need to create mappings for unmapped SIDs upon request.
  26  */
  27
  28 #ifndef _IDMAP_RW_H_
  29 #define _IDMAP_RW_H_
  30
  31 #include "includes.h"
  32 #include "idmap.h"
  33
  34 struct idmap_rw_ops {
  35         NTSTATUS (*get_new_id)(struct idmap_domain *dom, struct unixid *id);
  36         NTSTATUS (*set_mapping)(struct idmap_domain *dom,
  37                                 const struct id_map *map);
  38 };
  39
  40 /**
  41  * This is the abstract mechanism of creating a new mapping
  42  * for a given SID. It is meant to be called called from an
  43  * allocating backend from within idmap_<backend>_sids_to_unixids().
  44  * It expects map->sid and map->xid.type to be set.
  45  * Upon success, the new mapping is stored by the backend and
  46  * map contains the new mapped xid.
  47  *
  48  * The caller has to take care of the necessary steps to
  49  * guarantee atomicity of the operation, e.g. wrapping
  50  * this call in a transaction if available.
  51  */
  52 NTSTATUS idmap_rw_new_mapping(struct idmap_domain *dom,
  53                               struct idmap_rw_ops *ops,
  54                               struct id_map *map);
  55
  56 #endif /* _IDMAP_RW_H_ */