2 * Test for the Heimdal shared module API.
4 * Written by Russ Allbery <eagle@eyrie.org>
5 * Copyright 2009, 2013-2014
6 * The Board of Trustees of the Leland Stanford Junior University
8 * SPDX-License-Identifier: MIT
12 #include <portable/krb5.h>
13 #include <portable/system.h>
17 #ifdef HAVE_KADM5_KADM5_PWCHECK_H
18 # include <kadm5/kadm5-pwcheck.h>
21 #include <tests/tap/basic.h>
22 #include <tests/tap/kerberos.h>
23 #include <tests/tap/process.h>
24 #include <tests/tap/string.h>
25 #include <util/macros.h>
28 * The password test data, generated from the JSON source. Defines arrays
29 * named *_tests, where * is the file name without the ".c" suffix.
31 #include <tests/data/passwords/cdb.c>
32 #include <tests/data/passwords/classes.c>
33 #include <tests/data/passwords/cracklib.c>
34 #include <tests/data/passwords/length.c>
35 #include <tests/data/passwords/letter.c>
36 #include <tests/data/passwords/principal.c>
37 #include <tests/data/passwords/sqlite.c>
40 #ifndef HAVE_KADM5_KADM5_PWCHECK_H
42 * If we're not building with Heimdal, we can't run this test and much of the
43 * test won't even compile. Replace this test with a small program that just
49 skip_all("not built against Heimdal libraries");
56 * Loads the Heimdal password change plugin and tests that its metadata is
57 * correct. Returns a pointer to the kadm5_pw_policy_verifier struct or bails
58 * on failure to load the plugin. Stores the handle in the last argument so
59 * that the caller can free the handle at the end of the test suite.
61 static struct kadm5_pw_policy_verifier *
62 load_plugin(void **handle)
65 struct kadm5_pw_policy_verifier *verifier;
67 /* Load the module. */
68 path = test_file_path("../plugin/.libs/strength.so");
70 bail("cannot find plugin");
71 *handle = dlopen(path, RTLD_NOW);
73 bail("cannot dlopen %s: %s", path, dlerror());
74 test_file_path_free(path);
76 /* Find the dispatch table and do a basic sanity check. */
77 verifier = dlsym(*handle, "kadm5_password_verifier");
79 bail("cannot get kadm5_password_verifier symbol: %s", dlerror());
80 if (verifier->funcs == NULL || verifier->funcs[0].func == NULL)
81 bail("no verifier functions in module");
83 /* Verify the metadata. */
84 is_string("krb5-strength", verifier->name, "Module name");
85 is_string("Russ Allbery", verifier->vendor, "Module vendor");
86 is_int(KADM5_PASSWD_VERSION_V1, verifier->version, "Module version");
87 is_string("krb5-strength", verifier->funcs[0].name,
88 "Module function name");
89 ok(verifier->funcs[1].name == NULL, "Only one function in module");
91 /* Return the dispatch table. */
97 * Given the dispatch table and a test case, call out to the password strength
98 * checking module and check the results.
101 is_password_test(const struct kadm5_pw_policy_verifier *verifier,
102 const struct password_test *test)
105 krb5_principal princ;
106 krb5_error_code code;
109 char error[BUFSIZ] = "";
111 /* Obtain a Kerberos context to use for parsing principal names. */
112 code = krb5_init_context(&ctx);
114 bail_krb5(ctx, code, "cannot initialize Kerberos context");
116 /* Translate the test data into the form that the verifier expects. */
117 code = krb5_parse_name(ctx, test->principal, &princ);
119 bail_krb5(ctx, code, "cannot parse principal %s", test->principal);
120 password.data = (char *) test->password;
121 password.length = strlen(test->password);
123 /* Call the verifier. */
124 result = (verifier->funcs[0].func)(ctx, princ, &password, NULL, error,
127 /* Heimdal only returns 0 or 1, so translate the expected code. */
128 is_int(test->code == 0 ? 0 : 1, result, "%s (status)", test->name);
129 is_string(test->error == NULL ? "" : test->error, error, "%s (error)",
132 /* Free data structures. */
133 krb5_free_principal(ctx, princ);
134 krb5_free_context(ctx);
141 char *path, *krb5_config, *krb5_config_empty, *tmpdir;
142 char *setup_argv[12];
144 struct kadm5_pw_policy_verifier *verifier;
148 * Calculate how many tests we have. There are five tests for the module
149 * metadata and two tests per password test. We run the principal tests
150 * three times, once each with CrackLib, CDB, and SQLite.
152 count = ARRAY_SIZE(cracklib_tests);
153 count += 2 * ARRAY_SIZE(length_tests);
154 count += ARRAY_SIZE(cdb_tests);
155 count += ARRAY_SIZE(sqlite_tests);
156 count += ARRAY_SIZE(classes_tests);
157 count += ARRAY_SIZE(letter_tests);
158 count += ARRAY_SIZE(principal_tests) * 3;
161 /* Start with the krb5.conf that contains no dictionary configuration. */
162 path = test_file_path("data/krb5.conf");
164 bail("cannot find data/krb5.conf in the test suite");
165 basprintf(&krb5_config_empty, "KRB5_CONFIG=%s", path);
166 putenv(krb5_config_empty);
168 /* Load the plugin. */
169 verifier = load_plugin(&handle);
171 /* Set up our krb5.conf with a basic configuration. */
172 setup_argv[0] = test_file_path("data/make-krb5-conf");
173 if (setup_argv[0] == NULL)
174 bail("cannot find data/make-krb5-conf in the test suite");
175 tmpdir = test_tmpdir();
176 setup_argv[1] = path;
177 setup_argv[2] = tmpdir;
178 setup_argv[3] = NULL;
179 run_setup((const char **) setup_argv);
181 /* Point KRB5_CONFIG at the newly-generated krb5.conf file. */
182 basprintf(&krb5_config, "KRB5_CONFIG=%s/krb5.conf", tmpdir);
184 free(krb5_config_empty);
186 /* Run principal tests. */
187 for (i = 0; i < ARRAY_SIZE(principal_tests); i++)
188 is_password_test(verifier, &principal_tests[i]);
190 # ifdef HAVE_CRACKLIB
192 /* Add CrackLib tests. */
193 setup_argv[3] = (char *) "password_dictionary";
194 basprintf(&setup_argv[4], "%s/data/dictionary", getenv("BUILD"));
195 setup_argv[5] = NULL;
196 run_setup((const char **) setup_argv);
198 /* Now, run all of the tests. */
199 for (i = 0; i < ARRAY_SIZE(cracklib_tests); i++)
200 is_password_test(verifier, &cracklib_tests[i]);
203 * Add length restrictions and a maximum length for CrackLib. This should
204 * reject passwords as too short, but let through a password that's
205 * actually in the CrackLib dictionary.
207 setup_argv[5] = (char *) "minimum_length";
208 setup_argv[6] = (char *) "12";
209 setup_argv[7] = (char *) "cracklib_maxlen";
210 setup_argv[8] = (char *) "11";
211 setup_argv[9] = NULL;
212 run_setup((const char **) setup_argv);
214 /* Run the length tests. */
215 for (i = 0; i < ARRAY_SIZE(length_tests); i++)
216 is_password_test(verifier, &length_tests[i]);
218 /* Free the memory allocated for the CrackLib test. */
223 /* Otherwise, mark the CrackLib tests as skipped. */
224 count = ARRAY_SIZE(cracklib_tests) + ARRAY_SIZE(length_tests);
225 skip_block(count * 2, "not built with CDB support");
227 # endif /* !HAVE_CRACKLIB */
229 /* Add simple character class restrictions. */
230 setup_argv[3] = (char *) "minimum_different";
231 setup_argv[4] = (char *) "8";
232 setup_argv[5] = (char *) "require_ascii_printable";
233 setup_argv[6] = (char *) "true";
234 setup_argv[7] = (char *) "require_non_letter";
235 setup_argv[8] = (char *) "true";
236 setup_argv[9] = NULL;
237 run_setup((const char **) setup_argv);
239 /* Run the simple character class tests. */
240 for (i = 0; i < ARRAY_SIZE(letter_tests); i++)
241 is_password_test(verifier, &letter_tests[i]);
243 /* Add complex character class restrictions and remove the dictionary. */
244 setup_argv[3] = (char *) "require_classes";
245 setup_argv[4] = (char *) "8-19:lower,upper 8-15:digit 8-11:symbol 24-24:3";
246 setup_argv[5] = NULL;
247 run_setup((const char **) setup_argv);
249 /* Run the simple character class tests. */
250 for (i = 0; i < ARRAY_SIZE(classes_tests); i++)
251 is_password_test(verifier, &classes_tests[i]);
253 /* Try the length checks again with no dictionary at all. */
254 setup_argv[3] = (char *) "minimum_length";
255 setup_argv[4] = (char *) "12";
256 setup_argv[5] = NULL;
257 run_setup((const char **) setup_argv);
259 /* Run the length tests. */
260 for (i = 0; i < ARRAY_SIZE(length_tests); i++)
261 is_password_test(verifier, &length_tests[i]);
265 /* If built with CDB, set up krb5.conf to use a CDB dictionary instead. */
266 setup_argv[3] = (char *) "password_dictionary_cdb";
267 setup_argv[4] = test_file_path("data/wordlist.cdb");
268 if (setup_argv[4] == NULL)
269 bail("cannot find data/wordlist.cdb in the test suite");
270 setup_argv[5] = NULL;
271 run_setup((const char **) setup_argv);
272 test_file_path_free(setup_argv[4]);
274 /* Run the CDB tests. */
275 for (i = 0; i < ARRAY_SIZE(cdb_tests); i++)
276 is_password_test(verifier, &cdb_tests[i]);
277 for (i = 0; i < ARRAY_SIZE(principal_tests); i++)
278 is_password_test(verifier, &principal_tests[i]);
280 # else /* !HAVE_CDB */
282 /* Otherwise, mark the CDB tests as skipped. */
283 count = ARRAY_SIZE(cdb_tests) + ARRAY_SIZE(principal_tests);
284 skip_block(count * 2, "not built with CDB support");
286 # endif /* !HAVE_CDB */
291 * If built with SQLite, set up krb5.conf to use a SQLite dictionary
294 setup_argv[3] = (char *) "password_dictionary_sqlite";
295 setup_argv[4] = test_file_path("data/wordlist.sqlite");
296 if (setup_argv[4] == NULL)
297 bail("cannot find data/wordlist.sqlite in the test suite");
298 setup_argv[5] = NULL;
299 run_setup((const char **) setup_argv);
300 test_file_path_free(setup_argv[0]);
301 test_file_path_free(setup_argv[4]);
302 test_file_path_free(path);
304 /* Run the SQLite tests. */
305 for (i = 0; i < ARRAY_SIZE(sqlite_tests); i++)
306 is_password_test(verifier, &sqlite_tests[i]);
307 for (i = 0; i < ARRAY_SIZE(principal_tests); i++)
308 is_password_test(verifier, &principal_tests[i]);
310 # else /* !HAVE_SQLITE */
312 /* Otherwise, mark the SQLite tests as skipped. */
313 count = ARRAY_SIZE(sqlite_tests) + ARRAY_SIZE(principal_tests);
314 skip_block(count * 2, "not built with SQLite support");
316 # endif /* !HAVE_SQLITE */
318 /* Manually clean up after the results of make-krb5-conf. */
319 basprintf(&path, "%s/krb5.conf", tmpdir);
322 test_tmpdir_free(tmpdir);
324 /* Close down the module. */
325 if (dlclose(handle) != 0)
326 bail("cannot close plugin: %s", dlerror());
328 /* Keep valgrind clean by freeing environmental memory. */
329 putenv((char *) "KRB5_CONFIG=");
334 #endif /* HAVE_KADM5_KADM5_PWCHECK_H */