Add p11_kit_strerror() method and internationalization.

4 files changed, 249 insertions, 5 deletions

diff --git a/module/Makefile.am b/module/Makefile.am
index 23589d2..49f0a3d 100644
--- a/module/Makefile.am
+++ b/module/Makefile.am
@@ -1,10 +1,19 @@
 
+
+incdir = $(includedir)/p11-kit
+
+inc_HEADERS = \
+	p11-kit.h \
+	pkcs11.h
+
 MODULE_SRCS = \
 	conf.c conf.h \
 	hash.c hash.h \
 	p11-kit-lib.c \
 	p11-kit-proxy.c \
-	p11-kit-private.h p11-kit.h
+	p11-kit-private.h \
+	p11-kit-messages.c \
+	$(inc_HEADERS)
 
 lib_LTLIBRARIES = \
 	libp11-kit.la
@@ -13,7 +22,7 @@ noinst_LTLIBRARIES = \
 	libp11-kit-testable.la
 
 libp11_kit_la_LDFLAGS = \
-	-no-undefined -export-symbols-regex 'C_GetFunctionList'
+	-no-undefined -export-symbols-regex '^C_GetFunctionList|^p11_kit_'
 
 libp11_kit_la_SOURCES = $(MODULE_SRCS)
 
@@ -26,5 +35,4 @@ pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = p11-kit.pc
 
 EXTRA_DIST = \
-	pkcs11.h \
 	p11-kit.pc.in
\ No newline at end of file
diff --git a/module/p11-kit-lib.c b/module/p11-kit-lib.c
index 926de90..ae88703 100644
--- a/module/p11-kit-lib.c
+++ b/module/p11-kit-lib.c
@@ -222,8 +222,8 @@ load_module_from_config_unlocked (const char *configfile, const char *name)
 
 	rv = gfl (&module->funcs);
 	if (rv != CKR_OK) {
-		warning ("call to C_GetFunctiontList failed in module: %s: %lu",
-		         path, (unsigned long)rv);
+		warning ("call to C_GetFunctiontList failed in module: %s: %s",
+		         path, p11_kit_strerror (rv));
 		free_module_unlocked (module);
 		return rv;
 	}
