2 Unix SMB/CIFS implementation.
4 idmap TDB2 backend, used for clustered Samba setups.
6 This uses dbwrap to access tdb files. The location can be set
7 using tdb:idmap2.tdb =" in smb.conf
9 Copyright (C) Andrew Tridgell 2007
11 This is heavily based upon idmap_tdb.c, which is:
13 Copyright (C) Tim Potter 2000
14 Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
15 Copyright (C) Jeremy Allison 2006
16 Copyright (C) Simo Sorce 2003-2006
17 Copyright (C) Michael Adam 2009-2010
19 This program is free software; you can redistribute it and/or modify
20 it under the terms of the GNU General Public License as published by
21 the Free Software Foundation; either version 2 of the License, or
22 (at your option) any later version.
24 This program is distributed in the hope that it will be useful,
25 but WITHOUT ANY WARRANTY; without even the implied warranty of
26 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 GNU General Public License for more details.
29 You should have received a copy of the GNU General Public License
30 along with this program; if not, write to the Free Software
31 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
35 #include "system/filesys.h"
39 #include "dbwrap/dbwrap.h"
40 #include "dbwrap/dbwrap_open.h"
41 #include "../libcli/security/dom_sid.h"
43 #include "idmap_tdb_common.h"
46 #define DBGC_CLASS DBGC_IDMAP
48 struct idmap_tdb2_context
{
49 const char *script
; /* script to provide idmaps */
52 /* High water mark keys */
53 #define HWM_GROUP "GROUP HWM"
54 #define HWM_USER "USER HWM"
57 * check and initialize high/low water marks in the db
59 static NTSTATUS
idmap_tdb2_init_hwm(struct idmap_domain
*dom
)
63 struct idmap_tdb_common_context
*ctx
;
65 ctx
= talloc_get_type(dom
->private_data
,
66 struct idmap_tdb_common_context
);
68 /* Create high water marks for group and user id */
70 status
= dbwrap_fetch_uint32_bystring(ctx
->db
, HWM_USER
, &low_id
);
71 if (!NT_STATUS_IS_OK(status
) || (low_id
< dom
->low_id
)) {
72 status
= dbwrap_trans_store_uint32_bystring(ctx
->db
, HWM_USER
,
74 if (!NT_STATUS_IS_OK(status
)) {
75 DEBUG(0, ("Unable to initialise user hwm in idmap "
76 "database: %s\n", nt_errstr(status
)));
77 return NT_STATUS_INTERNAL_DB_ERROR
;
81 status
= dbwrap_fetch_uint32_bystring(ctx
->db
, HWM_GROUP
, &low_id
);
82 if (!NT_STATUS_IS_OK(status
) || (low_id
< dom
->low_id
)) {
83 status
= dbwrap_trans_store_uint32_bystring(ctx
->db
, HWM_GROUP
,
85 if (!NT_STATUS_IS_OK(status
)) {
86 DEBUG(0, ("Unable to initialise group hwm in idmap "
87 "database: %s\n", nt_errstr(status
)));
88 return NT_STATUS_INTERNAL_DB_ERROR
;
97 open the permanent tdb
99 static NTSTATUS
idmap_tdb2_open_db(struct idmap_domain
*dom
)
102 struct idmap_tdb_common_context
*ctx
;
104 ctx
= talloc_get_type(dom
->private_data
,
105 struct idmap_tdb_common_context
);
108 /* its already open */
112 db_path
= talloc_asprintf(NULL
, "%s/idmap2.tdb", lp_private_dir());
113 NT_STATUS_HAVE_NO_MEMORY(db_path
);
115 /* Open idmap repository */
116 ctx
->db
= db_open(ctx
, db_path
, 0, TDB_DEFAULT
, O_RDWR
|O_CREAT
, 0644,
117 DBWRAP_LOCK_ORDER_1
, DBWRAP_FLAG_NONE
);
118 TALLOC_FREE(db_path
);
120 if (ctx
->db
== NULL
) {
121 DEBUG(0, ("Unable to open idmap_tdb2 database '%s'\n",
123 return NT_STATUS_UNSUCCESSFUL
;
126 return idmap_tdb2_init_hwm(dom
);
130 * store a mapping in the database.
133 struct idmap_tdb2_set_mapping_context
{
138 static NTSTATUS
idmap_tdb2_set_mapping_action(struct db_context
*db
,
143 struct idmap_tdb2_set_mapping_context
*state
;
144 TALLOC_CTX
*tmp_ctx
= talloc_stackframe();
146 state
= (struct idmap_tdb2_set_mapping_context
*)private_data
;
148 DEBUG(10, ("Storing %s <-> %s map\n", state
->ksidstr
, state
->kidstr
));
150 /* check wheter sid mapping is already present in db */
151 ret
= dbwrap_fetch_bystring(db
, tmp_ctx
, state
->ksidstr
, &data
);
152 if (NT_STATUS_IS_OK(ret
)) {
153 ret
= NT_STATUS_OBJECT_NAME_COLLISION
;
157 ret
= dbwrap_store_bystring(db
, state
->ksidstr
,
158 string_term_tdb_data(state
->kidstr
),
160 if (!NT_STATUS_IS_OK(ret
)) {
161 DEBUG(0, ("Error storing SID -> ID: %s\n", nt_errstr(ret
)));
165 ret
= dbwrap_store_bystring(db
, state
->kidstr
,
166 string_term_tdb_data(state
->ksidstr
),
168 if (!NT_STATUS_IS_OK(ret
)) {
169 DEBUG(0, ("Error storing ID -> SID: %s\n", nt_errstr(ret
)));
170 /* try to remove the previous stored SID -> ID map */
171 dbwrap_delete_bystring(db
, state
->ksidstr
);
175 DEBUG(10,("Stored %s <-> %s\n", state
->ksidstr
, state
->kidstr
));
178 talloc_free(tmp_ctx
);
182 static NTSTATUS
idmap_tdb2_set_mapping(struct idmap_domain
*dom
, const struct id_map
*map
)
184 struct idmap_tdb2_context
*ctx
;
186 char *ksidstr
, *kidstr
;
187 struct idmap_tdb_common_context
*commonctx
;
188 struct idmap_tdb2_set_mapping_context state
;
190 if (!map
|| !map
->sid
) {
191 return NT_STATUS_INVALID_PARAMETER
;
194 ksidstr
= kidstr
= NULL
;
196 /* TODO: should we filter a set_mapping using low/high filters ? */
198 commonctx
= talloc_get_type(dom
->private_data
,
199 struct idmap_tdb_common_context
);
201 ctx
= talloc_get_type(commonctx
->private_data
,
202 struct idmap_tdb2_context
);
204 switch (map
->xid
.type
) {
207 kidstr
= talloc_asprintf(ctx
, "UID %lu", (unsigned long)map
->xid
.id
);
211 kidstr
= talloc_asprintf(ctx
, "GID %lu", (unsigned long)map
->xid
.id
);
215 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map
->xid
.type
));
216 return NT_STATUS_INVALID_PARAMETER
;
219 if (kidstr
== NULL
) {
220 DEBUG(0, ("ERROR: Out of memory!\n"));
221 ret
= NT_STATUS_NO_MEMORY
;
225 ksidstr
= sid_string_talloc(ctx
, map
->sid
);
226 if (ksidstr
== NULL
) {
227 DEBUG(0, ("Out of memory!\n"));
228 ret
= NT_STATUS_NO_MEMORY
;
232 state
.ksidstr
= ksidstr
;
233 state
.kidstr
= kidstr
;
235 ret
= dbwrap_trans_do(commonctx
->db
, idmap_tdb2_set_mapping_action
,
239 talloc_free(ksidstr
);
245 run a script to perform a mapping
247 The script should the following command lines:
253 and should return one of the following as a single line of text
259 static NTSTATUS
idmap_tdb2_script(struct idmap_tdb2_context
*ctx
,
260 struct id_map
*map
, const char *fmt
, ...)
261 PRINTF_ATTRIBUTE(3,4);
263 static NTSTATUS
idmap_tdb2_script(struct idmap_tdb2_context
*ctx
, struct id_map
*map
,
264 const char *fmt
, ...)
272 cmd
= talloc_asprintf(ctx
, "%s ", ctx
->script
);
273 NT_STATUS_HAVE_NO_MEMORY(cmd
);
276 cmd
= talloc_vasprintf_append(cmd
, fmt
, ap
);
278 NT_STATUS_HAVE_NO_MEMORY(cmd
);
283 return NT_STATUS_NONE_MAPPED
;
286 if (fgets(line
, sizeof(line
)-1, p
) == NULL
) {
288 return NT_STATUS_NONE_MAPPED
;
292 DEBUG(10,("idmap script gave: %s\n", line
));
294 if (sscanf(line
, "UID:%lu", &v
) == 1) {
296 map
->xid
.type
= ID_TYPE_UID
;
297 } else if (sscanf(line
, "GID:%lu", &v
) == 1) {
299 map
->xid
.type
= ID_TYPE_GID
;
300 } else if (strncmp(line
, "SID:S-", 6) == 0) {
301 if (!string_to_sid(map
->sid
, &line
[4])) {
302 DEBUG(0,("Bad SID in '%s' from idmap script %s\n",
304 return NT_STATUS_NONE_MAPPED
;
307 DEBUG(0,("Bad reply '%s' from idmap script %s\n",
309 return NT_STATUS_NONE_MAPPED
;
318 Single id to sid lookup function.
320 static NTSTATUS
idmap_tdb2_id_to_sid(struct idmap_domain
*dom
, struct id_map
*map
)
326 struct idmap_tdb_common_context
*commonctx
;
327 struct idmap_tdb2_context
*ctx
;
331 return NT_STATUS_INVALID_PARAMETER
;
334 status
= idmap_tdb2_open_db(dom
);
335 NT_STATUS_NOT_OK_RETURN(status
);
337 commonctx
= talloc_get_type(dom
->private_data
,
338 struct idmap_tdb_common_context
);
340 ctx
= talloc_get_type(commonctx
->private_data
,
341 struct idmap_tdb2_context
);
343 /* apply filters before checking */
344 if (!idmap_unix_id_is_in_range(map
->xid
.id
, dom
)) {
345 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
346 map
->xid
.id
, dom
->low_id
, dom
->high_id
));
347 return NT_STATUS_NONE_MAPPED
;
350 switch (map
->xid
.type
) {
353 keystr
= talloc_asprintf(ctx
, "UID %lu", (unsigned long)map
->xid
.id
);
357 keystr
= talloc_asprintf(ctx
, "GID %lu", (unsigned long)map
->xid
.id
);
361 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map
->xid
.type
));
362 return NT_STATUS_INVALID_PARAMETER
;
365 if (keystr
== NULL
) {
366 DEBUG(0, ("Out of memory!\n"));
367 ret
= NT_STATUS_NO_MEMORY
;
371 DEBUG(10,("Fetching record %s\n", keystr
));
373 /* Check if the mapping exists */
374 status
= dbwrap_fetch_bystring(commonctx
->db
, keystr
, keystr
, &data
);
376 if (!NT_STATUS_IS_OK(status
)) {
378 struct idmap_tdb2_set_mapping_context store_state
;
380 DEBUG(10,("Record %s not found\n", keystr
));
381 if (ctx
->script
== NULL
) {
382 ret
= NT_STATUS_NONE_MAPPED
;
386 ret
= idmap_tdb2_script(ctx
, map
, "IDTOSID %s", keystr
);
387 if (!NT_STATUS_IS_OK(ret
)) {
391 sidstr
= sid_string_talloc(keystr
, map
->sid
);
393 ret
= NT_STATUS_NO_MEMORY
;
397 store_state
.ksidstr
= sidstr
;
398 store_state
.kidstr
= keystr
;
400 ret
= dbwrap_trans_do(commonctx
->db
,
401 idmap_tdb2_set_mapping_action
,
406 if (!string_to_sid(map
->sid
, (const char *)data
.dptr
)) {
407 DEBUG(10,("INVALID SID (%s) in record %s\n",
408 (const char *)data
.dptr
, keystr
));
409 ret
= NT_STATUS_INTERNAL_DB_ERROR
;
413 DEBUG(10,("Found record %s -> %s\n", keystr
, (const char *)data
.dptr
));
423 Single sid to id lookup function.
425 static NTSTATUS
idmap_tdb2_sid_to_id(struct idmap_domain
*dom
, struct id_map
*map
)
430 unsigned long rec_id
= 0;
431 struct idmap_tdb_common_context
*commonctx
;
432 struct idmap_tdb2_context
*ctx
;
433 TALLOC_CTX
*tmp_ctx
= talloc_stackframe();
435 ret
= idmap_tdb2_open_db(dom
);
436 NT_STATUS_NOT_OK_RETURN(ret
);
438 commonctx
= talloc_get_type(dom
->private_data
,
439 struct idmap_tdb_common_context
);
441 ctx
= talloc_get_type(commonctx
->private_data
,
442 struct idmap_tdb2_context
);
444 keystr
= sid_string_talloc(tmp_ctx
, map
->sid
);
445 if (keystr
== NULL
) {
446 DEBUG(0, ("Out of memory!\n"));
447 ret
= NT_STATUS_NO_MEMORY
;
451 DEBUG(10,("Fetching record %s\n", keystr
));
453 /* Check if sid is present in database */
454 ret
= dbwrap_fetch_bystring(commonctx
->db
, tmp_ctx
, keystr
, &data
);
455 if (!NT_STATUS_IS_OK(ret
)) {
457 struct idmap_tdb2_set_mapping_context store_state
;
459 DEBUG(10,(__location__
" Record %s not found\n", keystr
));
461 if (ctx
->script
== NULL
) {
462 ret
= NT_STATUS_NONE_MAPPED
;
466 ret
= idmap_tdb2_script(ctx
, map
, "SIDTOID %s", keystr
);
467 if (!NT_STATUS_IS_OK(ret
)) {
471 /* apply filters before returning result */
472 if (!idmap_unix_id_is_in_range(map
->xid
.id
, dom
)) {
473 DEBUG(5, ("Script returned id (%u) out of range "
474 "(%u - %u). Filtered!\n",
475 map
->xid
.id
, dom
->low_id
, dom
->high_id
));
476 ret
= NT_STATUS_NONE_MAPPED
;
480 idstr
= talloc_asprintf(tmp_ctx
, "%cID %lu",
481 map
->xid
.type
== ID_TYPE_UID
?'U':'G',
482 (unsigned long)map
->xid
.id
);
484 ret
= NT_STATUS_NO_MEMORY
;
488 store_state
.ksidstr
= keystr
;
489 store_state
.kidstr
= idstr
;
491 ret
= dbwrap_trans_do(commonctx
->db
,
492 idmap_tdb2_set_mapping_action
,
497 /* What type of record is this ? */
498 if (sscanf((const char *)data
.dptr
, "UID %lu", &rec_id
) == 1) { /* Try a UID record. */
499 map
->xid
.id
= rec_id
;
500 map
->xid
.type
= ID_TYPE_UID
;
501 DEBUG(10,("Found uid record %s -> %s \n", keystr
, (const char *)data
.dptr
));
504 } else if (sscanf((const char *)data
.dptr
, "GID %lu", &rec_id
) == 1) { /* Try a GID record. */
505 map
->xid
.id
= rec_id
;
506 map
->xid
.type
= ID_TYPE_GID
;
507 DEBUG(10,("Found gid record %s -> %s \n", keystr
, (const char *)data
.dptr
));
510 } else { /* Unknown record type ! */
511 DEBUG(2, ("Found INVALID record %s -> %s\n", keystr
, (const char *)data
.dptr
));
512 ret
= NT_STATUS_INTERNAL_DB_ERROR
;
516 /* apply filters before returning result */
517 if (!idmap_unix_id_is_in_range(map
->xid
.id
, dom
)) {
518 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
519 map
->xid
.id
, dom
->low_id
, dom
->high_id
));
520 ret
= NT_STATUS_NONE_MAPPED
;
524 talloc_free(tmp_ctx
);
529 Initialise idmap database.
531 static NTSTATUS
idmap_tdb2_db_init(struct idmap_domain
*dom
)
534 struct idmap_tdb_common_context
*commonctx
;
535 struct idmap_tdb2_context
*ctx
;
536 char *config_option
= NULL
;
537 const char * idmap_script
= NULL
;
539 commonctx
= talloc_zero(dom
, struct idmap_tdb_common_context
);
541 DEBUG(0, ("Out of memory!\n"));
542 return NT_STATUS_NO_MEMORY
;
545 commonctx
->rw_ops
= talloc_zero(commonctx
, struct idmap_rw_ops
);
546 if (commonctx
->rw_ops
== NULL
) {
547 DEBUG(0, ("Out of memory!\n"));
548 ret
= NT_STATUS_NO_MEMORY
;
552 ctx
= talloc_zero(commonctx
, struct idmap_tdb2_context
);
554 DEBUG(0, ("Out of memory!\n"));
555 ret
= NT_STATUS_NO_MEMORY
;
559 config_option
= talloc_asprintf(ctx
, "idmap config %s", dom
->name
);
560 if (config_option
== NULL
) {
561 DEBUG(0, ("Out of memory!\n"));
562 ret
= NT_STATUS_NO_MEMORY
;
565 ctx
->script
= lp_parm_const_string(-1, config_option
, "script", NULL
);
566 talloc_free(config_option
);
568 idmap_script
= lp_parm_const_string(-1, "idmap", "script", NULL
);
569 if (idmap_script
!= NULL
) {
570 DEBUG(0, ("Warning: 'idmap:script' is deprecated. "
571 " Please use 'idmap config * : script' instead!\n"));
574 if (strequal(dom
->name
, "*") && ctx
->script
== NULL
) {
575 /* fall back to idmap:script for backwards compatibility */
576 ctx
->script
= idmap_script
;
580 DEBUG(1, ("using idmap script '%s'\n", ctx
->script
));
583 commonctx
->max_id
= dom
->high_id
;
584 commonctx
->hwmkey_uid
= HWM_USER
;
585 commonctx
->hwmkey_gid
= HWM_GROUP
;
587 commonctx
->sid_to_unixid_fn
= idmap_tdb2_sid_to_id
;
588 commonctx
->unixid_to_sid_fn
= idmap_tdb2_id_to_sid
;
590 commonctx
->rw_ops
->get_new_id
= idmap_tdb_common_get_new_id
;
591 commonctx
->rw_ops
->set_mapping
= idmap_tdb2_set_mapping
;
593 commonctx
->private_data
= ctx
;
594 dom
->private_data
= commonctx
;
596 ret
= idmap_tdb2_open_db(dom
);
597 if (!NT_STATUS_IS_OK(ret
)) {
604 talloc_free(commonctx
);
609 static struct idmap_methods db_methods
= {
610 .init
= idmap_tdb2_db_init
,
611 .unixids_to_sids
= idmap_tdb_common_unixids_to_sids
,
612 .sids_to_unixids
= idmap_tdb_common_sids_to_unixids
,
613 .allocate_id
= idmap_tdb_common_get_new_id
617 NTSTATUS
idmap_tdb2_init(void)
619 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION
, "tdb2", &db_methods
);