Change Log

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

5.5.1 (2018-11-26)

Bug Fixes

added aud and azp validations for ID Tokens passed by clients (4df8160)
aud for jwt oauth tokens no longer gets the client id pushed in (14c556e)

5.5.0 (2018-11-22)

Bug Fixes

gracefully handle mixed up response_type(s) order (b775591)
http2 is also stable in ^8.13.0 (3d240d9)

Features

initial and registration access token policies (452000c), closes #394

5.4.2 (2018-11-19)

Bug Fixes

ignore *_endpoint_auth_signing_alg client metadata when _jwt auth is not allowed (d0346a8)

5.4.1 (2018-11-19)

Bug Fixes

require consent result to save accepted scopes and claims (7720367)

5.4.0 (2018-11-18)

Bug Fixes

handle potentially unvalidated response mode in authz error handler (ee501d1)
issue new session identifiers when session changes (56d04e6)
omit saving an empty session on initial authorize request (d0b7069)

Features

allow omitting redirect_uri in code exchange at the token endpoint when there is just one registered (8cdd407)
update of draft-ietf-oauth-resource-indicators from 00 to 01 (1302a54), closes #385

5.3.0 (2018-11-05)

Bug Fixes

upgrade min node-jose version to fix its performance in node (f1cb4c6)

Features

sessionManagement frame uses Storage Access API to detect errors (156e12d)

5.2.0 (2018-11-01)

Draft Features

sessionManagement feature doesn't set a default thirdPartyCheckUrl anymore (0015c38)

With the sunset of https://rawgit.com i'm not going to look for a replacement CDN that hosts github content using the right content-type. This addition to sessionManagement is a gimmick helping only in a small % of cases anyway.

Note: Updates to draft and experimental specification versions are released as MINOR library versions, if you utilize these specification implementations consider using the tilde ~ operator in your package.json since breaking changes such as this one may be introduced as part of these version updates.

5.1.2 (2018-10-23)

Bug Fixes

