commit 6c888f49110b5ea50192c09e09886c9b647a4b42 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2505.section.md

···

       108
       108
        
       

     

       109
       109
        
       - [Schroot](https://codeberg.org/shelter/reschroot), a lightweight virtualisation tool. Securely enter a chroot and run a command or login shell. Available as [programs.schroot](#opt-programs.schroot.enable).

     

       110
       110
        
       

     

       111
       111
       +
       - [Firezone](https://firezone.dev), an enterprise-ready zero-trust access platform built on WireGuard. This includes the server stack as [services.firezone.server.enable](#opt-services.firezone.server.enable), a TURN/STUN relay service as [services.firezone.relay.enable](#opt-services.firezone.relay.enable), a gateway service as [services.firezone.gateway.enable](#opt-services.firezone.gateway.enable), a headless client as [services.firezone.headless-client.enable](#opt-services.firezone.headless-client.enable) and a GUI client as [services.firezone.gui-client.enable](#opt-services.firezone.gui-client.enable).

     

       112
       112
       +
       

     

       111
       113
        
       - [crab-hole](https://github.com/LuckyTurtleDev/crab-hole), a cross platform Pi-hole clone written in Rust using hickory-dns/trust-dns. Available as [services.crab-hole](#opt-services.crab-hole.enable).

     

       112
       114
        
       

     

       113
       115
        
       - [zwave-js-ui](https://zwave-js.github.io/zwave-js-ui/), a full featured Z-Wave Control Panel and MQTT Gateway. Available as [services.zwave-js-ui](#opt-services.zwave-js-ui.enable).

nixos/modules/module-list.nix

···

       1099
       1099
        
         ./services/networking/firewall.nix

     

       1100
       1100
        
         ./services/networking/firewall-iptables.nix

     

       1101
       1101
        
         ./services/networking/firewall-nftables.nix

     

       1102
       1102
       +
         ./services/networking/firezone/gateway.nix

     

       1103
       1103
       +
         ./services/networking/firezone/gui-client.nix

     

       1104
       1104
       +
         ./services/networking/firezone/headless-client.nix

     

       1105
       1105
       +
         ./services/networking/firezone/relay.nix

     

       1106
       1106
       +
         ./services/networking/firezone/server.nix

     

       1102
       1107
        
         ./services/networking/flannel.nix

     

       1103
       1108
        
         ./services/networking/freenet.nix

     

       1104
       1109
        
         ./services/networking/freeradius.nix

+159

nixos/modules/services/networking/firezone/gateway.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         pkgs,

     

       4
       4
       +
         config,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         inherit (lib)

     

       9
       9
       +
           boolToString

     

       10
       10
       +
           getExe

     

       11
       11
       +
           mkEnableOption

     

       12
       12
       +
           mkIf

     

       13
       13
       +
           mkOption

     

       14
       14
       +
           mkPackageOption

     

       15
       15
       +
           types

     

       16
       16
       +
           ;

     

       17
       17
       +
       

     

       18
       18
       +
         cfg = config.services.firezone.gateway;

     

       19
       19
       +
       in

     

       20
       20
       +
       {

     

       21
       21
       +
         options = {

     

       22
       22
       +
           services.firezone.gateway = {

     

       23
       23
       +
             enable = mkOption {

     

       24
       24
       +
               default = false;

     

       25
       25
       +
               example = true;

     

       26
       26
       +
               description = ''

     

       27
       27
       +
                 Whether to enable the firezone gateway.

     

       28
       28
       +
       

     

       29
       29
       +
                 You have to manually masquerade and forward traffic from the

     

       30
       30
       +
                 tun-firezone interface to your resource! Refer to the

     

       31
       31
       +
                 [upstream setup script](https://github.com/firezone/firezone/blob/8c7c0a9e8e33ae790aeb75fdb5a15432c2870b79/scripts/gateway-systemd-install.sh#L154-L168)

     

       32
       32
       +
                 for a list of iptable commands.

     

       33
       33
       +
       

     

       34
       34
       +
                 See the firezone nixos test in this repository for an nftables based example.

     

       35
       35
       +
               '';

     

       36
       36
       +
               type = lib.types.bool;

     

       37
       37
       +
             };

     

       38
       38
       +
             package = mkPackageOption pkgs "firezone-gateway" { };

     

       39
       39
       +
       

     

       40
       40
       +
             name = mkOption {

     

       41
       41
       +
               type = types.str;

     

       42
       42
       +
               description = "The name of this gateway as shown in firezone";

     

       43
       43
       +
             };

     

       44
       44
       +
       

     

       45
       45
       +
             apiUrl = mkOption {

     

       46
       46
       +
               type = types.strMatching "^wss://.+/$";

     

       47
       47
       +
               example = "wss://firezone.example.com/api/";

     

       48
       48
       +
               description = ''

     

       49
       49
       +
                 The URL of your firezone server's API. This should be the same

     

       50
       50
       +
                 as your server's setting for {option}`services.firezone.server.settings.api.externalUrl`,

     

       51
       51
       +
                 but with `wss://` instead of `https://`.

     

       52
       52
       +
               '';

     

       53
       53
       +
             };

     

       54
       54
       +
       

     

       55
       55
       +
             tokenFile = mkOption {

     

       56
       56
       +
               type = types.path;

     

       57
       57
       +
               example = "/run/secrets/firezone-gateway-token";

     

       58
       58
       +
               description = ''

     

       59
       59
       +
                 A file containing the firezone gateway token. Do not use a nix-store path here

     

       60
       60
       +
                 as it will make the token publicly readable!

     

       61
       61
       +
       

     

       62
       62
       +
                 This file will be passed via systemd credentials, it should only be accessible

     

       63
       63
       +
                 by the root user.

     

       64
       64
       +
               '';

     

       65
       65
       +
             };

     

       66
       66
       +
       

     

       67
       67
       +
             logLevel = mkOption {

     

       68
       68
       +
               type = types.str;

     

       69
       69
       +
               default = "info";

     

       70
       70
       +
               description = ''

     

       71
       71
       +
                 The log level for the firezone application. See

     

       72
       72
       +
                 [RUST_LOG](https://docs.rs/env_logger/latest/env_logger/#enabling-logging)

     

       73
       73
       +
                 for the format.

     

       74
       74
       +
               '';

     

       75
       75
       +
             };

     

       76
       76
       +
       

     

       77
       77
       +
             enableTelemetry = mkEnableOption "telemetry";

     

       78
       78
       +
           };

     

       79
       79
       +
         };

     

       80
       80
       +
       

     

       81
       81
       +
         config = mkIf cfg.enable {

     

       82
       82
       +
           systemd.services.firezone-gateway = {

     

       83
       83
       +
             description = "Gateway service for the Firezone zero-trust access platform";

     

       84
       84
       +
             after = [ "network.target" ];

     

       85
       85
       +
             wantedBy = [ "multi-user.target" ];

     

       86
       86
       +
       

     

       87
       87
       +
             path = [ pkgs.util-linux ];

     

       88
       88
       +
             script = ''

     

       89
       89
       +
               # If FIREZONE_ID is not given by the user, use a persisted (or newly generated) uuid.

     

       90
       90
       +
               if [[ -z "''${FIREZONE_ID:-}" ]]; then

     

       91
       91
       +
                 if [[ ! -e gateway_id ]]; then

     

       92
       92
       +
                   uuidgen -r > gateway_id

     

       93
       93
       +
                 fi

     

       94
       94
       +
                 export FIREZONE_ID=$(< gateway_id)

     

       95
       95
       +
               fi

     

       96
       96
       +
       

     

       97
       97
       +
               export FIREZONE_TOKEN=$(< "$CREDENTIALS_DIRECTORY/firezone-token")

     

       98
       98
       +
               exec ${getExe cfg.package}

     

       99
       99
       +
             '';

     

       100
       100
       +
       

     

       101
       101
       +
             environment = {

     

       102
       102
       +
               FIREZONE_API_URL = cfg.apiUrl;

     

       103
       103
       +
               FIREZONE_NAME = cfg.name;

     

       104
       104
       +
               FIREZONE_NO_TELEMETRY = boolToString (!cfg.enableTelemetry);

     

       105
       105
       +
               RUST_LOG = cfg.logLevel;

     

       106
       106
       +
             };

     

       107
       107
       +
       

     

       108
       108
       +
             serviceConfig = {

     

       109
       109
       +
               Type = "exec";

     

       110
       110
       +
               DynamicUser = true;

     

       111
       111
       +
               User = "firezone-gateway";

     

       112
       112
       +
               LoadCredential = [ "firezone-token:${cfg.tokenFile}" ];

     

       113
       113
       +
       

     

       114
       114
       +
               DeviceAllow = "/dev/net/tun";

     

       115
       115
       +
               AmbientCapabilities = [ "CAP_NET_ADMIN" ];

     

       116
       116
       +
               CapabilityBoundingSet = [ "CAP_NET_ADMIN" ];

     

       117
       117
       +
       

     

       118
       118
       +
               StateDirectory = "firezone-gateway";

     

       119
       119
       +
               WorkingDirectory = "/var/lib/firezone-gateway";

     

       120
       120
       +
       

     

       121
       121
       +
               Restart = "on-failure";

     

       122
       122
       +
               RestartSec = 10;

     

       123
       123
       +
       

     

       124
       124
       +
               LockPersonality = true;

     

       125
       125
       +
               MemoryDenyWriteExecute = true;

     

       126
       126
       +
               NoNewPrivileges = true;

     

       127
       127
       +
               PrivateMounts = true;

     

       128
       128
       +
               PrivateTmp = true;

     

       129
       129
       +
               PrivateUsers = false;

     

       130
       130
       +
               ProcSubset = "pid";

     

       131
       131
       +
               ProtectClock = true;

     

       132
       132
       +
               ProtectControlGroups = true;

     

       133
       133
       +
               ProtectHome = true;

     

       134
       134
       +
               ProtectHostname = true;

     

       135
       135
       +
               ProtectKernelLogs = true;

     

       136
       136
       +
               ProtectKernelModules = true;

     

       137
       137
       +
               ProtectKernelTunables = true;

     

       138
       138
       +
               ProtectProc = "invisible";

     

       139
       139
       +
               ProtectSystem = "strict";

     

       140
       140
       +
               RestrictAddressFamilies = [

     

       141
       141
       +
                 "AF_INET"

     

       142
       142
       +
                 "AF_INET6"

     

       143
       143
       +
                 "AF_NETLINK"

     

       144
       144
       +
               ];

     

       145
       145
       +
               RestrictNamespaces = true;

     

       146
       146
       +
               RestrictRealtime = true;

     

       147
       147
       +
               RestrictSUIDSGID = true;

     

       148
       148
       +
               SystemCallArchitectures = "native";

     

       149
       149
       +
               SystemCallFilter = "@system-service";

     

       150
       150
       +
               UMask = "077";

     

       151
       151
       +
             };

     

       152
       152
       +
           };

     

       153
       153
       +
         };

     

       154
       154
       +
       

     

       155
       155
       +
         meta.maintainers = with lib.maintainers; [

     

       156
       156
       +
           oddlama

     

       157
       157
       +
           patrickdag

     

       158
       158
       +
         ];

     

       159
       159
       +
       }

+138

nixos/modules/services/networking/firezone/gui-client.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         pkgs,

     

       4
       4
       +
         config,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         inherit (lib)

     

       9
       9
       +
           boolToString

     

       10
       10
       +
           getExe'

     

       11
       11
       +
           mkEnableOption

     

       12
       12
       +
           mkIf

     

       13
       13
       +
           mkOption

     

       14
       14
       +
           mkPackageOption

     

       15
       15
       +
           types

     

       16
       16
       +
           ;

     

       17
       17
       +
       

     

       18
       18
       +
         cfg = config.services.firezone.gui-client;

     

       19
       19
       +
       in

     

       20
       20
       +
       {

     

       21
       21
       +
         options = {

     

       22
       22
       +
           services.firezone.gui-client = {

     

       23
       23
       +
             enable = mkEnableOption "the firezone gui client";

     

       24
       24
       +
             package = mkPackageOption pkgs "firezone-gui-client" { };

     

       25
       25
       +
       

     

       26
       26
       +
             allowedUsers = mkOption {

     

       27
       27
       +
               type = types.listOf types.str;

     

       28
       28
       +
               default = [ ];

     

       29
       29
       +
               description = ''

     

       30
       30
       +
                 All listed users will become part of the `firezone-client` group so

     

       31
       31
       +
                 they can control the IPC service. This is a convenience option.

     

       32
       32
       +
               '';

     

       33
       33
       +
             };

     

       34
       34
       +
       

     

       35
       35
       +
             name = mkOption {

     

       36
       36
       +
               type = types.str;

     

       37
       37
       +
               description = "The name of this client as shown in firezone";

     

       38
       38
       +
             };

     

       39
       39
       +
       

     

       40
       40
       +
             logLevel = mkOption {

     

       41
       41
       +
               type = types.str;

     

       42
       42
       +
               default = "info";

     

       43
       43
       +
               description = ''

     

       44
       44
       +
                 The log level for the firezone application. See

     

       45
       45
       +
                 [RUST_LOG](https://docs.rs/env_logger/latest/env_logger/#enabling-logging)

     

       46
       46
       +
                 for the format.

     

       47
       47
       +
               '';

     

       48
       48
       +
             };

     

       49
       49
       +
           };

     

       50
       50
       +
         };

     

       51
       51
       +
       

     

       52
       52
       +
         config = mkIf cfg.enable {

     

       53
       53
       +
           users.groups.firezone-client.members = cfg.allowedUsers;

     

       54
       54
       +
       

     

       55
       55
       +
           # Required for deep-link mimetype registration

     

       56
       56
       +
           environment.systemPackages = [ cfg.package ];

     

       57
       57
       +
       

     

       58
       58
       +
           # Required for the token store in the gui application

     

       59
       59
       +
           services.gnome.gnome-keyring.enable = true;

     

       60
       60
       +
       

     

       61
       61
       +
           systemd.services.firezone-ipc-service = {

     

       62
       62
       +
             description = "GUI IPC service for the Firezone zero-trust access platform";

     

       63
       63
       +
             after = [ "network.target" ];

     

       64
       64
       +
             wantedBy = [ "multi-user.target" ];

     

       65
       65
       +
       

     

       66
       66
       +
             path = [ pkgs.util-linux ];

     

       67
       67
       +
             script = ''

     

       68
       68
       +
               # If FIREZONE_ID is not given by the user, use a persisted (or newly generated) uuid.

     

       69
       69
       +
               if [[ -z "''${FIREZONE_ID:-}" ]]; then

     

       70
       70
       +
                 if [[ ! -e client_id ]]; then

     

       71
       71
       +
                   uuidgen -r > client_id

     

       72
       72
       +
                 fi

     

       73
       73
       +
                 export FIREZONE_ID=$(< client_id)

     

       74
       74
       +
               fi

     

       75
       75
       +
       

     

       76
       76
       +
               exec ${getExe' cfg.package "firezone-client-ipc"} run

     

       77
       77
       +
             '';

     

       78
       78
       +
       

     

       79
       79
       +
             environment = {

     

       80
       80
       +
               FIREZONE_NAME = cfg.name;

     

       81
       81
       +
               LOG_DIR = "%L/dev.firezone.client";

     

       82
       82
       +
               RUST_LOG = cfg.logLevel;

     

       83
       83
       +
             };

     

       84
       84
       +
       

     

       85
       85
       +
             serviceConfig = {

     

       86
       86
       +
               Type = "notify";

     

       87
       87
       +
       

     

       88
       88
       +
               DeviceAllow = "/dev/net/tun";

     

       89
       89
       +
               AmbientCapabilities = [ "CAP_NET_ADMIN" ];

     

       90
       90
       +
               CapabilityBoundingSet = [ "CAP_NET_ADMIN" ];

     

       91
       91
       +
       

     

       92
       92
       +
               # This block contains hardcoded values in the client, we cannot change these :(

     

       93
       93
       +
               Group = "firezone-client";

     

       94
       94
       +
               RuntimeDirectory = "dev.firezone.client";

     

       95
       95
       +
               StateDirectory = "dev.firezone.client";

     

       96
       96
       +
               WorkingDirectory = "/var/lib/dev.firezone.client";

     

       97
       97
       +
               LogsDirectory = "dev.firezone.client";

     

       98
       98
       +
       

     

       99
       99
       +
               Restart = "on-failure";

     

       100
       100
       +
               RestartSec = 10;

     

       101
       101
       +
       

     

       102
       102
       +
               LockPersonality = true;

     

       103
       103
       +
               MemoryDenyWriteExecute = true;

     

       104
       104
       +
               NoNewPrivileges = true;

     

       105
       105
       +
               PrivateMounts = true;

     

       106
       106
       +
               PrivateTmp = true;

     

       107
       107
       +
               PrivateUsers = false;

     

       108
       108
       +
               ProcSubset = "pid";

     

       109
       109
       +
               ProtectClock = true;

     

       110
       110
       +
               ProtectControlGroups = true;

     

       111
       111
       +
               ProtectHome = true;

     

       112
       112
       +
               ProtectHostname = true;

     

       113
       113
       +
               ProtectKernelLogs = true;

     

       114
       114
       +
               ProtectKernelModules = true;

     

       115
       115
       +
               ProtectKernelTunables = true;

     

       116
       116
       +
               ProtectProc = "invisible";

     

       117
       117
       +
               ProtectSystem = "strict";

     

       118
       118
       +
               RestrictAddressFamilies = [

     

       119
       119
       +
                 "AF_INET"

     

       120
       120
       +
                 "AF_INET6"

     

       121
       121
       +
                 "AF_NETLINK"

     

       122
       122
       +
                 "AF_UNIX"

     

       123
       123
       +
               ];

     

       124
       124
       +
               RestrictNamespaces = true;

     

       125
       125
       +
               RestrictRealtime = true;

     

       126
       126
       +
               RestrictSUIDSGID = true;

     

       127
       127
       +
               SystemCallArchitectures = "native";

     

       128
       128
       +
               SystemCallFilter = "@system-service";

     

       129
       129
       +
               UMask = "077";

     

       130
       130
       +
             };

     

       131
       131
       +
           };

     

       132
       132
       +
         };

     

       133
       133
       +
       

     

       134
       134
       +
         meta.maintainers = with lib.maintainers; [

     

       135
       135
       +
           oddlama

     

       136
       136
       +
           patrickdag

     

       137
       137
       +
         ];

     

       138
       138
       +
       }

+148

nixos/modules/services/networking/firezone/headless-client.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         pkgs,

     

       4
       4
       +
         config,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         inherit (lib)

     

       9
       9
       +
           boolToString

     

       10
       10
       +
           getExe

     

       11
       11
       +
           mkEnableOption

     

       12
       12
       +
           mkIf

     

       13
       13
       +
           mkOption

     

       14
       14
       +
           mkPackageOption

     

       15
       15
       +
           types

     

       16
       16
       +
           ;

     

       17
       17
       +
       

     

       18
       18
       +
         cfg = config.services.firezone.headless-client;

     

       19
       19
       +
       in

     

       20
       20
       +
       {

     

       21
       21
       +
         options = {

     

       22
       22
       +
           services.firezone.headless-client = {

     

       23
       23
       +
             enable = mkEnableOption "the firezone headless client";

     

       24
       24
       +
             package = mkPackageOption pkgs "firezone-headless-client" { };

     

       25
       25
       +
       

     

       26
       26
       +
             name = mkOption {

     

       27
       27
       +
               type = types.str;

     

       28
       28
       +
               description = "The name of this client as shown in firezone";

     

       29
       29
       +
             };

     

       30
       30
       +
       

     

       31
       31
       +
             apiUrl = mkOption {

     

       32
       32
       +
               type = types.strMatching "^wss://.+/$";

     

       33
       33
       +
               example = "wss://firezone.example.com/api/";

     

       34
       34
       +
               description = ''

     

       35
       35
       +
                 The URL of your firezone server's API. This should be the same

     

       36
       36
       +
                 as your server's setting for {option}`services.firezone.server.settings.api.externalUrl`,

     

       37
       37
       +
                 but with `wss://` instead of `https://`.

     

       38
       38
       +
               '';

     

       39
       39
       +
             };

     

       40
       40
       +
       

     

       41
       41
       +
             tokenFile = mkOption {

     

       42
       42
       +
               type = types.path;

     

       43
       43
       +
               example = "/run/secrets/firezone-client-token";

     

       44
       44
       +
               description = ''

     

       45
       45
       +
                 A file containing the firezone client token. Do not use a nix-store path here

     

       46
       46
       +
                 as it will make the token publicly readable!

     

       47
       47
       +
       

     

       48
       48
       +
                 This file will be passed via systemd credentials, it should only be accessible

     

       49
       49
       +
                 by the root user.

     

       50
       50
       +
               '';

     

       51
       51
       +
             };

     

       52
       52
       +
       

     

       53
       53
       +
             logLevel = mkOption {

     

       54
       54
       +
               type = types.str;

     

       55
       55
       +
               default = "info";

     

       56
       56
       +
               description = ''

     

       57
       57
       +
                 The log level for the firezone application. See

     

       58
       58
       +
                 [RUST_LOG](https://docs.rs/env_logger/latest/env_logger/#enabling-logging)

     

       59
       59
       +
                 for the format.

     

       60
       60
       +
               '';

     

       61
       61
       +
             };

     

       62
       62
       +
       

     

       63
       63
       +
             enableTelemetry = mkEnableOption "telemetry";

     

       64
       64
       +
           };

     

       65
       65
       +
         };

     

       66
       66
       +
       

     

       67
       67
       +
         config = mkIf cfg.enable {

     

       68
       68
       +
           systemd.services.firezone-headless-client = {

     

       69
       69
       +
             description = "headless client service for the Firezone zero-trust access platform";

     

       70
       70
       +
             after = [ "network.target" ];

     

       71
       71
       +
             wantedBy = [ "multi-user.target" ];

     

       72
       72
       +
       

     

       73
       73
       +
             path = [ pkgs.util-linux ];

     

       74
       74
       +
             script = ''

     

       75
       75
       +
               # If FIREZONE_ID is not given by the user, use a persisted (or newly generated) uuid.

     

       76
       76
       +
               if [[ -z "''${FIREZONE_ID:-}" ]]; then

     

       77
       77
       +
                 if [[ ! -e client_id ]]; then

     

       78
       78
       +
                   uuidgen -r > client_id

     

       79
       79
       +
                 fi

     

       80
       80
       +
                 export FIREZONE_ID=$(< client_id)

     

       81
       81
       +
               fi

     

       82
       82
       +
       

     

       83
       83
       +
               exec ${getExe cfg.package}

     

       84
       84
       +
             '';

     

       85
       85
       +
       

     

       86
       86
       +
             environment = {

     

       87
       87
       +
               FIREZONE_API_URL = cfg.apiUrl;

     

       88
       88
       +
               FIREZONE_NAME = cfg.name;

     

       89
       89
       +
               FIREZONE_NO_TELEMETRY = boolToString (!cfg.enableTelemetry);

     

       90
       90
       +
               FIREZONE_TOKEN_PATH = "%d/firezone-token";

     

       91
       91
       +
               LOG_DIR = "%L/dev.firezone.client";

     

       92
       92
       +
               RUST_LOG = cfg.logLevel;

     

       93
       93
       +
             };

     

       94
       94
       +
       

     

       95
       95
       +
             serviceConfig = {

     

       96
       96
       +
               Type = "exec";

     

       97
       97
       +
               LoadCredential = [ "firezone-token:${cfg.tokenFile}" ];

     

       98
       98
       +
       

     

       99
       99
       +
               DeviceAllow = "/dev/net/tun";

     

       100
       100
       +
               AmbientCapabilities = [ "CAP_NET_ADMIN" ];

     

       101
       101
       +
               CapabilityBoundingSet = [ "CAP_NET_ADMIN" ];

     

       102
       102
       +
       

     

       103
       103
       +
               # Hardcoded values in the client :(

     

       104
       104
       +
               RuntimeDirectory = "dev.firezone.client";

     

       105
       105
       +
               StateDirectory = "dev.firezone.client";

     

       106
       106
       +
               WorkingDirectory = "/var/lib/dev.firezone.client";

     

       107
       107
       +
               LogsDirectory = "dev.firezone.client";

     

       108
       108
       +
       

     

       109
       109
       +
               Restart = "on-failure";

     

       110
       110
       +
               RestartSec = 10;

     

       111
       111
       +
       

     

       112
       112
       +
               LockPersonality = true;

     

       113
       113
       +
               MemoryDenyWriteExecute = true;

     

       114
       114
       +
               NoNewPrivileges = true;

     

       115
       115
       +
               PrivateMounts = true;

     

       116
       116
       +
               PrivateTmp = true;

     

       117
       117
       +
               PrivateUsers = false;

     

       118
       118
       +
               ProcSubset = "pid";

     

       119
       119
       +
               ProtectClock = true;

     

       120
       120
       +
               ProtectControlGroups = true;

     

       121
       121
       +
               ProtectHome = true;

     

       122
       122
       +
               ProtectHostname = true;

     

       123
       123
       +
               ProtectKernelLogs = true;

     

       124
       124
       +
               ProtectKernelModules = true;

     

       125
       125
       +
               ProtectKernelTunables = true;

     

       126
       126
       +
               ProtectProc = "invisible";

     

       127
       127
       +
               ProtectSystem = "strict";

     

       128
       128
       +
               RestrictAddressFamilies = [

     

       129
       129
       +
                 "AF_INET"

     

       130
       130
       +
                 "AF_INET6"

     

       131
       131
       +
                 "AF_NETLINK"

     

       132
       132
       +
                 "AF_UNIX"

     

       133
       133
       +
               ];

     

       134
       134
       +
               RestrictNamespaces = true;

     

       135
       135
       +
               RestrictRealtime = true;

     

       136
       136
       +
               RestrictSUIDSGID = true;

     

       137
       137
       +
               SystemCallArchitectures = "native";

     

       138
       138
       +
               SystemCallFilter = "@system-service";

     

       139
       139
       +
               UMask = "077";

     

       140
       140
       +
             };

     

       141
       141
       +
           };

     

       142
       142
       +
         };

     

       143
       143
       +
       

     

       144
       144
       +
         meta.maintainers = with lib.maintainers; [

     

       145
       145
       +
           oddlama

     

       146
       146
       +
           patrickdag

     

       147
       147
       +
         ];

     

       148
       148
       +
       }

+709

nixos/modules/services/networking/firezone/provision.exs

···

       1
       1
       +
       defmodule Provision do

     

       2
       2
       +
         alias Domain.{Repo, Accounts, Auth, Actors, Resources, Tokens, Gateways, Relays, Policies}

     

       3
       3
       +
         require Logger

     

       4
       4
       +
       

     

       5
       5
       +
         # UUID Mapping handling

     

       6
       6
       +
         defmodule UuidMapping do

     

       7
       7
       +
           @mapping_file "provision-uuids.json"

     

       8
       8
       +
       

     

       9
       9
       +
           # Loads the mapping from file

     

       10
       10
       +
           def load do

     

       11
       11
       +
             mappings = case File.read(@mapping_file) do

     

       12
       12
       +
               {:ok, content} ->

     

       13
       13
       +
                 case Jason.decode(content) do

     

       14
       14
       +
                   {:ok, mapping} -> mapping

     

       15
       15
       +
                   _ -> %{"accounts" => %{}}

     

       16
       16
       +
                 end

     

       17
       17
       +
       

     

       18
       18
       +
               _ -> %{"accounts" => %{}}

     

       19
       19
       +
             end

     

       20
       20
       +
             Process.put(:uuid_mappings, mappings)

     

       21
       21
       +
             mappings

     

       22
       22
       +
           end

     

       23
       23
       +
       

     

       24
       24
       +
           # Saves the current mapping (defaulting to the one in the process dictionary)

     

       25
       25
       +
           def save(mapping \\ Process.get(:uuid_mappings)) do

     

       26
       26
       +
             File.write!(@mapping_file, Jason.encode!(mapping))

     

       27
       27
       +
           end

     

       28
       28
       +
       

     

       29
       29
       +
           # Retrieves the account-level mapping from a given mapping (or from Process)

     

       30
       30
       +
           def get_account(mapping \\ Process.get(:uuid_mappings), account_slug) do

     

       31
       31
       +
             get_in(mapping, ["accounts", account_slug]) || %{}

     

       32
       32
       +
           end

     

       33
       33
       +
       

     

       34
       34
       +
           # Retrieves the entity mapping for a specific account and type

     

       35
       35
       +
           def get_entities(mapping \\ Process.get(:uuid_mappings), account_slug, type) do

     

       36
       36
       +
             get_in(mapping, ["accounts", account_slug, type]) || %{}

     

       37
       37
       +
           end

     

       38
       38
       +
       

     

       39
       39
       +
           # Retrieves an entity mapping for a specific account, type and external_id

     

       40
       40
       +
           def get_entity(mapping \\ Process.get(:uuid_mappings), account_slug, type, external_id) do

     

       41
       41
       +
             get_in(mapping, ["accounts", account_slug, type, external_id])

     

       42
       42
       +
           end

     

       43
       43
       +
       

     

       44
       44
       +
           # Updates (or creates) the account UUID mapping and stores it in the process dictionary.

     

       45
       45
       +
           def update_account(account_slug, uuid) do

     

       46
       46
       +
             mapping = Process.get(:uuid_mappings) || load()

     

       47
       47
       +
             mapping = ensure_account_exists(mapping, account_slug)

     

       48
       48
       +
             mapping = put_in(mapping, ["accounts", account_slug, "id"], uuid)

     

       49
       49
       +
             Process.put(:uuid_mappings, mapping)

     

       50
       50
       +
             mapping

     

       51
       51
       +
           end

     

       52
       52
       +
       

     

       53
       53
       +
           # Ensures that the given account exists in the mapping.

     

       54
       54
       +
           def ensure_account_exists(mapping, account_slug) do

     

       55
       55
       +
             if not Map.has_key?(mapping["accounts"], account_slug) do

     

       56
       56
       +
               put_in(mapping, ["accounts", account_slug], %{})

     

       57
       57
       +
             else

     

       58
       58
       +
               mapping

     

       59
       59
       +
             end

     

       60
       60
       +
           end

     

       61
       61
       +
       

     

       62
       62
       +
           # Updates (or creates) the mapping for entities of a given type for the account.

     

       63
       63
       +
           def update_entities(account_slug, type, new_entries) do

     

       64
       64
       +
             mapping = Process.get(:uuid_mappings) || load()

     

       65
       65
       +
             mapping = ensure_account_exists(mapping, account_slug)

     

       66
       66
       +
             current = get_entities(mapping, account_slug, type)

     

       67
       67
       +
             mapping = put_in(mapping, ["accounts", account_slug, type], Map.merge(current, new_entries))

     

       68
       68
       +
             Process.put(:uuid_mappings, mapping)

     

       69
       69
       +
             mapping

     

       70
       70
       +
           end

     

       71
       71
       +
       

     

       72
       72
       +
           # Removes an entire account from the mapping.

     

       73
       73
       +
           def remove_account(account_slug) do

     

       74
       74
       +
             mapping = Process.get(:uuid_mappings) || load()

     

       75
       75
       +
             mapping = update_in(mapping, ["accounts"], fn accounts ->

     

       76
       76
       +
               Map.delete(accounts, account_slug)

     

       77
       77
       +
             end)

     

       78
       78
       +
             Process.put(:uuid_mappings, mapping)

     

       79
       79
       +
             mapping

     

       80
       80
       +
           end

     

       81
       81
       +
       

     

       82
       82
       +
           # Removes a specific entity mapping for the account.

     

       83
       83
       +
           def remove_entity(account_slug, type, key) do

     

       84
       84
       +
             mapping = Process.get(:uuid_mappings) || load()

     

       85
       85
       +
             mapping = update_in(mapping, ["accounts", account_slug, type], fn entities ->

     

       86
       86
       +
               Map.delete(entities || %{}, key)

     

       87
       87
       +
             end)

     

       88
       88
       +
             Process.put(:uuid_mappings, mapping)

     

       89
       89
       +
             mapping

     

       90
       90
       +
           end

     

       91
       91
       +
         end

     

       92
       92
       +
       

     

       93
       93
       +
         defp resolve_references(value) when is_map(value) do

     

       94
       94
       +
           Enum.into(value, %{}, fn {k, v} -> {k, resolve_references(v)} end)

     

       95
       95
       +
         end

     

       96
       96
       +
       

     

       97
       97
       +
         defp resolve_references(value) when is_list(value) do

     

       98
       98
       +
           Enum.map(value, &resolve_references/1)

     

       99
       99
       +
         end

     

       100
       100
       +
       

     

       101
       101
       +
         defp resolve_references(value) when is_binary(value) do

     

       102
       102
       +
           Regex.replace(~r/\{env:([^}]+)\}/, value, fn _, var ->

     

       103
       103
       +
             System.get_env(var) || raise "Environment variable #{var} not set"

     

       104
       104
       +
           end)

     

       105
       105
       +
         end

     

       106
       106
       +
       

     

       107
       107
       +
         defp resolve_references(value), do: value

     

       108
       108
       +
       

     

       109
       109
       +
         defp atomize_keys(map) when is_map(map) do

     

       110
       110
       +
           Enum.into(map, %{}, fn {k, v} ->

     

       111
       111
       +
             {

     

       112
       112
       +
               if(is_binary(k), do: String.to_atom(k), else: k),

     

       113
       113
       +
               if(is_map(v), do: atomize_keys(v), else: v)

     

       114
       114
       +
             }

     

       115
       115
       +
           end)

     

       116
       116
       +
         end

     

       117
       117
       +
       

     

       118
       118
       +
         defp cleanup_account(uuid) do

     

       119
       119
       +
           case Accounts.fetch_account_by_id_or_slug(uuid) do

     

       120
       120
       +
             {:ok, value} when value.deleted_at == nil ->

     

       121
       121
       +
               Logger.info("Deleting removed account #{value.slug}")

     

       122
       122
       +
               value |> Ecto.Changeset.change(%{ deleted_at: DateTime.utc_now() }) |> Repo.update!()

     

       123
       123
       +
             _ -> :ok

     

       124
       124
       +
           end

     

       125
       125
       +
         end

     

       126
       126
       +
       

     

       127
       127
       +
         defp cleanup_actor(uuid, subject) do

     

       128
       128
       +
           case Actors.fetch_actor_by_id(uuid, subject) do

     

       129
       129
       +
             {:ok, value} ->

     

       130
       130
       +
               Logger.info("Deleting removed actor #{value.name}")

     

       131
       131
       +
               {:ok, _} = Actors.delete_actor(value, subject)

     

       132
       132
       +
             _ -> :ok

     

       133
       133
       +
           end

     

       134
       134
       +
         end

     

       135
       135
       +
       

     

       136
       136
       +
         defp cleanup_provider(uuid, subject) do

     

       137
       137
       +
           case Auth.fetch_provider_by_id(uuid, subject) do

     

       138
       138
       +
             {:ok, value} ->

     

       139
       139
       +
               Logger.info("Deleting removed provider #{value.name}")

     

       140
       140
       +
               {:ok, _} = Auth.delete_provider(value, subject)

     

       141
       141
       +
             _ -> :ok

     

       142
       142
       +
           end

     

       143
       143
       +
         end

     

       144
       144
       +
       

     

       145
       145
       +
         defp cleanup_gateway_group(uuid, subject) do

     

       146
       146
       +
           case Gateways.fetch_group_by_id(uuid, subject) do

     

       147
       147
       +
             {:ok, value} ->

     

       148
       148
       +
               Logger.info("Deleting removed gateway group #{value.name}")

     

       149
       149
       +
               {:ok, _} = Gateways.delete_group(value, subject)

     

       150
       150
       +
             _ -> :ok

     

       151
       151
       +
           end

     

       152
       152
       +
         end

     

       153
       153
       +
       

     

       154
       154
       +
         defp cleanup_relay_group(uuid, subject) do

     

       155
       155
       +
           case Relays.fetch_group_by_id(uuid, subject) do

     

       156
       156
       +
             {:ok, value} ->

     

       157
       157
       +
               Logger.info("Deleting removed relay group #{value.name}")

     

       158
       158
       +
               {:ok, _} = Relays.delete_group(value, subject)

     

       159
       159
       +
             _ -> :ok

     

       160
       160
       +
           end

     

       161
       161
       +
         end

     

       162
       162
       +
       

     

       163
       163
       +
         defp cleanup_actor_group(uuid, subject) do

     

       164
       164
       +
           case Actors.fetch_group_by_id(uuid, subject) do

     

       165
       165
       +
             {:ok, value} ->

     

       166
       166
       +
               Logger.info("Deleting removed actor group #{value.name}")

     

       167
       167
       +
               {:ok, _} = Actors.delete_group(value, subject)

     

       168
       168
       +
             _ -> :ok

     

       169
       169
       +
           end

     

       170
       170
       +
         end

     

       171
       171
       +
       

     

       172
       172
       +
         # Fetch resource by uuid, but follow the chain of replacements if any

     

       173
       173
       +
         defp fetch_resource(uuid, subject) do

     

       174
       174
       +
           case Resources.fetch_resource_by_id(uuid, subject) do

     

       175
       175
       +
             {:ok, resource} when resource.replaced_by_resource_id != nil -> fetch_resource(resource.replaced_by_resource_id, subject)

     

       176
       176
       +
             v -> v

     

       177
       177
       +
           end

     

       178
       178
       +
         end

     

       179
       179
       +
       

     

       180
       180
       +
         defp cleanup_resource(uuid, subject) do

     

       181
       181
       +
           case fetch_resource(uuid, subject) do

     

       182
       182
       +
             {:ok, value} when value.deleted_at == nil ->

     

       183
       183
       +
               Logger.info("Deleting removed resource #{value.name}")

     

       184
       184
       +
               {:ok, _} = Resources.delete_resource(value, subject)

     

       185
       185
       +
             _ -> :ok

     

       186
       186
       +
           end

     

       187
       187
       +
         end

     

       188
       188
       +
       

     

       189
       189
       +
         # Fetch policy by uuid, but follow the chain of replacements if any

     

       190
       190
       +
         defp fetch_policy(uuid, subject) do

     

       191
       191
       +
           case Policies.fetch_policy_by_id(uuid, subject) do

     

       192
       192
       +
             {:ok, policy} when policy.replaced_by_policy_id != nil -> fetch_policy(policy.replaced_by_policy_id, subject)

     

       193
       193
       +
             v -> v

     

       194
       194
       +
           end

     

       195
       195
       +
         end

     

       196
       196
       +
       

     

       197
       197
       +
         defp cleanup_policy(uuid, subject) do

     

       198
       198
       +
           case fetch_policy(uuid, subject) do

     

       199
       199
       +
             {:ok, value} when value.deleted_at == nil ->

     

       200
       200
       +
               Logger.info("Deleting removed policy #{value.description}")

     

       201
       201
       +
               {:ok, _} = Policies.delete_policy(value, subject)

     

       202
       202
       +
             _ -> :ok

     

       203
       203
       +
           end

     

       204
       204
       +
         end

     

       205
       205
       +
       

     

       206
       206
       +
         defp cleanup_entity_type(account_slug, entity_type, cleanup_fn, temp_admin_subject) do

     

       207
       207
       +
           # Get mapping for this entity type

     

       208
       208
       +
           existing_entities = UuidMapping.get_entities(account_slug, entity_type)

     

       209
       209
       +
           # Get current entities from account data

     

       210
       210
       +
           current_entities = Process.get(:current_entities)

     

       211
       211
       +
           # Determine which ones to remove

     

       212
       212
       +
           removed_entity_ids = Map.keys(existing_entities) -- (current_entities[entity_type] || [])

     

       213
       213
       +
       

     

       214
       214
       +
           # Process each entity to remove

     

       215
       215
       +
           Enum.each(removed_entity_ids, fn entity_id ->

     

       216
       216
       +
             case existing_entities[entity_id] do

     

       217
       217
       +
               nil -> :ok

     

       218
       218
       +
               uuid ->

     

       219
       219
       +
                 cleanup_fn.(uuid, temp_admin_subject)

     

       220
       220
       +
                 UuidMapping.remove_entity(account_slug, entity_type, entity_id)

     

       221
       221
       +
             end

     

       222
       222
       +
           end)

     

       223
       223
       +
         end

     

       224
       224
       +
       

     

       225
       225
       +
         defp collect_current_entities(account_data) do

     

       226
       226
       +
           %{

     

       227
       227
       +
             "actors" => Map.keys(account_data["actors"] || %{}),

     

       228
       228
       +
             "providers" => Map.keys(account_data["auth"] || %{}),

     

       229
       229
       +
             "gateway_groups" => Map.keys(account_data["gatewayGroups"] || %{}),

     

       230
       230
       +
             "relay_groups" => Map.keys(account_data["relayGroups"] || %{}),

     

       231
       231
       +
             "actor_groups" => Map.keys(account_data["groups"] || %{}) ++ ["everyone"],

     

       232
       232
       +
             "resources" => Map.keys(account_data["resources"] || %{}),

     

       233
       233
       +
             "policies" => Map.keys(account_data["policies"] || %{})

     

       234
       234
       +
           }

     

       235
       235
       +
         end

     

       236
       236
       +
       

     

       237
       237
       +
         defp nil_if_deleted_or_not_found(value) do

     

       238
       238
       +
           case value do

     

       239
       239
       +
             nil -> nil

     

       240
       240
       +
             {:error, :not_found} -> nil

     

       241
       241
       +
             {:ok, value} when value.deleted_at != nil -> nil

     

       242
       242
       +
             v -> v

     

       243
       243
       +
           end

     

       244
       244
       +
         end

     

       245
       245
       +
       

     

       246
       246
       +
         defp create_temp_admin(account, email_provider) do

     

       247
       247
       +
           temp_admin_actor_email = "firezone-provision@localhost.local"

     

       248
       248
       +
           temp_admin_actor_context = %Auth.Context{

     

       249
       249
       +
             type: :browser,

     

       250
       250
       +
             user_agent: "Unspecified/0.0",

     

       251
       251
       +
             remote_ip: {127, 0, 0, 1},

     

       252
       252
       +
             remote_ip_location_region: "N/A",

     

       253
       253
       +
             remote_ip_location_city: "N/A",

     

       254
       254
       +
             remote_ip_location_lat: 0.0,

     

       255
       255
       +
             remote_ip_location_lon: 0.0

     

       256
       256
       +
           }

     

       257
       257
       +
       

     

       258
       258
       +
           {:ok, temp_admin_actor} =

     

       259
       259
       +
             Actors.create_actor(account, %{

     

       260
       260
       +
               type: :account_admin_user,

     

       261
       261
       +
               name: "Provisioning"

     

       262
       262
       +
             })

     

       263
       263
       +
       

     

       264
       264
       +
           {:ok, temp_admin_actor_email_identity} =

     

       265
       265
       +
             Auth.create_identity(temp_admin_actor, email_provider, %{

     

       266
       266
       +
               provider_identifier: temp_admin_actor_email,

     

       267
       267
       +
               provider_identifier_confirmation: temp_admin_actor_email

     

       268
       268
       +
             })

     

       269
       269
       +
       

     

       270
       270
       +
           {:ok, temp_admin_actor_token} =

     

       271
       271
       +
             Auth.create_token(temp_admin_actor_email_identity, temp_admin_actor_context, "temporarynonce", DateTime.utc_now() |> DateTime.add(1, :hour))

     

       272
       272
       +
       

     

       273
       273
       +
           {:ok, temp_admin_subject} =

     

       274
       274
       +
             Auth.build_subject(temp_admin_actor_token, temp_admin_actor_context)

     

       275
       275
       +
       

     

       276
       276
       +
           {temp_admin_subject, temp_admin_actor, temp_admin_actor_email_identity, temp_admin_actor_token}

     

       277
       277
       +
         end

     

       278
       278
       +
       

     

       279
       279
       +
         defp cleanup_temp_admin(temp_admin_actor, temp_admin_actor_email_identity, temp_admin_actor_token, subject) do

     

       280
       280
       +
           Logger.info("Cleaning up temporary admin actor")

     

       281
       281
       +
           {:ok, _} = Tokens.delete_token(temp_admin_actor_token, subject)

     

       282
       282
       +
           {:ok, _} = Auth.delete_identity(temp_admin_actor_email_identity, subject)

     

       283
       283
       +
           {:ok, _} = Actors.delete_actor(temp_admin_actor, subject)

     

       284
       284
       +
         end

     

       285
       285
       +
       

     

       286
       286
       +
         def provision() do

     

       287
       287
       +
           Logger.info("Starting provisioning")

     

       288
       288
       +
       

     

       289
       289
       +
           # Load desired state

     

       290
       290
       +
           json_file = "provision-state.json"

     

       291
       291
       +
           {:ok, raw_json} = File.read(json_file)

     

       292
       292
       +
           {:ok, %{"accounts" => accounts}} = Jason.decode(raw_json)

     

       293
       293
       +
           accounts = resolve_references(accounts)

     

       294
       294
       +
       

     

       295
       295
       +
           # Load existing UUID mappings into the process dictionary.

     

       296
       296
       +
           UuidMapping.load()

     

       297
       297
       +
       

     

       298
       298
       +
           # Clean up removed accounts first

     

       299
       299
       +
           current_account_slugs = Map.keys(accounts)

     

       300
       300
       +
           existing_accounts = Map.keys(Process.get(:uuid_mappings)["accounts"])

     

       301
       301
       +
           removed_accounts = existing_accounts -- current_account_slugs

     

       302
       302
       +
       

     

       303
       303
       +
           Enum.each(removed_accounts, fn slug ->

     

       304
       304
       +
             if uuid = get_in(Process.get(:uuid_mappings), ["accounts", slug, "id"]) do

     

       305
       305
       +
               cleanup_account(uuid)

     

       306
       306
       +
               # Remove the account from the UUID mapping.

     

       307
       307
       +
               UuidMapping.remove_account(slug)

     

       308
       308
       +
             end

     

       309
       309
       +
           end)

     

       310
       310
       +
       

     

       311
       311
       +
           multi = Enum.reduce(accounts, Ecto.Multi.new(), fn {slug, account_data}, multi ->

     

       312
       312
       +
             account_attrs = atomize_keys(%{

     

       313
       313
       +
               name: account_data["name"],

     

       314
       314
       +
               slug: slug,

     

       315
       315
       +
               features: Map.get(account_data, "features", %{}),

     

       316
       316
       +
               metadata: Map.get(account_data, "metadata", %{}),

     

       317
       317
       +
               limits: Map.get(account_data, "limits", %{})

     

       318
       318
       +
             })

     

       319
       319
       +
       

     

       320
       320
       +
             multi = multi

     

       321
       321
       +
               |> Ecto.Multi.run({:account, slug}, fn repo, _changes ->

     

       322
       322
       +
                 case Accounts.fetch_account_by_id_or_slug(slug) do

     

       323
       323
       +
                   {:ok, acc} ->

     

       324
       324
       +
                     Logger.info("Updating existing account #{slug}")

     

       325
       325
       +
                     updated_acc = acc |> Ecto.Changeset.change(account_attrs) |> repo.update!()

     

       326
       326
       +
                     {:ok, {:existing, updated_acc}}

     

       327
       327
       +
                   _ ->

     

       328
       328
       +
                     Logger.info("Creating new account #{slug}")

     

       329
       329
       +
                     {:ok, account} = Accounts.create_account(account_attrs)

     

       330
       330
       +
       

     

       331
       331
       +
                     Logger.info("Creating internet gateway group")

     

       332
       332
       +
                     {:ok, internet_site} = Gateways.create_internet_group(account)

     

       333
       333
       +
       

     

       334
       334
       +
                     Logger.info("Creating internet resource")

     

       335
       335
       +
                     {:ok, _internet_resource} = Resources.create_internet_resource(account, internet_site)

     

       336
       336
       +
       

     

       337
       337
       +
                     # Store mapping of slug to UUID

     

       338
       338
       +
                     UuidMapping.update_account(slug, account.id)

     

       339
       339
       +
                     {:ok, {:new, account}}

     

       340
       340
       +
                 end

     

       341
       341
       +
               end)

     

       342
       342
       +
               |> Ecto.Multi.run({:everyone_group, slug}, fn _repo, changes ->

     

       343
       343
       +
                 case Map.get(changes, {:account, slug}) do

     

       344
       344
       +
                   {:new, account} ->

     

       345
       345
       +
                     Logger.info("Creating everyone group for new account")

     

       346
       346
       +
                     {:ok, actor_group} = Actors.create_managed_group(account, %{name: "Everyone", membership_rules: [%{operator: true}]})

     

       347
       347
       +
                     UuidMapping.update_entities(slug, "actor_groups", %{"everyone" => actor_group.id})

     

       348
       348
       +
                     {:ok, actor_group}

     

       349
       349
       +
                   {:existing, _account} ->

     

       350
       350
       +
                     {:ok, :skipped}

     

       351
       351
       +
                 end

     

       352
       352
       +
               end)

     

       353
       353
       +
               |> Ecto.Multi.run({:email_provider, slug}, fn _repo, changes ->

     

       354
       354
       +
                 case Map.get(changes, {:account, slug}) do

     

       355
       355
       +
                   {:new, account} ->

     

       356
       356
       +
                     Logger.info("Creating default email provider for new account")

     

       357
       357
       +
                     Auth.create_provider(account, %{name: "Email", adapter: :email, adapter_config: %{}})

     

       358
       358
       +
                   {:existing, account} ->

     

       359
       359
       +
                     Auth.Provider.Query.not_disabled()

     

       360
       360
       +
                     |> Auth.Provider.Query.by_adapter(:email)

     

       361
       361
       +
                     |> Auth.Provider.Query.by_account_id(account.id)

     

       362
       362
       +
                     |> Repo.fetch(Auth.Provider.Query, [])

     

       363
       363
       +
                 end

     

       364
       364
       +
               end)

     

       365
       365
       +
               |> Ecto.Multi.run({:temp_admin, slug}, fn _repo, changes ->

     

       366
       366
       +
                 {_, account} = changes[{:account, slug}]

     

       367
       367
       +
                 email_provider = changes[{:email_provider, slug}]

     

       368
       368
       +
                 {:ok, create_temp_admin(account, email_provider)}

     

       369
       369
       +
               end)

     

       370
       370
       +
       

     

       371
       371
       +
             # Clean up removed entities for this account after we have an admin subject

     

       372
       372
       +
             multi = multi

     

       373
       373
       +
               |> Ecto.Multi.run({:cleanup_entities, slug}, fn _repo, changes ->

     

       374
       374
       +
                 {temp_admin_subject, _, _, _} = changes[{:temp_admin, slug}]

     

       375
       375
       +
       

     

       376
       376
       +
                 # Store current entities in process dictionary for our helper function

     

       377
       377
       +
                 current_entities = collect_current_entities(account_data)

     

       378
       378
       +
                 Process.put(:current_entities, current_entities)

     

       379
       379
       +
       

     

       380
       380
       +
                 # Define entity types and their cleanup functions

     

       381
       381
       +
                 entity_types = [

     

       382
       382
       +
                   {"actors", &cleanup_actor/2},

     

       383
       383
       +
                   {"providers", &cleanup_provider/2},

     

       384
       384
       +
                   {"gateway_groups", &cleanup_gateway_group/2},

     

       385
       385
       +
                   {"relay_groups", &cleanup_relay_group/2},

     

       386
       386
       +
                   {"actor_groups", &cleanup_actor_group/2},

     

       387
       387
       +
                   {"resources", &cleanup_resource/2},

     

       388
       388
       +
                   {"policies", &cleanup_policy/2}

     

       389
       389
       +
                 ]

     

       390
       390
       +
       

     

       391
       391
       +
                 # Clean up each entity type

     

       392
       392
       +
                 Enum.each(entity_types, fn {entity_type, cleanup_fn} ->

     

       393
       393
       +
                   cleanup_entity_type(slug, entity_type, cleanup_fn, temp_admin_subject)

     

       394
       394
       +
                 end)

     

       395
       395
       +
       

     

       396
       396
       +
                 {:ok, :cleaned}

     

       397
       397
       +
               end)

     

       398
       398
       +
       

     

       399
       399
       +
             # Create or update actors

     

       400
       400
       +
             multi = Enum.reduce(account_data["actors"] || %{}, multi, fn {external_id, actor_data}, multi ->

     

       401
       401
       +
               actor_attrs = atomize_keys(%{

     

       402
       402
       +
                 name: actor_data["name"],

     

       403
       403
       +
                 type: String.to_atom(actor_data["type"])

     

       404
       404
       +
               })

     

       405
       405
       +
       

     

       406
       406
       +
               Ecto.Multi.run(multi, {:actor, slug, external_id}, fn _repo, changes ->

     

       407
       407
       +
                 {_, account} = changes[{:account, slug}]

     

       408
       408
       +
                 {temp_admin_subject, _, _, _} = changes[{:temp_admin, slug}]

     

       409
       409
       +
                 uuid = UuidMapping.get_entity(slug, "actors", external_id)

     

       410
       410
       +
                 case uuid && Actors.fetch_actor_by_id(uuid, temp_admin_subject) |> nil_if_deleted_or_not_found() do

     

       411
       411
       +
                   nil ->

     

       412
       412
       +
                     Logger.info("Creating new actor #{actor_data["name"]}")

     

       413
       413
       +
                     {:ok, actor} = Actors.create_actor(account, actor_attrs)

     

       414
       414
       +
                     # Update the mapping without manually handling Process.get/put.

     

       415
       415
       +
                     UuidMapping.update_entities(slug, "actors", %{external_id => actor.id})

     

       416
       416
       +
                     {:ok, {:new, actor}}

     

       417
       417
       +
                   {:ok, existing_actor} ->

     

       418
       418
       +
                     Logger.info("Updating existing actor #{actor_data["name"]}")

     

       419
       419
       +
                     {:ok, updated_act} = Actors.update_actor(existing_actor, actor_attrs, temp_admin_subject)

     

       420
       420
       +
                     {:ok, {:existing, updated_act}}

     

       421
       421
       +
                 end

     

       422
       422
       +
               end)

     

       423
       423
       +
               |> Ecto.Multi.run({:actor_identity, slug, external_id}, fn repo, changes ->

     

       424
       424
       +
                 email_provider = changes[{:email_provider, slug}]

     

       425
       425
       +
                 case Map.get(changes, {:actor, slug, external_id}) do

     

       426
       426
       +
                   {:new, actor} ->

     

       427
       427
       +
                     Logger.info("Creating actor email identity")

     

       428
       428
       +
                     Auth.create_identity(actor, email_provider, %{

     

       429
       429
       +
                       provider_identifier: actor_data["email"],

     

       430
       430
       +
                       provider_identifier_confirmation: actor_data["email"]

     

       431
       431
       +
                     })

     

       432
       432
       +
                   {:existing, actor} ->

     

       433
       433
       +
                     Logger.info("Updating actor email identity")

     

       434
       434
       +
                     {:ok, identity} = Auth.Identity.Query.not_deleted()

     

       435
       435
       +
                     |> Auth.Identity.Query.by_actor_id(actor.id)

     

       436
       436
       +
                     |> Auth.Identity.Query.by_provider_id(email_provider.id)

     

       437
       437
       +
                     |> Repo.fetch(Auth.Identity.Query, [])

     

       438
       438
       +
       

     

       439
       439
       +
                     {:ok, identity |> Ecto.Changeset.change(%{

     

       440
       440
       +
                       provider_identifier: actor_data["email"]

     

       441
       441
       +
                     }) |> repo.update!()}

     

       442
       442
       +
                 end

     

       443
       443
       +
               end)

     

       444
       444
       +
             end)

     

       445
       445
       +
       

     

       446
       446
       +
             # Create or update providers

     

       447
       447
       +
             multi = Enum.reduce(account_data["auth"] || %{}, multi, fn {external_id, provider_data}, multi ->

     

       448
       448
       +
               Ecto.Multi.run(multi, {:provider, slug, external_id}, fn repo, changes ->

     

       449
       449
       +
                 provider_attrs = %{

     

       450
       450
       +
                   name: provider_data["name"],

     

       451
       451
       +
                   adapter: String.to_atom(provider_data["adapter"]),

     

       452
       452
       +
                   adapter_config: provider_data["adapter_config"]

     

       453
       453
       +
                 }

     

       454
       454
       +
       

     

       455
       455
       +
                 {_, account} = changes[{:account, slug}]

     

       456
       456
       +
                 {temp_admin_subject, _, _, _} = changes[{:temp_admin, slug}]

     

       457
       457
       +
                 uuid = UuidMapping.get_entity(slug, "providers", external_id)

     

       458
       458
       +
                 case uuid && Auth.fetch_provider_by_id(uuid, temp_admin_subject) |> nil_if_deleted_or_not_found() do

     

       459
       459
       +
                   nil ->

     

       460
       460
       +
                     Logger.info("Creating new provider #{provider_data["name"]}")

     

       461
       461
       +
                     {:ok, provider} = Auth.create_provider(account, provider_attrs)

     

       462
       462
       +
                     UuidMapping.update_entities(slug, "providers", %{external_id => provider.id})

     

       463
       463
       +
                     {:ok, provider}

     

       464
       464
       +
                   {:ok, existing} ->

     

       465
       465
       +
                     Logger.info("Updating existing provider #{provider_data["name"]}")

     

       466
       466
       +
                     {:ok, existing |> Ecto.Changeset.change(provider_attrs) |> repo.update!()}

     

       467
       467
       +
                 end

     

       468
       468
       +
               end)

     

       469
       469
       +
             end)

     

       470
       470
       +
       

     

       471
       471
       +
             # Create or update gateway_groups

     

       472
       472
       +
             multi = Enum.reduce(account_data["gatewayGroups"] || %{}, multi, fn {external_id, gateway_group_data}, multi ->

     

       473
       473
       +
               Ecto.Multi.run(multi, {:gateway_group, slug, external_id}, fn _repo, changes ->

     

       474
       474
       +
                 gateway_group_attrs = %{

     

       475
       475
       +
                   name: gateway_group_data["name"],

     

       476
       476
       +
                   tokens: [%{}]

     

       477
       477
       +
                 }

     

       478
       478
       +
       

     

       479
       479
       +
                 {_, account} = changes[{:account, slug}]

     

       480
       480
       +
                 {temp_admin_subject, _, _, _} = changes[{:temp_admin, slug}]

     

       481
       481
       +
                 uuid = UuidMapping.get_entity(slug, "gateway_groups", external_id)

     

       482
       482
       +
                 case uuid && Gateways.fetch_group_by_id(uuid, temp_admin_subject) |> nil_if_deleted_or_not_found() do

     

       483
       483
       +
                   nil ->

     

       484
       484
       +
                     Logger.info("Creating new gateway group #{gateway_group_data["name"]}")

     

       485
       485
       +
                     gateway_group = account

     

       486
       486
       +
                       |> Gateways.Group.Changeset.create(gateway_group_attrs, temp_admin_subject)

     

       487
       487
       +
                       |> Repo.insert!()

     

       488
       488
       +
                     UuidMapping.update_entities(slug, "gateway_groups", %{external_id => gateway_group.id})

     

       489
       489
       +
                     {:ok, gateway_group}

     

       490
       490
       +
                   {:ok, existing} ->

     

       491
       491
       +
                     # Nothing to update

     

       492
       492
       +
                     {:ok, existing}

     

       493
       493
       +
                 end

     

       494
       494
       +
               end)

     

       495
       495
       +
             end)

     

       496
       496
       +
       

     

       497
       497
       +
             # Create or update relay_groups

     

       498
       498
       +
             multi = Enum.reduce(account_data["relayGroups"] || %{}, multi, fn {external_id, relay_group_data}, multi ->

     

       499
       499
       +
               Ecto.Multi.run(multi, {:relay_group, slug, external_id}, fn _repo, changes ->

     

       500
       500
       +
                 relay_group_attrs = %{

     

       501
       501
       +
                   name: relay_group_data["name"]

     

       502
       502
       +
                 }

     

       503
       503
       +
       

     

       504
       504
       +
                 {temp_admin_subject, _, _, _} = changes[{:temp_admin, slug}]

     

       505
       505
       +
                 uuid = UuidMapping.get_entity(slug, "relay_groups", external_id)

     

       506
       506
       +
                 existing_relay_group = uuid && Relays.fetch_group_by_id(uuid, temp_admin_subject)

     

       507
       507
       +
                 case existing_relay_group do

     

       508
       508
       +
                   v when v in [nil, {:error, :not_found}] ->

     

       509
       509
       +
                     Logger.info("Creating new relay group #{relay_group_data["name"]}")

     

       510
       510
       +
                     {:ok, relay_group} = Relays.create_group(relay_group_attrs, temp_admin_subject)

     

       511
       511
       +
                     UuidMapping.update_entities(slug, "relay_groups", %{external_id => relay_group.id})

     

       512
       512
       +
                     {:ok, relay_group}

     

       513
       513
       +
                   {:ok, existing} ->

     

       514
       514
       +
                     # Nothing to update

     

       515
       515
       +
                     {:ok, existing}

     

       516
       516
       +
                 end

     

       517
       517
       +
               end)

     

       518
       518
       +
             end)

     

       519
       519
       +
       

     

       520
       520
       +
             # Create or update actor_groups

     

       521
       521
       +
             multi = Enum.reduce(account_data["groups"] || %{}, multi, fn {external_id, actor_group_data}, multi ->

     

       522
       522
       +
               Ecto.Multi.run(multi, {:actor_group, slug, external_id}, fn _repo, changes ->

     

       523
       523
       +
                 actor_group_attrs = %{

     

       524
       524
       +
                   name: actor_group_data["name"],

     

       525
       525
       +
                   type: :static

     

       526
       526
       +
                 }

     

       527
       527
       +
       

     

       528
       528
       +
                 {temp_admin_subject, _, _, _} = changes[{:temp_admin, slug}]

     

       529
       529
       +
                 uuid = UuidMapping.get_entity(slug, "actor_groups", external_id)

     

       530
       530
       +
                 case uuid && Actors.fetch_group_by_id(uuid, temp_admin_subject) |> nil_if_deleted_or_not_found() do

     

       531
       531
       +
                   nil ->

     

       532
       532
       +
                     Logger.info("Creating new actor group #{actor_group_data["name"]}")

     

       533
       533
       +
                     {:ok, actor_group} = Actors.create_group(actor_group_attrs, temp_admin_subject)

     

       534
       534
       +
                     UuidMapping.update_entities(slug, "actor_groups", %{external_id => actor_group.id})

     

       535
       535
       +
                     {:ok, actor_group}

     

       536
       536
       +
                   {:ok, existing} ->

     

       537
       537
       +
                     # Nothing to update

     

       538
       538
       +
                     {:ok, existing}

     

       539
       539
       +
                 end

     

       540
       540
       +
               end)

     

       541
       541
       +
               |> Ecto.Multi.run({:actor_group_members, slug, external_id}, fn repo, changes ->

     

       542
       542
       +
                 {_, account} = changes[{:account, slug}]

     

       543
       543
       +
                 group_uuid = UuidMapping.get_entity(slug, "actor_groups", external_id)

     

       544
       544
       +
       

     

       545
       545
       +
                 memberships =

     

       546
       546
       +
                   Actors.Membership.Query.all()

     

       547
       547
       +
                   |> Actors.Membership.Query.by_group_id(group_uuid)

     

       548
       548
       +
                   |> Actors.Membership.Query.returning_all()

     

       549
       549
       +
                   |> Repo.all()

     

       550
       550
       +
       

     

       551
       551
       +
                 existing_members = Enum.map(memberships, fn membership -> membership.actor_id end)

     

       552
       552
       +
                 desired_members = Enum.map(actor_group_data["members"] || [], fn member ->

     

       553
       553
       +
                   uuid = UuidMapping.get_entity(slug, "actors", member)

     

       554
       554
       +
                   if uuid == nil do

     

       555
       555
       +
                     raise "Cannot find provisioned actor #{member} to add to group"

     

       556
       556
       +
                   end

     

       557
       557
       +
                   uuid

     

       558
       558
       +
                 end)

     

       559
       559
       +
       

     

       560
       560
       +
                 missing_members = desired_members -- existing_members

     

       561
       561
       +
                 untracked_members = existing_members -- desired_members

     

       562
       562
       +
       

     

       563
       563
       +
                 Logger.info("Updating members for actor group #{external_id}")

     

       564
       564
       +
                 Enum.each(missing_members || [], fn actor_uuid ->

     

       565
       565
       +
                   Logger.info("Adding member #{external_id}")

     

       566
       566
       +
                   Actors.Membership.Changeset.upsert(account.id, %Actors.Membership{}, %{

     

       567
       567
       +
                     group_id: group_uuid,

     

       568
       568
       +
                     actor_id: actor_uuid

     

       569
       569
       +
                   })

     

       570
       570
       +
                   |> repo.insert!()

     

       571
       571
       +
                 end)

     

       572
       572
       +
       

     

       573
       573
       +
                 if actor_group_data["forceMembers"] == true do

     

       574
       574
       +
                   # Remove untracked members

     

       575
       575
       +
                   to_delete = Enum.map(untracked_members, fn actor_uuid -> {group_uuid, actor_uuid} end)

     

       576
       576
       +
                   if to_delete != [] do

     

       577
       577
       +
                     Actors.Membership.Query.by_group_id_and_actor_id({:in, to_delete})

     

       578
       578
       +
                       |> repo.delete_all()

     

       579
       579
       +
                   end

     

       580
       580
       +
                 end

     

       581
       581
       +
       

     

       582
       582
       +
                 {:ok, nil}

     

       583
       583
       +
               end)

     

       584
       584
       +
             end)

     

       585
       585
       +
       

     

       586
       586
       +
             # Create or update resources

     

       587
       587
       +
             multi = Enum.reduce(account_data["resources"] || %{}, multi, fn {external_id, resource_data}, multi ->

     

       588
       588
       +
               Ecto.Multi.run(multi, {:resource, slug, external_id}, fn _repo, changes ->

     

       589
       589
       +
                 resource_attrs = %{

     

       590
       590
       +
                   type: String.to_atom(resource_data["type"]),

     

       591
       591
       +
                   name: resource_data["name"],

     

       592
       592
       +
                   address: resource_data["address"],

     

       593
       593
       +
                   address_description: resource_data["address_description"],

     

       594
       594
       +
                   connections: Enum.map(resource_data["gatewayGroups"] || [], fn group ->

     

       595
       595
       +
                     %{gateway_group_id: UuidMapping.get_entity(slug, "gateway_groups", group)}

     

       596
       596
       +
                   end),

     

       597
       597
       +
                   filters: Enum.map(resource_data["filters"] || [], fn filter ->

     

       598
       598
       +
                     %{

     

       599
       599
       +
                       ports: filter["ports"] || [],

     

       600
       600
       +
                       protocol: String.to_atom(filter["protocol"])

     

       601
       601
       +
                     }

     

       602
       602
       +
                   end)

     

       603
       603
       +
                 }

     

       604
       604
       +
       

     

       605
       605
       +
                 {temp_admin_subject, _, _, _} = changes[{:temp_admin, slug}]

     

       606
       606
       +
                 uuid = UuidMapping.get_entity(slug, "resources", external_id)

     

       607
       607
       +
                 case uuid && fetch_resource(uuid, temp_admin_subject) |> nil_if_deleted_or_not_found() do

     

       608
       608
       +
                   nil ->

     

       609
       609
       +
                     Logger.info("Creating new resource #{resource_data["name"]}")

     

       610
       610
       +
                     {:ok, resource} = Resources.create_resource(resource_attrs, temp_admin_subject)

     

       611
       611
       +
                     UuidMapping.update_entities(slug, "resources", %{external_id => resource.id})

     

       612
       612
       +
                     {:ok, resource}

     

       613
       613
       +
                   {:ok, existing} ->

     

       614
       614
       +
                     existing = Repo.preload(existing, :connections)

     

       615
       615
       +
                     Logger.info("Updating existing resource #{resource_data["name"]}")

     

       616
       616
       +
                     only_updated_attrs = resource_attrs

     

       617
       617
       +
                       |> Enum.reject(fn {key, value} ->

     

       618
       618
       +
                         case key do

     

       619
       619
       +
                           # Compare connections by gateway_group_id only

     

       620
       620
       +
                           :connections -> value == Enum.map(existing.connections || [], fn conn -> Map.take(conn, [:gateway_group_id]) end)

     

       621
       621
       +
                           # Compare filters by ports and protocol only

     

       622
       622
       +
                           :filters -> value == Enum.map(existing.filters || [], fn filter -> Map.take(filter, [:ports, :protocol]) end)

     

       623
       623
       +
                           _ -> Map.get(existing, key) == value

     

       624
       624
       +
                         end

     

       625
       625
       +
                       end)

     

       626
       626
       +
                       |> Enum.into(%{})

     

       627
       627
       +
       

     

       628
       628
       +
                     if only_updated_attrs == %{} do

     

       629
       629
       +
                       {:ok, existing}

     

       630
       630
       +
                     else

     

       631
       631
       +
                       resource = case existing |> Resources.update_resource(resource_attrs, temp_admin_subject) do

     

       632
       632
       +
                         {:replaced, _old, new} ->

     

       633
       633
       +
                           UuidMapping.update_entities(slug, "resources", %{external_id => new.id})

     

       634
       634
       +
                           new

     

       635
       635
       +
                         {:updated, value} -> value

     

       636
       636
       +
                         x -> x

     

       637
       637
       +
                       end

     

       638
       638
       +
       

     

       639
       639
       +
                       {:ok, resource}

     

       640
       640
       +
                     end

     

       641
       641
       +
                 end

     

       642
       642
       +
               end)

     

       643
       643
       +
             end)

     

       644
       644
       +
       

     

       645
       645
       +
             # Create or update policies

     

       646
       646
       +
             multi = Enum.reduce(account_data["policies"] || %{}, multi, fn {external_id, policy_data}, multi ->

     

       647
       647
       +
               Ecto.Multi.run(multi, {:policy, slug, external_id}, fn _repo, changes ->

     

       648
       648
       +
                 policy_attrs = %{

     

       649
       649
       +
                   description: policy_data["description"],

     

       650
       650
       +
                   actor_group_id: UuidMapping.get_entity(slug, "actor_groups", policy_data["group"]),

     

       651
       651
       +
                   resource_id: UuidMapping.get_entity(slug, "resources", policy_data["resource"])

     

       652
       652
       +
                 }

     

       653
       653
       +
       

     

       654
       654
       +
                 {temp_admin_subject, _, _, _} = changes[{:temp_admin, slug}]

     

       655
       655
       +
                 uuid = UuidMapping.get_entity(slug, "policies", external_id)

     

       656
       656
       +
                 case uuid && fetch_policy(uuid, temp_admin_subject) |> nil_if_deleted_or_not_found() do

     

       657
       657
       +
                   nil ->

     

       658
       658
       +
                     Logger.info("Creating new policy #{policy_data["name"]}")

     

       659
       659
       +
                     {:ok, policy} = Policies.create_policy(policy_attrs, temp_admin_subject)

     

       660
       660
       +
                     UuidMapping.update_entities(slug, "policies", %{external_id => policy.id})

     

       661
       661
       +
                     {:ok, policy}

     

       662
       662
       +
                   {:ok, existing} ->

     

       663
       663
       +
                     Logger.info("Updating existing policy #{policy_data["name"]}")

     

       664
       664
       +
                     only_updated_attrs = policy_attrs

     

       665
       665
       +
                       |> Enum.reject(fn {key, value} -> Map.get(existing, key) == value end)

     

       666
       666
       +
                       |> Enum.into(%{})

     

       667
       667
       +
       

     

       668
       668
       +
                     if only_updated_attrs == %{} do

     

       669
       669
       +
                       {:ok, existing}

     

       670
       670
       +
                     else

     

       671
       671
       +
                       policy = case existing |> Policies.update_policy(policy_attrs, temp_admin_subject) do

     

       672
       672
       +
                         {:replaced, _old, new} ->

     

       673
       673
       +
                           UuidMapping.update_entities(slug, "policies", %{external_id => new.id})

     

       674
       674
       +
                           new

     

       675
       675
       +
                         {:updated, value} -> value

     

       676
       676
       +
                         x -> x

     

       677
       677
       +
                       end

     

       678
       678
       +
       

     

       679
       679
       +
                       {:ok, policy}

     

       680
       680
       +
                     end

     

       681
       681
       +
                 end

     

       682
       682
       +
               end)

     

       683
       683
       +
             end)

     

       684
       684
       +
       

     

       685
       685
       +
             # Clean up temporary admin after all operations

     

       686
       686
       +
             multi |> Ecto.Multi.run({:cleanup_temp_admin, slug}, fn _repo, changes ->

     

       687
       687
       +
               {temp_admin_subject, temp_admin_actor, temp_admin_actor_email_identity, temp_admin_actor_token} =

     

       688
       688
       +
                 changes[{:temp_admin, slug}]

     

       689
       689
       +
       

     

       690
       690
       +
               cleanup_temp_admin(temp_admin_actor, temp_admin_actor_email_identity, temp_admin_actor_token, temp_admin_subject)

     

       691
       691
       +
               {:ok, :cleaned}

     

       692
       692
       +
             end)

     

       693
       693
       +
           end)

     

       694
       694
       +
           |> Ecto.Multi.run({:save_state}, fn _repo, _changes ->

     

       695
       695
       +
             # Save all UUID mappings to disk.

     

       696
       696
       +
             UuidMapping.save()

     

       697
       697
       +
             {:ok, :saved}

     

       698
       698
       +
           end)

     

       699
       699
       +
       

     

       700
       700
       +
           case Repo.transaction(multi) do

     

       701
       701
       +
             {:ok, _result} ->

     

       702
       702
       +
               Logger.info("Provisioning completed successfully")

     

       703
       703
       +
             {:error, step, reason, _changes} ->

     

       704
       704
       +
               Logger.error("Provisioning failed at step #{inspect(step)}, no changes were applied: #{inspect(reason)}")

     

       705
       705
       +
           end

     

       706
       706
       +
         end

     

       707
       707
       +
       end

     

       708
       708
       +
       

     

       709
       709
       +
       Provision.provision()

+202

nixos/modules/services/networking/firezone/relay.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         pkgs,

     

       4
       4
       +
         config,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         inherit (lib)

     

       9
       9
       +
           boolToString

     

       10
       10
       +
           getExe

     

       11
       11
       +
           mkEnableOption

     

       12
       12
       +
           mkIf

     

       13
       13
       +
           mkOption

     

       14
       14
       +
           mkPackageOption

     

       15
       15
       +
           types

     

       16
       16
       +
           ;

     

       17
       17
       +
       

     

       18
       18
       +
         cfg = config.services.firezone.relay;

     

       19
       19
       +
       in

     

       20
       20
       +
       {

     

       21
       21
       +
         options = {

     

       22
       22
       +
           services.firezone.relay = {

     

       23
       23
       +
             enable = mkEnableOption "the firezone relay server";

     

       24
       24
       +
             package = mkPackageOption pkgs "firezone-relay" { };

     

       25
       25
       +
       

     

       26
       26
       +
             name = mkOption {

     

       27
       27
       +
               type = types.str;

     

       28
       28
       +
               example = "My relay";

     

       29
       29
       +
               description = "The name of this gateway as shown in firezone";

     

       30
       30
       +
             };

     

       31
       31
       +
       

     

       32
       32
       +
             publicIpv4 = mkOption {

     

       33
       33
       +
               type = types.nullOr types.str;

     

       34
       34
       +
               default = null;

     

       35
       35
       +
               description = "The public ipv4 address of this relay";

     

       36
       36
       +
             };

     

       37
       37
       +
       

     

       38
       38
       +
             publicIpv6 = mkOption {

     

       39
       39
       +
               type = types.nullOr types.str;

     

       40
       40
       +
               default = null;

     

       41
       41
       +
               description = "The public ipv6 address of this relay";

     

       42
       42
       +
             };

     

       43
       43
       +
       

     

       44
       44
       +
             openFirewall = mkOption {

     

       45
       45
       +
               type = types.bool;

     

       46
       46
       +
               default = true;

     

       47
       47
       +
               description = "Opens up the main STUN port and the TURN allocation range.";

     

       48
       48
       +
             };

     

       49
       49
       +
       

     

       50
       50
       +
             port = mkOption {

     

       51
       51
       +
               type = types.port;

     

       52
       52
       +
               default = 3478;

     

       53
       53
       +
               description = "The port to listen on for STUN messages";

     

       54
       54
       +
             };

     

       55
       55
       +
       

     

       56
       56
       +
             lowestPort = mkOption {

     

       57
       57
       +
               type = types.port;

     

       58
       58
       +
               default = 49152;

     

       59
       59
       +
               description = "The lowest port to use in TURN allocation";

     

       60
       60
       +
             };

     

       61
       61
       +
       

     

       62
       62
       +
             highestPort = mkOption {

     

       63
       63
       +
               type = types.port;

     

       64
       64
       +
               default = 65535;

     

       65
       65
       +
               description = "The highest port to use in TURN allocation";

     

       66
       66
       +
             };

     

       67
       67
       +
       

     

       68
       68
       +
             apiUrl = mkOption {

     

       69
       69
       +
               type = types.strMatching "^wss://.+/$";

     

       70
       70
       +
               example = "wss://firezone.example.com/api/";

     

       71
       71
       +
               description = ''

     

       72
       72
       +
                 The URL of your firezone server's API. This should be the same

     

       73
       73
       +
                 as your server's setting for {option}`services.firezone.server.settings.api.externalUrl`,

     

       74
       74
       +
                 but with `wss://` instead of `https://`.

     

       75
       75
       +
               '';

     

       76
       76
       +
             };

     

       77
       77
       +
       

     

       78
       78
       +
             tokenFile = mkOption {

     

       79
       79
       +
               type = types.path;

     

       80
       80
       +
               example = "/run/secrets/firezone-relay-token";

     

       81
       81
       +
               description = ''

     

       82
       82
       +
                 A file containing the firezone relay token. Do not use a nix-store path here

     

       83
       83
       +
                 as it will make the token publicly readable!

     

       84
       84
       +
       

     

       85
       85
       +
                 This file will be passed via systemd credentials, it should only be accessible

     

       86
       86
       +
                 by the root user.

     

       87
       87
       +
               '';

     

       88
       88
       +
             };

     

       89
       89
       +
       

     

       90
       90
       +
             logLevel = mkOption {

     

       91
       91
       +
               type = types.str;

     

       92
       92
       +
               default = "info";

     

       93
       93
       +
               description = ''

     

       94
       94
       +
                 The log level for the firezone application. See

     

       95
       95
       +
                 [RUST_LOG](https://docs.rs/env_logger/latest/env_logger/#enabling-logging)

     

       96
       96
       +
                 for the format.

     

       97
       97
       +
               '';

     

       98
       98
       +
             };

     

       99
       99
       +
       

     

       100
       100
       +
             enableTelemetry = mkEnableOption "telemetry";

     

       101
       101
       +
           };

     

       102
       102
       +
         };

     

       103
       103
       +
       

     

       104
       104
       +
         config = mkIf cfg.enable {

     

       105
       105
       +
           assertions = [

     

       106
       106
       +
             {

     

       107
       107
       +
               assertion = cfg.publicIpv4 != null || cfg.publicIpv6 != null;

     

       108
       108
       +
               message = "At least one of `services.firezone.relay.publicIpv4` and `services.firezone.relay.publicIpv6` must be set";

     

       109
       109
       +
             }

     

       110
       110
       +
           ];

     

       111
       111
       +
       

     

       112
       112
       +
           networking.firewall.allowedUDPPorts = mkIf cfg.openFirewall [ cfg.port ];

     

       113
       113
       +
           networking.firewall.allowedUDPPortRanges = mkIf cfg.openFirewall [

     

       114
       114
       +
             {

     

       115
       115
       +
               from = cfg.lowestPort;

     

       116
       116
       +
               to = cfg.highestPort;

     

       117
       117
       +
             }

     

       118
       118
       +
           ];

     

       119
       119
       +
       

     

       120
       120
       +
           systemd.services.firezone-relay = {

     

       121
       121
       +
             description = "relay service for the Firezone zero-trust access platform";

     

       122
       122
       +
             after = [ "network.target" ];

     

       123
       123
       +
             wantedBy = [ "multi-user.target" ];

     

       124
       124
       +
       

     

       125
       125
       +
             path = [ pkgs.util-linux ];

     

       126
       126
       +
             script = ''

     

       127
       127
       +
               # If FIREZONE_ID is not given by the user, use a persisted (or newly generated) uuid.

     

       128
       128
       +
               if [[ -z "''${FIREZONE_ID:-}" ]]; then

     

       129
       129
       +
                 if [[ ! -e relay_id ]]; then

     

       130
       130
       +
                   uuidgen -r > relay_id

     

       131
       131
       +
                 fi

     

       132
       132
       +
                 export FIREZONE_ID=$(< relay_id)

     

       133
       133
       +
               fi

     

       134
       134
       +
       

     

       135
       135
       +
               export FIREZONE_TOKEN=$(< "$CREDENTIALS_DIRECTORY/firezone-token")

     

       136
       136
       +
               exec ${getExe cfg.package}

     

       137
       137
       +
             '';

     

       138
       138
       +
       

     

       139
       139
       +
             environment = {

     

       140
       140
       +
               FIREZONE_API_URL = cfg.apiUrl;

     

       141
       141
       +
               FIREZONE_NAME = cfg.name;

     

       142
       142
       +
               FIREZONE_TELEMETRY = boolToString cfg.enableTelemetry;

     

       143
       143
       +
       

     

       144
       144
       +
               PUBLIC_IP4_ADDR = cfg.publicIpv4;

     

       145
       145
       +
               PUBLIC_IP6_ADDR = cfg.publicIpv6;

     

       146
       146
       +
       

     

       147
       147
       +
               LISTEN_PORT = toString cfg.port;

     

       148
       148
       +
               LOWEST_PORT = toString cfg.lowestPort;

     

       149
       149
       +
               HIGHEST_PORT = toString cfg.highestPort;

     

       150
       150
       +
       

     

       151
       151
       +
               RUST_LOG = cfg.logLevel;

     

       152
       152
       +
               LOG_FORMAT = "human";

     

       153
       153
       +
             };

     

       154
       154
       +
       

     

       155
       155
       +
             serviceConfig = {

     

       156
       156
       +
               Type = "exec";

     

       157
       157
       +
               DynamicUser = true;

     

       158
       158
       +
               User = "firezone-relay";

     

       159
       159
       +
               LoadCredential = [ "firezone-token:${cfg.tokenFile}" ];

     

       160
       160
       +
       

     

       161
       161
       +
               StateDirectory = "firezone-relay";

     

       162
       162
       +
               WorkingDirectory = "/var/lib/firezone-relay";

     

       163
       163
       +
       

     

       164
       164
       +
               Restart = "on-failure";

     

       165
       165
       +
               RestartSec = 10;

     

       166
       166
       +
       

     

       167
       167
       +
               LockPersonality = true;

     

       168
       168
       +
               MemoryDenyWriteExecute = true;

     

       169
       169
       +
               NoNewPrivileges = true;

     

       170
       170
       +
               PrivateMounts = true;

     

       171
       171
       +
               PrivateTmp = true;

     

       172
       172
       +
               PrivateUsers = false;

     

       173
       173
       +
               ProcSubset = "pid";

     

       174
       174
       +
               ProtectClock = true;

     

       175
       175
       +
               ProtectControlGroups = true;

     

       176
       176
       +
               ProtectHome = true;

     

       177
       177
       +
               ProtectHostname = true;

     

       178
       178
       +
               ProtectKernelLogs = true;

     

       179
       179
       +
               ProtectKernelModules = true;

     

       180
       180
       +
               ProtectKernelTunables = true;

     

       181
       181
       +
               ProtectProc = "invisible";

     

       182
       182
       +
               ProtectSystem = "strict";

     

       183
       183
       +
               RestrictAddressFamilies = [

     

       184
       184
       +
                 "AF_INET"

     

       185
       185
       +
                 "AF_INET6"

     

       186
       186
       +
                 "AF_NETLINK"

     

       187
       187
       +
               ];

     

       188
       188
       +
               RestrictNamespaces = true;

     

       189
       189
       +
               RestrictRealtime = true;

     

       190
       190
       +
               RestrictSUIDSGID = true;

     

       191
       191
       +
               SystemCallArchitectures = "native";

     

       192
       192
       +
               SystemCallFilter = "@system-service";

     

       193
       193
       +
               UMask = "077";

     

       194
       194
       +
             };

     

       195
       195
       +
           };

     

       196
       196
       +
         };

     

       197
       197
       +
       

     

       198
       198
       +
         meta.maintainers = with lib.maintainers; [

     

       199
       199
       +
           oddlama

     

       200
       200
       +
           patrickdag

     

       201
       201
       +
         ];

     

       202
       202
       +
       }

+1210

nixos/modules/services/networking/firezone/server.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         pkgs,

     

       4
       4
       +
         config,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         inherit (lib)

     

       9
       9
       +
           attrNames

     

       10
       10
       +
           boolToString

     

       11
       11
       +
           concatLines

     

       12
       12
       +
           concatLists

     

       13
       13
       +
           concatMapAttrs

     

       14
       14
       +
           concatStringsSep

     

       15
       15
       +
           filterAttrs

     

       16
       16
       +
           filterAttrsRecursive

     

       17
       17
       +
           flip

     

       18
       18
       +
           forEach

     

       19
       19
       +
           getExe

     

       20
       20
       +
           isBool

     

       21
       21
       +
           mapAttrs

     

       22
       22
       +
           mapAttrsToList

     

       23
       23
       +
           mkDefault

     

       24
       24
       +
           mkEnableOption

     

       25
       25
       +
           mkIf

     

       26
       26
       +
           mkMerge

     

       27
       27
       +
           mkOption

     

       28
       28
       +
           mkPackageOption

     

       29
       29
       +
           optionalAttrs

     

       30
       30
       +
           optionalString

     

       31
       31
       +
           recursiveUpdate

     

       32
       32
       +
           subtractLists

     

       33
       33
       +
           toUpper

     

       34
       34
       +
           types

     

       35
       35
       +
           ;

     

       36
       36
       +
       

     

       37
       37
       +
         cfg = config.services.firezone.server;

     

       38
       38
       +
         jsonFormat = pkgs.formats.json { };

     

       39
       39
       +
         availableAuthAdapters = [

     

       40
       40
       +
           "email"

     

       41
       41
       +
           "openid_connect"

     

       42
       42
       +
           "userpass"

     

       43
       43
       +
           "token"

     

       44
       44
       +
           "google_workspace"

     

       45
       45
       +
           "microsoft_entra"

     

       46
       46
       +
           "okta"

     

       47
       47
       +
           "jumpcloud"

     

       48
       48
       +
         ];

     

       49
       49
       +
       

     

       50
       50
       +
         typePortRange =

     

       51
       51
       +
           types.coercedTo types.port

     

       52
       52
       +
             (x: {

     

       53
       53
       +
               from = x;

     

       54
       54
       +
               to = x;

     

       55
       55
       +
             })

     

       56
       56
       +
             (

     

       57
       57
       +
               types.submodule {

     

       58
       58
       +
                 options = {

     

       59
       59
       +
                   from = mkOption {

     

       60
       60
       +
                     type = types.port;

     

       61
       61
       +
                     description = "The start of the port range, inclusive.";

     

       62
       62
       +
                   };

     

       63
       63
       +
       

     

       64
       64
       +
                   to = mkOption {

     

       65
       65
       +
                     type = types.port;

     

       66
       66
       +
                     description = "The end of the port range, inclusive.";

     

       67
       67
       +
                   };

     

       68
       68
       +
                 };

     

       69
       69
       +
               }

     

       70
       70
       +
             );

     

       71
       71
       +
       

     

       72
       72
       +
         # All non-secret environment variables or the given component

     

       73
       73
       +
         collectEnvironment =

     

       74
       74
       +
           component:

     

       75
       75
       +
           mapAttrs (_: v: if isBool v then boolToString v else toString v) (

     

       76
       76
       +
             cfg.settings // cfg.${component}.settings

     

       77
       77
       +
           );

     

       78
       78
       +
       

     

       79
       79
       +
         # All mandatory secrets which were not explicitly provided by the user will

     

       80
       80
       +
         # have to be generated, if they do not yet exist.

     

       81
       81
       +
         generateSecrets =

     

       82
       82
       +
           let

     

       83
       83
       +
             requiredSecrets = filterAttrs (_: v: v == null) cfg.settingsSecret;

     

       84
       84
       +
           in

     

       85
       85
       +
           ''

     

       86
       86
       +
             mkdir -p secrets

     

       87
       87
       +
             chmod 700 secrets

     

       88
       88
       +
           ''

     

       89
       89
       +
           + concatLines (

     

       90
       90
       +
             forEach (attrNames requiredSecrets) (secret: ''

     

       91
       91
       +
               if [[ ! -e secrets/${secret} ]]; then

     

       92
       92
       +
                 echo "Generating ${secret}"

     

       93
       93
       +
                 # Some secrets like TOKENS_KEY_BASE require a value >=64 bytes.

     

       94
       94
       +
                 head -c 64 /dev/urandom | base64 -w 0 > secrets/${secret}

     

       95
       95
       +
                 chmod 600 secrets/${secret}

     

       96
       96
       +
               fi

     

       97
       97
       +
             '')

     

       98
       98
       +
           );

     

       99
       99
       +
       

     

       100
       100
       +
         # All secrets given in `cfg.settingsSecret` must be loaded from a file and

     

       101
       101
       +
         # exported into the environment. Also exclude any variables that were

     

       102
       102
       +
         # overwritten by the local component settings.

     

       103
       103
       +
         loadSecretEnvironment =

     

       104
       104
       +
           component:

     

       105
       105
       +
           let

     

       106
       106
       +
             relevantSecrets = subtractLists (attrNames cfg.${component}.settings) (

     

       107
       107
       +
               attrNames cfg.settingsSecret

     

       108
       108
       +
             );

     

       109
       109
       +
           in

     

       110
       110
       +
           concatLines (

     

       111
       111
       +
             forEach relevantSecrets (

     

       112
       112
       +
               secret:

     

       113
       113
       +
               ''export ${secret}=$(< ${

     

       114
       114
       +
                 if cfg.settingsSecret.${secret} == null then

     

       115
       115
       +
                   "secrets/${secret}"

     

       116
       116
       +
                 else

     

       117
       117
       +
                   "\"$CREDENTIALS_DIRECTORY/${secret}\""

     

       118
       118
       +
               })''

     

       119
       119
       +
             )

     

       120
       120
       +
           );

     

       121
       121
       +
       

     

       122
       122
       +
         provisionStateJson =

     

       123
       123
       +
           let

     

       124
       124
       +
             # Convert clientSecretFile options into the real counterpart

     

       125
       125
       +
             augmentedAccounts = flip mapAttrs cfg.provision.accounts (

     

       126
       126
       +
               accountName: account:

     

       127
       127
       +
               account

     

       128
       128
       +
               // {

     

       129
       129
       +
                 auth = flip mapAttrs account.auth (

     

       130
       130
       +
                   authName: auth:

     

       131
       131
       +
                   recursiveUpdate auth (

     

       132
       132
       +
                     optionalAttrs (auth.adapter_config.clientSecretFile != null) {

     

       133
       133
       +
                       adapter_config.client_secret = "{env:AUTH_CLIENT_SECRET_${toUpper accountName}_${toUpper authName}}";

     

       134
       134
       +
                     }

     

       135
       135
       +
                   )

     

       136
       136
       +
                 );

     

       137
       137
       +
               }

     

       138
       138
       +
             );

     

       139
       139
       +
           in

     

       140
       140
       +
           jsonFormat.generate "provision-state.json" {

     

       141
       141
       +
             # Do not include any clientSecretFile attributes in the resulting json

     

       142
       142
       +
             accounts = filterAttrsRecursive (k: _: k != "clientSecretFile") augmentedAccounts;

     

       143
       143
       +
           };

     

       144
       144
       +
       

     

       145
       145
       +
         commonServiceConfig = {

     

       146
       146
       +
           AmbientCapablities = [ ];

     

       147
       147
       +
           CapabilityBoundingSet = [ ];

     

       148
       148
       +
           LockPersonality = true;

     

       149
       149
       +
           MemoryDenyWriteExecute = true;

     

       150
       150
       +
           NoNewPrivileges = true;

     

       151
       151
       +
           PrivateMounts = true;

     

       152
       152
       +
           PrivateTmp = true;

     

       153
       153
       +
           PrivateUsers = false;

     

       154
       154
       +
           ProcSubset = "pid";

     

       155
       155
       +
           ProtectClock = true;

     

       156
       156
       +
           ProtectControlGroups = true;

     

       157
       157
       +
           ProtectHome = true;

     

       158
       158
       +
           ProtectHostname = true;

     

       159
       159
       +
           ProtectKernelLogs = true;

     

       160
       160
       +
           ProtectKernelModules = true;

     

       161
       161
       +
           ProtectKernelTunables = true;

     

       162
       162
       +
           ProtectProc = "invisible";

     

       163
       163
       +
           ProtectSystem = "strict";

     

       164
       164
       +
           RestrictAddressFamilies = [

     

       165
       165
       +
             "AF_INET"

     

       166
       166
       +
             "AF_INET6"

     

       167
       167
       +
             "AF_NETLINK"

     

       168
       168
       +
             "AF_UNIX"

     

       169
       169
       +
           ];

     

       170
       170
       +
           RestrictNamespaces = true;

     

       171
       171
       +
           RestrictRealtime = true;

     

       172
       172
       +
           RestrictSUIDSGID = true;

     

       173
       173
       +
           SystemCallArchitectures = "native";

     

       174
       174
       +
           SystemCallFilter = "@system-service";

     

       175
       175
       +
           UMask = "077";

     

       176
       176
       +
       

     

       177
       177
       +
           DynamicUser = true;

     

       178
       178
       +
           User = "firezone";

     

       179
       179
       +
       

     

       180
       180
       +
           Slice = "system-firezone.slice";

     

       181
       181
       +
           StateDirectory = "firezone";

     

       182
       182
       +
           WorkingDirectory = "/var/lib/firezone";

     

       183
       183
       +
       

     

       184
       184
       +
           LoadCredential = mapAttrsToList (secretName: secretFile: "${secretName}:${secretFile}") (

     

       185
       185
       +
             filterAttrs (_: v: v != null) cfg.settingsSecret

     

       186
       186
       +
           );

     

       187
       187
       +
           Type = "exec";

     

       188
       188
       +
           Restart = "on-failure";

     

       189
       189
       +
           RestartSec = 10;

     

       190
       190
       +
         };

     

       191
       191
       +
       

     

       192
       192
       +
         componentOptions = component: {

     

       193
       193
       +
           enable = mkEnableOption "the Firezone ${component} server";

     

       194
       194
       +
           package = mkPackageOption pkgs "firezone-server-${component}" { };

     

       195
       195
       +
       

     

       196
       196
       +
           settings = mkOption {

     

       197
       197
       +
             description = ''

     

       198
       198
       +
               Environment variables for this component of the Firezone server. For a

     

       199
       199
       +
               list of available variables, please refer to the [upstream definitions](https://github.com/firezone/firezone/blob/main/elixir/apps/domain/lib/domain/config/definitions.ex).

     

       200
       200
       +
               Some variables like `OUTBOUND_EMAIL_ADAPTER_OPTS` require json values

     

       201
       201
       +
               for which you can use `VAR = builtins.toJSON { /* ... */ }`.

     

       202
       202
       +
       

     

       203
       203
       +
               This component will automatically inherit all variables defined via

     

       204
       204
       +
               {option}`services.firezone.server.settings` and

     

       205
       205
       +
               {option}`services.firezone.server.settingsSecret`, but which can be

     

       206
       206
       +
               overwritten by this option.

     

       207
       207
       +
             '';

     

       208
       208
       +
             default = { };

     

       209
       209
       +
             type = types.submodule {

     

       210
       210
       +
               freeformType = types.attrsOf (

     

       211
       211
       +
                 types.oneOf [

     

       212
       212
       +
                   types.bool

     

       213
       213
       +
                   types.float

     

       214
       214
       +
                   types.int

     

       215
       215
       +
                   types.str

     

       216
       216
       +
                   types.path

     

       217
       217
       +
                   types.package

     

       218
       218
       +
                 ]

     

       219
       219
       +
               );

     

       220
       220
       +
             };

     

       221
       221
       +
           };

     

       222
       222
       +
         };

     

       223
       223
       +
       in

     

       224
       224
       +
       {

     

       225
       225
       +
         options.services.firezone.server = {

     

       226
       226
       +
           enable = mkEnableOption "all Firezone components";

     

       227
       227
       +
           enableLocalDB = mkEnableOption "a local postgresql database for Firezone";

     

       228
       228
       +
           nginx.enable = mkEnableOption "nginx virtualhost definition";

     

       229
       229
       +
       

     

       230
       230
       +
           openClusterFirewall = mkOption {

     

       231
       231
       +
             type = types.bool;

     

       232
       232
       +
             default = false;

     

       233
       233
       +
             description = ''

     

       234
       234
       +
               Opens up the erlang distribution port of all enabled components to

     

       235
       235
       +
               allow reaching the server cluster from the internet. You only need to

     

       236
       236
       +
               set this if you are actually distributing your cluster across multiple

     

       237
       237
       +
               machines.

     

       238
       238
       +
             '';

     

       239
       239
       +
           };

     

       240
       240
       +
       

     

       241
       241
       +
           clusterHosts = mkOption {

     

       242
       242
       +
             type = types.listOf types.str;

     

       243
       243
       +
             default = [

     

       244
       244
       +
               "api@localhost.localdomain"

     

       245
       245
       +
               "web@localhost.localdomain"

     

       246
       246
       +
               "domain@localhost.localdomain"

     

       247
       247
       +
             ];

     

       248
       248
       +
             description = ''

     

       249
       249
       +
               A list of components and their hosts that are part of this cluster. For

     

       250
       250
       +
               a single-machine setup, the default value will be sufficient. This

     

       251
       251
       +
               value will automatically set `ERLANG_CLUSTER_ADAPTER_CONFIG`.

     

       252
       252
       +
       

     

       253
       253
       +
               The format is `<COMPONENT_NAME>@<HOSTNAME>`.

     

       254
       254
       +
             '';

     

       255
       255
       +
           };

     

       256
       256
       +
       

     

       257
       257
       +
           settingsSecret = mkOption {

     

       258
       258
       +
             default = { };

     

       259
       259
       +
             description = ''

     

       260
       260
       +
               This is a convenience option which allows you to set secret values for

     

       261
       261
       +
               environment variables by specifying a file which will contain the value

     

       262
       262
       +
               at runtime. Before starting the server, the content of each file will

     

       263
       263
       +
               be loaded into the respective environment variable.

     

       264
       264
       +
       

     

       265
       265
       +
               Otherwise, this option is equivalent to

     

       266
       266
       +
               {option}`services.firezone.server.settings`. Refer to the settings

     

       267
       267
       +
               option for more information regarding the actual variables and how

     

       268
       268
       +
               filtering rules are applied for each component.

     

       269
       269
       +
             '';

     

       270
       270
       +
             type = types.submodule {

     

       271
       271
       +
               freeformType = types.attrsOf types.path;

     

       272
       272
       +
               options = {

     

       273
       273
       +
                 RELEASE_COOKIE = mkOption {

     

       274
       274
       +
                   type = types.nullOr types.path;

     

       275
       275
       +
                   default = null;

     

       276
       276
       +
                   description = ''

     

       277
       277
       +
                     A file containing a unique secret identifier for the Erlang

     

       278
       278
       +
                     cluster. All Firezone components in your cluster must use the

     

       279
       279
       +
                     same value.

     

       280
       280
       +
       

     

       281
       281
       +
                     If this is `null`, a shared value will automatically be generated

     

       282
       282
       +
                     on startup and used for all components on this machine. You do

     

       283
       283
       +
                     not need to set this except when you spread your cluster over

     

       284
       284
       +
                     multiple hosts.

     

       285
       285
       +
                   '';

     

       286
       286
       +
                 };

     

       287
       287
       +
       

     

       288
       288
       +
                 TOKENS_KEY_BASE = mkOption {

     

       289
       289
       +
                   type = types.nullOr types.path;

     

       290
       290
       +
                   default = null;

     

       291
       291
       +
                   description = ''

     

       292
       292
       +
                     A file containing a unique base64 encoded secret for the

     

       293
       293
       +
                     `TOKENS_KEY_BASE`. All Firezone components in your cluster must

     

       294
       294
       +
                     use the same value.

     

       295
       295
       +
       

     

       296
       296
       +
                     If this is `null`, a shared value will automatically be generated

     

       297
       297
       +
                     on startup and used for all components on this machine. You do

     

       298
       298
       +
                     not need to set this except when you spread your cluster over

     

       299
       299
       +
                     multiple hosts.

     

       300
       300
       +
                   '';

     

       301
       301
       +
                 };

     

       302
       302
       +
       

     

       303
       303
       +
                 SECRET_KEY_BASE = mkOption {

     

       304
       304
       +
                   type = types.nullOr types.path;

     

       305
       305
       +
                   default = null;

     

       306
       306
       +
                   description = ''

     

       307
       307
       +
                     A file containing a unique base64 encoded secret for the

     

       308
       308
       +
                     `SECRET_KEY_BASE`. All Firezone components in your cluster must

     

       309
       309
       +
                     use the same value.

     

       310
       310
       +
       

     

       311
       311
       +
                     If this is `null`, a shared value will automatically be generated

     

       312
       312
       +
                     on startup and used for all components on this machine. You do

     

       313
       313
       +
                     not need to set this except when you spread your cluster over

     

       314
       314
       +
                     multiple hosts.

     

       315
       315
       +
                   '';

     

       316
       316
       +
                 };

     

       317
       317
       +
       

     

       318
       318
       +
                 TOKENS_SALT = mkOption {

     

       319
       319
       +
                   type = types.nullOr types.path;

     

       320
       320
       +
                   default = null;

     

       321
       321
       +
                   description = ''

     

       322
       322
       +
                     A file containing a unique base64 encoded secret for the

     

       323
       323
       +
                     `TOKENS_SALT`. All Firezone components in your cluster must

     

       324
       324
       +
                     use the same value.

     

       325
       325
       +
       

     

       326
       326
       +
                     If this is `null`, a shared value will automatically be generated

     

       327
       327
       +
                     on startup and used for all components on this machine. You do

     

       328
       328
       +
                     not need to set this except when you spread your cluster over

     

       329
       329
       +
                     multiple hosts.

     

       330
       330
       +
                   '';

     

       331
       331
       +
                 };

     

       332
       332
       +
       

     

       333
       333
       +
                 LIVE_VIEW_SIGNING_SALT = mkOption {

     

       334
       334
       +
                   type = types.nullOr types.path;

     

       335
       335
       +
                   default = null;

     

       336
       336
       +
                   description = ''

     

       337
       337
       +
                     A file containing a unique base64 encoded secret for the

     

       338
       338
       +
                     `LIVE_VIEW_SIGNING_SALT`. All Firezone components in your cluster must

     

       339
       339
       +
                     use the same value.

     

       340
       340
       +
       

     

       341
       341
       +
                     If this is `null`, a shared value will automatically be generated

     

       342
       342
       +
                     on startup and used for all components on this machine. You do

     

       343
       343
       +
                     not need to set this except when you spread your cluster over

     

       344
       344
       +
                     multiple hosts.

     

       345
       345
       +
                   '';

     

       346
       346
       +
                 };

     

       347
       347
       +
       

     

       348
       348
       +
                 COOKIE_SIGNING_SALT = mkOption {

     

       349
       349
       +
                   type = types.nullOr types.path;

     

       350
       350
       +
                   default = null;

     

       351
       351
       +
                   description = ''

     

       352
       352
       +
                     A file containing a unique base64 encoded secret for the

     

       353
       353
       +
                     `COOKIE_SIGNING_SALT`. All Firezone components in your cluster must

     

       354
       354
       +
                     use the same value.

     

       355
       355
       +
       

     

       356
       356
       +
                     If this is `null`, a shared value will automatically be generated

     

       357
       357
       +
                     on startup and used for all components on this machine. You do

     

       358
       358
       +
                     not need to set this except when you spread your cluster over

     

       359
       359
       +
                     multiple hosts.

     

       360
       360
       +
                   '';

     

       361
       361
       +
                 };

     

       362
       362
       +
       

     

       363
       363
       +
                 COOKIE_ENCRYPTION_SALT = mkOption {

     

       364
       364
       +
                   type = types.nullOr types.path;

     

       365
       365
       +
                   default = null;

     

       366
       366
       +
                   description = ''

     

       367
       367
       +
                     A file containing a unique base64 encoded secret for the

     

       368
       368
       +
                     `COOKIE_ENCRYPTION_SALT`. All Firezone components in your cluster must

     

       369
       369
       +
                     use the same value.

     

       370
       370
       +
       

     

       371
       371
       +
                     If this is `null`, a shared value will automatically be generated

     

       372
       372
       +
                     on startup and used for all components on this machine. You do

     

       373
       373
       +
                     not need to set this except when you spread your cluster over

     

       374
       374
       +
                     multiple hosts.

     

       375
       375
       +
                   '';

     

       376
       376
       +
                 };

     

       377
       377
       +
               };

     

       378
       378
       +
             };

     

       379
       379
       +
           };

     

       380
       380
       +
       

     

       381
       381
       +
           settings = mkOption {

     

       382
       382
       +
             description = ''

     

       383
       383
       +
               Environment variables for the Firezone server. For a list of available

     

       384
       384
       +
               variables, please refer to the [upstream definitions](https://github.com/firezone/firezone/blob/main/elixir/apps/domain/lib/domain/config/definitions.ex).

     

       385
       385
       +
               Some variables like `OUTBOUND_EMAIL_ADAPTER_OPTS` require json values

     

       386
       386
       +
               for which you can use `VAR = builtins.toJSON { /* ... */ }`.

     

       387
       387
       +
       

     

       388
       388
       +
               Each component has an additional `settings` option which allows you to

     

       389
       389
       +
               override specific variables passed to that component.

     

       390
       390
       +
             '';

     

       391
       391
       +
             default = { };

     

       392
       392
       +
             type = types.submodule {

     

       393
       393
       +
               freeformType = types.attrsOf (

     

       394
       394
       +
                 types.oneOf [

     

       395
       395
       +
                   types.bool

     

       396
       396
       +
                   types.float

     

       397
       397
       +
                   types.int

     

       398
       398
       +
                   types.str

     

       399
       399
       +
                   types.path

     

       400
       400
       +
                   types.package

     

       401
       401
       +
                 ]

     

       402
       402
       +
               );

     

       403
       403
       +
             };

     

       404
       404
       +
           };

     

       405
       405
       +
       

     

       406
       406
       +
           smtp = {

     

       407
       407
       +
             configureManually = mkOption {

     

       408
       408
       +
               type = types.bool;

     

       409
       409
       +
               default = false;

     

       410
       410
       +
               description = ''

     

       411
       411
       +
                 Outbound email configuration is mandatory for Firezone and supports

     

       412
       412
       +
                 many different delivery adapters. Yet, most users will only need an

     

       413
       413
       +
                 SMTP relay to send emails, so this configuration enforced by default.

     

       414
       414
       +
       

     

       415
       415
       +
                 If you want to utilize an alternative way to send emails (e.g. via a

     

       416
       416
       +
                 supportd API-based service), enable this option and define

     

       417
       417
       +
                 `OUTBOUND_EMAIL_FROM`, `OUTBOUND_EMAIL_ADAPTER` and

     

       418
       418
       +
                 `OUTBOUND_EMAIL_ADAPTER_OPTS` manually via

     

       419
       419
       +
                 {option}`services.firezone.server.settings` and/or

     

       420
       420
       +
                 {option}`services.firezone.server.settingsSecret`.

     

       421
       421
       +
       

     

       422
       422
       +
                 The Firezone documentation holds [a list of supported Swoosh adapters](https://github.com/firezone/firezone/blob/main/website/src/app/docs/reference/env-vars/readme.mdx#outbound-emails).

     

       423
       423
       +
               '';

     

       424
       424
       +
             };

     

       425
       425
       +
       

     

       426
       426
       +
             from = mkOption {

     

       427
       427
       +
               type = types.str;

     

       428
       428
       +
               example = "firezone@example.com";

     

       429
       429
       +
               description = "Outbound SMTP FROM address";

     

       430
       430
       +
             };

     

       431
       431
       +
       

     

       432
       432
       +
             host = mkOption {

     

       433
       433
       +
               type = types.str;

     

       434
       434
       +
               example = "mail.example.com";

     

       435
       435
       +
               description = "Outbound SMTP host";

     

       436
       436
       +
             };

     

       437
       437
       +
       

     

       438
       438
       +
             port = mkOption {

     

       439
       439
       +
               type = types.port;

     

       440
       440
       +
               example = 465;

     

       441
       441
       +
               description = "Outbound SMTP port";

     

       442
       442
       +
             };

     

       443
       443
       +
       

     

       444
       444
       +
             implicitTls = mkOption {

     

       445
       445
       +
               type = types.bool;

     

       446
       446
       +
               default = false;

     

       447
       447
       +
               description = "Whether to use implicit TLS instead of STARTTLS (usually port 465)";

     

       448
       448
       +
             };

     

       449
       449
       +
       

     

       450
       450
       +
             username = mkOption {

     

       451
       451
       +
               type = types.str;

     

       452
       452
       +
               example = "firezone@example.com";

     

       453
       453
       +
               description = "Username to authenticate against the SMTP relay";

     

       454
       454
       +
             };

     

       455
       455
       +
       

     

       456
       456
       +
             passwordFile = mkOption {

     

       457
       457
       +
               type = types.path;

     

       458
       458
       +
               example = "/run/secrets/smtp-password";

     

       459
       459
       +
               description = "File containing the password for the given username. Beware that a file in the nix store will be world readable.";

     

       460
       460
       +
             };

     

       461
       461
       +
           };

     

       462
       462
       +
       

     

       463
       463
       +
           domain = componentOptions "domain";

     

       464
       464
       +
       

     

       465
       465
       +
           web = componentOptions "web" // {

     

       466
       466
       +
             externalUrl = mkOption {

     

       467
       467
       +
               type = types.strMatching "^https://.+/$";

     

       468
       468
       +
               example = "https://firezone.example.com/";

     

       469
       469
       +
               description = ''

     

       470
       470
       +
                 The external URL under which you will serve the web interface. You

     

       471
       471
       +
                 need to setup a reverse proxy for TLS termination, either with

     

       472
       472
       +
                 {option}`services.firezone.server.nginx.enable` or manually.

     

       473
       473
       +
               '';

     

       474
       474
       +
             };

     

       475
       475
       +
       

     

       476
       476
       +
             address = mkOption {

     

       477
       477
       +
               type = types.str;

     

       478
       478
       +
               default = "127.0.0.1";

     

       479
       479
       +
               description = "The address to listen on";

     

       480
       480
       +
             };

     

       481
       481
       +
       

     

       482
       482
       +
             port = mkOption {

     

       483
       483
       +
               type = types.port;

     

       484
       484
       +
               default = 8080;

     

       485
       485
       +
               description = "The port under which the web interface will be served locally";

     

       486
       486
       +
             };

     

       487
       487
       +
       

     

       488
       488
       +
             trustedProxies = mkOption {

     

       489
       489
       +
               type = types.listOf types.str;

     

       490
       490
       +
               default = [ ];

     

       491
       491
       +
               description = "A list of trusted proxies";

     

       492
       492
       +
             };

     

       493
       493
       +
           };

     

       494
       494
       +
       

     

       495
       495
       +
           api = componentOptions "api" // {

     

       496
       496
       +
             externalUrl = mkOption {

     

       497
       497
       +
               type = types.strMatching "^https://.+/$";

     

       498
       498
       +
               example = "https://firezone.example.com/api/";

     

       499
       499
       +
               description = ''

     

       500
       500
       +
                 The external URL under which you will serve the api. You need to

     

       501
       501
       +
                 setup a reverse proxy for TLS termination, either with

     

       502
       502
       +
                 {option}`services.firezone.server.nginx.enable` or manually.

     

       503
       503
       +
               '';

     

       504
       504
       +
             };

     

       505
       505
       +
       

     

       506
       506
       +
             address = mkOption {

     

       507
       507
       +
               type = types.str;

     

       508
       508
       +
               default = "127.0.0.1";

     

       509
       509
       +
               description = "The address to listen on";

     

       510
       510
       +
             };

     

       511
       511
       +
       

     

       512
       512
       +
             port = mkOption {

     

       513
       513
       +
               type = types.port;

     

       514
       514
       +
               default = 8081;

     

       515
       515
       +
               description = "The port under which the api will be served locally";

     

       516
       516
       +
             };

     

       517
       517
       +
       

     

       518
       518
       +
             trustedProxies = mkOption {

     

       519
       519
       +
               type = types.listOf types.str;

     

       520
       520
       +
               default = [ ];

     

       521
       521
       +
               description = "A list of trusted proxies";

     

       522
       522
       +
             };

     

       523
       523
       +
           };

     

       524
       524
       +
       

     

       525
       525
       +
           provision = {

     

       526
       526
       +
             enable = mkEnableOption "provisioning of the Firezone domain server";

     

       527
       527
       +
             accounts = mkOption {

     

       528
       528
       +
               type = types.attrsOf (

     

       529
       529
       +
                 types.submodule {

     

       530
       530
       +
                   freeformType = jsonFormat.type;

     

       531
       531
       +
                   options = {

     

       532
       532
       +
                     name = mkOption {

     

       533
       533
       +
                       type = types.str;

     

       534
       534
       +
                       description = "The account name";

     

       535
       535
       +
                       example = "My Organization";

     

       536
       536
       +
                     };

     

       537
       537
       +
       

     

       538
       538
       +
                     features =

     

       539
       539
       +
                       let

     

       540
       540
       +
                         mkFeatureOption =

     

       541
       541
       +
                           name: default:

     

       542
       542
       +
                           mkOption {

     

       543
       543
       +
                             type = types.bool;

     

       544
       544
       +
                             inherit default;

     

       545
       545
       +
                             description = "Whether to enable the `${name}` feature for this account.";

     

       546
       546
       +
                           };

     

       547
       547
       +
                       in

     

       548
       548
       +
                       {

     

       549
       549
       +
                         flow_activities = mkFeatureOption "flow_activities" true;

     

       550
       550
       +
                         policy_conditions = mkFeatureOption "policy_conditions" true;

     

       551
       551
       +
                         multi_site_resources = mkFeatureOption "multi_site_resources" true;

     

       552
       552
       +
                         traffic_filters = mkFeatureOption "traffic_filters" true;

     

       553
       553
       +
                         self_hosted_relays = mkFeatureOption "self_hosted_relays" true;

     

       554
       554
       +
                         idp_sync = mkFeatureOption "idp_sync" true;

     

       555
       555
       +
                         rest_api = mkFeatureOption "rest_api" true;

     

       556
       556
       +
                         internet_resource = mkFeatureOption "internet_resource" true;

     

       557
       557
       +
                       };

     

       558
       558
       +
       

     

       559
       559
       +
                     actors = mkOption {

     

       560
       560
       +
                       type = types.attrsOf (

     

       561
       561
       +
                         types.submodule {

     

       562
       562
       +
                           options = {

     

       563
       563
       +
                             type = mkOption {

     

       564
       564
       +
                               type = types.enum [

     

       565
       565
       +
                                 "account_admin_user"

     

       566
       566
       +
                                 "account_user"

     

       567
       567
       +
                                 "service_account"

     

       568
       568
       +
                                 "api_client"

     

       569
       569
       +
                               ];

     

       570
       570
       +
                               description = "The account type";

     

       571
       571
       +
                             };

     

       572
       572
       +
       

     

       573
       573
       +
                             name = mkOption {

     

       574
       574
       +
                               type = types.str;

     

       575
       575
       +
                               description = "The name of this actor";

     

       576
       576
       +
                             };

     

       577
       577
       +
       

     

       578
       578
       +
                             email = mkOption {

     

       579
       579
       +
                               type = types.str;

     

       580
       580
       +
                               description = "The email address used to authenticate as this account";

     

       581
       581
       +
                             };

     

       582
       582
       +
                           };

     

       583
       583
       +
                         }

     

       584
       584
       +
                       );

     

       585
       585
       +
                       default = { };

     

       586
       586
       +
                       example = {

     

       587
       587
       +
                         admin = {

     

       588
       588
       +
                           type = "account_admin_user";

     

       589
       589
       +
                           name = "Admin";

     

       590
       590
       +
                           email = "admin@myorg.example.com";

     

       591
       591
       +
                         };

     

       592
       592
       +
                       };

     

       593
       593
       +
                       description = ''

     

       594
       594
       +
                         All actors (users) to provision. The attribute name will only

     

       595
       595
       +
                         be used to track the actor and does not have any significance

     

       596
       596
       +
                         for Firezone.

     

       597
       597
       +
                       '';

     

       598
       598
       +
                     };

     

       599
       599
       +
       

     

       600
       600
       +
                     auth = mkOption {

     

       601
       601
       +
                       type = types.attrsOf (

     

       602
       602
       +
                         types.submodule {

     

       603
       603
       +
                           freeformType = jsonFormat.type;

     

       604
       604
       +
                           options = {

     

       605
       605
       +
                             name = mkOption {

     

       606
       606
       +
                               type = types.str;

     

       607
       607
       +
                               description = "The name of this authentication provider";

     

       608
       608
       +
                             };

     

       609
       609
       +
       

     

       610
       610
       +
                             adapter = mkOption {

     

       611
       611
       +
                               type = types.enum availableAuthAdapters;

     

       612
       612
       +
                               description = "The auth adapter type";

     

       613
       613
       +
                             };

     

       614
       614
       +
       

     

       615
       615
       +
                             adapter_config.clientSecretFile = mkOption {

     

       616
       616
       +
                               type = types.nullOr types.path;

     

       617
       617
       +
                               default = null;

     

       618
       618
       +
                               description = ''

     

       619
       619
       +
                                 A file containing a the client secret for an openid_connect adapter.

     

       620
       620
       +
                                 You only need to set this if this is an openid_connect provider.

     

       621
       621
       +
                               '';

     

       622
       622
       +
                             };

     

       623
       623
       +
                           };

     

       624
       624
       +
                         }

     

       625
       625
       +
                       );

     

       626
       626
       +
                       default = { };

     

       627
       627
       +
                       example = {

     

       628
       628
       +
                         myoidcprovider = {

     

       629
       629
       +
                           adapter = "openid_connect";

     

       630
       630
       +
                           adapter_config = {

     

       631
       631
       +
                             client_id = "clientid";

     

       632
       632
       +
                             clientSecretFile = "/run/secrets/oidc-client-secret";

     

       633
       633
       +
                             response_type = "code";

     

       634
       634
       +
                             scope = "openid email name";

     

       635
       635
       +
                             discovery_document_uri = "https://auth.example.com/.well-known/openid-configuration";

     

       636
       636
       +
                           };

     

       637
       637
       +
                         };

     

       638
       638
       +
                       };

     

       639
       639
       +
                       description = ''

     

       640
       640
       +
                         All authentication providers to provision. The attribute name

     

       641
       641
       +
                         will only be used to track the provider and does not have any

     

       642
       642
       +
                         significance for Firezone.

     

       643
       643
       +
                       '';

     

       644
       644
       +
                     };

     

       645
       645
       +
       

     

       646
       646
       +
                     resources = mkOption {

     

       647
       647
       +
                       type = types.attrsOf (

     

       648
       648
       +
                         types.submodule {

     

       649
       649
       +
                           options = {

     

       650
       650
       +
                             type = mkOption {

     

       651
       651
       +
                               type = types.enum [

     

       652
       652
       +
                                 "dns"

     

       653
       653
       +
                                 "cidr"

     

       654
       654
       +
                                 "ip"

     

       655
       655
       +
                               ];

     

       656
       656
       +
                               description = "The resource type";

     

       657
       657
       +
                             };

     

       658
       658
       +
       

     

       659
       659
       +
                             name = mkOption {

     

       660
       660
       +
                               type = types.str;

     

       661
       661
       +
                               description = "The name of this resource";

     

       662
       662
       +
                             };

     

       663
       663
       +
       

     

       664
       664
       +
                             address = mkOption {

     

       665
       665
       +
                               type = types.str;

     

       666
       666
       +
                               description = "The address of this resource. Depending on the resource type, this should be an ip, ip with cidr mask or a domain.";

     

       667
       667
       +
                             };

     

       668
       668
       +
       

     

       669
       669
       +
                             addressDescription = mkOption {

     

       670
       670
       +
                               type = types.nullOr types.str;

     

       671
       671
       +
                               default = null;

     

       672
       672
       +
                               description = "An optional description for resource address, usually a full link to the resource including a schema.";

     

       673
       673
       +
                             };

     

       674
       674
       +
       

     

       675
       675
       +
                             gatewayGroups = mkOption {

     

       676
       676
       +
                               type = types.nonEmptyListOf types.str;

     

       677
       677
       +
                               description = "A list of gateway groups (sites) which can reach the resource and may be used to connect to it.";

     

       678
       678
       +
                             };

     

       679
       679
       +
       

     

       680
       680
       +
                             filters = mkOption {

     

       681
       681
       +
                               type = types.listOf (

     

       682
       682
       +
                                 types.submodule {

     

       683
       683
       +
                                   options = {

     

       684
       684
       +
                                     protocol = mkOption {

     

       685
       685
       +
                                       type = types.enum [

     

       686
       686
       +
                                         "icmp"

     

       687
       687
       +
                                         "tcp"

     

       688
       688
       +
                                         "udp"

     

       689
       689
       +
                                       ];

     

       690
       690
       +
                                       description = "The protocol to allow";

     

       691
       691
       +
                                     };

     

       692
       692
       +
       

     

       693
       693
       +
                                     ports = mkOption {

     

       694
       694
       +
                                       type = types.listOf typePortRange;

     

       695
       695
       +
                                       example = [

     

       696
       696
       +
                                         443

     

       697
       697
       +
                                         {

     

       698
       698
       +
                                           from = 8080;

     

       699
       699
       +
                                           to = 8100;

     

       700
       700
       +
                                         }

     

       701
       701
       +
                                       ];

     

       702
       702
       +
                                       default = [ ];

     

       703
       703
       +
                                       apply =

     

       704
       704
       +
                                         xs: map (x: if x.from == x.to then toString x.from else "${toString x.from} - ${toString x.to}") xs;

     

       705
       705
       +
                                       description = "Either a single port or port range to allow. Both bounds are inclusive.";

     

       706
       706
       +
                                     };

     

       707
       707
       +
                                   };

     

       708
       708
       +
                                 }

     

       709
       709
       +
                               );

     

       710
       710
       +
                               default = [ ];

     

       711
       711
       +
                               description = "A list of filter to restrict traffic. If no filters are given, all traffic is allowed.";

     

       712
       712
       +
                             };

     

       713
       713
       +
                           };

     

       714
       714
       +
                         }

     

       715
       715
       +
                       );

     

       716
       716
       +
                       default = { };

     

       717
       717
       +
                       example = {

     

       718
       718
       +
                         vaultwarden = {

     

       719
       719
       +
                           type = "dns";

     

       720
       720
       +
                           name = "Vaultwarden";

     

       721
       721
       +
                           address = "vault.example.com";

     

       722
       722
       +
                           address_description = "https://vault.example.com";

     

       723
       723
       +
                           gatewayGroups = [ "my-site" ];

     

       724
       724
       +
                           filters = [

     

       725
       725
       +
                             { protocol = "icmp"; }

     

       726
       726
       +
                             {

     

       727
       727
       +
                               protocol = "tcp";

     

       728
       728
       +
                               ports = [

     

       729
       729
       +
                                 80

     

       730
       730
       +
                                 443

     

       731
       731
       +
                               ];

     

       732
       732
       +
                             }

     

       733
       733
       +
                           ];

     

       734
       734
       +
                         };

     

       735
       735
       +
                       };

     

       736
       736
       +
                       description = ''

     

       737
       737
       +
                         All resources to provision. The attribute name will only be used to

     

       738
       738
       +
                         track the resource and does not have any significance for Firezone.

     

       739
       739
       +
                       '';

     

       740
       740
       +
                     };

     

       741
       741
       +
       

     

       742
       742
       +
                     policies = mkOption {

     

       743
       743
       +
                       type = types.attrsOf (

     

       744
       744
       +
                         types.submodule {

     

       745
       745
       +
                           options = {

     

       746
       746
       +
                             description = mkOption {

     

       747
       747
       +
                               type = types.nullOr types.str;

     

       748
       748
       +
                               description = "The description of this policy";

     

       749
       749
       +
                             };

     

       750
       750
       +
       

     

       751
       751
       +
                             group = mkOption {

     

       752
       752
       +
                               type = types.str;

     

       753
       753
       +
                               description = "The group which should be allowed access to the given resource.";

     

       754
       754
       +
                             };

     

       755
       755
       +
       

     

       756
       756
       +
                             resource = mkOption {

     

       757
       757
       +
                               type = types.str;

     

       758
       758
       +
                               description = "The resource to which access should be allowed.";

     

       759
       759
       +
                             };

     

       760
       760
       +
                           };

     

       761
       761
       +
                         }

     

       762
       762
       +
                       );

     

       763
       763
       +
                       default = { };

     

       764
       764
       +
                       example = {

     

       765
       765
       +
                         access_vaultwarden = {

     

       766
       766
       +
                           name = "Allow anyone to access vaultwarden";

     

       767
       767
       +
                           group = "everyone";

     

       768
       768
       +
                           resource = "vaultwarden";

     

       769
       769
       +
                         };

     

       770
       770
       +
                       };

     

       771
       771
       +
                       description = ''

     

       772
       772
       +
                         All policies to provision. The attribute name will only be used to

     

       773
       773
       +
                         track the policy and does not have any significance for Firezone.

     

       774
       774
       +
                       '';

     

       775
       775
       +
                     };

     

       776
       776
       +
       

     

       777
       777
       +
                     groups = mkOption {

     

       778
       778
       +
                       type = types.attrsOf (

     

       779
       779
       +
                         types.submodule {

     

       780
       780
       +
                           options = {

     

       781
       781
       +
                             name = mkOption {

     

       782
       782
       +
                               type = types.str;

     

       783
       783
       +
                               description = "The name of this group";

     

       784
       784
       +
                             };

     

       785
       785
       +
       

     

       786
       786
       +
                             members = mkOption {

     

       787
       787
       +
                               type = types.listOf types.str;

     

       788
       788
       +
                               default = [ ];

     

       789
       789
       +
                               description = "The members of this group";

     

       790
       790
       +
                             };

     

       791
       791
       +
       

     

       792
       792
       +
                             forceMembers = mkOption {

     

       793
       793
       +
                               type = types.bool;

     

       794
       794
       +
                               default = false;

     

       795
       795
       +
                               description = "Ensure that only the given members are part of this group at every server start.";

     

       796
       796
       +
                             };

     

       797
       797
       +
                           };

     

       798
       798
       +
                         }

     

       799
       799
       +
                       );

     

       800
       800
       +
                       default = { };

     

       801
       801
       +
                       example = {

     

       802
       802
       +
                         users = {

     

       803
       803
       +
                           name = "Users";

     

       804
       804
       +
                         };

     

       805
       805
       +
                       };

     

       806
       806
       +
                       description = ''

     

       807
       807
       +
                         All groups to provision. The attribute name will only be used

     

       808
       808
       +
                         to track the group and does not have any significance for

     

       809
       809
       +
                         Firezone.

     

       810
       810
       +
       

     

       811
       811
       +
                         A group named `everyone` will automatically be managed by Firezone.

     

       812
       812
       +
                       '';

     

       813
       813
       +
                     };

     

       814
       814
       +
       

     

       815
       815
       +
                     relayGroups = mkOption {

     

       816
       816
       +
                       type = types.attrsOf (

     

       817
       817
       +
                         types.submodule {

     

       818
       818
       +
                           options = {

     

       819
       819
       +
                             name = mkOption {

     

       820
       820
       +
                               type = types.str;

     

       821
       821
       +
                               description = "The name of this relay group";

     

       822
       822
       +
                             };

     

       823
       823
       +
                           };

     

       824
       824
       +
                         }

     

       825
       825
       +
                       );

     

       826
       826
       +
                       default = { };

     

       827
       827
       +
                       example = {

     

       828
       828
       +
                         my-relays = {

     

       829
       829
       +
                           name = "My Relays";

     

       830
       830
       +
                         };

     

       831
       831
       +
                       };

     

       832
       832
       +
                       description = ''

     

       833
       833
       +
                         All relay groups to provision. The attribute name

     

       834
       834
       +
                         will only be used to track the relay group and does not have any

     

       835
       835
       +
                         significance for Firezone.

     

       836
       836
       +
                       '';

     

       837
       837
       +
                     };

     

       838
       838
       +
       

     

       839
       839
       +
                     gatewayGroups = mkOption {

     

       840
       840
       +
                       type = types.attrsOf (

     

       841
       841
       +
                         types.submodule {

     

       842
       842
       +
                           options = {

     

       843
       843
       +
                             name = mkOption {

     

       844
       844
       +
                               type = types.str;

     

       845
       845
       +
                               description = "The name of this gateway group";

     

       846
       846
       +
                             };

     

       847
       847
       +
                           };

     

       848
       848
       +
                         }

     

       849
       849
       +
                       );

     

       850
       850
       +
                       default = { };

     

       851
       851
       +
                       example = {

     

       852
       852
       +
                         my-gateways = {

     

       853
       853
       +
                           name = "My Gateways";

     

       854
       854
       +
                         };

     

       855
       855
       +
                       };

     

       856
       856
       +
                       description = ''

     

       857
       857
       +
                         All gateway groups (sites) to provision. The attribute name

     

       858
       858
       +
                         will only be used to track the gateway group and does not have any

     

       859
       859
       +
                         significance for Firezone.

     

       860
       860
       +
                       '';

     

       861
       861
       +
                     };

     

       862
       862
       +
                   };

     

       863
       863
       +
                 }

     

       864
       864
       +
               );

     

       865
       865
       +
               default = { };

     

       866
       866
       +
               example = {

     

       867
       867
       +
                 main = {

     

       868
       868
       +
                   name = "My Account / Organization";

     

       869
       869
       +
                   metadata.stripe.billing_email = "org@myorg.example.com";

     

       870
       870
       +
                   features.rest_api = false;

     

       871
       871
       +
                 };

     

       872
       872
       +
               };

     

       873
       873
       +
               description = ''

     

       874
       874
       +
                 All accounts to provision. The attribute name specified here will

     

       875
       875
       +
                 become the account slug. By using `"{file:/path/to/file}"` as a

     

       876
       876
       +
                 string value anywhere in these settings, the provisioning script will

     

       877
       877
       +
                 replace that value with the content of the given file at runtime.

     

       878
       878
       +
       

     

       879
       879
       +
                 Please refer to the [Firezone source code](https://github.com/firezone/firezone/blob/main/elixir/apps/domain/lib/domain/accounts/account.ex)

     

       880
       880
       +
                 for all available properties.

     

       881
       881
       +
               '';

     

       882
       882
       +
             };

     

       883
       883
       +
           };

     

       884
       884
       +
         };

     

       885
       885
       +
       

     

       886
       886
       +
         config = mkMerge [

     

       887
       887
       +
           {

     

       888
       888
       +
             assertions =

     

       889
       889
       +
               [

     

       890
       890
       +
                 {

     

       891
       891
       +
                   assertion = cfg.provision.enable -> cfg.domain.enable;

     

       892
       892
       +
                   message = "Provisioning must be done on a machine running the firezone domain server";

     

       893
       893
       +
                 }

     

       894
       894
       +
               ]

     

       895
       895
       +
               ++ concatLists (

     

       896
       896
       +
                 flip mapAttrsToList cfg.provision.accounts (

     

       897
       897
       +
                   accountName: accountCfg:

     

       898
       898
       +
                   [

     

       899
       899
       +
                     {

     

       900
       900
       +
                       assertion = (builtins.match "^[[:lower:]_-]+$" accountName) != null;

     

       901
       901
       +
                       message = "An account name must contain only lowercase characters and underscores, as it will be used as the URL slug for this account.";

     

       902
       902
       +
                     }

     

       903
       903
       +
                   ]

     

       904
       904
       +
                   ++ flip mapAttrsToList accountCfg.auth (

     

       905
       905
       +
                     authName: _: {

     

       906
       906
       +
                       assertion = (builtins.match "^[[:alnum:]_-]+$" authName) != null;

     

       907
       907
       +
                       message = "The authentication provider attribute key must contain only letters, numbers, underscores or dashes.";

     

       908
       908
       +
                     }

     

       909
       909
       +
                   )

     

       910
       910
       +
                 )

     

       911
       911
       +
               );

     

       912
       912
       +
           }

     

       913
       913
       +
           # Enable all components if the main server is enabled

     

       914
       914
       +
           (mkIf cfg.enable {

     

       915
       915
       +
             services.firezone.server.domain.enable = true;

     

       916
       916
       +
             services.firezone.server.web.enable = true;

     

       917
       917
       +
             services.firezone.server.api.enable = true;

     

       918
       918
       +
           })

     

       919
       919
       +
           # Create (and configure) a local database if desired

     

       920
       920
       +
           (mkIf cfg.enableLocalDB {

     

       921
       921
       +
             services.postgresql = {

     

       922
       922
       +
               enable = true;

     

       923
       923
       +
               ensureUsers = [

     

       924
       924
       +
                 {

     

       925
       925
       +
                   name = "firezone";

     

       926
       926
       +
                   ensureDBOwnership = true;

     

       927
       927
       +
                 }

     

       928
       928
       +
               ];

     

       929
       929
       +
               ensureDatabases = [ "firezone" ];

     

       930
       930
       +
             };

     

       931
       931
       +
       

     

       932
       932
       +
             services.firezone.server.settings = {

     

       933
       933
       +
               DATABASE_SOCKET_DIR = "/run/postgresql";

     

       934
       934
       +
               DATABASE_PORT = "5432";

     

       935
       935
       +
               DATABASE_NAME = "firezone";

     

       936
       936
       +
               DATABASE_USER = "firezone";

     

       937
       937
       +
               DATABASE_PASSWORD = "firezone";

     

       938
       938
       +
             };

     

       939
       939
       +
           })

     

       940
       940
       +
           # Create a local nginx reverse proxy

     

       941
       941
       +
           (mkIf cfg.nginx.enable {

     

       942
       942
       +
             services.nginx = mkMerge [

     

       943
       943
       +
               {

     

       944
       944
       +
                 enable = true;

     

       945
       945
       +
               }

     

       946
       946
       +
               (

     

       947
       947
       +
                 let

     

       948
       948
       +
                   urlComponents = builtins.elemAt (builtins.split "https://([^/]*)(/?.*)" cfg.web.externalUrl) 1;

     

       949
       949
       +
                   domain = builtins.elemAt urlComponents 0;

     

       950
       950
       +
                   location = builtins.elemAt urlComponents 1;

     

       951
       951
       +
                 in

     

       952
       952
       +
                 {

     

       953
       953
       +
                   virtualHosts.${domain} = {

     

       954
       954
       +
                     forceSSL = mkDefault true;

     

       955
       955
       +
                     locations.${location} = {

     

       956
       956
       +
                       # The trailing slash is important to strip the location prefix from the request

     

       957
       957
       +
                       proxyPass = "http://${cfg.web.address}:${toString cfg.web.port}/";

     

       958
       958
       +
                       proxyWebsockets = true;

     

       959
       959
       +
                     };

     

       960
       960
       +
                   };

     

       961
       961
       +
                 }

     

       962
       962
       +
               )

     

       963
       963
       +
               (

     

       964
       964
       +
                 let

     

       965
       965
       +
                   urlComponents = builtins.elemAt (builtins.split "https://([^/]*)(/?.*)" cfg.api.externalUrl) 1;

     

       966
       966
       +
                   domain = builtins.elemAt urlComponents 0;

     

       967
       967
       +
                   location = builtins.elemAt urlComponents 1;

     

       968
       968
       +
                 in

     

       969
       969
       +
                 {

     

       970
       970
       +
                   virtualHosts.${domain} = {

     

       971
       971
       +
                     forceSSL = mkDefault true;

     

       972
       972
       +
                     locations.${location} = {

     

       973
       973
       +
                       # The trailing slash is important to strip the location prefix from the request

     

       974
       974
       +
                       proxyPass = "http://${cfg.api.address}:${toString cfg.api.port}/";

     

       975
       975
       +
                       proxyWebsockets = true;

     

       976
       976
       +
                     };

     

       977
       977
       +
                   };

     

       978
       978
       +
                 }

     

       979
       979
       +
               )

     

       980
       980
       +
             ];

     

       981
       981
       +
           })

     

       982
       982
       +
           # Specify sensible defaults

     

       983
       983
       +
           {

     

       984
       984
       +
             services.firezone.server = {

     

       985
       985
       +
               settings = {

     

       986
       986
       +
                 LOG_LEVEL = mkDefault "info";

     

       987
       987
       +
                 RELEASE_HOSTNAME = mkDefault "localhost.localdomain";

     

       988
       988
       +
       

     

       989
       989
       +
                 ERLANG_CLUSTER_ADAPTER = mkDefault "Elixir.Cluster.Strategy.Epmd";

     

       990
       990
       +
                 ERLANG_CLUSTER_ADAPTER_CONFIG = mkDefault (

     

       991
       991
       +
                   builtins.toJSON {

     

       992
       992
       +
                     hosts = cfg.clusterHosts;

     

       993
       993
       +
                   }

     

       994
       994
       +
                 );

     

       995
       995
       +
       

     

       996
       996
       +
                 TZDATA_DIR = mkDefault "/var/lib/firezone/tzdata";

     

       997
       997
       +
                 TELEMETRY_ENABLED = mkDefault false;

     

       998
       998
       +
       

     

       999
       999
       +
                 # By default this will open nproc * 2 connections for each component,

     

       1000
       1000
       +
                 # which can exceeds the (default) maximum of 100 connections for

     

       1001
       1001
       +
                 # postgresql on a 12 core +SMT machine. 16 connections will be

     

       1002
       1002
       +
                 # sufficient for small to medium deployments

     

       1003
       1003
       +
                 DATABASE_POOL_SIZE = "16";

     

       1004
       1004
       +
       

     

       1005
       1005
       +
                 AUTH_PROVIDER_ADAPTERS = mkDefault (concatStringsSep "," availableAuthAdapters);

     

       1006
       1006
       +
       

     

       1007
       1007
       +
                 FEATURE_FLOW_ACTIVITIES_ENABLED = mkDefault true;

     

       1008
       1008
       +
                 FEATURE_POLICY_CONDITIONS_ENABLED = mkDefault true;

     

       1009
       1009
       +
                 FEATURE_MULTI_SITE_RESOURCES_ENABLED = mkDefault true;

     

       1010
       1010
       +
                 FEATURE_SELF_HOSTED_RELAYS_ENABLED = mkDefault true;

     

       1011
       1011
       +
                 FEATURE_IDP_SYNC_ENABLED = mkDefault true;

     

       1012
       1012
       +
                 FEATURE_REST_API_ENABLED = mkDefault true;

     

       1013
       1013
       +
                 FEATURE_INTERNET_RESOURCE_ENABLED = mkDefault true;

     

       1014
       1014
       +
                 FEATURE_TRAFFIC_FILTERS_ENABLED = mkDefault true;

     

       1015
       1015
       +
       

     

       1016
       1016
       +
                 FEATURE_SIGN_UP_ENABLED = mkDefault (!cfg.provision.enable);

     

       1017
       1017
       +
       

     

       1018
       1018
       +
                 WEB_EXTERNAL_URL = mkDefault cfg.web.externalUrl;

     

       1019
       1019
       +
                 API_EXTERNAL_URL = mkDefault cfg.api.externalUrl;

     

       1020
       1020
       +
               };

     

       1021
       1021
       +
       

     

       1022
       1022
       +
               domain.settings = {

     

       1023
       1023
       +
                 ERLANG_DISTRIBUTION_PORT = mkDefault 9000;

     

       1024
       1024
       +
                 HEALTHZ_PORT = mkDefault 4000;

     

       1025
       1025
       +
                 BACKGROUND_JOBS_ENABLED = mkDefault true;

     

       1026
       1026
       +
               };

     

       1027
       1027
       +
       

     

       1028
       1028
       +
               web.settings = {

     

       1029
       1029
       +
                 ERLANG_DISTRIBUTION_PORT = mkDefault 9001;

     

       1030
       1030
       +
                 HEALTHZ_PORT = mkDefault 4001;

     

       1031
       1031
       +
                 BACKGROUND_JOBS_ENABLED = mkDefault false;

     

       1032
       1032
       +
       

     

       1033
       1033
       +
                 PHOENIX_LISTEN_ADDRESS = mkDefault cfg.web.address;

     

       1034
       1034
       +
                 PHOENIX_EXTERNAL_TRUSTED_PROXIES = mkDefault (builtins.toJSON cfg.web.trustedProxies);

     

       1035
       1035
       +
                 PHOENIX_HTTP_WEB_PORT = mkDefault cfg.web.port;

     

       1036
       1036
       +
                 PHOENIX_HTTP_API_PORT = mkDefault cfg.api.port;

     

       1037
       1037
       +
                 PHOENIX_SECURE_COOKIES = mkDefault true; # enforce HTTPS on cookies

     

       1038
       1038
       +
               };

     

       1039
       1039
       +
       

     

       1040
       1040
       +
               api.settings = {

     

       1041
       1041
       +
                 ERLANG_DISTRIBUTION_PORT = mkDefault 9002;

     

       1042
       1042
       +
                 HEALTHZ_PORT = mkDefault 4002;

     

       1043
       1043
       +
                 BACKGROUND_JOBS_ENABLED = mkDefault false;

     

       1044
       1044
       +
       

     

       1045
       1045
       +
                 PHOENIX_LISTEN_ADDRESS = mkDefault cfg.api.address;

     

       1046
       1046
       +
                 PHOENIX_EXTERNAL_TRUSTED_PROXIES = mkDefault (builtins.toJSON cfg.api.trustedProxies);

     

       1047
       1047
       +
                 PHOENIX_HTTP_WEB_PORT = mkDefault cfg.web.port;

     

       1048
       1048
       +
                 PHOENIX_HTTP_API_PORT = mkDefault cfg.api.port;

     

       1049
       1049
       +
                 PHOENIX_SECURE_COOKIES = mkDefault true; # enforce HTTPS on cookies

     

       1050
       1050
       +
               };

     

       1051
       1051
       +
             };

     

       1052
       1052
       +
           }

     

       1053
       1053
       +
           (mkIf (!cfg.smtp.configureManually) {

     

       1054
       1054
       +
             services.firezone.server.settings = {

     

       1055
       1055
       +
               OUTBOUND_EMAIL_ADAPTER = "Elixir.Swoosh.Adapters.Mua";

     

       1056
       1056
       +
               OUTBOUND_EMAIL_ADAPTER_OPTS = builtins.toJSON { };

     

       1057
       1057
       +
               OUTBOUND_EMAIL_FROM = cfg.smtp.from;

     

       1058
       1058
       +
               OUTBOUND_EMAIL_SMTP_HOST = cfg.smtp.host;

     

       1059
       1059
       +
               OUTBOUND_EMAIL_SMTP_PORT = toString cfg.smtp.port;

     

       1060
       1060
       +
               OUTBOUND_EMAIL_SMTP_PROTOCOL = if cfg.smtp.implicitTls then "ssl" else "tcp";

     

       1061
       1061
       +
               OUTBOUND_EMAIL_SMTP_USERNAME = cfg.smtp.username;

     

       1062
       1062
       +
             };

     

       1063
       1063
       +
             services.firezone.server.settingsSecret = {

     

       1064
       1064
       +
               OUTBOUND_EMAIL_SMTP_PASSWORD = cfg.smtp.passwordFile;

     

       1065
       1065
       +
             };

     

       1066
       1066
       +
           })

     

       1067
       1067
       +
           (mkIf cfg.provision.enable {

     

       1068
       1068
       +
             # Load client secrets from authentication providers

     

       1069
       1069
       +
             services.firezone.server.settingsSecret = flip concatMapAttrs cfg.provision.accounts (

     

       1070
       1070
       +
               accountName: accountCfg:

     

       1071
       1071
       +
               flip concatMapAttrs accountCfg.auth (

     

       1072
       1072
       +
                 authName: authCfg:

     

       1073
       1073
       +
                 optionalAttrs (authCfg.adapter_config.clientSecretFile != null) {

     

       1074
       1074
       +
                   "AUTH_CLIENT_SECRET_${toUpper accountName}_${toUpper authName}" =

     

       1075
       1075
       +
                     authCfg.adapter_config.clientSecretFile;

     

       1076
       1076
       +
                 }

     

       1077
       1077
       +
               )

     

       1078
       1078
       +
             );

     

       1079
       1079
       +
           })

     

       1080
       1080
       +
           (mkIf (cfg.openClusterFirewall && cfg.domain.enable) {

     

       1081
       1081
       +
             networking.firewall.allowedTCPPorts = [

     

       1082
       1082
       +
               cfg.domain.settings.ERLANG_DISTRIBUTION_PORT

     

       1083
       1083
       +
             ];

     

       1084
       1084
       +
           })

     

       1085
       1085
       +
           (mkIf (cfg.openClusterFirewall && cfg.web.enable) {

     

       1086
       1086
       +
             networking.firewall.allowedTCPPorts = [

     

       1087
       1087
       +
               cfg.web.settings.ERLANG_DISTRIBUTION_PORT

     

       1088
       1088
       +
             ];

     

       1089
       1089
       +
           })

     

       1090
       1090
       +
           (mkIf (cfg.openClusterFirewall && cfg.api.enable) {

     

       1091
       1091
       +
             networking.firewall.allowedTCPPorts = [

     

       1092
       1092
       +
               cfg.api.settings.ERLANG_DISTRIBUTION_PORT

     

       1093
       1093
       +
             ];

     

       1094
       1094
       +
           })

     

       1095
       1095
       +
           (mkIf (cfg.domain.enable || cfg.web.enable || cfg.api.enable) {

     

       1096
       1096
       +
             systemd.slices.system-firezone = {

     

       1097
       1097
       +
               description = "Firezone Slice";

     

       1098
       1098
       +
             };

     

       1099
       1099
       +
       

     

       1100
       1100
       +
             systemd.targets.firezone = {

     

       1101
       1101
       +
               description = "Common target for all Firezone services.";

     

       1102
       1102
       +
               wantedBy = [ "multi-user.target" ];

     

       1103
       1103
       +
             };

     

       1104
       1104
       +
       

     

       1105
       1105
       +
             systemd.services.firezone-initialize = {

     

       1106
       1106
       +
               description = "Backend initialization service for the Firezone zero-trust access platform";

     

       1107
       1107
       +
       

     

       1108
       1108
       +
               after = mkIf cfg.enableLocalDB [ "postgresql.service" ];

     

       1109
       1109
       +
               requires = mkIf cfg.enableLocalDB [ "postgresql.service" ];

     

       1110
       1110
       +
               wantedBy = [ "firezone.target" ];

     

       1111
       1111
       +
               partOf = [ "firezone.target" ];

     

       1112
       1112
       +
       

     

       1113
       1113
       +
               script = ''

     

       1114
       1114
       +
                 mkdir -p "$TZDATA_DIR"

     

       1115
       1115
       +
       

     

       1116
       1116
       +
                 # Generate and load secrets

     

       1117
       1117
       +
                 ${generateSecrets}

     

       1118
       1118
       +
                 ${loadSecretEnvironment "domain"}

     

       1119
       1119
       +
       

     

       1120
       1120
       +
                 echo "Running migrations"

     

       1121
       1121
       +
                 ${getExe cfg.domain.package} eval Domain.Release.migrate

     

       1122
       1122
       +
               '';

     

       1123
       1123
       +
       

     

       1124
       1124
       +
               # We use the domain environment to be able to run migrations

     

       1125
       1125
       +
               environment = collectEnvironment "domain";

     

       1126
       1126
       +
               serviceConfig = commonServiceConfig // {

     

       1127
       1127
       +
                 Type = "oneshot";

     

       1128
       1128
       +
                 RemainAfterExit = true;

     

       1129
       1129
       +
               };

     

       1130
       1130
       +
             };

     

       1131
       1131
       +
       

     

       1132
       1132
       +
             systemd.services.firezone-server-domain = mkIf cfg.domain.enable {

     

       1133
       1133
       +
               description = "Backend domain server for the Firezone zero-trust access platform";

     

       1134
       1134
       +
               after = [ "firezone-initialize.service" ];

     

       1135
       1135
       +
               bindsTo = [ "firezone-initialize.service" ];

     

       1136
       1136
       +
               wantedBy = [ "firezone.target" ];

     

       1137
       1137
       +
               partOf = [ "firezone.target" ];

     

       1138
       1138
       +
       

     

       1139
       1139
       +
               script = ''

     

       1140
       1140
       +
                 ${loadSecretEnvironment "domain"}

     

       1141
       1141
       +
                 exec ${getExe cfg.domain.package} start;

     

       1142
       1142
       +
               '';

     

       1143
       1143
       +
       

     

       1144
       1144
       +
               path = [ pkgs.curl ];

     

       1145
       1145
       +
               postStart =

     

       1146
       1146
       +
                 ''

     

       1147
       1147
       +
                   # Wait for the firezone server to come online

     

       1148
       1148
       +
                   count=0

     

       1149
       1149
       +
                   while [[ "$(curl -s "http://localhost:${toString cfg.domain.settings.HEALTHZ_PORT}" 2>/dev/null || echo)" != '{"status":"ok"}' ]]

     

       1150
       1150
       +
                   do

     

       1151
       1151
       +
                     sleep 1

     

       1152
       1152
       +
                     if [[ "$count" -eq 30 ]]; then

     

       1153
       1153
       +
                       echo "Tried for at least 30 seconds, giving up..."

     

       1154
       1154
       +
                       exit 1

     

       1155
       1155
       +
                     fi

     

       1156
       1156
       +
                     count=$((count++))

     

       1157
       1157
       +
                   done

     

       1158
       1158
       +
                 ''

     

       1159
       1159
       +
                 + optionalString cfg.provision.enable ''

     

       1160
       1160
       +
                   # Wait for server to fully come up. Not ideal to use sleep, but at least it works.

     

       1161
       1161
       +
                   sleep 1

     

       1162
       1162
       +
       

     

       1163
       1163
       +
                   ${loadSecretEnvironment "domain"}

     

       1164
       1164
       +
                   ln -sTf ${provisionStateJson} provision-state.json

     

       1165
       1165
       +
                   ${getExe cfg.domain.package} rpc 'Code.eval_file("${./provision.exs}")'

     

       1166
       1166
       +
                 '';

     

       1167
       1167
       +
       

     

       1168
       1168
       +
               environment = collectEnvironment "domain";

     

       1169
       1169
       +
               serviceConfig = commonServiceConfig;

     

       1170
       1170
       +
             };

     

       1171
       1171
       +
       

     

       1172
       1172
       +
             systemd.services.firezone-server-web = mkIf cfg.web.enable {

     

       1173
       1173
       +
               description = "Backend web server for the Firezone zero-trust access platform";

     

       1174
       1174
       +
               after = [ "firezone-initialize.service" ];

     

       1175
       1175
       +
               bindsTo = [ "firezone-initialize.service" ];

     

       1176
       1176
       +
               wantedBy = [ "firezone.target" ];

     

       1177
       1177
       +
               partOf = [ "firezone.target" ];

     

       1178
       1178
       +
       

     

       1179
       1179
       +
               script = ''

     

       1180
       1180
       +
                 ${loadSecretEnvironment "web"}

     

       1181
       1181
       +
                 exec ${getExe cfg.web.package} start;

     

       1182
       1182
       +
               '';

     

       1183
       1183
       +
       

     

       1184
       1184
       +
               environment = collectEnvironment "web";

     

       1185
       1185
       +
               serviceConfig = commonServiceConfig;

     

       1186
       1186
       +
             };

     

       1187
       1187
       +
       

     

       1188
       1188
       +
             systemd.services.firezone-server-api = mkIf cfg.api.enable {

     

       1189
       1189
       +
               description = "Backend api server for the Firezone zero-trust access platform";

     

       1190
       1190
       +
               after = [ "firezone-initialize.service" ];

     

       1191
       1191
       +
               bindsTo = [ "firezone-initialize.service" ];

     

       1192
       1192
       +
               wantedBy = [ "firezone.target" ];

     

       1193
       1193
       +
               partOf = [ "firezone.target" ];

     

       1194
       1194
       +
       

     

       1195
       1195
       +
               script = ''

     

       1196
       1196
       +
                 ${loadSecretEnvironment "api"}

     

       1197
       1197
       +
                 exec ${getExe cfg.api.package} start;

     

       1198
       1198
       +
               '';

     

       1199
       1199
       +
       

     

       1200
       1200
       +
               environment = collectEnvironment "api";

     

       1201
       1201
       +
               serviceConfig = commonServiceConfig;

     

       1202
       1202
       +
             };

     

       1203
       1203
       +
           })

     

       1204
       1204
       +
         ];

     

       1205
       1205
       +
       

     

       1206
       1206
       +
         meta.maintainers = with lib.maintainers; [

     

       1207
       1207
       +
           oddlama

     

       1208
       1208
       +
           patrickdag

     

       1209
       1209
       +
         ];

     

       1210
       1210
       +
       }

nixos/tests/all-tests.nix

···

       413
       413
        
         firewall = handleTest ./firewall.nix { nftables = false; };

     

       414
       414
        
         firewall-nftables = handleTest ./firewall.nix { nftables = true; };

     

       415
       415
        
         fish = runTest ./fish.nix;

     

       416
       416
       +
         firezone = handleTest ./firezone/firezone.nix {};

     

       416
       417
        
         flannel = handleTestOn ["x86_64-linux"] ./flannel.nix {};

     

       417
       418
        
         flaresolverr = handleTest ./flaresolverr.nix {};

     

       418
       419
        
         flood = handleTest ./flood.nix {};

+86

nixos/tests/firezone/create-tokens.exs

···

       1
       1
       +
       alias Domain.{Repo, Accounts, Auth, Actors, Tokens}

     

       2
       2
       +
       

     

       3
       3
       +
       mappings = case File.read("provision-uuids.json") do

     

       4
       4
       +
       {:ok, content} ->

     

       5
       5
       +
         case Jason.decode(content) do

     

       6
       6
       +
           {:ok, mapping} -> mapping

     

       7
       7
       +
           _ -> %{"accounts" => %{}}

     

       8
       8
       +
         end

     

       9
       9
       +
       _ -> %{"accounts" => %{}}

     

       10
       10
       +
       end

     

       11
       11
       +
       

     

       12
       12
       +
       IO.puts("INFO: Fetching account")

     

       13
       13
       +
       {:ok, account} = Accounts.fetch_account_by_id_or_slug("main")

     

       14
       14
       +
       

     

       15
       15
       +
       IO.puts("INFO: Fetching email provider")

     

       16
       16
       +
       {:ok, email_provider} = Auth.Provider.Query.not_disabled()

     

       17
       17
       +
         |> Auth.Provider.Query.by_adapter(:email)

     

       18
       18
       +
         |> Auth.Provider.Query.by_account_id(account.id)

     

       19
       19
       +
         |> Repo.fetch(Auth.Provider.Query, [])

     

       20
       20
       +
       

     

       21
       21
       +
       temp_admin_actor_email = "firezone-provision@localhost.local"

     

       22
       22
       +
       temp_admin_actor_context = %Auth.Context{

     

       23
       23
       +
         type: :browser,

     

       24
       24
       +
         user_agent: "Unspecified/0.0",

     

       25
       25
       +
         remote_ip: {127, 0, 0, 1},

     

       26
       26
       +
         remote_ip_location_region: "N/A",

     

       27
       27
       +
         remote_ip_location_city: "N/A",

     

       28
       28
       +
         remote_ip_location_lat: 0.0,

     

       29
       29
       +
         remote_ip_location_lon: 0.0

     

       30
       30
       +
       }

     

       31
       31
       +
       

     

       32
       32
       +
       {:ok, temp_admin_actor} =

     

       33
       33
       +
         Actors.create_actor(account, %{

     

       34
       34
       +
           type: :account_admin_user,

     

       35
       35
       +
           name: "Token Provisioning"

     

       36
       36
       +
         })

     

       37
       37
       +
       

     

       38
       38
       +
       {:ok, temp_admin_actor_email_identity} =

     

       39
       39
       +
         Auth.create_identity(temp_admin_actor, email_provider, %{

     

       40
       40
       +
           provider_identifier: temp_admin_actor_email,

     

       41
       41
       +
           provider_identifier_confirmation: temp_admin_actor_email

     

       42
       42
       +
         })

     

       43
       43
       +
       

     

       44
       44
       +
       {:ok, temp_admin_actor_token} =

     

       45
       45
       +
         Auth.create_token(temp_admin_actor_email_identity, temp_admin_actor_context, "temporarynonce", DateTime.utc_now() |> DateTime.add(1, :hour))

     

       46
       46
       +
       

     

       47
       47
       +
       {:ok, temp_admin_subject} =

     

       48
       48
       +
         Auth.build_subject(temp_admin_actor_token, temp_admin_actor_context)

     

       49
       49
       +
       

     

       50
       50
       +
       {:ok, relay_group_token} =

     

       51
       51
       +
         Tokens.create_token(%{

     

       52
       52
       +
           "type" => :relay_group,

     

       53
       53
       +
       	"expires_at" => DateTime.utc_now() |> DateTime.add(1, :hour),

     

       54
       54
       +
           "secret_fragment" => Domain.Crypto.random_token(32, encoder: :hex32),

     

       55
       55
       +
           "relay_group_id" => get_in(mappings, ["accounts", "main", "relay_groups", "my-relays"])

     

       56
       56
       +
         })

     

       57
       57
       +
       

     

       58
       58
       +
       relay_group_encoded_token = Tokens.encode_fragment!(relay_group_token)

     

       59
       59
       +
       IO.puts("Created relay token: #{relay_group_encoded_token}")

     

       60
       60
       +
       File.write("relay_token.txt", relay_group_encoded_token)

     

       61
       61
       +
       

     

       62
       62
       +
       {:ok, gateway_group_token} =

     

       63
       63
       +
         Tokens.create_token(%{

     

       64
       64
       +
           "type" => :gateway_group,

     

       65
       65
       +
           "expires_at" => DateTime.utc_now() |> DateTime.add(1, :hour),

     

       66
       66
       +
           "secret_fragment" => Domain.Crypto.random_token(32, encoder: :hex32),

     

       67
       67
       +
           "account_id" => get_in(mappings, ["accounts", "main", "id"]),

     

       68
       68
       +
           "gateway_group_id" => get_in(mappings, ["accounts", "main", "gateway_groups", "site"])

     

       69
       69
       +
         }, temp_admin_subject)

     

       70
       70
       +
       

     

       71
       71
       +
       gateway_group_encoded_token = Tokens.encode_fragment!(gateway_group_token)

     

       72
       72
       +
       IO.puts("Created gateway group token: #{gateway_group_encoded_token}")

     

       73
       73
       +
       File.write("gateway_token.txt", gateway_group_encoded_token)

     

       74
       74
       +
       

     

       75
       75
       +
       {:ok, service_account_actor_token} =

     

       76
       76
       +
         Tokens.create_token(%{

     

       77
       77
       +
           "type" => :client,

     

       78
       78
       +
           "expires_at" => DateTime.utc_now() |> DateTime.add(1, :hour),

     

       79
       79
       +
           "secret_fragment" => Domain.Crypto.random_token(32, encoder: :hex32),

     

       80
       80
       +
           "account_id" => get_in(mappings, ["accounts", "main", "id"]),

     

       81
       81
       +
           "actor_id" => get_in(mappings, ["accounts", "main", "actors", "client"])

     

       82
       82
       +
         })

     

       83
       83
       +
       

     

       84
       84
       +
       service_account_actor_encoded_token = Tokens.encode_fragment!(service_account_actor_token)

     

       85
       85
       +
       IO.puts("Created service actor token: #{service_account_actor_encoded_token}")

     

       86
       86
       +
       File.write("client_token.txt", service_account_actor_encoded_token)

+349

nixos/tests/firezone/firezone.nix

···

       1
       1
       +
       import ../make-test-python.nix (

     

       2
       2
       +
         { pkgs, ... }:

     

       3
       3
       +
         let

     

       4
       4
       +
           certs = import ../common/acme/server/snakeoil-certs.nix;

     

       5
       5
       +
           domain = certs.domain;

     

       6
       6
       +
         in

     

       7
       7
       +
         {

     

       8
       8
       +
           name = "firezone";

     

       9
       9
       +
           meta.maintainers = with pkgs.lib.maintainers; [ oddlama ];

     

       10
       10
       +
       

     

       11
       11
       +
           nodes = {

     

       12
       12
       +
             server =

     

       13
       13
       +
               {

     

       14
       14
       +
                 config,

     

       15
       15
       +
                 lib,

     

       16
       16
       +
                 pkgs,

     

       17
       17
       +
                 ...

     

       18
       18
       +
               }:

     

       19
       19
       +
               {

     

       20
       20
       +
                 security.pki.certificateFiles = [ certs.ca.cert ];

     

       21
       21
       +
       

     

       22
       22
       +
                 networking.extraHosts = ''

     

       23
       23
       +
                   ${config.networking.primaryIPAddress} ${domain}

     

       24
       24
       +
                   ${config.networking.primaryIPv6Address} ${domain}

     

       25
       25
       +
                 '';

     

       26
       26
       +
       

     

       27
       27
       +
                 networking.firewall.allowedTCPPorts = [

     

       28
       28
       +
                   80

     

       29
       29
       +
                   443

     

       30
       30
       +
                 ];

     

       31
       31
       +
       

     

       32
       32
       +
                 services.nginx = {

     

       33
       33
       +
                   enable = true;

     

       34
       34
       +
                   virtualHosts.${domain} = {

     

       35
       35
       +
                     sslCertificate = certs.${domain}.cert;

     

       36
       36
       +
                     sslCertificateKey = certs.${domain}.key;

     

       37
       37
       +
                   };

     

       38
       38
       +
                 };

     

       39
       39
       +
       

     

       40
       40
       +
                 services.firezone.server = {

     

       41
       41
       +
                   enable = true;

     

       42
       42
       +
                   enableLocalDB = true;

     

       43
       43
       +
                   nginx.enable = true;

     

       44
       44
       +
       

     

       45
       45
       +
                   # Doesn't need to work for this test, but needs to be configured

     

       46
       46
       +
                   # otherwise the server will not start.

     

       47
       47
       +
                   smtp = {

     

       48
       48
       +
                     from = "firezone@example.com";

     

       49
       49
       +
                     host = "mail.localhost";

     

       50
       50
       +
                     port = 465;

     

       51
       51
       +
                     implicitTls = true;

     

       52
       52
       +
                     username = "firezone@example.com";

     

       53
       53
       +
                     passwordFile = pkgs.writeText "tmpmailpasswd" "supermailpassword";

     

       54
       54
       +
                   };

     

       55
       55
       +
       

     

       56
       56
       +
                   provision = {

     

       57
       57
       +
                     enable = true;

     

       58
       58
       +
                     accounts.main = {

     

       59
       59
       +
                       name = "My Account";

     

       60
       60
       +
                       relayGroups.my-relays.name = "Relays";

     

       61
       61
       +
                       gatewayGroups.site.name = "Site";

     

       62
       62
       +
                       actors = {

     

       63
       63
       +
                         admin = {

     

       64
       64
       +
                           type = "account_admin_user";

     

       65
       65
       +
                           name = "Admin";

     

       66
       66
       +
                           email = "admin@example.com";

     

       67
       67
       +
                         };

     

       68
       68
       +
                         client = {

     

       69
       69
       +
                           type = "service_account";

     

       70
       70
       +
                           name = "A client";

     

       71
       71
       +
                           email = "client@example.com";

     

       72
       72
       +
                         };

     

       73
       73
       +
                       };

     

       74
       74
       +
                       resources.res1 = {

     

       75
       75
       +
                         type = "dns";

     

       76
       76
       +
                         name = "Dns Resource";

     

       77
       77
       +
                         address = "resource.example.com";

     

       78
       78
       +
                         gatewayGroups = [ "site" ];

     

       79
       79
       +
                         filters = [

     

       80
       80
       +
                           { protocol = "icmp"; }

     

       81
       81
       +
                           {

     

       82
       82
       +
                             protocol = "tcp";

     

       83
       83
       +
                             ports = [ 80 ];

     

       84
       84
       +
                           }

     

       85
       85
       +
                         ];

     

       86
       86
       +
                       };

     

       87
       87
       +
                       resources.res2 = {

     

       88
       88
       +
                         type = "ip";

     

       89
       89
       +
                         name = "Ip Resource";

     

       90
       90
       +
                         address = "172.20.2.1";

     

       91
       91
       +
                         gatewayGroups = [ "site" ];

     

       92
       92
       +
                       };

     

       93
       93
       +
                       resources.res3 = {

     

       94
       94
       +
                         type = "cidr";

     

       95
       95
       +
                         name = "Cidr Resource";

     

       96
       96
       +
                         address = "172.20.1.0/24";

     

       97
       97
       +
                         gatewayGroups = [ "site" ];

     

       98
       98
       +
                       };

     

       99
       99
       +
                       policies.pol1 = {

     

       100
       100
       +
                         description = "Allow anyone res1 access";

     

       101
       101
       +
                         group = "everyone";

     

       102
       102
       +
                         resource = "res1";

     

       103
       103
       +
                       };

     

       104
       104
       +
                       policies.pol2 = {

     

       105
       105
       +
                         description = "Allow anyone res2 access";

     

       106
       106
       +
                         group = "everyone";

     

       107
       107
       +
                         resource = "res2";

     

       108
       108
       +
                       };

     

       109
       109
       +
                       policies.pol3 = {

     

       110
       110
       +
                         description = "Allow anyone res3 access";

     

       111
       111
       +
                         group = "everyone";

     

       112
       112
       +
                         resource = "res3";

     

       113
       113
       +
                       };

     

       114
       114
       +
                     };

     

       115
       115
       +
                   };

     

       116
       116
       +
       

     

       117
       117
       +
                   api.externalUrl = "https://${domain}/api/";

     

       118
       118
       +
                   web.externalUrl = "https://${domain}/";

     

       119
       119
       +
                 };

     

       120
       120
       +
       

     

       121
       121
       +
                 systemd.services.firezone-server-domain.postStart = lib.mkAfter ''

     

       122
       122
       +
                   ${lib.getExe config.services.firezone.server.domain.package} rpc 'Code.eval_file("${./create-tokens.exs}")'

     

       123
       123
       +
                 '';

     

       124
       124
       +
               };

     

       125
       125
       +
       

     

       126
       126
       +
             relay =

     

       127
       127
       +
               {

     

       128
       128
       +
                 nodes,

     

       129
       129
       +
                 config,

     

       130
       130
       +
                 lib,

     

       131
       131
       +
                 ...

     

       132
       132
       +
               }:

     

       133
       133
       +
               {

     

       134
       134
       +
                 security.pki.certificateFiles = [ certs.ca.cert ];

     

       135
       135
       +
                 networking.extraHosts = ''

     

       136
       136
       +
                   ${nodes.server.networking.primaryIPAddress} ${domain}

     

       137
       137
       +
                   ${nodes.server.networking.primaryIPv6Address} ${domain}

     

       138
       138
       +
                 '';

     

       139
       139
       +
       

     

       140
       140
       +
                 services.firezone.relay = {

     

       141
       141
       +
                   enable = true;

     

       142
       142
       +
                   logLevel = "debug";

     

       143
       143
       +
                   name = "test-relay";

     

       144
       144
       +
                   apiUrl = "wss://${domain}/api/";

     

       145
       145
       +
                   tokenFile = "/tmp/shared/relay_token.txt";

     

       146
       146
       +
                   publicIpv4 = config.networking.primaryIPAddress;

     

       147
       147
       +
                   publicIpv6 = config.networking.primaryIPv6Address;

     

       148
       148
       +
                   openFirewall = true;

     

       149
       149
       +
                 };

     

       150
       150
       +
       

     

       151
       151
       +
                 # Don't auto-start so we can wait until the token was provisioned

     

       152
       152
       +
                 systemd.services.firezone-relay.wantedBy = lib.mkForce [ ];

     

       153
       153
       +
               };

     

       154
       154
       +
       

     

       155
       155
       +
             # A resource that is only connected to the gateway,

     

       156
       156
       +
             # allowing us to confirm the VPN works

     

       157
       157
       +
             resource = {

     

       158
       158
       +
               virtualisation.vlans = [

     

       159
       159
       +
                 1

     

       160
       160
       +
                 2

     

       161
       161
       +
               ];

     

       162
       162
       +
       

     

       163
       163
       +
               networking.interfaces.eth1.ipv4.addresses = [

     

       164
       164
       +
                 {

     

       165
       165
       +
                   address = "172.20.1.1";

     

       166
       166
       +
                   prefixLength = 24;

     

       167
       167
       +
                 }

     

       168
       168
       +
               ];

     

       169
       169
       +
       

     

       170
       170
       +
               networking.interfaces.eth2.ipv4.addresses = [

     

       171
       171
       +
                 {

     

       172
       172
       +
                   address = "172.20.2.1";

     

       173
       173
       +
                   prefixLength = 24;

     

       174
       174
       +
                 }

     

       175
       175
       +
               ];

     

       176
       176
       +
       

     

       177
       177
       +
               networking.firewall.allowedTCPPorts = [

     

       178
       178
       +
                 80

     

       179
       179
       +
               ];

     

       180
       180
       +
       

     

       181
       181
       +
               services.nginx = {

     

       182
       182
       +
                 enable = true;

     

       183
       183
       +
                 virtualHosts = {

     

       184
       184
       +
                   "localhost" = {

     

       185
       185
       +
                     default = true;

     

       186
       186
       +
                     locations."/".extraConfig = ''

     

       187
       187
       +
                       return 200 'greetings from the resource';

     

       188
       188
       +
                       add_header Content-Type text/plain;

     

       189
       189
       +
                     '';

     

       190
       190
       +
                   };

     

       191
       191
       +
                 };

     

       192
       192
       +
               };

     

       193
       193
       +
             };

     

       194
       194
       +
       

     

       195
       195
       +
             gateway =

     

       196
       196
       +
               {

     

       197
       197
       +
                 nodes,

     

       198
       198
       +
                 lib,

     

       199
       199
       +
                 ...

     

       200
       200
       +
               }:

     

       201
       201
       +
               {

     

       202
       202
       +
                 virtualisation.vlans = [

     

       203
       203
       +
                   1

     

       204
       204
       +
                   2

     

       205
       205
       +
                 ];

     

       206
       206
       +
       

     

       207
       207
       +
                 networking = {

     

       208
       208
       +
                   interfaces.eth1.ipv4.addresses = [

     

       209
       209
       +
                     {

     

       210
       210
       +
                       address = "172.20.1.2";

     

       211
       211
       +
                       prefixLength = 24;

     

       212
       212
       +
                     }

     

       213
       213
       +
                   ];

     

       214
       214
       +
       

     

       215
       215
       +
                   interfaces.eth2.ipv4.addresses = [

     

       216
       216
       +
                     {

     

       217
       217
       +
                       address = "172.20.2.2";

     

       218
       218
       +
                       prefixLength = 24;

     

       219
       219
       +
                     }

     

       220
       220
       +
                   ];

     

       221
       221
       +
       

     

       222
       222
       +
                   firewall.enable = false;

     

       223
       223
       +
                   nftables.enable = true;

     

       224
       224
       +
                   nftables.tables."filter".family = "inet";

     

       225
       225
       +
                   nftables.tables."filter".content = ''

     

       226
       226
       +
                     chain incoming {

     

       227
       227
       +
                       type filter hook input priority 0; policy accept;

     

       228
       228
       +
                     }

     

       229
       229
       +
       

     

       230
       230
       +
                     chain postrouting {

     

       231
       231
       +
                       type nat hook postrouting priority srcnat; policy accept;

     

       232
       232
       +
                       meta protocol ip iifname "tun-firezone" oifname { "eth1", "eth2" } masquerade random

     

       233
       233
       +
                     }

     

       234
       234
       +
       

     

       235
       235
       +
                     chain forward {

     

       236
       236
       +
                       type filter hook forward priority 0; policy drop;

     

       237
       237
       +
                       iifname "tun-firezone" accept

     

       238
       238
       +
                       oifname "tun-firezone" accept

     

       239
       239
       +
                     }

     

       240
       240
       +
       

     

       241
       241
       +
                     chain output {

     

       242
       242
       +
                       type filter hook output priority 0; policy accept;

     

       243
       243
       +
                     }

     

       244
       244
       +
                   '';

     

       245
       245
       +
                 };

     

       246
       246
       +
       

     

       247
       247
       +
                 boot.kernel.sysctl."net.ipv4.ip_forward" = "1";

     

       248
       248
       +
                 # boot.kernel.sysctl."net.ipv4.conf.all.src_valid_mark" = "1";

     

       249
       249
       +
                 boot.kernel.sysctl."net.ipv6.conf.default.forwarding" = "1";

     

       250
       250
       +
                 boot.kernel.sysctl."net.ipv6.conf.all.forwarding" = "1";

     

       251
       251
       +
       

     

       252
       252
       +
                 security.pki.certificateFiles = [ certs.ca.cert ];

     

       253
       253
       +
                 networking.extraHosts = ''

     

       254
       254
       +
                   ${nodes.server.networking.primaryIPAddress} ${domain}

     

       255
       255
       +
                   ${nodes.server.networking.primaryIPv6Address} ${domain}

     

       256
       256
       +
                   172.20.1.1 resource.example.com

     

       257
       257
       +
                 '';

     

       258
       258
       +
       

     

       259
       259
       +
                 services.firezone.gateway = {

     

       260
       260
       +
                   enable = true;

     

       261
       261
       +
                   logLevel = "debug";

     

       262
       262
       +
                   name = "test-gateway";

     

       263
       263
       +
                   apiUrl = "wss://${domain}/api/";

     

       264
       264
       +
                   tokenFile = "/tmp/shared/gateway_token.txt";

     

       265
       265
       +
                 };

     

       266
       266
       +
       

     

       267
       267
       +
                 # Don't auto-start so we can wait until the token was provisioned

     

       268
       268
       +
                 systemd.services.firezone-gateway.wantedBy = lib.mkForce [ ];

     

       269
       269
       +
               };

     

       270
       270
       +
       

     

       271
       271
       +
             client =

     

       272
       272
       +
               {

     

       273
       273
       +
                 nodes,

     

       274
       274
       +
                 lib,

     

       275
       275
       +
                 ...

     

       276
       276
       +
               }:

     

       277
       277
       +
               {

     

       278
       278
       +
                 security.pki.certificateFiles = [ certs.ca.cert ];

     

       279
       279
       +
                 networking.useNetworkd = true;

     

       280
       280
       +
                 networking.extraHosts = ''

     

       281
       281
       +
                   ${nodes.server.networking.primaryIPAddress} ${domain}

     

       282
       282
       +
                   ${nodes.server.networking.primaryIPv6Address} ${domain}

     

       283
       283
       +
                 '';

     

       284
       284
       +
       

     

       285
       285
       +
                 services.firezone.headless-client = {

     

       286
       286
       +
                   enable = true;

     

       287
       287
       +
                   logLevel = "debug";

     

       288
       288
       +
                   name = "test-client-somebody";

     

       289
       289
       +
                   apiUrl = "wss://${domain}/api/";

     

       290
       290
       +
                   tokenFile = "/tmp/shared/client_token.txt";

     

       291
       291
       +
                 };

     

       292
       292
       +
       

     

       293
       293
       +
                 # Don't auto-start so we can wait until the token was provisioned

     

       294
       294
       +
                 systemd.services.firezone-headless-client.wantedBy = lib.mkForce [ ];

     

       295
       295
       +
               };

     

       296
       296
       +
           };

     

       297
       297
       +
       

     

       298
       298
       +
           testScript =

     

       299
       299
       +
             { ... }:

     

       300
       300
       +
             ''

     

       301
       301
       +
               start_all()

     

       302
       302
       +
       

     

       303
       303
       +
               with subtest("Start server"):

     

       304
       304
       +
                   server.wait_for_unit("firezone.target")

     

       305
       305
       +
                   server.wait_until_succeeds("curl -Lsf https://${domain} | grep 'Welcome to Firezone'")

     

       306
       306
       +
                   server.wait_until_succeeds("curl -Ls https://${domain}/api | grep 'Not Found'")

     

       307
       307
       +
       

     

       308
       308
       +
                   # Wait for tokens and copy them to shared folder

     

       309
       309
       +
                   server.wait_for_file("/var/lib/private/firezone/relay_token.txt")

     

       310
       310
       +
                   server.wait_for_file("/var/lib/private/firezone/gateway_token.txt")

     

       311
       311
       +
                   server.wait_for_file("/var/lib/private/firezone/client_token.txt")

     

       312
       312
       +
                   server.succeed("cp /var/lib/private/firezone/*_token.txt /tmp/shared")

     

       313
       313
       +
       

     

       314
       314
       +
               with subtest("Connect relay"):

     

       315
       315
       +
                   relay.succeed("systemctl start firezone-relay")

     

       316
       316
       +
                   relay.wait_for_unit("firezone-relay.service")

     

       317
       317
       +
                   relay.wait_until_succeeds("journalctl --since -2m --unit firezone-relay.service --grep 'Connected to portal.*${domain}'", timeout=30)

     

       318
       318
       +
       

     

       319
       319
       +
               with subtest("Connect gateway"):

     

       320
       320
       +
                   gateway.succeed("systemctl start firezone-gateway")

     

       321
       321
       +
                   gateway.wait_for_unit("firezone-gateway.service")

     

       322
       322
       +
                   gateway.wait_until_succeeds("journalctl --since -2m --unit firezone-gateway.service --grep 'Connected to portal.*${domain}'", timeout=30)

     

       323
       323
       +
                   relay.wait_until_succeeds("journalctl --since -2m --unit firezone-relay.service --grep 'Created allocation.*IPv4'", timeout=30)

     

       324
       324
       +
                   relay.wait_until_succeeds("journalctl --since -2m --unit firezone-relay.service --grep 'Created allocation.*IPv6'", timeout=30)

     

       325
       325
       +
       

     

       326
       326
       +
                   # Assert both relay ips are known

     

       327
       327
       +
                   gateway.wait_until_succeeds("journalctl --since -2m --unit firezone-gateway.service --grep 'Updated allocation.*relay_ip4.*Some.*relay_ip6.*Some'", timeout=30)

     

       328
       328
       +
       

     

       329
       329
       +
               with subtest("Connect headless-client"):

     

       330
       330
       +
                   client.succeed("systemctl start firezone-headless-client")

     

       331
       331
       +
                   client.wait_for_unit("firezone-headless-client.service")

     

       332
       332
       +
                   client.wait_until_succeeds("journalctl --since -2m --unit firezone-headless-client.service --grep 'Connected to portal.*${domain}'", timeout=30)

     

       333
       333
       +
                   client.wait_until_succeeds("journalctl --since -2m --unit firezone-headless-client.service --grep 'Tunnel ready'", timeout=30)

     

       334
       334
       +
       

     

       335
       335
       +
               with subtest("Check DNS based access"):

     

       336
       336
       +
                   # Check that we can access the resource through the VPN via DNS

     

       337
       337
       +
                   client.wait_until_succeeds("curl -4 -Lsf http://resource.example.com | grep 'greetings from the resource'")

     

       338
       338
       +
                   client.wait_until_succeeds("curl -6 -Lsf http://resource.example.com | grep 'greetings from the resource'")

     

       339
       339
       +
       

     

       340
       340
       +
               with subtest("Check CIDR based access"):

     

       341
       341
       +
                   # Check that we can access the resource through the VPN via CIDR

     

       342
       342
       +
                   client.wait_until_succeeds("ping -c1 -W1 172.20.1.1")

     

       343
       343
       +
       

     

       344
       344
       +
               with subtest("Check IP based access"):

     

       345
       345
       +
                   # Check that we can access the resource through the VPN via IP

     

       346
       346
       +
                   client.wait_until_succeeds("ping -c1 -W1 172.20.2.1")

     

       347
       347
       +
             '';

     

       348
       348
       +
         }

     

       349
       349
       +
       )