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