Implement support for registering and calling pinfile callbacks

 * These are callbacks that hanlde the pinfile part of a PKCS#11 URI.
 * One library can register a callback that another can then call
   in a thread-safe and simple fashion.

3 files changed, 507 insertions, 1 deletions

diff --git a/tests/Makefile.am b/tests/Makefile.am
index 6b988b8..cde804f 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -8,22 +8,32 @@ INCLUDES = \
 
 noinst_PROGRAMS = \
 	hash-test \
+	ptr-array-test \
 	conf-test \
-	uri-test
+	uri-test \
+	pin-test
 
 hash_test_LDADD = \
 	$(top_builddir)/p11-kit/libp11-kit-testable.la
 
+ptr_array_test_LDADD = \
+	$(top_builddir)/p11-kit/libp11-kit-testable.la
+
 conf_test_LDADD = \
 	$(top_builddir)/p11-kit/libp11-kit-testable.la
 
 uri_test_LDADD = \
 	$(top_builddir)/p11-kit/libp11-kit-testable.la
 
+pin_test_LDADD = \
+	$(top_builddir)/p11-kit/libp11-kit-testable.la
+
 check-am:
 	./hash-test
+	./ptr-array-test
 	./conf-test
 	./uri-test
+	./pin-test
 
 EXTRA_DIST = \
 	cutest \
