src/home/homework.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <linux/fs.h>
   5 #include <sys/vfs.h>
   6
   7 #include "sd-id128.h"
   8
   9 #include "loop-util.h"
  10 #include "user-record.h"
  11 #include "user-record-util.h"
  12
  13 typedef struct HomeSetup {
  14         char *dm_name;
  15         char *dm_node;
  16
  17         LoopDevice *loop;
  18         struct crypt_device *crypt_device;
  19         int root_fd;
  20         int image_fd;
  21         sd_id128_t found_partition_uuid;
  22         sd_id128_t found_luks_uuid;
  23         sd_id128_t found_fs_uuid;
  24
  25         uint8_t fscrypt_key_descriptor[FS_KEY_DESCRIPTOR_SIZE];
  26
  27         void *volume_key;
  28         size_t volume_key_size;
  29
  30         bool undo_dm;
  31         bool undo_mount;
  32         bool do_offline_fitrim;
  33         bool do_offline_fallocate;
  34         bool do_mark_clean;
  35
  36         uint64_t partition_offset;
  37         uint64_t partition_size;
  38 } HomeSetup;
  39
  40 typedef struct PasswordCache {
  41         /* Decoding passwords from security tokens is expensive and typically requires user interaction, hence cache any we already figured out. */
  42         char **pkcs11_passwords;
  43         char **fido2_passwords;
  44 } PasswordCache;
  45
  46 void password_cache_free(PasswordCache *cache);
  47
  48 #define HOME_SETUP_INIT                                 \
  49         {                                               \
  50                 .root_fd = -1,                          \
  51                 .image_fd = -1,                         \
  52                 .partition_offset = UINT64_MAX,         \
  53                 .partition_size = UINT64_MAX,           \
  54         }
  55
  56 int home_setup_undo(HomeSetup *setup);
  57
  58 int home_prepare(UserRecord *h, bool already_activated, PasswordCache *cache, HomeSetup *setup, UserRecord **ret_header_home);
  59
  60 int home_refresh(UserRecord *h, HomeSetup *setup, UserRecord *header_home, PasswordCache *cache, struct statfs *ret_statfs, UserRecord **ret_new_home);
  61
  62 int home_populate(UserRecord *h, int dir_fd);
  63
  64 int home_load_embedded_identity(UserRecord *h, int root_fd, UserRecord *header_home, UserReconcileMode mode, PasswordCache *cache, UserRecord **ret_embedded_home, UserRecord **ret_new_home);
  65 int home_store_embedded_identity(UserRecord *h, int root_fd, uid_t uid, UserRecord *old_home);
  66 int home_extend_embedded_identity(UserRecord *h, UserRecord *used, HomeSetup *setup);
  67
  68 int user_record_authenticate(UserRecord *h, UserRecord *secret, PasswordCache *cache, bool strict_verify);
  69
  70 int home_sync_and_statfs(int root_fd, struct statfs *ret);