pkgs/servers/frr/default.nix

   1 { lib
   2 , stdenv
   3 , fetchFromGitHub
   4
   5 # build time
   6 , autoreconfHook
   7 , flex
   8 , bison
   9 , perl
  10 , pkg-config
  11 , texinfo
  12 , buildPackages
  13
  14 # runtime
  15 , c-ares
  16 , json_c
  17 , libcap
  18 , elfutils
  19 , libunwind
  20 , libyang
  21 , net-snmp
  22 , openssl
  23 , pam
  24 , pcre2
  25 , python3
  26 , readline
  27 , rtrlib
  28 , protobufc
  29
  30 # tests
  31 , nettools
  32 , nixosTests
  33
  34 # FRR's configure.ac gets SNMP options by executing net-snmp-config on the build host
  35 # This leads to compilation errors when cross compiling.
  36 # E.g. net-snmp-config for x86_64 does not return the ARM64 paths.
  37 #
  38 #   SNMP_LIBS="`${NETSNMP_CONFIG} --agent-libs`"
  39 #   SNMP_CFLAGS="`${NETSNMP_CONFIG} --base-cflags`"
  40 , snmpSupport ? stdenv.buildPlatform.canExecute stdenv.hostPlatform
  41
  42 # other general options besides snmp support
  43 , rpkiSupport ? true
  44 , numMultipath ? 64
  45 , watchfrrSupport ? true
  46 , cumulusSupport ? false
  47 , datacenterSupport ? true
  48 , rtadvSupport ? true
  49 , irdpSupport ? true
  50 , routeReplacementSupport ? true
  51 , mgmtdSupport ? true
  52
  53 # routing daemon options
  54 , bgpdSupport ? true
  55 , ripdSupport ? true
  56 , ripngdSupport ? true
  57 , ospfdSupport ? true
  58 , ospf6dSupport ? true
  59 , ldpdSupport ? true
  60 , nhrpdSupport ? true
  61 , eigrpdSupport ? true
  62 , babeldSupport ? true
  63 , isisdSupport ? true
  64 , pimdSupport ? true
  65 , pim6dSupport ? true
  66 , sharpdSupport ? true
  67 , fabricdSupport ? true
  68 , vrrpdSupport ? true
  69 , pathdSupport ? true
  70 , bfddSupport ? true
  71 , pbrdSupport ? true
  72 , staticdSupport ? true
  73
  74 # BGP options
  75 , bgpAnnounce ? true
  76 , bgpBmp ? true
  77 , bgpVnc ? true
  78
  79 # OSPF options
  80 , ospfApi ? true
  81 }:
  82
  83 lib.warnIf (!(stdenv.buildPlatform.canExecute stdenv.hostPlatform))
  84   "cannot enable SNMP support due to cross-compilation issues with net-snmp-config"
  85
  86 stdenv.mkDerivation rec {
  87   pname = "frr";
  88   version = "10.0.1";
  89
  90   src = fetchFromGitHub {
  91     owner = "FRRouting";
  92     repo = pname;
  93     rev = "${pname}-${version}";
  94     hash = "sha256-bY5SSF/fmKQc8ECPik0v/ZlUiFsbZhwG2C5pbmoMzwQ=";
  95   };
  96
  97   nativeBuildInputs = [
  98     autoreconfHook
  99     bison
 100     flex
 101     perl
 102     pkg-config
 103     python3.pkgs.sphinx
 104     texinfo
 105     protobufc
 106   ];
 107
 108   buildInputs = [
 109     c-ares
 110     json_c
 111     libunwind
 112     libyang
 113     openssl
 114     pam
 115     pcre2
 116     python3
 117     readline
 118     rtrlib
 119     protobufc
 120   ] ++ lib.optionals stdenv.isLinux [
 121     libcap
 122   ] ++ lib.optionals snmpSupport [
 123     net-snmp
 124   ] ++ lib.optionals (lib.meta.availableOn stdenv.hostPlatform elfutils) [
 125     elfutils
 126   ];
 127
 128   # otherwise in cross-compilation: "configure: error: no working python version found"
 129   depsBuildBuild = [
 130     buildPackages.python3
 131   ];
 132
 133   # cross-compiling: clippy is compiled with the build host toolchain, split it out to ease
 134   # navigation in dependency hell
 135   clippy-helper = buildPackages.callPackage ./clippy-helper.nix { frrVersion = version; frrSource = src; };
 136
 137   configureFlags = [
 138     "--disable-silent-rules"
 139     "--disable-exampledir"
 140     "--enable-configfile-mask=0640"
 141     "--enable-group=frr"
 142     "--enable-logfile-mask=0640"
 143     "--enable-multipath=${toString numMultipath}"
 144     "--enable-user=frr"
 145     "--enable-vty-group=frrvty"
 146     "--localstatedir=/run/frr"
 147     "--sbindir=$(out)/libexec/frr"
 148     "--sysconfdir=/etc/frr"
 149     "--with-clippy=${clippy-helper}/bin/clippy"
 150     # general options
 151     (lib.strings.enableFeature snmpSupport "snmp")
 152     (lib.strings.enableFeature rpkiSupport "rpki")
 153     (lib.strings.enableFeature watchfrrSupport "watchfrr")
 154     (lib.strings.enableFeature rtadvSupport "rtadv")
 155     (lib.strings.enableFeature irdpSupport "irdp")
 156     (lib.strings.enableFeature routeReplacementSupport "rr-semantics")
 157     (lib.strings.enableFeature mgmtdSupport "mgmtd")
 158
 159     # routing protocols
 160     (lib.strings.enableFeature bgpdSupport "bgpd")
 161     (lib.strings.enableFeature ripdSupport "ripd")
 162     (lib.strings.enableFeature ripngdSupport "ripngd")
 163     (lib.strings.enableFeature ospfdSupport "ospfd")
 164     (lib.strings.enableFeature ospf6dSupport "ospf6d")
 165     (lib.strings.enableFeature ldpdSupport "ldpd")
 166     (lib.strings.enableFeature nhrpdSupport "nhrpd")
 167     (lib.strings.enableFeature eigrpdSupport "eigrpd")
 168     (lib.strings.enableFeature babeldSupport "babeld")
 169     (lib.strings.enableFeature isisdSupport "isisd")
 170     (lib.strings.enableFeature pimdSupport "pimd")
 171     (lib.strings.enableFeature pim6dSupport "pim6d")
 172     (lib.strings.enableFeature sharpdSupport "sharpd")
 173     (lib.strings.enableFeature fabricdSupport "fabricd")
 174     (lib.strings.enableFeature vrrpdSupport "vrrpd")
 175     (lib.strings.enableFeature pathdSupport "pathd")
 176     (lib.strings.enableFeature bfddSupport "bfdd")
 177     (lib.strings.enableFeature pbrdSupport "pbrd")
 178     (lib.strings.enableFeature staticdSupport "staticd")
 179     # BGP options
 180     (lib.strings.enableFeature bgpAnnounce "bgp-announce")
 181     (lib.strings.enableFeature bgpBmp "bgp-bmp")
 182     (lib.strings.enableFeature bgpVnc "bgp-vnc")
 183     # OSPF options
 184     (lib.strings.enableFeature ospfApi "ospfapi")
 185     # Cumulus options
 186     (lib.strings.enableFeature cumulusSupport "cumulus")
 187     # Datacenter options
 188     (lib.strings.enableFeature datacenterSupport "datacenter")
 189   ];
 190
 191   postPatch = ''
 192     substituteInPlace tools/frr-reload \
 193       --replace /usr/lib/frr/ $out/libexec/frr/
 194   '';
 195
 196   doCheck = true;
 197
 198   nativeCheckInputs = [
 199     nettools
 200     python3.pkgs.pytest
 201   ];
 202
 203   enableParallelBuilding = true;
 204
 205   meta = with lib; {
 206     homepage = "https://frrouting.org/";
 207     description = "FRR BGP/OSPF/ISIS/RIP/RIPNG routing daemon suite";
 208     longDescription = ''
 209       FRRouting (FRR) is a free and open source Internet routing protocol suite
 210       for Linux and Unix platforms. It implements BGP, OSPF, RIP, IS-IS, PIM,
 211       LDP, BFD, Babel, PBR, OpenFabric and VRRP, with alpha support for EIGRP
 212       and NHRP.
 213
 214       FRR’s seamless integration with native Linux/Unix IP networking stacks
 215       makes it a general purpose routing stack applicable to a wide variety of
 216       use cases including connecting hosts/VMs/containers to the network,
 217       advertising network services, LAN switching and routing, Internet access
 218       routers, and Internet peering.
 219
 220       FRR has its roots in the Quagga project. In fact, it was started by many
 221       long-time Quagga developers who combined their efforts to improve on
 222       Quagga’s well-established foundation in order to create the best routing
 223       protocol stack available. We invite you to participate in the FRRouting
 224       community and help shape the future of networking.
 225
 226       Join the ranks of network architects using FRR for ISPs, SaaS
 227       infrastructure, web 2.0 businesses, hyperscale services, and Fortune 500
 228       private clouds.
 229     '';
 230     license = with licenses; [ gpl2Plus lgpl21Plus ];
 231     maintainers = with maintainers; [ woffs thillux ];
 232     # adapt to platforms stated in http://docs.frrouting.org/en/latest/overview.html#supported-platforms
 233     platforms = (platforms.linux ++ platforms.freebsd ++ platforms.netbsd ++ platforms.openbsd);
 234   };
 235
 236   passthru.tests = { inherit (nixosTests) frr; };
 237 }