diff --git a/module/p11-kit-messages.c b/module/p11-kit-messages.c
new file mode 100644
index 0000000..3a71a96
--- /dev/null
+++ b/module/p11-kit-messages.c
@@ -0,0 +1,234 @@
+/*
+ * 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 "pkcs11.h"
+#include "p11-kit.h"
+
+#ifdef ENABLE_NLS
+#include <libintl.h>
+#define _(x) dgettext(PACKAGE_NAME, x)
+#else
+#define _(x) x
+#endif
+
+/**
+ * gck_message_from_rv:
+ * @rv: The PKCS#11 return value to get a message for.
+ *
+ * Get a message for a PKCS#11 return value or error code. Do not
+ * pass CKR_OK or other such non errors to this function.
+ *
+ * Return value: The user readable message.
+ **/
+const char*
+p11_kit_strerror (CK_RV rv)
+{
+	switch (rv) {
+
+	/* These are not really errors, or not current */
+	case CKR_OK:
+	case CKR_NO_EVENT:
+	case CKR_FUNCTION_NOT_PARALLEL:
+	case CKR_SESSION_PARALLEL_NOT_SUPPORTED:
+		return "";
+
+	case CKR_CANCEL:
+	case CKR_FUNCTION_CANCELED:
+		return _("The operation was cancelled");
+
+	case CKR_HOST_MEMORY:
+		return _("Insufficient memory available");
+	case CKR_SLOT_ID_INVALID:
+		return _("The specified slot ID is not valid");
+	case CKR_GENERAL_ERROR:
+		return _("Internal error");
+	case CKR_FUNCTION_FAILED:
+		return _("The operation failed");
+	case CKR_ARGUMENTS_BAD:
+		return _("Invalid arguments");
+	case CKR_NEED_TO_CREATE_THREADS:
+		return _("The module cannot create needed threads");
+	case CKR_CANT_LOCK:
+		return _("The module cannot lock data properly");
+	case CKR_ATTRIBUTE_READ_ONLY:
+		return _("The field is read-only");
+	case CKR_ATTRIBUTE_SENSITIVE:
+		return _("The field is sensitive and cannot be revealed");
+	case CKR_ATTRIBUTE_TYPE_INVALID:
+		return _("The field is invalid or does not exist");
+	case CKR_ATTRIBUTE_VALUE_INVALID:
+		return _("Invalid value for field");
+	case CKR_DATA_INVALID:
+		return _("The data is not valid or unrecognized");
+	case CKR_DATA_LEN_RANGE:
+		return _("The data is too long");
+	case CKR_DEVICE_ERROR:
+		return _("An error occurred on the device");
+	case CKR_DEVICE_MEMORY:
+		return _("Insufficient memory available on the device");
+	case CKR_DEVICE_REMOVED:
+		return _("The device was removed or unplugged");
+	case CKR_ENCRYPTED_DATA_INVALID:
+		return _("The encrypted data is not valid or unrecognized");
+	case CKR_ENCRYPTED_DATA_LEN_RANGE:
+		return _("The encrypted data is too long");
+	case CKR_FUNCTION_NOT_SUPPORTED:
+		return _("This operation is not supported");
+	case CKR_KEY_HANDLE_INVALID:
+		return _("The key is missing or invalid");
+	case CKR_KEY_SIZE_RANGE:
+		return _("The key is the wrong size");
+	case CKR_KEY_TYPE_INCONSISTENT:
+		return _("The key is of the wrong type");
+	case CKR_KEY_NOT_NEEDED:
+		return _("No key is needed");
+	case CKR_KEY_CHANGED:
+		return _("The key is different than before");
+	case CKR_KEY_NEEDED:
+		return _("A key is needed");
+	case CKR_KEY_INDIGESTIBLE:
+		return _("Cannot include the key in the digest");
+	case CKR_KEY_FUNCTION_NOT_PERMITTED:
+		return _("This operation cannot be done with this key");
+	case CKR_KEY_NOT_WRAPPABLE:
+		return _("The key cannot be wrapped");
+	case CKR_KEY_UNEXTRACTABLE:
+		return _("Cannot export this key");
+	case CKR_MECHANISM_INVALID:
+		return _("The crypto mechanism is invalid or unrecognized");
+	case CKR_MECHANISM_PARAM_INVALID:
+		return _("The crypto mechanism has an invalid argument");
+	case CKR_OBJECT_HANDLE_INVALID:
+		return _("The object is missing or invalid");
+	case CKR_OPERATION_ACTIVE:
+		return _("Another operation is already taking place");
+	case CKR_OPERATION_NOT_INITIALIZED:
+		return _("No operation is taking place");
+	case CKR_PIN_INCORRECT:
+		return _("The password or PIN is incorrect");
+	case CKR_PIN_INVALID:
+		return _("The password or PIN is invalid");
+	case CKR_PIN_LEN_RANGE:
+		return _("The password or PIN is of an invalid length");
+	case CKR_PIN_EXPIRED:
+		return _("The password or PIN has expired");
+	case CKR_PIN_LOCKED:
+		return _("The password or PIN is locked");
+	case CKR_SESSION_CLOSED:
+		return _("The session is closed");
+	case CKR_SESSION_COUNT:
+		return _("Too many sessions are active");
+	case CKR_SESSION_HANDLE_INVALID:
+		return _("The session is invalid");
+	case CKR_SESSION_READ_ONLY:
+		return _("The session is read-only");
+	case CKR_SESSION_EXISTS:
+		return _("An open session exists");
+	case CKR_SESSION_READ_ONLY_EXISTS:
+		return _("A read-only session exists");
+	case CKR_SESSION_READ_WRITE_SO_EXISTS:
+		return _("An administrator session exists");
+	case CKR_SIGNATURE_INVALID:
+		return _("The signature is bad or corrupted");
+	case CKR_SIGNATURE_LEN_RANGE:
+		return _("The signature is unrecognized or corrupted");
+	case CKR_TEMPLATE_INCOMPLETE:
+		return _("Certain required fields are missing");
+	case CKR_TEMPLATE_INCONSISTENT:
+		return _("Certain fields have invalid values");
+	case CKR_TOKEN_NOT_PRESENT:
+		return _("The device is not present or unplugged");
+	case CKR_TOKEN_NOT_RECOGNIZED:
+		return _("The device is invalid or unrecognizable");
+	case CKR_TOKEN_WRITE_PROTECTED:
+		return _("The device is write protected");
+	case CKR_UNWRAPPING_KEY_HANDLE_INVALID:
+		return _("Cannot import because the key is invalid");
+	case CKR_UNWRAPPING_KEY_SIZE_RANGE:
+		return _("Cannot import because the key is of the wrong size");
+	case CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT:
+		return _("Cannot import because the key is of the wrong type");
+	case CKR_USER_ALREADY_LOGGED_IN:
+		return _("You are already logged in");
+	case CKR_USER_NOT_LOGGED_IN:
+		return _("No user has logged in");
+	case CKR_USER_PIN_NOT_INITIALIZED:
+		return _("The user's password or PIN is not set");
+	case CKR_USER_TYPE_INVALID:
+		return _("The user is of an invalid type");
+	case CKR_USER_ANOTHER_ALREADY_LOGGED_IN:
+		return _("Another user is already logged in");
+	case CKR_USER_TOO_MANY_TYPES:
+		return _("Too many users of different types are logged in");
+	case CKR_WRAPPED_KEY_INVALID:
+		return _("Cannot import an invalid key");
+	case CKR_WRAPPED_KEY_LEN_RANGE:
+		return _("Cannot import a key of the wrong size");
+	case CKR_WRAPPING_KEY_HANDLE_INVALID:
+		return _("Cannot export because the key is invalid");
+	case CKR_WRAPPING_KEY_SIZE_RANGE:
+		return _("Cannot export because the key is of the wrong size");
+	case CKR_WRAPPING_KEY_TYPE_INCONSISTENT:
+		return _("Cannot export because the key is of the wrong type");
+	case CKR_RANDOM_SEED_NOT_SUPPORTED:
+		return _("Unable to initialize the random number generator");
+	case CKR_RANDOM_NO_RNG:
+		return _("No random number generator available");
+	case CKR_DOMAIN_PARAMS_INVALID:
+		return _("The crypto mechanism has an invalid parameter");
+	case CKR_BUFFER_TOO_SMALL:
+		return _("Not enough space to store the result");
+	case CKR_SAVED_STATE_INVALID:
+		return _("The saved state is invalid");
+	case CKR_INFORMATION_SENSITIVE:
+		return _("The information is sensitive and cannot be revealed");
+	case CKR_STATE_UNSAVEABLE:
+		return _("The state cannot be saved");
+	case CKR_CRYPTOKI_NOT_INITIALIZED:
+		return _("The module has not been initialized");
+	case CKR_CRYPTOKI_ALREADY_INITIALIZED:
+		return _("The module has already been initialized");
+	case CKR_MUTEX_BAD:
+		return _("Cannot lock data");
+	case CKR_MUTEX_NOT_LOCKED:
+		return _("The data cannot be locked");
+	case CKR_FUNCTION_REJECTED:
+		return _("The signature request was rejected by the user");
+
+	default:
+		return _("Unknown error");
+	}
+}
diff --git a/module/p11-kit.h b/module/p11-kit.h
index 919d6b8..50b93d8 100644
--- a/module/p11-kit.h
+++ b/module/p11-kit.h
@@ -54,4 +54,6 @@ CK_RV                    p11_kit_initialize_module         (CK_FUNCTION_LIST_PTR
 CK_RV                    p11_kit_finalize_module           (CK_FUNCTION_LIST_PTR funcs,
                                                             CK_VOID_PTR reserved);
 
+const char*              p11_kit_strerror                  (CK_RV rv);
+
 #endif /* __P11_KIT_H__ */