feat(mitm): allow a user to configure dns provider

ulixee · Oct 11, 2021 · c361d5c · c361d5c
1 parent 5ed488b
commit c361d5c
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git a/docs/main/BasicInterfaces/Hero.md b/docs/main/BasicInterfaces/Hero.md
@@ -78,6 +78,9 @@ const Hero = require('@ulixee/hero');
   - userAgent `strong`. This sets your browser's user agent string. Prefixing this string with a tilde (~) allows for dynamic options.
   - browserEmulatorId `string` defaults to `default-browser-emulator`. Chooses the BrowserEmulator plugin which emulates the properties that help Hero look like a normal browser.
   - humanEmulatorId `string` defaults to `default-human-emulator`. Chooses the HumanEmulator plugin which drives the mouse/keyboard movements.
+  - dnsOverTlsProvider `object`. Configure the host and port to use for DNS over TLS. This feature replicates the Chrome feature that is used if the host DNS provider supports DNS over TLS or DNS over HTTPS. A `null` value will disable this feature.
+    - host `string`. The DNS provider host address. Google=8.8.8.8, Cloudflare=1.1.1.1, Quad9=9.9.9.9.
+    - servername `string`. The DNS provider tls servername. Google=dns.google, Cloudflare=cloudflare-dns.com, Quad9=dns.quad9.net.
   - geolocation `IGeolocation`. Overrides the geolocation of the user. Will automatically grant permissions to all origins for geolocation.
     - latitude `number`. Latitude between -90 and 90.
     - longitude `number`. Longitude between -180 and 180.

diff --git a/interfaces/ICorePlugin.ts b/interfaces/ICorePlugin.ts
@@ -158,6 +158,7 @@ export interface IBrowserEmulatorConfig {
   geolocation?: IGeolocation;
   timezoneId?: string;
   locale?: string;
+  dnsOverTlsProvider?: IDnsSettings['dnsOverTlsConnection'];
 }
 
 // decorator for browser emulator classes. hacky way to check the class implements statics we need

diff --git a/interfaces/ISessionCreateOptions.ts b/interfaces/ISessionCreateOptions.ts
@@ -26,7 +26,7 @@ export default interface ISessionCreateOptions extends ISessionOptions {
   geolocation?: IGeolocation;
   dependencyMap?: { [clientPluginId: string]: string[] };
   corePluginPaths?: string[];
-
+  dnsOverTlsProvider?: { host: string; port: number };
   showBrowser?: boolean;
   showBrowserInteractions?: boolean;
   allowManualBrowserInteraction?: boolean;

diff --git a/plugins/default-browser-emulator/index.ts b/plugins/default-browser-emulator/index.ts
@@ -52,6 +52,7 @@ export default class DefaultBrowserEmulator extends BrowserEmulator {
   public locale: string;
   public viewport: IViewport;
   public geolocation: IGeolocation;
+  public dnsOverTlsProvider: IDnsSettings['dnsOverTlsConnection'];
 
   protected readonly data: IBrowserData;
   private readonly domOverridesBuilder: DomOverridesBuilder;
@@ -82,10 +83,15 @@ export default class DefaultBrowserEmulator extends BrowserEmulator {
     this.viewport = config.viewport;
     this.timezoneId = config.timezoneId;
     this.geolocation = config.geolocation;
+    this.dnsOverTlsProvider = config.dnsOverTlsProvider;
   }
 
   public onDnsConfiguration(settings: IDnsSettings): void {
     configureSessionDns(this, settings);
+
+    if (this.dnsOverTlsProvider !== undefined) {
+      settings.dnsOverTlsConnection = this.dnsOverTlsProvider;
+    }
   }
 
   public onTcpConfiguration(settings: ITcpSettings): void {