https://github.com/iambumblehead/pkce-pair

pkce-pair creation and validation in node and browser runtimes
https://github.com/iambumblehead/pkce-pair

code-challenge oauth2 pkce

Last synced: 23 days ago
JSON representation

pkce-pair creation and validation in node and browser runtimes

• Host: GitHub
• URL: https://github.com/iambumblehead/pkce-pair
• Owner: iambumblehead
• Created: 2021-10-19T20:14:50.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-10-20T15:29:35.000Z (about 3 years ago)
• Last Synced: 2024-10-02T21:18:09.949Z (about 1 month ago)
• Topics: code-challenge, oauth2, pkce
• Language: JavaScript
• Homepage:
• Size: 18.6 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
pkce-pair

=========

**(c)[Bumblehead][0]**

[![npm version](https://badge.fury.io/js/pkce-pair.svg)](https://badge.fury.io/js/pkce-pair) [![Build Status](https://github.com/iambumblehead/pkce-pair/workflows/nodejs-ci/badge.svg)][2]

Creates and validates [PKCE-pairs][12] for node and browser environments. `pkce-pair` copies from projects [here][10] and [here.][11] PKCE-pair brings together a few things missing from other PKCE packages out there,

  * works with node and browser crypto,

  * returns Promises and not callbacks to use browser `window.crypto`

If you're using PKCE pairs in a node server environment _only_ and not a browser environment, [consider using the pkce-challenge package][11] to generate synchronous pkce values instead (browser `window.crypto` is asynchronous).

[10]: https://github.com/coolgk/utils/

[11]: https://github.com/crouchcd/pkce-challenge

[12]: https://datatracker.ietf.org/doc/html/rfc7636#section-4.1

```javascript

import pkcePair, {

  create,

  createVerifier,

  createChallenge,

  isVerified

} from 'pkce-pair';

```

call imported functions with a node or browser `crypto` object,

```javascript

import pkcePair from 'pkce-pair';

import crypto from 'crypto';

const pair = await pkcePair(crypto);

const isVerified = await isVerified(crypto, pair.verifier, pair.challenge);

console.log(isVerified); // true

```

another example, using browser `window.crypto`

```javascript

import pkcePair from 'pkce-pair';

const pair = await pkcePair(window.crypto);

const challenge = await pkcePair.createChallenge(window.crypto, pair.verifier);

const isVerified = await isVerified(window.crypto, pair.verifier, challenge);

console.log(isVerified); // true

```

![scrounge](https://github.com/iambumblehead/scroungejs/raw/master/img/hand.png)

(The MIT License)

Copyright (c) [Bumblehead][0] 

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

[0]: http://www.bumblehead.com                            "bumblehead"

[2]: https://github.com/iambumblehead/pkce-pair "pkce-pair"