nixpkgs/pkgs/development/libraries/quictls/default.nix

{ lib, stdenv, fetchurl, buildPackages, perl, coreutils, fetchFromGitHub
, withCryptodev ? false, cryptodev
, enableSSL2 ? false
, enableSSL3 ? false
, static ? stdenv.hostPlatform.isStatic
# Used to avoid cross compiling perl, for example, in darwin bootstrap tools.
# This will cause c_rehash to refer to perl via the environment, but otherwise
# will produce a perfectly functional openssl binary and library.
, withPerl ? stdenv.hostPlatform == stdenv.buildPlatform
, removeReferencesTo
}:

stdenv.mkDerivation rec {
  pname = "quictls";
  version = "3.0.5+quick_unstable-2022-07.05";

  src = fetchFromGitHub {
    owner = "quictls";
    repo = "openssl";
    rev = "75e940831d0570d6b020cfebf128ae500f424867";
    sha256 = "sha256-1HBGKafcCbM0RZWLvyl3vpSfGBsAcGDgjz1Nm/qclWM=";
  };

  patches = [
    ../openssl/3.0/nix-ssl-cert-file.patch

    # openssl will only compile in KTLS if the current kernel supports it.
    # This patch disables build-time detection.
    ../openssl/3.0/openssl-disable-kernel-detection.patch

    (if stdenv.hostPlatform.isDarwin
      then ../openssl/use-etc-ssl-certs-darwin.patch
      else ../openssl/use-etc-ssl-certs.patch)
  ];

  postPatch = ''
    patchShebangs Configure
  ''
  # config is a configure script which is not installed.
  + ''
    substituteInPlace config --replace '/usr/bin/env' '${buildPackages.coreutils}/bin/env'
  '' + lib.optionalString stdenv.hostPlatform.isMusl ''
    substituteInPlace crypto/async/arch/async_posix.h \
      --replace '!defined(__ANDROID__) && !defined(__OpenBSD__)' \
                '!defined(__ANDROID__) && !defined(__OpenBSD__) && 0'
  '';

  outputs = [ "bin" "dev" "out" "man" "doc" ];
  setOutputFlags = false;
  separateDebugInfo =
    !stdenv.hostPlatform.isDarwin &&
    !(stdenv.hostPlatform.useLLVM or false) &&
    stdenv.cc.isGNU;

  nativeBuildInputs = [ perl removeReferencesTo ];
  buildInputs = lib.optional withCryptodev cryptodev
    # perl is included to allow the interpreter path fixup hook to set the
    # correct interpreter in c_rehash.
    ++ lib.optional withPerl perl;

  # TODO(@Ericson2314): Improve with mass rebuild
  configurePlatforms = [];
  configureScript = {
      armv5tel-linux = "./Configure linux-armv4 -march=armv5te";
      armv6l-linux = "./Configure linux-armv4 -march=armv6";
      armv7l-linux = "./Configure linux-armv4 -march=armv7-a";
      x86_64-darwin  = "./Configure darwin64-x86_64-cc";
      aarch64-darwin = "./Configure darwin64-arm64-cc";
      x86_64-linux = "./Configure linux-x86_64";
      x86_64-solaris = "./Configure solaris64-x86_64-gcc";
      riscv64-linux = "./Configure linux64-riscv64";
      mips64el-linux =
        if stdenv.hostPlatform.isMips64n64
        then "./Configure linux64-mips64"
        else if stdenv.hostPlatform.isMips64n32
        then "./Configure linux-mips64"
        else throw "unsupported ABI for ${stdenv.hostPlatform.system}";
    }.${stdenv.hostPlatform.system} or (
      if stdenv.hostPlatform == stdenv.buildPlatform
        then "./config"
      else if stdenv.hostPlatform.isBSD && stdenv.hostPlatform.isx86_64
        then "./Configure BSD-x86_64"
      else if stdenv.hostPlatform.isBSD && stdenv.hostPlatform.isx86_32
        then "./Configure BSD-x86" + lib.optionalString (stdenv.hostPlatform.parsed.kernel.execFormat.name == "elf") "-elf"
      else if stdenv.hostPlatform.isBSD
        then "./Configure BSD-generic${toString stdenv.hostPlatform.parsed.cpu.bits}"
      else if stdenv.hostPlatform.isMinGW
        then "./Configure mingw${lib.optionalString
                                   (stdenv.hostPlatform.parsed.cpu.bits != 32)
                                   (toString stdenv.hostPlatform.parsed.cpu.bits)}"
      else if stdenv.hostPlatform.isLinux
        then "./Configure linux-generic${toString stdenv.hostPlatform.parsed.cpu.bits}"
      else if stdenv.hostPlatform.isiOS
        then "./Configure ios${toString stdenv.hostPlatform.parsed.cpu.bits}-cross"
      else
        throw "Not sure what configuration to use for ${stdenv.hostPlatform.config}"
    );

  # OpenSSL doesn't like the `--enable-static` / `--disable-shared` flags.
  dontAddStaticConfigureFlags = true;
  configureFlags = [
    "shared" # "shared" builds both shared and static libraries
    "--libdir=lib"
    "--openssldir=etc/ssl"
    "enable-ktls"
  ] ++ lib.optionals withCryptodev [
    "-DHAVE_CRYPTODEV"
    "-DUSE_CRYPTODEV_DIGESTS"
  ] ++ lib.optional enableSSL2 "enable-ssl2"
    ++ lib.optional enableSSL3 "enable-ssl3"
    ++ lib.optional stdenv.hostPlatform.isAarch64 "no-afalgeng"
    # OpenSSL needs a specific `no-shared` configure flag.
    # See https://wiki.openssl.org/index.php/Compilation_and_Installation#Configure_Options
    # for a comprehensive list of configuration options.
    ++ lib.optional static "no-shared"
    # This introduces a reference to the CTLOG_FILE which is undesired when
    # trying to build binaries statically.
    ++ lib.optional static "no-ct"
    ;

  makeFlags = [
    "MANDIR=$(man)/share/man"
    # This avoids conflicts between man pages of openssl subcommands (for
    # example 'ts' and 'err') man pages and their equivalent top-level
    # command in other packages (respectively man-pages and moreutils).
    # This is done in ubuntu and archlinux, and possiibly many other distros.
    "MANSUFFIX=ssl"
  ];

  enableParallelBuilding = true;

  postInstall = (if static then ''
    # OPENSSLDIR has a reference to self
    ${removeReferencesTo}/bin/remove-references-to -t $out $out/lib/*.a
  '' else ''
    # If we're building dynamic libraries, then don't install static
    # libraries.
    if [ -n "$(echo $out/lib/*.so $out/lib/*.dylib $out/lib/*.dll)" ]; then
        rm "$out/lib/"*.a
    fi
  '') + lib.optionalString (!stdenv.hostPlatform.isWindows)
    # Fix bin/c_rehash's perl interpreter line
    #
    # - openssl 1_0_2: embeds a reference to buildPackages.perl
    # - openssl 1_1:   emits "#!/usr/bin/env perl"
    #
    # In the case of openssl_1_0_2, reset the invalid reference and let the
    # interpreter hook take care of it.
    #
    # In both cases, if withPerl = false, the intepreter line is expected be
    # "#!/usr/bin/env perl"
  ''
    substituteInPlace $out/bin/c_rehash --replace ${buildPackages.perl}/bin/perl "/usr/bin/env perl"
  '' + ''
    mkdir -p $bin
    mv $out/bin $bin/bin
    mkdir $dev
    mv $out/include $dev/
    # remove dependency on Perl at runtime
    rm -r $out/etc/ssl/misc
    rmdir $out/etc/ssl/{certs,private}
  '';

  postFixup = lib.optionalString (!stdenv.hostPlatform.isWindows) ''
    # Check to make sure the main output doesn't depend on perl
    if grep -r '${buildPackages.perl}' $out; then
      echo "Found an erroneous dependency on perl ^^^" >&2
      exit 1
    fi
  '';

  meta = with lib; {
    homepage = "https://quictls.github.io";
    description = "TLS/SSL and crypto library with QUIC APIs";
    license = licenses.openssl;
    platforms = platforms.all;
    maintainers = with maintainers; [ izorkin ];
  };
}