febootstrap.ml

   1 (* febootstrap 3
   2  * Copyright (C) 2009-2010 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  *)
  18
  19 open Unix
  20 open Printf
  21
  22 open Febootstrap_package_handlers
  23 open Febootstrap_utils
  24 open Febootstrap_cmdline
  25
  26 (* Create a temporary directory for use by all the functions in this file. *)
  27 let tmpdir = tmpdir ()
  28
  29 let () =
  30   debug "%s %s" Config.package_name Config.package_version;
  31
  32   (* Instead of printing out warnings as we go along, accumulate them
  33    * in lists and print them all out at the end.
  34    *)
  35   let warn_unreadable = ref [] in
  36
  37   (* Determine which package manager this system uses. *)
  38   check_system ();
  39   let ph = get_package_handler () in
  40
  41   debug "selected package handler: %s" (get_package_handler_name ());
  42
  43   (* Not --names: check files exist. *)
  44   if not names_mode then (
  45     List.iter (
  46       fun pkg ->
  47         if not (file_exists pkg) then (
  48           eprintf "febootstrap: %s: no such file (did you miss out the --names option?)\n" pkg;
  49           exit 1
  50         )
  51     ) packages
  52   );
  53
  54   (* --names: resolve the package list to a full list of package names
  55    * (including dependencies).
  56    *)
  57   let packages =
  58     if names_mode then (
  59       let packages = ph.ph_resolve_dependencies_and_download packages in
  60       debug "resolved packages: %s" (String.concat " " packages);
  61       packages
  62     )
  63     else packages in
  64
  65   (* Get the list of files. *)
  66   let files =
  67     List.flatten (
  68       List.map (
  69         fun pkg ->
  70           let files = ph.ph_list_files pkg in
  71           List.map (fun (filename, ft) -> filename, ft, pkg) files
  72       ) packages
  73     ) in
  74
  75   (* Sort and combine duplicate files. *)
  76   let files =
  77     let files = List.sort compare files in
  78
  79     let combine (name1, ft1, pkg1) (name2, ft2, pkg2) =
  80       (* Rules for combining files. *)
  81       if ft1.ft_config || ft2.ft_config then (
  82         eprintf "febootstrap: error: %s is a config file which is listed in two packages (%s, %s)\n"
  83           name1 pkg1 pkg2;
  84         exit 1
  85       );
  86       if (ft1.ft_dir || ft2.ft_dir) && (not (ft1.ft_dir && ft2.ft_dir)) then (
  87         eprintf "febootstrap: error: %s appears as both directory and ordinary file (%s, %s)\n"
  88           name1 pkg1 pkg2;
  89         exit 1
  90       );
  91       if ft1.ft_ghost then
  92         (name2, ft2, pkg2)
  93       else
  94         (name1, ft1, pkg1)
  95     in
  96
  97     let rec loop = function
  98       | [] -> []
  99       | (name1, _, _ as f1) :: (name2, _, _ as f2) :: fs when name1 = name2 ->
 100           let f = combine f1 f2 in loop (f :: fs)
 101       | f :: fs -> f :: loop fs
 102     in
 103     loop files in
 104
 105   (* Because we may have excluded some packages, and also because of
 106    * distribution packaging errors, it's not necessarily true that a
 107    * directory is created before each file in that directory.
 108    * Determine those missing directories and add them now.
 109    *)
 110   let files =
 111     let insert_dir, dir_seen =
 112       let h = Hashtbl.create (List.length files) in
 113       let insert_dir dir = Hashtbl.replace h dir true in
 114       let dir_seen dir = Hashtbl.mem h dir in
 115       insert_dir, dir_seen
 116     in
 117     let files =
 118       List.map (
 119         fun (path, { ft_dir = is_dir }, _ as f) ->
 120           if is_dir then
 121             insert_dir path;
 122
 123           let rec loop path =
 124             let parent = Filename.dirname path in
 125             if dir_seen parent then []
 126             else (
 127               insert_dir parent;
 128               let newdir = (parent, { ft_dir = true; ft_config = false;
 129                                       ft_ghost = false; ft_mode = 0o40755 },
 130                             "") in
 131               newdir :: loop parent
 132             )
 133           in
 134           List.rev (f :: loop path)
 135       ) files in
 136     List.flatten files in
 137
 138   (* Debugging. *)
 139   debug "%d files and directories" (List.length files);
 140   if false then (
 141     List.iter (
 142       fun (name, { ft_dir = dir; ft_ghost = ghost; ft_config = config;
 143                    ft_mode = mode }, pkg) ->
 144         printf "%s [%s%s%s%o] from %s\n" name
 145           (if dir then "dir " else "")
 146           (if ghost then "ghost " else "")
 147           (if config then "config " else "")
 148           mode
 149           pkg
 150     ) files
 151   );
 152
 153   (* Split the list of files into ones for hostfiles and ones for base image. *)
 154   let p_hmac = Str.regexp "/\\.*\\.hmac$" in
 155
 156   let hostfiles = ref []
 157   and baseimgfiles = ref [] in
 158   List.iter (
 159     fun (path, {ft_dir = dir; ft_ghost = ghost; ft_config = config} ,_ as f) ->
 160       (* Ignore boot files, kernel, kernel modules.  Supermin appliances
 161        * are booted from external kernel and initrd, and
 162        * febootstrap-supermin-helper copies the host kernel modules.
 163        * Note we want to keep the /boot and /lib/modules directory entries.
 164        *)
 165       if string_prefix "/boot/" path then ()
 166       else if string_prefix "/lib/modules/" path then ()
 167
 168       (* Always write directory names to both output files. *)
 169       else if dir then (
 170         hostfiles := f :: !hostfiles;
 171         baseimgfiles := f :: !baseimgfiles;
 172       )
 173
 174       (* Timezone configuration is config, but copy it from host system. *)
 175       else if path = "/etc/localtime" then
 176         hostfiles := f :: !hostfiles
 177
 178       (* Ignore FIPS files (.*.hmac) (RHBZ#654638). *)
 179       else if Str.string_match p_hmac path 0 then ()
 180
 181       (* Ghost files are created empty in the base image. *)
 182       else if ghost then
 183         baseimgfiles := f :: !baseimgfiles
 184
 185       (* For config files we can't rely on the host-installed copy
 186        * since the admin may have modified then.  We have to get the
 187        * original file from the package and put it in the base image.
 188        *)
 189       else if config then
 190         baseimgfiles := f :: !baseimgfiles
 191
 192       (* Anything else comes from the host. *)
 193       else
 194         hostfiles := f :: !hostfiles
 195   ) files;
 196   let hostfiles = List.rev !hostfiles
 197   and baseimgfiles = List.rev !baseimgfiles in
 198
 199   (* Write hostfiles. *)
 200
 201   (* Regexps used below. *)
 202   let p_ld_so = Str.regexp "^ld-[.0-9]+\\.so$" in
 203   let p_libbfd = Str.regexp "^libbfd-.*\\.so$" in
 204   let p_libgcc = Str.regexp "^libgcc_s-.*\\.so\\.\\([0-9]+\\)$" in
 205   let p_libntfs3g = Str.regexp "^libntfs-3g\\.so\\..*$" in
 206   let p_lib123so = Str.regexp "^lib\\(.*\\)-[-.0-9]+\\.so$" in
 207   let p_lib123so123 =
 208     Str.regexp "^lib\\(.*\\)-[-.0-9]+\\.so\\.\\([0-9]+\\)\\." in
 209   let p_libso123 = Str.regexp "^lib\\(.*\\)\\.so\\.\\([0-9]+\\)\\." in
 210   let ntfs3g_once = ref false in
 211
 212   let chan = open_out (tmpdir // "hostfiles") in
 213   List.iter (
 214     fun (path, {ft_dir = is_dir; ft_ghost = ghost; ft_config = config;
 215                 ft_mode = mode }, _) ->
 216       let dir = Filename.dirname path in
 217       let file = Filename.basename path in
 218
 219       if is_dir then
 220         fprintf chan "%s\n" path
 221
 222       (* Warn about hostfiles which are unreadable by non-root.  We
 223        * won't be able to add those to the appliance at run time, but
 224        * there's not much else we can do about it except get the
 225        * distros to fix this nonsense.
 226        *)
 227       else if mode land 0o004 = 0 then
 228         warn_unreadable := path :: !warn_unreadable
 229
 230       (* Replace fixed numbers in some library names by wildcards. *)
 231       else if Str.string_match p_ld_so file 0 then
 232         fprintf chan "%s/ld-*.so\n" dir
 233
 234       (* Special case for libbfd. *)
 235       else if Str.string_match p_libbfd file 0 then
 236         fprintf chan "%s/libbfd-*.so\n" dir
 237
 238       (* Special case for libgcc_s-<gccversion>-<date>.so.N *)
 239       else if Str.string_match p_libgcc file 0 then
 240         fprintf chan "%s/libgcc_s-*.so.%s\n" dir (Str.matched_group 1 file)
 241
 242       (* Special case for libntfs-3g.so.* *)
 243       else if Str.string_match p_libntfs3g file 0 then (
 244         if not !ntfs3g_once then (
 245           fprintf chan "%s/libntfs-3g.so.*\n" dir;
 246           ntfs3g_once := true
 247         )
 248       )
 249
 250       (* libfoo-1.2.3.so *)
 251       else if Str.string_match p_lib123so file 0 then
 252         fprintf chan "%s/lib%s-*.so\n" dir (Str.matched_group 1 file)
 253
 254       (* libfoo-1.2.3.so.123 (but NOT '*.so.N') *)
 255       else if Str.string_match p_lib123so123 file 0 then
 256         fprintf chan "%s/lib%s-*.so.%s.*\n" dir
 257           (Str.matched_group 1 file) (Str.matched_group 2 file)
 258
 259       (* libfoo.so.1.2.3 (but NOT '*.so.N') *)
 260       else if Str.string_match p_libso123 file 0 then
 261         fprintf chan "%s/lib%s.so.%s.*\n" dir
 262           (Str.matched_group 1 file) (Str.matched_group 2 file)
 263
 264       (* Anything else comes from the host. *)
 265       else
 266         fprintf chan "%s\n" path
 267   ) hostfiles;
 268   close_out chan;
 269
 270   (* Write base.img.
 271    *
 272    * We have to create directories and copy files to tmpdir/root
 273    * and then call out to cpio to construct the initrd.
 274    *)
 275   let rootdir = tmpdir // "root" in
 276   mkdir rootdir 0o755;
 277   List.iter (
 278     fun (path, { ft_dir = is_dir; ft_ghost = ghost; ft_config = config;
 279                  ft_mode = mode }, pkg) ->
 280       (* Always write directory names to both output files. *)
 281       if is_dir then (
 282         (* Directory permissions are fixed up below. *)
 283         if path <> "/" then mkdir (rootdir // path) 0o755
 284       )
 285
 286       (* Ghost files are just touched with the correct perms. *)
 287       else if ghost then (
 288         let chan = open_out (rootdir // path) in
 289         close_out chan;
 290         chmod (rootdir // path) (mode land 0o777 lor 0o400)
 291       )
 292
 293       (* For config files we can't rely on the host-installed copy
 294        * since the admin may have modified it.  We have to get the
 295        * original file from the package.
 296        *)
 297       else if config then (
 298         let outfile = ph.ph_get_file_from_package pkg path in
 299
 300         (* Note that the output config file might not be a regular file. *)
 301         let statbuf = lstat outfile in
 302
 303         let destfile = rootdir // path in
 304
 305         (* Depending on the file type, copy it to destination. *)
 306         match statbuf.st_kind with
 307         | S_REG ->
 308             (* Unreadable files (eg. /etc/gshadow).  Make readable. *)
 309             if statbuf.st_perm = 0 then chmod outfile 0o400;
 310             let cmd =
 311               sprintf "cp %s %s"
 312                 (Filename.quote outfile) (Filename.quote destfile) in
 313             run_command cmd;
 314             chmod destfile (mode land 0o777 lor 0o400)
 315         | S_LNK ->
 316             let link = readlink outfile in
 317             symlink link destfile
 318         | S_DIR -> assert false
 319         | S_CHR
 320         | S_BLK
 321         | S_FIFO
 322         | S_SOCK ->
 323             eprintf "febootstrap: error: %s: don't know how to handle this type of file\n" path;
 324             exit 1
 325       )
 326
 327       else
 328         assert false (* should not be reached *)
 329   ) baseimgfiles;
 330
 331   (* Fix up directory permissions, in reverse order.  Since we don't
 332    * want to have a read-only directory that we can't write into above.
 333    *)
 334   List.iter (
 335     fun (path, { ft_dir = is_dir; ft_mode = mode }, _) ->
 336       if is_dir then chmod (rootdir // path) (mode land 0o777 lor 0o700)
 337   ) (List.rev baseimgfiles);
 338
 339   (* Construct the 'base.img' initramfs.  Feed in the list of filenames
 340    * partly because we conveniently have them, and partly because
 341    * this results in a nice alphabetical ordering in the cpio file.
 342    *)
 343   (*let cmd = sprintf "ls -lR %s" rootdir in
 344   ignore (Sys.command cmd);*)
 345   let cmd =
 346     sprintf "(cd %s && cpio --quiet -o -0 -H newc) > %s"
 347       rootdir (tmpdir // "base.img") in
 348   let chan = open_process_out cmd in
 349   List.iter (fun (path, _, _) -> fprintf chan ".%s\000" path) baseimgfiles;
 350   let stat = close_process_out chan in
 351   (match stat with
 352    | WEXITED 0 -> ()
 353    | WEXITED i ->
 354        eprintf "febootstrap: command '%s' failed (returned %d), see earlier error messages\n" cmd i;
 355        exit i
 356    | WSIGNALED i ->
 357        eprintf "febootstrap: command '%s' killed by signal %d" cmd i;
 358        exit 1
 359    | WSTOPPED i ->
 360        eprintf "febootstrap: command '%s' stopped by signal %d" cmd i;
 361        exit 1
 362   );
 363
 364   (* Undo directory permissions, because rm -rf can't delete files in
 365    * unreadable directories.
 366    *)
 367   List.iter (
 368     fun (path, { ft_dir = is_dir; ft_mode = mode }, _) ->
 369       if is_dir then chmod (rootdir // path) 0o755
 370   ) (List.rev baseimgfiles);
 371
 372   (* Print warnings. *)
 373   if warnings then (
 374     (match !warn_unreadable with
 375      | [] -> ()
 376      | paths ->
 377          eprintf "febootstrap: warning: some host files are unreadable by non-root\n";
 378          eprintf "febootstrap: warning: get your distro to fix these files:\n";
 379          List.iter
 380            (fun path -> eprintf "\t%s\n%!" path)
 381            (List.sort compare paths)
 382     );
 383   );
 384
 385   (* Near-atomically copy files to the final output directory. *)
 386   debug "writing %s ..." (outputdir // "base.img");
 387   let cmd =
 388     sprintf "mv %s %s"
 389       (Filename.quote (tmpdir // "base.img"))
 390       (Filename.quote (outputdir // "base.img")) in
 391   run_command cmd;
 392   debug "writing %s ..." (outputdir // "hostfiles");
 393   let cmd =
 394     sprintf "mv %s %s"
 395       (Filename.quote (tmpdir // "hostfiles"))
 396       (Filename.quote (outputdir // "hostfiles")) in
 397   run_command cmd