libnss-host4 0.2.1

A convenient way to implement the glibc gethostbyname4_r NSS host API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# libnss-host4

[![crates.io](https://img.shields.io/crates/v/libnss-host4.svg)](https://crates.io/crates/libnss-host4)
[![docs.rs](https://img.shields.io/docsrs/libnss-host4)](https://docs.rs/libnss-host4)
[![CI](https://github.com/cfzimmerman/libnss-host4/actions/workflows/ci.yml/badge.svg)](https://github.com/cfzimmerman/libnss-host4/actions/workflows/ci.yml)
[![license](https://img.shields.io/crates/l/libnss-host4.svg)](#license)

Implementing the trait and macro in this crate will expose a
`gethostbyname4_r` FFI hook for NSS in your Rust `cdylib`.

### Example

```rust
use libnss_host4::{Addr, HostResolver, err::NssErr, impl_gethostbyname4_r};
use std::net::Ipv6Addr;

/// This resolver maps "localhost" to [::1%0].
struct LocalDns;
impl_gethostbyname4_r!(local, LocalDns);

impl HostResolver for LocalDns {
    fn resolve_host(hostname: &str) -> Result<impl IntoIterator<Item = Addr>, NssErr> {
        if hostname == "localhost" {
            return Ok([Addr {
                ip: Ipv6Addr::LOCALHOST.into(),
                scope_id: 0,
            }]);
        }
        Err(NssErr::NO_RESULT)
    }
}
```

See [examples/nss_example.rs](https://github.com/cfzimmerman/libnss-host4/blob/main/examples/nss_example.rs) for more info.

Building the example as an NSS module requires the `crate-type = ["cdylib"]`
declaration shown in [Cargo.toml](https://github.com/cfzimmerman/libnss-host4/blob/main/Cargo.toml).

### Background

glibc defines a Name Service Switch interface for querying hostnames.

<https://sourceware.org/glibc/manual/2.43/html_mono/libc.html#Host-Names>

This once-simple lookup API has unfortunately degenerated into a sedimentary
chaos of numbered functions differentiated by reentrance and lack thereof.
An early indication of which is the conspicuous absence of `gethostbyname3_r`
and `gethostbyname4_r` in the docs linked above.

However, as of writing, `gethostbyname4_r` is the only NSS host hook that
can return IPv6 addresses with a `scope_id`, which makes it a big deal
for the chosen few who care about such things.

Other Rust NSS usage is already well supported by the [libnss crate](https://crates.io/crates/libnss).
The motivating cause for this crate cannot accomodate its GPL license,
which is why this is standalone. Presumably both crates can be used in
the same `cdylib` to cover the full NSS host API.

If the other hooks aren't needed, though, a cdylib with just `gethostbyname4_r`
is sufficient for `getaddrinfo`-based resolution via `/etc/nsswitch.conf`.

### License

Licensed under either of the following at your option:

- MIT license ([LICENSE-MIT](LICENSE-MIT))
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE))

Unless explicitly stated otherwise, any contribution to this crate
shall be dual licensed as above without any additional terms or conditions.