nss/file.h

   1 /*
   2  * Load and unload nsscash files (header)
   3  *
   4  * Copyright (C) 2019-2020  Simon Ruderich
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero 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  * This program 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 Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef FILE_H
  21 #define FILE_H
  22
  23 #include <stdbool.h>
  24 #include <stdint.h>
  25 #include <stdlib.h>
  26
  27
  28 // Magic value at the beginning of each nsscash file (8 byte, without the
  29 // trailing NUL)
  30 #define MAGIC "NSS-CASH"
  31
  32 // Defined in Makefile
  33 #ifndef NSSCASH_PASSWD_FILE
  34 # define NSSCASH_PASSWD_FILE "/etc/passwd.nsscash"
  35 #endif
  36 #ifndef NSSCASH_GROUP_FILE
  37 # define NSSCASH_GROUP_FILE "/etc/group.nsscash"
  38 #endif
  39
  40
  41 // header describes the on-disk (and, after loading via mmap, in-memory)
  42 // structure of nsscash files.
  43 struct header {
  44     char magic[8]; // magic string
  45     uint64_t version; // also doubles as byte-order check
  46
  47     uint64_t count; // number of entries in this file
  48
  49     // All offsets are relative to data
  50     uint64_t off_orig_index;
  51     uint64_t off_id_index;
  52     uint64_t off_name_index;
  53     uint64_t off_data;
  54
  55     char data[];
  56 } __attribute__((packed));
  57
  58 // file represents an open nsscash file.
  59 struct file {
  60     int fd;
  61     size_t size;
  62
  63     const struct header *header;
  64     uint64_t next_index; // used by getpwent (pw.c)
  65 };
  66
  67 bool map_file(const char *path, struct file *f) __attribute__((visibility("hidden")));
  68 void unmap_file(struct file *f) __attribute__((visibility("hidden")));
  69
  70 #endif