> This README is for virgil-pythia v1.0.x. Check the v0.2.7 branch for virgil-pythia docs.

Virgil Pythia Node.js SDK



Introduction | SDK Features | Install and configure SDK | Usage Examples | Docs | Support

Introduction

Virgil Security provides an SDK which allows you to communicate with Virgil Pythia Service
and implement Pythia protocol for the following use cases:.

Breach-proof password*. Pythia is a technology that gives you a new, more secure mechanism that "breach-proofs" user
passwords and lessens the security risks associated with weak passwords by providing cryptographic leverage for the
defender (by eliminating offline password cracking attacks), detection for online attacks, and key rotation to recover
from stolen password databases.
BrainKey*. User's Private Key which is based on user's password. BrainKey can be easily restored and is resistant to
online and offline attacks.

In both cases you get the mechanism which assures you that neither Virgil nor attackers know anything about user's
password.

SDK Features

- communicate with Virgil Pythia Service
- manage your Pythia application credentials
- create, verify and update user's breach-proof password
- generate user's BrainKey
- use [Virgil Crypto Pythia library][_virgil_crypto_pythia]

Install and configure SDK

Install Pythia SDK with the following code:
``bash
npm install virgil-pythia
`

You will also need to install the virgil-crypto, @virgilsecurity/pythia-crypto and virgil-sdk packages.
`bash
npm install virgil-crypto @virgilsecurity/pythia-crypto virgil-sdk
`

$3

The library needs the following information from your [Virgil Dashboard][_dashboard] account:

| Parameter | Description | Purpose |
| --- | --- | --- |
| API_KEY_ID | Id of the API Key | Used for JWT generation |
| API_KEY | The private key of the API Key | Used for JWT generation |
| APP_ID | Id of the Pythia App | Used for JWT generation |
| PROOF_KEY | The Proof Key of the Pythia App | Used to verify the cryptographic proof that transformed password returned form service is correct |

Here is an example of how to configure the library for work with Virgil Pythia Service:

`javascript

import { initPythia, VirgilPythiaCrypto } from '@virgilsecurity/pythia-crypto';
import { initCrypto, VirgilCrypto, VirgilAccessTokenSigner } from 'virgil-crypto';
import { createPythia } from 'virgil-pythia';
import { JwtGenerator, GeneratorJwtProvider } from 'virgil-sdk';

Promise.all([initCrypto(), initPythia()])
.then(() => {
const virgilCrypto = new VirgilCrypto();
const virgilPythiaCrypto = new VirgilPythiaCrypto();
const jwtGenerator = new JwtGenerator({
apiKey: crypto.importPrivateKey(process.env.API_KEY),
apiKeyId: process.env.API_KEY_ID,
appId: process.env.APP_ID,
accessTokenSigner: new VirgilAccessTokenSigner(crypto),
});
const accessTokenProvider = new GeneratorJwtProvider(jwtGenerator);
const pythia = createPythia({
virgilCrypto,
virgilPythiaCrypto,
accessTokenProvider,
proofKeys: [
process.env.PROOF_KEY,
],
});
});
`

Usage Examples

Virgil Pythia SDK lets you create, verify and update user's breach-proof password using Virgil Crypto library.

First of all, you need to set up your database to store users' breach-proof passwords. Create additional columns in your database for storing the following parameters:

Parameters	Type	Size (bytes)	Description
salt	blob	32	Unique random string that is generated by Pythia SDK for each user
deblindedPassword	blob	384	user's breach-proof password
version	int	4	Version of your Pythia Application credentials. This parameter has the same value for all users unless you generate new Pythia credentials on Virgil Dashboard

Now we can start creating breach-proof passwords for users. Depending on the situation, you will use one of the
following Pythia SDK functions:
- createBreachProofPassword is used to create a user's breach-proof password (e.g. during registration).
- verifyBreachProofPassword is used to verify a user's breach-proof password (e.g. during authentication).

$3

Use this flow to create a new breach-proof password for a user.

> Remember, if you already have a database with user passwords, you don't have to wait until a user logs in into your
system to implement Pythia.
You can go through your database and create breach-proof user passwords at any time.

So, in order to create a user's breach-proof password for a new database or existing one, take the following actions:
- Take a user's password (or its hash or whatever you use) and pass it into the createBreachProofPassword function.
- Pythia SDK will blind the password, send a request to Pythia Service to get a transformed blinded password and
de-blind the transformed blinded password into a user's deblinded password (breach-proof password).

`javascript
// create a new Breach-proof password using user's password or its hash
pythia.createBreachProofPassword('USER_PASSWORD')
.then(bpPassword => {
// save the breach-proof password parameters into your database
console.log(bpPassword.salt.toString('base64')); // salt is a Buffer
console.log(bpPassword.deblindedPassword.toString('base64')); // deblindedPassword is a Buffer
console.log(bpPassword.version);
});
`

The result of calling createBreachProofPassword is an object containing parameters mentioned previously (salt,
deblindedPassword, version),
save these parameters into corresponding columns in your database.

Check that you've updated all database records and delete the now unnecessary column where users' passwords were
previously stored.

$3

Use this flow when you need to verify that the user-provided plaintext password matches the breach-proof password stored
in your database. You will have to pass their plaintext password into the verifyBreachProofPassword function:

`javascript
import { BreachProofPassword } from 'virgil-pythia';

