src/shared/dissect-image.h

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