Support VERIFY reset feature
[gnuk/gnuk.git] / src / gnuk.h
1 /*
2  * Application layer <-> CCID layer data structure
3  */
4 struct apdu {
5   uint8_t seq;
6
7   /* command APDU */
8   uint8_t *cmd_apdu_head;       /* CLS INS P1 P2 [ internal Lc ] */
9   uint8_t *cmd_apdu_data;
10   uint16_t cmd_apdu_data_len;   /* Nc, calculated by Lc field */
11   uint16_t expected_res_size;   /* Ne, calculated by Le field */
12
13   /* response APDU */
14   uint16_t sw;
15   uint8_t *res_apdu_data;
16   uint16_t res_apdu_data_len;
17 };
18
19 extern struct apdu apdu;
20
21 #define CARD_CHANGE_INSERT 0
22 #define CARD_CHANGE_REMOVE 1
23 #define CARD_CHANGE_TOGGLE 2
24 void ccid_card_change_signal (int how);
25 void ccid_usb_reset (void);
26
27 /* CCID thread */
28 #define EV_RX_DATA_READY   1 /* USB Rx data available  */
29 #define EV_EXEC_FINISHED   2 /* OpenPGP Execution finished */
30 #define EV_TX_FINISHED     4 /* CCID Tx finished  */
31 #define EV_CARD_CHANGE     8
32 #define EV_USB_RESET      16
33
34 /* OpenPGPcard thread */
35 #define EV_PINPAD_INPUT_DONE      1
36 #define EV_EXIT                   2
37 #define EV_CMD_AVAILABLE          4
38 #define EV_VERIFY_CMD_AVAILABLE   8
39 #define EV_MODIFY_CMD_AVAILABLE  16
40
41 /* Maximum cmd apdu data is key import 24+4+256+256 (proc_key_import) */
42 #define MAX_CMD_APDU_DATA_SIZE (24+4+256+256) /* without header */
43 /* Maximum res apdu data is public key 5+9+512 (gpg_do_public_key) */
44 #define MAX_RES_APDU_DATA_SIZE (5+9+512) /* without trailer */
45
46 #define ICC_MSG_HEADER_SIZE     10
47
48 #define res_APDU apdu.res_apdu_data
49 #define res_APDU_size apdu.res_apdu_data_len
50
51 /* USB buffer size of LL (Low-level): size of single Bulk transaction */
52 #define USB_LL_BUF_SIZE 64
53
54 enum icc_state {
55   ICC_STATE_NOCARD,             /* No card available */
56   ICC_STATE_START,              /* Initial */
57   ICC_STATE_WAIT,               /* Waiting APDU */
58                                 /* Busy1, Busy2, Busy3, Busy5 */
59   ICC_STATE_EXECUTE,            /* Busy4 */
60   ICC_STATE_RECEIVE,            /* APDU Received Partially */
61   ICC_STATE_SEND,               /* APDU Sent Partially */
62
63   ICC_STATE_EXITED,             /* ICC Thread Terminated */
64   ICC_STATE_EXEC_REQUESTED,     /* Exec requested */
65 };
66
67 #define CCID_CARD_INIT CARD_CHANGE_INSERT
68
69 extern enum icc_state *icc_state_p;
70
71 extern volatile uint8_t auth_status;
72 #define AC_NONE_AUTHORIZED      0x00
73 #define AC_PSO_CDS_AUTHORIZED   0x01  /* PW1 with 0x81 verified */
74 #define AC_OTHER_AUTHORIZED     0x02  /* PW1 with 0x82 verified */
75 #define AC_ADMIN_AUTHORIZED     0x04  /* PW3 verified */
76 #define AC_NEVER                0x80
77 #define AC_ALWAYS               0xFF
78
79 #define PW_ERR_PW1 0
80 #define PW_ERR_RC  1
81 #define PW_ERR_PW3 2
82 int gpg_pw_get_retry_counter (int who);
83 int gpg_pw_locked (uint8_t which);
84 void gpg_pw_reset_err_counter (uint8_t which);
85 void gpg_pw_increment_err_counter (uint8_t which);
86
87 int ac_check_status (uint8_t ac_flag);
88 int verify_pso_cds (const uint8_t *pw, int pw_len);
89 int verify_other (const uint8_t *pw, int pw_len);
90 int verify_user_0 (uint8_t access, const uint8_t *pw, int buf_len,
91                    int pw_len_known, const uint8_t *ks_pw1, int saveks);
92 int verify_admin (const uint8_t *pw, int pw_len);
93 int verify_admin_0 (const uint8_t *pw, int buf_len, int pw_len_known,
94                     const uint8_t *ks_pw3, int saveks);
95
96 void ac_reset_pso_cds (void);
97 void ac_reset_other (void);
98 void ac_reset_admin (void);
99 void ac_fini (void);
100
101
102 void set_res_sw (uint8_t sw1, uint8_t sw2);
103 extern uint16_t data_objects_number_of_bytes;
104
105 #define CHALLENGE_LEN   32
106
107 void gpg_data_scan (const uint8_t *p);
108 void gpg_data_copy (const uint8_t *p);
109 void gpg_do_get_data (uint16_t tag, int with_tag);
110 void gpg_do_put_data (uint16_t tag, const uint8_t *data, int len);
111 void gpg_do_public_key (uint8_t kk_byte);
112 void gpg_do_keygen (uint8_t kk_byte);
113
114 const uint8_t *gpg_get_firmware_update_key (uint8_t keyno);
115
116 /* Constants: algo+size */
117 #define ALGO_RSA4K      0
118 #define ALGO_NISTP256R1 1
119 #define ALGO_SECP256K1  2
120 #define ALGO_ED25519    3
121 #define ALGO_CURVE25519 4
122 #define ALGO_RSA2K      255
123
124 enum kind_of_key {
125   GPG_KEY_FOR_SIGNING = 0,
126   GPG_KEY_FOR_DECRYPTION,
127   GPG_KEY_FOR_AUTHENTICATION,
128 };
129
130 enum size_of_key {
131   GPG_KEY_STORAGE = 0,          /* PUBKEY + PRVKEY rounded to 2^N */
132   GPG_KEY_PUBLIC,
133   GPG_KEY_PRIVATE,
134 };
135
136 int gpg_get_algo_attr (enum kind_of_key kk);
137 int gpg_get_algo_attr_key_size (enum kind_of_key kk, enum size_of_key s);
138
139 const uint8_t *flash_init (void);
140 void flash_init_keys (void);
141 void flash_do_release (const uint8_t *);
142 const uint8_t *flash_do_write (uint8_t nr, const uint8_t *data, int len);
143 uint8_t *flash_key_alloc (enum kind_of_key);
144 void flash_key_release (uint8_t *, int);
145 void flash_key_release_page (enum kind_of_key);
146 int flash_key_write (uint8_t *key_addr,
147                      const uint8_t *key_data, int key_data_len,
148                      const uint8_t *pubkey, int pubkey_len);
149 void flash_set_data_pool_last (const uint8_t *p);
150 void flash_clear_halfword (uint32_t addr);
151 void flash_increment_counter (uint8_t counter_tag_nr);
152 void flash_reset_counter (uint8_t counter_tag_nr);
153
154 #define FILEID_SERIAL_NO        0
155 #define FILEID_UPDATE_KEY_0     1
156 #define FILEID_UPDATE_KEY_1     2
157 #define FILEID_UPDATE_KEY_2     3
158 #define FILEID_UPDATE_KEY_3     4
159 #define FILEID_CH_CERTIFICATE   5
160 int flash_erase_binary (uint8_t file_id);
161 int flash_write_binary (uint8_t file_id, const uint8_t *data,
162                         uint16_t len, uint16_t offset);
163
164 #define FLASH_CH_CERTIFICATE_SIZE 2048
165
166 /* Linker set these two symbols */
167 extern uint8_t ch_certificate_start;
168
169 #define FIRMWARE_UPDATE_KEY_CONTENT_LEN 256     /* RSA-2048 (p and q) */
170
171 #define INITIAL_VECTOR_SIZE 16
172 #define DATA_ENCRYPTION_KEY_SIZE 16
173
174 #define MAX_PRVKEY_LEN 512      /* Maximum is the case for RSA 4096-bit.  */
175
176 struct key_data {
177   const uint8_t *pubkey;        /* Pointer to public key */
178   uint8_t data[MAX_PRVKEY_LEN]; /* decrypted private key data content */
179 };
180
181 struct prvkey_data {
182   /*
183    * IV: Initial Vector
184    */
185   uint8_t iv[INITIAL_VECTOR_SIZE];
186   /*
187    * Checksum
188    */
189   uint8_t checksum_encrypted[DATA_ENCRYPTION_KEY_SIZE];
190   /*
191    * DEK (Data Encryption Key) encrypted
192    */
193   uint8_t dek_encrypted_1[DATA_ENCRYPTION_KEY_SIZE]; /* For user */
194   uint8_t dek_encrypted_2[DATA_ENCRYPTION_KEY_SIZE]; /* For resetcode */
195   uint8_t dek_encrypted_3[DATA_ENCRYPTION_KEY_SIZE]; /* For admin */
196 };
197
198 #define BY_USER         1
199 #define BY_RESETCODE    2
200 #define BY_ADMIN        3
201
202 /*
203  * Maximum length of pass phrase is 127.
204  * We use the top bit (0x80) to encode if keystring is available within DO.
205  */
206 #define PW_LEN_MAX            127
207 #define PW_LEN_MASK          0x7f
208 #define PW_LEN_KEYSTRING_BIT 0x80
209
210 #define SALT_SIZE 8
211
212 void s2k (const unsigned char *salt, size_t slen,
213           const unsigned char *input, size_t ilen, unsigned char output[32]);
214
215 #define KEYSTRING_PASSLEN_SIZE  1
216 #define KEYSTRING_SALT_SIZE     SALT_SIZE
217 #define KEYSTRING_MD_SIZE       32
218 #define KEYSTRING_SIZE        (KEYSTRING_PASSLEN_SIZE + KEYSTRING_SALT_SIZE \
219                                + KEYSTRING_MD_SIZE)
220 #define KS_META_SIZE          (KEYSTRING_PASSLEN_SIZE + KEYSTRING_SALT_SIZE)
221 #define KS_GET_SALT(ks)       (ks + KEYSTRING_PASSLEN_SIZE)
222 #define KS_GET_KEYSTRING(ks)  (ks + KS_META_SIZE)
223
224 void gpg_do_clear_prvkey (enum kind_of_key kk);
225 int gpg_do_load_prvkey (enum kind_of_key kk, int who, const uint8_t *keystring);
226 int gpg_do_chks_prvkey (enum kind_of_key kk,
227                         int who_old, const uint8_t *old_ks,
228                         int who_new, const uint8_t *new_ks);
229
230 int gpg_change_keystring (int who_old, const uint8_t *old_ks,
231                           int who_new, const uint8_t *new_ks);
232
233 extern struct key_data kd[3];
234
235 #ifdef DEBUG
236 #define DEBUG_MORE 1
237 /*
238  * Debug functions in debug.c
239  */
240 void put_byte (uint8_t b);
241 void put_byte_with_no_nl (uint8_t b);
242 void put_short (uint16_t x);
243 void put_word (uint32_t x);
244 void put_int (uint32_t x);
245 void put_string (const char *s);
246 void put_binary (const char *s, int len);
247
248 #define DEBUG_INFO(msg)     put_string (msg)
249 #define DEBUG_WORD(w)       put_word (w)
250 #define DEBUG_SHORT(h)      put_short (h)
251 #define DEBUG_BYTE(b)       put_byte (b)
252 #define DEBUG_BINARY(s,len) put_binary ((const char *)s,len)
253 #else
254 #define DEBUG_INFO(msg)
255 #define DEBUG_WORD(w)
256 #define DEBUG_SHORT(h)
257 #define DEBUG_BYTE(b)
258 #define DEBUG_BINARY(s,len)
259 #endif
260
261 int rsa_sign (const uint8_t *, uint8_t *, int, struct key_data *, int);
262 uint8_t *modulus_calc (const uint8_t *, int);
263 int rsa_decrypt (const uint8_t *, uint8_t *, int, struct key_data *,
264                  unsigned int *);
265 int rsa_verify (const uint8_t *, int, const uint8_t *, const uint8_t *);
266 uint8_t *rsa_genkey (int);
267
268 int ecdsa_sign_p256r1 (const uint8_t *hash, uint8_t *output,
269                        const uint8_t *key_data);
270 uint8_t *ecc_compute_public_p256r1 (const uint8_t *key_data);
271 int ecc_check_secret_p256r1 (const uint8_t *d0, uint8_t *d1);
272 int ecdh_decrypt_p256r1 (const uint8_t *input, uint8_t *output,
273                          const uint8_t *key_data);
274
275 int ecdsa_sign_p256k1 (const uint8_t *hash, uint8_t *output,
276                        const uint8_t *key_data);
277 uint8_t *ecc_compute_public_p256k1 (const uint8_t *key_data);
278 int ecc_check_secret_p256k1 (const uint8_t *d0, uint8_t  *d1);
279 int ecdh_decrypt_p256k1 (const uint8_t *input, uint8_t *output,
280                          const uint8_t *key_data);
281
282 int eddsa_sign_25519 (const uint8_t *input, size_t ilen, uint32_t *output,
283                       const uint8_t *sk_a, const uint8_t *seed,
284                       const uint8_t *pk);
285 uint8_t *eddsa_compute_public_25519 (const uint8_t *a);
286 uint8_t *ecdh_compute_public_25519 (const uint8_t *a);
287 int ecdh_decrypt_curve25519 (const uint8_t *input, uint8_t *output,
288                              const uint8_t *key_data);
289
290 const uint8_t *gpg_do_read_simple (uint8_t);
291 void gpg_do_write_simple (uint8_t, const uint8_t *, int);
292 void gpg_increment_digital_signature_counter (void);
293
294
295 void fatal (uint8_t code) __attribute__ ((noreturn));
296 #define FATAL_FLASH  1
297 #define FATAL_RANDOM 2
298
299 extern uint8_t keystring_md_pw3[KEYSTRING_MD_SIZE];
300 extern uint8_t admin_authorized;
301
302 /*** Flash memory tag values ***/
303 /* Data objects */
304 /*
305  * Representation of data object:
306  *
307  *   <-1 halfword-> <--len/2 halfwords->
308  *   <-tag-><-len-> <---data content--->
309  */
310 #define NR_DO_SEX               0x00
311 #define NR_DO_FP_SIG            0x01
312 #define NR_DO_FP_DEC            0x02
313 #define NR_DO_FP_AUT            0x03
314 #define NR_DO_CAFP_1            0x04
315 #define NR_DO_CAFP_2            0x05
316 #define NR_DO_CAFP_3            0x06
317 #define NR_DO_KGTIME_SIG        0x07
318 #define NR_DO_KGTIME_DEC        0x08
319 #define NR_DO_KGTIME_AUT        0x09
320 #define NR_DO_LOGIN_DATA        0x0a
321 #define NR_DO_URL               0x0b
322 #define NR_DO_NAME              0x0c
323 #define NR_DO_LANGUAGE          0x0d
324 #define NR_DO_PRVKEY_SIG        0x0e
325 #define NR_DO_PRVKEY_DEC        0x0f
326 #define NR_DO_PRVKEY_AUT        0x10
327 #define NR_DO_KEYSTRING_PW1     0x11
328 #define NR_DO_KEYSTRING_RC      0x12
329 #define NR_DO_KEYSTRING_PW3     0x13
330 #define NR_DO__LAST__           20   /* == 0x14 */
331 /* 14-bit counter for DS: Recorded in flash memory by 1-halfword (2-byte).  */
332 /*
333  * Representation of 14-bit counter:
334  *      0: 0x8000
335  *      1: 0x8001
336  *     ...
337  *  16383: 0xbfff
338  */
339 #define NR_COUNTER_DS           0x80 /* ..0xbf */
340 /* 10-bit counter for DS: Recorded in flash memory by 1-halfword (2-byte).  */
341 /*
342  * Representation of 10-bit counter:
343  *      0: 0xc000
344  *      1: 0xc001
345  *     ...
346  *   1023: 0xc3ff
347  */
348 #define NR_COUNTER_DS_LSB       0xc0 /* ..0xc3 */
349 /*
350  * Boolean object, small enum, or 8-bit integer:
351  * Recorded in flash memory by 1-halfword (2-byte)
352  */
353 /*
354  * Representation of Boolean object:
355  *   0: No record in flash memory
356  *   1: 0xf000
357  */
358 #define NR_BOOL_PW1_LIFETIME    0xf0
359 /*
360  * Representation of algorithm attribute object:
361  *   RSA-2048:       No record in flash memory
362  *   RSA-4096:       0xf?00
363  *   ECC p256r1:     0xf?01
364  *   ECC p256k1:     0xf?02
365  *   ECC Ed25519:    0xf?03
366  *   ECC Curve25519: 0xf?04
367  * where <?> == 1 (signature), 2 (decryption) or 3 (authentication)
368  */
369 #define NR_KEY_ALGO_ATTR_SIG    0xf1
370 #define NR_KEY_ALGO_ATTR_DEC    0xf2
371 #define NR_KEY_ALGO_ATTR_AUT    0xf3
372 /*
373  * NR_UINT_SOMETHING could be here...  Use 0xf[456789abcd]
374  */
375 /* 123-counters: Recorded in flash memory by 2-halfword (4-byte).  */
376 /*
377  * Representation of 123-counters:
378  *   0: No record in flash memory
379  *   1: 0xfe?? 0xffff
380  *   2: 0xfe?? 0xc3c3
381  *   3: 0xfe?? 0x0000
382  *                    where <counter_id> is placed at second byte <??>
383  */
384 #define NR_COUNTER_123          0xfe
385 #define NR_EMPTY                0xff
386
387 #define SIZE_PW_STATUS_BYTES 7
388
389
390 #define NUM_ALL_PRV_KEYS 3      /* SIG, DEC and AUT */
391
392 #if !defined(OPENPGP_CARD_INITIAL_PW1)
393 #define OPENPGP_CARD_INITIAL_PW1 "123456"
394 #endif
395
396 #if !defined(OPENPGP_CARD_INITIAL_PW3)
397 #define OPENPGP_CARD_INITIAL_PW3 "12345678"
398 #endif
399
400 extern const uint8_t openpgpcard_aid[14];
401
402 void flash_bool_clear (const uint8_t **addr_p);
403 const uint8_t *flash_bool_write (uint8_t nr);
404 void flash_enum_clear (const uint8_t **addr_p);
405 const uint8_t *flash_enum_write (uint8_t nr, uint8_t v);
406 int flash_cnt123_get_value (const uint8_t *p);
407 void flash_cnt123_increment (uint8_t which, const uint8_t **addr_p);
408 void flash_cnt123_clear (const uint8_t **addr_p);
409 void flash_put_data (uint16_t hw);
410 void flash_warning (const char *msg);
411
412 void flash_put_data_internal (const uint8_t *p, uint16_t hw);
413 void flash_bool_write_internal (const uint8_t *p, int nr);
414 void flash_enum_write_internal (const uint8_t *p, int nr, uint8_t v);
415 void flash_cnt123_write_internal (const uint8_t *p, int which, int v);
416 void flash_do_write_internal (const uint8_t *p, int nr,
417                               const uint8_t *data, int len);
418
419 extern const uint8_t gnuk_string_serial[];
420
421 #define LED_ONESHOT               1
422 #define LED_TWOSHOTS              2
423 #define LED_SHOW_STATUS           4
424 #define LED_START_COMMAND         8
425 #define LED_FINISH_COMMAND       16
426 #define LED_FATAL                32
427 #define LED_USB_RESET            64
428 #define LED_GNUK_EXEC           128
429 void led_blink (int spec);
430
431 #if defined(PINPAD_SUPPORT)
432 # if defined(PINPAD_CIR_SUPPORT)
433 void cir_init (void);
434 # elif defined(PINPAD_DIAL_SUPPORT)
435 void dial_sw_disable (void);
436 void dial_sw_enable (void);
437 # elif defined(PINPAD_DND_SUPPORT)
438 void msc_init (void);
439 void msc_media_insert_change (int available);
440 int msc_scsi_write (uint32_t lba, const uint8_t *buf, size_t size);
441 int msc_scsi_read (uint32_t lba, const uint8_t **sector_p);
442 void msc_scsi_stop (uint8_t code);
443 # endif
444 #define PIN_INPUT_CURRENT 1
445 #define PIN_INPUT_NEW     2
446 #define PIN_INPUT_CONFIRM 3
447 #define MAX_PIN_CHARS 32
448 extern uint8_t pin_input_buffer[MAX_PIN_CHARS];
449 extern uint8_t pin_input_len;
450
451 int pinpad_getline (int msg_code, uint32_t timeout_usec);
452
453 #endif
454
455 extern uint8_t _regnual_start, __heap_end__[];