2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
122 lines
3.6 KiB
Nix
122 lines
3.6 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.tor.torsocks;
|
|
optionalNullStr = b: v: optionalString (b != null) v;
|
|
|
|
configFile = server: ''
|
|
TorAddress ${toString (head (splitString ":" server))}
|
|
TorPort ${toString (tail (splitString ":" server))}
|
|
|
|
OnionAddrRange ${cfg.onionAddrRange}
|
|
|
|
${optionalNullStr cfg.socks5Username
|
|
"SOCKS5Username ${cfg.socks5Username}"}
|
|
${optionalNullStr cfg.socks5Password
|
|
"SOCKS5Password ${cfg.socks5Password}"}
|
|
|
|
AllowInbound ${if cfg.allowInbound then "1" else "0"}
|
|
'';
|
|
|
|
wrapTorsocks = name: server: pkgs.writeTextFile {
|
|
name = name;
|
|
text = ''
|
|
#!${pkgs.runtimeShell}
|
|
TORSOCKS_CONF_FILE=${pkgs.writeText "torsocks.conf" (configFile server)} ${pkgs.torsocks}/bin/torsocks "$@"
|
|
'';
|
|
executable = true;
|
|
destination = "/bin/${name}";
|
|
};
|
|
|
|
in
|
|
{
|
|
options = {
|
|
services.tor.torsocks = {
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = config.services.tor.enable && config.services.tor.client.enable;
|
|
defaultText = literalExpression "config.services.tor.enable && config.services.tor.client.enable";
|
|
description = lib.mdDoc ''
|
|
Whether to build `/etc/tor/torsocks.conf`
|
|
containing the specified global torsocks configuration.
|
|
'';
|
|
};
|
|
|
|
server = mkOption {
|
|
type = types.str;
|
|
default = "127.0.0.1:9050";
|
|
example = "192.168.0.20:1234";
|
|
description = lib.mdDoc ''
|
|
IP/Port of the Tor SOCKS server. Currently, hostnames are
|
|
NOT supported by torsocks.
|
|
'';
|
|
};
|
|
|
|
fasterServer = mkOption {
|
|
type = types.str;
|
|
default = "127.0.0.1:9063";
|
|
example = "192.168.0.20:1234";
|
|
description = lib.mdDoc ''
|
|
IP/Port of the Tor SOCKS server for torsocks-faster wrapper suitable for HTTP.
|
|
Currently, hostnames are NOT supported by torsocks.
|
|
'';
|
|
};
|
|
|
|
onionAddrRange = mkOption {
|
|
type = types.str;
|
|
default = "127.42.42.0/24";
|
|
description = lib.mdDoc ''
|
|
Tor hidden sites do not have real IP addresses. This
|
|
specifies what range of IP addresses will be handed to the
|
|
application as "cookies" for .onion names. Of course, you
|
|
should pick a block of addresses which you aren't going to
|
|
ever need to actually connect to. This is similar to the
|
|
MapAddress feature of the main tor daemon.
|
|
'';
|
|
};
|
|
|
|
socks5Username = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = null;
|
|
example = "bob";
|
|
description = lib.mdDoc ''
|
|
SOCKS5 username. The `TORSOCKS_USERNAME`
|
|
environment variable overrides this option if it is set.
|
|
'';
|
|
};
|
|
|
|
socks5Password = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = null;
|
|
example = "sekret";
|
|
description = lib.mdDoc ''
|
|
SOCKS5 password. The `TORSOCKS_PASSWORD`
|
|
environment variable overrides this option if it is set.
|
|
'';
|
|
};
|
|
|
|
allowInbound = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Set Torsocks to accept inbound connections. If set to
|
|
`true`, listen() and accept() will be
|
|
allowed to be used with non localhost address.
|
|
'';
|
|
};
|
|
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
environment.systemPackages = [ pkgs.torsocks (wrapTorsocks "torsocks-faster" cfg.fasterServer) ];
|
|
|
|
environment.etc."tor/torsocks.conf" =
|
|
{
|
|
source = pkgs.writeText "torsocks.conf" (configFile cfg.server);
|
|
};
|
|
};
|
|
}
|