security/nss/lib/pk11wrap/pk11err.c@b8a032363ba2
security/nss/lib/pk11wrap/pk11err.c
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
1 /* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
4 /*
5 * this file maps PKCS11 Errors into SECErrors
6 * This is an information reducing process, since most errors are reflected
7 * back to the user (the user doesn't care about invalid flags, or active
8 * operations). If any of these errors need more detail in the upper layers
9 * which call PK11 library functions, we can add more SEC_ERROR_XXX functions
10 * and change there mappings here.
11 *
12 * Some PKCS11 errors are mapped to SEC_ERROR_LIBRARY_FAILURE intentionally
13 * because they indicate that there is a bug in the library (either NSS or
14 * the token).
15 */
16 #include "pkcs11t.h"
17 #include "pk11func.h"
18 #include "secerr.h"
19 #include "prerror.h"
21 #ifdef PK11_ERROR_USE_ARRAY
23 /*
24 * build a static array of entries...
25 */
26 static struct {
27 CK_RV pk11_error;
28 int sec_error;
29 } pk11_error_map = {
30 #define MAPERROR(x,y) {x, y},
32 #else
34 /* the default is to use a big switch statement */
35 int
36 PK11_MapError(CK_RV rv) {
38 switch (rv) {
39 #define MAPERROR(x,y) case x: return y;
41 #endif
43 /* the guts mapping */
44 MAPERROR(CKR_OK, 0)
45 MAPERROR(CKR_CANCEL, SEC_ERROR_IO)
46 MAPERROR(CKR_HOST_MEMORY, SEC_ERROR_NO_MEMORY)
47 MAPERROR(CKR_SLOT_ID_INVALID, SEC_ERROR_BAD_DATA)
48 MAPERROR(CKR_ARGUMENTS_BAD, SEC_ERROR_INVALID_ARGS)
49 MAPERROR(CKR_ATTRIBUTE_READ_ONLY, SEC_ERROR_READ_ONLY)
50 MAPERROR(CKR_ATTRIBUTE_SENSITIVE, SEC_ERROR_IO) /* XX SENSITIVE */
51 MAPERROR(CKR_ATTRIBUTE_TYPE_INVALID, SEC_ERROR_BAD_DATA)
52 MAPERROR(CKR_ATTRIBUTE_VALUE_INVALID, SEC_ERROR_BAD_DATA)
53 MAPERROR(CKR_BUFFER_TOO_SMALL, SEC_ERROR_OUTPUT_LEN)
54 MAPERROR(CKR_DATA_INVALID, SEC_ERROR_BAD_DATA)
55 MAPERROR(CKR_DATA_LEN_RANGE, SEC_ERROR_INPUT_LEN)
56 MAPERROR(CKR_DEVICE_ERROR, SEC_ERROR_PKCS11_DEVICE_ERROR)
57 MAPERROR(CKR_DEVICE_MEMORY, SEC_ERROR_NO_MEMORY)
58 MAPERROR(CKR_DEVICE_REMOVED, SEC_ERROR_NO_TOKEN)
59 MAPERROR(CKR_DOMAIN_PARAMS_INVALID, SEC_ERROR_INVALID_KEY)
60 MAPERROR(CKR_ENCRYPTED_DATA_INVALID, SEC_ERROR_BAD_DATA)
61 MAPERROR(CKR_ENCRYPTED_DATA_LEN_RANGE, SEC_ERROR_BAD_DATA)
62 MAPERROR(CKR_FUNCTION_CANCELED, SEC_ERROR_LIBRARY_FAILURE)
63 MAPERROR(CKR_FUNCTION_FAILED, SEC_ERROR_PKCS11_FUNCTION_FAILED)
64 MAPERROR(CKR_FUNCTION_NOT_PARALLEL, SEC_ERROR_LIBRARY_FAILURE)
65 MAPERROR(CKR_FUNCTION_NOT_SUPPORTED, PR_NOT_IMPLEMENTED_ERROR)
66 MAPERROR(CKR_GENERAL_ERROR, SEC_ERROR_PKCS11_GENERAL_ERROR)
67 MAPERROR(CKR_KEY_HANDLE_INVALID, SEC_ERROR_INVALID_KEY)
68 MAPERROR(CKR_KEY_SIZE_RANGE, SEC_ERROR_INVALID_KEY)
69 MAPERROR(CKR_KEY_TYPE_INCONSISTENT, SEC_ERROR_INVALID_KEY)
70 MAPERROR(CKR_MECHANISM_INVALID, SEC_ERROR_INVALID_ALGORITHM)
71 MAPERROR(CKR_MECHANISM_PARAM_INVALID, SEC_ERROR_BAD_DATA)
72 MAPERROR(CKR_NO_EVENT, SEC_ERROR_NO_EVENT)
73 MAPERROR(CKR_OBJECT_HANDLE_INVALID, SEC_ERROR_BAD_DATA)
74 MAPERROR(CKR_OPERATION_ACTIVE, SEC_ERROR_LIBRARY_FAILURE)
75 MAPERROR(CKR_OPERATION_NOT_INITIALIZED,SEC_ERROR_LIBRARY_FAILURE )
76 MAPERROR(CKR_PIN_INCORRECT, SEC_ERROR_BAD_PASSWORD)
77 MAPERROR(CKR_PIN_INVALID, SEC_ERROR_INVALID_PASSWORD)
78 MAPERROR(CKR_PIN_LEN_RANGE, SEC_ERROR_INVALID_PASSWORD)
79 MAPERROR(CKR_PIN_EXPIRED, SEC_ERROR_EXPIRED_PASSWORD)
80 MAPERROR(CKR_PIN_LOCKED, SEC_ERROR_LOCKED_PASSWORD)
81 MAPERROR(CKR_SESSION_CLOSED, SEC_ERROR_LIBRARY_FAILURE)
82 MAPERROR(CKR_SESSION_COUNT, SEC_ERROR_NO_MEMORY) /* XXXX? */
83 MAPERROR(CKR_SESSION_HANDLE_INVALID, SEC_ERROR_BAD_DATA)
84 MAPERROR(CKR_SESSION_PARALLEL_NOT_SUPPORTED, SEC_ERROR_LIBRARY_FAILURE)
85 MAPERROR(CKR_SESSION_READ_ONLY, SEC_ERROR_READ_ONLY)
86 MAPERROR(CKR_SIGNATURE_INVALID, SEC_ERROR_BAD_SIGNATURE)
87 MAPERROR(CKR_SIGNATURE_LEN_RANGE, SEC_ERROR_BAD_SIGNATURE)
88 MAPERROR(CKR_TEMPLATE_INCOMPLETE, SEC_ERROR_BAD_DATA)
89 MAPERROR(CKR_TEMPLATE_INCONSISTENT, SEC_ERROR_BAD_DATA)
90 MAPERROR(CKR_TOKEN_NOT_PRESENT, SEC_ERROR_NO_TOKEN)
91 MAPERROR(CKR_TOKEN_NOT_RECOGNIZED, SEC_ERROR_IO)
92 MAPERROR(CKR_TOKEN_WRITE_PROTECTED, SEC_ERROR_READ_ONLY)
93 MAPERROR(CKR_UNWRAPPING_KEY_HANDLE_INVALID, SEC_ERROR_INVALID_KEY)
94 MAPERROR(CKR_UNWRAPPING_KEY_SIZE_RANGE, SEC_ERROR_INVALID_KEY)
95 MAPERROR(CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT, SEC_ERROR_INVALID_KEY)
96 MAPERROR(CKR_USER_ALREADY_LOGGED_IN, 0)
97 MAPERROR(CKR_USER_NOT_LOGGED_IN, SEC_ERROR_TOKEN_NOT_LOGGED_IN)
98 MAPERROR(CKR_USER_PIN_NOT_INITIALIZED, SEC_ERROR_NO_TOKEN)
99 MAPERROR(CKR_USER_TYPE_INVALID, SEC_ERROR_LIBRARY_FAILURE)
100 MAPERROR(CKR_WRAPPED_KEY_INVALID, SEC_ERROR_INVALID_KEY)
101 MAPERROR(CKR_WRAPPED_KEY_LEN_RANGE, SEC_ERROR_INVALID_KEY)
102 MAPERROR(CKR_WRAPPING_KEY_HANDLE_INVALID, SEC_ERROR_INVALID_KEY)
103 MAPERROR(CKR_WRAPPING_KEY_SIZE_RANGE, SEC_ERROR_INVALID_KEY)
104 MAPERROR(CKR_WRAPPING_KEY_TYPE_INCONSISTENT, SEC_ERROR_INVALID_KEY)
105 MAPERROR(CKR_VENDOR_DEFINED, SEC_ERROR_LIBRARY_FAILURE)
106 MAPERROR(CKR_NETSCAPE_CERTDB_FAILED, SEC_ERROR_BAD_DATABASE)
107 MAPERROR(CKR_NETSCAPE_KEYDB_FAILED, SEC_ERROR_BAD_DATABASE)
108 MAPERROR(CKR_CANT_LOCK, SEC_ERROR_INCOMPATIBLE_PKCS11)
110 #ifdef PK11_ERROR_USE_ARRAY
111 };
113 int
114 PK11_MapError(CK_RV rv) {
115 int size = sizeof(pk11_error_map)/sizeof(pk11_error_map[0]);
117 for (i=0; i < size; i++) {
118 if (pk11_error_map[i].pk11_error == rv) {
119 return pk11_error_map[i].sec_error;
120 }
121 }
122 return SEC_ERROR_UNKNOWN_PKCS11_ERROR;
123 }
126 #else
128 default:
129 break;
130 }
131 return SEC_ERROR_UNKNOWN_PKCS11_ERROR;
132 }
135 #endif
