contrib/cryptsetup/lib/utils.c

   1 #include <stdio.h>
   2 #include <string.h>
   3 #include <stdlib.h>
   4 #include <stddef.h>
   5 #include <stdarg.h>
   6 #include <errno.h>
   7 #include <linux/fs.h>
   8 #include <sys/types.h>
   9 #include <unistd.h>
  10 #include <sys/types.h>
  11 #include <sys/stat.h>
  12 #include <sys/ioctl.h>
  13 #include <fcntl.h>
  14 #include <termios.h>
  15 #include <sys/mman.h>
  16 #include <sys/resource.h>
  17
  18 #include "libcryptsetup.h"
  19 #include "internal.h"
  20
  21 struct safe_allocation {
  22         size_t  size;
  23         char    data[1];
  24 };
  25
  26 static char *error=NULL;
  27
  28 void set_error_va(const char *fmt, va_list va)
  29 {
  30         int r;
  31
  32         if(error) {
  33                 free(error);
  34                 error = NULL;
  35         }
  36
  37         if(!fmt) return;
  38
  39         r = vasprintf(&error, fmt, va);
  40         if (r < 0) {
  41                 free(error);
  42                 error = NULL;
  43                 return;
  44         }
  45
  46         if (r && error[r - 1] == '\n')
  47                 error[r - 1] = '\0';
  48 }
  49
  50 void set_error(const char *fmt, ...)
  51 {
  52         va_list va;
  53
  54         va_start(va, fmt);
  55         set_error_va(fmt, va);
  56         va_end(va);
  57 }
  58
  59 const char *get_error(void)
  60 {
  61         return error;
  62 }
  63
  64 void *safe_alloc(size_t size)
  65 {
  66         struct safe_allocation *alloc;
  67
  68         if (!size)
  69                 return NULL;
  70
  71         alloc = malloc(size + offsetof(struct safe_allocation, data));
  72         if (!alloc)
  73                 return NULL;
  74
  75         alloc->size = size;
  76
  77         return &alloc->data;
  78 }
  79
  80 void safe_free(void *data)
  81 {
  82         struct safe_allocation *alloc;
  83
  84         if (!data)
  85                 return;
  86
  87         alloc = data - offsetof(struct safe_allocation, data);
  88
  89         memset(data, 0, alloc->size);
  90
  91         alloc->size = 0x55aa55aa;
  92         free(alloc);
  93 }
  94
  95 void *safe_realloc(void *data, size_t size)
  96 {
  97         void *new_data;
  98
  99         new_data = safe_alloc(size);
 100
 101         if (new_data && data) {
 102                 struct safe_allocation *alloc;
 103
 104                 alloc = data - offsetof(struct safe_allocation, data);
 105
 106                 if (size > alloc->size)
 107                         size = alloc->size;
 108
 109                 memcpy(new_data, data, size);
 110         }
 111
 112         safe_free(data);
 113         return new_data;
 114 }
 115
 116 char *safe_strdup(const char *s)
 117 {
 118         char *s2 = safe_alloc(strlen(s) + 1);
 119
 120         if (!s2)
 121                 return NULL;
 122
 123         return strcpy(s2, s);
 124 }
 125
 126 static int get_alignment(int fd)
 127 {
 128         int alignment = DEFAULT_ALIGNMENT;
 129
 130 #ifdef _PC_REC_XFER_ALIGN
 131         alignment = fpathconf(fd, _PC_REC_XFER_ALIGN);
 132         if (alignment < 0)
 133                 alignment = DEFAULT_ALIGNMENT;
 134 #endif
 135         return alignment;
 136 }
 137
 138 static void *aligned_malloc(void **base, int size, int alignment)
 139 {
 140 #ifdef HAVE_POSIX_MEMALIGN
 141         return posix_memalign(base, alignment, size) ? NULL : *base;
 142 #else
 143 /* Credits go to Michal's padlock patches for this alignment code */
 144         char *ptr;
 145
 146         ptr  = malloc(size + alignment);
 147         if(ptr == NULL) return NULL;
 148
 149         *base = ptr;
 150         if(alignment > 1 && ((long)ptr & (alignment - 1))) {
 151                 ptr += alignment - ((long)(ptr) & (alignment - 1));
 152         }
 153         return ptr;
 154 #endif
 155 }
 156 static int sector_size(int fd)
 157 {
 158         int bsize;
 159         if (ioctl(fd,BLKSSZGET, &bsize) < 0)
 160                 return -EINVAL;
 161         else
 162                 return bsize;
 163 }
 164
 165 int sector_size_for_device(const char *device)
 166 {
 167         int fd = open(device, O_RDONLY);
 168         int r;
 169         if(fd < 0)
 170                 return -EINVAL;
 171         r = sector_size(fd);
 172         close(fd);
 173         return r;
 174 }
 175
 176 ssize_t write_blockwise(int fd, const void *orig_buf, size_t count)
 177 {
 178         void *hangover_buf, *hangover_buf_base = NULL;
 179         void *buf, *buf_base = NULL;
 180         int r, hangover, solid, bsize, alignment;
 181         ssize_t ret = -1;
 182
 183         if ((bsize = sector_size(fd)) < 0)
 184                 return bsize;
 185
 186         hangover = count % bsize;
 187         solid = count - hangover;
 188         alignment = get_alignment(fd);
 189
 190         if ((long)orig_buf & (alignment - 1)) {
 191                 buf = aligned_malloc(&buf_base, count, alignment);
 192                 if (!buf)
 193                         goto out;
 194                 memcpy(buf, orig_buf, count);
 195         } else
 196                 buf = (void *)orig_buf;
 197
 198         r = write(fd, buf, solid);
 199         if (r < 0 || r != solid)
 200                 goto out;
 201
 202         if (hangover) {
 203                 hangover_buf = aligned_malloc(&hangover_buf_base, bsize, alignment);
 204                 if (!hangover_buf)
 205                         goto out;
 206
 207                 r = read(fd, hangover_buf, bsize);
 208                 if(r < 0 || r != bsize) goto out;
 209
 210                 r = lseek(fd, -bsize, SEEK_CUR);
 211                 if (r < 0)
 212                         goto out;
 213                 memcpy(hangover_buf, buf + solid, hangover);
 214
 215                 r = write(fd, hangover_buf, bsize);
 216                 if(r < 0 || r != bsize) goto out;
 217                 free(hangover_buf_base);
 218         }
 219         ret = count;
 220  out:
 221         if (buf != orig_buf)
 222                 free(buf_base);
 223         return ret;
 224 }
 225
 226 ssize_t read_blockwise(int fd, void *orig_buf, size_t count) {
 227         void *hangover_buf, *hangover_buf_base;
 228         void *buf, *buf_base = NULL;
 229         int r, hangover, solid, bsize, alignment;
 230         ssize_t ret = -1;
 231
 232         if ((bsize = sector_size(fd)) < 0)
 233                 return bsize;
 234
 235         hangover = count % bsize;
 236         solid = count - hangover;
 237         alignment = get_alignment(fd);
 238
 239         if ((long)orig_buf & (alignment - 1)) {
 240                 buf = aligned_malloc(&buf_base, count, alignment);
 241                 if (!buf)
 242                         goto out;
 243         } else
 244                 buf = orig_buf;
 245
 246         r = read(fd, buf, solid);
 247         if(r < 0 || r != solid)
 248                 goto out;
 249
 250         if (hangover) {
 251                 hangover_buf = aligned_malloc(&hangover_buf_base, bsize, alignment);
 252                 if (!hangover_buf)
 253                         goto out;
 254                 r = read(fd, hangover_buf, bsize);
 255                 if (r <  0 || r != bsize)
 256                         goto out;
 257
 258                 memcpy(buf + solid, hangover_buf, hangover);
 259                 free(hangover_buf_base);
 260         }
 261         ret = count;
 262  out:
 263         if (buf != orig_buf) {
 264                 memcpy(orig_buf, buf, count);
 265                 free(buf_base);
 266         }
 267         return ret;
 268 }
 269
 270 /*
 271  * Combines llseek with blockwise write. write_blockwise can already deal with short writes
 272  * but we also need a function to deal with short writes at the start. But this information
 273  * is implicitly included in the read/write offset, which can not be set to non-aligned
 274  * boundaries. Hence, we combine llseek with write.
 275  */
 276
 277 ssize_t write_lseek_blockwise(int fd, const char *buf, size_t count, off_t offset) {
 278         int bsize = sector_size(fd);
 279         const char *orig_buf = buf;
 280         char frontPadBuf[bsize];
 281         int frontHang = offset % bsize;
 282         int r;
 283         int innerCount = count < bsize ? count : bsize;
 284
 285         if (bsize < 0)
 286                 return bsize;
 287
 288         lseek(fd, offset - frontHang, SEEK_SET);
 289         if(offset % bsize) {
 290                 r = read(fd,frontPadBuf,bsize);
 291                 if(r < 0) return -1;
 292
 293                 memcpy(frontPadBuf+frontHang, buf, innerCount);
 294
 295                 lseek(fd, offset - frontHang, SEEK_SET);
 296                 r = write(fd,frontPadBuf,bsize);
 297                 if(r < 0) return -1;
 298
 299                 buf += innerCount;
 300                 count -= innerCount;
 301         }
 302         if(count <= 0) return buf - orig_buf;
 303
 304         return write_blockwise(fd, buf, count) + innerCount;
 305 }
 306
 307 /* Password reading helpers */
 308
 309 static int untimed_read(int fd, char *pass, size_t maxlen)
 310 {
 311         ssize_t i;
 312
 313         i = read(fd, pass, maxlen);
 314         if (i > 0) {
 315                 pass[i-1] = '\0';
 316                 i = 0;
 317         } else if (i == 0) { /* EOF */
 318                 *pass = 0;
 319                 i = -1;
 320         }
 321         return i;
 322 }
 323
 324 static int timed_read(int fd, char *pass, size_t maxlen, long timeout)
 325 {
 326         struct timeval t;
 327         fd_set fds;
 328         int failed = -1;
 329
 330         FD_ZERO(&fds);
 331         FD_SET(fd, &fds);
 332         t.tv_sec = timeout;
 333         t.tv_usec = 0;
 334
 335         if (select(fd+1, &fds, NULL, NULL, &t) > 0)
 336                 failed = untimed_read(fd, pass, maxlen);
 337
 338         return failed;
 339 }
 340
 341 static int interactive_pass(const char *prompt, char *pass, size_t maxlen,
 342                 long timeout)
 343 {
 344         struct termios orig, tmp;
 345         int failed = -1;
 346         int infd = STDIN_FILENO, outfd;
 347
 348         if (maxlen < 1)
 349                 goto out_err;
 350
 351         /* Read and write to /dev/tty if available */
 352         if ((infd = outfd = open("/dev/tty", O_RDWR)) == -1) {
 353                 infd = STDIN_FILENO;
 354                 outfd = STDERR_FILENO;
 355         }
 356
 357         if (tcgetattr(infd, &orig))
 358                 goto out_err;
 359
 360         memcpy(&tmp, &orig, sizeof(tmp));
 361         tmp.c_lflag &= ~ECHO;
 362
 363         if (write(outfd, prompt, strlen(prompt)) < 0)
 364                 goto out_err;
 365
 366         tcsetattr(infd, TCSAFLUSH, &tmp);
 367         if (timeout)
 368                 failed = timed_read(infd, pass, maxlen, timeout);
 369         else
 370                 failed = untimed_read(infd, pass, maxlen);
 371         tcsetattr(infd, TCSAFLUSH, &orig);
 372
 373 out_err:
 374         if (!failed && write(outfd, "\n", 1));
 375
 376         if (infd != STDIN_FILENO)
 377                 close(infd);
 378         return failed;
 379 }
 380
 381 /*
 382  * Password reading behaviour matrix of get_key
 383  * FIXME: rewrite this from scratch.
 384  *                    p   v   n   h
 385  * -----------------+---+---+---+---
 386  * interactive      | Y | Y | Y | Inf
 387  * from fd          | N | N | Y | Inf
 388  * from binary file | N | N | N | Inf or options->key_size
 389  *
 390  * Legend: p..prompt, v..can verify, n..newline-stop, h..read horizon
 391  *
 392  * Note: --key-file=- is interpreted as a read from a binary file (stdin)
 393  */
 394
 395 void get_key(char *prompt, char **key, unsigned int *passLen, int key_size,
 396             const char *key_file, int timeout, int how2verify,
 397             struct crypt_device *cd)
 398 {
 399         int fd = -1;
 400         const int verify = how2verify & CRYPT_FLAG_VERIFY;
 401         const int verify_if_possible = how2verify & CRYPT_FLAG_VERIFY_IF_POSSIBLE;
 402         char *pass = NULL;
 403         int read_horizon;
 404         int regular_file = 0;
 405         int read_stdin;
 406         int r;
 407         struct stat st;
 408
 409         /* Passphrase read from stdin? */
 410         read_stdin = (!key_file || !strcmp(key_file, "-")) ? 1 : 0;
 411
 412         /* read_horizon applies only for real keyfile, not stdin or terminal */
 413         read_horizon = (key_file && !read_stdin) ? key_size : 0 /* until EOF */;
 414
 415         /* Setup file descriptior */
 416         fd = read_stdin ? STDIN_FILENO : open(key_file, O_RDONLY);
 417         if (fd < 0) {
 418                 log_err(cd, _("Failed to open key file %s.\n"), key_file ?: "-");
 419                 goto out_err;
 420         }
 421
 422         /* Interactive case */
 423         if(isatty(fd)) {
 424                 int i;
 425
 426                 pass = safe_alloc(MAX_TTY_PASSWORD_LEN);
 427                 if (!pass || (i = interactive_pass(prompt, pass, MAX_TTY_PASSWORD_LEN, timeout))) {
 428                         log_err(cd, _("Error reading passphrase from terminal.\n"));
 429                         goto out_err;
 430                 }
 431                 if (verify || verify_if_possible) {
 432                         char pass_verify[MAX_TTY_PASSWORD_LEN];
 433                         i = interactive_pass(_("Verify passphrase: "), pass_verify, sizeof(pass_verify), timeout);
 434                         if (i || strcmp(pass, pass_verify) != 0) {
 435                                 log_err(cd, _("Passphrases do not match.\n"));
 436                                 goto out_err;
 437                         }
 438                         memset(pass_verify, 0, sizeof(pass_verify));
 439                 }
 440                 *passLen = strlen(pass);
 441                 *key = pass;
 442         } else {
 443                 /*
 444                  * This is either a fd-input or a file, in neither case we can verify the input,
 445                  * however we don't stop on new lines if it's a binary file.
 446                  */
 447                 int buflen, i;
 448
 449                 if(verify) {
 450                         log_err(cd, _("Can't do passphrase verification on non-tty inputs.\n"));
 451                         goto out_err;
 452                 }
 453                 /* The following for control loop does an exhausting
 454                  * read on the key material file, if requested with
 455                  * key_size == 0, as it's done by LUKS. However, we
 456                  * should warn the user, if it's a non-regular file,
 457                  * such as /dev/random, because in this case, the loop
 458                  * will read forever.
 459                  */
 460                 if(!read_stdin && read_horizon == 0) {
 461                         if(stat(key_file, &st) < 0) {
 462                                 log_err(cd, _("Failed to stat key file %s.\n"), key_file);
 463                                 goto out_err;
 464                         }
 465                         if(!S_ISREG(st.st_mode))
 466                                 log_std(cd, _("Warning: exhausting read requested, but key file %s"
 467                                         " is not a regular file, function might never return.\n"),
 468                                         key_file);
 469                         else
 470                                 regular_file = 1;
 471                 }
 472                 buflen = 0;
 473                 for(i = 0; read_horizon == 0 || i < read_horizon; i++) {
 474                         if(i >= buflen - 1) {
 475                                 buflen += 128;
 476                                 pass = safe_realloc(pass, buflen);
 477                                 if (!pass) {
 478                                         log_err(cd, _("Out of memory while reading passphrase.\n"));
 479                                         goto out_err;
 480                                 }
 481                         }
 482
 483                         r = read(fd, pass + i, 1);
 484                         if (r < 0) {
 485                                 log_err(cd, _("Error reading passphrase.\n"));
 486                                 goto out_err;
 487                         }
 488
 489                         /* Stop on newline only if not requested read from keyfile */
 490                         if(r == 0 || (!key_file && pass[i] == '\n'))
 491                                 break;
 492                 }
 493                 /* Fail if piped input dies reading nothing */
 494                 if(!i && !regular_file) {
 495                         log_dbg("Error reading passphrase.");
 496                         goto out_err;
 497                 }
 498                 pass[i] = 0;
 499                 *key = pass;
 500                 *passLen = i;
 501         }
 502         if(fd != STDIN_FILENO)
 503                 close(fd);
 504         return;
 505
 506 out_err:
 507         if(fd >= 0 && fd != STDIN_FILENO)
 508                 close(fd);
 509         if(pass)
 510                 safe_free(pass);
 511         *key = NULL;
 512         *passLen = 0;
 513 }
 514
 515 int device_ready(struct crypt_device *cd, const char *device, int mode)
 516 {
 517         int devfd, r = 1;
 518         ssize_t s;
 519         struct stat st;
 520         char buf[512];
 521
 522         if(stat(device, &st) < 0) {
 523                 log_err(cd, _("Device %s doesn't exist or access denied.\n"), device);
 524                 return 0;
 525         }
 526
 527         log_dbg("Trying to open and read device %s.", device);
 528         devfd = open(device, mode | O_DIRECT | O_SYNC);
 529         if(devfd < 0) {
 530                 log_err(cd, _("Cannot open device %s for %s%s access.\n"), device,
 531                         (mode & O_EXCL) ? _("exclusive ") : "",
 532                         (mode & O_RDWR) ? _("writable") : _("read-only"));
 533                 return 0;
 534         }
 535
 536          /* Try to read first sector */
 537         s = read_blockwise(devfd, buf, sizeof(buf));
 538         if (s < 0 || s != sizeof(buf)) {
 539                 log_err(cd, _("Cannot read device %s.\n"), device);
 540                 r = 0;
 541         }
 542
 543         memset(buf, 0, sizeof(buf));
 544         close(devfd);
 545
 546         return r;
 547 }
 548
 549 int get_device_infos(const char *device, struct device_infos *infos, struct crypt_device *cd)
 550 {
 551         uint64_t size;
 552         unsigned long size_small;
 553         int readonly = 0;
 554         int ret = -1;
 555         int fd;
 556
 557         /* Try to open read-write to check whether it is a read-only device */
 558         fd = open(device, O_RDWR);
 559         if (fd < 0) {
 560                 if (errno == EROFS) {
 561                         readonly = 1;
 562                         fd = open(device, O_RDONLY);
 563                 }
 564         } else {
 565                 close(fd);
 566                 fd = open(device, O_RDONLY);
 567         }
 568         if (fd < 0) {
 569                 log_err(cd, _("Cannot open device: %s\n"), device);
 570                 return -1;
 571         }
 572
 573 #ifdef BLKROGET
 574         /* If the device can be opened read-write, i.e. readonly is still 0, then
 575          * check whether BKROGET says that it is read-only. E.g. read-only loop
 576          * devices may be openend read-write but are read-only according to BLKROGET
 577          */
 578         if (readonly == 0 && ioctl(fd, BLKROGET, &readonly) < 0) {
 579                 log_err(cd, _("BLKROGET failed on device %s.\n"), device);
 580                 goto out;
 581         }
 582 #else
 583 #error BLKROGET not available
 584 #endif
 585
 586 #ifdef BLKGETSIZE64
 587         if (ioctl(fd, BLKGETSIZE64, &size) >= 0) {
 588                 size >>= SECTOR_SHIFT;
 589                 ret = 0;
 590                 goto out;
 591         }
 592 #endif
 593
 594 #ifdef BLKGETSIZE
 595         if (ioctl(fd, BLKGETSIZE, &size_small) >= 0) {
 596                 size = (uint64_t)size_small;
 597                 ret = 0;
 598                 goto out;
 599         }
 600 #else
 601 #       error Need at least the BLKGETSIZE ioctl!
 602 #endif
 603
 604         log_err(cd, _("BLKGETSIZE failed on device %s.\n"), device);
 605 out:
 606         if (ret == 0) {
 607                 infos->size = size;
 608                 infos->readonly = readonly;
 609         }
 610         close(fd);
 611         return ret;
 612 }
 613
 614 int wipe_device_header(const char *device, int sectors)
 615 {
 616         char *buffer;
 617         int size = sectors * SECTOR_SIZE;
 618         int r = -1;
 619         int devfd;
 620
 621         devfd = open(device, O_RDWR | O_DIRECT | O_SYNC);
 622         if(devfd == -1)
 623                 return -EINVAL;
 624
 625         buffer = malloc(size);
 626         if (!buffer) {
 627                 close(devfd);
 628                 return -ENOMEM;
 629         }
 630         memset(buffer, 0, size);
 631
 632         r = write_blockwise(devfd, buffer, size) < size ? -EIO : 0;
 633
 634         free(buffer);
 635         close(devfd);
 636
 637         return r;
 638 }
 639
 640 /* MEMLOCK */
 641 #define DEFAULT_PROCESS_PRIORITY -18
 642
 643 static int _priority;
 644 static int _memlock_count = 0;
 645
 646 // return 1 if memory is locked
 647 int crypt_memlock_inc(struct crypt_device *ctx)
 648 {
 649         if (!_memlock_count++) {
 650                 log_dbg("Locking memory.");
 651                 if (mlockall(MCL_CURRENT | MCL_FUTURE)) {
 652                         log_err(ctx, _("WARNING!!! Possibly insecure memory. Are you root?\n"));
 653                         _memlock_count--;
 654                         return 0;
 655                 }
 656                 errno = 0;
 657                 if (((_priority = getpriority(PRIO_PROCESS, 0)) == -1) && errno)
 658                         log_err(ctx, _("Cannot get process priority.\n"));
 659                 else
 660                         if (setpriority(PRIO_PROCESS, 0, DEFAULT_PROCESS_PRIORITY))
 661                                 log_err(ctx, _("setpriority %u failed: %s"),
 662                                         DEFAULT_PROCESS_PRIORITY, strerror(errno));
 663         }
 664         return _memlock_count ? 1 : 0;
 665 }
 666
 667 int crypt_memlock_dec(struct crypt_device *ctx)
 668 {
 669         if (_memlock_count && (!--_memlock_count)) {
 670                 log_dbg("Unlocking memory.");
 671                 if (munlockall())
 672                         log_err(ctx, _("Cannot unlock memory."));
 673                 if (setpriority(PRIO_PROCESS, 0, _priority))
 674                         log_err(ctx, _("setpriority %u failed: %s"), _priority, strerror(errno));
 675         }
 676         return _memlock_count ? 1 : 0;
 677 }
 678
 679 /* DEVICE TOPOLOGY */
 680
 681 /* block device topology ioctls, introduced in 2.6.32 */
 682 #ifndef BLKIOMIN
 683 #define BLKIOMIN    _IO(0x12,120)
 684 #define BLKIOOPT    _IO(0x12,121)
 685 #define BLKALIGNOFF _IO(0x12,122)
 686 #endif
 687
 688 void get_topology_alignment(const char *device,
 689                             unsigned long *required_alignment, /* bytes */
 690                             unsigned long *alignment_offset,   /* bytes */
 691                             unsigned long default_alignment)
 692 {
 693         unsigned int dev_alignment_offset = 0;
 694         unsigned long min_io_size = 0, opt_io_size = 0;
 695         int fd;
 696
 697         *required_alignment = default_alignment;
 698         *alignment_offset = 0;
 699
 700         fd = open(device, O_RDONLY);
 701         if (fd == -1)
 702                 return;
 703
 704         /* minimum io size */
 705         if (ioctl(fd, BLKIOMIN, &min_io_size) == -1) {
 706                 log_dbg("Topology info for %s not supported, using default offset %lu bytes.",
 707                         device, default_alignment);
 708                 goto out;
 709         }
 710
 711         /* optimal io size */
 712         if (ioctl(fd, BLKIOOPT, &opt_io_size) == -1)
 713                 opt_io_size = min_io_size;
 714
 715         /* alignment offset, bogus -1 means misaligned/unknown */
 716         if (ioctl(fd, BLKALIGNOFF, &dev_alignment_offset) == -1 || (int)dev_alignment_offset < 0)
 717                 dev_alignment_offset = 0;
 718
 719         if (*required_alignment < min_io_size)
 720                 *required_alignment = min_io_size;
 721
 722         if (*required_alignment < opt_io_size)
 723                 *required_alignment = opt_io_size;
 724
 725         *alignment_offset = (unsigned long)dev_alignment_offset;
 726
 727         log_dbg("Topology: IO (%lu/%lu), offset = %lu; Required alignment is %lu bytes.",
 728                 min_io_size, opt_io_size, *alignment_offset, *required_alignment);
 729 out:
 730         (void)close(fd);
 731 }