@fails-components/webtransport 1.1.3 → 1.2.0

package/test/datagrams.spec.js

@@ -1,104 +0,0 @@
-/* eslint-env mocha */
-
-import WebTransport from './fixtures/webtransport.js'
-import { expect } from './fixtures/chai.js'
-import { readStream } from './fixtures/read-stream.js'
-import { readCertHash } from './fixtures/read-cert-hash.js'
-import { pTimeout } from './fixtures/p-timeout.js'
-import { quicheLoaded } from './fixtures/quiche.js'
-
-/**
- * @template T
- * @typedef {import('../lib/types').Deferred<T>} Deferred<T>
- */
-
-describe('datagrams', function () {
-  /** @type {import('../lib/dom').WebTransport | undefined} */
-  let client
-  let forceReliable = false
-  if (process.env.USE_HTTP2 === 'true') forceReliable = true
-
-  const wtOptions = {
-    serverCertificateHashes: [
-      {
-        algorithm: 'sha-256',
-        value: readCertHash(process.env.CERT_HASH)
-      }
-    ],
-    // @ts-ignore
-    forceReliable
-  }
-
-  if (process.env.NO_CERT_HASHES === 'true')
-    // @ts-ignore
-    delete wtOptions.serverCertificateHashes
-
-  // @ts-ignore
-  beforeEach(async () => {
-    if (
-      process.env.USE_HTTP2 !== 'true' &&
-      process.env.USE_PONYFILL !== 'true' &&
-      process.env.USE_POLYFILL !== 'true'
-    ) {
-      await quicheLoaded
-    }
-  })
-
-  // @ts-ignore
-  afterEach(async () => {
-    if (client != null) {
-      client.close()
-      client = undefined
-    }
-  })
-  it('client sends datagrams to the server', async () => {
-    // client context - connects to the server, sends some datagrams and reads the response
-    client = new WebTransport(
-      `${process.env.SERVER_URL}/datagrams_client_send`,
-      wtOptions
-    )
-    await client.ready
-
-    const writer = client.datagrams.writable.getWriter()
-    let closed = false
-
-    // write datagrams until the server receives one and closes the connection
-    // eslint-disable-next-line promise/catch-or-return
-    Promise.resolve().then(async () => {
-      while (!closed) {
-        try {
-          await writer.ready
-          await writer.write(Uint8Array.from([0, 1, 2, 3, 4]))
-          await new Promise((resolve) => setTimeout(resolve, 100))
-        } catch {
-          // the session can be closed while we are writing
-        }
-      }
-    })
-
-    const result = await client.closed
-    closed = true
-
-    // should receive the default close info
-    expect(result).to.have.property('reason', '')
-    expect(result).to.have.property('closeCode', 0)
-  })
-
-  it('receives datagrams from the server', async () => {
-    // client context - pipes the server's datagrams back to them
-    client = new WebTransport(
-      `${process.env.SERVER_URL}/datagrams_server_send`,
-      wtOptions
-    )
-    await client.ready
-
-    // datagram transport is unreliable, at least one message should make it through
-    const expected = 1
-
-    const received = await pTimeout(
-      readStream(client.datagrams.readable, expected),
-      1000
-    )
-    expect(received).to.have.lengthOf(expected)
-  })
-})

package/test/fixtures/certificate.js

