1 /*
2 * Tests exercising the ldb match operations.
3 *
4 *
5 * Copyright (C) Catalyst.NET Ltd 2017
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22 /*
23 * from cmocka.c:
24 * These headers or their equivalents should be included prior to
25 * including
26 * this header file.
27 *
28 * #include <stdarg.h>
29 * #include <stddef.h>
30 * #include <setjmp.h>
31 *
32 * This allows test applications to use custom definitions of C standard
33 * library functions and types.
34 */
35 #include <stdarg.h>
36 #include <stddef.h>
37 #include <stdint.h>
38 #include <setjmp.h>
39 #include <cmocka.h>
40
41 #include "../common/ldb_match.c"
42
43 #include "../include/ldb.h"
44
45 struct ldbtest_ctx {
46 struct tevent_context *ev;
47 struct ldb_context *ldb;
48 };
49
ldb_test_canonicalise(struct ldb_context * ldb,void * mem_ctx,const struct ldb_val * in,struct ldb_val * out)50 static int ldb_test_canonicalise(
51 struct ldb_context *ldb,
52 void *mem_ctx,
53 const struct ldb_val *in,
54 struct ldb_val *out)
55 {
56 out->length = in->length;
57 out->data = in->data;
58 return 0;
59 }
60
setup(void ** state)61 static int setup(void **state)
62 {
63 struct ldbtest_ctx *test_ctx;
64 struct ldb_schema_syntax *syntax = NULL;
65 int ret;
66
67 test_ctx = talloc_zero(NULL, struct ldbtest_ctx);
68 assert_non_null(test_ctx);
69
70 test_ctx->ev = tevent_context_init(test_ctx);
71 assert_non_null(test_ctx->ev);
72
73 test_ctx->ldb = ldb_init(test_ctx, test_ctx->ev);
74 assert_non_null(test_ctx->ldb);
75
76 syntax = talloc_zero(test_ctx, struct ldb_schema_syntax);
77 assert_non_null(syntax);
78 syntax->canonicalise_fn = ldb_test_canonicalise;
79
80 ret = ldb_schema_attribute_add_with_syntax(
81 test_ctx->ldb, "a", LDB_ATTR_FLAG_FIXED, syntax);
82 assert_int_equal(LDB_SUCCESS, ret);
83
84 *state = test_ctx;
85 return 0;
86 }
87
teardown(void ** state)88 static int teardown(void **state)
89 {
90 talloc_free(*state);
91 return 0;
92 }
93
escape_string(uint8_t * buf,size_t buflen,const uint8_t * s,size_t len)94 static void escape_string(uint8_t *buf, size_t buflen,
95 const uint8_t *s, size_t len)
96 {
97 size_t i;
98 size_t j = 0;
99 for (i = 0; i < len; i++) {
100 if (j == buflen - 1) {
101 goto fin;
102 }
103 if (s[i] >= 0x20) {
104 buf[j] = s[i];
105 j++;
106 } else {
107 if (j >= buflen - 4) {
108 goto fin;
109 }
110 /* utf-8 control char representation */
111 buf[j] = 0xE2;
112 buf[j + 1] = 0x90;
113 buf[j + 2] = 0x80 + s[i];
114 j+= 3;
115 }
116 }
117 fin:
118 buf[j] = 0;
119 }
120
121
122 /*
123 * The wild card pattern "attribute=*" is parsed as an LDB_OP_PRESENT operation
124 * rather than a LDB_OP_????
125 *
126 * This test serves to document that behaviour, and to confirm that
127 * ldb_wildcard_compare handles this case appropriately.
128 */
test_wildcard_match_star(void ** state)129 static void test_wildcard_match_star(void **state)
130 {
131 struct ldbtest_ctx *ctx = *state;
132 bool matched = false;
133 int ret;
134
135 uint8_t value[] = "The value.......end";
136 struct ldb_val val = {
137 .data = value,
138 .length = (sizeof(value))
139 };
140 struct ldb_parse_tree *tree = ldb_parse_tree(ctx, "a=*");
141 assert_non_null(tree);
142
143 ret = ldb_wildcard_compare(ctx->ldb, tree, val, &matched);
144 assert_false(matched);
145 assert_int_equal(LDB_ERR_INAPPROPRIATE_MATCHING, ret);
146 }
147
148 /*
149 * Test basic wild card matching
150 *
151 */
152 struct wildcard_test {
153 uint8_t *val;
154 size_t val_size;
155 const char *search;
156 bool should_match;
157 bool fold;
158 };
159
160 /*
161 * Q: Why this macro rather than plain struct values?
162 * A: So we can get the size of the const char[] value while it is still a
163 * true array, not a pointer.
164 *
165 * Q: but why not just use strlen?
166 * A: so values can contain '\0', which we supposedly allow.
167 */
168
169 #define TEST_ENTRY(val, search, should_match, fold) \
170 { \
171 (uint8_t*)discard_const(val), \
172 sizeof(val) - 1, \
173 search, \
174 should_match, \
175 fold \
176 }
177
test_wildcard_match(void ** state)178 static void test_wildcard_match(void **state)
179 {
180 struct ldbtest_ctx *ctx = *state;
181 size_t failed = 0;
182 size_t i;
183 struct wildcard_test tests[] = {
184 TEST_ENTRY(" 1 0", "1*0*", true, true),
185 TEST_ENTRY(" 1 0", "1 *0", true, true),
186 TEST_ENTRY("The value.......end", "*end", true, true),
187 TEST_ENTRY("The value.......end", "*fend", false, true),
188 TEST_ENTRY("The value.......end", "*eel", false, true),
189 TEST_ENTRY("The value.......end", "*d", true, true),
190 TEST_ENTRY("The value.......end", "*D*", true, true),
191 TEST_ENTRY("The value.......end", "*e*d*", true, true),
192 TEST_ENTRY("end", "*e*d*", true, true),
193 TEST_ENTRY("end", " *e*d*", true, true),
194 TEST_ENTRY("1.0..0.0.0.0.0.0.0aAaaaAAAAAAA", "*a", true, true),
195 TEST_ENTRY("1.0.0.0.0.0.0.0.0.0.0aaaa", "*aaaaa", false, true),
196 TEST_ENTRY("1.0.0.0.0.0.0.0.0.0.0", "*0.0", true, true),
197 TEST_ENTRY("1.0.0.0.0.0.0.0.0.0", "1*0*0*0*0*0*0*0*0*0", true,
198 true),
199 TEST_ENTRY("1.0.0.0.0.0.0.0.0", "1*0*0*0*0*0*0*0*0*0", false,
200 true),
201 TEST_ENTRY("1.0.0.0.000.0.0.0.0", "1*0*0*0*0*0*0*0*0*0", true,
202 true),
203 TEST_ENTRY("1\n0\r0\t000.0.0.0.0", "1*0*0*0*0*0*0*0*0", true,
204 true),
205 /*
206 * We allow NUL bytes and redundant spaces in non-casefolding
207 * syntaxes.
208 */
209 TEST_ENTRY(" 1 0", "*1 0", true, false),
210 TEST_ENTRY(" 1 0", "*1 0", true, false),
211 TEST_ENTRY("1 0", "*1 0", false, false),
212 TEST_ENTRY("1\x00 x", "1*x", true, false),
213 TEST_ENTRY("1\x00 x", "*x", true, false),
214 TEST_ENTRY("1\x00 x", "*x*", true, false),
215 TEST_ENTRY("1\x00 x", "* *", true, false),
216 TEST_ENTRY("1\x00 x", "1*", true, false),
217 TEST_ENTRY("1\x00 b* x", "1*b*", true, false),
218 TEST_ENTRY("1.0..0.0.0.0.0.0.0aAaaaAAAAAAA", "*a", false, false),
219 };
220
221 for (i = 0; i < ARRAY_SIZE(tests); i++) {
222 bool matched;
223 int ret;
224 struct ldb_val val = {
225 .data = (uint8_t *)tests[i].val,
226 .length = tests[i].val_size
227 };
228 const char *attr = tests[i].fold ? "objectclass" : "birthLocation";
229 const char *s = talloc_asprintf(ctx, "%s=%s",
230 attr, tests[i].search);
231 struct ldb_parse_tree *tree = ldb_parse_tree(ctx, s);
232 assert_non_null(tree);
233 ret = ldb_wildcard_compare(ctx->ldb, tree, val, &matched);
234 if (ret != LDB_SUCCESS) {
235 uint8_t buf[100];
236 escape_string(buf, sizeof(buf),
237 tests[i].val, tests[i].val_size);
238 print_error("%zu val: «%s», search «%s» FAILED with %d\n",
239 i, buf, tests[i].search, ret);
240 failed++;
241 }
242 if (matched != tests[i].should_match) {
243 uint8_t buf[100];
244 escape_string(buf, sizeof(buf),
245 tests[i].val, tests[i].val_size);
246 print_error("%zu val: «%s», search «%s» should %s\n",
247 i, buf, tests[i].search,
248 matched ? "not match" : "match");
249 failed++;
250 }
251 }
252 if (failed != 0) {
253 fail_msg("wrong results for %zu/%zu wildcard searches\n",
254 failed, ARRAY_SIZE(tests));
255 }
256 }
257
258 #undef TEST_ENTRY
259
260
261 /*
262 * ldb_handler_copy and ldb_val_dup over allocate by one and add a trailing '\0'
263 * to the data, to make them safe to use the C string functions on.
264 *
265 * However testing for the trailing '\0' is not the correct way to test for
266 * the end of a value, the length should be checked instead.
267 */
test_wildcard_match_end_condition(void ** state)268 static void test_wildcard_match_end_condition(void **state)
269 {
270 struct ldbtest_ctx *ctx = *state;
271 bool matched = false;
272
273 uint8_t value[] = "hellomynameisbobx";
274 struct ldb_val val = {
275 .data = talloc_memdup(NULL, value, sizeof(value)),
276 .length = (sizeof(value) - 2)
277 };
278 struct ldb_parse_tree *tree = ldb_parse_tree(ctx, "a=*hello*mynameis*bob");
279 assert_non_null(tree);
280
281 ldb_wildcard_compare(ctx->ldb, tree, val, &matched);
282 assert_true(matched);
283 }
284
285 /*
286 * Note: to run under valgrind use:
287 * valgrind \
288 * --suppressions=lib/ldb/tests/ldb_match_test.valgrind \
289 * bin/ldb_match_test
290 */
main(int argc,const char ** argv)291 int main(int argc, const char **argv)
292 {
293 const struct CMUnitTest tests[] = {
294 cmocka_unit_test_setup_teardown(
295 test_wildcard_match_star,
296 setup,
297 teardown),
298 cmocka_unit_test_setup_teardown(
299 test_wildcard_match,
300 setup,
301 teardown),
302 cmocka_unit_test_setup_teardown(
303 test_wildcard_match_end_condition,
304 setup,
305 teardown),
306 };
307
308 return cmocka_run_group_tests(tests, NULL, NULL);
309 }
310