allow http2 req/res in interaction detail helpers (fixes #383) (a86aba7)

5.1.0 (2018-10-03)

Bug Fixes

ignore sector_identifier_uri when subject_type is not pairwise (416e379)

Features

add Resource Indicators for OAuth 2.0 - draft 00 implementation (1bc2994)

5.0.1 (2018-09-27)

5.0.0 (2018-09-26)

Bug Fixes

change conformIdTokenClaims default value to true (ef40f6d)
devInteractions also have no-cache headers, doesn't set acr (9d7a032)
ensure non-whitelisted JWA algs cannot be used by *_jwt client auth (186de0d)
extraClientMetadata.properties keys do not get transformed (837beca)
fixed 500 in client update checking client_secret equality (bad6348)
remove deprecated passing of scope with consent results (35f13bc)
remove deprecated Session.find upsert behaviour (73e07bd)
remove deprecated unused exported errors (fc3f509)
remove got 8 > 9(retries > retry) option re-assign behaviour (db31d32)
secretFactory is now used in client update (0923f52)
validate secret length for client_secret_jwt with no alg specified (ab64268)

Code Refactoring

IdToken constructor and #sign() method changes (bb4269f)
moved thirdPartyCheckUrl under features.sessionManagement (c3f84b2)
renamed deviceCode feature to deviceFlow (cd57d77)

Features

add self_signed_tls_client_auth client authentication method (9a1f0a3)
add tls_client_auth client authentication method (ce2bf66)
allow custom mechanisms for handling pairwise identifiers (57ce6d7)
back and front-channel can be enabled without sessionManagement (8cb37ff)
dynamic token expiration (6788b83)
enable Certificate Bound Access Tokens (f43d820)
enable explicit whitelist of JWA algorithms (0604e08)
enable token storage and representation format to be dynamic (8487bd8)
invalid_token errors now have a detail to aid in debugging or logs (b8324b7)
JWT Secured Authorization Response Mode for OAuth 2.0 (JARM) (c759415)
opaque is the default adapter format now (75e7a3f)
unify audiences helper function signature (fd38600)

BREAKING CHANGES

the configuration option pairwiseSalt is replaced with pairwiseIdentifier async helper function. This allows for different means of generating the pairwise identifier to be implemented, such as the ones mentioned in Core 1.0
Passing scope to interaction result's consent property is no longer supported
cookies.thirdPartyCheckUrl is now configured with features.sessionManagement.thirdPartyCheckUrl instead
features.deviceCode is now features.deviceFlow and deviceCodeSuccess helper function is now deviceFlowSuccess
In order for dynamic token expiration to be able to pass a client instance to the helpers it is now better to pass a client property being the client instance to a new token instance rather then a clientId. When passing a client the clientId will be set automatically.
the default adapter format is now set to opaque, the legacy "legacy" value is still available for legacy deployments but cannot be combined with the new dynamic format feature option and is considered deprecated and will be removed in the next major release.
the default enabled JWA algorithms have changed. See the new whitelistedJWA configuration option to re-enable the ones you need.
the configuration unsupported property is removed, use the configuration whitelistedJWA object instead. This isn't a 1:1 renaming of a configuration value, while the unsupported option was essentually a blacklist the whitelistedJWA as the name suggests is a whitelist.
the RSA-OAEP-256 key wrapping algorithm has been removed and is not configurable since it's not supported natively in nodejs.
IdToken constructor now requires the client instance to be passed in as a second argument. IdToken instance .sign() now takes just one argument with the options.
when a symmetrical endpoint authentication signing alg is not specified the secret will be validated such that it can be used with all available HS bit lengths
audience helper token argument will no longer be a reference to other tokens than the one to which the audiences will be pushed.
audience helper scope argument is no longer available
generateTokenId format method is now a prototype method instead of a class one
the http request option retries will no longer be transformed into retry, see got@^9.0.0 package for the retry options
exported errors RestrictedGrantType and RestrictedResponseType are no longer available
Session.find default upsert behaviour is changed to return a new empty session instead
change conformIdTokenClaims default value to true
custom client metadata properties will not get transformed between snake_case and camelCase anymore to allow for namespaced metadata properties such as custom://metadata

4.8.3 (2018-09-20)

Bug Fixes

reference correct param names in features.webMessageResponseMode (e495c6b)

4.8.2 (2018-09-16)

Bug Fixes

do not overwrite custom response mode implementations with defaults (7f7ea79), closes #365
remove unnecessary catchall in fallback session save (3bfb8f0), closes #363

4.8.1 (2018-09-06)

Bug Fixes

claim definition also detects dynamic scopes (d8c8170)
custom registered grants do not get overriden by defaults (d4185f9), closes #349

4.8.0 (2018-08-29)

Features

add dynamic scope value support (caa8f0e)

4.7.1 (2018-08-27)

Bug Fixes

check_session regression fix (32975d9)

4.7.0 (2018-08-26)

Bug Fixes

conform claims param parsing (c553a92)
set session params as undefined instead of delete (a872091)

Features

accepted scope and rejected claim tracking (b4c2655)
session_state changes (f64d040)

4.6.0 (2018-08-13)

Features

add client meta to setProviderSession (1174c76), closes #352
check session client Origin check (6c27f10)
option to set interactionResult without redirecting to resume right away (6aeedf2), closes #350
session management client helper is now inline with other helpers (96802df)
update JWT Response for OAuth Token Introspection draft (039ab90)

4.5.0 (2018-08-03)

Bug Fixes

message displayed on blank /device (86541df)

Features

update device flow to draft-12 (e00fa52)

4.4.0 (2018-07-22)

Features

JWT Response for OAuth Token Introspection (72142fd)

4.3.2 (2018-07-21)

Bug Fixes

add a clear error description when sector uri isn't a valid json (05c14d1)
allow clients that do not use authorization to utilize pairwise (c24ea70)

4.3.1 (2018-07-17)

Bug Fixes

device_authorization w/ offline_access scope (19a85ac)

4.3.0 (2018-07-16)

Bug Fixes

allow for pkce to be disabled (3aca2c8)
debug revocation after yield (bf4c012)
pathFor returns a valid route for issuers with terminating "/" (9e4b1a0), closes #315

Features

add Device Flow experimental/draft feature (461a8e3)
add gty storage claim for access and refresh token (a492a5e)
change the requests's uuid to a previous value of grantId (28673e2)

Pre standard-version Change Log

4.2.x

4.2.2

2018-07-13 DIFF
fixed expiresIn sent to adapter#upsert when interaction session are saved using interactionFinished()

4.2.1

2018-07-13 DIFF
fixed form_post regression for response types including token from 4.2.0

4.2.0

2018-07-12 DIFF

New Feature - OAuth 2.0 Web Message Response Mode

Based on OAuth 2.0 Web Message Response Mode response_mode=web_message is a new response mode that uses HTML5 Web Messaging instead of a redirect for the Authorization Response from the Authorization Endpoint. It defines two modes: simple mode and relay mode. Relay mode can be used to protect the response by confining it within the origins of a resource server and preventing it from being read by the client.

This is released as an experimental/draft feature so as with the others it is disabled by default and breaking changes to this feature will be released as MINOR releases. When using Web Message Response Mode be sure to lock down oidc-provider in your package.json with the tilde ~ operator and pay close attention to this changelog when updates are released.

To enable configure:

const configuration = { features: { webMessageResponseMode: true } };

Note: Although a general advise to use a helmet(express, koa) it is especially advised for your interaction views routes if Web Message Response Mode is available on your deployment.

Enhancements

added no-cache headers to the authorization endpoint
#provider.setProviderSession() now returns the created session object
#provider.registerGrantType() also accepts additional parameter to indicate parameters for which duplicates are allowed (e.g. audience and resource in OAuth 2.0 Token Exchange)

Fixes

fixed some edge cases where authorization error responses would still reach the redirect_uri even when it could not have been validated
fixed parameters coming from Request Objects to be always used as strings
fixed upstream body parser params to be always strings (unless json)
fixed parameters coming multiple times still being used in error handlers (e.g. state)
fixed form post values not being html escaped

4.1.x

4.1.3

2018-06-28 DIFF
fixed www-authenticate header uses in bearer token endpoints according to Core 1.0 and RFC6750

4.1.2

2018-06-26 DIFF
fixed missing sid claim in access tokens
fixed non-consumable tokens having consumed stored and #consume() instance method

4.1.1

2018-06-25 DIFF
fixed missing sub claim from tokens when using the jwt format
chores (lint, tests, refactors, default error and logout screen styles)

4.1.0

2018-06-22 DIFF

New Feature - Storage Formats

Added formats configuration option. This option allows to configure the token storage and value formats. The different values change how a token value is generated as well as what properties get sent to the adapter for storage. Three formats are defined:

legacy is the current and default format until next major release. no changes in the format sent to adapter
opaque formatted tokens have a different value then legacy and in addition store what was in legacy format encoded under payload as root properties, this makes analysing the data in your storage way easier
jwt formatted tokens are issued as JWTs and stored the same as opaque only with additional property jwt. The signing algorithm for these tokens uses the client's id_token_signed_response_alg value and falls back to RS256 for tokens with no relation to a client or when the client's alg is none

This feature uses the previously defined public token API of [klass].prototype.getValueAndPayload, [klass].prototype.constructor.getTokenId, [klass].prototype.constructor.verify and adds a new one [klass].prototype.constructor.generateTokenId. See the inline comment docs for more detail on those. Further format ideas and suggestions are welcome.

New Feature - conformIdTokenClaims feature toggle Added conformIdTokenClaims feature toggle.

This toggle makes the OP only include End-User claims in the ID Token as defined by Core 1.0 section 5.4 - when the response_type is id_token or unless requested using the claims parameter.

Fixes

fixed edge cases where client and provider signing keys would be used for encryption and vice versa
fixed client request_object_signing_alg and contact validations
fixed defaultHttpOptions to be as documented
fixed an end_session server error in case where session.authorizations is missing - #295
adjusted error_description to be more descriptive when PKCE plain value fallback is not possible due to the plain method not being supported
fixed audiences helper results to assert that an array of strings is returned
fixed issues with interaction sessions and the back button, assertions are now in place and both resume endpoint and interaction helpers will now reject with SessionNotFound named error, which is essentially just InvalidRequest with a more descriptive name.

4.0.x

4.0.3

2018-06-09 DIFF
fixed token endpoint grant_type=refresh_token scope parameter related bugs
- a rotated refresh token will retain the original scope, its only the access and id token that has the requested scope as specified in section 6 of RFC6749
- openid scope must be provided in the list of requested scopes

4.0.2

2018-06-05 DIFF
fixed non-spec errors restricted_response_type and restricted_grant_type to be UnauthorizedClient (unauthorized_client) instead as specified in RFC6749
fixed missing WWW-Authenticate response header in Bearer auth scheme endpoints when 401 is returned (was missing from registration_endpoint, registration_client_uri)
fixed #session.save() when cookies.*.maxAge is set to 0 to not add the exp claim - #289
fixed the remember=false option to apply to client session state cookies too

4.0.1

2018-06-01 DIFF

Breaking changes

minimal version of node lts/carbon is required (>=8.9.0)

Client Metadata - null property values are no longer ignored

clients pushed through #initialize() must not submit properties with null values
clients stored via an adapter must be updated in your storage not to have null or null-deserialized values, alternatively you can update your adapter not to return these properties back to the provider

const _ = require('lodash');
// your adapter implementation
class MyAdapter {
  // ...
  async find(id) {
    // load entity properties and then drop the null properties if its a Client adapter instance
    // this is implementation specific
    const data = await DB.query(...);
    if (this.name === 'Client') {
      return _.omitBy(data, _.isNull);
    }
    return data;
  }
  // ...
}

Client Authentication
- Errors related to authentication details parsing and format are now 400 Bad Request and invalid_request. Errors related to actual authentication check are now 401 Unauthorized and invalid_client with no details in the description. This means that errors related to client authentication will no longer leak details back to the client, instead the provider may be configured to get these errors from e.g. provider.on('grant.error') and provide the errors to clients out of bands.
```
function handleClientAuthErrors(err, { headers: { authorization }, oidc: { body, client } }) {
  if (err instanceof Provider.errors.InvalidClientAuth) {
    // save error details out-of-bands for the client developers, `authorization`, `body`, `client`
    // are just some details available, you can dig in ctx object for more.
    console.log(err);
  }
}
provider.on('grant.error', handleClientAuthErrors);
provider.on('introspection.error', handleClientAuthErrors);
provider.on('revocation.error', handleClientAuthErrors);
```
- added WWW-Authenticate response header to token endpoints when 401 is returned and Authorization scheme was used to authenticate and changed client authentication related errors to be 401 Unauthorized
- fixed several issues with token client authentication related to client_id lookup, it is no longer possible to:
  - submit multiple authentication mechanisms
  - send Authorization header to identify a none authentication method client
  - send both Authorization header and client_secret or client_assertion in the body
all error classes the provider emits/throws are now exported in Provider.errors[class] instead of Provider[class] and the class names are no longer suffixed by Error. See console.log(Provider.errors)
removed the non-spec rt_hash ID Token claim
features.pkce now only enables S256 by default, this is sufficient for most deployments. If plain is needed enable pkce with { features: { pkce: { supportedMethods: ['plain', 'S256'] } }.
client.backchannelLogout no longer suppresses any errors, instead rejects the promise

token introspection endpoint no longer returns the wrong token_type claim - #189

to continue the support of this non-standardized claim from introspection you may register the following middleware

provider.use(async function introspectionTokenType(ctx, next) {
  await next();
  if (ctx.oidc.route === 'introspection') {
    const token = ctx.oidc.entities.AccessToken || ctx.oidc.entities.ClientCredentials || ctx.oidc.entities.RefreshToken;

    switch (token && token.kind) {
      case 'AccessToken':
        ctx.body.token_type = 'access_token';
        break;
      case 'ClientCredentials':
        ctx.body.token_type = 'client_credentials';
        break;
      case 'RefreshToken':
        ctx.body.token_type = 'refresh_token';
        break;
    }
  }
});

fetched request_uri contents are no longer cached for 15 minutes default, cache headers are honoured and responses without one will fall off the LRU-Cache when this one is full
default configuration values for cookies.short.maxAge and cookies.long.maxAge changed
audiences is now in addition to existing id_token and signed userinfo cases called for client_credentials and access_token, this is useful for pushing additional audiences to an Access Token, these are now returned by token introspection and can be used when serializing an Access Token as a JWT
the provider will no longer use the first value from acrValues to denote a "session" like acr. In cases where acr is requested as a voluntary claim and no result is available this claim will not be returned.
- to continue the support of the removed behaviour you can change the OIDCContext acr getter
```
const _ = require('lodash');
const sessionAcr = '...';
Object.defineProperty(provider.OIDCContext.prototype, 'acr', {
  get() {
    return _.get(this, 'result.login.acr', sessionAcr);
  },
});
```
- removed deprecated #provider.setSessionAccountId() helper method. Use #provider.setProviderSession() instead

Enhancements

Session Changes
- stored sessions now have an exp property allowing the provider to ignore expired but still returned sessions
  - existing sessions without this property will be accepted and the exp property will be added with the next save
bumped the semantic version of every dependency to the latest as of release
added aud to the introspection response if a token has one
audiences helper gets called with additional parameters use and scope
renderError helper is now called with a third argument that's the actual Error instance.
node-jose dependency bumped to major ^1.0.0 - fixes A\d{3}GCMKW symmetrical encryption support
added cookies.thirdPartyCheckUrl option and a warning to host it
moved middleware handling missing optionally redirect_uri parameter case right after loading the client

3.0.x

3.0.3

2018-05-23 DIFF
all options passed to defaultHttpOptions now also reach request when #useRequest() is used
fixed a case when RS256 key presence check was wrongly omitted during #initialize()
fixed client jwks_uri refresh error to be invalid_client_metadata and propagated to the client

3.0.2

2018-05-15 DIFF
base64url dependency replaced

3.0.1

2018-05-10 DIFF
dependency tree updates

3.0.0

2018-05-02 DIFF
fixed client_secret_basic requiring the username and password tokens to be x-www-form-urlencoded according to https://tools.ietf.org/html/rfc6749#section-2.3.1
- NOTE: Although technically a fix, this is a breaking change for clients with client secrets that need to be encoded according to the standard and don't currently do so. A proper way of submitting client_id and client_secret using client_secret_basic is Authorization: base64(formEncode(client_id):formEncode(client_secret)). This is only becoming apparent for client ids and secrets with special characters that need encoding.

2.18.x

2.18.2

re-released 2.18.0 as 2.18.2 following deprecation of 2.18.1

2.18.0

2018-04-12 DIFF
added ctx.oidc.entities with all loaded model/entity instances during a given request
added cookies.keys configuration option for KeyGrip key app passthrough
added #provider.setProviderSession for setting provider session from outside of a regular context
deprecated #provider.setSessionAccountId in favor of #provider.setProviderSession

2.17.0

2018-03-29 DIFF
fixed alternative verb routes to be named as well
fixed default interactionCheck passing /resume when users click cancel or just navigate back to auth resume route
added client_update and client_delete as named routes
added extraClientMetadata configuration option that allows for custom client properties as well as for additional validations for existing properties to be defined
when provider is configured with only pairwise subject type support then it is the client default and does not have to be explicitly provided anymore

2.16.0

2018-03-26 DIFF
supported PKCE code challenge methods are now configurable, use to i.e. disable plain for stricter OIDC profiles and new deployments where legacy clients without S256 support aren't to be expected.
added configuration validations for subjectTypes and pkce supportedMethods

2.15.0

2018-03-23 DIFF
added provider.use((ctx, next) => {}) middleware support
added provider.listen(port_or_socket)
added attribute delegates proxy, keys, env, subdomainOffset from provider to the underlying koa app
updated docs

2.14.x

2.14.1

2018-03-13 DIFF
bumped minimal debug dependency version due to its found vulnerability in lesser versions
adjusted documentation on refreshTokenRotation configuration option
adjusted documentation on TLS offloading

2.14.0

2018-03-05 DIFF
added current account id from OP session to interaction sessions
added provider.setSessionAccountId(req, id, [ts]) helper for setting OP session from other contexts, such as interrupted interactions or password reset flows.

2.13.x

2.13.1

2018-02-14 DIFF
clientCacheDuration no longer has any effect on static clients passed through the #provider.initialize() call

2.13.0

2018-01-29 DIFF
#provider.Client.cacheClear([id]) can now optionally drop just one specific client from provider cache when provided its client_id

2.12.0

2018-01-24 DIFF
findById returned struct's #claims() method is now called with two parameters (use and scope) allowing to fine-tune the returned claims depending on the intended place for these claims.

2.11.x

2.11.2

2018-01-21 DIFF
aligned oidc-provider:token DEBUG format
exposed client validation schema prototype under provider.Client.Schema

2.11.1

2018-01-17 DIFF
fixed a bug where non global logouts would not trigger back and front-channel logout features for the one client that gets logged out.
added missing backchannel.success and backchannel.error events

2.11.0

2018-01-16 DIFF
added no-cache headers to userinfo responses
added optional support for draft02 of Front-Channel Logout 1.0
- enable with configuration features.frontchannelLogout = true;
- adds new client properties frontchannel_logout_uri and frontchannel_logout_session_required
- adds new discovery properties frontchannel_logout_supported and frontchannel_logout_session_supported
- added frontchannelLogoutPendingSource helper for customizing the pending frontchannel web page HTML source

2.10.0

2018-01-15 DIFF
added audiences helper function to allow for pushing additional audiences to issued ID Tokens, this will additionally push an azp claim with the client_id value as per Core 1.0 spec defined ID Token validations.

2.9.x

2.9.2

2018-01-03 DIFF
added used http verb to error debug messages
added a descriptive "method not allowed" error message

2.9.1

2017-12-18 DIFF
fixed useRequest to be a static method as documented

2.9.0

2017-12-14 DIFF
added and documented the optional use of request instead of got for deployments requiring http(s) proxies to reach out to the internet wilderness

2.8.x

2.8.3

2017-12-12 DIFF
fixed token expires_in to be based off an overloadable BaseToken expiration() instance method
fixed token introspection response for consumed tokens

2.8.2

2017-12-11 DIFF
changed grant_type requires to resolve oidc-provider loading through webpack

2.8.0

2017-12-05 DIFF
added provider clockTolerance option
fixed clients with jwks_uri failing to be fetched blocking the initialize call
fixed successful client keystore refresh after failed verification to pass
bumped node-jose dependency

2.7.x

2.7.2

2017-11-30 DIFF

adjusted the client schema to ignore extra properties for disabled features
fixed encrypted ID Tokens without a used alg (json payload) to have cty (content-type) json
fixed unsigned ID Tokens missing *_hash properties
request_uri response caching now also handles expires response headers

Note: 2.7.0 and 2.7.1 yanked for the bugs they introduced

2.6.0

2017-11-23 DIFF
added scope to successful token (authorization_code, refresh_token) responses
updated dependencies (got@8.x, removed deprecated buffer-equals-constant)

2.5.x

2.5.1

2017-11-14 DIFF
fixed already authorized application_type=native prompt=none authorizations to be able to check if the authorization is still present
bumped session management jsSHA cdn dependency version

2.5.0

2017-10-28 DIFF
added an option to return metadata alongside with interaction results, this metadata is then retrievable i.e. during the interactionCheck call. #164, #165
added an option to return error instead of the standard interaction results, the provider will take this error (and error_description when provided) and resolve the authorization request with it. #167, #168
fixed Token#find() swallowing adapter#find errors
fixed introspection swallowing rethrown adapter#find errors

2.4.x

2.4.1

2017-10-12 DIFF
fixed token upsert expiration to respect token's instance expiration

2.4.0

2017-10-05 DIFF
added BaseToken public API, this API enables advanced users in search of features such as JWT-formatted Bearer tokens or not being able to reconstruct client token values from a DB backup to overload these methods and get those features.
fixed keystore initialize method to allow for servers only supporting authorization flow not needing RS256 signature key
fixed token introspection disclosing details for expired but found tokens
fixed exception during token introspection auth none clients looking up non-existing tokens

2.3.x

2.3.2

2017-09-25 DIFF
fixed interactionFinished, interactionDetails and Session#find expecting an id retrieved from a cookie. When not found will throw.

2.3.1

2017-09-15 DIFF
fixed devInteractions reported with the same grant uuid

2.3.0

2017-09-11 DIFF
added s_hash support for ID Tokens returned by authorization endpoint
added Request Object symmetrical encryption support
fixed PBES2 encryption to use client_secret derived symmetrical key instead of its full octet value
fixed claims parameter handling when part of a Request object as an object
removed bugged? and/or previously not working A(128|192|256)GCMKW symmetrical encryption algs

2.2.x

2.2.1

2017-09-09 DIFF
fixed encrypted parameters incorrectly assumed as signed (request object asymmetrical encryption)

2.2.0

2017-08-27 DIFF
added a clientCacheDuration option (defaults to Infinity), this option defines the time a client configuration loaded from an adapter will be kept in cache before being loaded again with the next request
removed valid-url dependency in favor of STDLIB's WHATWG url.URL

2.1.0

2017-08-04 DIFF
added a third parameter for findById helper, when findById is used in relation to an access token or an authorization code the token instance will be passed
added ctx.oidc.signed with an array of parameter names which were received using a signed or encrypted request/Uri parameter.
signed array of strings is available in the short lived session for interactions
added basic sequelize adapter example
fixed a bug where extraParams weren't recognized when part of a request or request_uri parameters
fixed a bug where client credential and refresh token adapter instances were used even if these grants/tokens weren't enabled
fixed a bug which allowed for non-enabled scopes to be added in client_credential grants

2.0.x

2.0.1

2017-08-04 DIFF
fixed infinite interactionCheck loop for application_type=native clients

2.0.0

Breaking Changes

oidc-provider now requires node v8.0.0 or higher for ES2015, async function and utils.promisify support
internal koa (and related) dependencies updated to their respective 'next' or koa2 middleware compatible versions
adapter must now be passed into #initialize()
helper functions which returned or accepted generators will no longer work, use async functions
helper functions no longer have koa ctx bound to this, instead their signature is changed
interactionUrl helper signature changed to (ctx, interaction) and is now awaited
renderError helper signature changed to (ctx, error) and is now awaited
uniqueness helper signature changed to (ctx, jti, expiresAt)
interactionCheck helper signature changed to (ctx)
default interactionCheck helper requires all native application client authorizations to pass through interactions
findById helper signature changed to (ctx, accountId)
postLogoutRedirectUri configuration option is now a helper function and is awaited to
default acrValues configuration option is now empty, if you used the old values ['0', '1', '2'], you must configure the value explicitly
ctx.prompted renamed to more descriptive ctx.promptPending
default refreshTokenRotation changed from 'none' to 'rotateAndConsume'
pkce.skipClientAuth removed, native clients not willing to submit secrets should be registered with method none
features.requestUri enabled by default with requireRequestUriRegistration
features.oauthNativeApps enabled by default
features.oauthNativeApps automatically enables features.pkce with { forcedForNative: true }
interaction details no longer utilize cookies to store the details and request parameters, short lived sessions are created and maintained via the adapter instead
Integrity keystore is no longer used, random strings are used to generate a lengthy token, a none signed JWT is used to store the metadata, keeping the datasets the same as 1.x
interaction helper provider#interactionDetails now returns a Promise, it reads the short lived session id and loads the details using your adapter
interaction helper provider.interactionFinished now returns a Promise, it reads the short lived session id and stores the interaction results there
default token TTLs shortened
Request Object iss (issuer) and aud (audience) values are now being validated to be equal to Client's identifier (iss) and the OP Issuer identifier (aud) when present in a Request Object

New features

static function named connect can now be present on an Adapter prototype, this will be awaited during initialization, use to establish the necessary adapter connections
introspection and revocation endpoint authentication now has dedicated settings and properties, unless specific settings for those are provided they default to what's provided for token_endpoint equivalents, this allows for fine-tuning while not disrupting existing behavior
new client metadata supported:
- introspection_endpoint_auth_method
- introspection_endpoint_auth_signing_alg
- revocation_endpoint_auth_method
- revocation_endpoint_auth_signing_alg
new configuration properties:
- introspectionEndpointAuthMethods
- introspectionEndpointAuthSigningAlgValues
- unsupported.introspectionEndpointAuthSigningAlgValues
- revocationEndpointAuthMethods
- revocationEndpointAuthSigningAlgValues
- unsupported.revocationEndpointAuthSigningAlgValues
new discovery properties:
- introspection_endpoint_auth_methods_supported
- introspection_endpoint_auth_signing_alg_values_supported
- revocation_endpoint_auth_methods_supported
- revocation_endpoint_auth_signing_alg_values_supported

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

Change Log

5.5.1 (2018-11-26)

Bug Fixes

5.5.0 (2018-11-22)

Bug Fixes

Features

5.4.2 (2018-11-19)

Bug Fixes

5.4.1 (2018-11-19)

Bug Fixes

5.4.0 (2018-11-18)

Bug Fixes

Features

5.3.0 (2018-11-05)

Bug Fixes

Features

5.2.0 (2018-11-01)

Draft Features

5.1.2 (2018-10-23)

Bug Fixes

5.1.0 (2018-10-03)

Bug Fixes

Features

5.0.1 (2018-09-27)

5.0.0 (2018-09-26)

Bug Fixes

Code Refactoring

Features

BREAKING CHANGES

4.8.3 (2018-09-20)

Bug Fixes

4.8.2 (2018-09-16)

Bug Fixes

4.8.1 (2018-09-06)

Bug Fixes

4.8.0 (2018-08-29)

Features

4.7.1 (2018-08-27)

Bug Fixes

4.7.0 (2018-08-26)

Bug Fixes

Features

4.6.0 (2018-08-13)

Features

4.5.0 (2018-08-03)

Bug Fixes

Features

4.4.0 (2018-07-22)

Features

4.3.2 (2018-07-21)

Bug Fixes

4.3.1 (2018-07-17)

Bug Fixes

4.3.0 (2018-07-16)

Bug Fixes

Features

Pre standard-version Change Log

4.2.x

4.2.2

4.2.1

4.2.0

4.1.x

4.1.3

4.1.2

4.1.1

4.1.0

4.0.x

4.0.3

4.0.2

4.0.1

3.0.x

3.0.3

3.0.2

3.0.1