1 /* libp11, a simple layer on to of PKCS#11 API
2  * Copyright (C) 2005 Olaf Kirch <okir@lst.de>
3  *
4  *  This library is free software; you can redistribute it and/or
5  *  modify it under the terms of the GNU Lesser General Public
6  *  License as published by the Free Software Foundation; either
7  *  version 2.1 of the License, or (at your option) any later version.
8  *
9  *  This library is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  *  Lesser General Public License for more details.
13  *
14  *  You should have received a copy of the GNU Lesser General Public
15  *  License along with this library; if not, write to the Free Software
16  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
17  */
18 
19 #include "libp11.h"
20 #include "libp11-int.h"
21 
22 #define CKR_LIB_NAME "PKCS#11 module"
23 
24 /* BEGIN ERROR CODES */
25 #ifndef NO_ERR
26 
27 # define ERR_FUNC(func) ERR_PACK(0,func,0)
28 # define ERR_REASON(reason) ERR_PACK(0,0,reason)
29 
30 static ERR_STRING_DATA CKR_str_functs[] = {
31 	{ERR_FUNC(CKR_F_PKCS11_CHANGE_PIN), "pkcs11_change_pin"},
32 	{ERR_FUNC(CKR_F_PKCS11_CHECK_TOKEN), "pkcs11_check_token"},
33 	{ERR_FUNC(CKR_F_PKCS11_CTX_LOAD), "pkcs11_CTX_load"},
34 	{ERR_FUNC(CKR_F_PKCS11_ECDH_DERIVE), "pkcs11_ecdh_derive"},
35 	{ERR_FUNC(CKR_F_PKCS11_ECDSA_SIGN), "pkcs11_ecdsa_sign"},
36 	{ERR_FUNC(CKR_F_PKCS11_ENUMERATE_SLOTS), "pkcs11_enumerate_slots"},
37 	{ERR_FUNC(CKR_F_PKCS11_FIND_CERTS), "pkcs11_find_certs"},
38 	{ERR_FUNC(CKR_F_PKCS11_FIND_KEYS), "pkcs11_find_keys"},
39 	{ERR_FUNC(CKR_F_PKCS11_GENERATE_RANDOM), "pkcs11_generate_random"},
40 	{ERR_FUNC(CKR_F_PKCS11_GETATTR_ALLOC), "pkcs11_getattr_alloc"},
41 	{ERR_FUNC(CKR_F_PKCS11_GETATTR_BN), "pkcs11_getattr_bn"},
42 	{ERR_FUNC(CKR_F_PKCS11_GETATTR_INT), "pkcs11_getattr_int"},
43 	{ERR_FUNC(CKR_F_PKCS11_INIT_PIN), "pkcs11_init_pin"},
44 	{ERR_FUNC(CKR_F_PKCS11_INIT_SLOT), "pkcs11_init_slot"},
45 	{ERR_FUNC(CKR_F_PKCS11_INIT_TOKEN), "pkcs11_init_token"},
46 	{ERR_FUNC(CKR_F_PKCS11_IS_LOGGED_IN), "pkcs11_is_logged_in"},
47 	{ERR_FUNC(CKR_F_PKCS11_LOGIN), "pkcs11_login"},
48 	{ERR_FUNC(CKR_F_PKCS11_LOGOUT), "pkcs11_logout"},
49 	{ERR_FUNC(CKR_F_PKCS11_NEXT_CERT), "pkcs11_next_cert"},
50 	{ERR_FUNC(CKR_F_PKCS11_NEXT_KEY), "pkcs11_next_key"},
51 	{ERR_FUNC(CKR_F_PKCS11_OPEN_SESSION), "pkcs11_open_session"},
52 	{ERR_FUNC(CKR_F_PKCS11_PRIVATE_DECRYPT), "pkcs11_private_decrypt"},
53 	{ERR_FUNC(CKR_F_PKCS11_PRIVATE_ENCRYPT), "pkcs11_private_encrypt"},
54 	{ERR_FUNC(CKR_F_PKCS11_RELOAD_KEY), "pkcs11_reload_key"},
55 	{ERR_FUNC(CKR_F_PKCS11_REOPEN_SESSION), "pkcs11_reopen_session"},
56 	{ERR_FUNC(CKR_F_PKCS11_SEED_RANDOM), "pkcs11_seed_random"},
57 	{ERR_FUNC(CKR_F_PKCS11_STORE_CERTIFICATE), "pkcs11_store_certificate"},
58 	{ERR_FUNC(CKR_F_PKCS11_STORE_KEY), "pkcs11_store_key"},
59 	{0, NULL}
60 };
61 
62 static ERR_STRING_DATA CKR_str_reasons[] = {
63 	{CKR_CANCEL, "Cancel"},
64 	{CKR_HOST_MEMORY, "Host memory error"},
65 	{CKR_SLOT_ID_INVALID, "Invalid slot ID"},
66 	{CKR_GENERAL_ERROR, "General Error"},
67 	{CKR_FUNCTION_FAILED, "Function failed"},
68 	{CKR_ARGUMENTS_BAD, "Invalid arguments"},
69 	{CKR_NO_EVENT, "No event"},
70 	{CKR_NEED_TO_CREATE_THREADS, "Need to create threads"},
71 	{CKR_CANT_LOCK, "Cannott lock"},
72 	{CKR_ATTRIBUTE_READ_ONLY, "Attribute read only"},
73 	{CKR_ATTRIBUTE_SENSITIVE, "Attribute sensitive"},
74 	{CKR_ATTRIBUTE_TYPE_INVALID, "Attribute type invalid"},
75 	{CKR_ATTRIBUTE_VALUE_INVALID, "Attribute value invalid"},
76 	{CKR_DATA_INVALID, "Data invalid"},
77 	{CKR_DATA_LEN_RANGE, "Data len range"},
78 	{CKR_DEVICE_ERROR, "Device error"},
79 	{CKR_DEVICE_MEMORY, "Device memory"},
80 	{CKR_DEVICE_REMOVED, "Device removed"},
81 	{CKR_ENCRYPTED_DATA_INVALID, "Encrypted data invalid"},
82 	{CKR_ENCRYPTED_DATA_LEN_RANGE, "Encrypted data len range"},
83 	{CKR_FUNCTION_CANCELED, "Function canceled"},
84 	{CKR_FUNCTION_NOT_PARALLEL, "Function not parallel"},
85 	{CKR_FUNCTION_NOT_SUPPORTED, "Function not supported"},
86 	{CKR_KEY_HANDLE_INVALID, "Key handle invalid"},
87 	{CKR_KEY_SIZE_RANGE, "Key size range"},
88 	{CKR_KEY_TYPE_INCONSISTENT, "Key type inconsistent"},
89 	{CKR_KEY_NOT_NEEDED, "Key not needed"},
90 	{CKR_KEY_CHANGED, "Key changed"},
91 	{CKR_KEY_NEEDED, "Key needed"},
92 	{CKR_KEY_INDIGESTIBLE, "Key indigestible"},
93 	{CKR_KEY_FUNCTION_NOT_PERMITTED, "Key function not permitted"},
94 	{CKR_KEY_NOT_WRAPPABLE, "Key not wrappable"},
95 	{CKR_KEY_UNEXTRACTABLE, "Key unextractable"},
96 	{CKR_MECHANISM_INVALID, "Mechanism invalid"},
97 	{CKR_MECHANISM_PARAM_INVALID, "Mechanism param invalid"},
98 	{CKR_OBJECT_HANDLE_INVALID, "Object handle invalid"},
99 	{CKR_OPERATION_ACTIVE, "Operation active"},
100 	{CKR_OPERATION_NOT_INITIALIZED, "Operation not initialized"},
101 	{CKR_PIN_INCORRECT, "PIN incorrect"},
102 	{CKR_PIN_INVALID, "PIN invalid"},
103 	{CKR_PIN_LEN_RANGE, "Invalid PIN length"},
104 	{CKR_PIN_EXPIRED, "PIN expired"},
105 	{CKR_PIN_LOCKED, "PIN locked"},
106 	{CKR_SESSION_CLOSED, "Session closed"},
107 	{CKR_SESSION_COUNT, "Session count"},
108 	{CKR_SESSION_HANDLE_INVALID, "Session handle invalid"},
109 	{CKR_SESSION_PARALLEL_NOT_SUPPORTED, "Session parallel not supported"},
110 	{CKR_SESSION_READ_ONLY, "Session read only"},
111 	{CKR_SESSION_EXISTS, "Session exists"},
112 	{CKR_SESSION_READ_ONLY_EXISTS, "Read-only session exists"},
113 	{CKR_SESSION_READ_WRITE_SO_EXISTS, "Read/write SO session exists"},
114 	{CKR_SIGNATURE_INVALID, "Signature invalid"},
115 	{CKR_SIGNATURE_LEN_RANGE, "Signature len range"},
116 	{CKR_TEMPLATE_INCOMPLETE, "Incomplete template"},
117 	{CKR_TEMPLATE_INCONSISTENT, "Inconsistent template"},
118 	{CKR_TOKEN_NOT_PRESENT, "No PKCS#11 token present"},
119 	{CKR_TOKEN_NOT_RECOGNIZED, "PKCS#11 token not recognized"},
120 	{CKR_TOKEN_WRITE_PROTECTED, "Token write protected"},
121 	{CKR_UNWRAPPING_KEY_HANDLE_INVALID, "Unwrapping key handle invalid"},
122 	{CKR_UNWRAPPING_KEY_SIZE_RANGE, "Unwrapping key size range"},
123 	{CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT, "Unwrapping key type inconsistent"},
124 	{CKR_USER_ALREADY_LOGGED_IN, "User already logged in"},
125 	{CKR_USER_NOT_LOGGED_IN, "User not logged in"},
126 	{CKR_USER_PIN_NOT_INITIALIZED, "User pin not initialized"},
127 	{CKR_USER_TYPE_INVALID, "User type invalid"},
128 	{CKR_USER_ANOTHER_ALREADY_LOGGED_IN, "User another is already logged in"},
129 	{CKR_USER_TOO_MANY_TYPES, "User too many types"},
130 	{CKR_WRAPPED_KEY_INVALID, "Wrapped key invalid"},
131 	{CKR_WRAPPED_KEY_LEN_RANGE, "Wrapped key len range"},
132 	{CKR_WRAPPING_KEY_HANDLE_INVALID, "Wrapping key handle invalid"},
133 	{CKR_WRAPPING_KEY_SIZE_RANGE, "Wrapping key size range"},
134 	{CKR_WRAPPING_KEY_TYPE_INCONSISTENT, "Wrapping key type inconsistent"},
135 	{CKR_RANDOM_SEED_NOT_SUPPORTED, "Random seed not supported"},
136 	{CKR_RANDOM_NO_RNG, "Random no rng"},
137 	{CKR_DOMAIN_PARAMS_INVALID, "Domain params invalid"},
138 	{CKR_BUFFER_TOO_SMALL, "Buffer too small"},
139 	{CKR_SAVED_STATE_INVALID, "Saved state invalid"},
140 	{CKR_INFORMATION_SENSITIVE, "Information sensitive"},
141 	{CKR_STATE_UNSAVEABLE, "State unsaveable"},
142 	{CKR_CRYPTOKI_NOT_INITIALIZED, "Cryptoki not initialized"},
143 	{CKR_CRYPTOKI_ALREADY_INITIALIZED, "Cryptoki already initialized"},
144 	{CKR_MUTEX_BAD, "Mutex bad"},
145 	{CKR_MUTEX_NOT_LOCKED, "Mutex not locked"},
146 	{CKR_VENDOR_DEFINED, "Vendor defined"},
147 	{0, NULL}
148 };
149 #endif
150 
151 #ifdef CKR_LIB_NAME
152 static ERR_STRING_DATA CKR_lib_name[] = {
153 	{0, CKR_LIB_NAME},
154 	{0, NULL}
155 };
156 #endif
157 
158 static int CKR_lib_error_code = 0;
159 static int CKR_error_init = 1;
160 
ERR_load_CKR_strings(void)161 int ERR_load_CKR_strings(void)
162 {
163 	if (CKR_lib_error_code == 0)
164 		CKR_lib_error_code = ERR_get_next_error_library();
165 
166 	if (CKR_error_init) {
167 		CKR_error_init = 0;
168 #ifndef OPENSSL_NO_ERR
169 		ERR_load_strings(CKR_lib_error_code, CKR_str_functs);
170 		ERR_load_strings(CKR_lib_error_code, CKR_str_reasons);
171 #endif
172 
173 #ifdef CKR_LIB_NAME
174 		CKR_lib_name->error = ERR_PACK(CKR_lib_error_code, 0, 0);
175 		ERR_load_strings(0, CKR_lib_name);
176 #endif
177 	}
178 	return 1;
179 }
180 
ERR_unload_CKR_strings(void)181 void ERR_unload_CKR_strings(void)
182 {
183 	if (CKR_error_init == 0) {
184 #ifndef OPENSSL_NO_ERR
185 		ERR_unload_strings(CKR_lib_error_code, CKR_str_functs);
186 		ERR_unload_strings(CKR_lib_error_code, CKR_str_reasons);
187 #endif
188 
189 #ifdef CKR_LIB_NAME
190 		ERR_unload_strings(0, CKR_lib_name);
191 #endif
192 		CKR_error_init = 1;
193 	}
194 }
195 
ERR_CKR_error(int function,int reason,char * file,int line)196 void ERR_CKR_error(int function, int reason, char *file, int line)
197 {
198 	if (CKR_lib_error_code == 0)
199 		CKR_lib_error_code = ERR_get_next_error_library();
200 	ERR_PUT_error(CKR_lib_error_code, function, reason, file, line);
201 }
202 
ERR_get_CKR_code(void)203 int ERR_get_CKR_code(void)
204 {
205 	if (CKR_lib_error_code == 0)
206 		CKR_lib_error_code = ERR_get_next_error_library();
207 	return CKR_lib_error_code;
208 }
209 
210 /* vim: set noexpandtab: */
211