diff --git a/tests/pin-test.c b/tests/pin-test.c
new file mode 100644
index 0000000..7f1bc08
--- /dev/null
+++ b/tests/pin-test.c
@@ -0,0 +1,237 @@
+/*
+ * Copyright (c) 2011, Collabora Ltd.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *     * Redistributions of source code must retain the above
+ *       copyright notice, this list of conditions and the
+ *       following disclaimer.
+ *     * Redistributions in binary form must reproduce the
+ *       above copyright notice, this list of conditions and
+ *       the following disclaimer in the documentation and/or
+ *       other materials provided with the distribution.
+ *     * The names of contributors to this software may not be
+ *       used to endorse or promote products derived from this
+ *       software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+ * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+ * DAMAGE.
+ *
+ * Author: Stef Walter <stefw@collabora.co.uk>
+ */
+
+#include "config.h"
+#include "CuTest.h"
+
+#include <assert.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+
+#include "p11-kit/pin.h"
+
+static int
+callback_one (const char *pinfile, P11KitUri *pin_uri, const char *pin_description,
+              P11KitPinFlags pin_flags, void *callback_data, char *pin,
+              size_t pin_max)
+{
+	int *data = callback_data;
+	assert (*data == 33);
+	strncpy (pin, "one", pin_max);
+	return 1;
+}
+
+static int
+callback_other (const char *pinfile, P11KitUri *pin_uri, const char *pin_description,
+                P11KitPinFlags pin_flags, void *callback_data, char *pin,
+                size_t pin_max)
+{
+	char *data = callback_data;
+	strncpy (pin, data, pin_max);
+	return 1;
+}
+
+static void
+destroy_data (void *callback_data)
+{
+	int *data = callback_data;
+	(*data)++;
+}
+
+static void
+test_pin_register_unregister (CuTest *tc)
+{
+	int data = 33;
+
+	p11_kit_pin_register_callback ("/the/pinfile", callback_one,
+	                               &data, destroy_data);
+
+	p11_kit_pin_unregister_callback ("/the/pinfile", callback_one,
+	                                 &data);
+
+	CuAssertIntEquals (tc, 34, data);
+}
+
+static void
+test_pin_read (CuTest *tc)
+{
+	P11KitUri *uri;
+	char buffer[256];
+	int data = 33;
+	int ret;
+
+	p11_kit_pin_register_callback ("/the/pinfile", callback_one,
+	                               &data, destroy_data);
+
+	uri = p11_kit_uri_new ();
+	ret = p11_kit_pin_read_pinfile ("/the/pinfile", uri, "The token",
+	                                P11_KIT_PIN_FLAGS_USER_LOGIN,
+	                                buffer, sizeof (buffer));
+	p11_kit_uri_free (uri);
+
+	CuAssertIntEquals (tc, 1, ret);
+	CuAssertStrEquals (tc, "one", buffer);
+
+	p11_kit_pin_unregister_callback ("/the/pinfile", callback_one,
+	                                 &data);
+}
+
+static void
+test_pin_read_no_match (CuTest *tc)
+{
+	P11KitUri *uri;
+	char buffer[256];
+	int ret;
+
+	uri = p11_kit_uri_new ();
+	ret = p11_kit_pin_read_pinfile ("/the/pinfile", uri, "The token",
+	                                P11_KIT_PIN_FLAGS_USER_LOGIN,
+	                                buffer, sizeof (buffer));
+	p11_kit_uri_free (uri);
+
+	CuAssertIntEquals (tc, 0, ret);
+}
+
+static void
+test_pin_register_duplicate (CuTest *tc)
+{
+	P11KitUri *uri;
+	char *value = "secret";
+	char buffer[256];
+	int data = 33;
+	int ret;
+
+	uri = p11_kit_uri_new ();
+
+	p11_kit_pin_register_callback ("/the/pinfile", callback_one,
+	                               &data, destroy_data);
+
+	p11_kit_pin_register_callback ("/the/pinfile", callback_other,
+	                               value, NULL);
+
+	ret = p11_kit_pin_read_pinfile ("/the/pinfile", uri, "The token",
+	                                P11_KIT_PIN_FLAGS_USER_LOGIN,
+	                                buffer, sizeof (buffer));
+
+	CuAssertIntEquals (tc, 1, ret);
+	CuAssertStrEquals (tc, "secret", buffer);
+
+	p11_kit_pin_unregister_callback ("/the/pinfile", callback_other,
+	                                 value);
+
+	ret = p11_kit_pin_read_pinfile ("/the/pinfile", uri, "The token",
+	                                P11_KIT_PIN_FLAGS_USER_LOGIN,
+	                                buffer, sizeof (buffer));
+
+	CuAssertIntEquals (tc, 1, ret);
+	CuAssertStrEquals (tc, "one", buffer);
+
+	p11_kit_pin_unregister_callback ("/the/pinfile", callback_one,
+	                                 &data);
+
+	ret = p11_kit_pin_read_pinfile ("/the/pinfile", uri, "The token",
+	                                P11_KIT_PIN_FLAGS_USER_LOGIN,
+	                                buffer, sizeof (buffer));
+
+	CuAssertIntEquals (tc, 0, ret);
+
+	p11_kit_uri_free (uri);
+}
+
+static void
+test_pin_register_fallback (CuTest *tc)
+{
+	char *value = "secret";
+	P11KitUri *uri;
+	char buffer[256];
+	int data = 33;
+	int ret;
+
+	uri = p11_kit_uri_new ();
+
+	p11_kit_pin_register_callback (P11_KIT_PIN_FALLBACK, callback_one,
+	                               &data, destroy_data);
+
+	ret = p11_kit_pin_read_pinfile ("/the/pinfile", uri, "The token",
+	                                P11_KIT_PIN_FLAGS_USER_LOGIN,
+	                                buffer, sizeof (buffer));
+
+	CuAssertIntEquals (tc, 1, ret);
+	CuAssertStrEquals (tc, "one", buffer);
+
+	p11_kit_pin_register_callback ("/the/pinfile", callback_other,
+	                               value, NULL);
+
+	ret = p11_kit_pin_read_pinfile ("/the/pinfile", uri, "The token",
+	                                P11_KIT_PIN_FLAGS_USER_LOGIN,
+	                                buffer, sizeof (buffer));
+
+	CuAssertIntEquals (tc, 1, ret);
+	CuAssertStrEquals (tc, "secret", buffer);
+
+	p11_kit_pin_unregister_callback ("/the/pinfile", callback_other,
+	                                 value);
+
+	p11_kit_pin_unregister_callback (P11_KIT_PIN_FALLBACK, callback_one,
+	                                 &data);
+
+	p11_kit_uri_free (uri);
+}
+
+int
+main (void)
+{
+	CuString *output = CuStringNew ();
+	CuSuite* suite = CuSuiteNew ();
+	int ret;
+
+	SUITE_ADD_TEST (suite, test_pin_register_unregister);
+	SUITE_ADD_TEST (suite, test_pin_read);
+	SUITE_ADD_TEST (suite, test_pin_read_no_match);
+	SUITE_ADD_TEST (suite, test_pin_register_duplicate);
+	SUITE_ADD_TEST (suite, test_pin_register_fallback);
+
+	CuSuiteRun (suite);
+	CuSuiteSummary (suite, output);
+	CuSuiteDetails (suite, output);
+	printf ("%s\n", output->buffer);
+	ret = suite->failCount;
+	CuSuiteDelete (suite);
+	CuStringDelete (output);
+
+	return ret;
+}
+
+#include "CuTest.c"
diff --git a/tests/ptr-array-test.c b/tests/ptr-array-test.c
new file mode 100644
index 0000000..ff9959d
--- /dev/null
+++ b/tests/ptr-array-test.c
@@ -0,0 +1,259 @@
+/*
+ * Copyright (c) 2011, Collabora Ltd.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *     * Redistributions of source code must retain the above
+ *       copyright notice, this list of conditions and the
+ *       following disclaimer.
+ *     * Redistributions in binary form must reproduce the
+ *       above copyright notice, this list of conditions and
+ *       the following disclaimer in the documentation and/or
+ *       other materials provided with the distribution.
+ *     * The names of contributors to this software may not be
+ *       used to endorse or promote products derived from this
+ *       software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+ * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+ * DAMAGE.
+ *
+ * Author: Stef Walter <stefw@collabora.co.uk>
+ */
+
+#include "config.h"
+#include "CuTest.h"
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+
+#include "ptr-array.h"
+
+static void
+test_ptr_array_create (CuTest *tc)
+{
+	ptr_array_t *array;
+
+	array = ptr_array_create (NULL);
+	CuAssertPtrNotNull (tc, array);
+	ptr_array_free (array);
+}
+
+static void
+test_ptr_array_free_null (CuTest *tc)
+{
+	ptr_array_free (NULL);
+}
+
+static void
+destroy_value (void *data)
+{
+	int *value = data;
+	*value = 2;
+}
+
+static void
+test_ptr_array_free_destroys (CuTest *tc)
+{
+	ptr_array_t *array;
+	int value = 0;
+
+	array = ptr_array_create (destroy_value);
+	CuAssertPtrNotNull (tc, array);
+	if (!ptr_array_add (array, &value))
+		CuFail (tc, "should not be reached");
+	ptr_array_free (array);
+
+	CuAssertIntEquals (tc, 2, value);
+}
+
+#if 0
+static void
+test_hash_iterate (CuTest *tc)
+{
+	hash_t *ht;
+	hash_iter_t hi;
+	int key = 1;
+	int value = 2;
+	void *pkey;
+	void *pvalue;
+	int ret;
+
+	ht = hash_create (hash_direct_hash, hash_direct_equal, NULL, NULL);
+	CuAssertPtrNotNull (tc, ht);
+	if (!hash_set (ht, &key, &value))
+		CuFail (tc, "should not be reached");
+
+	hash_iterate (ht, &hi);
+
+	ret = hash_next (&hi, &pkey, &pvalue);
+	CuAssertIntEquals (tc, 1, ret);
+	CuAssertPtrEquals (tc, pkey, &key);
+	CuAssertPtrEquals (tc, pvalue, &value);
+
+	ret = hash_next (&hi, &pkey, &pvalue);
+	CuAssertIntEquals (tc, 0, ret);
+
+	hash_free (ht);
+}
+
+#endif
+
+static void
+test_ptr_array_add (CuTest *tc)
+{
+	char *value = "VALUE";
+	char *check;
+	ptr_array_t *array;
+
+	array = ptr_array_create (NULL);
+	if (!ptr_array_add (array, value))
+		CuFail (tc, "should not be reached");
+
+	CuAssertIntEquals (tc, 1, ptr_array_count (array));
+
+	check = ptr_array_at (array, 0);
+	CuAssertPtrEquals (tc, check, value);
+
+	ptr_array_free (array);
+}
+
+static void
+test_ptr_array_add_remove (CuTest *tc)
+{
+	char *value = "VALUE";
+	char *check;
+	ptr_array_t *array;
+
+	array = ptr_array_create (NULL);
+	if (!ptr_array_add (array, value))
+		CuFail (tc, "should not be reached");
+
+	CuAssertIntEquals (tc, 1, ptr_array_count (array));
+
+	check = ptr_array_at (array, 0);
+	CuAssertPtrEquals (tc, check, value);
+
+	ptr_array_remove (array, 0);
+
+	CuAssertIntEquals (tc, 0, ptr_array_count (array));
+
+	ptr_array_free (array);
+}
+
+static void
+test_ptr_array_remove_destroys (CuTest *tc)
+{
+	ptr_array_t *array;
+	int value = 0;
+
+	array = ptr_array_create (destroy_value);
+	if (!ptr_array_add (array, &value))
+		CuFail (tc, "should not be reached");
+
+	ptr_array_remove (array, 0);
+
+	CuAssertIntEquals (tc, 2, value);
+
+	/* should not be destroyed again */
+	value = 0;
+
+	ptr_array_free (array);
+
+	CuAssertIntEquals (tc, 0, value);
+}
+
+static void
+test_ptr_array_remove_and_count (CuTest *tc)
+{
+	ptr_array_t *array;
+	int *value;
+	int i;
+
+	array = ptr_array_create (free);
+
+	CuAssertIntEquals (tc, 0, ptr_array_count (array));
+
+	for (i = 0; i < 20000; ++i) {
+		value = malloc (sizeof (int));
+		*value = i;
+		if (!ptr_array_add (array, value))
+			CuFail (tc, "should not be reached");
+		CuAssertIntEquals (tc, i + 1, ptr_array_count (array));
+	}
+
+	for (i = 10; i < 20000; ++i) {
+		ptr_array_remove (array, 10);
+		CuAssertIntEquals (tc, 20010 - (i + 1), ptr_array_count (array));
+	}
+
+	CuAssertIntEquals (tc, 10, ptr_array_count (array));
+
+	ptr_array_free (array);
+}
+
+static void
+test_ptr_array_snapshot (CuTest *tc)
+{
+	ptr_array_t *array;
+	void **snapshot;
+
+	array = ptr_array_create (NULL);
+
+	ptr_array_add (array, "1");
+	ptr_array_add (array, "2");
+	ptr_array_add (array, "3");
+	ptr_array_add (array, "4");
+	CuAssertIntEquals (tc, 4, ptr_array_count (array));
+
+	snapshot = ptr_array_snapshot (array);
+
+	CuAssertStrEquals (tc, "1", snapshot[0]);
+	CuAssertStrEquals (tc, "2", snapshot[1]);
+	CuAssertStrEquals (tc, "3", snapshot[2]);
+	CuAssertStrEquals (tc, "4", snapshot[3]);
+
+	free (snapshot);
+	ptr_array_free (array);
+}
+
+int
+main (void)
+{
+	CuString *output = CuStringNew ();
+	CuSuite* suite = CuSuiteNew ();
+	int ret;
+
+	SUITE_ADD_TEST (suite, test_ptr_array_create);
+	SUITE_ADD_TEST (suite, test_ptr_array_add);
+	SUITE_ADD_TEST (suite, test_ptr_array_add_remove);
+	SUITE_ADD_TEST (suite, test_ptr_array_remove_destroys);
+	SUITE_ADD_TEST (suite, test_ptr_array_remove_and_count);
+	SUITE_ADD_TEST (suite, test_ptr_array_free_null);
+	SUITE_ADD_TEST (suite, test_ptr_array_free_destroys);
+	SUITE_ADD_TEST (suite, test_ptr_array_snapshot);
+
+	CuSuiteRun (suite);
+	CuSuiteSummary (suite, output);
+	CuSuiteDetails (suite, output);
+	printf ("%s\n", output->buffer);
+	ret = suite->failCount;
+	CuSuiteDelete (suite);
+	CuStringDelete (output);
+
+	return ret;
+}
+
+#include "CuTest.c"