2 Unix SMB/CIFS implementation.
4 DRS::prefixMap implementation
6 Copyright (C) Kamen Mazdrashki <kamen.mazdrashki@postpath.com> 2009
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.
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.
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/>.
23 #include "dsdb/samdb/samdb.h"
24 #include "librpc/gen_ndr/ndr_drsuapi.h"
25 #include "librpc/gen_ndr/ndr_drsblobs.h"
26 #include "../lib/util/asn1.h"
30 * Determine range type for supplied ATTID
32 enum dsdb_attid_type
dsdb_pfm_get_attid_type(uint32_t attid
)
34 if (attid
<= 0x7FFFFFFF) {
35 return DSDB_ATTID_TYPE_PFM
;
37 else if (attid
<= 0xBFFFFFFF) {
38 return DSDB_ATTID_TYPE_INTID
;
40 else if (attid
<= 0xFFFEFFFF) {
41 return DSDB_ATTID_TYPE_RESERVED
;
44 return DSDB_ATTID_TYPE_INTERNAL
;
49 * Allocates schema_prefixMap object in supplied memory context
51 static struct dsdb_schema_prefixmap
*_dsdb_schema_prefixmap_talloc(TALLOC_CTX
*mem_ctx
,
54 struct dsdb_schema_prefixmap
*pfm
;
56 pfm
= talloc_zero(mem_ctx
, struct dsdb_schema_prefixmap
);
62 pfm
->prefixes
= talloc_zero_array(pfm
, struct dsdb_schema_prefixmap_oid
,
73 * Initial prefixMap creation according to:
74 * [MS-DRSR] section 5.12.2
76 WERROR
dsdb_schema_pfm_new(TALLOC_CTX
*mem_ctx
, struct dsdb_schema_prefixmap
**_pfm
)
79 struct dsdb_schema_prefixmap
*pfm
;
82 const char *oid_prefix
;
84 {.id
=0x00000000, .oid_prefix
="2.5.4"},
85 {.id
=0x00000001, .oid_prefix
="2.5.6"},
86 {.id
=0x00000002, .oid_prefix
="1.2.840.113556.1.2"},
87 {.id
=0x00000003, .oid_prefix
="1.2.840.113556.1.3"},
88 {.id
=0x00000004, .oid_prefix
="2.16.840.1.101.2.2.1"},
89 {.id
=0x00000005, .oid_prefix
="2.16.840.1.101.2.2.3"},
90 {.id
=0x00000006, .oid_prefix
="2.16.840.1.101.2.1.5"},
91 {.id
=0x00000007, .oid_prefix
="2.16.840.1.101.2.1.4"},
92 {.id
=0x00000008, .oid_prefix
="2.5.5"},
93 {.id
=0x00000009, .oid_prefix
="1.2.840.113556.1.4"},
94 {.id
=0x0000000A, .oid_prefix
="1.2.840.113556.1.5"},
95 {.id
=0x00000013, .oid_prefix
="0.9.2342.19200300.100"},
96 {.id
=0x00000014, .oid_prefix
="2.16.840.1.113730.3"},
97 {.id
=0x00000015, .oid_prefix
="0.9.2342.19200300.100.1"},
98 {.id
=0x00000016, .oid_prefix
="2.16.840.1.113730.3.1"},
99 {.id
=0x00000017, .oid_prefix
="1.2.840.113556.1.5.7000"},
100 {.id
=0x00000018, .oid_prefix
="2.5.21"},
101 {.id
=0x00000019, .oid_prefix
="2.5.18"},
102 {.id
=0x0000001A, .oid_prefix
="2.5.20"},
105 /* allocate mem for prefix map */
106 pfm
= _dsdb_schema_prefixmap_talloc(mem_ctx
, ARRAY_SIZE(pfm_init_data
));
107 W_ERROR_HAVE_NO_MEMORY(pfm
);
110 for (i
= 0; i
< pfm
->length
; i
++) {
111 if (!ber_write_partial_OID_String(pfm
, &pfm
->prefixes
[i
].bin_oid
, pfm_init_data
[i
].oid_prefix
)) {
113 return WERR_INTERNAL_ERROR
;
115 pfm
->prefixes
[i
].id
= pfm_init_data
[i
].id
;
125 * Adds oid to prefix map.
126 * On success returns ID for newly added index
127 * or ID of existing entry that matches oid
128 * Reference: [MS-DRSR] section 5.12.2
130 * \param pfm prefixMap
131 * \param bin_oid OID prefix to be added to prefixMap
132 * \param pfm_id Location where to store prefixMap entry ID
134 static WERROR
_dsdb_schema_pfm_add_entry(struct dsdb_schema_prefixmap
*pfm
, DATA_BLOB bin_oid
, uint32_t *_idx
)
137 struct dsdb_schema_prefixmap_oid
* pfm_entry
;
138 struct dsdb_schema_prefixmap_oid
* prefixes_new
;
140 /* dup memory for bin-oid prefix to be added */
141 bin_oid
= data_blob_dup_talloc(pfm
, &bin_oid
);
142 W_ERROR_HAVE_NO_MEMORY(bin_oid
.data
);
144 /* make room for new entry */
145 prefixes_new
= talloc_realloc(pfm
, pfm
->prefixes
, struct dsdb_schema_prefixmap_oid
, pfm
->length
+ 1);
147 talloc_free(bin_oid
.data
);
150 pfm
->prefixes
= prefixes_new
;
152 /* make new unique ID in prefixMap */
153 pfm_entry
= &pfm
->prefixes
[pfm
->length
];
155 for (i
= 0; i
< pfm
->length
; i
++) {
156 if (pfm_entry
->id
< pfm
->prefixes
[i
].id
)
157 pfm_entry
->id
= pfm
->prefixes
[i
].id
;
160 /* add new bin-oid prefix */
162 pfm_entry
->bin_oid
= bin_oid
;
172 * Make partial binary OID for supplied OID.
173 * Reference: [MS-DRSR] section 5.12.2
175 static WERROR
_dsdb_pfm_make_binary_oid(const char *full_oid
, TALLOC_CTX
*mem_ctx
,
176 DATA_BLOB
*_bin_oid
, uint32_t *_last_subid
)
179 const char *oid_subid
;
181 /* make last sub-identifier value */
182 oid_subid
= strrchr(full_oid
, '.');
184 return WERR_INVALID_PARAMETER
;
187 last_subid
= strtoul(oid_subid
, NULL
, 10);
189 /* encode oid in BER format */
190 if (!ber_write_OID_String(mem_ctx
, _bin_oid
, full_oid
)) {
191 DEBUG(0,("ber_write_OID_String() failed for %s\n", full_oid
));
192 return WERR_INTERNAL_ERROR
;
195 /* get the prefix of the OID */
196 if (last_subid
< 128) {
197 _bin_oid
->length
-= 1;
199 _bin_oid
->length
-= 2;
202 /* return last_value if requested */
204 *_last_subid
= last_subid
;
211 * Lookup partial-binary-oid in prefixMap
213 WERROR
dsdb_schema_pfm_find_binary_oid(const struct dsdb_schema_prefixmap
*pfm
,
219 for (i
= 0; i
< pfm
->length
; i
++) {
220 if (pfm
->prefixes
[i
].bin_oid
.length
!= bin_oid
.length
) {
224 if (memcmp(pfm
->prefixes
[i
].bin_oid
.data
, bin_oid
.data
, bin_oid
.length
) == 0) {
232 return WERR_NOT_FOUND
;
236 * Lookup full-oid in prefixMap
237 * Note: this may be slow.
239 WERROR
dsdb_schema_pfm_find_oid(const struct dsdb_schema_prefixmap
*pfm
,
240 const char *full_oid
,
246 ZERO_STRUCT(bin_oid
);
248 /* make partial-binary-oid to look for */
249 werr
= _dsdb_pfm_make_binary_oid(full_oid
, NULL
, &bin_oid
, NULL
);
250 W_ERROR_NOT_OK_RETURN(werr
);
252 /* lookup the partial-oid */
253 werr
= dsdb_schema_pfm_find_binary_oid(pfm
, bin_oid
, _idx
);
255 data_blob_free(&bin_oid
);
261 * Make ATTID for given OID
262 * If OID is not in prefixMap, new prefix
263 * may be added depending on 'can_change_pfm' flag
264 * Reference: [MS-DRSR] section 5.12.2
266 static WERROR
dsdb_schema_pfm_make_attid_impl(struct dsdb_schema_prefixmap
*pfm
,
273 uint32_t lo_word
, hi_word
;
278 return WERR_INVALID_PARAMETER
;
281 return WERR_INVALID_PARAMETER
;
284 werr
= _dsdb_pfm_make_binary_oid(oid
, pfm
, &bin_oid
, &last_subid
);
285 W_ERROR_NOT_OK_RETURN(werr
);
287 /* search the prefix in the prefix table, if none found, add
288 * one entry for new prefix.
290 werr
= dsdb_schema_pfm_find_binary_oid(pfm
, bin_oid
, &idx
);
291 if (W_ERROR_IS_OK(werr
)) {
292 /* free memory allocated for bin_oid */
293 data_blob_free(&bin_oid
);
295 /* return error in read-only mode */
296 if (!can_change_pfm
) {
300 /* entry does not exists, add it */
301 werr
= _dsdb_schema_pfm_add_entry(pfm
, bin_oid
, &idx
);
302 W_ERROR_NOT_OK_RETURN(werr
);
305 /* compose the attid */
306 lo_word
= last_subid
% 16384; /* actually get lower 14 bits: lo_word & 0x3FFF */
307 if (last_subid
>= 16384) {
308 /* mark it so that it is known to not be the whole lastValue
309 * This will raise 16-th bit*/
312 hi_word
= pfm
->prefixes
[idx
].id
;
315 * HIWORD is prefixMap id
316 * LOWORD is truncated binary-oid */
317 *attid
= (hi_word
* 65536) + lo_word
;
323 * Make ATTID for given OID
324 * Reference: [MS-DRSR] section 5.12.2
326 * Note: This function may change prefixMap if prefix
327 * for supplied 'oid' doesn't exists yet.
328 * It is recommended to be used mostly when caller
329 * want to add new prefixes.
330 * Otherwise dsdb_schema_pfm_attid_from_oid() should be used.
332 WERROR
dsdb_schema_pfm_make_attid(struct dsdb_schema_prefixmap
*pfm
,
336 return dsdb_schema_pfm_make_attid_impl(pfm
, oid
, true, attid
);
340 * Make ATTID for given OID
341 * Reference: [MS-DRSR] section 5.12.2
343 WERROR
dsdb_schema_pfm_attid_from_oid(struct dsdb_schema_prefixmap
*pfm
,
347 return dsdb_schema_pfm_make_attid_impl(pfm
, oid
, false, attid
);
351 * Make OID for given ATTID.
352 * Reference: [MS-DRSR] section 5.12.2
354 WERROR
dsdb_schema_pfm_oid_from_attid(struct dsdb_schema_prefixmap
*pfm
, uint32_t attid
,
355 TALLOC_CTX
*mem_ctx
, const char **_oid
)
358 uint32_t hi_word
, lo_word
;
359 DATA_BLOB bin_oid
= {NULL
, 0};
360 struct dsdb_schema_prefixmap_oid
*pfm_entry
;
361 WERROR werr
= WERR_OK
;
363 /* sanity check for attid requested */
364 if (dsdb_pfm_get_attid_type(attid
) != DSDB_ATTID_TYPE_PFM
) {
365 return WERR_INVALID_PARAMETER
;
368 /* crack attid value */
369 hi_word
= attid
>> 16;
370 lo_word
= attid
& 0xFFFF;
372 /* locate corRespoNding prefixMap entry */
374 for (i
= 0; i
< pfm
->length
; i
++) {
375 if (hi_word
== pfm
->prefixes
[i
].id
) {
376 pfm_entry
= &pfm
->prefixes
[i
];
382 DEBUG(1,("Failed to find prefixMap entry for ATTID = 0x%08X (%d)\n",
384 return WERR_DS_NO_ATTRIBUTE_OR_VALUE
;
387 /* copy oid prefix making enough room */
388 bin_oid
.length
= pfm_entry
->bin_oid
.length
+ 2;
389 bin_oid
.data
= talloc_array(mem_ctx
, uint8_t, bin_oid
.length
);
390 W_ERROR_HAVE_NO_MEMORY(bin_oid
.data
);
391 memcpy(bin_oid
.data
, pfm_entry
->bin_oid
.data
, pfm_entry
->bin_oid
.length
);
394 bin_oid
.length
= bin_oid
.length
- 1;
395 bin_oid
.data
[bin_oid
.length
-1] = lo_word
;
398 if (lo_word
>= 32768) {
401 bin_oid
.data
[bin_oid
.length
-2] = (0x80 | ((lo_word
>>7) & 0x7f));
402 bin_oid
.data
[bin_oid
.length
-1] = lo_word
& 0x7f;
405 if (!ber_read_OID_String(mem_ctx
, bin_oid
, _oid
)) {
406 DEBUG(0,("ber_read_OID_String() failed for %s\n",
407 hex_encode_talloc(bin_oid
.data
, bin_oid
.data
, bin_oid
.length
)));
408 werr
= WERR_INTERNAL_ERROR
;
411 /* free locally allocated memory */
412 talloc_free(bin_oid
.data
);
419 * Verifies drsuapi mappings.
421 static WERROR
_dsdb_drsuapi_pfm_verify(const struct drsuapi_DsReplicaOIDMapping_Ctr
*ctr
,
422 bool have_schema_info
)
425 uint32_t num_mappings
;
426 struct drsuapi_DsReplicaOIDMapping
*mapping
;
428 /* check input params */
430 return WERR_INVALID_PARAMETER
;
432 if (!ctr
->mappings
) {
433 return WERR_INVALID_PARAMETER
;
435 num_mappings
= ctr
->num_mappings
;
437 if (have_schema_info
) {
440 if (ctr
->num_mappings
< 2) {
441 return WERR_INVALID_PARAMETER
;
444 /* check last entry for being special */
445 mapping
= &ctr
->mappings
[ctr
->num_mappings
- 1];
446 if (mapping
->id_prefix
!= 0) {
447 return WERR_INVALID_PARAMETER
;
450 /* verify schemaInfo blob is valid one */
451 blob
= data_blob_const(mapping
->oid
.binary_oid
, mapping
->oid
.length
);
452 if (!dsdb_schema_info_blob_is_valid(&blob
)) {
453 return WERR_INVALID_PARAMETER
;
456 /* get number of read mappings in the map */
460 /* now, verify rest of entries for being at least not null */
461 for (i
= 0; i
< num_mappings
; i
++) {
462 mapping
= &ctr
->mappings
[i
];
463 if (!mapping
->oid
.length
) {
464 return WERR_INVALID_PARAMETER
;
466 if (!mapping
->oid
.binary_oid
) {
467 return WERR_INVALID_PARAMETER
;
469 /* check it is not the special entry */
470 if (*mapping
->oid
.binary_oid
== 0xFF) {
471 return WERR_INVALID_PARAMETER
;
479 * Convert drsuapi_ prefix map to prefixMap internal presentation.
481 * \param ctr Pointer to drsuapi_DsReplicaOIDMapping_Ctr which represents drsuapi_ prefixMap
482 * \param have_schema_info if drsuapi_prefixMap have schem_info in it or not
483 * \param mem_ctx TALLOC_CTX to make allocations in
484 * \param _pfm Out pointer to hold newly created prefixMap
485 * \param _schema_info Out param to store schema_info to. If NULL, schema_info is not decoded
487 WERROR
dsdb_schema_pfm_from_drsuapi_pfm(const struct drsuapi_DsReplicaOIDMapping_Ctr
*ctr
,
488 bool have_schema_info
,
490 struct dsdb_schema_prefixmap
**_pfm
,
491 const char **_schema_info
)
496 uint32_t num_mappings
;
497 struct dsdb_schema_prefixmap
*pfm
;
500 return WERR_INVALID_PARAMETER
;
504 * error out if schema_info is requested
505 * but it is not in the drsuapi_prefixMap
507 if (_schema_info
&& !have_schema_info
) {
508 return WERR_INVALID_PARAMETER
;
511 /* verify drsuapi_pefixMap */
512 werr
=_dsdb_drsuapi_pfm_verify(ctr
, have_schema_info
);
513 W_ERROR_NOT_OK_RETURN(werr
);
515 /* allocate mem for prefix map */
516 num_mappings
= ctr
->num_mappings
;
517 if (have_schema_info
) {
520 pfm
= _dsdb_schema_prefixmap_talloc(mem_ctx
, num_mappings
);
521 W_ERROR_HAVE_NO_MEMORY(pfm
);
523 /* copy entries from drsuapi_prefixMap */
524 for (i
= 0; i
< pfm
->length
; i
++) {
525 blob
= data_blob_talloc(pfm
,
526 ctr
->mappings
[i
].oid
.binary_oid
,
527 ctr
->mappings
[i
].oid
.length
);
532 pfm
->prefixes
[i
].id
= ctr
->mappings
[i
].id_prefix
;
533 pfm
->prefixes
[i
].bin_oid
= blob
;
536 /* fetch schema_info if requested */
538 /* by this time, i should have this value,
539 * but set it here for clarity */
540 i
= ctr
->num_mappings
- 1;
542 *_schema_info
= hex_encode_talloc(mem_ctx
,
543 ctr
->mappings
[i
].oid
.binary_oid
,
544 ctr
->mappings
[i
].oid
.length
);
545 if (!*_schema_info
) {
551 /* schema_prefixMap created successfully */
558 * Convert drsuapi_ prefix map to prefixMap internal presentation.
560 * \param pfm Schema prefixMap to be converted
561 * \param schema_info schema_info string - if NULL, we don't need it
562 * \param mem_ctx TALLOC_CTX to make allocations in
563 * \param _ctr Out pointer to drsuapi_DsReplicaOIDMapping_Ctr prefix map structure
565 WERROR
dsdb_drsuapi_pfm_from_schema_pfm(const struct dsdb_schema_prefixmap
*pfm
,
566 const char *schema_info
,
568 struct drsuapi_DsReplicaOIDMapping_Ctr
**_ctr
)
572 struct drsuapi_DsReplicaOIDMapping_Ctr
*ctr
;
575 return WERR_INVALID_PARAMETER
;
578 return WERR_INVALID_PARAMETER
;
580 if (pfm
->length
== 0) {
581 return WERR_INVALID_PARAMETER
;
584 /* allocate memory for the structure */
585 ctr
= talloc_zero(mem_ctx
, struct drsuapi_DsReplicaOIDMapping_Ctr
);
586 W_ERROR_HAVE_NO_MEMORY(ctr
);
588 ctr
->num_mappings
= (schema_info
? pfm
->length
+ 1 : pfm
->length
);
589 ctr
->mappings
= talloc_array(ctr
, struct drsuapi_DsReplicaOIDMapping
, ctr
->num_mappings
);
590 if (!ctr
->mappings
) {
595 /* copy entries from schema_prefixMap */
596 for (i
= 0; i
< pfm
->length
; i
++) {
597 blob
= data_blob_dup_talloc(ctr
, &pfm
->prefixes
[i
].bin_oid
);
602 ctr
->mappings
[i
].id_prefix
= pfm
->prefixes
[i
].id
;
603 ctr
->mappings
[i
].oid
.length
= blob
.length
;
604 ctr
->mappings
[i
].oid
.binary_oid
= blob
.data
;
607 /* make schema_info entry if needed */
609 /* by this time, i should have this value,
610 * but set it here for clarity */
611 i
= ctr
->num_mappings
- 1;
613 blob
= strhex_to_data_blob(ctr
, schema_info
);
619 ctr
->mappings
[i
].id_prefix
= 0;
620 ctr
->mappings
[i
].oid
.length
= blob
.length
;
621 ctr
->mappings
[i
].oid
.binary_oid
= blob
.data
;
624 /* drsuapi_prefixMap constructed successfully */
631 * Verifies schema prefixMap and drsuapi prefixMap are same.
632 * Note that we just need to verify pfm contains prefixes
633 * from ctr, not that those prefixes has same id_prefix.
635 WERROR
dsdb_schema_pfm_contains_drsuapi_pfm(const struct dsdb_schema_prefixmap
*pfm
,
636 const struct drsuapi_DsReplicaOIDMapping_Ctr
*ctr
)
643 /* verify drsuapi_pefixMap */
644 werr
= _dsdb_drsuapi_pfm_verify(ctr
, true);
645 W_ERROR_NOT_OK_RETURN(werr
);
647 /* check pfm contains every entry from ctr, except the last one */
648 for (i
= 0; i
< ctr
->num_mappings
- 1; i
++) {
649 bin_oid
.length
= ctr
->mappings
[i
].oid
.length
;
650 bin_oid
.data
= ctr
->mappings
[i
].oid
.binary_oid
;
652 werr
= dsdb_schema_pfm_find_binary_oid(pfm
, bin_oid
, &idx
);
653 if (!W_ERROR_IS_OK(werr
)) {
654 return WERR_DS_DRA_SCHEMA_MISMATCH
;