npmpackage.info

Gathering detailed insights and metrics for @bity/oauth2-auth-code-pkce

Other packages similar to @bity/oauth2-auth-code-pkce

angular-auth-oidc-client

18.0.2

Angular Lib for OpenID Connect & OAuth2

angular-oauth2-oidc

17.0.2

Support for OAuth 2 and OpenId Connect (OIDC) in Angular. Already prepared for the upcoming OAuth 2.1.

react-oauth2-code-pkce

1.22.2

Provider agnostic react package for OAuth2 Authorization Code flow with PKCE

@badgateway/oauth2-client

2.4.2

OAuth2 client for browsers and Node.js. Tiny footprint, PKCE support

Gathering detailed insights and metrics for @bity/oauth2-auth-code-pkce

@bity/oauth2-auth-code-pkce

An OAuth 2.0 client that ONLY supports the Authorization Code flow with PKCE support.

2.13.0

Apache-2.0

TypeScript

774,860 1.7

Installations

npm install @bity/oauth2-auth-code-pkce

Pull Requests

Open

6

Total

22

Closed

16

Issues

Open

4

Total

15

Closed

11

Releases

Unable to fetch releases

Developer

BitySA

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

14.17.0

NPM Version

6.14.13 Statistics

52 Stars

70 Commits

17 Forks

3 Watching

7 Branches

2 Contributors

Updated on 23 Oct 2024

Languages

TypeScript (93.32%)

HTML (6.68%)

Total Downloads

Cumulative downloads

Total Downloads

774,860

Last day

90%

1,769

Compared to previous day

Last week

12%

5,267

Compared to previous week

Last month

-7.6%

21,765

Compared to previous month

Last year

-12.6%

256,231

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

browserify http-server typescript

Versions

OAuth2AuthCodePKCE client

A zero dependency OAuth 2.0 client supporting only the authorization code grant (RFC 6749 § 4.1) with PKCE (RFC 7636) for client side protection.

Currently the only Type/JavaScript implementation in public existence.

1 file implementation for easy auditing.

Installation

npm install @bity/oauth2-auth-code-pkce

Usage

See the source code of tests/panel.html. It's commented with helpful information.

Run npm run serve:tests and navigate to http://localhost:8080/tests/panel.html

This page acts as a test panel for various scenarios. Play around! :)

Modify the example to use the correct configuration.

Exposing other query string parameters on return

Some OAuth servers will return additional parameters to the requester. In order to access these they must be explicitly asked for:

config.explicitlyExposedTokens = ['open_id'];

Then this will be available as a property: accessContext.explicitlyExposedTokens.open_id.

Extra parameters which other OAuth servers require

It is probable you will encounter an OAuth server which requires some additional parameters. In order to pass extra parameters, add the following to the configuration:

config.extraAuthorizationParams = { 'some_query_string_param': 'value', ... };

If you have values which need to be computed at run-time and then passed, you can pass them like so:

oauth2.fetchAuthorizationCode({ 'another_query_string_param': computedValue });

Module systems supported

Module system	File
Browser (window)	index.umd.js
CommonJS (require e.g. nodejs)	index.js
TypeScript	index.ts

Development

Publishing to NPM

Grab the NPM-generated bity-oauth2-auth-code-pkce-*.tgz tarball from CI and then use npm publish $tarball to publish it to NPM.

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

SAST

Determines if the project uses static code analysis.

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

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 2024-11-25

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