@@ -1,456 +0,0 @@
-// Copyright (c) 2022 Marten Richter or other contributers (see commit). All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-// large portions taken from selfsigned with the following Copyright and license
-/* MIT License
-
-Copyright (c) 2013 José F. Romaniello
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-*/
-
-// also large portions taken from the node-forge project licensed under
-/* New BSD License (3-clause)
-Copyright (c) 2010, Digital Bazaar, Inc.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of Digital Bazaar, Inc. nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL DIGITAL BAZAAR BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
-
-// @ts-expect-error node-forge has no types and @types/node-forge do not include oids
-import forge from 'node-forge'
-import { webcrypto as crypto, X509Certificate } from 'crypto'
-
-const { pki, asn1, oids } = forge
-// taken from node-forge
-/**
- * Converts an X.509 subject or issuer to an ASN.1 RDNSequence.
- *
- * @param {any} obj the subject or issuer (distinguished name).
- *
- * @return the ASN.1 RDNSequence.
- */
-function _dnToAsn1(obj) {
-  // create an empty RDNSequence
-  const rval = asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SEQUENCE, true, [])
-
-  // iterate over attributes
-  let attr, set
-  const attrs = obj.attributes
-  for (let i = 0; i < attrs.length; ++i) {
-    attr = attrs[i]
-    let value = attr.value
-
-    // reuse tag class for attribute value if available
-    let valueTagClass = asn1.Type.PRINTABLESTRING
-    if ('valueTagClass' in attr) {
-      valueTagClass = attr.valueTagClass
-
-      if (valueTagClass === asn1.Type.UTF8) {
-        value = forge.util.encodeUtf8(value)
-      }
-      // FIXME: handle more encodings
-    }
-
-    // create a RelativeDistinguishedName set
-    // each value in the set is an AttributeTypeAndValue first
-    // containing the type (an OID) and second the value
-    set = asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SET, true, [
-      asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SEQUENCE, true, [
-        // AttributeType
-        asn1.create(
-          asn1.Class.UNIVERSAL,
-          asn1.Type.OID,
-          false,
-          asn1.oidToDer(attr.type).getBytes()
-        ),
-        // AttributeValue
-        asn1.create(asn1.Class.UNIVERSAL, valueTagClass, false, value)
-      ])
-    ])
-    rval.value.push(set)
-  }
-
-  return rval
-}
-
-const jan_1_1950 = new Date('1950-01-01T00:00:00Z') // eslint-disable-line camelcase
-const jan_1_2050 = new Date('2050-01-01T00:00:00Z') // eslint-disable-line camelcase
-// taken from node-forge almost not modified
-/**
- * Converts a Date object to ASN.1
- * Handles the different format before and after 1st January 2050
- *
- * @param {Date} date date object.
- *
- * @return the ASN.1 object representing the date.
- */
-function _dateToAsn1(date) {
-  // eslint-disable-next-line camelcase
-  if (date >= jan_1_1950 && date < jan_1_2050) {
-    return asn1.create(
-      asn1.Class.UNIVERSAL,
-      asn1.Type.UTCTIME,
-      false,
-      asn1.dateToUtcTime(date)
-    )
-  } else {
-    return asn1.create(
-      asn1.Class.UNIVERSAL,
-      asn1.Type.GENERALIZEDTIME,
-      false,
-      asn1.dateToGeneralizedTime(date)
-    )
-  }
-}
-
-// taken from node-forge almost not modified
-/**
- * Convert signature parameters object to ASN.1
- *
- * @param {string} oid Signature algorithm OID
- * @param {any} params The signature parameters object
- * @return ASN.1 object representing signature parameters
- */
-function _signatureParametersToAsn1(oid, params) {
-  const parts = []
-
-  switch (oid) {
-    case oids['RSASSA-PSS']:
-      if (params.hash.algorithmOid !== undefined) {
-        parts.push(
-          asn1.create(asn1.Class.CONTEXT_SPECIFIC, 0, true, [
-            asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SEQUENCE, true, [
-              asn1.create(
-                asn1.Class.UNIVERSAL,
-                asn1.Type.OID,
-                false,
-                asn1.oidToDer(params.hash.algorithmOid).getBytes()
-              ),
-              asn1.create(asn1.Class.UNIVERSAL, asn1.Type.NULL, false, '')
-            ])
-          ])
-        )
-      }
-
-      if (params.mgf.algorithmOid !== undefined) {
-        parts.push(
-          asn1.create(asn1.Class.CONTEXT_SPECIFIC, 1, true, [
-            asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SEQUENCE, true, [
-              asn1.create(
-                asn1.Class.UNIVERSAL,
-                asn1.Type.OID,
-                false,
-                asn1.oidToDer(params.mgf.algorithmOid).getBytes()
-              ),
-              asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SEQUENCE, true, [
-                asn1.create(
-                  asn1.Class.UNIVERSAL,
-                  asn1.Type.OID,
-                  false,
-                  asn1.oidToDer(params.mgf.hash.algorithmOid).getBytes()
-                ),
-                asn1.create(asn1.Class.UNIVERSAL, asn1.Type.NULL, false, '')
-              ])
-            ])
-          ])
-        )
-      }
-
-      if (params.saltLength !== undefined) {
-        parts.push(
-          asn1.create(asn1.Class.CONTEXT_SPECIFIC, 2, true, [
-            asn1.create(
-              asn1.Class.UNIVERSAL,
-              asn1.Type.INTEGER,
-              false,
-              asn1.integerToDer(params.saltLength).getBytes()
-            )
-          ])
-        )
-      }
-
-      return asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SEQUENCE, true, parts)
-
-    default:
-      return asn1.create(asn1.Class.UNIVERSAL, asn1.Type.NULL, false, '')
-  }
-}
-
-// taken from node-forge and modified to work with ECDSA
-/**
- * Gets the ASN.1 TBSCertificate part of an X.509v3 certificate.
- *
- * @param {any} cert the certificate.
- *
- * @return the asn1 TBSCertificate.
- */
-function getTBSCertificate(cert) {
-  // TBSCertificate
-  const notBefore = _dateToAsn1(cert.validity.notBefore)
-  const notAfter = _dateToAsn1(cert.validity.notAfter)
-
-  const tbs = asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SEQUENCE, true, [
-    // version
-    asn1.create(asn1.Class.CONTEXT_SPECIFIC, 0, true, [
-      // integer
-      asn1.create(
-        asn1.Class.UNIVERSAL,
-        asn1.Type.INTEGER,
-        false,
-        asn1.integerToDer(cert.version).getBytes()
-      )
-    ]),
-    // serialNumber
-    asn1.create(
-      asn1.Class.UNIVERSAL,
-      asn1.Type.INTEGER,
-      false,
-      forge.util.hexToBytes(cert.serialNumber)
-    ),
-    // signature
-    asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SEQUENCE, true, [
-      // algorithm
-      asn1.create(
-        asn1.Class.UNIVERSAL,
-        asn1.Type.OID,
-        false,
-        asn1.oidToDer(cert.siginfo.algorithmOid).getBytes()
-      ),
-      // parameters
-      _signatureParametersToAsn1(
-        cert.siginfo.algorithmOid,
-        cert.siginfo.parameters
-      )
-    ]),
-    // issuer
-    _dnToAsn1(cert.issuer),
-    // validity
-    asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SEQUENCE, true, [
-      notBefore,
-      notAfter
-    ]),
-    // subject
-    _dnToAsn1(cert.subject),
-    // SubjectPublicKeyInfo
-    // here comes our modification, we are other objects here
-    asn1.fromDer(
-      new forge.util.ByteBuffer(
-        cert.publicKey
-      ) /* is in already SPKI format but in DER encoding */
-    )
-  ])
-
-  if (cert.issuer.uniqueId) {
-    // issuerUniqueID (optional)
-    tbs.value.push(
-      asn1.create(asn1.Class.CONTEXT_SPECIFIC, 1, true, [
-        asn1.create(
-          asn1.Class.UNIVERSAL,
-          asn1.Type.BITSTRING,
-          false,
-          // TODO: support arbitrary bit length ids
-          String.fromCharCode(0x00) + cert.issuer.uniqueId
-        )
-      ])
-    )
-  }
-  if (cert.subject.uniqueId) {
-    // subjectUniqueID (optional)
-    tbs.value.push(
-      asn1.create(asn1.Class.CONTEXT_SPECIFIC, 2, true, [
-        asn1.create(
-          asn1.Class.UNIVERSAL,
-          asn1.Type.BITSTRING,
-          false,
-          // TODO: support arbitrary bit length ids
-          String.fromCharCode(0x00) + cert.subject.uniqueId
-        )
-      ])
-    )
-  }
-
-  if (cert.extensions.length > 0) {
-    // extensions (optional)
-    tbs.value.push(pki.certificateExtensionsToAsn1(cert.extensions))
-  }
-
-  return tbs
-}
-
-// function taken form selfsigned
-// a hexString is considered negative if it's most significant bit is 1
-// because serial numbers use ones' complement notation
-// this RFC in section 4.1.2.2 requires serial numbers to be positive
-// http://www.ietf.org/rfc/rfc5280.txt
-/**
- * @param {string} hexString
- * @returns
- */
-function toPositiveHex(hexString) {
-  let mostSiginficativeHexAsInt = parseInt(hexString[0], 16)
-  if (mostSiginficativeHexAsInt < 8) {
-    return hexString
-  }
-
-  mostSiginficativeHexAsInt -= 8
-  return mostSiginficativeHexAsInt.toString() + hexString.substring(1)
-}
-
-// the next is an edit of the selfsigned function reduced to the function necessary for webtransport
-/**
- * @typedef {object} Certificate
- * @property {string} public
- * @property {string} private
- * @property {string} cert
- * @property {Uint8Array} hash
- * @property {string} fingerprint
- *
- * @param {*} attrs
- * @param {*} options
- * @returns {Promise<Certificate | null>}
- */
-export async function generateWebTransportCertificate(attrs, options) {
-  try {
-    const keyPair = await crypto.subtle.generateKey(
-      {
-        name: 'ECDSA',
-        namedCurve: 'P-256'
-      },
-      true,
-      ['sign', 'verify']
-    )
-
-    const cert = pki.createCertificate()
-
-    cert.serialNumber = toPositiveHex(
-      forge.util.bytesToHex(forge.random.getBytesSync(9))
-    ) // the serial number can be decimal or hex (if preceded by 0x)
-    cert.validity.notBefore = new Date()
-    cert.validity.notAfter = new Date()
-    cert.validity.notAfter.setDate(
-      cert.validity.notBefore.getDate() + (options.days || 14)
-    ) // per spec only 14 days allowed
-
-    cert.setSubject(attrs)
-    cert.setIssuer(attrs)
-
-    const privateKey = crypto.subtle.exportKey('pkcs8', keyPair.privateKey)
-    const publicKey = (cert.publicKey = await crypto.subtle.exportKey(
-      'spki',
-      keyPair.publicKey
-    ))
-
-    cert.setExtensions(
-      options.extensions || [
-        {
-          name: 'basicConstraints',
-          cA: false
-        },
-        {
-          name: 'keyUsage',
-          keyCertSign: true,
-          digitalSignature: true,
-          nonRepudiation: true,
-          keyEncipherment: true,
-          dataEncipherment: true
-        },
-        {
-          name: 'subjectAltName',
-          altNames: [
-            {
-              type: 6, // URI
-              value: 'http://example.org/webid#me'
-            }
-          ]
-        }
-      ]
-    )
-
-    // to signing
-    // patch oids object
-    oids['1.2.840.10045.4.3.2'] = 'ecdsa-with-sha256'
-    oids['ecdsa-with-sha256'] = '1.2.840.10045.4.3.2'
-
-    cert.siginfo.algorithmOid = cert.signatureOid = '1.2.840.10045.4.3.2' // 'ecdsa-with-sha256'
-
-    cert.tbsCertificate = getTBSCertificate(cert)
-    const encoded = Buffer.from(
-      asn1.toDer(cert.tbsCertificate).getBytes(),
-      'binary'
-    )
-    cert.md = crypto.subtle.digest('SHA-256', encoded)
-    cert.signature = crypto.subtle.sign(
-      {
-        name: 'ECDSA',
-        hash: { name: 'SHA-256' }
-      },
-      keyPair.privateKey,
-      encoded
-    )
-    cert.md = await cert.md
-    cert.signature = await cert.signature
-
-    const pemcert = pki.certificateToPem(cert)
-    const x509cert = new X509Certificate(pemcert)
-
-    const certhash = Buffer.from(
-      x509cert.fingerprint256.split(':').map((el) => parseInt(el, 16))
-    )
-
-    const pem = {
-      private: forge.pem.encode({
-        type: 'PRIVATE KEY',
-        body: new forge.util.ByteBuffer(await privateKey).getBytes()
-      }),
-      public: forge.pem.encode({
-        type: 'PUBLIC KEY',
-        body: new forge.util.ByteBuffer(publicKey).getBytes()
-      }),
-      cert: pemcert,
-      hash: certhash,
-      fingerprint: x509cert.fingerprint256
-    }
-
-    return pem
-  } catch (error) {
-    console.log('error in generate certificate', error)
-    return null
-  }
-}

