git.delta.rocks / jrsonnet / refs/commits / b00d46da7979

1# Shared functions for fleet configuration, available as `fleet` module argument2{ lib }:3let4  inherit (lib.trivial) isFunction functionArgs;5  inherit (lib.options) mkOption mergeOneOption;6  inherit (lib.modules) mkOverride;7  inherit (lib.types)8    listOf9    submodule10    attrsOf11    mkOptionType12    ;13  inherit (lib.strings) optionalString hasPrefix removePrefix;14in15rec {16  types = {17    overlay = mkOptionType {18      name = "nixpkgs-overlay";19      description = "nixpkgs overlay";20      check = {21        __functor = _self: isFunction;22        isV2MergeCoherent = true;23      };24      merge = mergeOneOption;25    };26    listOfOverlay = listOf types.overlay;2728    mkHostsType = module: attrsOf (submodule module);29    mkDataType = module: submodule module;30  };3132  options = {33    mkHostsOption =34      module:35      mkOption {36        type = types.mkHostsType module;37      };38    mkDataOption =39      module:40      mkOption {41        type = types.mkDataType module;42      };43  };4445  inherit (options) mkHostsOption;4647  modules = {48    /**49      Use in places, where fleet might know better than nixpkgs defaults to50    */51    mkFleetDefault = mkOverride 999;52    /**53      Some generators use mkDefault, but optionDefault is set by nixpkgs.54    */55    mkFleetGeneratorDefault = mkOverride 1001;56  };5758  inherit (modules) mkFleetDefault mkFleetGeneratorDefault;5960  secrets = {6162    /**63      Generate a random secret password, 32 ascii characters by default6465      Options:66        size: generated password length in ascii characters (bytes).67        noSymbols: by default, character set includes various special characters ($ , ! + * : ~), and might68                   not be accepted in some contexts, this option switches charset to just [A-Za-z0-9].6970      Output:71        Resulting secret has only part: secret, which contains encrypted password.72    */73    mkPassword =74      {75        size ? 32,76      }:77      (78        {79          coreutils,80          mkSecretGenerator,81        }:82        mkSecretGenerator {83          script = ''84            mkdir $out85            gh generate password -o $out/secret --size ${toString size}86          '';87          parts.secret.encrypted = true;88        }89      );9091    /**92      Generate a random ed25519 keypair9394      Options:95        noEmbedPublic: By default, secret key also embeds public key in itself ("extended" format, 64 bytes)96                       When noEmbedPublis is enabled - only the private scalar is included.97        encoding: Encoring of public and secret parts, can be "raw" (default), "base64" or "hex".9899      Output:100        Resulting secret has two parts: public and secret, where the secret part is encrypted.101102      This secret format is used by e.g Garage S3 server103    */104    mkEd25519 =105      {106        noEmbedPublic ? false,107        encoding ? null,108      }:109      (110        { mkSecretGenerator }:111        mkSecretGenerator {112          script = ''113            mkdir $out114            gh generate ed25519 -p $out/public -s $out/secret \115              ${optionalString noEmbedPublic "--no-embed-public"} \116              ${optionalString (encoding != null) "--encoding=${encoding}"}117          '';118          parts.secret.encrypted = true;119          parts.public.encrypted = false;120        }121      );122123    /**124      Generate a random x25519 keypair125126      Options:127        encoding: Encoring of public and secret parts, can be "raw" (default), "base64" or "hex".128129      Output:130        Resulting secret has two parts: public and secret, where the secret part is encrypted.131132      This secret format is used by e.g Wireguard VPN for peers (base64-encoded)133    */134    mkX25519 =135      {136        encoding ? null,137      }:138      (139        { mkSecretGenerator }:140        mkSecretGenerator {141          script = ''142            mkdir $out143            gh generate x25519 -p $out/public -s $out/secret \144              ${optionalString (encoding != null) "--encoding=${encoding}"}145          '';146147          parts.secret.encrypted = true;148          parts.public.encrypted = false;149        }150      );151152    /**153      Generate a random RSA keypair154155      Options:156        size: RSA key size, 4096 by default157158      Output:159        Resulting secret has two parts: public and secret, where the secret part is encrypted.160        Both parts are PEM encoded.161    */162    mkRsa =163      {164        size ? 4096,165      }:166      (167        {168          openssl,169          mkSecretGenerator,170        }:171        mkSecretGenerator {172          script = ''173            mkdir $out174175            ${openssl}/bin/openssl genrsa -out rsa_private.key ${toString size}176            ${openssl}/bin/openssl rsa -in rsa_private.key -pubout -out rsa_public.key177178            cat rsa_private.key | gh private -o $out/secret179            cat rsa_public.key | gh public -o $out/public180          '';181182          parts.secret.encrypted = true;183          parts.public.encrypted = false;184        }185      );186187    /**188      Generate a random byte sequence189190      Options:191        size: generated password length in bytes, 32 by default.192        encoding: how the generated bytes should be encoded, "raw" (default), "hex" or "base64"193        noNuls: prevent output byte sequence from containing internal \0, useful for some C applications194                that can't handle their strings properly.195196      Output:197        Resulting secret has only part: secret, which contains encrypted bytes.198199      Might be used for e.g. Wireguard VPN PSK keys (base64-encoded)200    */201    mkBytes =202      {203        count ? 32,204        encoding,205        noNuls ? false,206      }:207      (208        { mkSecretGenerator }:209        mkSecretGenerator {210          script = ''211            mkdir $out212            gh generate bytes --count=${toString count} --encoding=${encoding} -o $out/secret \213              ${optionalString noNuls "--no-nuls"}214          '';215          parts.secret.encrypted = true;216        }217      );218    /**219      Shorthand for `mkBytes`, which defaults to "hex" encoding220    */221    mkHexBytes =222      {223        count ? 32,224      }:225      mkBytes {226        inherit count;227        encoding = "hex";228      };229    /**230      Shorthand for `mkBytes`, which defaults to "base64" encoding231    */232    mkBase64Bytes =233      {234        count ? 32,235      }:236      mkBytes {237        inherit count;238        encoding = "base64";239      };240241    # Wireguard242    # mkWireguard = {}: mkX25519 {encoding = "base64";};243    # mkWireguardPsk = {}: mkBase64Bytes {count = 32;};244  };245246  inherit (secrets)247    mkPassword248    mkEd25519249    mkX25519250    mkRsa251    mkBytes252    mkHexBytes253    mkBase64Bytes254    ;255256  strings =257    let258      plaintextPrefix = "<PLAINTEXT>";259      plaintextNewlinePrefix = "<PLAINTEXT-NL>";260    in261    {262      /**263        Decode public secret part into string264      */265      decodeRawSecret =266        raw:267        if hasPrefix plaintextPrefix raw then268          removePrefix plaintextPrefix raw269        else if hasPrefix plaintextNewlinePrefix raw then270          removePrefix plaintextNewlinePrefix raw271        else272          throw "decodeRawSecret only works with plaintext-encoded secret public parts, got ${raw}";273    };274275  inherit (strings) decodeRawSecret;276}