English | 简体中文

🌐 What is OpenLAN?

OpenLAN is a multiple-tenant networking solution that carries LAN packets over WAN links, allowing you to build and operate multiple isolated virtual Ethernet networks across regions, clouds, and branch sites.

🤔 Why Choose OpenLAN?

If you need a flexible VPN solution for secure enterprise access, traffic proxying, or tunneling through public cloud instances, OpenLAN simplifies deployment and improves operational efficiency.

✨ Key Features

• 🔒 Multi-Network and Namespace Isolation: Support multiple network spaces, VRF/Namespace binding, cross-network isolation, scope-based SNAT, and in-network DHCP address allocation.
• 🔗 Central Switch Interconnect and Routing: Support TCP/UDP outputs, three-node forwarding, static routes, FindHop active-backup/load balancing, and External BGP prefix filters.
• 🖥️ OpenVPN Access: Support OpenVPN onboarding, static client addresses, client-to-client reachability, route redirect, TCP reset handling, and remote VIP access through SNAT.
• 🛡️ Tunnels and Overlays: Support TCP/UDP transports, VxLAN/GRE outputs, and IPSec tunnels, with connectivity and performance sampling before and after IPSec is enabled.
• 🔑 Authentication and Layered Crypt: Support username/password auth, same-user mutex, concurrent admin logins, global and per-network pre-shared crypt, plus AES/SM4 OpenVPN cipher negotiation.
• 🧭 Policy Control Plane: Built-in ACL default actions, persisted fine-grained rules, zero-trust Guest/Knock controls, DNAT service publishing, and client QoS rules.
• ⚙️ Operational Traffic Governance: Dynamic rate-limit updates, observable Linux tc/iptables state, reload persistence, and ping/RTT/iperf3 performance sampling.
• 🔄 Ceci Proxy and Service Forwarding: HTTP/TCP/DNS Proxy, domain-matched multi-backend routing, and TCP/HTTP Service forwarding with route/global backends and restart recovery.

🗺️ Use Cases

🏢 Branch-to-Center Access

         Central Switch (Enterprise Center) - 10.16.1.10/24
                               ^
                               |
                            Wifi(DNAT)
                               |
                               |
         --------------------Internet-------------------
         ^                     ^                       ^
         |                     |                       |
      Branch1                Branch2                 Branch3
         |                     |                       |
      OpenLAN               OpenLAN                 OpenLAN
   10.16.1.11/24          10.16.1.12/24           10.16.1.13/24

🌍 Multi-Region Interconnection

192.168.1.20/24                                      192.168.1.21/24
     |                                                    |
OpenLAN -- Hotel Wifi --> Central Switch(NanJing) <--- Other Wifi --- OpenLAN
                                |
                                |
                              Internet
                                |
                                |
                  Central Switch(Shanghai) - 192.168.1.10/24
                                |
                                |
      --------------------------------------------------------
      ^                         ^                            ^
      |                         |                            |
   Office Wifi               Home Wifi                    Hotel Wifi
      |                         |                            |
   OpenLAN                    OpenLAN                     OpenLAN
192.168.1.11/24            192.168.1.12/24             192.168.1.13/24

🔐 Zero-Trust Access Control

       Guest Endpoint            Staff Endpoint            Ops Endpoint
             |                        |                        |
          OpenVPN                  OpenVPN                  OpenVPN
             \                        |                        /
              \                       |                       /
               ---------------------Internet-------------------
                                      |
                                      |
                         Central Switch (Policy Hub)
                        ZTrust + ACL + Knock + Auth
                        /                         \
                       /                           \
      Guest Network (restricted)      Trusted Network (policy access)
            172.16.100.0/24                 10.16.1.0/24

📚 Documentation

• 📦 Software Installation
• 🏢 Branch Access
• 🌍 Multi-Region Interconnection
• 🔐 Zero Trust Network
• 🐳 Docker Compose

🧪 Scenario Tests

OpenLAN provides 42 executable scenario scripts under tests/cases, organized into 75+ validation functions with 1000+ assertions in total. The unified entrypoint is tests/start.sh.

Common commands:

# List all scenarios
bash tests/start.sh --list

# Run all scenarios
bash tests/start.sh

# Run selected scenarios
bash tests/start.sh switch_tcp access_success

# Generate test reports (md/html)
bash tests/start.sh --report

