security/nss/lib/pk11wrap/pk11err.c

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is the Netscape security libraries.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Netscape Communications Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 1994-2000
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36 /*
  37  * this file maps PKCS11 Errors into SECErrors
  38  *  This is an information reducing process, since most errors are reflected
  39  *  back to the user (the user doesn't care about invalid flags, or active
  40  *  operations). If any of these errors need more detail in the upper layers
  41  *  which call PK11 library functions, we can add more SEC_ERROR_XXX functions
  42  *  and change there mappings here.
  43  */
  44 #include "pkcs11t.h"
  45 #include "pk11func.h"
  46 #include "secerr.h"
  47
  48 #ifdef PK11_ERROR_USE_ARRAY
  49
  50 /*
  51  * build a static array of entries...
  52  */
  53 static struct {
  54         CK_RV pk11_error;
  55         int   sec_error;
  56 } pk11_error_map = {
  57 #define MAPERROR(x,y) {x, y},
  58
  59 #else
  60
  61 /* the default is to use a big switch statement */
  62 int
  63 PK11_MapError(CK_RV rv) {
  64
  65         switch (rv) {
  66 #define MAPERROR(x,y) case x: return y;
  67
  68 #endif
  69
  70 /* the guts mapping */
  71         MAPERROR(CKR_OK, 0)
  72         MAPERROR(CKR_CANCEL, SEC_ERROR_IO)
  73         MAPERROR(CKR_HOST_MEMORY, SEC_ERROR_NO_MEMORY)
  74         MAPERROR(CKR_SLOT_ID_INVALID, SEC_ERROR_BAD_DATA)
  75         MAPERROR(CKR_ATTRIBUTE_READ_ONLY, SEC_ERROR_READ_ONLY)
  76         MAPERROR(CKR_ATTRIBUTE_SENSITIVE, SEC_ERROR_IO) /* XX SENSITIVE */
  77         MAPERROR(CKR_ATTRIBUTE_TYPE_INVALID, SEC_ERROR_BAD_DATA)
  78         MAPERROR(CKR_ATTRIBUTE_VALUE_INVALID, SEC_ERROR_BAD_DATA)
  79         MAPERROR(CKR_DATA_INVALID, SEC_ERROR_BAD_DATA)
  80         MAPERROR(CKR_DATA_LEN_RANGE, SEC_ERROR_BAD_DATA)
  81         MAPERROR(CKR_DEVICE_ERROR, SEC_ERROR_IO)
  82         MAPERROR(CKR_DEVICE_MEMORY, SEC_ERROR_NO_MEMORY)
  83         MAPERROR(CKR_DEVICE_REMOVED, SEC_ERROR_NO_TOKEN)
  84         MAPERROR(CKR_ENCRYPTED_DATA_INVALID, SEC_ERROR_BAD_DATA)
  85         MAPERROR(CKR_ENCRYPTED_DATA_LEN_RANGE, SEC_ERROR_BAD_DATA)
  86         MAPERROR(CKR_FUNCTION_CANCELED, SEC_ERROR_LIBRARY_FAILURE)
  87         MAPERROR(CKR_FUNCTION_NOT_PARALLEL, SEC_ERROR_LIBRARY_FAILURE)
  88         MAPERROR(CKR_KEY_HANDLE_INVALID, SEC_ERROR_INVALID_KEY)
  89         MAPERROR(CKR_KEY_SIZE_RANGE, SEC_ERROR_INVALID_KEY)
  90         MAPERROR(CKR_KEY_TYPE_INCONSISTENT, SEC_ERROR_INVALID_KEY)
  91         MAPERROR(CKR_MECHANISM_INVALID, SEC_ERROR_BAD_DATA)
  92         MAPERROR(CKR_MECHANISM_PARAM_INVALID, SEC_ERROR_BAD_DATA)
  93         MAPERROR(CKR_NO_EVENT, SEC_ERROR_NO_EVENT)
  94         MAPERROR(CKR_OBJECT_HANDLE_INVALID, SEC_ERROR_BAD_DATA)
  95         MAPERROR(CKR_OPERATION_ACTIVE, SEC_ERROR_LIBRARY_FAILURE)
  96         MAPERROR(CKR_OPERATION_NOT_INITIALIZED,SEC_ERROR_LIBRARY_FAILURE )
  97         MAPERROR(CKR_PIN_INCORRECT, SEC_ERROR_BAD_PASSWORD)
  98         MAPERROR(CKR_PIN_INVALID, SEC_ERROR_INVALID_PASSWORD)
  99         MAPERROR(CKR_PIN_LEN_RANGE, SEC_ERROR_INVALID_PASSWORD)
 100         MAPERROR(CKR_SESSION_CLOSED, SEC_ERROR_LIBRARY_FAILURE)
 101         MAPERROR(CKR_SESSION_COUNT, SEC_ERROR_NO_MEMORY) /* XXXX? */
 102         MAPERROR(CKR_SESSION_HANDLE_INVALID, SEC_ERROR_BAD_DATA)
 103         MAPERROR(CKR_SESSION_PARALLEL_NOT_SUPPORTED, SEC_ERROR_LIBRARY_FAILURE)
 104         MAPERROR(CKR_SESSION_READ_ONLY, SEC_ERROR_LIBRARY_FAILURE)
 105         MAPERROR(CKR_SIGNATURE_INVALID, SEC_ERROR_BAD_SIGNATURE)
 106         MAPERROR(CKR_SIGNATURE_LEN_RANGE, SEC_ERROR_BAD_SIGNATURE)
 107         MAPERROR(CKR_TEMPLATE_INCOMPLETE, SEC_ERROR_BAD_DATA)
 108         MAPERROR(CKR_TEMPLATE_INCONSISTENT, SEC_ERROR_BAD_DATA)
 109         MAPERROR(CKR_TOKEN_NOT_PRESENT, SEC_ERROR_NO_TOKEN)
 110         MAPERROR(CKR_TOKEN_NOT_RECOGNIZED, SEC_ERROR_IO)
 111         MAPERROR(CKR_TOKEN_WRITE_PROTECTED, SEC_ERROR_READ_ONLY)
 112         MAPERROR(CKR_UNWRAPPING_KEY_HANDLE_INVALID, SEC_ERROR_INVALID_KEY)
 113         MAPERROR(CKR_UNWRAPPING_KEY_SIZE_RANGE, SEC_ERROR_INVALID_KEY)
 114         MAPERROR(CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT, SEC_ERROR_INVALID_KEY)
 115         MAPERROR(CKR_USER_ALREADY_LOGGED_IN, 0)
 116         MAPERROR(CKR_USER_NOT_LOGGED_IN, SEC_ERROR_TOKEN_NOT_LOGGED_IN)
 117         MAPERROR(CKR_USER_PIN_NOT_INITIALIZED, SEC_ERROR_NO_TOKEN)
 118         MAPERROR(CKR_USER_TYPE_INVALID, SEC_ERROR_LIBRARY_FAILURE)
 119         MAPERROR(CKR_WRAPPED_KEY_INVALID, SEC_ERROR_INVALID_KEY)
 120         MAPERROR(CKR_WRAPPED_KEY_LEN_RANGE, SEC_ERROR_INVALID_KEY)
 121         MAPERROR(CKR_WRAPPING_KEY_HANDLE_INVALID, SEC_ERROR_INVALID_KEY)
 122         MAPERROR(CKR_WRAPPING_KEY_SIZE_RANGE, SEC_ERROR_INVALID_KEY)
 123         MAPERROR(CKR_WRAPPING_KEY_TYPE_INCONSISTENT, SEC_ERROR_INVALID_KEY)
 124         MAPERROR(CKR_VENDOR_DEFINED, SEC_ERROR_LIBRARY_FAILURE)
 125         MAPERROR(CKR_NETSCAPE_CERTDB_FAILED, SEC_ERROR_BAD_DATABASE)
 126         MAPERROR(CKR_NETSCAPE_KEYDB_FAILED, SEC_ERROR_BAD_DATABASE)
 127         MAPERROR(CKR_CANT_LOCK, SEC_ERROR_INCOMPATIBLE_PKCS11)
 128
 129 #ifdef PK11_ERROR_USE_ARRAY
 130 };
 131
 132 int
 133 PK11_MapError(CK_RV rv) {
 134     int size = sizeof(pk11_error_map)/sizeof(pk11_error_map[0]);
 135
 136     for (i=0; i < size; i++) {
 137         if (pk11_error_map[i].pk11_error == rv) {
 138             return pk11_error_map[i].sec_error;
 139         }
 140     }
 141     return SEC_ERROR_IO;
 142  }
 143
 144
 145 #else
 146
 147     default:
 148         break;
 149     }
 150     return SEC_ERROR_IO;
 151 }
 152
 153
 154 #endif