// get user's Breach-proof password parameters from your users DB
// ...
// assuming user is the object representing your database record
const bpPassword = new BreachProofPassword(user.salt, user.deblindedPassword, user.version);

// calculate user's Breach-proof password parameters
// compare these parameters with parameters from your DB
pythia.verifyBreachProofPassword('USER_PASSWORD', bpPassword, false)
.then(verified => {
console.log(verified); // true if the plaintext password matches the stored one, otherwise false
});
`

The difference between the verifyBreachProofPassword and createBreachProofPassword functions is that the
verification of Pythia Service's response is optional in verifyBreachProofPassword function, which allows you
to achieve maximum performance when processing data. You can turn on the proof step in verifyBreachProofPassword
function if you have any suspicions that a user or Pythia Service were compromised.

$3

This step will allow you to use an updateToken in order to update users' breach-proof passwords in your database.

> Use this flow only if your database was COMPROMISED.

How it works:
- Open your Pythia app page in Virgil Dashboard and press the "My Database Was Compromised" button.
- Pythia Service generates a special updateToken and new Proof Key.
- You then specify new Pythia Application credentials in the Pythia SDK on your Server side.
- Then you use updateBreachProofPassword function to create new breach-proof passwords for your users.
- Finally, you save the new breach-proof passwords into your database.

Here is an example of using the updateBreachProofPassword function:
`javascript
//get previous user's breach-proof password parameters from a compromised DB

// ...

// set up an updateToken that you got on the Virgil Dashboard
// update previous user's deblindedPassword and version, and save new one into your DB

const updatedBpPassword = pythia.updateBreachProofPassword('UT.1.2.UPDATE_TOKEN', bpPassword);
console.log(updatedBpPassword.deblindedPassword.toString('base64'));
console.log(updatedBpPassword.version);
`

$3

PYTHIA Service can be used directly as a means to generate strong cryptographic keys based on user's password or other secret data. We call these keys the BrainKeys. Thus, when you need to restore a Private Key you use only user's Password and Pythia Service.

In order to create a user's BrainKey, go through the following operations:
- Register your E2EE application on [Virgil Dashboard][_dashboard] and get your app credentials
- Generate your API key or use available
- Set up JWT provider using previously mentioned parameters (App ID, API key, API key ID) on the Server side
- Generate JWT token with user's identity inside and transmit it to Client side (user's side)
- On Client side set up access token provider in order to specify JWT provider
- Setup BrainKey function with access token provider and pass user's password
- Send BrainKey request to Pythia Service
- Generate a strong cryptographic keypair based on a user's password or other user's secret


#### Generate BrainKey based on user's password
`html














`

#### Generate BrainKey based on unique URL
The typical BrainKey implementation uses a password or concatenated answers to security questions to regenerate the user’s private key. But a unique session link generated by the system admin can also do the trick.

This typically makes the most sense for situations where it’s burdensome to require a password each time a user wants to send or receive messages, like single-session chats in a browser application.

Here’s the general flow of how BrainKey can be used to regenerate a private key based on a unique URL:
- When the user is ready to begin an encrypted messaging session, the application sends the user an SMS message
- The SMS message contains a unique link like https://healthcare.app/?session=abcdef13803488
- The string 'abcdef13803488' is used as a password for the private key regeneration
- By clicking on the link, the user immediately establishes a secure session using their existing private key regenerated with Brainkey and does not need to input an additional password

Important notes for implementation:
- The link is one-time use only. When the user clicks on the link, the original link expires and cannot be used again, and so a new link has to be created for each new chat session.
- All URL links must be short-lived (recommended lifetime is 1 minute).
- The SMS messages should be sent over a different channel than the one the user will be using for the secure chat session.
- If you’d like to add additional protection to ensure that the person clicking the link is the intended chat participant, users can be required to submit their name or any other security question. This answer will need to be built in as part of the BrainKey password.

`javascript
...
brainKey.generateKeyPair('abcdef13803488', 'optional_user_ssn')
.then(keyPair => {
console.log(keyPair);
});
...
`
> Note! if you don't need to use additional parameters, like "Optional User SSN", you can just omit it: brainKey.generateKeyPair('abcdef13803488')`

Docs

Virgil Security has a powerful set of APIs, and the documentation below can get you started today.

* [Breach-Proof Password][_pythia_use_case] Use Case
* [Brain Key][_brain_key_use_case] Use Case
* The Pythia PRF Service - foundation principles of the protocol
* [Virgil Security Documentation][_documentation]

License

This library is released under the 3-clause BSD License.

Support

Our developer support team is here to help you. Find out more information on our Help Center.

You can find us on Twitter or send us email support@VirgilSecurity.com.

Also, get extra help from our support team on Slack.

[_virgil_crypto_pythia]: https://github.com/VirgilSecurity/pythia
[_brain_key_use_case]: https://developer.virgilsecurity.com/docs/use-cases/v1/brainkey
[_pythia_use_case]: https://developer.virgilsecurity.com/docs/go/use-cases/v1/breach-proof-password
[_documentation]: https://developer.virgilsecurity.com/
[_dashboard]: https://dashboard.virgilsecurity.com/