@kineticcafe/app-identity v2.0.0

@kineticcafe/app-identity 2.0.0: AppIdentity for JavaScript

• code :: https://github.com/KineticCafe/app-identity/tree/main/ts/
• issues :: https://github.com/KineticCafe/app-identity/issues

Description

@kineticcafe/app-identity is the runtime-agnostic Typescript implementation of the Kinetic Commerce application identity proof algorithm as described in its spec.

This package cannot be used without a runtime adapter. See @kineticcafe/app-identity-node for the Node.js adapter. If a different runtime is required, see adapter.ts for the required functions.

Synopsis

import * as AppIdentity from '@kineticcafe/app-identity'
import { myRuntime } from './runtime'

// Required at program start.
AppIdentity.setRuntimeAdapter(myRuntime)

const app = { id, secret, version: 2 }
const proof = AppIdentity.generateProof(app)
AppIdentity.verifyProof(proof, app)

Installation

@kineticcafe/app-identity should be added to your list of dependencies in package.json.

$ npm add @kineticcafe/app-identity@^2.0

We discourage the use of AppIdentity for JavaScript in a browser because the App Identity algorithm requires the use of shared secrets for validation.

Semantic Versioning

AppIdentity uses a Semantic Versioning scheme with one significant change:

• When PATCH is zero (0), it will be omitted from version references.

Additionally, the major version will generally be reserved for specification revisions.

Contributing

AppIdentity for JavaScript welcomes contributions. This project, like all Kinetic Commerce open source projects, is under the Kinetic Commerce Open Source Code of Conduct.

AppIdentity for Elixir is licensed under the Apache License, version 2.0 and requires certification via a Developer Certificate of Origin. See Licence for more details.