1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/security/nss/lib/pk11wrap/pk11err.c Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,135 @@
1.4 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.5 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.6 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.7 +/*
1.8 + * this file maps PKCS11 Errors into SECErrors
1.9 + * This is an information reducing process, since most errors are reflected
1.10 + * back to the user (the user doesn't care about invalid flags, or active
1.11 + * operations). If any of these errors need more detail in the upper layers
1.12 + * which call PK11 library functions, we can add more SEC_ERROR_XXX functions
1.13 + * and change there mappings here.
1.14 + *
1.15 + * Some PKCS11 errors are mapped to SEC_ERROR_LIBRARY_FAILURE intentionally
1.16 + * because they indicate that there is a bug in the library (either NSS or
1.17 + * the token).
1.18 + */
1.19 +#include "pkcs11t.h"
1.20 +#include "pk11func.h"
1.21 +#include "secerr.h"
1.22 +#include "prerror.h"
1.23 +
1.24 +#ifdef PK11_ERROR_USE_ARRAY
1.25 +
1.26 +/*
1.27 + * build a static array of entries...
1.28 + */
1.29 +static struct {
1.30 + CK_RV pk11_error;
1.31 + int sec_error;
1.32 +} pk11_error_map = {
1.33 +#define MAPERROR(x,y) {x, y},
1.34 +
1.35 +#else
1.36 +
1.37 +/* the default is to use a big switch statement */
1.38 +int
1.39 +PK11_MapError(CK_RV rv) {
1.40 +
1.41 + switch (rv) {
1.42 +#define MAPERROR(x,y) case x: return y;
1.43 +
1.44 +#endif
1.45 +
1.46 +/* the guts mapping */
1.47 + MAPERROR(CKR_OK, 0)
1.48 + MAPERROR(CKR_CANCEL, SEC_ERROR_IO)
1.49 + MAPERROR(CKR_HOST_MEMORY, SEC_ERROR_NO_MEMORY)
1.50 + MAPERROR(CKR_SLOT_ID_INVALID, SEC_ERROR_BAD_DATA)
1.51 + MAPERROR(CKR_ARGUMENTS_BAD, SEC_ERROR_INVALID_ARGS)
1.52 + MAPERROR(CKR_ATTRIBUTE_READ_ONLY, SEC_ERROR_READ_ONLY)
1.53 + MAPERROR(CKR_ATTRIBUTE_SENSITIVE, SEC_ERROR_IO) /* XX SENSITIVE */
1.54 + MAPERROR(CKR_ATTRIBUTE_TYPE_INVALID, SEC_ERROR_BAD_DATA)
1.55 + MAPERROR(CKR_ATTRIBUTE_VALUE_INVALID, SEC_ERROR_BAD_DATA)
1.56 + MAPERROR(CKR_BUFFER_TOO_SMALL, SEC_ERROR_OUTPUT_LEN)
1.57 + MAPERROR(CKR_DATA_INVALID, SEC_ERROR_BAD_DATA)
1.58 + MAPERROR(CKR_DATA_LEN_RANGE, SEC_ERROR_INPUT_LEN)
1.59 + MAPERROR(CKR_DEVICE_ERROR, SEC_ERROR_PKCS11_DEVICE_ERROR)
1.60 + MAPERROR(CKR_DEVICE_MEMORY, SEC_ERROR_NO_MEMORY)
1.61 + MAPERROR(CKR_DEVICE_REMOVED, SEC_ERROR_NO_TOKEN)
1.62 + MAPERROR(CKR_DOMAIN_PARAMS_INVALID, SEC_ERROR_INVALID_KEY)
1.63 + MAPERROR(CKR_ENCRYPTED_DATA_INVALID, SEC_ERROR_BAD_DATA)
1.64 + MAPERROR(CKR_ENCRYPTED_DATA_LEN_RANGE, SEC_ERROR_BAD_DATA)
1.65 + MAPERROR(CKR_FUNCTION_CANCELED, SEC_ERROR_LIBRARY_FAILURE)
1.66 + MAPERROR(CKR_FUNCTION_FAILED, SEC_ERROR_PKCS11_FUNCTION_FAILED)
1.67 + MAPERROR(CKR_FUNCTION_NOT_PARALLEL, SEC_ERROR_LIBRARY_FAILURE)
1.68 + MAPERROR(CKR_FUNCTION_NOT_SUPPORTED, PR_NOT_IMPLEMENTED_ERROR)
1.69 + MAPERROR(CKR_GENERAL_ERROR, SEC_ERROR_PKCS11_GENERAL_ERROR)
1.70 + MAPERROR(CKR_KEY_HANDLE_INVALID, SEC_ERROR_INVALID_KEY)
1.71 + MAPERROR(CKR_KEY_SIZE_RANGE, SEC_ERROR_INVALID_KEY)
1.72 + MAPERROR(CKR_KEY_TYPE_INCONSISTENT, SEC_ERROR_INVALID_KEY)
1.73 + MAPERROR(CKR_MECHANISM_INVALID, SEC_ERROR_INVALID_ALGORITHM)
1.74 + MAPERROR(CKR_MECHANISM_PARAM_INVALID, SEC_ERROR_BAD_DATA)
1.75 + MAPERROR(CKR_NO_EVENT, SEC_ERROR_NO_EVENT)
1.76 + MAPERROR(CKR_OBJECT_HANDLE_INVALID, SEC_ERROR_BAD_DATA)
1.77 + MAPERROR(CKR_OPERATION_ACTIVE, SEC_ERROR_LIBRARY_FAILURE)
1.78 + MAPERROR(CKR_OPERATION_NOT_INITIALIZED,SEC_ERROR_LIBRARY_FAILURE )
1.79 + MAPERROR(CKR_PIN_INCORRECT, SEC_ERROR_BAD_PASSWORD)
1.80 + MAPERROR(CKR_PIN_INVALID, SEC_ERROR_INVALID_PASSWORD)
1.81 + MAPERROR(CKR_PIN_LEN_RANGE, SEC_ERROR_INVALID_PASSWORD)
1.82 + MAPERROR(CKR_PIN_EXPIRED, SEC_ERROR_EXPIRED_PASSWORD)
1.83 + MAPERROR(CKR_PIN_LOCKED, SEC_ERROR_LOCKED_PASSWORD)
1.84 + MAPERROR(CKR_SESSION_CLOSED, SEC_ERROR_LIBRARY_FAILURE)
1.85 + MAPERROR(CKR_SESSION_COUNT, SEC_ERROR_NO_MEMORY) /* XXXX? */
1.86 + MAPERROR(CKR_SESSION_HANDLE_INVALID, SEC_ERROR_BAD_DATA)
1.87 + MAPERROR(CKR_SESSION_PARALLEL_NOT_SUPPORTED, SEC_ERROR_LIBRARY_FAILURE)
1.88 + MAPERROR(CKR_SESSION_READ_ONLY, SEC_ERROR_READ_ONLY)
1.89 + MAPERROR(CKR_SIGNATURE_INVALID, SEC_ERROR_BAD_SIGNATURE)
1.90 + MAPERROR(CKR_SIGNATURE_LEN_RANGE, SEC_ERROR_BAD_SIGNATURE)
1.91 + MAPERROR(CKR_TEMPLATE_INCOMPLETE, SEC_ERROR_BAD_DATA)
1.92 + MAPERROR(CKR_TEMPLATE_INCONSISTENT, SEC_ERROR_BAD_DATA)
1.93 + MAPERROR(CKR_TOKEN_NOT_PRESENT, SEC_ERROR_NO_TOKEN)
1.94 + MAPERROR(CKR_TOKEN_NOT_RECOGNIZED, SEC_ERROR_IO)
1.95 + MAPERROR(CKR_TOKEN_WRITE_PROTECTED, SEC_ERROR_READ_ONLY)
1.96 + MAPERROR(CKR_UNWRAPPING_KEY_HANDLE_INVALID, SEC_ERROR_INVALID_KEY)
1.97 + MAPERROR(CKR_UNWRAPPING_KEY_SIZE_RANGE, SEC_ERROR_INVALID_KEY)
1.98 + MAPERROR(CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT, SEC_ERROR_INVALID_KEY)
1.99 + MAPERROR(CKR_USER_ALREADY_LOGGED_IN, 0)
1.100 + MAPERROR(CKR_USER_NOT_LOGGED_IN, SEC_ERROR_TOKEN_NOT_LOGGED_IN)
1.101 + MAPERROR(CKR_USER_PIN_NOT_INITIALIZED, SEC_ERROR_NO_TOKEN)
1.102 + MAPERROR(CKR_USER_TYPE_INVALID, SEC_ERROR_LIBRARY_FAILURE)
1.103 + MAPERROR(CKR_WRAPPED_KEY_INVALID, SEC_ERROR_INVALID_KEY)
1.104 + MAPERROR(CKR_WRAPPED_KEY_LEN_RANGE, SEC_ERROR_INVALID_KEY)
1.105 + MAPERROR(CKR_WRAPPING_KEY_HANDLE_INVALID, SEC_ERROR_INVALID_KEY)
1.106 + MAPERROR(CKR_WRAPPING_KEY_SIZE_RANGE, SEC_ERROR_INVALID_KEY)
1.107 + MAPERROR(CKR_WRAPPING_KEY_TYPE_INCONSISTENT, SEC_ERROR_INVALID_KEY)
1.108 + MAPERROR(CKR_VENDOR_DEFINED, SEC_ERROR_LIBRARY_FAILURE)
1.109 + MAPERROR(CKR_NETSCAPE_CERTDB_FAILED, SEC_ERROR_BAD_DATABASE)
1.110 + MAPERROR(CKR_NETSCAPE_KEYDB_FAILED, SEC_ERROR_BAD_DATABASE)
1.111 + MAPERROR(CKR_CANT_LOCK, SEC_ERROR_INCOMPATIBLE_PKCS11)
1.112 +
1.113 +#ifdef PK11_ERROR_USE_ARRAY
1.114 +};
1.115 +
1.116 +int
1.117 +PK11_MapError(CK_RV rv) {
1.118 + int size = sizeof(pk11_error_map)/sizeof(pk11_error_map[0]);
1.119 +
1.120 + for (i=0; i < size; i++) {
1.121 + if (pk11_error_map[i].pk11_error == rv) {
1.122 + return pk11_error_map[i].sec_error;
1.123 + }
1.124 + }
1.125 + return SEC_ERROR_UNKNOWN_PKCS11_ERROR;
1.126 + }
1.127 +
1.128 +
1.129 +#else
1.130 +
1.131 + default:
1.132 + break;
1.133 + }
1.134 + return SEC_ERROR_UNKNOWN_PKCS11_ERROR;
1.135 +}
1.136 +
1.137 +
1.138 +#endif
