Readme.md

Gatekeeper: A SOCKS5 Server written in Rust.

Features

Authentication Method

Any authentication method is not supported.

The client connects to the server is required for sending X'00' (NO AUTHENTICATION REQUIRED) as a method selection message.

Command

Only CONNECT command is supported.

Filter

Gatekeeper allow users to restricting connection based on:

• target address
  • ip address (subnet range)
  • domain name (regex matching, wildcard)
• port number
• protocol (currently, tcp is only supported)

Usage

This crate provides a library and an executable using the crate.

Crate

This can be used by adding gatekeeper to your dependencies in your project's Cargo.toml.

[dependencies]
gatekeeper = "2.4.0"

Executable

You can install gatekeeper as an executable (gatekeeperd) with cargo install.

$ cargo install gatekeeper
$ gatekeeperd
gatekeeperd
gatekeeper 2.4.0

How to use

When the gatekeeperd installation is complete, you would be able to run the program.

$ gatekeeperd

You can look see command line options.

$ gatekeeperd --help

Filter Rule

By default, gatekeeper accepts all connection requests. However, it is possible to filter out some requests along with a filtering rule (described above) given an yaml file. This yaml file follows special format described below.

Format

Any filter rule yaml is constructed from a sequence of RuleEntries. Each RuleEntry is either Allow or Deny.

---
- Allow:
    ..
- Deny:
    ..
- Deny:
    ..
- Allow:
    ..
..

The rule is in the back of this list have higher precedence. Then the head of rules is treated as default rule, and the rule should be either allow all connection or deny all connection.

- Allow:
    address: Any
    port: Any
    protocol: Any
..

Or

- Deny:
    address: Any
    port: Any
    protocol: Any
..

All RuleEntry have 3 fields address, port and protocol. Value of these fields are either Any or Specif. Any matches any values, and Specif matches a specified value(s).

• address

  # any address
  address: Any

  address is either IpAddr or Domain.
  IpAddr is specified with addr and prefix.

  # 192.168.0.1/24
  address:
    Specif:
      IpAddr:
        addr: 192.168.0.1
        prefix: 24

  Domain is specified as either pattern or wildcard.

  # {mail.,}google.{com,co.jp}
  address:
    Specif:
      Domain:
        # regexp pattern
        pattern: '\A(mail\.)?google.((com|co)\.jp)\z'

  # allow any Amazon API Gateway's REST API
  address:
    Specif:
      Domain:
        # converted to the regex pattern: \A[A-Za-z0-9-]{1,63}\.execute\-api\.[A-Za-z0-9-]{1,63}\.amazonaws\.com\z
        wildcard: '*.execute-api.*.amazonaws.com'

• port

  # any port number
  port: Any

  # match only 8080
  port:
    Specif: 8080

• protocol

  # any protocol
  protocol: Any

  # match only tcp
  protocol:
    Specif: Tcp

Examples

• allow all connections

  ---
  - Allow:
      address: Any
      port: Any
      protocol: Any

• allow only local subnet (192.168.0.1/16)

  ---
  .. default deny ..
  - Allow:
      address:
        Specif:
          IpAddr:
            addr: 192.168.0.1
            prefix: 16
      port: Any
      protocol: Any

• block access to facebook.com and youtube.com

  ---
  .. default allow ..
  - Deny:
      address:
        Specif:
          Domain:
            pattern: '\A(www\.)?facebook\.com\z'
      port: Any
      protocol:
        Specif: Tcp
  - Deny:
      address:
        Specif:
          Domain:
            pattern: '\A(www\.)?youtube\.com\z'
      port: Any
      protocol:
        Specif: Tcp

Build Docker Image

x86_64

For building docker image for x86_64.

$ docker-compose build gatekeeper

x86_64 and Arm

For building docker images for x86_64 and armv6/7:

$ GATEKEEPER_VER=<version> docker buildx bake --load

The docker images idein/gatekeeper:<version>-<arch> are added to your docker env. Where the arch is x86_64 and armv6, armv7.

Integration Test

1. Prepare the socks and http server

$ docker-compose build
$ docker-compose up -d

2. Run ignored test

$ cargo test --verbose -- --nocapture --ignored