Gathering detailed insights and metrics for oauth-pkce
Gathering detailed insights and metrics for oauth-pkce
OAUTH PKCE code_verifier and code_challenge Generator for IE 11 and Modern Browsers
Installations
npm install oauth-pkceDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
14.21.3
NPM Version
6.14.18
Releases
Unable to fetch releases
Languages
2
TypeScript
HTML
TypeScript (69.84%)
HTML (30.16%)
Developer
coolgk
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
11 Stars
31 Commits
1 Forks
2 Watchers
15 Branches
2 Contributors
Updated on Apr 22, 2024
Maintainers
2
Package Meta Information
Latest Version
0.0.7
Package Id
oauth-pkce@0.0.7
Unpacked Size
13.18 kB
Size
4.72 kB
File Count
10
NPM Version
6.14.18
Node Version
14.21.3
Published on
Apr 22, 2024
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
Dev Dependencies
25
@size-limit/file@types/chai@types/crypto-js@types/mocha@types/node@types/sinon@typescript-eslint/eslint-plugin@typescript-eslint/parserchaicross-envcrypto-jseslinteslint-config-prettiereslint-plugin-prettiereslint-plugin-securityhuskylint-stagedmochaprettiersinonsize-limitsource-map-supportts-nodetypescriptuglify-js
OAUTH PKCE code_verifier and code_challenge Generator for IE 11 and Modern Browsers
Proof Key for Code Exchange Spec
A small (409-Byte gzipped) zero-dependency helper function for generating a high-entropy cryptographic random "code_verifier" (using Web Crypto API) and its "code_challenge" based on RFC 7636. (i.e. BASE64URL-ENCODE(SHA256(ASCII(code_verifier))))
This package does NOT use Math.random() which does not provide cryptographically secure random numbers, and should not use them for anything related to security.
Browser ONLY
This package is for browsers only (including IE 11), it uses Web Crypto API for generating random strings and SHA-256 hashing.
CDN
https://cdn.jsdelivr.net/npm/oauth-pkce@latest/dist/oauth-pkce.min.js
or with version
https://cdn.jsdelivr.net/npm/oauth-pkce@0.0.2/dist/oauth-pkce.min.js
Usage
npm i oauth-pkce
Typescript Ready
1import getPkce from 'oauth-pkce'; 2 3// create a verifier of 43 characters long 4getPkce(43, (error, { verifier, challenge }) => { 5 if (!error) { 6 console.log({ verifier, challenge }); 7 } 8}); 9 10// { verifier: "uxr7S_52pCoOPFpPPYWNvdw76k3ZnSN-J0PvD0iPL9B", challenge: "8L_tpjLD-Vcc3-G6ea2ifym8AQrushivXHMib5zPp1A" }
Use directly from CDN
1<script src="https://cdn.jsdelivr.net/npm/oauth-pkce@0.0.2/dist/oauth-pkce.min.js" async defer></script>; 2 3getPkce(43, (error, { verifier, challenge }) => { 4 if (!error) { 5 console.log({ verifier, challenge }); 6 } 7});
React
1import React, { useEffect, useState } from 'react'; 2import getPkce from 'oauth-pkce'; 3 4function Pkce() { 5 const { pkce, setPkce } = useState({}); 6 7 useEffect(() => { 8 // getPkce relies on the window object for its crypto api 9 // put in in useEffect 10 getPkce(50, (error, { verifier, challenge }) => { 11 setPkce({ verifier, challenge }); 12 }); 13 }, []); 14 15 return ( 16 <div> 17 {pkce.verifier} | {pkce.challenge} 18 </div> 19 ); 20}
This package uses callback style for minimising code size and compatibility with IE 11. Wrapp it in a Promise if you prefer async await style.
1const { verifier, challenge } = await new Promise((resolve) => { 2 getPkce(43, (error, { verifier, challenge }) => { 3 if (error) throw error; 4 resolve({ verifier, challenge }); 5 }); 6});
Server Side code_verifier Verification
For node environment, use crypto module natively from node.
1import crypto from 'crypto'; 2 3const base64 = crypto.createHash('sha256').update(code_verifier).digest('base64'); 4const base64UriEncoded = base64.replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/, ''); 5 6const isValid = base64UriEncoded === code_challenge;
code_challenge is a Base64URL encoded string (RFC 4648). To verify the code_verifier you need to convert the base64 value of crypto.createHash('sha256').update(code_verifier).digest('base64') to a base64url encoded string.
In getPkce(), base64url removes the pad characters "=" from code_challenge
API
1getPkce( 2 codeVerifierLength: number = 43, 3 callback: (error: Error | null, value: { verifier: string; challenge: string }) 4)
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 1/7 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 29 are checked with a SAST tool
Reason
43 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-xwcq-pm8m-c4vf
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
- Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
- Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
- Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
- Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
- Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
- Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
- Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Score
1.9
/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