get-browser-fingerprint 3.0.0 → 3.2.0

package/README.md

@@ -13,7 +13,8 @@ console.log(fingerprint);
 
 Options available:
 - `hardwareOnly` (default `false`): leverage only hardware info about device 
-- `enableWebgl` (default `false`): enable webgl renderer, ~4x times slower but adds another deadly powerful hardware detection layer on top of canvas 
+- `enableWebgl` (default `false`): enable webgl renderer, ~4x times slower but adds another deadly powerful hardware detection layer on top of canvas
+- `enableScreen` (default `true`): enable screen resolution detection, disable it if your userbase may use multiple screens
 - `debug`: log data used to generate fingerprint to console and add canvas/webgl canvas to body to see rendered image (default `false`)
 
 ⚠️ Be careful: the strongest discriminating factor is canvas token which can't be computed on old devices (eg: iPhone 6), deal accordingly ⚠️
@@ -30,4 +31,4 @@ yarn test
 To run example locally:
 ```sh
 yarn http-server src -o -c-1 -p 80
-```
+```

package/package.json

@@ -1,19 +1,24 @@
 {
   "name": "get-browser-fingerprint",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "author": "Damiano Barbati <damiano.barbati@gmail.com> (https://github.com/damianobarbati)",
   "repository": "https://github.com/damianobarbati/get-browser-fingerprint",
   "license": "MIT",
   "main": "src/index.js",
+  "files": [
+    "README.md",
+    "package.json",
+    "src/index.js"
+  ],
   "type": "module",
   "scripts": {
     "eslint": "eslint --ignore-path .gitignore --fix",
     "test": "vitest run"
   },
   "devDependencies": {
-    "eslint-config-xs": "^1.6.2",
+    "eslint-config-xs": "^2.6.1",
     "http-server": "^14.1.1",
-    "puppeteer": "^19.8.0",
-    "vitest": "^0.29.7"
+    "puppeteer": "^21.4.1",
+    "vitest": "^0.34.6"
   }
 }

package/src/index.js

@@ -1,7 +1,23 @@
-const getBrowserFingerprint = ({ hardwareOnly = false, enableWebgl = false, debug = false } = {}) => {
-  const { cookieEnabled, deviceMemory, doNotTrack, hardwareConcurrency, language, languages, maxTouchPoints, platform, userAgent, vendor } = window.navigator;
-
-  const { width, height, colorDepth, pixelDepth } = window.screen;
+const getBrowserFingerprint = ({
+  hardwareOnly = false,
+  enableWebgl = false,
+  enableScreen = true,
+  debug = false,
+} = {}) => {
+  const {
+    cookieEnabled,
+    deviceMemory,
+    doNotTrack,
+    hardwareConcurrency,
+    language,
+    languages,
+    maxTouchPoints,
+    platform,
+    userAgent,
+    vendor,
+  } = window.navigator;
+
+  const { width, height, colorDepth, pixelDepth } = enableScreen ? window.screen : {}; // undefined will remove this from the stringify down here
   const timezoneOffset = new Date().getTimezoneOffset();
   const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
   const touchSupport = 'ontouchstart' in window;
@@ -97,7 +113,8 @@ export const getWebglID = (debug) => {
 
     const f =
       'attribute vec2 attrVertex;varying vec2 varyinTexCoordinate;uniform vec2 uniformOffset;void main(){varyinTexCoordinate=attrVertex+uniformOffset;gl_Position=vec4(attrVertex,0,1);}';
-    const g = 'precision mediump float;varying vec2 varyinTexCoordinate;void main() {gl_FragColor=vec4(varyinTexCoordinate,0,1);}';
+    const g =
+      'precision mediump float;varying vec2 varyinTexCoordinate;void main() {gl_FragColor=vec4(varyinTexCoordinate,0,1);}';
     const h = ctx.createBuffer();
 
     ctx.bindBuffer(ctx.ARRAY_BUFFER, h);
@@ -151,10 +168,10 @@ export const getWebglInfo = () => {
     const ctx = document.createElement('canvas').getContext('webgl');
 
     const result = {
-      VERSION: ctx.getParameter(ctx.VERSION),
-      SHADING_LANGUAGE_VERSION: ctx.getParameter(ctx.SHADING_LANGUAGE_VERSION),
-      VENDOR: ctx.getParameter(ctx.VENDOR),
-      SUPORTED_EXTENSIONS: ctx.getSupportedExtensions(),
+      VERSION: String(ctx.getParameter(ctx.VERSION)),
+      SHADING_LANGUAGE_VERSION: String(ctx.getParameter(ctx.SHADING_LANGUAGE_VERSION)),
+      VENDOR: String(ctx.getParameter(ctx.VENDOR)),
+      SUPORTED_EXTENSIONS: String(ctx.getSupportedExtensions()),
     };
 
     return result;
@@ -172,7 +189,11 @@ export const murmurhash3_32_gc = (key) => {
   let h1, h1b, k1;
 
   for (let i = 0; i < bytes; i++) {
-    k1 = (key.charCodeAt(i) & 0xff) | ((key.charCodeAt(++i) & 0xff) << 8) | ((key.charCodeAt(++i) & 0xff) << 16) | ((key.charCodeAt(++i) & 0xff) << 24);
+    k1 =
+      (key.charCodeAt(i) & 0xff) |
+      ((key.charCodeAt(++i) & 0xff) << 8) |
+      ((key.charCodeAt(++i) & 0xff) << 16) |
+      ((key.charCodeAt(++i) & 0xff) << 24);
     ++i;
 
     k1 = ((k1 & 0xffff) * c1 + ((((k1 >>> 16) * c1) & 0xffff) << 16)) & 0xffffffff;
@@ -220,6 +241,8 @@ export const murmurhash3_32_gc = (key) => {
   return h1 >>> 0;
 };
 
-window.getBrowserFingerprint = getBrowserFingerprint;
+if (typeof window !== 'undefined') {
+  window.getBrowserFingerprint = getBrowserFingerprint;
+}
 
 export default getBrowserFingerprint;

package/.eslintrc

@@ -1,5 +0,0 @@
-{
-  "extends": [
-    "eslint-config-xs/react"
-  ]
-}

package/.github/workflows/commit.yml

@@ -1,24 +0,0 @@
-name: commit
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  test:
-    runs-on: ubuntu-22.04
-    timeout-minutes: 3
-    steps:
-      - name: checkout
-        uses: actions/checkout@v2
-
-      - name: setup node
-        uses: actions/setup-node@v2
-        with:
-          node-version-file: '.nvmrc'
-
-      - name: test
-        run: |
-          yarn install
-          yarn test

package/.github/workflows/tag.yml

@@ -1,28 +0,0 @@
-name: tag
-
-on:
-  push:
-    tags:
-      - v*
-
-jobs:
-  release:
-    runs-on: ubuntu-22.04
-    timeout-minutes: 3
-    steps:
-      - name: checkout
-        uses: actions/checkout@v2
-
-      - name: setup node
-        uses: actions/setup-node@v2
-        with:
-          node-version-file: '.nvmrc'
-          registry-url: https://registry.npmjs.org/
-
-      - name: release
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-        run: |
-          yarn install
-          yarn test
-          npm publish

package/.nvmrc

@@ -1 +0,0 @@
-v16.16

package/src/index.html

@@ -1,47 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>get-browser-fingerprint demo</title>
-  </head>
-  <body>
-    <h1>get-browser-fingerprint</h1>
-
-    <h2 id="default"></h2>
-    <h2 id="hardwareOnly"></h2>
-    <h2 id="enableWebgl"></h2>
-
-    <script type="module">
-      import getFingerprint from './index.js';
-
-      args_default: {
-        const t0 = performance.now();
-        const fingerprint = getFingerprint({ debug: true });
-        const t1 = performance.now();
-
-        const result = `Fingerprint: ${fingerprint} (computed in ${(t1 - t0).toFixed(0)} ms)`;
-        console.log(result);
-        document.getElementById('default').innerText = result;
-      }
-
-      args_hardwareOnly: {
-        const t0 = performance.now();
-        const fingerprint = getFingerprint({ hardwareOnly: true, debug: true });
-        const t1 = performance.now();
-
-        const result = `Fingerprint with hardwareOnly=true: ${fingerprint} (computed in ${(t1 - t0).toFixed(0)} ms)`;
-        console.log(result);
-        document.getElementById('hardwareOnly').innerText = result;
-      }
-
-      args_enableWebgl: {
-        const t0 = performance.now();
-        const fingerprint = getFingerprint({ enableWebgl: true, debug: true });
-        const t1 = performance.now();
-
-        const result = `Fingerprint with enableWebgl=true: ${fingerprint} (computed in ${(t1 - t0).toFixed(0)} ms)`;
-        console.log(result);
-        document.getElementById('enableWebgl').innerText = result;
-      }
-    </script>
-  </body>
-</html>

package/src/index.spec.js

@@ -1,53 +0,0 @@
-import { describe, it, beforeAll, afterAll, expect } from 'vitest';
-import puppeteer from 'puppeteer';
-
-describe('getBrowserFingerprint', () => {
-  let browser, page;
-
-  beforeAll(async () => {
-    browser = await puppeteer.launch({
-      // headless: false,
-      // devtools: true,
-    });
-    page = await browser.newPage();
-
-    await page.addScriptTag({
-      type: 'module',
-      path: './src/index.js',
-    });
-  });
-
-  afterAll(async () => {
-    await browser.close();
-  });
-
-  it('works without args', async () => {
-    const result = await page.evaluate(() => {
-      const result = window.getBrowserFingerprint();
-      return result;
-    });
-
-    expect(typeof result).toBe('number');
-    expect(String(result).length).toBeGreaterThanOrEqual(7);
-  });
-
-  it('works without hardwareOnly=true', async () => {
-    const result = await page.evaluate(() => {
-      const result = window.getBrowserFingerprint();
-      return result;
-    });
-
-    expect(typeof result).toBe('number');
-    expect(String(result).length).toBeGreaterThanOrEqual(7);
-  });
-
-  it('works with enableWebgl=true', async () => {
-    const result = await page.evaluate(() => {
-      const result = window.getBrowserFingerprint({ enableWebgl: true });
-      return result;
-    });
-
-    expect(typeof result).toBe('number');
-    expect(String(result).length).toBeGreaterThanOrEqual(7);
-  });
-});