Empty project structure outline (based on @httptoolkit/httpolyglot)

Author: pimterry

.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    name: Build & test
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, v16.x, v16.16.0, v18.x, '*']
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - run: npm install
+      - run: npm test

.npmrc

@@ -0,0 +1 @@
+package-lock=false

README.md

@@ -1 +1,5 @@
-# read-tls-fingerprint
+# Read-TLS-Fingerprint [![Build Status](https://github.com/httptoolkit/read-tls-fingerprint/workflows/CI/badge.svg)](https://github.com/httptoolkit/read-tls-fingerprint/actions) [![Available on NPM](https://img.shields.io/npm/v/read-tls-fingerprint.svg)](https://npmjs.com/package/read-tls-fingerprint)
+
+> _Part of [HTTP Toolkit](https://httptoolkit.tech): powerful tools for building, testing & debugging HTTP(S)_
+
+A pure-JS module to read TLS fingerprints from an incoming socket connection. Using this, you can recognize certain TLS clients - e.g. specific browser, cURL, or even the specific versions of a specific programming language a client is using - regardless of the content of the request they send.

package.json

@@ -0,0 +1,50 @@
+{
+  "name": "read-tls-fingerprint",
+  "version": "1.0.0",
+  "author": "Tim Perry <[email protected]>",
+  "description": "A pure-JS module to read TLS fingerprints from an incoming socket connection",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/",
+    "src/"
+  ],
+  "scripts": {
+    "prebuild": "rimraf dist/*",
+    "build": "tsc",
+    "prepack": "npm run build",
+    "pretest": "npm run build",
+    "test": "mocha -r ts-node/register 'test/**/*.spec.ts'"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "keywords": [
+    "tls",
+    "fingerprint",
+    "fingerprinting",
+    "https"
+  ],
+  "licenses": [
+    {
+      "type": "Apache-2.0",
+      "url": "http://github.com/httptoolkit/read-tls-fingerprint/raw/main/LICENSE"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/httptoolkit/read-tls-fingerprint.git"
+  },
+  "dependencies": {
+    "@types/node": "^16.7.10"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.2.21",
+    "@types/mocha": "^9.0.0",
+    "chai": "^4.3.4",
+    "mocha": "^10.0.0",
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.8.4"
+  }
+}

src/index.ts

@@ -0,0 +1,19 @@
+-----BEGIN CERTIFICATE-----
+MIIDJzCCAg+gAwIBAgIUfxc7qPwEIlAJQtS+67g2MhKq9zkwDQYJKoZIhvcNAQEL
+BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MCAXDTIxMDgzMDE1MjUxNFoYDzIxMjEw
+ODA2MTUyNTE0WjAUMRIwEAYDVQQDDAlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEB
+AQUAA4IBDwAwggEKAoIBAQC4Cf55DdM7CE40miw2k2B1m+gihcHl+GkEu5ulrX9i
+NbgqsWC3FixNMejDk0DdyEi2QGdQNFha7w/jlQ/u4HGJTQBmKsqVFaV03N/dnnCV
+3yll7tjDJoA7yxohGSs2ouOhvytM/w2JflJ/bV5OWhsTrbV8V7omPGm83F/3RXer
+r76VUvhNbtpwc/QEV+zZ9HWDA9p+bjtsusFb+HD4XIn7lYfBBXQgUfGFJR1VCftQ
+7b8VCoMZTGj6+NL1+k+EQvgdlwi2u7BfXYI1q765gUk5XS3/eennvOKi8Jn5kzuh
+gQRyhErzYHwKv+KUYvJvOctIjHL6egNUqeVXYB3Q9AphAgMBAAGjbzBtMB0GA1Ud
+DgQWBBRWMwFWKMABMs5WSuxEnFoYPwlAUjAfBgNVHSMEGDAWgBRWMwFWKMABMs5W
+SuxEnFoYPwlAUjAPBgNVHRMBAf8EBTADAQH/MBoGA1UdEQQTMBGCCWxvY2FsaG9z
+dIcEfwAAATANBgkqhkiG9w0BAQsFAAOCAQEAdjlHqfdKUdEdGofuL5CLMOZtMgmU
+7BYRuBVkBBRb+aysRf+vb8OvmCHK+j4HzWe5hlsrJkyDhvTWQ6IMxuufEdK9NwOX
+8zLut+k7N7LRkJvqC+RX8bbD+2a56n+TJjdvCqsyBFyuYdlxw07s7So2gW818ooK
+qTJSAjBcSkrdgZhYOEkG/AWKkelZRw2R9WLQv5wB2b+R7q0wrGtB2b9IXOs6JTaS
+HA5dFMDW8YaGiUQLm53eEZeTeZg+l5+izl4mTi4ytV4xa5KDyQTzzTttkLHK4cb3
+kVgGmAHsFu5/W1u/1u/WG/JnUW1XeEml7HVRuyA2E+GWCJc2fvTd4A0DaQ==
+-----END CERTIFICATE-----

test/fixtures/server.crt

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQC4Cf55DdM7CE40
+miw2k2B1m+gihcHl+GkEu5ulrX9iNbgqsWC3FixNMejDk0DdyEi2QGdQNFha7w/j
+lQ/u4HGJTQBmKsqVFaV03N/dnnCV3yll7tjDJoA7yxohGSs2ouOhvytM/w2JflJ/
+bV5OWhsTrbV8V7omPGm83F/3RXerr76VUvhNbtpwc/QEV+zZ9HWDA9p+bjtsusFb
++HD4XIn7lYfBBXQgUfGFJR1VCftQ7b8VCoMZTGj6+NL1+k+EQvgdlwi2u7BfXYI1
+q765gUk5XS3/eennvOKi8Jn5kzuhgQRyhErzYHwKv+KUYvJvOctIjHL6egNUqeVX
+YB3Q9AphAgMBAAECggEAYCeQlizb/Q7U1XTrvsP3dNs1SLw712yXagqfQsvIL0bD
+50JvtpjWIqr94xkPnhCjtN0nXWdL9o7K7WwXPAZ2K3dYywh2ebgqj0lLiZ3bUuKa
+3ZASHrwB6buu9jYRNuWaKwsXk436w6iFb+BzklpPpVNv6/xl3M5ZrHwzg5z+7mrs
+LQ83IgjFe6kVnkLYFPWLrFEsoiS3jOoILiDCUO5k4j0ZNYjRlmPpG7Iq+oPv+0rf
+JHiOV1Q9L1SMeubYSZ7NSiKPAqbi93BjJOpbNS2BrSL5YPt5pp8tKhwLj0gB8hux
++XBwpn8GwwUypNy0YdbtYbLs/CbPcg1t5NEvhkrysQKBgQDfnBiQck9Xd8nqvwkb
+N0nw5UBXiPoKqHOxfQC5fsYjNdwKEvUj4OiGwAFtUwTSMqyqdmrj1Sy9SUuYfm3w
+ehOdQnabVyxYZj5Z1nLrP+wtXdCWv66ezq2S4dRsygs2fuy3uiL+ryVMojlBYj6M
+s53ipMN3qjDKt2NmwGWt33DJrQKBgQDSsokjbg7OMDebiWoimViE+eWRJ3YEXAtk
+WnDttCcG0qEGVi2gqZh6NjnCpiK3+dC07Sh24wfW6TS9Z9SZeNPrQ3BTnY4e0EDC
+hLo4MXeSEeXa+ndlTzpNcw/q63RNlKg7L+FJOV7Q3HaHKZvmC+kw2Y2dI9zYlK+X
+RH9ymffCBQKBgHdJHS2JXVwK0hNBX8k+AFra4S0RLFodLMKlLYrG30oPRFe3b0B5
+jXG84cYBQJQlZkj1LOZnZRuBCyvJXjqn1OjSeNU7drOdr2tbZCitC//TiR+yF6Qu
+Gxg9EoYKblre8Ma+LEbzBhHQhHylvTpv4yzxujiO+MJbfFJnFpbfmJptAoGARxx4
+yptvpcmCSx1y0+Cbjq3k/DusSkZileksah2+ekAGluPpHGuBCeZZUkfOOfe3qAjO
++mkfkTo+UZrEl1O/eozVUXNAr0esQ7qWOzb+2y7tPB4CxA+cZt1pxujW5QRCT0+W
+oqcZSDbQTkgN1PO6LYGPmTSsafCs3soAlcY/Z50CgYBRhbOo9mq+hNXrKYifJwWZ
+dVzvlV1hJZ8ViXCzJIFwkcq9yokUwsppF/K+5c/fKN+6IWAwep7I7035GEAwtLTc
+J4oxpxDBYgHAON7OqHuns/xQ1Lvvg6fzAIQzR3NTXoPBSOyT2TbZJLDUf9jQ/TN/
+ts7xHGcDnvSUE/8RItnM5w==
+-----END PRIVATE KEY-----

test/fixtures/server.key

@@ -0,0 +1,33 @@
+import * as stream from 'stream';
+import * as fs from 'fs';
+
+export const testKey = fs.readFileSync(__dirname + '/fixtures/server.key');
+export const testCert = fs.readFileSync(__dirname + '/fixtures/server.crt');
+
+export type Deferred<T> = Promise<T> & {
+    resolve(value: T): void,
+    reject(e: Error): void
+}
+
+export function getDeferred<T>(): Deferred<T> {
+    let resolveCallback: (value: T) => void;
+    let rejectCallback: (e: Error) => void;
+    let result = <Deferred<T>> new Promise((resolve, reject) => {
+        resolveCallback = resolve;
+        rejectCallback = reject;
+    });
+    result.resolve = resolveCallback!;
+    result.reject = rejectCallback!;
+
+    return result;
+}
+
+export async function streamToBuffer(stream: stream.Readable): Promise<Buffer> {
+    const data: Buffer[] = [];
+    stream.on('data', (d) => data.push(d));
+
+    return new Promise((resolve, reject) => {
+        stream.on('end', () => resolve(Buffer.concat(data)));
+        stream.on('error', reject);
+    });
+}

test/test-util.ts

@@ -0,0 +1,5 @@
+describe("Read-TLS-Fingerprint", () => {
+    it("runs a test", () => {
+        // no-op
+    });
+});

test/test.spec.ts

@@ -0,0 +1,9 @@
+{
+    "extends": "../tsconfig.json",
+    "include": [
+        "../src/**/*.ts",
+        "../dist/**/*.d.ts",
+        "./**/*.ts",
+        "../package.json"
+    ]
+}