Data and security

Security

Pinned and hashed releases, open source with provenance, narrow keys, and code that fails safe.

Parlox runs code on your pages and your server, so the first question is what that code can do to your site. The answer is designed to be as small as possible, and checkable.

Open source

What you install is public, under the MIT licence: github.com/parlox-io/parlox-js holds @parlox/browser, @parlox/server, the install wizard and the Google Tag Manager template, with their tests. The gateway and the dashboard are Parlox's own service and are not in that repository.

Releases you can verify

  • Published only from CI. Every release with code is published only by the public repository's release workflow, through npm trusted publishing: no npm token exists. A maintainer must approve each release, and the workflow's actions are pinned to full commit hashes.
  • Provenance. Every release with code carries an SLSA provenance attestation, recorded in the public Sigstore log, that links it to the commit and the workflow run that built it. (The placeholder versions that reserved the package names contain no code.) Check it in your own project:
Terminal
npm audit signatures
  • Immutable versions. A change to what runs on your pages always gets a new version. With npm, your lockfile pins the one you reviewed.

A tag that cannot change under you

The pinned tag names one release and carries its SHA-384 integrity hash. The browser runs exactly that file or nothing: even if Parlox's server were compromised, it could not change what runs on your page. The tag loads its recorder with a second hash built into it, so pinning the tag pins the whole chain. From release 1.0.3, each release of the tag is the very file shipped in the npm package of the same version. Releases are served with Cache-Control: immutable.

Code that fails safe

In the browser:

  • Every listener and every hook the browser part installs is wrapped, so it can never throw into your page.
  • Functions it wraps (fetch, XMLHttpRequest.open, history.pushState, dataLayer.push) keep their behaviour and their return values exactly.
  • It loads async, and nothing on the page waits for it. If Parlox is unreachable, beacons wait in the tab's sessionStorage and are sent again later (up to four attempts within ten minutes, 30 beacons at most), then dropped.
  • A page that has frozen fetch, XMLHttpRequest or history loses that one source of events, never the tracker.

On the server:

  • Reports go in the background, never delaying the response or failing it; every send gives up after two seconds (ten for a batch). The Next.js and Vercel middleware report as the request arrives, before your page answers, so their reports carry no status. They never throw; failures go to your onError.
  • Work is bounded: a queue of at most 1,000 reports on a long-running server, at most 64 sent at once elsewhere, the excess counted rather than sent.
  • It never changes your framework's settings. It reads the client address only from a header a proxy you control sets, never from X-Forwarded-For as the client sent it, and installs no signal handlers.

Keys with the least access

  • The public key (pk_…) can only send data, never read any, and the gateway accepts its beacons only from pages on your site's own domain.
  • Secret keys (sk_parlox_…, a distinctive prefix that makes a leaked key easy to spot) are stored only as a hash and shown once, when created. Each has one access level, fixed at creation, and the key a new site gets, like every key the install wizard makes, can only send crawler reports. Revoking a key stops it at once on every gateway instance.

The details, and how to replace a key without downtime: Keys and access.

What Parlox will not do on your site's pages

  • Set cookies, or use any identifier that lasts beyond one browser tab.
  • Read values typed into fields or keystrokes, or page text beyond the labels and names of the controls clicked (one exception, in versions up to 1.0.3, is described in Masking).
  • Store an IP address: Parlox never writes one to its database. Addresses are compared with published ranges inside the request and dropped; the rate limiter holds them in memory only.
  • Record a visit it has judged to be a person (Agent recordings, with its edge case).

In the dashboard

A site is visible only to the members of the account it belongs to. Only an owner or an admin of that account can change its keys and settings; other members can read its data and use its tools, but change no keys or settings.

Reporting a vulnerability

Report it privately through GitHub: the Security tab of parlox-io/parlox-js, then Report a vulnerability. Please do not open a public issue. Reports are acknowledged within two business days, and the aim is a fix, as a new version, within seven days for anything that affects merchants' sites.