package/test/fixtures/chai.js

@@ -1,8 +0,0 @@
-import chai from 'chai'
-import dirtyChai from 'dirty-chai'
-import chaiAsPromised from 'chai-as-promised'
-
-chai.use(dirtyChai)
-chai.use(chaiAsPromised)
-
-export const expect = chai.expect

package/test/fixtures/known-bytes.js

@@ -1,44 +0,0 @@
-/**
- * Bytes send by tests
- */
-export const KNOWN_BYTES = [
-  Uint8Array.from([0, 1, 2, 3, 4]),
-  Uint8Array.from([5, 6, 7, 8, 9]),
-  Uint8Array.from([10, 11, 12, 13, 14]),
-  Uint8Array.from([15, 16, 17, 18, 19]),
-  Uint8Array.from([20, 21, 22, 23, 24])
-]
-
-export const KNOWN_BYTES_LENGTH = KNOWN_BYTES.reduce(
-  (accumulator, currentValue) => accumulator + currentValue.length,
-  0
-)
-
-const createBytesChunk = function (/** @type {number} */ length) {
-  const workArray = new Array(length / 2)
-  for (let i = 0; i < length / 4; i++) {
-    workArray[2 * i + 1] = length % 0xffff
-    workArray[2 * i] = i
-  }
-  const helper = new Uint16Array(workArray)
-  const toreturn = new Uint8Array(
-    helper.buffer,
-    helper.byteOffset,
-    helper.byteLength
-  )
-  return toreturn
-}
-
-export const KNOWN_BYTES_LONG = [
-  createBytesChunk(60000), // 96, 234
-  createBytesChunk(12), // 0, 12
-  createBytesChunk(50000), // 195, 80
-  createBytesChunk(1600), // 6, 64
-  createBytesChunk(20000), // 78, 32
-  createBytesChunk(30000) // 117, 48
-]
-
-export const KNOWN_BYTES_LONG_LENGTH = KNOWN_BYTES_LONG.reduce(
-  (accumulator, currentValue) => accumulator + currentValue.length,
-  0
-)

