cognito-srp-browser-client
TypeScript icon, indicating that this package has built-in type declarations

0.1.5 • Public • Published

# cognito-srp-browser-client

Amazon Cognito Secure Remote Password client protocol for browsers.

This package is designed to be used on a modern web browser, primarily to provide SRP for the SDK v3 @aws-sdk/client-cognito-identity-provider package.

SubtleCrypto is used for cryptography. It is only available in secure (e.g. https://) contexts, and so this package will not work otherwise. Note that for development, Chrome considers http://localhost as secure.

History

This package is forked from cognito-srp. It has been updated to work on modern browsers natively, without the need for node.js polyfills. The cognito-srp package provides server functionality which has been stripped out of this package.

The original cognito-srp package borrows heavily from the srp-js package, but implements a slight variant of the protocol in order to work with Amazon Cognito. Also inspired by bits from amazon-cognito-identity-js, the official client library.

Usage

First, install:

yarn add cognito-srp-browser-client

Then import. Your starting point will usually be the UserPool class:

import { UserPool } from ' cognito-srp-browser-client';

Instantiate a pool, using your pool name:

const userPool = new UserPool('7DZy4Fkn7');

Note that the pool name here is not the full UserPoolId that the AWS SDK asks for, i.e.:

const UserPoolId = 'us-east-2_7DZy4Fkn7';
const poolname = UserPoolId.split('_')[1];

Once the user has entered their username and password, you can create a challenge:

const challenge = await userPool.getClientChallenge({ username, password });

You can then make a request to the server with the user's username and a client key (A):

const A = challenge.calculateA();

The server will respond with the server key (B), the user's salt, and a secret block. The client can then create a session:

const session = await challenge.getSession(B, salt);

Then, the client can calculate the signature as proof that it knows the password:

const timestamp = getTimestamp();
const signature = await session.calculateSignature(secretBlock, timestamp);

The client sends the secret block, timestamp and signature back to the server, and its identity is established.

Notes

The exact format of the requests and responses to Amazon Cognito is outside the scope of this package – it only implements the SRP stuff, and you can wrap it in whatever protocol you want.

Although this library is compatible with Cognito and therefore successfully implements the Secure Remote Password protocol, I'm not a security expert, and I don't claim to understand the maths behind it – keep that in mind before you use it for something important.

Package Sidebar

Install

npm i cognito-srp-browser-client

Weekly Downloads

0

Version

0.1.5

License

ISC

Unpacked Size

61.6 kB

Total Files

26

Last publish

Collaborators

  • richard-underwood