🌜
🌞
oidc-client

oidc-client

v1.11.5

OpenID Connect (OIDC) & OAuth2 client library

npm install oidc-client

README

No Longer Maintained

This library, while functional, is no longer being maintained.

A successor project that is showing great progress in updating and modernizing is "oidc-client-ts" and can be found here.


npm package

oidc-client

Library to provide OpenID Connect (OIDC) and OAuth2 protocol support for client-side, browser-based JavaScript client applications. Also included is support for user session and access token management.

Install

Node.js

Node.js v4.4 or later required.

NPM

npm install oidc-client --save

NOTE: if you're not already using babel-polyfill make sure you run npm install --save babel-polyfill as well. Then include it in your build.

CommonJS

If you don't use a package manager or a module loader, then you can get the library from the dist folder on github here.

Including in the browser

If you intend to use this library directly in a browser and are not using UMD/AMD then there is a compiled version in the ~/dist folder. It is already bundled/minified and contains the necessary dependencies and polyfills (mainly for ES6 features such as Promises).

If you are using UMD/AMD and/or you already have included an ES6 polyfill (such as babel-polyfill.js) then you can include the UMD packaged version of the file from the ~/lib folder.

Building the Source

git clone https://github.com/IdentityModel/oidc-client-js.git
cd oidc-client-js
npm install
npm run build

Running the Sample

npm start

and then browse to http://localhost:15000.

Running the Tests

npm test

Docs

Some initial docs are here.

Feedback, Feature requests, and Bugs

All are welcome on the issue tracker.

Release Notes

1.11.5
By Brock Allen • Published on February 17, 2021

As part of this release we had 1 issue closed.

bug

  • #1305 metadataSeed improperly merged and returned
1.11.4
By Brock Allen • Published on February 13, 2021

As part of this release we had 1 issue closed.

bug

  • #1303 Revert "feat: merge openid-configuration and metdata"
1.11.3
By Brock Allen • Published on January 30, 2021

As part of this release we had 1 issue closed.

bug

  • #1258 Fix #1256: AuthCode w/ PKCE not supported for popups
1.11.2
By Brock Allen • Published on January 30, 2021

As part of this release we had 2 issues closed.

bugs

  • #1289 TS typings error in getToken for optional param
  • #1110 Typo in log message
1.11.1
By Brock Allen • Published on January 30, 2021

As part of this release we had 5 issues closed.

bugs

  • #1286 fix: remove getEpochTime from OidcClientSettings
  • #726 SessionMonitor always causes warning when using Bluebird

enhancements

  • #1173 Bump to jsrsasign version to '^8.0.17'
  • #1068 feat: merge openid-configuration and metdata
  • #1061 Package [email protected] contains vulnerability and should be upgraded
1.11.0
By Brock Allen • Published on January 29, 2021

As part of this release we had 17 issues closed.

bugs

  • #1240 fixed a bug with Iframe width and height
  • #1238 Keep existing id_token if not in token result
  • #1189 Fix UserManager.signoutCallback typing
  • #1071 Properly decode plus character in URLS
  • #977 Minor fix in readSignoutResponseState
  • #925 Remove the check for "inside a frame"
  • #861 Problem merging claims when array with JSON

enhancements

  • #1272 Add MetadataService.resetSigningKeys() type
  • #1269 Add UserSignedIn hooks to UserManagerEvents type
  • #1260 fix:Add optional to MetadataService.getTokenEndpoint in inde…
  • #1229 add optional refresh_token to SigninResponse
  • #1223 Add defensive checks in IFrameWindow.js callback
  • #1204 Render invisible iframes for silentRenew on Firefox
  • #1203 🏷️ fix: Add types for UserInfoService
  • #1129 Upgrade core-js package on last 3.* version
  • #1060 Add client_secret_basic auth exchangeCode Method. IdentityModel/oidc-client-js#892
  • #559 Adds retry behavior while fetching JWKS keys.
1.10.1
By Brock Allen • Published on December 18, 2019

As part of this release we had 2 issues closed.

bugs

  • #1017 New TypeScript typings don't allow optionless UserManager
  • #1015 v1.10.0 Build on TypeScript 2.9.2 Reporting Error TS1039
1.10.0
By Brock Allen • Published on December 16, 2019

As part of this release we had 2 issues closed.

bug

  • #954 fix: Angular 8 build error:

enhancement

  • #980 Please allow extraTokenParams to be configured via OidcClient settings
1.9.1
By Brock Allen • Published on August 31, 2019

As part of this release we had 1 issue closed.

bug

  • #931 "TypeError: Cannot read property 'id' of undefined" in validateSignoutResponse
1.9.0
By Brock Allen • Published on August 15, 2019

As part of this release we had 14 issues closed.

enhancements

  • #913 lib version of rsa256 js bundle was added
  • #896 Allow location.replace when using signinRedirect
  • #877 Dependency and import tidy-up
  • #858 Expose version as property.
  • #856 Assume requested scopes when response response doesn't contain scope
  • #825 don't call user info endpoint from querySessionStatus
  • #822 "refresh_token" pkce flow does not update the "oidc:user.id_token" in storage
  • #796 Improve typings for UserManagerEvents callback signatures
  • #793 Improve typings for UserManager.getUser() and signinRedirectCallback()
  • #756 Clone object given to signin/signout APIs so values are not overwritten
  • #745 Extra parameter in token request (authorization code grant)
  • #477 Consider capturing settings at authorize request time
  • #473 Allow a single signinRedirect url and api to process signin results
  • #442 Consider checking sub on signInSilent response to compare against current sub

General

License
Apache-2.0
Typescript Types
None found
Tree-shakeable
No

Popularity

GitHub Stargazers
2,354
Community Interest
3,114
Number of Forks
848

Maintenance

Commits
11/2110/2202
Last Commit
Open Issues
89
Closed Issues
1,063
Open Pull Requests
27
Closed Pull Requests
83

Versions

Versions Released
11/2110/2201
Latest Version Released
Feb 17, 2021
Current Tags
latest1.11.5
beta1.11.6-beta.1

Contributors

brockallen
brockallen
Commits: 530
hmtylmz
hmtylmz
Commits: 11
maxmantz
maxmantz
Commits: 10
donalfenwick
donalfenwick
Commits: 4
alexanderbh
alexanderbh
Commits: 3
HenrikWM
HenrikWM
Commits: 3
pmoleri
pmoleri
Commits: 3
merijndejonge
merijndejonge
Commits: 3
longsleep
longsleep
Commits: 3
robbaman
robbaman
Commits: 3
volkc-basf
volkc-basf
Commits: 3
rstaib
rstaib
Commits: 3
coolhome
coolhome
Commits: 3
markphillips100
markphillips100
Commits: 3
DavidRouyer
DavidRouyer
Commits: 2