common/include/APDUHelper.h

   1 /*
   2  * Copyright (c) 2012, 2013 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef APDUHELPER_H_
  18 #define APDUHELPER_H_
  19
  20 /* standard library header */
  21
  22 /* SLP library header */
  23
  24 /* local header */
  25 #include "ByteArray.h"
  26
  27 namespace smartcard_service_api
  28 {
  29         /* LCOV_EXCL_START */
  30         class ResponseHelper
  31         {
  32         private:
  33                 ByteArray response;
  34                 unsigned char sw[2];
  35                 int status;
  36                 ByteArray dataField;
  37
  38                 static int parseStatusWord(const unsigned char *sw);
  39
  40         public:
  41                 static const int SUCCESS = 0;
  42
  43                 static const int ERROR_UNKNOWN = -1;
  44
  45                 static const int ERROR_NO_INFORMATION = -(0x6900);
  46                 static const int ERROR_COMMAND_INCOMPATIBLE = -(0x6981);
  47                 static const int ERROR_SECURITY_NOT_SATISFIED = -(0x6982);
  48                 static const int ERROR_AUTH_PIN_BLOCKED = -(0x6983);
  49                 static const int ERROR_REF_DATA_INVALID = -(0x6984);
  50                 static const int ERROR_CONDITION_NOT_SATIFIED = -(0x6985);
  51                 static const int ERROR_COMMAND_NOT_ALLOW = -(0x6986);
  52
  53                 static const int ERROR_INCORRECT_PARAMETER = -(0x6a80);
  54                 static const int ERROR_FUNCTION_NOT_SUPPORT = -(0x6a81);
  55                 static const int ERROR_FILE_NOT_FOUND = -(0x6a82);
  56                 static const int ERROR_RECORD_NOT_FOUND = -(0x6a83);
  57                 static const int ERROR_NOT_ENOUGH_MEMORY = -(0x6a84);
  58                 static const int ERROR_INCORRECT_P1_P2 = -(0x6a86);
  59                 static const int ERROR_LC_INCONSISTENT = -(0x6a87);
  60                 static const int ERROR_REF_DATA_NOT_FOUND = -(0x6a88);
  61
  62                 ResponseHelper();
  63                 ResponseHelper(const ByteArray &response);
  64                 ~ResponseHelper();
  65
  66                 bool setResponse(const ByteArray &response);
  67                 inline int getStatus() const { return status; }
  68                 inline unsigned char getSW1() const { return sw[0]; }
  69                 inline unsigned char getSW2() const { return sw[1]; }
  70
  71 //              char *getErrorString();
  72                 inline const ByteArray getDataField() const { return dataField; }
  73
  74                 static int getStatus(const ByteArray &response);
  75                 static const ByteArray getDataField(const ByteArray &response);
  76 //              static char *getErrorString();
  77         };
  78
  79         class APDUCommand
  80         {
  81         private:
  82                 typedef struct _command_header_t
  83                 {
  84                         unsigned char cla;
  85                         unsigned char ins;
  86                         unsigned char param[2];
  87                 } command_header_t;
  88
  89                 command_header_t header;
  90                 ByteArray commandData;
  91                 unsigned int maxResponseSize;
  92                 bool isExtendedLength;
  93
  94         public:
  95                 static const unsigned char INS_DEACTIVATE_FILE = (unsigned char)0x04;
  96                 static const unsigned char INS_TERMINAL_PROFILE = (unsigned char)0x10;
  97                 static const unsigned char INS_FETCH = (unsigned char)0x12;
  98                 static const unsigned char INS_TERMINAL_RESPONSE = (unsigned char)0x14;
  99                 static const unsigned char INS_VERIFY = (unsigned char)0x20;
 100                 static const unsigned char INS_CHANGE_PIN = (unsigned char)0x24;
 101                 static const unsigned char INS_DISABLE_PIN = (unsigned char)0x26;
 102                 static const unsigned char INS_ENABLE_PIN = (unsigned char)0x28;
 103                 static const unsigned char INS_UNBLOCK_PIN = (unsigned char)0x2C;
 104                 static const unsigned char INS_INCREASE = (unsigned char)0x32;
 105                 static const unsigned char INS_ACTIVATE_FILE = (unsigned char)0x44;
 106                 static const unsigned char INS_GET_CHALLENGE = (unsigned char)0x84;
 107                 static const unsigned char INS_AUTHENTICATE = (unsigned char)0x88;
 108                 static const unsigned char INS_AUTHENTICATE2 = (unsigned char)0x89;
 109                 static const unsigned char INS_MANAGE_CHANNEL = (unsigned char)0x70;
 110                 static const unsigned char INS_MANAGE_SECURE_CHANNEL = (unsigned char)0x73;
 111                 static const unsigned char INS_TRANSACT_DATA = (unsigned char)0x75;
 112                 static const unsigned char INS_SEARCH_RECORD = (unsigned char)0xA2;
 113                 static const unsigned char INS_SELECT_FILE = (unsigned char)0xA4;
 114                 static const unsigned char INS_TERMINAL_CAPABILITY = (unsigned char)0xAA;
 115                 static const unsigned char INS_READ_BINARY = (unsigned char)0xB0;
 116                 static const unsigned char INS_READ_RECORD = (unsigned char)0xB2;
 117                 static const unsigned char INS_GET_RESPONSE = (unsigned char)0xC0;
 118                 static const unsigned char INS_ENVELOPE = (unsigned char)0xC2;
 119                 static const unsigned char INS_RETRIEVE_DATA = (unsigned char)0xCB;
 120                 static const unsigned char INS_WRITE_BINARY = (unsigned char)0xD0;
 121                 static const unsigned char INS_UPDATE_BINARY = (unsigned char)0xD6;
 122                 static const unsigned char INS_UPDATE_RECORD = (unsigned char)0xDC;
 123                 static const unsigned char INS_SET_DATA = (unsigned char)0xDB;
 124                 static const unsigned char INS_CREATE_FILE = (unsigned char)0xE0;
 125                 static const unsigned char INS_APPEND_RECORD = (unsigned char)0xE2;
 126                 static const unsigned char INS_DELETE_FILE = (unsigned char)0xE4;
 127                 static const unsigned char INS_STATUS = (unsigned char)0xF2;
 128 //              static const unsigned char INS_ = (unsigned char)0x;
 129
 130                 static const unsigned char P1_SELECT_BY_ID = (unsigned char)0x00;
 131                 static const unsigned char P1_SELECT_PARENT_DF = (unsigned char)0x03;
 132                 static const unsigned char P1_SELECT_BY_DF_NAME = (unsigned char)0x04;
 133                 static const unsigned char P1_SELECT_BY_PATH = (unsigned char)0x08;
 134                 static const unsigned char P1_SELECT_BY_PATH_FROM_CURRENT_DF = (unsigned char)0x09;
 135 //              static const unsigned char P1_ = (unsigned char)0x;
 136
 137                 static const unsigned char P2_SELECT_GET_FCP = (unsigned char)0x04;
 138                 static const unsigned char P2_SELECT_GET_FCI = (unsigned char)0x00;
 139 //              static const unsigned char P2_ = (unsigned char)0x;
 140
 141                 static const unsigned char CLA_CHANNEL_STANDARD = (unsigned char)0x00;
 142                 static const unsigned char CLA_CHANNEL_EXTENDED = (unsigned char)0x01;
 143
 144                 static const unsigned int LE_MAX = -1;
 145
 146                 APDUCommand();
 147                 ~APDUCommand();
 148
 149                 bool setCommand(unsigned char cla, unsigned char ins, unsigned char p1,
 150                         unsigned char p2, const ByteArray &commandData, unsigned int maxResponseSize);
 151                 bool setCommand(const ByteArray &command);
 152
 153                 bool setChannel(int type, int channelNum);
 154
 155                 void setCLA(unsigned char cla);
 156                 unsigned char getCLA() const;
 157
 158                 void setINS(unsigned char ins);
 159                 unsigned char getINS() const;
 160
 161                 void setP1(unsigned char p1);
 162                 unsigned char getP1() const;
 163
 164                 void setP2(unsigned char p2);
 165                 unsigned char getP2() const;
 166
 167                 void setCommandData(const ByteArray &data);
 168                 const ByteArray getCommandData() const;
 169
 170                 void setMaxResponseSize(unsigned int maxResponseSize);
 171                 unsigned int getMaxResponseSize() const;
 172
 173                 bool getBuffer(ByteArray &array) const;
 174         };
 175
 176         class APDUHelper
 177         {
 178         public:
 179                 static const int COMMAND_OPEN_LOGICAL_CHANNEL = 1;
 180                 static const int COMMAND_CLOSE_LOGICAL_CHANNEL = 2;
 181                 static const int COMMAND_SELECT_BY_ID = 3;
 182                 static const int COMMAND_SELECT_PARENT_DF = 4;
 183                 static const int COMMAND_SELECT_BY_DF_NAME = 5;
 184                 static const int COMMAND_SELECT_BY_PATH = 6;
 185                 static const int COMMAND_SELECT_BY_PATH_FROM_CURRENT_DF = 7;
 186                 static const int COMMAND_READ_BINARY = 8;
 187                 static const int COMMAND_READ_RECORD = 9;
 188                 static const int COMMAND_WRITE_BINARY = 10;
 189                 static const int COMMAND_WRITE_RECORD = 11;
 190
 191                 static const ByteArray generateAPDU(int command,
 192                         int channel, const ByteArray &data);
 193         };
 194
 195         /* LCOV_EXCL_STOP */
 196 } /* namespace smartcard_service_api */
 197 #endif /* APDUHELPER_H_ */