Installations

npm install simple-pkce-web-crypto

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

12.18.4

NPM Version

6.14.8 Score

71.4

Supply Chain

84.5

Quality

75.4

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

2

JavaScript

TypeScript

JavaScript (71.35%)

TypeScript (28.65%)

Developer

yarsky-tgz

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

MIT License

7 Commits

1 Watchers

1 Branches

1 Contributors

Updated on Oct 15, 2020

Maintainers

1

View All 1 Contributors

Package Meta Information

Latest Version

1.0.2

Package Id

simple-pkce-web-crypto@1.0.2

Unpacked Size

17.37 kB

Size

4.73 kB

File Count

13

NPM Version

6.14.8

Node Version

12.18.4

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

abstract-pkce

Dev Dependencies

12

@types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-airbnb-typescript eslint-config-prettier eslint-plugin-import husky lint-staged prettier ts-node typescript

simple-pkce-web-crypto

PKCE helper, generates verify & challenge with preconfigured type (HMAC or hash) algorithm and digest encoding using Web Crypto API

Installation

1npm i simple-pkce-web-crypto

Usage

Library exports single function - createPKCEHelper(algorithm = 'SHA-256', encoding = 'base64', isHMAC = true)

This function returns object with two async methods on it:

getChallenge(verifier: string) => Promise<string> - for getting challenge from verifier
generateChallenge(verifierLength: number) => Promise<PKCEChallenge> - generates verifier of given length and returns Promise<PKCEChallenge>:

1interface PKCEChallenge {
2    verifier: string;
3    challenge: string;
4}

Examples

if you need SHA256 base64 HMAC challenge:

1import { createPKCEHelper, PKCEChallenge, PKCEHelperWebCrypto } from 'simple-pkce-web-crypto'
2
3(async () => {
4  const VERIFIER_LENGTH = 64
5  const { generateChallenge }: PKCEHelperWebCrypto = createPKCEHelper()
6  const { verifier, challenge }: PKCEChallenge = await generateChallenge(VERIFIER_LENGTH)
7})()

You can use any other algorithm:

1import { createPKCEHelper, PKCEChallenge, PKCEHelperWebCrypto } from 'simple-pkce-web-crypto'
2
3(async () => {
4  const VERIFIER_LENGTH = 80
5  const { generateChallenge }: PKCEHelperWebCrypto = createPKCEHelper('SHA-512')
6  const { verifier, challenge }: PKCEChallenge = await generateChallenge(VERIFIER_LENGTH)
7})()

1import { createPKCEHelper, PKCEChallenge, PKCEHelperLegacyBrowser } from 'simple-pkce-web-crypto'
2
3(async () => {
4  const VERIFIER_LENGTH = 80
5  const { generateChallenge }: PKCEHelperLegacyBrowser = createPKCEHelper('SHA-224', 'hex', false)
6  const { verifier, challenge }: PKCEChallenge = await generateChallenge(VERIFIER_LENGTH)
7})()

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More