liboverdrop-0.1.0/.cargo_vcs_info.json0000644000000001360000000000100133610ustar { "git": { "sha1": "b043cff30f15a53cb63d7c371fcc690439b023c2" }, "path_in_vcs": "" }liboverdrop-0.1.0/COPYRIGHT000064400000000000000000000003321046102023000134420ustar 00000000000000Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: liboverdrop Source: https://github.com/coreos/liboverdrop-rs Files: * Copyright: 2019, Red Hat Inc. License: MIT or Apache-2.0 liboverdrop-0.1.0/Cargo.toml0000644000000021600000000000100113560ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2021" rust-version = "1.56.0" name = "liboverdrop" version = "0.1.0" authors = [ "Luca Bruno ", "Robert Fairley ", ] exclude = [ ".gitignore", ".github", ] description = "Configuration library, with directory overlaying and fragments dropins" readme = "README.md" license = "MIT/Apache-2.0" repository = "https://github.com/coreos/liboverdrop-rs" [package.metadata.release] sign-commit = true sign-tag = true push = false publish = false pre-release-commit-message = "cargo: liboverdrop release {{version}}" tag-message = "liboverdrop {{version}}" [dependencies.log] version = "^0.4.6" liboverdrop-0.1.0/Cargo.toml.orig000064400000000000000000000011771046102023000150460ustar 00000000000000[package] name = "liboverdrop" description = "Configuration library, with directory overlaying and fragments dropins" version = "0.1.0" license = "MIT/Apache-2.0" authors = ["Luca Bruno ", "Robert Fairley "] repository = "https://github.com/coreos/liboverdrop-rs" readme = "README.md" rust-version = "1.56.0" edition = "2021" exclude = [".gitignore", ".github"] [dependencies] log = "^0.4.6" [package.metadata.release] sign-commit = true sign-tag = true push = false publish = false pre-release-commit-message = "cargo: liboverdrop release {{version}}" tag-message = "liboverdrop {{version}}" liboverdrop-0.1.0/LICENSE-APACHE-2.0000064400000000000000000000261361046102023000144020ustar 00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. liboverdrop-0.1.0/LICENSE-MIT000064400000000000000000000017771046102023000136210ustar 00000000000000Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. liboverdrop-0.1.0/README.md000064400000000000000000000025121046102023000134300ustar 00000000000000# liboverdrop [![crates.io](https://img.shields.io/crates/v/liboverdrop.svg)](https://crates.io/crates/liboverdrop) [![Documentation](https://docs.rs/liboverdrop/badge.svg)](https://docs.rs/liboverdrop) ![Rust 1.56+](https://img.shields.io/badge/Rust-1.56%2B-orange.svg) A simple Rust library to handle configuration fragments. This crate provides helpers to scan configuration fragments on disk. The goal is to help in writing Linux services which are shipped as part of a [Reproducible OS][reproducible]. Its name derives from **over**lays and **drop**ins (base directories and configuration fragments). The main entrypoint is [`scan`](fn.scan.html). It scans for configuration fragments across multiple directories (with increasing priority), following these rules: * fragments are identified by unique filenames, lexicographically (e.g. `50-default-limits.conf`). * in case of name duplication, last directory wins (e.g. `/etc/svc/custom.conf` can override `/usr/lib/svc/custom.conf`). * a fragment symlinked to `/dev/null` is used to ignore any previous fragment with the same filename. [reproducible]: http://0pointer.net/blog/projects/stateless.html ## License Licensed under either of * MIT license - * Apache License, Version 2.0 - at your option. liboverdrop-0.1.0/src/lib.rs000064400000000000000000000247401046102023000140630ustar 00000000000000//! Simple library to handle configuration fragments. //! //! This crate provides helpers to scan configuration fragments on disk. //! The goal is to help in writing Linux services which are shipped as part of a [Reproducible OS][reproducible]. //! Its name derives from **over**lays and **drop**ins (base directories and configuration fragments). //! //! The main entrypoint is [`scan`](fn.scan.html). It scans //! for configuration fragments across multiple directories (with increasing priority), //! following these rules: //! //! * fragments are identified by unique filenames, lexicographically (e.g. `50-default-limits.conf`). //! * in case of name duplication, last directory wins (e.g. `/etc/svc/custom.conf` can override `/usr/lib/svc/custom.conf`). //! * a fragment symlinked to `/dev/null` is used to ignore any previous fragment with the same filename. //! //! [reproducible]: http://0pointer.net/blog/projects/stateless.html //! //! # Example //! //! ```rust,no_run //! # use liboverdrop; //! // Scan for fragments under: //! // * /usr/lib/my-crate/config.d/*.toml //! // * /run/my-crate/config.d/*.toml //! // * /etc/my-crate/config.d/*.toml //! //! let base_dirs = [ //! "/usr/lib", //! "/run", //! "/etc", //! ]; //! let fragments = liboverdrop::scan(&base_dirs, "my-crate/config.d", &["toml"], false); //! //! for (filename, filepath) in fragments { //! println!("fragment '{}' located at '{}'", filename.to_string_lossy(), filepath.display()); //! } //! ``` //! //! # Migrating from liboverdrop 0.0.x //! //! The signature changed from //! ```rust,compile_fail //! # use liboverdrop::FragmentScanner; //! let base_dirs: Vec = vec![/**/]; //! let shared_path: &str = "config.d"; //! let allowed_extensions: Vec = vec![/**/]; //! for (basename, filepath) in FragmentScanner::new( //! base_dirs, shared_path, false, allowed_extensions).scan() { //! // basename: String //! // filepath: PathBuf //! } //! ``` //! to //! ```rust,no_run //! # use liboverdrop; //! # /* //! let base_dirs: IntoIterator> = /* could be anything */; //! let shared_path: AsRef = /* ... */; //! let allowed_extensions: &[AsRef] = &[/* ... */]; //! # */ //! # let base_dirs = [""]; //! # let shared_path = ""; //! # let allowed_extensions = &[""]; //! for (basename, filepath) in liboverdrop::scan( //! base_dirs, shared_path, allowed_extensions, false) { //! // basename: OsString //! // filepath: PathBuf //! } //! ``` //! //! When updating, re-consider if you need to allocate any argument now, //! since they can all be literals or borrowed. use log::trace; use std::collections::BTreeMap; use std::ffi::{OsStr, OsString}; use std::fs; use std::path::{Path, PathBuf}; /// The well-known path to the null device used for overrides. const DEVNULL: &str = "/dev/null"; /// Scan unique configuration fragments from the configuration directories specified. /// /// # Arguments /// /// * `base_dirs` - Base components of directories where configuration fragments are located. /// * `shared_path` - Common relative path from each entry in `base_dirs` to the directory /// holding configuration fragments. /// * `allowed_extensions` - Only scan files that have an extension listed in `allowed_extensions`. /// If an empty slice is passed, then all extensions are allowed. /// * `ignore_dotfiles` - Whether to ignore dotfiles (hidden files with name prefixed with '.'). /// /// `shared_path` is joined onto each entry in `base_dirs` to form the directory paths to scan. /// /// Returns a `BTreeMap` indexed by configuration fragment filename, /// holding the path where the unique configuration fragment is located. /// /// Configuration fragments are stored in the `BTreeMap` in alphanumeric order by filename. /// Configuration fragments existing in directories that are scanned later override fragments /// of the same filename in directories that are scanned earlier. pub fn scan, BdI: IntoIterator, Sp: AsRef, As: AsRef>( base_dirs: BdI, shared_path: Sp, allowed_extensions: &[As], ignore_dotfiles: bool, ) -> BTreeMap { let shared_path = shared_path.as_ref(); let mut files_map = BTreeMap::new(); for dir in base_dirs { let dir = dir.as_ref().join(shared_path); trace!("Scanning directory '{}'", dir.display()); let dir_iter = match fs::read_dir(dir) { Ok(iter) => iter, _ => continue, }; for entry in dir_iter.flatten() { let fpath = entry.path(); let fname = entry.file_name(); // If hidden files not allowed, ignore dotfiles. // Rust RFC 900 &c.: there's no way to check if a Path/OsStr starts with a prefix; // instead, we check via to_string_lossy(), which will only allocate if the basename wasn't UTF-8, // and the lossiness doesn't bother us; https://github.com/rust-lang/rfcs/issues/900 if ignore_dotfiles && fname.to_string_lossy().starts_with('.') { continue; } // If extensions are specified, proceed only if filename has one of the allowed // extensions. if !allowed_extensions.is_empty() { if let Some(extension) = fpath.extension() { if !allowed_extensions.iter().any(|ae| ae.as_ref() == extension) { continue; } } else { continue; } } // Check filetype, ignore non-file. let meta = match entry.metadata() { Ok(m) => m, _ => continue, }; if !meta.file_type().is_file() { if let Ok(target) = fs::read_link(&fpath) { // A devnull symlink is a special case to ignore previous file-names. if target == Path::new(DEVNULL) { trace!("Nulled config file '{}'", fpath.display()); files_map.remove(&fname); } } continue; } trace!( "Found config file '{}' at '{}'", Path::new(&fname).display(), fpath.display() ); files_map.insert(fname, fpath); } } files_map } #[cfg(test)] mod tests { use super::*; fn assert_fragments_match( fragments: &BTreeMap, filename: &OsStr, filepath: &Path, ) { assert_eq!(fragments.get(filename).unwrap(), filepath); } fn assert_fragments_hit>(fragments: &BTreeMap, filename: T) { assert!(fragments.get(filename.as_ref()).is_some()); } fn assert_fragments_miss>( fragments: &BTreeMap, filename: T, ) { assert!(fragments.get(filename.as_ref()).is_none()); } #[test] fn basic_override() { let treedir = "tests/fixtures/tree-basic"; let dirs = [ format!("{}/{}", treedir, "usr/lib"), format!("{}/{}", treedir, "run"), format!("{}/{}", treedir, "etc"), ]; let expected_fragments = [ ( OsString::from("01-config-a.toml"), Path::new(treedir).join("etc/liboverdrop.d/01-config-a.toml"), ), ( OsString::from("02-config-b.toml"), Path::new(treedir).join("run/liboverdrop.d/02-config-b.toml"), ), ( OsString::from("03-config-c.toml"), Path::new(treedir).join("etc/liboverdrop.d/03-config-c.toml"), ), ( OsString::from("04-config-d.toml"), Path::new(treedir).join("usr/lib/liboverdrop.d/04-config-d.toml"), ), ( OsString::from("05-config-e.toml"), Path::new(treedir).join("etc/liboverdrop.d/05-config-e.toml"), ), ( OsString::from("06-config-f.toml"), Path::new(treedir).join("run/liboverdrop.d/06-config-f.toml"), ), ( OsString::from("07-config-g.toml"), Path::new(treedir).join("etc/liboverdrop.d/07-config-g.toml"), ), ]; let fragments = scan(&dirs, "liboverdrop.d", &["toml"], false); for (name, path) in &expected_fragments { assert_fragments_match(&fragments, &name, &path); } // Check keys are stored in the correct order. let expected_keys: Vec<_> = expected_fragments .into_iter() .map(|(name, _)| name) .collect(); let fragments_keys: Vec<_> = fragments.keys().cloned().collect(); assert_eq!(fragments_keys, expected_keys); } #[test] fn basic_override_restrict_extensions() { let treedir = "tests/fixtures/tree-basic"; let dirs = [format!("{}/{}", treedir, "etc")]; let fragments = scan(&dirs, "liboverdrop.d", &["toml"], false); assert_fragments_hit(&fragments, "01-config-a.toml"); assert_fragments_miss(&fragments, "08-config-h.conf"); assert_fragments_miss(&fragments, "noextension"); } #[test] fn basic_override_allow_all_extensions() { let treedir = "tests/fixtures/tree-basic"; let dirs = [format!("{}/{}", treedir, "etc")]; let fragments = scan::<_, _, _, &str>(&dirs, "liboverdrop.d", &[], false); assert_fragments_hit(&fragments, "01-config-a.toml"); assert_fragments_hit(&fragments, "config.conf"); assert_fragments_hit(&fragments, "noextension"); } #[test] fn basic_override_ignore_hidden() { let treedir = "tests/fixtures/tree-basic"; let dirs = [format!("{}/{}", treedir, "etc")]; let fragments = scan::<_, _, _, &str>(&dirs, "liboverdrop.d", &[], true); assert_fragments_hit(&fragments, "config.conf"); assert_fragments_miss(&fragments, ".hidden.conf"); } #[test] fn basic_override_allow_hidden() { let treedir = "tests/fixtures/tree-basic"; let dirs = [format!("{}/{}", treedir, "etc")]; let fragments = scan::<_, _, _, &OsStr>(&dirs, "liboverdrop.d", &[], false); assert_fragments_hit(&fragments, "config.conf"); assert_fragments_hit(&fragments, ".hidden.conf"); } } liboverdrop-0.1.0/tests/fixtures/tree-basic/etc/liboverdrop.d/.hidden.conf000064400000000000000000000000001046102023000246740ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/etc/liboverdrop.d/01-config-a.toml000064400000000000000000000000001046102023000253120ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/etc/liboverdrop.d/03-config-c.toml000064400000000000000000000000001046102023000253160ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/etc/liboverdrop.d/05-config-e.toml000064400000000000000000000000001046102023000253220ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/etc/liboverdrop.d/07-config-g.toml000064400000000000000000000000001046102023000253260ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/etc/liboverdrop.d/config.conf000064400000000000000000000000001046102023000246300ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/etc/liboverdrop.d/noextension000064400000000000000000000000001046102023000250100ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/run/liboverdrop.d/02-config-b.toml000064400000000000000000000000001046102023000253450ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/run/liboverdrop.d/03-config-c.toml000064400000000000000000000000001046102023000253470ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/run/liboverdrop.d/06-config-f.toml000064400000000000000000000000001046102023000253550ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/run/liboverdrop.d/07-config-g.toml000064400000000000000000000000001046102023000253570ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/usr/lib/liboverdrop.d/04-config-d.toml000064400000000000000000000000001046102023000261240ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/usr/lib/liboverdrop.d/05-config-e.toml000064400000000000000000000000001046102023000261260ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/usr/lib/liboverdrop.d/06-config-f.toml000064400000000000000000000000001046102023000261300ustar 00000000000000liboverdrop-0.1.0/tests/fixtures/tree-basic/usr/lib/liboverdrop.d/07-config-g.toml000064400000000000000000000000001046102023000261320ustar 00000000000000