Environment
Environment variables for secrets, coverage SHM, RPC, and NXS.
Environment variables used by Nexsiz when the corresponding CLI flag or config key is not set. Companion pages: Guide · Configuration, Config File, CLI.
When env applies
After argument parsing, Nexsiz fills selected fields from the environment only if still unset: RPC socket, NXS set/path, and related encryptor/coverage material depending on path. Prefer explicit CLI or conf for reproducible campaigns; use env for host-local secrets and CI wiring.
Variable reference
| Variable | Equivalent | Purpose |
|---|---|---|
NEXSIZ_ENC_KEY | -k / enc_key | Encryptor key material |
NEXSIZ_ENC_NONCE | — | Encryptor nonce material |
NEXSIZ_NONCE_MODE | — | fixed | incrementing | random |
NEXSIZ_SHM_ID | -S / coverage_shm | Coverage shared-memory id for Frida agent (/nexsiz-cov-<ID>) |
NEXSIZ_RPC_SOCK | -Y / rpc_sock | Unix domain socket path for Python/RPC control |
NEXSIZ_NXS | --nxs / nxs | NXS set expression; enables NXS when non-empty |
NEXSIZ_NXS_PATH | --nxs-path / nxs_path | Colon-separated extra search directories for NXS binaries |
Examples
# Encryptor key without putting secrets in argv history
export NEXSIZ_ENC_KEY='0x0123456789abcdef0123456789abcdef'
export NEXSIZ_ENC_NONCE='0x000000000000000000000000'
nexsiz -h 10.0.0.5 -p 443 -m http -e chacha20+tls -v
# Frida coverage agent SHM id
export NEXSIZ_SHM_ID=campaign42
nexsiz -h 127.0.0.1 -p 21 -m ftp -C map -v
# RPC control socket
export NEXSIZ_RPC_SOCK=/tmp/nexsiz.sock
nexsiz -h 127.0.0.1 -p 21 -m ftp -v
# client: python3 python/nexsiz_client.py
# NXS without repeating long flags
export NEXSIZ_NXS=default
export NEXSIZ_NXS_PATH=$HOME/.nexsiz/nxs/bin:./nxs/bin
nexsiz -h 127.0.0.1 -p 21 -m ftp -v
Operational notes
- Secrets — Prefer env or a restricted conf file for keys; avoid embedding long-lived secrets in shell history via
-k. - SHM cleanup — After map coverage campaigns:
rm -f /dev/shm/nexsiz-cov*ormake clean-shm. - Empty values — Empty string for
NEXSIZ_NXS/NEXSIZ_RPC_SOCKis treated as unset (no enable). - Windows — RPC UDS and POSIX SHM paths differ; core env names remain the same where supported.