g13: Re-factor high level create code.
[gnupg.git] / g13 / sh-dmcrypt.c
1 /* sh-dmcrypt.c - The DM-Crypt part for g13-syshelp
2  * Copyright (C) 2015 Werner Koch
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 #include <config.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <stdarg.h>
25 #include <errno.h>
26 #include <assert.h>
27 #include <sys/types.h>
28 #ifdef HAVE_STAT
29 # include <sys/stat.h>
30 #endif
31 #include <unistd.h>
32
33 #include "g13-syshelp.h"
34 #include <assuan.h>
35 #include "i18n.h"
36 #include "utils.h"
37 #include "exectool.h"
38 #include "keyblob.h"
39
40 /* The standard disk block size (logical).  */
41 #define SECTOR_SIZE 512
42
43 /* The physical block size used by modern devices.  */
44 #define PHY_SECTOR_SIZE  (SECTOR_SIZE*8)  /* 4 KiB */
45
46 /* The length of the crypto setup area in sectors.  16 KiB is a nice
47    multiple of a modern block size and should be sufficient for all
48    kind of extra public key encryption packet.  */
49 #define SETUP_AREA_SECTORS 32  /* 16 KiB */
50
51 /* The number of header block copies stored at the begin and end of
52    the device.  */
53 #define HEADER_SETUP_AREA_COPIES 2
54 #define FOOTER_SETUP_AREA_COPIES 2
55
56 /* The length in blocks of the space we put at the start and at the
57    end of the device.  This space is used to store N copies of the
58    setup area for the actual encrypted container inbetween.  */
59 #define HEADER_SECTORS (SETUP_AREA_SECTORS * HEADER_SETUP_AREA_COPIES)
60 #define FOOTER_SECTORS (SETUP_AREA_SECTORS * FOOTER_SETUP_AREA_COPIES)
61
62 /* Minimim size of the encrypted space in blocks.  This is more or
63    less an arbitrary value.  */
64 #define MIN_ENCRYPTED_SPACE 32
65
66 /* Some consistency checks for the above constants.  */
67 #if (PHY_SECTOR_SIZE % SECTOR_SIZE)
68 # error the physical secotor size should be a multiple of 512
69 #endif
70 #if ((SETUP_AREA_SECTORS*SECTOR_SIZE) % PHY_SECTOR_SIZE)
71 # error The setup area size should be a multiple of the phy. sector size.
72 #endif
73
74
75 /* Check whether the block device DEVNAME is used by device mapper.
76    Returns: 0 if the device is good and not yet used by DM.  */
77 static gpg_error_t
78 check_blockdev (const char *devname)
79 {
80   gpg_error_t err;
81   struct stat sb;
82   unsigned int devmajor, devminor;
83   char *result = NULL;
84   char **lines = NULL;
85   char **fields = NULL;
86   int lno, count;
87
88   if (stat (devname, &sb))
89     {
90       err = gpg_error_from_syserror ();
91       log_error ("error stating '%s': %s\n", devname, gpg_strerror (err));
92       return err;
93     }
94   if (!S_ISBLK (sb.st_mode))
95     {
96       err = gpg_error (GPG_ERR_ENOTBLK);
97       log_error ("can't use '%s': %s\n", devname, gpg_strerror (err));
98       return err;
99     }
100   devmajor = major (sb.st_rdev);
101   devminor = minor (sb.st_rdev);
102
103   {
104     const char *argv[2];
105
106     argv[0] = "deps";
107     argv[1] = NULL;
108     err = gnupg_exec_tool ("/sbin/dmsetup", argv, NULL, &result, NULL);
109   }
110   if (err)
111     {
112       log_error ("error running '%s' to search for '%s': %s\n",
113                  "dmsetup deps", devname, gpg_strerror (err));
114       goto leave;
115     }
116   lines = strsplit (result, '\n', 0, NULL);
117   if (!lines)
118     {
119       err = gpg_error_from_syserror ();
120       goto leave;
121     }
122   if (lines[0] && !strcmp (lines[0], "No devices found"))
123     ;
124   else
125     {
126       for (lno=0; lines[lno]; lno++)
127         {
128           unsigned int xmajor, xminor;
129
130           if (!*lines[lno])
131             continue;
132           xfree (fields);
133           fields = strsplit (lines[lno], ':', 0, &count);
134           if (!fields)
135             {
136               err = gpg_error_from_syserror ();
137               goto leave;
138             }
139           if (count < 3
140               || sscanf (fields[2], " (%u,%u)", &xmajor, &xminor) != 2)
141             {
142               log_error ("error running '%s' to search for '%s': %s\n",
143                          "dmsetup deps", devname, "unexpected output");
144               err = gpg_error (GPG_ERR_INV_VALUE);
145               goto leave;
146             }
147
148           if (xmajor == devmajor && xminor == devminor)
149             {
150               log_error ("device '%s' (%u:%u) already used by device mapper\n",
151                          devname, devmajor, devminor);
152               err = gpg_error (GPG_ERR_EBUSY);
153               goto leave;
154             }
155         }
156     }
157
158
159  leave:
160   xfree (fields);
161   xfree (lines);
162   xfree (result);
163   return err;
164 }
165
166
167 /* Return a malloced buffer with the prefix of the setup area.  This
168    is the data written right before the encrypted keyblob.  Return NULL
169    on error and sets ERRNO.  */
170 static void *
171 mk_setup_area_prefix (size_t *r_length)
172 {
173   unsigned char *packet;
174   size_t setuparealen;
175
176   packet = xtrymalloc (32);
177   if (!packet)
178     return NULL;
179   *r_length = 32;
180
181   setuparealen = SETUP_AREA_SECTORS * SECTOR_SIZE;
182
183   packet[0] = (0xc0|61); /* CTB for the private packet type 0x61.  */
184   packet[1] = 0xff;      /* 5 byte length packet, value 20.  */
185   packet[2] = 0;
186   packet[3] = 0;
187   packet[4] = 0;
188   packet[5] = 26;
189   memcpy (packet+6, "GnuPG/G13", 10); /* Packet subtype.  */
190   packet[16] = 1;   /* G13 packet format version.  */
191   packet[17] = 0;   /* Reserved.  */
192   packet[18] = 0;   /* Reserved.  */
193   packet[19] = 1;   /* OS Flag = Linux  */
194   packet[20] = (setuparealen >> 24);  /* Total length of header.  */
195   packet[21] = (setuparealen >> 16);
196   packet[22] = (setuparealen >> 8);
197   packet[23] = (setuparealen);
198   packet[24] = HEADER_SETUP_AREA_COPIES;
199   packet[25] = FOOTER_SETUP_AREA_COPIES;
200   packet[26] = 0;   /* Reserved.  */
201   packet[27] = 0;   /* Reserved.  */
202   packet[28] = 0;   /* Reserved.  */
203   packet[29] = 0;   /* Reserved.  */
204   packet[30] = 0;   /* Reserved.  */
205   packet[31] = 0;   /* Reserved.  */
206
207   return packet;
208 }
209
210
211 gpg_error_t
212 sh_dmcrypt_create_container (ctrl_t ctrl, const char *devname, estream_t devfp)
213 {
214   gpg_error_t err;
215   char *header_space;
216   char *targetname = NULL;
217   size_t nread;
218   char *p;
219   char hexkey[16*2+1];
220   char *table = NULL;
221   unsigned long long nblocks;
222   char *result = NULL;
223   unsigned char twobyte[2];
224   membuf_t keyblob;
225   void  *keyblob_buf = NULL;
226   size_t keyblob_len;
227   size_t n;
228   const char *s;
229
230   if (!ctrl->devti)
231     return gpg_error (GPG_ERR_INV_ARG);
232
233   header_space = xtrymalloc (HEADER_SECTORS * SECTOR_SIZE);
234   if (!header_space)
235     return gpg_error_from_syserror ();
236
237   /* Start building the keyblob.  */
238   init_membuf (&keyblob, 512);
239   append_tuple (&keyblob, KEYBLOB_TAG_BLOBVERSION, "\x01", 1);
240   n = CONTTYPE_DM_CRYPT;
241   twobyte[0] = (n >> 8);
242   twobyte[1] = n;
243   append_tuple (&keyblob, KEYBLOB_TAG_CONTTYPE, twobyte, 2);
244   {
245     gnupg_isotime_t tbuf;
246
247     gnupg_get_isotime (tbuf);
248     append_tuple (&keyblob, KEYBLOB_TAG_CREATED, tbuf, strlen (tbuf));
249   }
250
251   /* Rewind out stream.  */
252   if (es_fseeko (devfp, 0, SEEK_SET))
253     {
254       err = gpg_error_from_syserror ();
255       log_error ("error seeking to begin of '%s': %s\n",
256                  devname, gpg_strerror (err));
257       goto leave;
258     }
259   es_clearerr (devfp);
260
261   /* Extra check that the device is empty.  */
262   if (es_read (devfp, header_space, HEADER_SECTORS * SECTOR_SIZE, &nread))
263     err = gpg_error_from_syserror ();
264   else if (nread != HEADER_SECTORS * SECTOR_SIZE)
265     err = gpg_error (GPG_ERR_TOO_SHORT);
266   else
267     err = 0;
268   if (err)
269     {
270       log_error ("error reading header space of '%s': %s\n",
271                  devname, gpg_strerror (err));
272       goto leave;
273     }
274   for (p=header_space; nread && !*p; nread--, p++)
275     ;
276   if (nread)
277     {
278       log_error ("header space of '%s' already used - use %s to override\n",
279                  devname, "--force");
280       err = gpg_error (GPG_ERR_NOT_SUPPORTED);
281       goto leave;
282     }
283
284   /* Check that the device is not used by device mapper. */
285   err = check_blockdev (devname);
286   if (err)
287     goto leave;
288
289   /* Compute the number of blocks.  */
290   err = sh_blockdev_getsz (devname, &nblocks);
291   if (err)
292     {
293       log_error ("error getting size of '%s': %s\n",
294                  devname, gpg_strerror (err));
295       goto leave;
296     }
297   if (nblocks <= HEADER_SECTORS + MIN_ENCRYPTED_SPACE + FOOTER_SECTORS)
298     {
299       log_error ("device '%s' is too small (min=%d blocks)\n",
300                  devname,
301                  HEADER_SECTORS + MIN_ENCRYPTED_SPACE + FOOTER_SECTORS);
302       err = gpg_error (GPG_ERR_TOO_SHORT);
303       goto leave;
304     }
305   nblocks -= HEADER_SECTORS + FOOTER_SECTORS;
306
307   /* Device mapper needs a name for the device: Take it from the label
308      or use "0".  */
309   targetname = strconcat ("g13-", ctrl->client.uname, "-",
310                           ctrl->devti->label? ctrl->devti->label : "0",
311                           NULL);
312   if (!targetname)
313     {
314       err = gpg_error_from_syserror ();
315       goto leave;
316     }
317
318   /* Create the key.  */
319   {
320     char key[16];
321     gcry_randomize (key, sizeof key, GCRY_STRONG_RANDOM);
322     append_tuple (&keyblob, KEYBLOB_TAG_ENCKEY, key, sizeof key);
323     bin2hex (key, 16, hexkey);
324     wipememory (key, 16);
325     /* Add a 2*(4+16) byte filler to conceal the fact that we use
326        AES-128.  If we ever want to switch to 256 bit we can resize
327        that filler to keep the keyblob at the same size.  */
328     append_tuple (&keyblob, KEYBLOB_TAG_FILLER, key, sizeof key);
329     append_tuple (&keyblob, KEYBLOB_TAG_FILLER, key, sizeof key);
330   }
331
332   /* Build dmcrypt table. */
333   s = "aes-cbc-essiv:sha256";
334   append_tuple (&keyblob, KEYBLOB_TAG_ALGOSTR, s, strlen (s));
335   table = es_bsprintf ("0 %llu crypt %s %s 0 %s %d",
336                        nblocks, s, hexkey, devname, HEADER_SECTORS);
337   if (!table)
338     {
339       err = gpg_error_from_syserror ();
340       goto leave;
341     }
342   wipememory (hexkey, sizeof hexkey);
343
344   /* Add a copy of the setup area prefix to the keyblob.  */
345   p = mk_setup_area_prefix (&n);
346   if (!p)
347     {
348       err = gpg_error_from_syserror ();
349       goto leave;
350     }
351   append_tuple (&keyblob, KEYBLOB_TAG_HDRCOPY, p, n);
352
353   /* Turn the keyblob into a buffer and callback to encrypt it.  */
354   keyblob_buf = get_membuf (&keyblob, &keyblob_len);
355   if (!keyblob_buf)
356     {
357       err = gpg_error_from_syserror ();
358       goto leave;
359     }
360   err = sh_encrypt_keyblob (ctrl, keyblob_buf, keyblob_len, &p, &n);
361   if (err)
362     {
363       log_error ("encrypting the keyblob failed: %s\n", gpg_strerror (err));
364       goto leave;
365     }
366   wipememory (keyblob_buf, keyblob_len);
367   xfree (keyblob_buf);
368   keyblob_buf = NULL;
369
370   /* Create the container.  */
371   /* { */
372   /*   const char *argv[3]; */
373
374   /*   argv[0] = "create"; */
375   /*   argv[1] = targetname; */
376   /*   argv[2] = NULL; */
377   /*   err = sh_exec_tool ("/sbin/dmsetup", argv, table, &result, NULL); */
378   /* } */
379   /* if (err) */
380   /*   { */
381   /*     log_error ("error running dmsetup for '%s': %s\n", */
382   /*                devname, gpg_strerror (err)); */
383   /*     goto leave; */
384   /*   } */
385   /* log_debug ("dmsetup result: %s\n", result); */
386
387   /* Write the setup area.  */
388
389
390  leave:
391   wipememory (hexkey, sizeof hexkey);
392   if (table)
393     {
394       wipememory (table, strlen (table));
395       xfree (table);
396     }
397   if (keyblob_buf)
398     {
399       wipememory (keyblob_buf, keyblob_len);
400       xfree (keyblob_buf);
401     }
402   xfree (get_membuf (&keyblob, NULL));
403   xfree (targetname);
404   xfree (result);
405   xfree (header_space);
406   return err;
407 }