Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@openziti/ziti-browzer-sw

openziti576Apache-2.00.84.0

Service Worker used as part of the OpenZiti browZer stack

ziti, zero trust, zero-trust, browZer, browser, js, javascript, workbox

readme

@openziti/ziti-browzer-sw

This component contains the ServiceWorker used as part of the OpenZiti Zero Trust browZer stack


Are you interested in knowing how to easily embed programmable, high performance, zero trust networking into your app, on any internet connection, without VPNs?
Learn more about our OpenZiti project by clicking the image below:



Build CodeQL Issues License LOC PRs Welcome Contributor Covenant


Overview

coming soon...

Installation

The ziti-browzer-sw is intended to be consumed by the ziti-http-agent, not as a general purpose module in your build. It is available through npm, and installed via the following command:

npm i @openziti/ziti-browzer-sw

The the ziti-http-agent serves the contents of ziti-browzer-sw in response to HTTP requests originating from the ziti-browzer-runtime. It does so by using the code shown below:


// Locate the path to the ServiceWorker distro within the build of our running instance
let pathToZitiBrowzerSwModule = require.resolve('@openziti/ziti-browzer-sw');

pathToZitiBrowzerSwModule = pathToZitiBrowzerSwModule.substring(0, pathToZitiBrowzerSwModule.lastIndexOf('/'));

