Make the visible app name configurable

pimterry · pimterry · commit 2a690b66f9ba · 2020-03-06T20:16:55.000+01:00
diff --git a/src/cert-check-server.ts b/src/cert-check-server.ts
@@ -1,11 +1,11 @@
 import { getLocal, Mockttp } from 'mockttp';
 
-import { HttpsPathOptions } from 'mockttp/dist/util/tls';
 import { readFile } from './util';
+import { HtkConfig } from './config';
 
 export class CertCheckServer {
 
-    constructor(private config: { https: HttpsPathOptions }) { }
+    constructor(private config: HtkConfig) { }
 
     private server: Mockttp | undefined;
 
@@ -24,7 +24,7 @@ export class CertCheckServer {
             }),
             this.server.get('/check-cert').thenReply(200, `
                 <html>
-                    <title>HTTP Toolkit Certificate Setup</title>
+                    <title>${this.config.appName} Certificate Setup</title>
                     <meta charset="UTF-8" />
                     <link href="http://fonts.googleapis.com/css?family=Lato" rel="stylesheet" />
                     <style>
@@ -112,23 +112,23 @@ export class CertCheckServer {
                         </svg>
 
                         <p>
-                            To intercept HTTPS traffic, you need to trust the HTTP Toolkit certificate.
+                            To intercept HTTPS traffic, you need to trust the ${this.config.appName} certificate.
                             <br/>
                             This will only apply to this standalone Firefox profile, not your normal browser.
                         </p>
                         <p><strong>
                             Select 'Trust this CA to identify web sites' and press 'OK' to continue.
                         </strong></p>
                         <p>
-                            Made a mistake? Quit Firefox and start it again from HTTP Toolkit to retry.
+                            Made a mistake? Quit Firefox and start again to retry.
                         </p>
                     </div>
                     </body>
                 </html>
             `),
             this.server.get('/spinner').thenReply(200, `
                 <html>
-                    <title>HTTP Toolkit Certificate Setup</title>
+                    <title>${this.config.appName} Certificate Setup</title>
                     <meta charset="UTF-8" />
                     <style>
                         body {
diff --git a/src/config.d.ts b/src/config.d.ts
@@ -1,4 +1,5 @@
 export interface HtkConfig {
+    appName: string;
     configPath: string;
     authToken?: string;
     https: {
diff --git a/src/hide-warning-server.ts b/src/hide-warning-server.ts
@@ -1,11 +1,16 @@
 import { getLocal, Mockttp } from 'mockttp';
+import { HtkConfig } from './config';
 
 // The first tab that opens in a new Chrome/Edge window warns about dangerous flags.
 // Closing it and immediately opening a new one is a bit cheeky, but
 // is completely gets rid that, more or less invisibly:
 
 export class HideWarningServer {
 
+    constructor(
+        private config: HtkConfig
+    ) {}
+
     private server: Mockttp = getLocal();
 
     // Resolved once the server has seen at least once
@@ -23,7 +28,7 @@ export class HideWarningServer {
 
         await this.server.get('/hide-warning').thenReply(200, `
             <html>
-                <title>HTTP Toolkit Warning Fix</title>
+                <title>${this.config.appName} Warning Fix</title>
                 <meta charset="UTF-8" />
                 <style>
                     body { background-color: #d8e2e6; }
diff --git a/src/index.ts b/src/index.ts
@@ -14,6 +14,8 @@ import { ALLOWED_ORIGINS } from './constants';
 import { delay, readFile, checkAccess, writeFile, ensureDirectoryExists } from './util';
 import { registerShutdownHandler } from './shutdown';
 
+const APP_NAME = "HTTP Toolkit";
+
 async function generateHTTPSConfig(configPath: string) {
     const keyPath = path.join(configPath, 'ca.key');
     const certPath = path.join(configPath, 'ca.pem');
@@ -28,7 +30,7 @@ async function generateHTTPSConfig(configPath: string) {
         // Cert doesn't exist, or is too close/past expiry. Generate a new one:
 
         const newCertPair = await generateCACertificate({
-            commonName: 'HTTP Toolkit CA'
+            commonName: APP_NAME + ' CA'
         });
 
         return Promise.all([
@@ -95,6 +97,7 @@ export async function runHTK(options: {
 
     // Start the HTK server API
     const apiServer = new HttpToolkitServerApi({
+        appName: APP_NAME,
         configPath,
         authToken: options.authToken,
         https: httpsConfig
diff --git a/src/interceptors/fresh-chrome.ts b/src/interceptors/fresh-chrome.ts
@@ -41,7 +41,7 @@ export class FreshChrome implements Interceptor {
         const certificatePem = await readFile(this.config.https.certPath, 'utf8');
         const spkiFingerprint = generateSPKIFingerprint(certificatePem);
 
-        const hideWarningServer = new HideWarningServer();
+        const hideWarningServer = new HideWarningServer(this.config);
         await hideWarningServer.start('https://amiusing.httptoolkit.tech');
 
         const chromeDetails = await getChromeBrowserDetails(this.config);
diff --git a/src/interceptors/fresh-edge.ts b/src/interceptors/fresh-edge.ts
@@ -41,7 +41,7 @@ export class FreshEdge implements Interceptor {
         const certificatePem = await readFile(this.config.https.certPath, 'utf8');
         const spkiFingerprint = generateSPKIFingerprint(certificatePem);
 
-        const hideWarningServer = new HideWarningServer();
+        const hideWarningServer = new HideWarningServer(this.config);
         await hideWarningServer.start('https://amiusing.httptoolkit.tech');
 
         const edgeDetails = await getEdgeBrowserDetails(this.config);
diff --git a/test/interceptors/interceptor-test-utils.ts b/test/interceptors/interceptor-test-utils.ts
@@ -33,7 +33,7 @@ export async function setupInterceptor(interceptor: string): InterceptorSetup {
     const httpsConfig = await getCertificateDetails(configPath);
 
     const server = getLocal({ https: httpsConfig });
-    const interceptors = buildInterceptors({ configPath, https: httpsConfig });
+    const interceptors = buildInterceptors({ appName: "HTTP Toolkit", configPath, https: httpsConfig });
 
     return { server, interceptor: interceptors[interceptor], httpsConfig };
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`export interface HtkConfig {`
	`2`	`+ appName: string;`
`2`	`3`	`configPath: string;`
`3`	`4`	`authToken?: string;`
`4`	`5`	`https: {`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ export async function setupInterceptor(interceptor: string): InterceptorSetup {`
`33`	`33`	`const httpsConfig = await getCertificateDetails(configPath);`
`34`	`34`
`35`	`35`	`const server = getLocal({ https: httpsConfig });`
`36`		`- const interceptors = buildInterceptors({ configPath, https: httpsConfig });`
	`36`	`+ const interceptors = buildInterceptors({ appName: "HTTP Toolkit", configPath, https: httpsConfig });`
`37`	`37`
`38`	`38`	`return { server, interceptor: interceptors[interceptor], httpsConfig };`
`39`	`39`	`}`