VeraCrypt
aboutsummaryrefslogtreecommitdiff
path: root/src/Common/CommandAPDU.cpp
blob: b202cb13e8cddaafc78f1c70bf0e916732eb5415 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
#include "CommandAPDU.h"
#include <string.h>

using namespace std;

namespace VeraCrypt
{
	CommandAPDU::CommandAPDU()
		: m_nc(0), m_ne(0), m_dataOffset(0), m_isExtendedAPDU(false), m_parsingErrorStr(""), m_parsedSuccessfully(false)
	{
	}

	void CommandAPDU::parse()
	{
		uint32 l1 = 0;
		uint32 l2 = 0;
		size_t leOfs = 0;
		uint32 l3 = 0;
		m_parsingErrorStr = "";
		m_parsedSuccessfully = false;

		if (m_apdu.size() < 4)
		{
			m_parsingErrorStr = vformat("APDU must be at least 4 bytes long - Length = %zu", m_apdu.size());
			goto failure;
		}

		if (m_apdu.size() == 4)
		{
			//	case 1
			goto success;
		}

		/***	SHORT APDUs		***/
		l1 = m_apdu[4] & 0xff;
		if (m_apdu.size() == 5)
		{
			//	case 2s
			m_ne = (l1 == 0) ? 256 : l1;
			goto success;
		}
		if (l1 != 0)
		{
			if (m_apdu.size() == 4 + 1 + l1)
			{
				//	case 3s
				m_nc = l1;
				m_dataOffset = 5;
				goto success;
			}
			else if (m_apdu.size() == 4 + 2 + l1)
			{
				//	case 4s
				m_nc = l1;
				m_dataOffset = 5;
				l2 = m_apdu[m_apdu.size() - 1] & 0xff;
				m_ne = (l2 == 0) ? 256 : l2;
				goto success;
			}
			else
			{
				m_parsingErrorStr = vformat("Invalid APDU : b1 = %u, expected length to be %u or %u, got %zu", l1, 4 + 1 + l1, 4 + 2 + l1, m_apdu.size());
				goto failure;
			}
		}

		if (m_apdu.size() < 7)
		{
			m_parsingErrorStr = vformat("Invalid APDU : b1 = %u, expected length to be >= 7 , got %zu", l1, m_apdu.size());
			goto failure;
		}

		/***	EXTENDED APDUs	***/
		l2 = ((m_apdu[5] & 0xff) << 8) | (m_apdu[6] & 0xff);
		if (m_apdu.size() == 7)
		{
			//	case 2e
			m_ne = (l2 == 0) ? 65536 : l2;
			m_isExtendedAPDU = true;
			goto success;
		}
		if (l2 == 0)
		{
			m_parsingErrorStr = vformat("Invalid APDU: b1 = %u, b2||b3 = %u, length = %zu", l1, l2, m_apdu.size());
			goto failure;
		}
		if (m_apdu.size() == 4 + 3 + l2)
		{
			//	case 3e
			m_nc = l2;
			m_dataOffset = 7;
			m_isExtendedAPDU = true;
			goto success;
		}
		if (m_apdu.size() == 4 + 5 + l2)
		{
			//	case 4e
			m_nc = l2;
			m_dataOffset = 7;
			leOfs = m_apdu.size() - 2;
			l3 = ((m_apdu[leOfs] & 0xff) << 8) | (m_apdu[leOfs + 1] & 0xff);
			m_ne = (l3 == 0) ? 65536 : l3;
			m_isExtendedAPDU = true;
			goto success;
		}
		else
		{
			m_parsingErrorStr = vformat("Invalid APDU : b1 = %u, b2||b3 = %u, expected length to be %u or %u, got %zu", l1, l2, 4 + 3 + l2, 4 + 5 + l2, m_apdu.size());
			goto failure;
		}

	success:
		m_parsedSuccessfully = true;

	failure:
		clear();
	}

