6bf806c60fdb89bdd680ab1f51750ef83a522eb2
[amitay/samba.git] / 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
31 #define SMB_IDMAP_INTERFACE_VERSION 5
32
33 struct idmap_domain {
34         const char *name;
35         struct idmap_methods *methods;
36         void *private_data;
37 };
38
39 /* Filled out by IDMAP backends */
40 struct idmap_methods {
41
42         /* Called when backend is first loaded */
43         NTSTATUS (*init)(struct idmap_domain *dom, const char *params);
44
45         /* Map an array of uids/gids to SIDs.  The caller specifies
46            the uid/gid and type. Gets back the SID. */
47         NTSTATUS (*unixids_to_sids)(struct idmap_domain *dom, struct id_map **ids);
48
49         /* Map an arry of SIDs to uids/gids.  The caller sets the SID
50            and type and gets back a uid or gid. */
51         NTSTATUS (*sids_to_unixids)(struct idmap_domain *dom, struct id_map **ids);
52
53         NTSTATUS (*set_mapping)(struct idmap_domain *dom, const struct id_map *map);
54
55         /* Called to dump backends data */
56         /* NOTE: caller must use talloc_free to free maps when done */
57         NTSTATUS (*dump_data)(struct idmap_domain *dom, struct id_map **maps, int *num_maps);
58
59         /* Called when backend is unloaded */
60         NTSTATUS (*close_fn)(struct idmap_domain *dom);
61 };
62
63 struct idmap_alloc_methods {
64
65         /* Called when backend is first loaded */
66         NTSTATUS (*init)(const char *compat_params);
67
68         NTSTATUS (*allocate_id)(struct unixid *id);
69         NTSTATUS (*get_id_hwm)(struct unixid *id);
70         NTSTATUS (*set_id_hwm)(struct unixid *id);
71
72         /* Called when backend is unloaded */
73         NTSTATUS (*close_fn)(void);
74 };
75
76 #endif /* _IDMAP_H_ */