Report: run.md

Capability coverage by test scenario:

• Access authentication and sessions
  • access_success: verifies two-client login, reachability, and reconnect after global crypt update.
  • access_fail: verifies wrong-password rejection.
  • access_admin_multi_login: verifies concurrent admin logins.
  • access_same_user_mutex: verifies same-user mutex for regular users.
• Access crypt, SNAT, and QoS
  • access_pre_network_crypt: verifies per-network pre-shared crypt and client behavior after key updates.
  • access_snat_scope_matrix: covers the SNAT scope matrix for OpenVPN, Network A, and Network B.
  • access_client_qos: verifies client QoS rule add, update, list, save, and remove flows.
• OpenVPN access paths
  • access_openvpn: covers OpenVPN add/remove, CCD files, invalid cipher rejection, and AES/SM4 data-channel negotiation.
  • access_openvpn_acl: verifies OpenVPN ACL uses iptables while bridge ACL uses ebtables.
  • access_openvpn_client_ping: verifies static-address client-to-client ping.
  • access_openvpn_redirect: verifies source-route redirect to a second switch for VIP access.
  • access_openvpn_tcp_reset: verifies server-side TCP reset handling.
  • access_openvpn_snat_vip: verifies OpenVPN client access to a remote VIP through SNAT.
  • access_openvpn_multi_route: verifies a sw1 network-a OpenVPN client cannot reach sw2 network a/b before sw2 return routing is added, then can reach both after the route is added.
  • access_openvpn_multi_snat: verifies a sw1 network-a OpenVPN client can reach sw2 network a/b through OpenVPN-scoped SNAT without a sw2 return route.
• OpenVPN performance sampling
  • access_openvpn_perf: covers TCP/UDP OpenVPN connectivity, 0% packet-loss RTT summaries, iperf3 bandwidth sampling, and reload persistence.
• Ceci Proxy and Service
  • proxy_http, proxy_tcp, proxy_name, and proxy_name_backends: cover HTTP/TCP/DNS proxying, domain-matched multi-backend routing, and reload recovery.
  • service_tcp and service_http: cover Ceci Service TCP/HTTP forwarding, route/global backends, and restart recovery.
• Switch baseline output links
  • switch_tcp and switch_udp: cover TCP/UDP output authentication, reachability, reload behavior, and isolation after output removal.
• Switch IPSec and overlays
  • switch_ipsec_vxlan and switch_ipsec_gre: cover VxLAN/GRE outputs with IPSec tunnel establishment, reload, and removal.
  • switch_ipsec_vxlan_perf: compares ping, RTT, and TCP/UDP iperf3 samples before and after IPSec is enabled.
• Switch ACL and zero trust
  • switch_acl: verifies ACL add/list/save/reload/remove with VIP TCP/80 and ICMP.
  • switch_acl_default: verifies ACL default action switching between drop and accept.
  • switch_acl_network: verifies ACL ebtables hook is bridge ingress only.
  • switch_ztrust: verifies ZTrust enable/disable, Guest add, no-address client error output, token-derived Guest/Knock add/list, other-user knock rejection, and reload persistence.
• Switch routing and forwarding control
  • switch_bgp: verifies BGP peering, prefix advertise/receive filters, and reload.
  • switch_route3: verifies three-node forwarding and static-route reachability.
  • switch_findhop: verifies FindHop route binding, remove guards, active-backup, and load balancing.
• Switch NAT, DHCP, rate limit, and namespace isolation
  • switch_dnat: verifies DNAT add, reachability, reload, and remove.
  • switch_dhcp: verifies DHCP enable/disable APIs, independent dhcpConfig, dnsmasq start/stop, namespace and access client lease allocation, ping reachability, and reload persistence.
  • switch_ratelimit: verifies bridge/OpenVPN device rate-limit updates and Linux tc state.
  • switch_setaddress: verifies bridge address updates refresh address assignment, SNAT source ranges, and OpenVPN pushed routes.
  • switch_namespace, switch_namespace_snat, and switch_namespace_openvpn: cover VRF binding, SNAT source rewriting, OpenVPN device VRF membership, cross-network isolation, and reload persistence.
• Switch output performance
  • switch_output_perf: covers one center switch with mixed UDP/TCP outputs, authentication, connectivity, 0% packet-loss RTT summaries, bandwidth sampling, and reload recovery.