Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
passport-saml
Advanced tools
passport-saml - npm Package Compare versions
Comparing version 0.16.1 to 0.16.2
| { | ||
| "name": "passport-saml", | ||
| "version": "0.16.1", | ||
| "version": "0.16.2", | ||
| "licenses": [ | ||
@@ -5,0 +5,0 @@ { |
@@ -43,36 +43,37 @@ Passport-SAML | ||
| Config parameter details: | ||
| * Core | ||
| * `callbackUrl`: full callbackUrl (overrides path/protocol if supplied) | ||
| * `path`: path to callback; will be combined with protocol and server host information to construct callback url if `callbackUrl` is not specified (default: `/saml/consume`) | ||
| * `protocol`: protocol for callback; will be combined with path and server host information to construct callback url if `callbackUrl` is not specified (default: `http://`) | ||
| * `host`: host for callback; will be combined with path and protocol to construct callback url if `callbackUrl` is not specified (default: `localhost`) | ||
| * `entryPoint`: identity provider entrypoint | ||
| * `issuer`: issuer string to supply to identity provider | ||
| * `cert`: see [Security and signatures](#security-and-signatures) | ||
| * `privateCert`: see [Security and signatures](#security-and-signatures) | ||
| * `decryptionPvk`: optional private key that will be used to attempt to decrypt any encrypted assertions that are received | ||
| * `signatureAlgorithm`: optionally set the signature algorithm for signing requests, valid values are 'sha1' (default), 'sha256', or 'sha512' | ||
| * Additional SAML behaviors | ||
| * `additionalParams`: dictionary of additional query params to add to all requests | ||
| * `additionalAuthorizeParams`: dictionary of additional query params to add to 'authorize' requests | ||
| * `identifierFormat`: if truthy, name identifier format to request from identity provider (default: `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress`) | ||
| * `acceptedClockSkewMs`: Time in milliseconds of skew that is acceptable between client and server when checking `OnBefore` and `NotOnOrAfter` assertion condition validity timestamps. Setting to `-1` will disable checking these conditions entirely. Default is `0`. | ||
| * `attributeConsumingServiceIndex`: optional `AttributeConsumingServiceIndex` attribute to add to AuthnRequest to instruct the IDP which attribute set to attach to the response ([link](http://blog.aniljohn.com/2014/01/data-minimization-front-channel-saml-attribute-requests.html)) | ||
| * `disableRequestedAuthnContext`: if truthy, do not request a specific auth context | ||
| * `authnContext`: if truthy, name identifier format to request auth context (default: `urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport`) | ||
| * `forceAuthn`: if set to true, the initial SAML request from the service provider specifies that the IdP should force re-authentication of the user, even if they possess a valid session. | ||
| * `skipRequestCompression`: if set to true, the SAML request from the service provider won't be compressed. | ||
| * `authnRequestBinding`: if set to `HTTP-POST`, will request authentication from IDP via HTTP POST binding, otherwise defaults to HTTP Redirect | ||
| * InResponseTo Validation | ||
| * `validateInResponseTo`: if truthy, then InResponseTo will be validated from incoming SAML responses | ||
| * `requestIdExpirationPeriodMs`: Defines the expiration time when a Request ID generated for a SAML request will not be valid if seen in a SAML response in the `InResponseTo` field. Default is 8 hours. | ||
| * `cacheProvider`: Defines the implementation for a cache provider used to store request Ids generated in SAML requests as part of `InResponseTo` validation. Default is a built-in in-memory cache provider. For details see the 'Cache Provider' section. | ||
| * Passport | ||
| * `passReqToCallback`: if truthy, `req` will be passed as the first argument to the verify callback (default: `false`) | ||
| * Logout | ||
| * `logoutUrl`: base address to call with logout requests (default: `entryPoint`) | ||
| * `additionalLogoutParams`: dictionary of additional query params to add to 'logout' requests | ||
| * `logoutCallbackUrl`: The value with which to populate the `Location` attribute in the `SingleLogoutService` elements in the generated service provider metadata. | ||
| #### Config parameter details: | ||
| * **Core** | ||
| * `callbackUrl`: full callbackUrl (overrides path/protocol if supplied) | ||
| * `path`: path to callback; will be combined with protocol and server host information to construct callback url if `callbackUrl` is not specified (default: `/saml/consume`) | ||
| * `protocol`: protocol for callback; will be combined with path and server host information to construct callback url if `callbackUrl` is not specified (default: `http://`) | ||
| * `host`: host for callback; will be combined with path and protocol to construct callback url if `callbackUrl` is not specified (default: `localhost`) | ||
| * `entryPoint`: identity provider entrypoint | ||
| * `issuer`: issuer string to supply to identity provider | ||
| * `cert`: see [Security and signatures](#security-and-signatures) | ||
| * `privateCert`: see [Security and signatures](#security-and-signatures) | ||
| * `decryptionPvk`: optional private key that will be used to attempt to decrypt any encrypted assertions that are received | ||
| * `signatureAlgorithm`: optionally set the signature algorithm for signing requests, valid values are 'sha1' (default), 'sha256', or 'sha512' | ||
| * **Additional SAML behaviors** | ||
| * `additionalParams`: dictionary of additional query params to add to all requests | ||
| * `additionalAuthorizeParams`: dictionary of additional query params to add to 'authorize' requests | ||
| * `identifierFormat`: if truthy, name identifier format to request from identity provider (default: `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress`) | ||
| * `acceptedClockSkewMs`: Time in milliseconds of skew that is acceptable between client and server when checking `OnBefore` and `NotOnOrAfter` assertion condition validity timestamps. Setting to `-1` will disable checking these conditions entirely. Default is `0`. | ||
| * `attributeConsumingServiceIndex`: optional `AttributeConsumingServiceIndex` attribute to add to AuthnRequest to instruct the IDP which attribute set to attach to the response ([link](http://blog.aniljohn.com/2014/01/data-minimization-front-channel-saml-attribute-requests.html)) | ||
| * `disableRequestedAuthnContext`: if truthy, do not request a specific auth context | ||
| * `authnContext`: if truthy, name identifier format to request auth context (default: `urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport`) | ||
| * `forceAuthn`: if set to true, the initial SAML request from the service provider specifies that the IdP should force re-authentication of the user, even if they possess a valid session. | ||
| * `skipRequestCompression`: if set to true, the SAML request from the service provider won't be compressed. | ||
| * `authnRequestBinding`: if set to `HTTP-POST`, will request authentication from IDP via HTTP POST binding, otherwise defaults to HTTP Redirect | ||
| * **InResponseTo Validation** | ||
| * `validateInResponseTo`: if truthy, then InResponseTo will be validated from incoming SAML responses | ||
| * `requestIdExpirationPeriodMs`: Defines the expiration time when a Request ID generated for a SAML request will not be valid if seen in a SAML response in the `InResponseTo` field. Default is 8 hours. | ||
| * `cacheProvider`: Defines the implementation for a cache provider used to store request Ids generated in SAML requests as part of `InResponseTo` validation. Default is a built-in in-memory cache provider. For details see the 'Cache Provider' section. | ||
| * **Passport** | ||
| * `passReqToCallback`: if truthy, `req` will be passed as the first argument to the verify callback (default: `false`) | ||
| * **Logout** | ||
| * `logoutUrl`: base address to call with logout requests (default: `entryPoint`) | ||
| * `additionalLogoutParams`: dictionary of additional query params to add to 'logout' requests | ||
| * `logoutCallbackUrl`: The value with which to populate the `Location` attribute in the `SingleLogoutService` elements in the generated service provider metadata. | ||
| ### Provide the authentication callback | ||
@@ -79,0 +80,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.02%
302008
- Number of lines in readme file
- increased by0.47%
212
No dependency changes