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