// Read the component off the disk
fs.readFile( path.join( pathToZitiBrowzerSwModule, outgoing.path.split("/").pop() ), (err, data) => {

if (err) {  // If we can't read the file from disk

    res.writeHead(500, { 'x-ziti-http-agent-err': err.message });
    res.end('');
    return;

} else {    // Emit the Service Worker onto the wire

    res.writeHead(200, { 
        'Content-Type': 'application/javascript',
        'Service-Worker-Allowed': '/',
        'x-ziti-http-agent-info': 'self-configured ziti service worker' 
    });

    res.write(data);  // the actual service worker code

    res.end('\n');
    return;
}

Contributing

AllContibs

Your Contributions are welcome! Please see our Contributing Guide for more details. Thanks to all our contributors!

Contibs

License

Apache 2.0

changelog

0.84.0 (2025-07-07)

Features

0.83.0 (2025-04-07)

Features

  • defensive programming for dumpHeaders UUID (#269) (3d1a846)

0.82.0 (2025-04-02)

Features

  • correct ephemeral cert issue on behalf of WebSocket intercept in ZBR (#267) (6b2d2ba)

0.81.0 (2025-04-01)

Features

0.80.0 (2025-03-20)

Features

0.79.1 (2025-03-19)

0.79.0 (2025-03-19)

Features

  • gather OIDC scope from /external-jwt-signers (#261) (f4f7fb6)

0.78.0 (2025-03-10)

Features

0.77.0 (2025-03-10)

Features

0.76.1 (2025-03-10)

0.76.0 (2025-03-10)

Features

0.75.0 (2025-02-18)

Features

  • fix a 500 error caused by a bad redirect transform (#248) (2b00fa9)

0.74.0 (2025-02-13)

Features

0.73.1 (2025-01-21)

Bug Fixes

  • Correct 30x Location header target transform error (#245) (8835179)

0.73.0 (2025-01-21)

Features

  • Add 'Sec-Fetch-Mode navigate' header to HTTP requests when appropriate (#244) (9649c51)

0.72.7 (2025-01-17)

Bug Fixes

  • Correct sub-domain Service-routing issue (#243) (0965efa)

0.72.6 (2025-01-16)

Bug Fixes

  • Correct sub-domain Service-routing issue (#242) (a36d527)

0.72.5 (2025-01-16)

Bug Fixes

  • POST via fetch to private API listening on HTTPS fails (#241) (3542ca7)

0.72.4 (2025-01-15)

Bug Fixes

  • POST via fetch to private API listening on HTTPS fails (#240) (cc98b3b)

0.72.3 (2025-01-15)

Bug Fixes

  • POST via fetch to private API listening on HTTPS fails (#239) (417ca97)

0.72.2 (2025-01-10)

Bug Fixes

  • Bogus access_token from Entra can cause PKCE redirect loop in ZBR (#238) (18b973d)

0.72.1 (2025-01-09)

Bug Fixes

  • Drop of very large files into Mattermost causes exception (#237) (e2e3675)

0.72.0 (2024-12-19)

Features

  • Make ZAC served from Controller's /zac binding work under browZer (#236) (30d0e7a)

0.71.0 (2024-12-11)

Features

  • Null ptr while handling service app-connect data results in 500 Response (#235) (c726df8)

0.70.0 (2024-11-20)

Features

0.69.0 (2024-11-01)

Features

0.68.0 (2024-10-21)

Features

0.67.0 (2024-10-21)

Features

0.66.0 (2024-10-20)

Features

  • introduce 'target host transformer' to gzip inflator (#230) (0d05861)

0.65.0 (2024-10-08)

Features

  • do not process 'null' as a WebSocket event listener (#229) (67afa70)

0.64.0 (2024-09-26)

Features

  • don't evaporate Angular-specific attributes during HTML streaming (#228) (d2a9cc6)

0.63.0 (2024-09-24)

Features

  • bump to @openziti/libcrypto-js 0.24.0 (#227) (4b66e11)

0.62.0 (2024-09-09)

Features

  • HA network detection, and authentication (#226) (055f51e)

0.61.0 (2024-08-29)

Features

0.60.0 (2024-08-27)

Features

  • Do not attempt to wrap/stream the Body of a 204 Response (#224) (b09f066)

0.59.0 (2024-08-26)

Features

0.58.0 (2024-08-21)

Features

  • HomeAssistant support: various URL intercept, WebSocket and XHR tweaks (#222) (511ba4f)

0.57.1 (2024-08-06)

Bug Fixes

  • add controller to 'CSP connect-src' if present (#221) (53bb7d8)

0.57.0 (2024-08-02)

Features

  • Render Error page if Controller certs are expired (#220) (8979c99)

0.56.0 (2024-07-12)

Features

  • new throughput chart in browZer tools (#218) (da26851)

0.55.0 (2024-07-09)

Features

  • emit error page if wssER connections fail (#217) (9ff96cf)

0.54.5 (2024-07-08)

Bug Fixes

0.54.4 (2024-07-02)

Bug Fixes

  • properly handle WebSocket msgs sent with opcode 2 (binary) (#215) (00079df)

0.54.3 (2024-06-28)

Bug Fixes

  • send chunked WebSocket frames in a single write (prevent RSV2/3 errs) (#214) (a1d9e56)

0.54.2 (2024-05-22)

0.54.1 (2024-05-13)

Bug Fixes

  • correct a cookie handling issue (Wazuh) (#208) (4264080)

0.54.0 (2024-04-29)

Features

  • adjust CI/runtime to use hash-bundle name for browZer CSS (#207) (b8e0ada)

0.53.0 (2024-04-29)

Features

  • New Settings Dlg (with 'Changelog' and 'Feedback' widgets) (#206) (7d89336)

0.52.1 (2024-04-22)

Bug Fixes

  • Service revocation detect/react enhancements (#205) (a1fd84c)

0.52.0 (2024-04-19)

Features

0.51.0 (2024-03-31)

Features

0.50.7 (2024-03-21)

Bug Fixes

0.50.6 (2024-03-20)

Bug Fixes

  • inaccurate oauth2 callback parameters matching in matchGetCb (#201) (45f0365)

0.50.5 (2024-03-18)

Bug Fixes

  • Scada web app loses WebSocket connection (#199) (5d2d90d)

0.50.4 (2024-03-17)

Bug Fixes

0.50.3 (2024-03-17)

Bug Fixes

  • non-default lb+bootstrapper port handling (#197) (2da9ff8)

0.50.2 (2024-03-15)

Bug Fixes

  • non-default bootstrapper port handling (#196) (1b1b039)

0.50.1 (2024-03-06)

Bug Fixes

  • match redirects with serviceConnectAppData.dst_ip (#195) (6e40aba)

0.50.0 (2024-03-05)

Features

  • improve intercept.v1 config protocol parsing (#194) (b96af1f)

0.49.0 (2024-03-05)

Features

0.48.4 (2024-02-28)

Bug Fixes

0.48.3 (2024-02-28)

Bug Fixes

0.48.2 (2024-02-22)

Bug Fixes

0.48.1 (2024-02-21)

Bug Fixes

0.48.0 (2024-02-10)

Features

0.47.1 (2024-02-05)

Bug Fixes

0.47.0 (2024-02-05)

Features

0.46.2 (2024-01-31)

Bug Fixes

0.46.1 (2024-01-25)

Bug Fixes

0.46.0 (2024-01-25)

Features

0.45.4 (2024-01-11)

Bug Fixes

  • multi-MB writes fail under nestedTLS (#182) (0ee20af)

0.45.3 (2024-01-10)

Bug Fixes

  • use self.skipWaiting() to prevent stalled SW during activation (#181) (b2dda26)

0.45.2 (2024-01-08)

Bug Fixes

0.45.1 (2024-01-05)

Bug Fixes

0.45.0 (2024-01-05)

Features

0.44.0 (2023-12-19)

Features

0.43.1 (2023-12-18)

Bug Fixes

  • img fetch/render broken due to CSP misalignment (#176) (7eda635)

0.43.0 (2023-12-16)

Features

0.42.3 (2023-12-13)

Bug Fixes

  • add controller and bootstrapper to 'connect-src' CSP (#174) (0bf2208)

0.42.2 (2023-12-12)

Bug Fixes

0.42.1 (2023-12-12)

Bug Fixes

0.42.0 (2023-12-11)

Features

0.41.1 (2023-12-06)

Bug Fixes

0.41.0 (2023-12-06)

Features

  • Support multiple wssER's in same network (#169) (441a5e5)

0.40.0 (2023-12-03)

Features

0.39.1 (2023-11-24)

Bug Fixes

0.39.0 (2023-11-20)

Features

0.38.2 (2023-11-19)

0.38.1 (2023-11-19)

Bug Fixes

0.38.0 (2023-11-14)

Features

0.37.2 (2023-11-03)

Bug Fixes

  • ensure UA header is present (keep Observium happy) (#163) (df30515)

0.37.1 (2023-11-01)

Bug Fixes

  • handle duplicate Set-Cookie headers from Icinga (#162) (541c3dd)

0.37.0 (2023-10-30)

Features

0.36.0 (2023-10-27)

Features

0.35.0 (2023-10-23)

Features

0.34.6 (2023-09-18)

Bug Fixes

0.34.5 (2023-09-14)

Bug Fixes

  • correct problem with intercepted WebSocket msg handling (#157) (3850edf)

0.34.4 (2023-09-14)

Bug Fixes

  • additional METHOD intercepts that target Ziti Services (#156) (800396c)

0.34.3 (2023-09-13)

Bug Fixes

  • intercept PUT requests targeting Ziti Service (#155) (ef25360)

0.34.2 (2023-09-13)

Bug Fixes

  • bump to latest 'core' and 'strategies' (#154) (594e4e6)

0.34.1 (2023-09-11)

Bug Fixes

  • don't drop METHOD when building ClientRequest (#153) (47e62ff)

0.34.0 (2023-08-31)

Features

0.33.2 (2023-08-21)

Bug Fixes

0.33.1 (2023-08-08)

Bug Fixes

0.33.0 (2023-08-08)

Features

0.32.0 (2023-08-04)

Features

0.31.0 (2023-08-02)

Features

0.30.2 (2023-08-02)

Bug Fixes

  • skip 'inject check' when not going over Ziti (#146) (68cd9d9)

0.30.1 (2023-08-02)

Bug Fixes

0.30.0 (2023-07-26)

Features

0.29.0 (2023-07-24)

Features

0.28.0 (2023-07-19)

Features

0.27.4 (2023-07-13)

Bug Fixes

  • do a GET before a POST at startup (use listControllerVersion) (#141) (e8a90e6)

0.27.3 (2023-07-09)

Bug Fixes

0.27.2 (2023-06-21)

Bug Fixes

0.27.1 (2023-06-12)

Bug Fixes

0.27.0 (2023-06-03)

Features

0.26.0 (2023-05-30)

Features

0.25.0 (2023-05-26)

Features

  • support both 'ws' and 'wss' ER bindings (#135) (1d75501)

0.24.0 (2023-05-23)

Features

0.23.1 (2023-05-19)

Bug Fixes

0.23.0 (2023-05-17)

Features

0.22.0 (2023-05-17)

Features

0.21.2 (2023-04-22)

Bug Fixes

0.21.1 (2023-04-05)

Bug Fixes

0.21.0 (2023-04-04)

Features

0.20.0 (2023-03-30)

Features

0.19.1 (2023-03-15)

Bug Fixes

  • Intercept GETs while awaiting zitiConfig after SW transitions from Terminated->Idle (#126) (5896716)

0.19.0 (2023-01-23)

Features

0.18.1 (2022-11-29)

Bug Fixes

  • handle array of 'Set-Cookie' headers (#118) (84a277d)

0.18.0 (2022-11-27)

Features

  • use 'memoization' for some frequently-used expensive (core) funcs (#115) (baa5ce6)

0.17.2 (2022-11-23)

Bug Fixes

  • adjust event handling for large Blob responses (Jellyfin streaming) (#114) (520919f)

0.17.1 (2022-11-21)

Bug Fixes

  • host the 'toast' locally, not in CDN (#113) (2494f29)

0.17.0 (2022-11-18)

Features

0.16.0 (2022-11-03)

Features

0.15.5 (2022-10-31)

Bug Fixes

0.15.4 (2022-10-19)

Bug Fixes

0.15.3 (2022-10-13)

Bug Fixes

0.15.2 (2022-10-07)

Bug Fixes

0.15.1 (2022-09-13)

Bug Fixes

  • don't hang if some wsER's are offline (#98) (54a946e)

0.15.0 (2022-09-06)

Features

0.14.0 (2022-08-31)

Features

0.13.1 (2022-08-30)

Bug Fixes

0.13.0 (2022-08-30)

Features

0.12.2 (2022-08-30)

Bug Fixes

0.12.1 (2022-08-23)

Bug Fixes

  • correct libsodium e2e encryption regression (#87) (6f0a1fa)

0.12.0 (2022-08-16)

Features

  • initiate proper ZBR bootstrapping by SW (#86) (09f21f3)

0.11.0 (2022-08-11)

Features

  • initiate proper ZBR bootstrapping by SW (#85) (7c0cb08)

0.10.2 (2022-08-05)

Bug Fixes

  • correct unneeded unregister/reloads (#83) (e934464)

0.10.1 (2022-08-05)

Bug Fixes

0.10.0 (2022-08-05)

Features

0.9.0 (2022-08-04)

Features

0.8.0 (2022-08-03)

Features

  • no limits on simultaneous requests (#79) (61a5d0d)

0.7.0 (2022-08-03)

Features

0.6.11 (2022-08-02)

Bug Fixes

  • correct MM channel 'Loading...' issue (#77) (d2d2dc3)

0.6.10 (2022-07-25)

Bug Fixes

  • correct missing Buffer reference (#74) (a519a69)

0.6.9 (2022-07-24)

Bug Fixes

0.6.8 (2022-07-21)

Bug Fixes

  • Need for Speed: make EC keys the default (#72) (a8c739d)

0.6.7 (2022-07-20)

Bug Fixes

  • getMatchConfigInterceptV1 false positives (#70) (9ffa444)

0.6.6 (2022-07-19)

Bug Fixes

  • Pause for session cert sync to ER (#69) (ff6b77e)

0.6.5 (2022-07-19)

Bug Fixes

0.6.4 (2022-07-19)

Bug Fixes

0.6.3 (2022-07-16)

Bug Fixes

0.6.2 (2022-07-15)

Bug Fixes

0.6.1 (2022-06-21)

Bug Fixes

0.6.0 (2022-06-01)

Features

0.5.2 (2022-05-04)

0.5.1 (2022-05-04)

0.5.0 (2022-05-02)

Features

0.4.0 (2022-04-20)

Features

0.3.1 (2022-04-12)

0.3.0 (2022-04-06)

Features

0.2.0 (2022-04-04)

Features

0.1.20 (2022-03-28)

0.1.19 (2022-03-28)

0.1.18 (2022-03-25)

0.1.17 (2022-03-25)

0.1.16 (2022-03-25)

0.1.15 (2022-03-25)

0.1.14 (2022-03-24)

0.1.13 (2022-03-24)

0.1.12 (2022-03-04)

0.1.11 (2022-03-03)

0.1.10 (2022-03-03)

0.1.9 (2022-03-03)

0.1.8 (2022-03-03)

0.1.7 (2022-03-03)

0.1.6 (2022-03-03)

0.1.5 (2022-03-03)

0.1.4 (2022-03-03)

0.1.3 (2022-03-03)

0.1.2 (2022-03-03)

0.1.1 (2022-03-03)