Server Side Fingerprint v1.6.0 Documentation

Table of contents

• Installation
• Description
• Usage example
• API
  • Types
  • generateFingerprint

Installation

npm i server-side-fingerprint

Description

Node.js library for generating server-side MD5 fingerprint hash from the operating system's data that looks like this:

{
  "EOL": "\n",
  "availableParallelism": 8,
  "arch": "arm64",
  "cpuInfo": [
    {
      "model": "Apple M1",
      "speed": 24
    },
    {
      "model": "Apple M1",
      "speed": 24
    },
    {
      "model": "Apple M1",
      "speed": 24
    },
    {
      "model": "Apple M1",
      "speed": 24
    },
    {
      "model": "Apple M1",
      "speed": 24
    },
    {
      "model": "Apple M1",
      "speed": 24
    },
    {
      "model": "Apple M1",
      "speed": 24
    },
    {
      "model": "Apple M1",
      "speed": 24
    }
  ],
  "devNull": "/dev/null",
  "endianness": "LE",
  "homedir": "/Users/datomarjanidze",
  "hostname": "Datos-MacBook-Air.local",
  "machine": "arm64",
  "platform": "darwin",
  "release": "23.1.0",
  "tmpdir": "/var/folders/9w/gl_7whfjvxw7h3ftnvz48s3c0000gn/T",
  "totalmem": 8181934592,
  "type": "Darwin",
  "userInfo": {
    "uid": 555,
    "gid": 41,
    "username": "datomarjanidze",
    "homedir": "/Users/datomarjanidze",
    "shell": "/bin/bash"
  },
  "version": "Darwin Kernel Version 23.1.0: Mon Mar  6 20:00:40 PST 2023; root:xnu-8791.102.1~5/RELEASE_ARM64_T8103"
}

Usage example

import { generateFingerprint } from 'server-side-fingerprint'

const fingerprint = generateFingerprint()
console.log(fingerprint) // 'a923cd82ad685819e1bcbd3acbab179f'

API

Types

import { UserInfo, CpuInfo } from 'node:os'

interface FingerprintData {
  EOL: string
  availableParallelism: number
  arch: string
  cpuInfo: CpuPartialInfo[]
  devNull: string
  endianness: string
  homedir: string
  hostname: string
  machine: string
  platform: string
  release: string
  tmpdir: string
  totalmem: number
  type: string
  userInfo: UserInfo<string>
  version: string
}

type CpuPartialInfo = Pick<CpuInfo, 'model' | 'speed'>

generateFingerprint()

• Returns: string

Generates the fingerprint.

generateFingerprintData()

• Returns: FingerprintData

Generates the data that is used for fingerprint creation.