package/test/fixtures/p-timeout.js

@@ -1,33 +0,0 @@
-class TimeoutError extends Error {
-  /**
-   * @param {string} message
-   */
-  constructor(message) {
-    super(message)
-
-    this.name = this[Symbol.toStringTag] = 'TimeoutError'
-  }
-}
-
-/**
- * @template T
- * @param {Promise<T>} promise
- * @param {number} timeout
- * @returns {Promise<T>}
- */
-export async function pTimeout(promise, timeout) {
-  let ref
-
-  const value = await Promise.race([
-    promise,
-    new Promise((resolve, reject) => {
-      ref = setTimeout(() => {
-        reject(new TimeoutError('timeout'))
-      }, timeout)
-    })
-  ])
-
-  clearTimeout(ref)
-
-  return value
-}

package/test/fixtures/quiche.browser.js

@@ -1,2 +0,0 @@
-const quicheLoaded = Promise.resolve()
-export { quicheLoaded }

package/test/fixtures/quiche.js

@@ -1 +0,0 @@
-export { quicheLoaded } from '../../lib/index.node.js'

package/test/fixtures/read-cert-hash.js

@@ -1,7 +0,0 @@
-/**
- * @param {string} [certHash]
- * @returns {Uint8Array}
- */
-export function readCertHash(certHash) {
-  return Uint8Array.from(`${certHash}`.split(':').map((i) => parseInt(i, 16)))
-}