	void CommandAPDU::init(byte cla, byte ins, byte p1, byte p2, const byte* data, uint32 dataOffset, uint32 dataLength, uint32 ne)
	{
		m_nc = 0;
		m_ne = 0;
		m_dataOffset = 0;
		m_isExtendedAPDU = false;
		m_parsingErrorStr = "";
		m_parsedSuccessfully = false;

		if (dataLength > 65535) 
		{
			m_parsingErrorStr = vformat("dataLength is too large (> 65535) - dataLength = %u", dataLength);
			clear();
			return;
		}
		if (ne > 65536) 
		{
			m_parsingErrorStr = vformat("ne is too large (> 65536) - ne = %u", ne);
			clear();
			return;
		}

		m_ne = ne;
		m_nc = dataLength;

		if (dataLength == 0)
		{
			if (m_ne == 0)
			{
				//	case 1
				m_apdu.resize(4, 0);
				setHeader(cla, ins, p1, p2);
			}
			else
			{
				//	case 2s or 2e
				if (ne <= 256)
				{
					//	case 2s
					//	256 is encoded as 0x00
					byte len = (m_ne != 256) ? (byte)m_ne : 0;
					m_apdu.resize(5, 0);
					setHeader(cla, ins, p1, p2);
					m_apdu[4] = len;
				}
				else
				{
					//	case 2e
					byte l1, l2;
					//	65536 is encoded as 0x00 0x00
					if (m_ne == 65536)
					{
						l1 = 0;
						l2 = 0;
					}
					else
					{
						l1 = (byte)(m_ne >> 8);
						l2 = (byte)m_ne;
					}
					m_apdu.resize(7, 0);
					setHeader(cla, ins, p1, p2);
					m_apdu[5] = l1;
					m_apdu[6] = l2;
					m_isExtendedAPDU = true;
				}
			}
		}
		else
		{
			if (m_ne == 0)
			{
				//	case 3s or 3e
				if (dataLength <= 255)
				{
					//	case 3s
					m_apdu.resize(4 + 1 + dataLength, 0);
					setHeader(cla, ins, p1, p2);
					m_apdu[4] = (byte)dataLength;
					m_dataOffset = 5;
					memcpy(m_apdu.data() + 5, data + dataOffset, dataLength);
				}
				else
				{
					//	case 3e
					m_apdu.resize(4 + 3 + dataLength, 0);
					setHeader(cla, ins, p1, p2);
					m_apdu[4] = 0;
					m_apdu[5] = (byte)(dataLength >> 8);
					m_apdu[6] = (byte)dataLength;
					m_dataOffset = 7;
					memcpy(m_apdu.data() + 7, data + dataOffset, dataLength);
					m_isExtendedAPDU = true;
				}
			}
			else
			{
				//	case 4s or 4e
				if ((dataLength <= 255) && (m_ne <= 256))
				{
					//	case 4s
					m_apdu.resize(4 + 2 + dataLength, 0);
					setHeader(cla, ins, p1, p2);
					m_apdu[4] = (byte)dataLength;
					m_dataOffset = 5;
					memcpy(m_apdu.data() + 5, data + dataOffset, dataLength);
					m_apdu[m_apdu.size() - 1] = (m_ne != 256) ? (byte)m_ne : 0;
				}
				else
				{
					//	case 4e
					m_apdu.resize(4 + 5 + dataLength, 0);
					setHeader(cla, ins, p1, p2);
					m_apdu[4] = 0;
					m_apdu[5] = (byte)(dataLength >> 8);
					m_apdu[6] = (byte)dataLength;
					m_dataOffset = 7;
					memcpy(m_apdu.data() + 7, data + dataOffset, dataLength);
					if (ne != 65536)
					{
						size_t leOfs = m_apdu.size() - 2;
						m_apdu[leOfs] = (byte)(m_ne >> 8);
						m_apdu[leOfs + 1] = (byte)m_ne;
					} // else le == 65536: no need to fill in, encoded as 0
					m_isExtendedAPDU = true;
				}
			}
		}

		m_parsedSuccessfully = true;
	}

	void CommandAPDU::setHeader(byte cla, byte ins, byte p1, byte p2)
	{
		m_apdu[0] = (byte)cla;
		m_apdu[1] = (byte)ins;
		m_apdu[2] = (byte)p1;
		m_apdu[3] = (byte)p2;
	}

	void CommandAPDU::clear()
	{
		m_apdu.clear();
		m_nc = 0;
		m_ne = 0;
		m_dataOffset = 0;
	}

	CommandAPDU::CommandAPDU(byte cla, byte ins, byte p1, byte p2, const byte* data, uint32 dataOffset, uint32 dataLength, uint32 ne)
	{
		init(cla, ins, p1, p2, data, dataOffset, dataLength, ne);
	}

	CommandAPDU::CommandAPDU(byte cla, byte ins, byte p1, byte p2)
	{
		init(cla, ins, p1, p2, NULL, 0, 0, 0);
	}

	CommandAPDU::CommandAPDU(byte cla, byte ins, byte p1, byte p2, uint32 ne)
	{
		init(cla, ins, p1, p2, NULL, 0, 0, ne);
	}

	CommandAPDU::CommandAPDU(byte cla, byte ins, byte p1, byte p2, const vector<byte>& data)
	{
		init(cla, ins, p1, p2, data.data(), 0, (uint32)data.size(), 0);
	}

	CommandAPDU::CommandAPDU(byte cla, byte ins, byte p1, byte p2, const byte* data, uint32 dataOffset, uint32 dataLength)
	{
		init(cla, ins, p1, p2, data, dataOffset, dataLength, 0);
	}

	CommandAPDU::CommandAPDU(byte cla, byte ins, byte p1, byte p2, const vector<byte>& data, uint32 ne)
	{
		init(cla, ins, p1, p2, data.data(), 0, (uint32)data.size(), ne);
	}

	CommandAPDU::CommandAPDU(const vector<byte>& apdu) : m_nc(0), m_ne(0), m_dataOffset(0), m_isExtendedAPDU(false)
	{
		m_apdu = apdu;
		parse();
	}

	byte CommandAPDU::getCLA()
	{
		return m_apdu[0] & 0xff;
	}

	byte CommandAPDU::getINS()
	{
		return m_apdu[1] & 0xff;
	}

	byte CommandAPDU::getP1()
	{
		return m_apdu[2] & 0xff;
	}

	byte CommandAPDU::getP2()
	{
		return m_apdu[3] & 0xff;
	}

	uint32 CommandAPDU::getNc()
	{
		return m_nc;
	}

	const vector<byte> CommandAPDU::getData()
	{
		vector<byte> data;

		if (m_nc > 0)
		{
			data.resize(m_nc, 0);
			memcpy(data.data(), m_apdu.data() + m_dataOffset, data.size());
		}

		return data;
	}

	uint32 CommandAPDU::getNe()
	{
		return m_ne;
	}

	const vector<byte> CommandAPDU::getAPDU()
	{
		return m_apdu;
	}

	bool CommandAPDU::isExtended()
	{
		return m_isExtendedAPDU;
	}

	bool CommandAPDU::isValid()
	{
		return m_parsedSuccessfully;
	}

	std::string CommandAPDU::getErrorStr()
	{
		return m_parsingErrorStr;
	}
}