source3/include/idmap.h

   1 #ifndef _IDMAP_H_
   2 #define _IDMAP_H_
   3 /*
   4    Unix SMB/CIFS implementation.
   5
   6    Idmap headers
   7
   8    Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
   9    Copyright (C) Simo Sorce 2003
  10
  11    This library is free software; you can redistribute it and/or
  12    modify it under the terms of the GNU Lesser General Public
  13    License as published by the Free Software Foundation; either
  14    version 3 of the License, or (at your option) any later version.
  15
  16    This library is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19    Library General Public License for more details.
  20
  21    You should have received a copy of the GNU Lesser General Public License
  22    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23 */
  24
  25 /* The interface version specifier.
  26    Updated to 3 for enum types by JRA. */
  27
  28 /* Updated to 4, completely new interface, SSS */
  29 /* Updated to 5, simplified interface by Volker */
  30 /* Updated to 6, modules now take TALLOC_CTX * init parameter. */
  31
  32 #define SMB_IDMAP_INTERFACE_VERSION 6
  33
  34 #include "librpc/gen_ndr/idmap.h"
  35
  36 struct wbint_userinfo;
  37
  38 struct idmap_domain {
  39         const char *name;
  40         /*
  41          * dom_sid is currently only initialized in the unixids_to_sids request,
  42          * so don't rely on this being filled out everywhere!
  43          */
  44         struct dom_sid dom_sid;
  45         const struct idmap_methods *methods;
  46         NTSTATUS (*query_user)(struct idmap_domain *domain,
  47                                struct wbint_userinfo *info);
  48         uint32_t low_id;
  49         uint32_t high_id;
  50         bool read_only;
  51         void *private_data;
  52 };
  53
  54 /* Filled out by IDMAP backends */
  55 struct idmap_methods {
  56
  57         /* Called when backend is first loaded */
  58         NTSTATUS (*init)(struct idmap_domain *dom);
  59
  60         /* Map an array of uids/gids to SIDs.  The caller specifies
  61            the uid/gid and type. Gets back the SID. */
  62         NTSTATUS (*unixids_to_sids)(struct idmap_domain *dom, struct id_map **ids);
  63
  64         /* Map an arry of SIDs to uids/gids.  The caller sets the SID
  65            and type and gets back a uid or gid. */
  66         NTSTATUS (*sids_to_unixids)(struct idmap_domain *dom, struct id_map **ids);
  67
  68         /* Allocate a Unix-ID. */
  69         NTSTATUS (*allocate_id)(struct idmap_domain *dom, struct unixid *id);
  70 };
  71
  72 #include "winbindd/idmap_proto.h"
  73
  74 #endif /* _IDMAP_H_ */