commit 8abf395995946e9f60c6949109b0565b51a341c4 · pyrox.dev/nixpkgs

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

···

       120
        
       

     

       121
        
       - `services.libvirtd.autoSnapshot`, a backup service for libvirt managed vms.

     

       122
        
       

     

       0
        
       
     

       0
        
       
     

       123
        
       ## Backward Incompatibilities {#sec-release-25.11-incompatibilities}

     

       124
        
       

     

       125
        
       <!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

···

       120
        
       

     

       121
        
       - `services.libvirtd.autoSnapshot`, a backup service for libvirt managed vms.

     

       122
        
       

     

       123
       +
       - [Sshwifty](https://github.com/nirui/sshwifty), a Telnet and SSH client for your browser. Available as [services.sshwifty](#opt-services.sshwifty.enable).

     

       124
       +
       

     

       125
        
       ## Backward Incompatibilities {#sec-release-25.11-incompatibilities}

     

       126
        
       

     

       127
        
       <!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

nixos/modules/module-list.nix

···

       1694
        
         ./services/web-apps/snipe-it.nix

     

       1695
        
         ./services/web-apps/snips-sh.nix

     

       1696
        
         ./services/web-apps/sogo.nix

     

       0
        
       
     

       1697
        
         ./services/web-apps/stash.nix

     

       1698
        
         ./services/web-apps/stirling-pdf.nix

     

       1699
        
         ./services/web-apps/strfry.nix

···

       1694
        
         ./services/web-apps/snipe-it.nix

     

       1695
        
         ./services/web-apps/snips-sh.nix

     

       1696
        
         ./services/web-apps/sogo.nix

     

       1697
       +
         ./services/web-apps/sshwifty.nix

     

       1698
        
         ./services/web-apps/stash.nix

     

       1699
        
         ./services/web-apps/stirling-pdf.nix

     

       1700
        
         ./services/web-apps/strfry.nix

+128

nixos/modules/services/web-apps/sshwifty.nix

···

       1
       +
       {

     

       2
       +
         config,

     

       3
       +
         lib,

     

       4
       +
         pkgs,

     

       5
       +
         ...

     

       6
       +
       }:

     

       7
       +
       let

     

       8
       +
         cfg = config.services.sshwifty;

     

       9
       +
         format = pkgs.formats.json { };

     

       10
       +
         settings = format.generate "sshwifty.json" cfg.settings;

     

       11
       +
       in

     

       12
       +
       {

     

       13
       +
         options.services.sshwifty = {

     

       14
       +
           enable = lib.mkEnableOption "Sshwifty";

     

       15
       +
           package = lib.mkPackageOption pkgs "sshwifty" { };

     

       16
       +
           settings = lib.mkOption {

     

       17
       +
             type = format.type;

     

       18
       +
             description = ''

     

       19
       +
               Configuration for Sshwifty. See

     

       20
       +
               [the Sshwifty documentation](https://github.com/nirui/sshwifty/tree/master?tab=readme-ov-file#configuration)

     

       21
       +
               for possible options.

     

       22
       +
             '';

     

       23
       +
           };

     

       24
       +
           sharedKeyFile = lib.mkOption {

     

       25
       +
             type = lib.types.nullOr lib.types.path;

     

       26
       +
             default = null;

     

       27
       +
             description = "Path to a file containing the shared key.";

     

       28
       +
           };

     

       29
       +
           socks5PasswordFile = lib.mkOption {

     

       30
       +
             type = lib.types.nullOr lib.types.path;

     

       31
       +
             default = null;

     

       32
       +
             description = "Path to a file containing the SOCKS5 password.";

     

       33
       +
           };

     

       34
       +
         };

     

       35
       +
         config = lib.mkIf cfg.enable {

     

       36
       +
           systemd.services.sshwifty = {

     

       37
       +
             description = "Sshwifty";

     

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

     

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

     

       40
       +
             script = ''

     

       41
       +
               ${lib.optionalString (cfg.sharedKeyFile != null || cfg.socks5PasswordFile != null) (

     

       42
       +
                 lib.concatStringsSep " " [

     

       43
       +
                   (lib.getExe pkgs.jq)

     

       44
       +
                   "-s"

     

       45
       +
                   "'.[0] * .[1]"

     

       46
       +
                   (lib.optionalString (cfg.sharedKeyFile != null && cfg.socks5PasswordFile != null) "* .[2]")

     

       47
       +
                   "'"

     

       48
       +
                   settings

     

       49
       +
                   (lib.optionalString (

     

       50
       +
                     cfg.sharedKeyFile != null

     

       51
       +
                   ) "<(echo \"{\\\"SharedKey\\\":\\\"$(cat $CREDENTIALS_DIRECTORY/sharedkey)\\\"}\")")

     

       52
       +
                   (lib.optionalString (

     

       53
       +
                     cfg.socks5PasswordFile != null

     

       54
       +
                   ) "<(echo \"{\\\"Socks5Password\\\":\\\"$(cat $CREDENTIALS_DIRECTORY/socks5pass)\\\"}\")")

     

       55
       +
                   "> /run/sshwifty/sshwifty.json"

     

       56
       +
                 ]

     

       57
       +
               )}

     

       58
       +
               ${lib.optionalString (

     

       59
       +
                 cfg.sharedKeyFile != null || cfg.socks5PasswordFile != null

     

       60
       +
               ) "export SSHWIFTY_CONFIG=/run/sshwifty/sshwifty.json"}

     

       61
       +
               ${lib.optionalString (

     

       62
       +
                 cfg.sharedKeyFile == null && cfg.socks5PasswordFile == null

     

       63
       +
               ) "export SSHWIFTY_CONFIG=${settings}"}

     

       64
       +
               exec ${lib.getExe cfg.package}

     

       65
       +
             '';

     

       66
       +
             serviceConfig = {

     

       67
       +
               DynamicUser = true;

     

       68
       +
               RuntimeDirectory = "sshwifty";

     

       69
       +
               RuntimeDirectoryMode = "0750";

     

       70
       +
               LoadCredential =

     

       71
       +
                 [ ]

     

       72
       +
                 ++ lib.optionals (cfg.sharedKeyFile != null) [ "sharedkey:${cfg.sharedKeyFile}" ]

     

       73
       +
                 ++ lib.optionals (cfg.socks5PasswordFile != null) [ "socks5pass:${cfg.socks5PasswordFile}" ];

     

       74
       +
               # Hardening

     

       75
       +
               LockPersonality = true;

     

       76
       +
               MemoryDenyWriteExecute = true;

     

       77
       +
               NoNewPrivileges = true;

     

       78
       +
               PrivateDevices = true;

     

       79
       +
               PrivateMounts = true;

     

       80
       +
               ProtectClock = true;

     

       81
       +
               ProtectControlGroups = true;

     

       82
       +
               ProtectHome = true;

     

       83
       +
               ProtectHostname = true;

     

       84
       +
               ProtectKernelLogs = true;

     

       85
       +
               ProtectKernelModules = true;

     

       86
       +
               ProtectKernelTunables = true;

     

       87
       +
               RemoveIPC = true;

     

       88
       +
               RestrictRealtime = true;

     

       89
       +
               RestrictSUIDSGID = true;

     

       90
       +
               CapabilityBoundingSet = "CAP_NET_BIND_SERVICE";

     

       91
       +
               AmbientCapabilities = "CAP_NET_BIND_SERVICE";

     

       92
       +
               PrivateTmp = "disconnected";

     

       93
       +
               ProcSubset = "pid";

     

       94
       +
               ProtectProc = "invisible";

     

       95
       +
               ProtectSystem = "strict";

     

       96
       +
               RestrictAddressFamilies = [

     

       97
       +
                 "AF_INET"

     

       98
       +
                 "AF_INET6"

     

       99
       +
               ];

     

       100
       +
               RestrictNamespaces = [

     

       101
       +
                 "~cgroup"

     

       102
       +
                 "~ipc"

     

       103
       +
                 "~mnt"

     

       104
       +
                 "~net"

     

       105
       +
                 "~pid"

     

       106
       +
                 "~user"

     

       107
       +
                 "~uts"

     

       108
       +
               ];

     

       109
       +
               SystemCallArchitectures = "native";

     

       110
       +
               SystemCallFilter = [

     

       111
       +
                 "~@clock"

     

       112
       +
                 "~@cpu-emulation"

     

       113
       +
                 "~@debug"

     

       114
       +
                 "~@module"

     

       115
       +
                 "~@mount"

     

       116
       +
                 "~@obsolete"

     

       117
       +
                 "~@privileged"

     

       118
       +
                 "~@raw-io"

     

       119
       +
                 "~@reboot"

     

       120
       +
                 "~@resources"

     

       121
       +
                 "~@swap"

     

       122
       +
               ];

     

       123
       +
               UMask = "0077";

     

       124
       +
             };

     

       125
       +
           };

     

       126
       +
         };

     

       127
       +
         meta.maintainers = [ lib.maintainers.ungeskriptet ];

     

       128
       +
       }

nixos/tests/all-tests.nix

···

       1373
        
         sslh = handleTest ./sslh.nix { };

     

       1374
        
         ssh-agent-auth = runTest ./ssh-agent-auth.nix;

     

       1375
        
         ssh-audit = runTest ./ssh-audit.nix;

     

       0
        
       
     

       1376
        
         sssd = handleTestOn [ "x86_64-linux" "aarch64-linux" ] ./sssd.nix { };

     

       1377
        
         sssd-ldap = handleTestOn [ "x86_64-linux" "aarch64-linux" ] ./sssd-ldap.nix { };

     

       1378
        
         stalwart-mail = runTest ./stalwart/stalwart-mail.nix;

···

       1373
        
         sslh = handleTest ./sslh.nix { };

     

       1374
        
         ssh-agent-auth = runTest ./ssh-agent-auth.nix;

     

       1375
        
         ssh-audit = runTest ./ssh-audit.nix;

     

       1376
       +
         sshwifty = runTest ./web-apps/sshwifty/default.nix;

     

       1377
        
         sssd = handleTestOn [ "x86_64-linux" "aarch64-linux" ] ./sssd.nix { };

     

       1378
        
         sssd-ldap = handleTestOn [ "x86_64-linux" "aarch64-linux" ] ./sssd-ldap.nix { };

     

       1379
        
         stalwart-mail = runTest ./stalwart/stalwart-mail.nix;

+32

nixos/tests/web-apps/sshwifty/default.nix

···

       1
       +
       { lib, pkgs, ... }:

     

       2
       +
       {

     

       3
       +
         name = "sshwifty";

     

       4
       +
       

     

       5
       +
         nodes.machine =

     

       6
       +
           { ... }:

     

       7
       +
           {

     

       8
       +
             services.sshwifty = {

     

       9
       +
               enable = true;

     

       10
       +
               sharedKeyFile = pkgs.writeText "sharedkey" "rpz2E4QI6uPMLr";

     

       11
       +
               settings = {

     

       12
       +
                 HostName = "localhost";

     

       13
       +
                 Servers = [

     

       14
       +
                   {

     

       15
       +
                     ListenInterface = "::1";

     

       16
       +
                     ListenPort = 80;

     

       17
       +
                     ServerMessage = "NixOS test";

     

       18
       +
                   }

     

       19
       +
                 ];

     

       20
       +
               };

     

       21
       +
             };

     

       22
       +
           };

     

       23
       +
       

     

       24
       +
         testScript = ''

     

       25
       +
           machine.wait_for_unit("sshwifty.service")

     

       26
       +
           machine.wait_for_open_port(80)

     

       27
       +
           machine.wait_until_succeeds("curl --fail -6 http://localhost/", timeout=60)

     

       28
       +
           machine.wait_until_succeeds("${lib.getExe pkgs.nodejs} ${./sshwifty-test.js}", timeout=60)

     

       29
       +
         '';

     

       30
       +
       

     

       31
       +
         meta.maintainers = [ lib.maintainers.ungeskriptet ];

     

       32
       +
       }

+83

nixos/tests/web-apps/sshwifty/sshwifty-test.js

···

       1
       +
       #!/usr/bin/env node

     

       2
       +
       /* Based on ui/app.js from Sshwifty. */

     

       3
       +
       const { subtle } = require('node:crypto')

     

       4
       +
       const sshwiftyURL = 'http://localhost/sshwifty/socket/verify'

     

       5
       +
       const sharedKey = 'rpz2E4QI6uPMLr'

     

       6
       +
       const serverMessage = 'NixOS test'

     

       7
       +
       

     

       8
       +
       async function hmac512(secret, data) {

     

       9
       +
         const key = await subtle.importKey(

     

       10
       +
           'raw',

     

       11
       +
           secret,

     

       12
       +
           { name: 'HMAC', hash: { name: 'SHA-512' } },

     

       13
       +
           false,

     

       14
       +
           ['sign', 'verify'],

     

       15
       +
         )

     

       16
       +
         return subtle.sign(key.algorithm, key, data)

     

       17
       +
       }

     

       18
       +
       

     

       19
       +
       async function getSocketAuthKey(privateKey) {

     

       20
       +
         const enc = new TextEncoder(),

     

       21
       +
           rTime = Number(Math.trunc(Date.now() / 100000))

     

       22
       +
         return new Uint8Array(

     

       23
       +
           await hmac512(enc.encode(privateKey), enc.encode(rTime)),

     

       24
       +
         ).slice(0, 32)

     

       25
       +
       }

     

       26
       +
       

     

       27
       +
       async function requestAuth(privateKey) {

     

       28
       +
         const authKey = await getSocketAuthKey(privateKey)

     

       29
       +
         const h = await fetch(sshwiftyURL, {

     

       30
       +
           headers: { 'X-Key': btoa(String.fromCharCode.apply(null, authKey)) },

     

       31
       +
         })

     

       32
       +
         const serverDate = h.headers.get('Date')

     

       33
       +
         return {

     

       34
       +
           result: h.status,

     

       35
       +
           date: serverDate ? new Date(serverDate) : null,

     

       36
       +
           text: await h.text(),

     

       37
       +
         }

     

       38
       +
       }

     

       39
       +
       

     

       40
       +
       async function tryInitialAuth() {

     

       41
       +
         try {

     

       42
       +
           const result = await requestAuth(sharedKey)

     

       43
       +
           if (result.date) {

     

       44
       +
             const serverRespondTime = result.date,

     

       45
       +
               serverRespondTimestamp = serverRespondTime.getTime(),

     

       46
       +
               clientCurrent = new Date(),

     

       47
       +
               clientTimestamp = clientCurrent.getTime(),

     

       48
       +
               timeDiff = Math.abs(serverRespondTimestamp - clientTimestamp)

     

       49
       +
             if (timeDiff > 30000) {

     

       50
       +
               console.log('Time difference between client and server too big.')

     

       51
       +
               process.exit(1)

     

       52
       +
             }

     

       53
       +
           }

     

       54
       +
           switch (result.result) {

     

       55
       +
             case 200:

     

       56
       +
               if (result.text.includes(serverMessage)) {

     

       57
       +
                 console.log('All good.')

     

       58
       +
                 process.exit()

     

       59
       +
               } else {

     

       60
       +
                 console.log('Server message not found')

     

       61
       +
                 process.exit(1)

     

       62
       +
               }

     

       63
       +
               break

     

       64
       +
             case 403:

     

       65
       +
               console.log('We need auth.')

     

       66
       +
               process.exit(1)

     

       67
       +
               break

     

       68
       +
             case 0:

     

       69
       +
               console.log('Timeout?')

     

       70
       +
               process.exit(1)

     

       71
       +
               break

     

       72
       +
             default:

     

       73
       +
               console.log('wghat')

     

       74
       +
               process.exit(1)

     

       75
       +
           }

     

       76
       +
         } catch {

     

       77
       +
           console.log('Something went horribly wrong, ouch.')

     

       78
       +
           process.exit(1)

     

       79
       +
         }

     

       80
       +
       }

     

       81
       +
       

     

       82
       +
       console.log('Testing Sshwifty')

     

       83
       +
       tryInitialAuth()

+5 -1

pkgs/by-name/ss/sshwifty/package.nix

···

       4
        
         buildNpmPackage,

     

       5
        
         fetchFromGitHub,

     

       6
        
         versionCheckHook,

     

       0
        
       
     

       7
        
         nix-update-script,

     

       8
        
         go_1_25,

     

       9
        
       }:

     
···

       52
        
         nativeInstallCheckInputs = [ versionCheckHook ];

     

       53
        
         doInstallCheck = true;

     

       54
        
       

     

       55
       -
         passthru.updateScript = nix-update-script { };

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       56
        
       

     

       57
        
         meta = {

     

       58
        
           description = "WebSSH & WebTelnet client";

···

       4
        
         buildNpmPackage,

     

       5
        
         fetchFromGitHub,

     

       6
        
         versionCheckHook,

     

       7
       +
         nixosTests,

     

       8
        
         nix-update-script,

     

       9
        
         go_1_25,

     

       10
        
       }:

     
···

       53
        
         nativeInstallCheckInputs = [ versionCheckHook ];

     

       54
        
         doInstallCheck = true;

     

       55
        
       

     

       56
       +
         passthru = {

     

       57
       +
           tests = { inherit (nixosTests) sshwifty; };

     

       58
       +
           updateScript = nix-update-script { };

     

       59
       +
         };

     

       60
        
       

     

       61
        
         meta = {

     

       62
        
           description = "WebSSH & WebTelnet client";