Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

introduce 'eruda' url query parm #179

Merged
merged 2 commits into from
Jan 5, 2024
Merged

introduce 'eruda' url query parm #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8103d2b
introduce 'eruda' url query parm
rentallect Jan 5, 2024
fe52155
introduce 'eruda' url query parm
rentallect Jan 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
]
},
"dependencies": {
"@openziti/ziti-browzer-core": "^0.35.0",
"@openziti/ziti-browzer-core": "^0.35.1",
"async-mutex": "^0.3.2",
"cheerio": "^1.0.0-rc.12",
"jwt-decode": "^3.1.2",
Expand Down
74 changes: 42 additions & 32 deletions src/ZitiFirstStrategy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import { buildInfo } from './buildInfo'
export interface ZitiFirstOptions extends StrategyOptions {
zitiBrowzerServiceWorkerGlobalScope?: any;
logLevel?: string;
eruda?: boolean;
controllerApi?: string;
zitiNetworkTimeoutSeconds?: number;
uuid?: string;
Expand Down Expand Up @@ -122,7 +123,9 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
this._core = new ZitiBrowzerCore({});
this.logger = this._core.createZitiLogger({
logLevel: this._logLevel,
suffix: 'ZBSW'
suffix: 'ZBSW',
useSWPostMessage: options.eruda,
zitiBrowzerServiceWorkerGlobalScope: this._zitiBrowzerServiceWorkerGlobalScope,
});
this.logger.trace(`ZitiFirstStrategy ctor completed`);
}
Expand Down Expand Up @@ -188,8 +191,10 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
origCSP['script-src'].push(`${this._zitiBrowzerServiceWorkerGlobalScope._zitiConfig.idp.host}`.replace('https://',''));
if (isEqual(this._zitiBrowzerServiceWorkerGlobalScope._zitiConfig.idp.type, 'keycloak')) {
origCSP['script-src'].push(`${keycloakJs}`);
}
origCSP['script-src'].push(`${erudaJs}`);
}
if (this._zitiBrowzerServiceWorkerGlobalScope._zitiConfig.eruda) {
origCSP['script-src'].push(`${erudaJs}`);
}
if (!origCSP['script-src'].includes("'unsafe-eval'")) {
origCSP['script-src'].push("'unsafe-eval'");
}
Expand Down Expand Up @@ -296,7 +301,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {

idpAuthHealthEventHandler(idpAuthHealthEvent: any) {

this.logger.trace(`idpAuthHealthEventHandler() `, idpAuthHealthEvent);
this.logger.trace(`idpAuthHealthEventHandler() ${idpAuthHealthEvent}`);

if (idpAuthHealthEvent.expired) {

Expand Down Expand Up @@ -542,8 +547,6 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {

if ( newUrl.pathname === '/' ) {

// this.logger.trace('_shouldRouteOverZiti: root path, bypassing intercept of [%s]: ', request.url);

result.url = request.url;
result.routeOverZiti = true;
result.serviceName = this._zitiBrowzerServiceWorkerGlobalScope._zitiConfig.browzer.bootstrapper.target.service;
Expand All @@ -552,7 +555,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
}
else
if ( (request.url.match( regexZBR )) || (request.url.match( regexZBRnaked )) || (request.url.match( regexZBWASM )) || (request.url.match( regexZBRLogo )) || (request.url.match( regexZBRcss )) || (request.url.match( regexZBRCORS ))) { // the request seeks z-b-r/wasm/logo/css/cors-proxy
this.logger.trace('_shouldRouteOverZiti: z-b-r/wasm/logo, bypassing intercept of [%s]: ', request.url);
this.logger.trace(`_shouldRouteOverZiti: z-b-r/wasm/logo, bypassing intercept of [${request.url}]`);
}
else {

Expand All @@ -569,10 +572,10 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
this.logger.trace( '_shouldRouteOverZiti: transformed URL: ', newUrl.toString());

result.serviceName = await this._zitiContext.shouldRouteOverZiti( newUrl );
this.logger.trace(`_shouldRouteOverZiti result.serviceName[%o]`, result.serviceName);
this.logger.trace(`_shouldRouteOverZiti result.serviceName[${result.serviceName}]`);

if (isUndefined(result.serviceName) || isEqual(result.serviceName, '')) { // If we have no config associated with the hostname:port, do not intercept
this.logger.warn('_shouldRouteOverZiti: no associated Ziti config, bypassing intercept of [%s]', request.url);
this.logger.warn(`_shouldRouteOverZiti: no associated Ziti config, bypassing intercept of [${request.url}]`);
setTimeout(this._sendServiceUnavailable, 250, this._zitiBrowzerServiceWorkerGlobalScope, newUrl);
} else {
result.url = newUrl.toString();
Expand All @@ -585,7 +588,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {

}
else if ( (request.url.match( regexZBR )) || ((request.url.match( regexZBWASM ))) ) { // the request seeks z-b-r/wasm
this.logger.trace('_shouldRouteOverZiti: z-b-r/wasm, bypassing intercept of [%s]: ', request.url);
this.logger.trace(`_shouldRouteOverZiti: z-b-r/wasm, bypassing intercept of [${request.url}]`);
}
else if (request.url.match( targetServiceRegex )) { // yes, the request is targeting the 'dark' web app

Expand All @@ -603,11 +606,11 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
} else { // the request is targeting the raw internet

result.serviceName = await this._zitiContext.shouldRouteOverZiti( request.url );
this.logger.trace(`_shouldRouteOverZiti result.serviceName[%o]`, result.serviceName);
this.logger.trace(`_shouldRouteOverZiti result.serviceName[${result.serviceName}]`);

if (isUndefined(result.serviceName) || isEqual(result.serviceName, '')) { // If we have no config associated with the hostname:port

this.logger.warn('_shouldRouteOverZiti: no associated config, bypassing intercept of [%s]', request.url);
this.logger.warn(`_shouldRouteOverZiti: no associated config, bypassing intercept of [${request.url}]`);

} else {

Expand All @@ -623,7 +626,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
this.logger.error( e );
}

this.logger.trace(`_shouldRouteOverZiti result[%o]`, result);
this.logger.trace(`_shouldRouteOverZiti result[${result.routeOverZiti}]`);

return result;

Expand Down Expand Up @@ -713,7 +716,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {

let tryZiti: boolean | false;

this.logger.trace(`_handle entered for: `, request.url);
this.logger.trace(`_handle entered for: [${request.url}]`);

const requestURL = new URL(request.url);

Expand Down Expand Up @@ -1048,7 +1051,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {

if (bootstrappingZBRFromSW) {

self.logger.trace('detectFromBootstrapper: bootstrappingZBRFromSW [%o]', bootstrappingZBRFromSW);
self.logger.trace(`detectFromBootstrapper: bootstrappingZBRFromSW [${bootstrappingZBRFromSW}]`);

// swap the id to indicate we are bootstrapping from the SW
fromEl.attr('id', `from-ziti-browzer-sw`);
Expand All @@ -1071,7 +1074,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
},
flush(controller) {
if (buffer) {
self.logger.trace('detectFromBootstrapper: result [%o]', fromBootstrapper);
self.logger.trace(`detectFromBootstrapper: result [${fromBootstrapper}]`);
controller.enqueue(buffer);
}
}
Expand Down Expand Up @@ -1123,7 +1126,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
streamingAttrReplace($, 'track', 'src');
streamingAttrReplace($, 'video', 'src');

self.logger.trace('streamingHEADReplace: HTML before modifications is: ', $.html());
self.logger.trace(`streamingHEADReplace: HTML before modifications is: ${$.html()}`);

let zbrElement = $('<script></script> ').attr('id', 'from-ziti-browzer-sw').attr('type', 'text/javascript').attr('src', `${_obtainBootStrapperURL()}/${zbrLocation}`); //.attr('defer', `defer`);
let ppElement = $('<script></script> ')
Expand Down Expand Up @@ -1161,22 +1164,25 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
}

let erudaElement = $('<script></script> ')
.attr('id', 'ziti-browzer-eruda')
.attr('type', 'text/javascript')
.attr('src', `${erudaJs}`);
if (self._zitiBrowzerServiceWorkerGlobalScope._zitiConfig.eruda) {
erudaElement = $('<script></script> ')
.attr('id', 'ziti-browzer-eruda')
.attr('type', 'text/javascript')
.attr('src', `${erudaJs}`);
}

// Locate the CSP
let cspElement = $('meta[http-equiv="content-security-policy"]');

// If we found a CSP
if (cspElement.length > 0) {

self.logger.trace('streamingHEADReplace: CSP found in html with content: ', cspElement.attr('content'));
// self.logger.trace('streamingHEADReplace: CSP found in html with content: ', cspElement.attr('content'));
// then augment it to enable WASM load/xeq
let cspContent = cspElement.attr('content');
let newCspContent = self.generateNewCSP(cspContent);
cspElement.attr('content', newCspContent);
self.logger.trace('streamingHEADReplace: CSP is now enhanced with content: ', cspElement.attr('content'));
// self.logger.trace('streamingHEADReplace: CSP is now enhanced with content: ', cspElement.attr('content'));

// Inject the PP immediately after the CSP
cspElement.after(ppCss1Element);
Expand All @@ -1190,7 +1196,9 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
cspElement.after(kcElement);
}

cspElement.after(erudaElement);
if (self._zitiBrowzerServiceWorkerGlobalScope._zitiConfig.eruda) {
cspElement.after(erudaElement);
}

let ppEl = $('link[id="ziti-browzer-ppcss"]');
// Inject the ZBR immediately after the PP
Expand Down Expand Up @@ -1218,7 +1226,9 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
headElement.prepend(kcElement);
}

headElement.prepend(erudaElement);
if (self._zitiBrowzerServiceWorkerGlobalScope._zitiConfig.eruda) {
headElement.prepend(erudaElement);
}

buffer += $.html();
}
Expand All @@ -1236,7 +1246,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
flush(controller) {
if (buffer) {
buffer = buffer.replace('document.domain', 'document.zitidomain');
self.logger.trace('streamingHEADReplace: HTML after modifications is: ', buffer);
self.logger.trace(`streamingHEADReplace: HTML after modifications is: ${buffer}`);
controller.enqueue(buffer);
}
}
Expand Down Expand Up @@ -1489,7 +1499,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
}
);

this.logger.debug(`Got zitiResponse: `, zitiResponse);
this.logger.debug(`Got zitiResponse from [${zitiResponse.url}]`);

/**
* Now that ziti-browzer-core has returned us a ZitiResponse, instantiate a fresh native Response object that we
Expand All @@ -1514,7 +1524,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
for (let i = 0; i < keys.length; i++) {
let key = keys[i];
let val = zitiHeaders[key][0];
this.logger.trace( 'ZitiFirstStrategy: zitiResponse.headers: ', key, val);
this.logger.trace(`ZitiFirstStrategy: zitiResponse.headers: [${key}] [${val}]`);

if (key.toLowerCase() === 'set-cookie') {
if (Array.isArray(val)) {
Expand Down Expand Up @@ -1668,7 +1678,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {

}

this.logger.trace(`ZitiFirstStrategy: formed native response: `, response);
this.logger.trace(`ZitiFirstStrategy: formed native response for [${zitiResponse.url}]`);

} catch (fetchError) {
this.logger.error(`Got error: `, fetchError);
Expand All @@ -1695,7 +1705,7 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
if ((error || !response) && useCache) {
response = await handler.cacheMatch(request);
if (response) {
this.logger.debug(`Found a cached response in the '${this.cacheName}'` + ` cache.`);
this.logger.debug(`Found a cached response`);
}
}

Expand Down Expand Up @@ -1730,12 +1740,12 @@ class ZitiFirstStrategy extends CacheFirst /* NetworkFirst */ {
// this.logger.debug(`doing raw internet fetchAndCachePut for: `, request.url);
// response = await handler.fetchAndCachePut(request);
// } else {
this.logger.debug(`doing raw internet fetch for: `, request.url);
this.logger.debug(`doing raw internet fetch for [${request.url}]`);
response = await handler.fetch(request);
// }
this.logger.debug(`Got response: `, response);
this.logger.debug(`Got raw internet response from [${request.url}]`);
} catch (fetchError) {
this.logger.error(`Got error: `, fetchError);
this.logger.error(`Got error: [${fetchError}]`);
if (fetchError instanceof Error) {
error = fetchError;
}
Expand Down
8 changes: 4 additions & 4 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -969,10 +969,10 @@
"@types/emscripten" "^1.39.6"
"@wasmer/wasi" "^1.0.2"

"@openziti/ziti-browzer-core@^0.35.0":
version "0.35.0"
resolved "https://registry.yarnpkg.com/@openziti/ziti-browzer-core/-/ziti-browzer-core-0.35.0.tgz#d545cfc2bca08e9aef6cf052701e24900876ba5c"
integrity sha512-o18NtJZm4KQwwi/u0a2o4rwSbYsCFAZud0liRKB/CSbga1NCELXx2hiyFjj4vY58RYOZ1gqojBv19d8kjz6dMg==
"@openziti/ziti-browzer-core@^0.35.1":
version "0.35.1"
resolved "https://registry.yarnpkg.com/@openziti/ziti-browzer-core/-/ziti-browzer-core-0.35.1.tgz#ec911044d004bd388513817b5e8c41b290161cc3"
integrity sha512-LIZoDknH/h/aSw16VCq0SY7hfi20QxkY+hurh2PDfT4vqZlqhrDg/Ayi+/M4fkE1FqAQAqtgQBufJ/o07xrIaQ==
dependencies:
"@openziti/libcrypto-js" "^0.19.0"
"@openziti/ziti-browzer-edge-client" "^0.6.2"
Expand Down
Loading