diff options
author | Joachim F <joachifm@users.noreply.github.com> | 2018-06-02 10:26:09 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-06-02 10:26:09 +0000 |
commit | ae512f2d8e2907f2624d0d36f7c40dadea87d424 (patch) | |
tree | 671dd324d6e06a6c37d90a108d6b9e48a8e96827 | |
parent | 04f0e08c9102bed3cbdc1d9eb900b377e6375632 (diff) | |
parent | e9ff80d24a14d786e68141cf18e40edcc8e58fa8 (diff) |
Merge pull request #34886 from leenaars/mortyproxy
morty: init -> 0.2.0
-rw-r--r-- | nixos/modules/module-list.nix | 1 | ||||
-rw-r--r-- | nixos/modules/services/networking/morty.nix | 98 | ||||
-rw-r--r-- | nixos/release.nix | 1 | ||||
-rw-r--r-- | nixos/tests/morty.nix | 32 | ||||
-rw-r--r-- | pkgs/servers/web-apps/morty/default.nix | 41 | ||||
-rw-r--r-- | pkgs/servers/web-apps/morty/deps.nix | 57 | ||||
-rw-r--r-- | pkgs/top-level/all-packages.nix | 2 |
7 files changed, 232 insertions, 0 deletions
diff --git a/nixos/modules/module-list.nix b/nixos/modules/module-list.nix index 12d9e1adf23d5..fb94189d30126 100644 --- a/nixos/modules/module-list.nix +++ b/nixos/modules/module-list.nix @@ -514,6 +514,7 @@ ./services/networking/miniupnpd.nix ./services/networking/mosquitto.nix ./services/networking/monero.nix + ./services/networking/morty.nix ./services/networking/miredo.nix ./services/networking/mstpd.nix ./services/networking/murmur.nix diff --git a/nixos/modules/services/networking/morty.nix b/nixos/modules/services/networking/morty.nix new file mode 100644 index 0000000000000..b31bec9a86275 --- /dev/null +++ b/nixos/modules/services/networking/morty.nix @@ -0,0 +1,98 @@ +{ config, lib, pkgs, ... }: + +with lib; + +let + + cfg = config.services.morty; + + configFile = cfg.configFile; + +in + +{ + + ###### interface + + options = { + + services.morty = { + + enable = mkEnableOption + "Morty proxy server. See https://github.com/asciimoo/morty"; + + ipv6 = mkOption { + type = types.bool; + default = true; + description = "Allow IPv6 HTTP requests?"; + defaultText = "Allow IPv6 HTTP requests."; + }; + + key = mkOption { + type = types.string; + default = ""; + description = "HMAC url validation key (hexadecimal encoded). + Leave blank to disable. Without validation key, anyone can + submit proxy requests. Leave blank to disable."; + defaultText = "No HMAC url validation. Generate with echo -n somevalue | openssl dgst -sha1 -hmac somekey"; + }; + + timeout = mkOption { + type = types.int; + default = 2; + description = "Request timeout in seconds."; + defaultText = "A resource now gets 2 seconds to respond."; + }; + + package = mkOption { + type = types.package; + default = pkgs.morty; + defaultText = "pkgs.morty"; + description = "morty package to use."; + }; + + port = mkOption { + type = types.int; + default = 3000; + description = "Listing port"; + }; + + listenAddress = mkOption { + type = types.string; + default = "127.0.0.1"; + description = "The address on which the service listens"; + defaultText = "127.0.0.1 (localhost)"; + }; + + }; + + }; + + ###### Service definition + + config = mkIf config.services.morty.enable { + + users.extraUsers.morty = + { description = "Morty user"; + createHome = true; + home = "/var/lib/morty"; + }; + + systemd.services.morty = + { + description = "Morty sanitizing proxy server."; + after = [ "network.target" ]; + wantedBy = [ "multi-user.target" ]; + serviceConfig = { + User = "morty"; + ExecStart = ''${cfg.package}/bin/morty \ + -listen ${cfg.listenAddress}:${toString cfg.port} \ + ${optionalString cfg.ipv6 "-ipv6"} \ + ${optionalString (cfg.key != "") "-key " + cfg.key} \ + ''; + }; + }; + environment.systemPackages = [ cfg.package ]; + + }; +} diff --git a/nixos/release.nix b/nixos/release.nix index 1e52c0f86a7a9..8777d85c5d46b 100644 --- a/nixos/release.nix +++ b/nixos/release.nix @@ -408,6 +408,7 @@ in rec { tests.xss-lock = callTest tests/xss-lock.nix {}; tests.yabar = callTest tests/yabar.nix {}; tests.zookeeper = callTest tests/zookeeper.nix {}; + tests.morty = callTest tests/morty.nix { }; /* Build a bunch of typical closures so that Hydra can keep track of the evolution of closure sizes. */ diff --git a/nixos/tests/morty.nix b/nixos/tests/morty.nix new file mode 100644 index 0000000000000..e052ee988060b --- /dev/null +++ b/nixos/tests/morty.nix @@ -0,0 +1,32 @@ +import ./make-test.nix ({ pkgs, ... }: + +{ + name = "morty"; + meta = with pkgs.stdenv.lib.maintainers; { + maintainers = [ leenaars ]; + }; + + nodes = + { mortyProxyWithKey = + + { config, pkgs, ... }: + { services.morty = { + enable = true; + key = "78a9cd0cfee20c672f78427efb2a2a96036027f0"; + port = 3001; + }; + }; + + }; + + testScript = + { nodes , ... }: + '' + startAll; + + $mortyProxyWithKey->waitForUnit("morty"); + $mortyProxyWithKey->succeed("curl -L 127.0.0.1:3001 | grep MortyProxy"); + + ''; + +}) diff --git a/pkgs/servers/web-apps/morty/default.nix b/pkgs/servers/web-apps/morty/default.nix new file mode 100644 index 0000000000000..eeb19f81c54d7 --- /dev/null +++ b/pkgs/servers/web-apps/morty/default.nix @@ -0,0 +1,41 @@ +{ stdenv, buildGoPackage, fetchgit }: + +buildGoPackage rec { + name = "morty-${version}"; + version = "0.2.0"; + + goPackagePath = "github.com/asciimoo/morty"; + + src = fetchgit { + rev = "v${version}"; + url = "https://github.com/asciimoo/morty"; + sha256 = "1wvrdlwbpzizfg7wrcfyf1x6qllp3aw425n88z516wc9jalfqrrm"; + }; + + goDeps = ./deps.nix; + + meta = with stdenv.lib; { + homepage = "https://github.com/asciimoo/morty"; + maintainers = with maintainers; [ leenaars ]; + description = "Privacy aware web content sanitizer proxy as a service"; + longDescription = '' + Morty is a web content sanitizer proxy as a service. It rewrites web + pages to exclude malicious HTML tags and attributes. It also replaces + external resource references to prevent third party information leaks. + + The main goal of morty is to provide a result proxy for searx, but it + can be used as a standalone sanitizer service too. + + Features: + + * HTML sanitization + * Rewrites HTML/CSS external references to locals + * JavaScript blocking + * No Cookies forwarded + * No Referrers + * No Caching/Etag + * Supports GET/POST forms and IFrames + * Optional HMAC URL verifier key to prevent service abuse +''; + }; +} diff --git a/pkgs/servers/web-apps/morty/deps.nix b/pkgs/servers/web-apps/morty/deps.nix new file mode 100644 index 0000000000000..643fc5bb76361 --- /dev/null +++ b/pkgs/servers/web-apps/morty/deps.nix @@ -0,0 +1,57 @@ +# This file was generated by https://github.com/kamilchm/go2nix v1.2.1 +[ + { + goPackagePath = "github.com/klauspost/compress"; + fetch = { + type = "git"; + url = "https://github.com/klauspost/compress"; + rev = "5698df94daded084fa836b7df2ffbf6cbd3dd63a"; + sha256 = "1jligmzsyv08dysdaih3r95ki0dqnay9wlzganl4r0mamwhq22wz"; + }; + } + { + goPackagePath = "github.com/klauspost/cpuid"; + fetch = { + type = "git"; + url = "https://github.com/klauspost/cpuid"; + rev = "ae832f27941af41db13bd6d8efd2493e3b22415a"; + sha256 = "1h46y0lbzx0zjdnwbh0znf2ghgbvpzk1p269kkn7v8645xk3apk9"; + }; + } + { + goPackagePath = "github.com/valyala/bytebufferpool"; + fetch = { + type = "git"; + url = "https://github.com/valyala/bytebufferpool"; + rev = "e746df99fe4a3986f4d4f79e13c1e0117ce9c2f7"; + sha256 = "01lqzjddq6kz9v41nkky7wbgk7f1cw036sa7ldz10d82g5klzl93"; + }; + } + { + goPackagePath = "github.com/valyala/fasthttp"; + fetch = { + type = "git"; + url = "https://github.com/valyala/fasthttp"; + rev = "e5f51c11919d4f66400334047b897ef0a94c6f3c"; + sha256 = "0g24gys7xk449jd9ja89vr33i3amcb12jnmhsrmd5r2q8byv3l09"; + }; + } + { + goPackagePath = "golang.org/x/net"; + fetch = { + type = "git"; + url = "https://go.googlesource.com/net"; + rev = "f5dfe339be1d06f81b22525fe34671ee7d2c8904"; + sha256 = "01y9j7pjnnld4ipmzjvs0hls0hh698f2sga8cxaw5y6r5j7igaah"; + }; + } + { + goPackagePath = "golang.org/x/text"; + fetch = { + type = "git"; + url = "https://go.googlesource.com/text"; + rev = "4e4a3210bb54bb31f6ab2cdca2edcc0b50c420c1"; + sha256 = "10505r4xw1njnr2ns1s5r62s4pwif0kfaa30xxpgpz6qxrrmw15s"; + }; + } +] diff --git a/pkgs/top-level/all-packages.nix b/pkgs/top-level/all-packages.nix index 3c0e04dd26355..4e2c3eb4b9544 100644 --- a/pkgs/top-level/all-packages.nix +++ b/pkgs/top-level/all-packages.nix @@ -12609,6 +12609,8 @@ with pkgs; mlmmj = callPackage ../servers/mail/mlmmj { }; + morty = callPackage ../servers/web-apps/morty { }; + myserver = callPackage ../servers/http/myserver { }; nas = callPackage ../servers/nas { }; |