Linux tests on master 
Windows tests on master 
Macos tests on master 
(c) 2022- Marten Richter
The package provides Webtransport support to node.js .
This package is part of FAILS. A web based lecture system developed out of university lectures.
While FAILS as a whole is licensed via GNU Affero GPL version 3.0, this package is licensed under a BSD-style license that can be found in the LICENSE file, while code taken from other projects is still under their respective license (see LICENSE file for details). This package is licensed more permissive, since it can be useful outside of the FAILS environment.
This module is a C++ node binding to libquiche https://github.com/google/quiche(note there is a second library with a similar purpose and the same name), which provides besides other network protocols HTTP/3 support.
This packages currently only provides support for HTTP/3 WebTransport with an interface similar to the browser side (but not all features implemented), for server as well as for client, see test/test.js, test/testsuite.js, test/echoclient.js, test/echoserver.js for examples.
Note, the client implementation only supports certificates checking via certificateHashes.
It may be possible in the future to also support normal HTTP/3 not so much effort, however there is no intention from the author to implement this, since it will not be needed by FAILS. However PR request are welcome and will be supported by advise from the author.
The package should be considered as a ducttape style solution, until a bullet proof native support of HTTP/3 and WebTransport is provided by node itself.
If you need a ponyfill checkout the sister package https://github.com/fails-components/webtransport-ponyfill-websocket/, that provides a mapping of the Webtransport interfaces to Websocket connections.
You can install the package directly via npm from node.js or github packages:
npm install @fails-components/webtransportIn case of github packages, please add to your .npmrc file
@fails-components:registry=https://npm.pkg.github.com
In this case you need to be authenticated against github.
The package provides prebuild binaries for windows, linux and macos for the platform x64 and ia32 (only windows).
Other platforms may be possible via crosscompiling in the github actions, if someone needs this, PRs are welcome.
Of course you can also build the binary on your system.
If you are running the compiling install as root, you need to use --unsafe-perm as flag.
Installing the package without prebuild requires a full building environment including clang-9, perl6, python, golang, ninja-build, icu. See the Dockerfile or Dockerfile.development for required debian packages.
This should work for Windows, linux and Mac OS X.
(You may want to check out the building dependencies (especially for windows) for BoringSSl, zlib, abseil on their respective websites).
Of course, PR for patches and for compiling instructions and necessary changes are welcome for all possible environments.
** Warning the build time takes more than 15 minutes, on windows even longer! (Due to the building of the third party libraries). **
In the directory test you find a simple echo server code. That answers to a series of WebTransport echos. Furthermore some example browser code and finally a unit test of the library including certificate generation.
When testing remember you might need to start chromium based browser with certain flags to accept your http/3 certificate with errors, e.g.:
chrome --ignore-certificate-errors-spki-list=FINGERPRINTOFYOURCERTIFICATE --ignore-certificate-errors --v=2 --enable-logging=stderr --origin-to-force-quic-on=192.168.1.50:8080
of course replace IP and fingerprint of your certificate accordingly.
This module implements parts of the WebTransport spec but not all of it.
The types from the W3C Working Draft have been added to lib/dom.ts but some fields are commented out.
These fields are unimplemented by this module at this time. Some may be implemented in the future, others are legacy fields that may be removed from the spec. PRs are welcome!
They are: