src/shared/dissect-image.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   Copyright 2016 Lennart Poettering
   6 ***/
   7
   8 #include <stdbool.h>
   9
  10 #include "sd-id128.h"
  11
  12 #include "macro.h"
  13
  14 typedef struct DissectedImage DissectedImage;
  15 typedef struct DissectedPartition DissectedPartition;
  16 typedef struct DecryptedImage DecryptedImage;
  17
  18 struct DissectedPartition {
  19         bool found:1;
  20         bool rw:1;
  21         int partno;        /* -1 if there was no partition and the images contains a file system directly */
  22         int architecture;  /* Intended architecture: either native, secondary or unset (-1). */
  23         sd_id128_t uuid;   /* Partition entry UUID as reported by the GPT */
  24         char *fstype;
  25         char *node;
  26         char *decrypted_node;
  27         char *decrypted_fstype;
  28 };
  29
  30 enum  {
  31         PARTITION_ROOT,
  32         PARTITION_ROOT_SECONDARY,  /* Secondary architecture */
  33         PARTITION_HOME,
  34         PARTITION_SRV,
  35         PARTITION_ESP,
  36         PARTITION_SWAP,
  37         PARTITION_ROOT_VERITY, /* verity data for the PARTITION_ROOT partition */
  38         PARTITION_ROOT_SECONDARY_VERITY, /* verity data for the PARTITION_ROOT_SECONDARY partition */
  39         _PARTITION_DESIGNATOR_MAX,
  40         _PARTITION_DESIGNATOR_INVALID = -1
  41 };
  42
  43 static inline int PARTITION_VERITY_OF(int p) {
  44         if (p == PARTITION_ROOT)
  45                 return PARTITION_ROOT_VERITY;
  46         if (p == PARTITION_ROOT_SECONDARY)
  47                 return PARTITION_ROOT_SECONDARY_VERITY;
  48         return _PARTITION_DESIGNATOR_INVALID;
  49 }
  50
  51 typedef enum DissectImageFlags {
  52         DISSECT_IMAGE_READ_ONLY           = 1 << 0,
  53         DISSECT_IMAGE_DISCARD_ON_LOOP     = 1 << 1,  /* Turn on "discard" if on a loop device and file system supports it */
  54         DISSECT_IMAGE_DISCARD             = 1 << 2,  /* Turn on "discard" if file system supports it, on all block devices */
  55         DISSECT_IMAGE_DISCARD_ON_CRYPTO   = 1 << 3,  /* Turn on "discard" also on crypto devices */
  56         DISSECT_IMAGE_DISCARD_ANY = DISSECT_IMAGE_DISCARD_ON_LOOP |
  57                                     DISSECT_IMAGE_DISCARD |
  58                                     DISSECT_IMAGE_DISCARD_ON_CRYPTO,
  59         DISSECT_IMAGE_GPT_ONLY            = 1 << 4,  /* Only recognize images with GPT partition tables */
  60         DISSECT_IMAGE_REQUIRE_ROOT        = 1 << 5,  /* Don't accept disks without root partition */
  61         DISSECT_IMAGE_MOUNT_ROOT_ONLY     = 1 << 6,  /* Mount only the root partition */
  62         DISSECT_IMAGE_MOUNT_NON_ROOT_ONLY = 1 << 7,  /* Mount only non-root partitions */
  63         DISSECT_IMAGE_VALIDATE_OS         = 1 << 8,  /* Refuse mounting images that aren't identifyable as OS images */
  64 } DissectImageFlags;
  65
  66 struct DissectedImage {
  67         bool encrypted:1;
  68         bool verity:1;     /* verity available and usable */
  69         bool can_verity:1; /* verity available, but not necessarily used */
  70
  71         DissectedPartition partitions[_PARTITION_DESIGNATOR_MAX];
  72
  73         char *hostname;
  74         sd_id128_t machine_id;
  75         char **machine_info;
  76         char **os_release;
  77 };
  78
  79 int probe_filesystem(const char *node, char **ret_fstype);
  80 int dissect_image(int fd, const void *root_hash, size_t root_hash_size, DissectImageFlags flags, DissectedImage **ret);
  81 int dissect_image_and_warn(int fd, const char *name, const void *root_hash, size_t root_hash_size, DissectImageFlags flags, DissectedImage **ret);
  82
  83 DissectedImage* dissected_image_unref(DissectedImage *m);
  84 DEFINE_TRIVIAL_CLEANUP_FUNC(DissectedImage*, dissected_image_unref);
  85
  86 int dissected_image_decrypt(DissectedImage *m, const char *passphrase, const void *root_hash, size_t root_hash_size, DissectImageFlags flags, DecryptedImage **ret);
  87 int dissected_image_decrypt_interactively(DissectedImage *m, const char *passphrase, const void *root_hash, size_t root_hash_size, DissectImageFlags flags, DecryptedImage **ret);
  88 int dissected_image_mount(DissectedImage *m, const char *dest, uid_t uid_shift, DissectImageFlags flags);
  89
  90 int dissected_image_acquire_metadata(DissectedImage *m);
  91
  92 DecryptedImage* decrypted_image_unref(DecryptedImage *p);
  93 DEFINE_TRIVIAL_CLEANUP_FUNC(DecryptedImage*, decrypted_image_unref);
  94 int decrypted_image_relinquish(DecryptedImage *d);
  95
  96 const char* partition_designator_to_string(int i) _const_;
  97 int partition_designator_from_string(const char *name) _pure_;
  98
  99 int root_hash_load(const char *image, void **ret, size_t *ret_size);