Overview

OIDC PKCE is a package for generating PKCE parameters (code_verifier, code_challenge), nonce, and state for OpenID Connect authentication. It simplifies secure authentication flows in web applications.

Installation

using npm

npm install oidc_pkce

using yarn

yarn add oidc_pkce

Usage

import { generatePKCEandNONCEandState } from 'oidc_pkce';

const params = await generatePKCEandNONCEandState(
    useNONCE=true, 
    useSTATE=true, 
    usePKCE=true, 
    codeChallengeMethod='S256',
    codeVerifierLength=64,
    stateLength=32,
    nonceLength=32
    );

console.log(params);

{
    "state": "XLNsfvqqlTE9QJxt7lqeJOIkh47VV8p6",
    "nonce": "LswwqA9qb3KYQTrxzzqoSwbLgBbXXmx7",
    "code_verifier": "QRPu08SgpA088cfsXFSruGJzvavfQlQ4LuzvlwpLGrLjgRTTy5nzonga96VsDBJR",
    "code_challenge": "-_0S2uSeCqGW6q7tGPnonsBZVb5IUr_iX_wLSqA34Qc",
    "code_challenge_method": "S256"
}

Explain generatePKCEandNONCEandState Parameters

- useNONCE (optional, default: true): Whether to include a nonce in the generated parameters.
- useSTATE (optional, default: true): Whether to include a state in the generated parameters.
- usePKCE (optional, default: true): Whether to include PKCE parameters (code_verifier and code_challenge) in the generated parameters.
- codeChallengeMethod (optional, default: 'S256'): The method used to generate the code_challenge. Supported values: 'plain' or 'S256'.
- codeVerifierLength (optional, default: 64): The length of the code_verifier to generate.
- stateLength (optional, default: 32): The length of the state to generate.
- nonceLength (optional, default: 32): The length of the nonce to generate.
- Returns an object containing the generated parameters.

License

Copyright © 2023, Hamad Almogbl. Released under the MIT License.