1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
|
/*
ldb database library
Copyright (C) Andrew Tridgell 2004
Copyright (C) Stefan Metzmacher 2004
Copyright (C) Simo Sorce 2005-2006
** NOTE! The following LGPL license applies to the ldb
** library. This does NOT imply that all of Samba is released
** under the LGPL
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*
* Name: ldb
*
* Component: ldb header
*
* Description: defines for base ldb API
*
* Author: Andrew Tridgell
* Author: Stefan Metzmacher
*/
/**
\file ldb.h Samba's ldb database
This header file provides the main API for ldb.
*/
#ifndef _LDB_H_
/*! \cond DOXYGEN_IGNORE */
#define _LDB_H_ 1
/*! \endcond */
/*
major restrictions as compared to normal LDAP:
- no async calls.
- each record must have a unique key field
- the key must be representable as a NULL terminated C string and may not
contain a comma or braces
major restrictions as compared to tdb:
- no explicit locking calls
UPDATE: we have transactions now, better than locking --SSS.
*/
#ifndef ldb_val
/**
Result value
An individual lump of data in a result comes in this format. The
pointer will usually be to a UTF-8 string if the application is
sensible, but it can be to anything you like, including binary data
blobs of arbitrary size.
\note the data is null (0x00) terminated, but the length does not
include the terminator.
*/
struct ldb_val {
uint8_t *data; /*!< result data */
size_t length; /*!< length of data */
};
#endif
/*! \cond DOXYGEN_IGNORE */
#ifndef PRINTF_ATTRIBUTE
#define PRINTF_ATTRIBUTE(a,b)
#endif
/*! \endcond */
/* opaque ldb_dn structures, see ldb_dn.c for internals */
struct ldb_dn_component;
struct ldb_dn;
/**
There are a number of flags that are used with ldap_modify() in
ldb_message_element.flags fields. The LDA_FLAGS_MOD_ADD,
LDA_FLAGS_MOD_DELETE and LDA_FLAGS_MOD_REPLACE flags are used in
ldap_modify() calls to specify whether attributes are being added,
deleted or modified respectively.
*/
#define LDB_FLAG_MOD_MASK 0x3
/**
Flag value used in ldap_modify() to indicate that attributes are
being added.
\sa LDB_FLAG_MOD_MASK
*/
#define LDB_FLAG_MOD_ADD 1
/**
Flag value used in ldap_modify() to indicate that attributes are
being replaced.
\sa LDB_FLAG_MOD_MASK
*/
#define LDB_FLAG_MOD_REPLACE 2
/**
Flag value used in ldap_modify() to indicate that attributes are
being deleted.
\sa LDB_FLAG_MOD_MASK
*/
#define LDB_FLAG_MOD_DELETE 3
/**
OID for logic AND comaprison.
This is the well known object ID for a logical AND comparitor.
*/
#define LDB_OID_COMPARATOR_AND "1.2.840.113556.1.4.803"
/**
OID for logic OR comparison.
This is the well known object ID for a logical OR comparitor.
*/
#define LDB_OID_COMPARATOR_OR "1.2.840.113556.1.4.804"
/**
results are given back as arrays of ldb_message_element
*/
struct ldb_message_element {
unsigned int flags;
const char *name;
unsigned int num_values;
struct ldb_val *values;
};
/**
a ldb_message represents all or part of a record. It can contain an arbitrary
number of elements.
*/
struct ldb_message {
struct ldb_dn *dn;
unsigned int num_elements;
struct ldb_message_element *elements;
};
enum ldb_changetype {
LDB_CHANGETYPE_NONE=0,
LDB_CHANGETYPE_ADD,
LDB_CHANGETYPE_DELETE,
LDB_CHANGETYPE_MODIFY
};
/**
LDIF record
This structure contains a LDIF record, as returned from ldif_read()
and equivalent functions.
*/
struct ldb_ldif {
enum ldb_changetype changetype; /*!< The type of change */
struct ldb_message *msg; /*!< The changes */
};
enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
LDB_SCOPE_BASE=0,
LDB_SCOPE_ONELEVEL=1,
LDB_SCOPE_SUBTREE=2};
struct ldb_context;
/* debugging uses one of the following levels */
enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
/**
the user can optionally supply a debug function. The function
is based on the vfprintf() style of interface, but with the addition
of a severity level
*/
struct ldb_debug_ops {
void (*debug)(void *context, enum ldb_debug_level level,
const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
void *context;
};
/**
The user can optionally supply a custom utf8 functions,
to handle comparisons and casefolding.
*/
struct ldb_utf8_fns {
void *context;
char *(*casefold)(void *context, void *mem_ctx, const char *s);
};
/**
Flag value for database connection mode.
If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
opened read-only, if possible.
*/
#define LDB_FLG_RDONLY 1
/**
Flag value for database connection mode.
If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
opened without synchronous operations, if possible.
*/
#define LDB_FLG_NOSYNC 2
/**
Flag value to specify autoreconnect mode.
If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
be opened in a way that makes it try to auto reconnect if the
connection is dropped (actually make sense only with ldap).
*/
#define LDB_FLG_RECONNECT 4
/*
structures for ldb_parse_tree handling code
*/
enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
struct ldb_parse_tree {
enum ldb_parse_op operation;
union {
struct {
struct ldb_parse_tree *child;
} isnot;
struct {
const char *attr;
struct ldb_val value;
} equality;
struct {
const char *attr;
int start_with_wildcard;
int end_with_wildcard;
struct ldb_val **chunks;
} substring;
struct {
const char *attr;
} present;
struct {
const char *attr;
struct ldb_val value;
} comparison;
struct {
const char *attr;
int dnAttributes;
char *rule_id;
struct ldb_val value;
} extended;
struct {
unsigned int num_elements;
struct ldb_parse_tree **elements;
} list;
} u;
};
struct ldb_parse_tree *ldb_parse_tree(void *mem_ctx, const char *s);
char *ldb_filter_from_tree(void *mem_ctx, struct ldb_parse_tree *tree);
/**
Encode a binary blob
This function encodes a binary blob using the encoding rules in RFC
2254 (Section 4). This function also escapes any non-printable
characters.
\param ctx the memory context to allocate the return string in.
\param val the (potentially) binary data to be encoded
\return the encoded data as a null terminated string
\sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
*/
char *ldb_binary_encode(void *ctx, struct ldb_val val);
/**
Encode a string
This function encodes a string using the encoding rules in RFC 2254
(Section 4). This function also escapes any non-printable
characters.
\param mem_ctx the memory context to allocate the return string in.
\param string the string to be encoded
\return the encoded data as a null terminated string
\sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
*/
char *ldb_binary_encode_string(void *mem_ctx, const char *string);
/*
functions for controlling attribute handling
*/
typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
/*
attribute handler structure
attr -> The attribute name
flags -> LDB_ATTR_FLAG_*
ldif_read_fn -> convert from ldif to binary format
ldif_write_fn -> convert from binary to ldif format
canonicalise_fn -> canonicalise a value, for use by indexing and dn construction
comparison_fn -> compare two values
*/
struct ldb_schema_syntax {
const char *name;
ldb_attr_handler_t ldif_read_fn;
ldb_attr_handler_t ldif_write_fn;
ldb_attr_handler_t canonicalise_fn;
ldb_attr_comparison_t comparison_fn;
};
struct ldb_schema_attribute {
const char *name;
unsigned flags;
const struct ldb_schema_syntax *syntax;
};
const struct ldb_schema_attribute *ldb_schema_attribute_by_name(struct ldb_context *ldb,
const char *name);
/**
The attribute is not returned by default
*/
#define LDB_ATTR_FLAG_HIDDEN (1<<0)
/* the attribute handler name should be freed when released */
#define LDB_ATTR_FLAG_ALLOCATED (1<<1)
/**
The attribute is constructed from other attributes
*/
#define LDB_ATTR_FLAG_CONSTRUCTED (1<<1)
/**
LDAP attribute syntax for a DN
This is the well-known LDAP attribute syntax for a DN.
See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
*/
#define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
/**
LDAP attribute syntax for a Directory String
This is the well-known LDAP attribute syntax for a Directory String.
\sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
*/
#define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
/**
LDAP attribute syntax for an integer
This is the well-known LDAP attribute syntax for an integer.
See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
*/
#define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
/**
LDAP attribute syntax for an octet string
This is the well-known LDAP attribute syntax for an octet string.
See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
*/
#define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
/**
LDAP attribute syntax for UTC time.
This is the well-known LDAP attribute syntax for a UTC time.
See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
*/
#define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
#define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
/* sorting helpers */
typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
/**
OID for the paged results control. This control is included in the
searchRequest and searchResultDone messages as part of the controls
field of the LDAPMessage, as defined in Section 4.1.12 of
LDAP v3.
\sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
*/
#define LDB_CONTROL_PAGED_RESULTS_OID "1.2.840.113556.1.4.319"
/**
OID for specifying the returned elements of the ntSecurityDescriptor
\sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_sd_flags_oid.asp">Microsoft documentation of this OID</a>
*/
#define LDB_CONTROL_SD_FLAGS_OID "1.2.840.113556.1.4.801"
/**
OID for specifying an advanced scope for the search (one partition)
\sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_domain_scope_oid.asp">Microsoft documentation of this OID</a>
*/
#define LDB_CONTROL_DOMAIN_SCOPE_OID "1.2.840.113556.1.4.1339"
/**
OID for specifying an advanced scope for a search
\sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_search_options_oid.asp">Microsoft documentation of this OID</a>
*/
#define LDB_CONTROL_SEARCH_OPTIONS_OID "1.2.840.113556.1.4.1340"
/**
OID for notification
\sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_notification_oid.asp">Microsoft documentation of this OID</a>
*/
#define LDB_CONTROL_NOTIFICATION_OID "1.2.840.113556.1.4.528"
/**
OID for getting deleted objects
\sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_show_deleted_oid.asp">Microsoft documentation of this OID</a>
*/
#define LDB_CONTROL_SHOW_DELETED_OID "1.2.840.113556.1.4.417"
/**
OID for extended DN
\sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_extended_dn_oid.asp">Microsoft documentation of this OID</a>
*/
#define LDB_CONTROL_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
/**
OID for LDAP server sort result extension.
This control is included in the searchRequest message as part of
the controls field of the LDAPMessage, as defined in Section 4.1.12
of LDAP v3. The controlType is set to
"1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
FALSE (where absent is also equivalent to FALSE) at the client's
option.
\sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
*/
#define LDB_CONTROL_SERVER_SORT_OID "1.2.840.113556.1.4.473"
/**
OID for LDAP server sort result response extension.
This control is included in the searchResultDone message as part of
the controls field of the LDAPMessage, as defined in Section 4.1.12 of
LDAP v3.
\sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
*/
#define LDB_CONTROL_SORT_RESP_OID "1.2.840.113556.1.4.474"
/**
OID for LDAP Attribute Scoped Query extension.
This control is included in SearchRequest or SearchResponse
messages as part of the controls field of the LDAPMessage.
*/
#define LDB_CONTROL_ASQ_OID "1.2.840.113556.1.4.1504"
/**
OID for LDAP Directory Sync extension.
This control is included in SearchRequest or SearchResponse
messages as part of the controls field of the LDAPMessage.
*/
#define LDB_CONTROL_DIRSYNC_OID "1.2.840.113556.1.4.841"
/**
OID for LDAP Virtual List View Request extension.
This control is included in SearchRequest messages
as part of the controls field of the LDAPMessage.
*/
#define LDB_CONTROL_VLV_REQ_OID "2.16.840.1.113730.3.4.9"
/**
OID for LDAP Virtual List View Response extension.
This control is included in SearchResponse messages
as part of the controls field of the LDAPMessage.
*/
#define LDB_CONTROL_VLV_RESP_OID "2.16.840.1.113730.3.4.10"
/**
OID to let modifies don't give an error when adding an existing
attribute with the same value or deleting an nonexisting one attribute
\sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_permissive_modify_oid.asp">Microsoft documentation of this OID</a>
*/
#define LDB_CONTROL_PERMISSIVE_MODIFY_OID "1.2.840.113556.1.4.1413"
/**
OID for LDAP Extended Operation START_TLS.
This Extended operation is used to start a new TLS
channel on top of a clear text channel.
*/
#define LDB_EXTENDED_START_TLS_OID "1.3.6.1.4.1.1466.20037"
/**
OID for LDAP Extended Operation START_TLS.
This Extended operation is used to start a new TLS
channel on top of a clear text channel.
*/
#define LDB_EXTENDED_DYNAMIC_OID "1.3.6.1.4.1.1466.101.119.1"
/**
OID for LDAP Extended Operation START_TLS.
This Extended operation is used to start a new TLS
channel on top of a clear text channel.
*/
#define LDB_EXTENDED_FAST_BIND_OID "1.2.840.113556.1.4.1781"
struct ldb_sd_flags_control {
/*
* request the owner 0x00000001
* request the group 0x00000002
* request the DACL 0x00000004
* request the SACL 0x00000008
*/
unsigned secinfo_flags;
};
struct ldb_search_options_control {
/*
* DOMAIN_SCOPE 0x00000001
* this limits the search to one partition,
* and no referrals will be returned.
* (Note this doesn't limit the entries by there
* objectSid belonging to a domain! Builtin and Foreign Sids
* are still returned)
*
* PHANTOM_ROOT 0x00000002
* this search on the whole tree on a domain controller
* over multiple partitions without referrals.
* (This is the default behavior on the Global Catalog Port)
*/
unsigned search_options;
};
struct ldb_paged_control {
int size;
int cookie_len;
char *cookie;
};
struct ldb_extended_dn_control {
int type;
};
struct ldb_server_sort_control {
char *attributeName;
char *orderingRule;
int reverse;
};
struct ldb_sort_resp_control {
int result;
char *attr_desc;
};
struct ldb_asq_control {
int request;
char *source_attribute;
int src_attr_len;
int result;
};
struct ldb_dirsync_control {
int flags;
int max_attributes;
int cookie_len;
char *cookie;
};
struct ldb_vlv_req_control {
int beforeCount;
int afterCount;
int type;
union {
struct {
int offset;
int contentCount;
} byOffset;
struct {
int value_len;
char *value;
} gtOrEq;
} match;
int ctxid_len;
char *contextId;
};
struct ldb_vlv_resp_control {
int targetPosition;
int contentCount;
int vlv_result;
int ctxid_len;
char *contextId;
};
struct ldb_control {
const char *oid;
int critical;
void *data;
};
enum ldb_request_type {
LDB_SEARCH,
LDB_ADD,
LDB_MODIFY,
LDB_DELETE,
LDB_RENAME,
LDB_EXTENDED,
LDB_SEQUENCE_NUMBER,
LDB_REQ_REGISTER_CONTROL,
LDB_REQ_REGISTER_PARTITION
};
enum ldb_reply_type {
LDB_REPLY_ENTRY,
LDB_REPLY_REFERRAL,
LDB_REPLY_EXTENDED,
LDB_REPLY_DONE
};
enum ldb_wait_type {
LDB_WAIT_ALL,
LDB_WAIT_NONE
};
enum ldb_state {
LDB_ASYNC_INIT,
LDB_ASYNC_PENDING,
LDB_ASYNC_DONE
};
struct ldb_result {
unsigned int count;
struct ldb_message **msgs;
char **refs;
struct ldb_control **controls;
};
struct ldb_extended {
const char *oid;
void *data;
};
struct ldb_reply {
enum ldb_reply_type type;
struct ldb_message *message;
struct ldb_extended *response;
char *referral;
struct ldb_control **controls;
};
struct ldb_handle {
int status;
enum ldb_state state;
void *private_data;
struct ldb_module *module;
};
struct ldb_search {
struct ldb_dn *base;
enum ldb_scope scope;
const struct ldb_parse_tree *tree;
const char * const *attrs;
struct ldb_result *res;
};
struct ldb_add {
const struct ldb_message *message;
};
struct ldb_modify {
const struct ldb_message *message;
};
struct ldb_delete {
struct ldb_dn *dn;
};
struct ldb_rename {
struct ldb_dn *olddn;
struct ldb_dn *newdn;
};
struct ldb_register_control {
const char *oid;
};
struct ldb_register_partition {
struct ldb_dn *dn;
};
struct ldb_sequence_number {
enum ldb_sequence_type {
LDB_SEQ_HIGHEST_SEQ,
LDB_SEQ_HIGHEST_TIMESTAMP,
LDB_SEQ_NEXT
} type;
uint64_t seq_num;
uint32_t flags;
};
typedef int (*ldb_request_callback_t)(struct ldb_context *, void *, struct ldb_reply *);
struct ldb_request {
enum ldb_request_type operation;
union {
struct ldb_search search;
struct ldb_add add;
struct ldb_modify mod;
struct ldb_delete del;
struct ldb_rename rename;
struct ldb_extended extended;
struct ldb_sequence_number seq_num;
struct ldb_register_control reg_control;
struct ldb_register_partition reg_partition;
} op;
struct ldb_control **controls;
void *context;
ldb_request_callback_t callback;
int timeout;
time_t starttime;
struct ldb_handle *handle;
};
int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
/**
Initialise ldbs' global information
This is required before any other LDB call
\return 0 if initialisation succeeded, -1 otherwise
*/
int ldb_global_init(void);
/**
Initialise an ldb context
This is required before any other LDB call.
\param mem_ctx pointer to a talloc memory context. Pass NULL if there is
no suitable context available.
\return pointer to ldb_context that should be free'd (using talloc_free())
at the end of the program.
*/
struct ldb_context *ldb_init(void *mem_ctx);
/**
Connect to a database.
This is typically called soon after ldb_init(), and is required prior to
any search or database modification operations.
The URL can be one of the following forms:
- tdb://path
- ldapi://path
- ldap://host
- sqlite://path
\param ldb the context associated with the database (from ldb_init())
\param url the URL of the database to connect to, as noted above
\param flags a combination of LDB_FLG_* to modify the connection behaviour
\param options backend specific options - passed uninterpreted to the backend
\return result code (LDB_SUCCESS on success, or a failure code)
\note It is an error to connect to a database that does not exist in readonly mode
(that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
created if it does not exist.
*/
int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
/*
return an automatic basedn from the rootDomainNamingContext of the rootDSE
This value have been set in an opaque pointer at connection time
*/
struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
/*
return an automatic basedn from the configurationNamingContext of the rootDSE
This value have been set in an opaque pointer at connection time
*/
struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
/*
return an automatic basedn from the schemaNamingContext of the rootDSE
This value have been set in an opaque pointer at connection time
*/
struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
/*
return an automatic baseDN from the defaultNamingContext of the rootDSE
This value have been set in an opaque pointer at connection time
*/
struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
/**
The Default iasync search callback function
\param ldb the context associated with the database (from ldb_init())
\param context the callback context
\param ares a single reply from the async core
\return result code (LDB_SUCCESS on success, or a failure code)
\note this function expects the context to always be an struct ldb_result pointer
AND a talloc context, this function will steal on the context each message
from the ares reply passed on by the async core so that in the end all the
messages will be in the context (ldb_result) memory tree.
Freeing the passed context (ldb_result tree) will free all the resources
(the request need to be freed separately and the result doe not depend on the
request that can be freed as sson as the search request is finished)
*/
int ldb_search_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares);
/**
Helper function to build a search request
\param ret_req the request structure is returned here (talloced on mem_ctx)
\param ldb the context associated with the database (from ldb_init())
\param mem_ctx a talloc emmory context (used as parent of ret_req)
\param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
\param scope the search scope for the query
\param expression the search expression to use for this query
\param attrs the search attributes for the query (pass NULL if none required)
\param controls an array of controls
\param context the callback function context
\param the callback function to handle the async replies
\return result code (LDB_SUCCESS on success, or a failure code)
*/
int ldb_build_search_req(struct ldb_request **ret_req,
struct ldb_context *ldb,
void *mem_ctx,
struct ldb_dn *base,
enum ldb_scope scope,
const char *expression,
const char * const *attrs,
struct ldb_control **controls,
void *context,
ldb_request_callback_t callback);
/**
Helper function to build an add request
\param ret_req the request structure is returned here (talloced on mem_ctx)
\param ldb the context associated with the database (from ldb_init())
\param mem_ctx a talloc emmory context (used as parent of ret_req)
\param message contains the entry to be added
\param controls an array of controls
\param context the callback function context
\param the callback function to handle the async replies
\return result code (LDB_SUCCESS on success, or a failure code)
*/
int ldb_build_add_req(struct ldb_request **ret_req,
struct ldb_context *ldb,
void *mem_ctx,
const struct ldb_message *message,
struct ldb_control **controls,
void *context,
ldb_request_callback_t callback);
/**
Helper function to build a modify request
\param ret_req the request structure is returned here (talloced on mem_ctx)
\param ldb the context associated with the database (from ldb_init())
\param mem_ctx a talloc emmory context (used as parent of ret_req)
\param message contains the entry to be modified
\param controls an array of controls
\param context the callback function context
\param the callback function to handle the async replies
\return result code (LDB_SUCCESS on success, or a failure code)
*/
int ldb_build_mod_req(struct ldb_request **ret_req,
struct ldb_context *ldb,
void *mem_ctx,
const struct ldb_message *message,
struct ldb_control **controls,
void *context,
ldb_request_callback_t callback);
/**
Helper function to build a delete request
\param ret_req the request structure is returned here (talloced on mem_ctx)
\param ldb the context associated with the database (from ldb_init())
\param mem_ctx a talloc emmory context (used as parent of ret_req)
\param dn the DN to be deleted
\param controls an array of controls
\param context the callback function context
\param the callback function to handle the async replies
\return result code (LDB_SUCCESS on success, or a failure code)
*/
int ldb_build_del_req(struct ldb_request **ret_req,
struct ldb_context *ldb,
void *mem_ctx,
struct ldb_dn *dn,
struct ldb_control **controls,
void *context,
ldb_request_callback_t callback);
/**
Helper function to build a rename request
\param ret_req the request structure is returned here (talloced on mem_ctx)
\param ldb the context associated with the database (from ldb_init())
\param mem_ctx a talloc emmory context (used as parent of ret_req)
\param olddn the old DN
\param newdn the new DN
\param controls an array of controls
\param context the callback function context
\param the callback function to handle the async replies
\return result code (LDB_SUCCESS on success, or a failure code)
*/
int ldb_build_rename_req(struct ldb_request **ret_req,
struct ldb_context *ldb,
void *mem_ctx,
struct ldb_dn *olddn,
struct ldb_dn *newdn,
struct ldb_control **controls,
void *context,
ldb_request_callback_t callback);
/**
Search the database
This function searches the database, and returns
records that match an LDAP-like search expression
\param ldb the context associated with the database (from ldb_init())
\param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
\param scope the search scope for the query
\param expression the search expression to use for this query
\param attrs the search attributes for the query (pass NULL if none required)
\param res the return result
\return result code (LDB_SUCCESS on success, or a failure code)
\note use talloc_free() to free the ldb_result returned
*/
int ldb_search(struct ldb_context *ldb,
struct ldb_dn *base,
enum ldb_scope scope,
const char *expression,
const char * const *attrs, struct ldb_result **res);
/*
* a useful search function where you can easily define the expression and
* that takes a memory context where results are allocated
*/
int ldb_search_exp_fmt(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
struct ldb_result **result, struct ldb_dn *base,
enum ldb_scope scope, const char * const *attrs,
const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
/*
like ldb_search() but takes a parse tree
*/
int ldb_search_bytree(struct ldb_context *ldb,
struct ldb_dn *base,
enum ldb_scope scope,
struct ldb_parse_tree *tree,
const char * const *attrs, struct ldb_result **res);
/**
Add a record to the database.
This function adds a record to the database. This function will fail
if a record with the specified class and key already exists in the
database.
\param ldb the context associated with the database (from
ldb_init())
\param message the message containing the record to add.
\return result code (LDB_SUCCESS if the record was added, otherwise
a failure code)
*/
int ldb_add(struct ldb_context *ldb,
const struct ldb_message *message);
/**
Modify the specified attributes of a record
This function modifies a record that is in the database.
\param ldb the context associated with the database (from
ldb_init())
\param message the message containing the changes required.
\return result code (LDB_SUCCESS if the record was modified as
requested, otherwise a failure code)
*/
int ldb_modify(struct ldb_context *ldb,
const struct ldb_message *message);
/**
Rename a record in the database
This function renames a record in the database.
\param ldb the context associated with the database (from
ldb_init())
\param olddn the DN for the record to be renamed.
\param newdn the new DN
\return result code (LDB_SUCCESS if the record was renamed as
requested, otherwise a failure code)
*/
int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
/**
Delete a record from the database
This function deletes a record from the database.
\param ldb the context associated with the database (from
ldb_init())
\param dn the DN for the record to be deleted.
\return result code (LDB_SUCCESS if the record was deleted,
otherwise a failure code)
*/
int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
/**
start a transaction
*/
int ldb_transaction_start(struct ldb_context *ldb);
/**
commit a transaction
*/
int ldb_transaction_commit(struct ldb_context *ldb);
/**
cancel a transaction
*/
int ldb_transaction_cancel(struct ldb_context *ldb);
/**
return extended error information from the last call
*/
const char *ldb_errstring(struct ldb_context *ldb);
/**
return a string explaining what a ldb error constant meancs
*/
const char *ldb_strerror(int ldb_err);
/**
setup the default utf8 functions
FIXME: these functions do not yet handle utf8
*/
void ldb_set_utf8_default(struct ldb_context *ldb);
/**
Casefold a string
\param ldb the ldb context
\param mem_ctx the memory context to allocate the result string
memory from.
\param s the string that is to be folded
\return a copy of the string, converted to upper case
\note The default function is not yet UTF8 aware. Provide your own
set of functions through ldb_set_utf8_fns()
*/
char *ldb_casefold(struct ldb_context *ldb, void *mem_ctx, const char *s);
/**
Check the attribute name is valid according to rfc2251
\param s tthe string to check
\return 1 if the name is ok
*/
int ldb_valid_attr_name(const char *s);
/*
ldif manipulation functions
*/
/**
Write an LDIF message
This function writes an LDIF message using a caller supplied write
function.
\param ldb the ldb context (from ldb_init())
\param fprintf_fn a function pointer for the write function. This must take
a private data pointer, followed by a format string, and then a variable argument
list.
\param private_data pointer that will be provided back to the write
function. This is useful for maintaining state or context.
\param ldif the message to write out
\return the total number of bytes written, or an error code as returned
from the write function.
\sa ldb_ldif_write_file for a more convenient way to write to a
file stream.
\sa ldb_ldif_read for the reader equivalent to this function.
*/
int ldb_ldif_write(struct ldb_context *ldb,
int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
void *private_data,
const struct ldb_ldif *ldif);
/**
Clean up an LDIF message
This function cleans up a LDIF message read using ldb_ldif_read()
or related functions (such as ldb_ldif_read_string() and
ldb_ldif_read_file().
\param ldb the ldb context (from ldb_init())
\param msg the message to clean up and free
*/
void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
/**
Read an LDIF message
This function creates an LDIF message using a caller supplied read
function.
\param ldb the ldb context (from ldb_init())
\param fgetc_fn a function pointer for the read function. This must
take a private data pointer, and must return a pointer to an
integer corresponding to the next byte read (or EOF if there is no
more data to be read).
\param private_data pointer that will be provided back to the read
function. This is udeful for maintaining state or context.
\return the LDIF message that has been read in
\note You must free the LDIF message when no longer required, using
ldb_ldif_read_free().
\sa ldb_ldif_read_file for a more convenient way to read from a
file stream.
\sa ldb_ldif_read_string for a more convenient way to read from a
string (char array).
\sa ldb_ldif_write for the writer equivalent to this function.
*/
struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
int (*fgetc_fn)(void *), void *private_data);
/**
Read an LDIF message from a file
This function reads the next LDIF message from the contents of a
file stream. If you want to get all of the LDIF messages, you will
need to repeatedly call this function, until it returns NULL.
\param ldb the ldb context (from ldb_init())
\param f the file stream to read from (typically from fdopen())
\sa ldb_ldif_read_string for an equivalent function that will read
from a string (char array).
\sa ldb_ldif_write_file for the writer equivalent to this function.
*/
struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
/**
Read an LDIF message from a string
This function reads the next LDIF message from the contents of a char
array. If you want to get all of the LDIF messages, you will need
to repeatedly call this function, until it returns NULL.
\param ldb the ldb context (from ldb_init())
\param s pointer to the char array to read from
\sa ldb_ldif_read_file for an equivalent function that will read
from a file stream.
\sa ldb_ldif_write for a more general (arbitrary read function)
version of this function.
*/
struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
/**
Write an LDIF message to a file
\param ldb the ldb context (from ldb_init())
\param f the file stream to write to (typically from fdopen())
\param msg the message to write out
\return the total number of bytes written, or a negative error code
\sa ldb_ldif_read_file for the reader equivalent to this function.
*/
int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
/**
Base64 encode a buffer
\param mem_ctx the memory context that the result is allocated
from.
\param buf pointer to the array that is to be encoded
\param len the number of elements in the array to be encoded
\return pointer to an array containing the encoded data
\note The caller is responsible for freeing the result
*/
char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
/**
Base64 decode a buffer
This function decodes a base64 encoded string in place.
\param s the string to decode.
\return the length of the returned (decoded) string.
\note the string is null terminated, but the null terminator is not
included in the length.
*/
int ldb_base64_decode(char *s);
/* The following definitions come from lib/ldb/common/ldb_dn.c */
struct ldb_dn *ldb_dn_new(void *mem_ctx, struct ldb_context *ldb, const char *dn);
struct ldb_dn *ldb_dn_new_fmt(void *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
bool ldb_dn_validate(struct ldb_dn *dn);
char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
const char *ldb_dn_get_linearized(struct ldb_dn *dn);
const char *ldb_dn_get_casefold(struct ldb_dn *dn);
char *ldb_dn_alloc_linearized(void *mem_ctx, struct ldb_dn *dn);
char *ldb_dn_alloc_casefold(void *mem_ctx, struct ldb_dn *dn);
int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
struct ldb_dn *ldb_dn_copy(void *mem_ctx, struct ldb_dn *dn);
struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, struct ldb_dn *dn);
char *ldb_dn_canonical_string(void *mem_ctx, struct ldb_dn *dn);
char *ldb_dn_canonical_ex_string(void *mem_ctx, struct ldb_dn *dn);
int ldb_dn_get_comp_num(struct ldb_dn *dn);
const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
bool ldb_dn_is_valid(struct ldb_dn *dn);
bool ldb_dn_is_special(struct ldb_dn *dn);
bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
bool ldb_dn_is_null(struct ldb_dn *dn);
/* useful functions for ldb_message structure manipulation */
int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
/**
Compare two attributes
This function compares to attribute names. Note that this is a
case-insensitive comparison.
\param attr1 the first attribute name to compare
\param attr2 the second attribute name to compare
\return 0 if the attribute names are the same, or only differ in
case; non-zero if there are any differences
attribute names are restricted by rfc2251 so using
strcasecmp and toupper here is ok.
return 0 for match
*/
#define ldb_attr_cmp(a, b) strcasecmp(a, b)
char *ldb_attr_casefold(void *mem_ctx, const char *s);
int ldb_attr_dn(const char *attr);
/**
Create an empty message
\param mem_ctx the memory context to create in. You can pass NULL
to get the top level context, however the ldb context (from
ldb_init()) may be a better choice
*/
struct ldb_message *ldb_msg_new(void *mem_ctx);
/**
Find an element within an message
*/
struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
const char *attr_name);
/**
Compare two ldb_val values
\param v1 first ldb_val structure to be tested
\param v2 second ldb_val structure to be tested
\return 1 for a match, 0 if there is any difference
*/
int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
/**
find a value within an ldb_message_element
\param el the element to search
\param val the value to search for
\note This search is case sensitive
*/
struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
struct ldb_val *val);
/**
add a new empty element to a ldb_message
*/
int ldb_msg_add_empty(struct ldb_message *msg,
const char *attr_name,
int flags,
struct ldb_message_element **return_el);
/**
add a element to a ldb_message
*/
int ldb_msg_add(struct ldb_message *msg,
const struct ldb_message_element *el,
int flags);
int ldb_msg_add_value(struct ldb_message *msg,
const char *attr_name,
const struct ldb_val *val,
struct ldb_message_element **return_el);
int ldb_msg_add_steal_value(struct ldb_message *msg,
const char *attr_name,
struct ldb_val *val);
int ldb_msg_add_steal_string(struct ldb_message *msg,
const char *attr_name, char *str);
int ldb_msg_add_string(struct ldb_message *msg,
const char *attr_name, const char *str);
int ldb_msg_add_fmt(struct ldb_message *msg,
const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
/**
compare two message elements - return 0 on match
*/
int ldb_msg_element_compare(struct ldb_message_element *el1,
struct ldb_message_element *el2);
/**
Find elements in a message.
This function finds elements and converts to a specific type, with
a give default value if not found. Assumes that elements are
single valued.
*/
const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
const char *attr_name,
int default_value);
unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
const char *attr_name,
unsigned int default_value);
int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
const char *attr_name,
int64_t default_value);
uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
const char *attr_name,
uint64_t default_value);
double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
const char *attr_name,
double default_value);
int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
const char *attr_name,
int default_value);
const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
const char *attr_name,
const char *default_value);
struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
void *mem_ctx,
const struct ldb_message *msg,
const char *attr_name);
void ldb_msg_sort_elements(struct ldb_message *msg);
struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx,
const struct ldb_message *msg);
struct ldb_message *ldb_msg_copy(void *mem_ctx,
const struct ldb_message *msg);
struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
const struct ldb_message *msg);
struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
struct ldb_message *msg1,
struct ldb_message *msg2);
int ldb_msg_check_string_attribute(const struct ldb_message *msg,
const char *name,
const char *value);
/**
Integrity check an ldb_message
This function performs basic sanity / integrity checks on an
ldb_message.
\param msg the message to check
\return LDB_SUCCESS if the message is OK, or a non-zero error code
(one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
message.
*/
int ldb_msg_sanity_check(struct ldb_context *ldb,
const struct ldb_message *msg);
/**
Duplicate an ldb_val structure
This function copies an ldb value structure.
\param mem_ctx the memory context that the duplicated value will be
allocated from
\param v the ldb_val to be duplicated.
\return the duplicated ldb_val structure.
*/
struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
/**
this allows the user to set a debug function for error reporting
*/
int ldb_set_debug(struct ldb_context *ldb,
void (*debug)(void *context, enum ldb_debug_level level,
const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
void *context);
/**
this allows the user to set custom utf8 function for error reporting
*/
void ldb_set_utf8_fns(struct ldb_context *ldb,
void *context,
char *(*casefold)(void *, void *, const char *));
/**
this sets up debug to print messages on stderr
*/
int ldb_set_debug_stderr(struct ldb_context *ldb);
/* control backend specific opaque values */
int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
const char **ldb_attr_list_copy_add(void *mem_ctx, const char * const *attrs, const char *new_attr);
int ldb_attr_in_list(const char * const *attrs, const char *attr);
void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
const char *attr,
const char *replace);
int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
/**
Convert a time structure to a string
This function converts a time_t structure to an LDAP formatted
GeneralizedTime string.
\param mem_ctx the memory context to allocate the return string in
\param t the time structure to convert
\return the formatted string, or NULL if the time structure could
not be converted
*/
char *ldb_timestring(void *mem_ctx, time_t t);
/**
Convert a string to a time structure
This function converts an LDAP formatted GeneralizedTime string
to a time_t structure.
\param s the string to convert
\return the time structure, or 0 if the string cannot be converted
*/
time_t ldb_string_to_time(const char *s);
/**
Convert a time structure to a string
This function converts a time_t structure to an LDAP formatted
UTCTime string.
\param mem_ctx the memory context to allocate the return string in
\param t the time structure to convert
\return the formatted string, or NULL if the time structure could
not be converted
*/
char *ldb_timestring_utc(void *mem_ctx, time_t t);
/**
Convert a string to a time structure
This function converts an LDAP formatted UTCTime string
to a time_t structure.
\param s the string to convert
\return the time structure, or 0 if the string cannot be converted
*/
time_t ldb_string_utc_to_time(const char *s);
void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
#endif
|