README

Server-side PHP library for nymic browser fingerprints. Use it to compute a device ID from the data nymic collects in the browser, and to compare two IDs.

Requirements

PHP 8.2 or later
@azuradara/nymic in the browser

Install

composer require azuradara/logonymic

In the browser

pnpm add @azuradara/nymic

Collect the fingerprint and send worker with the order:

import { incant } from '@azuradara/nymic'

const { worker } = await incant()

await fetch('/orders', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ ...order, worker }),
})

Without a bundler, load it from jsDelivr and call Nymic.incant():

<script src="https://cdn.jsdelivr.net/npm/@azuradara/nymic/dist/nymic.js"></script>

On the server

Compute the nymic from worker:

use Logonymic\Nymic;

$nymic = Nymic::of(json_decode($request->getContent())->worker);

$nymic->neonymic;
$nymic->toArray();

You can pass Nymic::of() a JSON string, a decoded object or an array. In an array, an empty object and an empty list are both stored as []. Pass the raw JSON or an object when you can.

Field	Value
`neonymic`	Device and browser ID. Use it as the main ID.
`egonymic`	Device ID that stays the same across browser updates
`tribunymic`	Hardware model, shared by devices of the same model
`protonymic`	OS, browser and device type
`paleonymic`	Per-signal fragments, used for `similarity`

Store toArray() with the order.

Comparing two devices

use Logonymic\Level;
use Logonymic\Nymic;

$result = Nymic::from($order->nymic)->match(Nymic::from($previous->nymic));

$sameDevice = in_array($result->level, [Level::Browser, Level::Device], true);

You get a MatchResult from match(), with a level and a similarity from 0 to 1. Levels, from strongest to weakest.

Level	Meaning
`Browser`	Same `neonymic`: same browser on the same device
`Device`	Same `egonymic`: same device, after a browser update
`Similar`	`similarity` is at or above the threshold: the same device after a bigger change, or an identical device
`Model`	Same `tribunymic`: same hardware model
`None`	No match

The threshold is 0.8 by default:

$result = $a->match($b, threshold: 0.9);

You can get the same ID for two devices of the same model, OS and browser version. Combine the result with order data such as the phone number, address and IP.

Development

composer install
composer test
composer lint

License

MIT

azuradara / logonymic

Package info

Security

Statistics