8 releases (breaking)

new 0.8.0 May 18, 2024
0.7.0 Apr 24, 2024
0.6.0 Feb 17, 2024
0.5.0 Aug 22, 2023
0.1.0 Jun 9, 2019

#83 in Database interfaces

Download history 4062/week @ 2024-01-27 4103/week @ 2024-02-03 4683/week @ 2024-02-10 4857/week @ 2024-02-17 4541/week @ 2024-02-24 4927/week @ 2024-03-02 4706/week @ 2024-03-09 4386/week @ 2024-03-16 3887/week @ 2024-03-23 4461/week @ 2024-03-30 4072/week @ 2024-04-06 4950/week @ 2024-04-13 6338/week @ 2024-04-20 5394/week @ 2024-04-27 6328/week @ 2024-05-04 4946/week @ 2024-05-11

23,948 downloads per month
Used in 2 crates

LGPL-3.0

38KB
823 lines

libnss-rs

Rust bindings for creating libnss modules.

Currently supports the following databases:

  • passwd
  • shadow
  • group
  • hosts

Getting started

  • Create a new library

    cargo new nss_example --lib
    
  • Change library type to cdylib in your Cargo.toml

    [lib]
    name = "nss_example"
    crate-type = [ "cdylib" ]
    

    *** NOTE *** The name of the crate itself is not important, however the library itself must follow the nss_xxx pattern.

  • Add libnss to your Cargo.toml

    [dependencies]
    libc = "0.2.0"
    libnss = "0.8.0"
    
  • Implement a passwd database

    use libnss::passwd::{PasswdHooks, Passwd};
    use libnss::libnss_passwd_hooks;
    
    struct ExamplePasswd;
    libnss_passwd_hooks!(example, ExamplePasswd);
    

    It is important that the first param of libnss_passwd_hooks is the name of your final library libnss_example.so.2

    impl PasswdHooks for HardcodedPasswd {
        fn get_all_entries() -> Vec<Passwd> {
            vec![
                Passwd {
                    name: "test".to_string(),
                    passwd: "x".to_string(),
                    uid: 1005,
                    gid: 1005,
                    gecos: "Test Account".to_string(),
                    dir: "/home/test".to_string(),
                    shell: "/bin/bash".to_string(),
                }
            ]
        }
    
        fn get_entry_by_uid(uid: libc::uid_t) -> Option<Passwd> {
            if uid == 1005 {
                return Some(Passwd {
                    name: "test".to_string(),
                    passwd: "x".to_string(),
                    uid: 1005,
                    gid: 1005,
                    gecos: "Test Account".to_string(),
                    dir: "/home/test".to_string(),
                    shell: "/bin/bash".to_string(),
                });
            }
    
            None
        }
    
        fn get_entry_by_name(name: String) -> Option<Passwd> {
            if name == "test" {
                return Some(Passwd {
                    name: "test".to_string(),
                    passwd: "x".to_string(),
                    uid: 1005,
                    gid: 1005,
                    gecos: "Test Account".to_string(),
                    dir: "/home/test".to_string(),
                    shell: "/bin/bash".to_string(),
                });
            }
    
            None
        }
    }
    
  • Build

    cargo build --release
    
  • Install the library

    cd target/release
    cp libnss_example.so libnss_example.so.2
    sudo install -m 0644 libnss_example.so.2 /lib
    sudo /sbin/ldconfig -n /lib /usr/lib
    
  • Enable your nss module in /etc/nsswitch.conf eg:

    passwd:         example files systemd
    

    The name in here must follow the final library name libnss_example.so.2

  • Look at the examples for more information

Dependencies

~57KB