Skip to main content

CLI generator for sing-box configuration files

Project description

Quickstart

Install the CLI:

pip install sekai-generator

Generate configs (local/test mode uses bundled fixtures):

sekai-generator --local --debug --start-port 8820 --tls-server-name mozilla.org --obfs-password password123

Outputs (in test mode):

  • test_data/inbounds.jsonc
  • test_data/outbounds.jsonc
  • test_data/users.jsonc

Manual usage and prerequisites

Download sing-box binary from GitHub releases

VERSION=1.12.14  # Replace with the desired version
ARCH=$(uname -m)
if [ "$ARCH" = "x86_64" ]; then
    TARGETARCH=amd64
elif [ "$ARCH" = "aarch64" ]; then
    TARGETARCH=arm64
else
    echo "Unsupported architecture: $ARCH"
    exit 1
fi
curl -LJ "https://github.com/SagerNet/sing-box/releases/download/v${VERSION}/sing-box-${VERSION}-linux-${ARCH}.tar.gz" -o /tmp/sing-box.tar.gz

tar -xz -C ./ -f /tmp/sing-box.tar.gz --strip-components=1 && rm /tmp/sing-box.tar.gz

First think about two domain names for TLS handshake with TLS1.3 support and for ECH. I will use

  • mozilla.org for TLS handshake server name and
  • google.com for ECH domain since those are not blocked here, in Myanmar.
export TLS_SERVER_NAME=mozilla.org
export ECH_DOMAIN=google.com

Then generate self-signed certificate and private key:

mkdir -p data/certs && \
openssl ecparam -genkey -name prime256v1 -out data/certs/private.key && \
openssl req -new -x509 -days 36500 -key data/certs/private.key -out data/certs/certificate.crt \
-subj "/CN=${TLS_SERVER_NAME}" \
-addext "subjectAltName=DNS:${TLS_SERVER_NAME}"

Generate Reality keypair:

REALITY_KEYPAIR=$(./sing-box generate reality-keypair)
AUTO_REALITY_PRIVATE=$(awk '/PrivateKey/{print $NF}' <<< "$REALITY_KEYPAIR")
AUTO_REALITY_PUBLIC=$(awk '/PublicKey/{print $NF}' <<< "$REALITY_KEYPAIR")
REALITY_PRIVATE=${CUSTOM_REALITY_PRIVATE:-$AUTO_REALITY_PRIVATE}
REALITY_PUBLIC=${CUSTOM_REALITY_PUBLIC:-$AUTO_REALITY_PUBLIC}
printf '%s\n' "$REALITY_PRIVATE" > data/certs/reality_private.key
printf '%s\n' "$REALITY_PUBLIC" > data/certs/reality_public.key

Generate ECH keypair:

ECH_KEYPAIR=$(./sing-box generate ech-keypair ${ECH_DOMAIN})
AUTO_ECH_PUBLIC=$(sed -n '/-----BEGIN ECH CONFIGS-----/,/-----END ECH CONFIGS-----/p' <<< "$ECH_KEYPAIR")
AUTO_ECH_PRIVATE=$(sed -n '/-----BEGIN ECH KEYS-----/,/-----END ECH KEYS-----/p' <<< "$ECH_KEYPAIR")
ECH_PRIVATE=${CUSTOM_ECH_PRIVATE:-$AUTO_ECH_PRIVATE}
ECH_PUBLIC=${CUSTOM_ECH_PUBLIC:-$AUTO_ECH_PUBLIC}
printf '%s\n' "$ECH_PRIVATE" > data/certs/ech.key
printf '%s\n' "$ECH_PUBLIC" > data/certs/ech.config

Add users to users.yaml

  • A user must have a unique name, password, and UUID.
  • It's recommended to use a strong password and a randomly generated UUID.
  • Generate UUID (just in case you don't have one):
UUID=$(uuidgen)
echo "Generated UUID: $UUID"

Install dependencies:

python3 -m pip install sekai-generator

Run generator:

sekai-generator \
    --start-port 8820 \
    --tls-server-name $TLS_SERVER_NAME \
    --obfs_password "your_obfs_password"

Check out app.py for more options and details.

Run sing-box with the generated configuration:

./sing-box run -c config.jsonc

Run Tests:

pytest -vv

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sekai_generator-1.3.2.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sekai_generator-1.3.2-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file sekai_generator-1.3.2.tar.gz.

File metadata

  • Download URL: sekai_generator-1.3.2.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sekai_generator-1.3.2.tar.gz
Algorithm Hash digest
SHA256 861552c0bdd53cb71a3f17ceed57bb7a2c4ffcddd0176d730bd4dad19e39bee8
MD5 d37a0802183a0c0413f08a1fca76eb89
BLAKE2b-256 75b9239ae39cad4674284b01204db714424f4bfda3c20782069dec2433597ff0

See more details on using hashes here.

File details

Details for the file sekai_generator-1.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for sekai_generator-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c1584e99e83d041a0790e153b4cd170dadf0fd7b7e0a7e52d5e8b4e20db34a25
MD5 c127208477f7ecbe7f2983c76517fb7f
BLAKE2b-256 c3676b53a3c54607192a531cec48f98aca1118c79bfde994d51da8562816548a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page