bookclerk_plugin_manifest::address

Development These docs follow the development version and change with every merge.

Last updated View as Markdown

Address-space policy independent of hostname matching.

Default reachability is the public Internet. Loopback, RFC1918, link-local, unique-local, metadata, and IPv4-mapped forms of those ranges stay denied unless the operator grants an explicit CIDR. A public-redirect capability never implies those ranges.

Item Kind Summary
CidrGrant struct One operator- or manifest-granted CIDR (10.0.60.100/32, ::1/128).
canonical_ip function Unwraps IPv4-mapped IPv6 so :ffff:127.0.0.1 is treated as IPv4.
is_public_internet function True when ip is reachable on the public Internet (not a special range).
is_local_network function True when ip is a local-network address a LAN service may answer on: RFC 1918 IPv4 (10/8, 172.16/12, 192.168/16), RFC 6598 shared address space (100.64/10, carrier-grade NAT and overlay networks) or an IPv6 unique local address (fc00::/7).
is_restricted_hostname function Special hostnames that resolve into denied address space without a CIDR grant.
address_allowed function True when ip is allowed: public Internet, or an explicit CIDR grant.
workerd_network_allow function Workerd network.allow tokens for this policy: public plus granted CIDRs.

Structs

CidrGrant

pub struct CidrGrant {
    pub network: IpAddr,
    pub prefix: u8,
}

One operator- or manifest-granted CIDR (10.0.60.100/32, ::1/128).

Fields

  • network: Network address (host bits masked off).
  • prefix: Prefix length.

CidrGrant::parse

pub fn parse(raw: &str) -> Result<Self, String>

Parses addr/prefix. Bare addresses are treated as /32 or /128.

Errors

Returns a message when the CIDR is malformed or the prefix is too large.

CidrGrant::contains

pub fn contains(&self, ip: IpAddr) -> bool

True when ip (after IPv4-mapped unwrapping) falls in this range.

Implements: Clone, Debug, Eq, PartialEq

Functions

canonical_ip

pub fn canonical_ip(ip: IpAddr) -> IpAddr

Unwraps IPv4-mapped IPv6 so :ffff:127.0.0.1 is treated as IPv4.

is_public_internet

pub fn is_public_internet(ip: IpAddr) -> bool

True when ip is reachable on the public Internet (not a special range).

is_local_network

pub fn is_local_network(ip: IpAddr) -> bool

True when ip is a local-network address a LAN service may answer on: RFC 1918 IPv4 (10/8, 172.16/12, 192.168/16), RFC 6598 shared address space (100.64/10, carrier-grade NAT and overlay networks) or an IPv6 unique local address (fc00::/7).

Loopback, link-local (where cloud metadata lives), unspecified, multicast and broadcast addresses are never local-network addresses here: they always need an explicit CIDR grant. IPv4-mapped IPv6 is judged as IPv4.

Arguments

  • ip - Resolved destination address.

Returns

true for the ranges above.

Examples

use bookclerk_plugin_manifest::is_local_network;

assert!(is_local_network("192.168.1.20".parse().unwrap()));
assert!(is_local_network("fd12:3456::1".parse().unwrap()));
assert!(!is_local_network("127.0.0.1".parse().unwrap()));
assert!(!is_local_network("169.254.169.254".parse().unwrap()));

is_restricted_hostname

pub fn is_restricted_hostname(host: &str) -> bool

Special hostnames that resolve into denied address space without a CIDR grant.

address_allowed

pub fn address_allowed(ip: IpAddr, grants: &[CidrGrant]) -> bool

True when ip is allowed: public Internet, or an explicit CIDR grant.

workerd_network_allow

pub fn workerd_network_allow(cidrs: &[CidrGrant]) -> Vec<String>

Workerd network.allow tokens for this policy: public plus granted CIDRs.

Never emits the blanket private / local / network tokens.

Generated from crates/bookclerk-plugin-manifest at main · View as Markdown