Archived Release Notes
Looking for newer release notes? Look at the latest release notes.
Version 1.16.0-RC.1 #
April 21st, 2020
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
This is a release candidate. This release is not intended for production use. If you encounter issues please open a GitHub issue to let us know.
Changed#
- Email Send API no longer requires a from email or a default from name, defaults may be taken from the tenant. See the Emails API documentation for reference.
- The OpenID Connect JSON Web Key Set API endpoint returns only public keys generated by FusionAuth. This endpoint previously also returned imported public keys, for which we do not hold the private key.
Security#
- Updated default CORS configuration for clean installs, see the CORS Reference for details. It is highly recommended you modify your CORS configuration to match our new default values unless you have a technical requirement for your existing CORS configuration.
- Upgrade Handlebars to version
4.7.6due to a known vulnerability. There is no known exploit of this vulnerability in FusionAuth, this is a pro-active upgrade. FusionAuth uses this JavaScript library in the administrative UI to build dynamic table roles.- https://snyk.io/vuln/SNYK-JS-HANDLEBARS-534988
- Resolves GitHub Issue #564, thanks to @michael-burt for alerting us to this vulnerability.
Enhancement#
- The OpenID Connect and SAML v2 Reconcile Lambda may now modify the assigned user roles. Prior to this version any changes to the roles were intentionally not preserved. This restriction has been lifted.
- Resolves GitHub Issue #536, thanks to @sedough for opening the request.
- In some cases the
stateparameter returning from external SAML v2 & OpenID Connect identity providers is decoded incorrectly. We are now Base64 encoding this value to preserve it's integrity.
New#
- Support for Elasticsearch version 7
- FusionAuth maintains backward-compatibility with Elasticsearch 6.3.x clusters and indexes.
fusionauth-app.search-engine-typeconfiguration property andFUSIONAUTH_SEARCH_ENGINE_TYPEenvironment variable exposed for configuring the search engine, see the Configuration documentation for reference.- A reindex may be necessary depending on how you have upgraded your Elasticsearch cluster. You may issue a reindex in the FusionAuth admin UI under System -> Reindex .
- Resolves GitHub Issue #199
- Support for using the database as the user search engine. This is now the default configuration. See the Core Concepts - Users documentation for details.
- Use of the database search engine provides limited search capabilities, and has limitations for the Users API, see the Bulk Delete Users API and Search for Users API documentation for details.
- Resolves GitHub Issue #427
- The Registration API returns an access token within the
tokenfield of responses toPOSTrequests. See the Registrations API documentation for reference.- Application registration records a login and will be reflected in the Login, Daily Active User, and Monthly Active User reports within the FusionAuth admin UI.
- The
applicationIdis now optional forPUTrequests (update login instants) to the Login API. See the Login API documentation for reference.PUTrequests to the Login API records a login and will be reflected in the Login, Daily Active User, and Monthly Active User reports within the FusionAuth admin UI.
- The User API returns an access token within the
tokenfield of responses toPOSTrequests creating a user. See the User API documentation for reference.- User creation records a login and will be reflected in the Login, Daily Active User, and Monthly Active User reports within the FusionAuth admin UI.
- System logs can be viewed from the Admin interface. Navigate to System -> Log to view and download the system logs.
- This feature is available in the UI and via a new API.
- Resolves GitHub Issue #540
- System log export API has been added for retrieving a node's system logs as a compressed zip file. See the System Logs API documentation for reference.
- There is a Test SMTP button that you can utilize during an Edit or Add Tenant operation to ensure the correct SMTP configuration.
- Resolves GitHub Issue #539
- Production runtime mode disables maintenance mode, database migrations must be applied manually in this runtime mode. See the FusionAuth App Installation Guide documentation for reference.
- Advanced configuration exposed for search engine type, runtime mode, and Same-Site cookie policy. See the Configuration documentation for reference.
- JWT Refresh webhook event, issued when an access token is refreshed by refresh token, see the Events documentation for reference.
- Tenant email configuration provides a default from email and a default from name. See the Tenants API documentation for reference.
- Resolves GitHub Issue #262, thanks to @engineertdog for the request!
Docker#
- Next time a release candidate is built, the
latesttag will be preserved to always be the latest stable release. This way if you are always using thelatesttag you will not automatically upgrade to a release candidate.- Resolves GitHub Issue #596, thanks to @ceefour for the request.
- The reference
docker-compose.ymlprovided by the fusionauth-containers GitHub repo has been modified to install leveraging database as the User search engine. You will need to include the referencedocker-compose.override.ymlin order to install and configure Elasticsearch as the User search engine. See the Docker installation guide for reference.
Internal#
- Java 14. Upgrade from Java 8. The FusionAuth Java runtime has been upgraded to version 14. All external Java packages such as the Java REST client and the Plugin interface are all still compiled against Java 8 so this upgrade should not impact any users.
- Resolves GitHub Issue #481
- Upgrade Apache Tomcat to the latest patch version
8.5.53. - Much smaller Docker images based upon Alpine Linux! Compressed size changed from ~ 150 MB to 76 MB. More features, less size? Yeah, that's right.
- Check it out for yourself. See the fusionauth/fusionauth-app repo.
Version 1.15.8 #
April 10th, 2020
Fixed#
- When more than one tenant is defined, the redirect to
/oauth2/callbackwhich is used for 3rd Party SAML v2 or OpenID Connect identity providers will fail unless the corresponding application is in the default tenant. This issue was introduced in1.15.6which means it only affects version1.15.6. If you encounter this issue you may be shown an error on the login page indicatingA validation error occurred during the login attempt. An event log was created for the administrator to review..- Resolves GitHub Issue #548, thanks so much to @lamuertepeluda for reporting and providing excellent technical details to assist in tracking down the bug.
- A callback from a Social IdP configuration may fail to complete the login workflow. This issue was introduced in
1.15.6which means it only affects version1.15.6and1.15.7.- Resolves GitHub Issue #553, thanks to @ulybu for reporting the issue!
Enhancements#
- When a user attempts to utilize an expired Passwordless or Forgot Password link, FusionAuth will now still be able to allow the user to restart the login workflow.
- Resolves GitHub Issue #468, thanks to @davidmw for suggesting this enhancement.
- In order to take advantage of this enhancement, you will need to upgrade your email template for one or both of these workflows. See the Email Templates documentation for a reference usage.
Version 1.15.7 #
March 30th, 2020
Fixed#
- Due to a change in how FusionAuth encodes the
RelayStatevalue when redirecting to a 3rd party SAML v2 identity providers, the authentication request will fail with an OAuth2 error. This issue was introduced in1.15.6which means it only affects version1.15.6.
Version 1.15.6 #
March 27th, 2020
Fixed#
- Handle tabs and other control characters in an included text file when parsing the Kickstart configuration files.
- Resolves GitHub Issue #524, thanks to @mgetka for reporting.
- When the FusionAuth Reactor is enabled, a breach detection is incorrectly requested during a user update when the password is not being modified. You may see errors in the Event Log indicating Reactor returned a status code of
400, this error is just noise and it did not affect the requested action.- Resolves GitHub Issue #533.
- When running FusionAuth on an un-secured connection during development, newer versions of the Chrome browser will reject the
Set-Cookierequest in the HTTP response because theSameSiteattribute is not set.- Resolves GitHub Issue #537.
Enhancement#
- When integrating with 3rd Party Identity Providers FusionAuth will build a
stateparameter in order to complete the FusionAuth OAuth2 or SAML v2 request on the callback from the 3rd Party IdP. There are times when a 3rd Party IdP may un-intentionally modify thestateparameter by decoding the value. When thestateparameter is not returned to FusionAuth the way it was sent the integration breaks. FusionAuth will now Bas64 encode thestatevalue to better defend against 3rd Party IdP integrations.- Resolves GitHub Issue #538.
Version 1.15.5 #
March 16th, 2020
Fixed#
- Adding a Consent to a User that does not have a First or Last Name. This was causing an error in the UI where the Add Consent dialog was not rendering and instead displaying a stack trace.
- Resolves GitHub Issue #512, thanks to @mgetka for reporting.
- When Reactor is enabled and more than one user requires action due to a breached password the Reactor index page will fail to render.
- Resolves GitHub Issue #514, thanks to our friends at Frontdoor for reporting the issue.
- When adding a new Tenant in the UI you may encounter a
500status code with aFusionAuth encountered an unexpected error.message. If you encounter this error, edit the default tenant, click save and then retry the add operation.- Resolves GitHub Issue #517, thanks to @vburghelea for reporting.
- A JavaScript exception was causing the ExternalJWT identity mapping dialog to fail. A work around is to use the API to add these claim mappings. This bug was introduced in version 1.15.3.
- Resolves GitHub Issue #518, thanks to @irzhywau for reporting.
Version 1.15.4 #
March 10th, 2020
Fixed#
- When using PostgreSQL and using the Import User API with a large amount of roles assigned to user FusionAuth may exceed the maximum allowed parameterized values in a prepared statement causing a SQL exception. If you encounter this issue you may work around the issue by reducing the size of your import request to 200-500 users per request.
- Resolves GitHub Issue #505, thanks to @leafknode for reporting and helping debug!
- When creating a user through Kickstart with
passwordChangeRequiredset totrueand exception will occur during the next login request. This issue was introduced in version 1.15.0.- Resolves GitHub Issue #509, thanks to @mgetka for reporting!
- When a Kickstart file contains multi-byte characters the string value may not be encoded properly if the default file encoding is not UTF-8. This has now been resolved by explicitly requesting UTF-8 encoding during file I/O.
- Resolves GitHub Issue #510, thanks to @mgetka for reporting!
- When using the SAML IdP configuration where FusionAuth is the SAML service provider if the base64 encoded SAML response from the IdP contains line returns FusionAuth will fail to parse the request and the login request will fail.
- Resolves GitHub Issue #511
Version 1.15.3 #
February 27th, 2020
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
Changed#
- The External JWT Identity Provider now manages keys used for token verification in the Key Master. All keys have been migrated to Key Master, and going forward all keys can be managed through the Key Master.
- Prior to this version the OpenID Connect IdP would send the client secret using the
client_secret_basicand theclient_secret_postmethod. This was done for compatibility with providers that did not utilize theclient_secret_basicmethod. Now this configuration is now provided and only the configured client authentication method will be used.
Fixed#
- Using the JWT Refresh API with a JWT issued from one tenant for a user in another tenant. This error was causing an exception instead of the proper validation error being returned to the caller. A
404will now properly be returned when this scenario occurs.- Resolves GitHub Issue #399, thanks to @johnmaia for helping us track it down.
- Missing API validation on the
/oauth2/passwordlessendpoint. A500was returned instead of the correct validation errors.- Resolves GitHub Issue #450, thanks to @GraafG for reporting.
- On systems running MySQL, the SQL migration for
1.15.0on theDELIMITERcommand and causes the instance table to have a nulllicense_id. If you have previously connected your support contract Id with your instance and upgraded to a previous1.15.xversion, you will need to reconnect your license Id in the Reactor tab. This issue was introduced in version 1.15.0.- Resolves GitHub Issue #482, thanks to @nulian for reporting!
- The
CancelActionmethod in the .NET Core client returning field error due to incorrect method definition.- Resolves GitHub Issue #11, thanks to @minjup for reporting.
- The OpenID Connect IdP client authentication method is now configurable as
client_secret_basic,client_secret_post, ornoneand will authenticate solely with the configured method. See the OIDC spec concerning Client Authentication for more information.- The
1.15.3database migration configures the client authentication method toclient_secret_basicfor identity provider configurations with a client secret defined, andnonefor those without a client secret defined. If your OpenID Connect provider requiresclient_secret_postyou will need to update your configuration to ensure the integration continues to function properly. Discord is one of the known IdPs that requires theclient_secret_postclient authentication method. - See the OpenID Connect Identity Providers APIs, the OpenID Connect Identity Provider Overview and the Discord OIDC integration tutorial for more detail.
- Resolves GitHub Issue #445, thanks to @ovrdoz for reporting.
- The
- When you have enabled Self Service Registration and Registration Verification FusionAuth will fail to send the email to the end user during this workflow.
- Resolves GitHub Issue #496, thanks to our great Slack community for letting us know and assisting with debug.
- If a Two Factor Trust has been established with a particular browser through the user of a cookie, it was not being honored during the Passwordless Email workflow and the user would be prompted for the Two Factor challenge during each login attempt.
- Resolves GitHub Issue #495, thanks to our great Slack community for reporting!
- When using managed domains with the OpenID Connect or SAML v2 Identity Provider configurations the callback to FusionAuth may fail with an error.
- Resolves GitHub Issue #488, thanks to @sedough for reporting.
- When a stylesheet in your theme contains
>the new HTML escaping strategy introduced in version X causes this value in the CSS to be incorrectly escaped. If you encounter this problem in your current them, update the usage of the stylesheet to${theme.stylesheet()?no_esc}instead of the previous usage of${theme.stylesheet()}.- Resolves GitHub Issue #489, thanks to @snmed for reporting.
- Fix a Kickstart bug, when a variable is used in the very first API key the replacement was not honored.
- Resolves GitHub Issue #493, thanks to @tst-dhudlow for reporting!
Enhancements#
- When the External JWT Identity Provider does not have any managed domains defined, allow a JWT from any domain to be reconciled. This change makes this IdP configuration more consistent with our IdP configurations that allow for managed domains.
- Resolves GitHub Issue #491
Version 1.15.2 #
February 19th, 2020
Known Issues#
- Fixed in 1.15.3, on systems running MySQL, the
1.15.0migration fails on aDELIMITERcommand and causes the instance table to have a nulllicense_id. If you upgraded to1.15.2, have connected our instance to a support contract, and ran the1.15.0migration using maintenance mode, you will need to reconnect your license Id in the Reactor tab.- A workaround for this issue is to download the
fusionauth-database-schema-1.15.0.zipfrom our direct download page, unzip and manually apply themigrations/mysql/1.15.0.sqlmigration. You may also wait to upgrade until1.15.3is available and allow maintenance mode to run the fixed migration.
- A workaround for this issue is to download the
Fixed#
- Password breached fixes. On some systems running PostgreSQL a portion of the breach detections features may not function properly. If you are running MySQL this will not affect you, and only certain PostgreSQL versions are affected. If you are not using FusionAuth Reactor this issue will not affect you.
Version 1.15.1 #
February 18th, 2020
Known Issues#
- Fixed in 1.15.3, on systems running MySQL, the
1.15.0migration fails on aDELIMITERcommand and causes the instance table to have a nulllicense_id. If you upgraded to1.15.1, have connected our instance to a support contract, and ran the1.15.0migration using maintenance mode, you will need to reconnect your license Id in the Reactor tab.- A workaround for this issue is to download the
fusionauth-database-schema-1.15.0.zipfrom our direct download page, unzip and manually apply themigrations/mysql/1.15.0.sqlmigration. You may also wait to upgrade until1.15.3is available and allow maintenance mode to run the fixed migration.
- A workaround for this issue is to download the
Fixed#
- A SQL statement in PostgreSQL may cause some 9.x versions to fail to store breach metrics once FusionAuth Reactor has been enabled. If you are running MySQL this will not affect you, and only certain PostgreSQL versions are affected. If you are not using FusionAuth Reactor this issue will not affect you.
Version 1.15.0 #
February 17th, 2020
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
Known Issues#
- Fixed in 1.15.1, some versions of PostgreSQL may cause an exception when storing breach metrics after enabling FusionAuth Reactor. If you are not using FusionAuth Reactor or you are using MySQL instead of PostgreSQL this issue will not affect you.
- Fixed in 1.15.3, on systems running MySQL, the
1.15.0migration fails on aDELIMITERcommand and causes the instance table to have a nulllicense_id. If you upgraded to1.15.0, have connected our instance to a support contract, and ran the1.15.0migration using maintenance mode, you will need to reconnect your license Id in the Reactor tab.- A workaround for this issue is to download the
fusionauth-database-schema-1.15.0.zipfrom our direct download page, unzip and manually apply themigrations/mysql/1.15.0.sqlmigration. You may also wait to upgrade until1.15.3is available and allow maintenance mode to run the fixed migration.
- A workaround for this issue is to download the
Changed#
- In the FusionAuth admin UI you will notice that User, Groups, Applications and Tenants are all now at the top level of the left navigation sidebar. This change has been done to provide quicker access to these frequently accessed menus.
New#
- FusionAuth Reactor ™. FusionAuth Reactor is available with all paid plans of FusionAuth. The first feature in the Reactor suite will be breached password detection. All passwords will be checked against a breached list during all password change events, and optionally during login based upon your configuration.
- New webhook event for use with FusionAuth Reactor breached password detection. This event when enabled will be fired during login if the user is using a vulnerable password.
- User Password Breach (
user.password.breach), see Webhook Events for additional information.
- User Password Breach (
- New Tenant configuration in support of FusionAuth Reactor and additional password validation rules. This configuration can be found in the Password tab of the Tenant configuration on the Tenant API.
tenant.passwordValidationRules.validateOnLogin- When enabled the user's password will be validated during login. If the password does not meet the currently configured validation rules the user will be required to change their password. Prior to this release password validation was only ever performed during a change event, you may now optionally enforce your password policy during login.tenant.passwordValidationRules.breachDetection- A new object to provide configuration per tenant for password breach detection.
- During login, if the user is required to change their password, the Login API, Authorization Code Grant, Implicit Grant and Password Grant will now also return a change reason. This additional value in the response will indicate why the user is being required to change their password.
- See the Login API, and corresponding OAuth endpoints for more detail.
Security#
- A small window exists after a Refresh Token has expired when this token can still be used under specific circumstances. This symptom only occurs when using the
/api/jwt/refreshAPI, and not when using the Refresh Grant using the/oauth/tokenendpoint. In a worst case scenario the Refresh Token may be honored up to 5 hours after the expiration date, in most circumstances it will be much less. This only applies to expired Refresh Tokens, revoking a Refresh Token is not affected.- Resolves GitHub Issue #454, thanks to @johnmaia one of our FusionAuth MVPs!
Fixed#
- Editing a Group in a Tenant that does not yet have any Applications created causes and exception when you attempt to save the edit form in the FusionAuth admin UI.
- Resolves GitHub Issue #471, thanks to @dhait for letting us know, we appreciate you!
- When Self Service Registration, if Registration Verification is enabled and Email Verification is disabled the user will not receive a Registration Verification email.
- Resolves GitHub Issue #472
- An exception may occur when using the Import User API if you are missing the
applicationIdproperty in a User Registration. This error should have been found as a validation error and instead an exception occurred.- Resolves GitHub Issue #479, thanks to our friends at Integra Financial Services for reporting the error.
Enhancements#
- Allow Kickstart to better handle varying startup times and delays. A few users reported scenarios where Kickstart would begin before FusionAuth was ready causing Kickstart to fail.
- Resolves GitHub Issue #477
Version 1.14.0 #
January 22th, 2020
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
This change may affect you if you are performing advanced HTML escaping in your themed templates. During upgrade, any usage of ?html in a themed template will removed because it is now handled automatically and it is no longer valid to use the FreeMarker built-in ?html.
If any of your translated messages include an HTML entity such as \… and you are including this message using the theme message helper theme.message you may need to make a small adjustment in order for the entity to render properly. For example, on the Logout template the default text is Logging out… but if you see it rendered as Logging out\… you will need to add an the FreeMarker suffix ?no_esc so that the usage looks like this theme.message('logging-out')?no_esc.
It is recommended that you audit your theme for any usage of ?html and ensure you test your theme after migration. In the FusionAuth UI if you navigate to Settings -> Themes you can use the View action to render each template and ensure they render properly.]
Changed#
- A JWT Populate Lambda now has fewer reserved claims. All claims can now be removed or modified except for
exp,iatand thesubclaims by the JWT Populate Lambda. You remove or modify claims added by FusionAuth at your own peril.- See JWT Populate for additional details.
- Resolves GitHub Issue #387
- Add additional fields that can be merged by the
PATCHHTTP method. The following fields were not being merge, but replaced. The limitation of this change is that it is difficult to remove fields from values from arrays. A future enhancement may be to support the JSON Patch specification which provides semantics for add, replace and remove.User.preferredLanguagesUser.membershipsUser.registrationsUser.dataUserRegistration.dataUserRegistration.preferredLanguagesUserRegistration.rolesApplication.data- Resolves GitHub Issue #424
New#
- Kickstart™ allows you bypass the Setup Wizard in order to FusionAuth up and running quickly. Deploy development or production instances of FusionAuth using a pre-defined configuration of Users, Groups, Applications, Tenants, Templates, API keys, etc.
- Resolves GitHub Issue #170 🤘
- This feature is in *Tech Preview * which means if we find shortcomings with the design as we gather feedback from end users it is possible we will make breaking changes to the feature to correct or enhance the functionality. Any such changes will be documented in future release notes as appropriate.
- The Tenant API can optionally take a new
sourceTenantIdparameter to allow you to create a new Tenant using the values from an existing Tenant. Using thesourceTenantIdlimits the required parameters to the Tenant name.- Resolves GitHub Issue #311
- Add a View action to a Group Membership in the Membership tab of the Manage User panel in the UI.
- Resolves GitHub Issue #413
Fixed#
- A memory leak in the Nashorn JavaScript engine used to execute FusionAuth Lambdas has been resolved.
- The OAuth2 Authorization Code grant was required to complete a SAMLv2 login, this grant is no longer required to be enabled.
- Resolves GitHub Issue #432
- Added missing
theme_managerrole to the FusionAuth application
Version 1.13.2 #
December 30th, 2019
Fixed#
- During a reindex operation the status will properly be displayed on every node when viewing the User Search or the Reindex pages in the UI.
- Improve Kafka configuration validation when using the Test button in the UI.
- Resolves GitHub Issue #318, thanks to @nikos for reporting the issue!
- An exception may occur when using ReactNative with FusionAuth when an HTTP Origin header is sent to FusionAuth with a value of
file://. The exception is caused becausefile://without a value after the double slash is not a valid URI and cannot be parsed byjava.net.URI. However the HTTP specification indicates that an origin header with a scheme offile://is allowed and when used anything following the prefix is allowed. This fix follows a similar decision made by Apache Tomcat in their CORS filter, see Bugzilla #60008.- Resolves GitHub Issue #414, thanks to @karice for reporting the issue and helping us debug!
- When an invalid code or expired code is used on a Passwordless login request an exception may occur.
- Resolves GitHub Issue #416, thanks to @downagain for reporting the issue!
- When a user email is verified implicitly due to a change password action that originated via an email request the
user.verifiedevent is now sent.- Resolves GitHub Issue #418, thanks to @JonasDoe for asking via StackOverflow and then opening an issue to help us resolve the issue.
Version 1.13.1 #
December 19th, 2019
Search Index Rebuild
As part of the upgrade the Elasticsearch index will be rebuilt due to a modification in the index to support searching on nested collections. This additional step may cause additional load on your system until it has completed. If you have less than 100,000 users in FusionAuth you will not likely observe any meaningful impact to your system. If your user count is > 1 million, the reindex may take minutes to complete, during this time you may still use FusionAuth normally. Until your search index is completely rebuilt the Search API or User Search feature in the UI may not provide complete results.
Fixed#
- The Elasticsearch migration required to complete the upgrade to 1.13.0 may not always run as intended. Upgrading to this release will kick off an Elasticsearch reindex operation to correct the search index state.
Version 1.13.0 #
December 18th, 2019
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
Known Issues#
- A search index rebuild is required to complete this upgrade, this operation may not automatically be started during upgrade. If you have already upgraded to this release you can either upgrade to the 1.13.1, or manually initiate a reindex request by navigating in the UI to System -> Reindex .
New#
- Delete users who have not verified their email address after a specified duration
- See Tenant configuration or the Tenant API for additional information.
- Resolves GitHub Issue #360
- Delete application registrations of users who have not verified their registration after a specified duration
- See Application configuration or the Application API for additional information.
- Resolves GitHub Issue #360
- Delete Users by Search Query
- Resolves GitHub Issue #361
- See Bulk Delete Users API.
Fixed#
- The newly supported
PATCHHTTP method cannot be selected from the API key endpoint security settings. This means that you need to allow all methods in order to utilize thePATCHmethod. This has been resolved.- Resolves GitHub Issue #402, thanks to @radicaljohan for reporting!
- The newly supported
PATCHHTTP method is not configurable in the CORS filter. - An empty salt value is recommended in an error message but this was failing validation during Import using the User Import API.
- Resolves GitHub Issue #410, thanks to @TanguyGiton for reporting!
- An exception may occur when using the PATCH method on the User API when more than one tenant exists.
- Resolves GitHub Issue #400, thanks to @JesperWe for reporting!
Enhancement#
DELETE /api/user/bulktakesqueryStringandqueryparameters to search for users to delete by Elasticsearch query string and raw JSON query, and adryRunparameter to preview the affected users. See the User Bulk Delete API documentation.- Addresses GitHub Issue #361
POST /api/user/searchandGET /api/user/searchtake aqueryparameter to search for users by an Elasticsearch raw JSON query. See the User Search API documentation.- Addresses GitHub Issue #361
/api/user/searchtakes newsortFieldsfor sorting search results. See the User Search API documentation.- The Webhook URL is no longer constrained to 191 characters. Prior to this version, this URL was considered unique and the length was constrained due to indexing limitations. The URL is no longer required to be unique and it is up to the user to limit duplicate webhooks.
- Resolves GitHub Issue #386, and thanks to @davidmw for bringing this issue to our attention. Long URLs for everyone!
Version 1.12.0 #
December 8th, 2019
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
Changed#
- In support of the OAuth Device Grant feature released in 1.11.0, a second template was added to separate the completion state.
- New themed template
OAuth device complete. Starting with version 1.12.0, templates will no longer be automatically migrated into an existing theme. We believe this is a safer choice overall. Instead your theme will be marked as requiring upgrade when viewed in the UI. You will be prompted to complete the missing templates when you edit and you will be provided with the option to copy in the default template as a starting point. - If FusionAuth attempts to render the missing template you will be prompted with a message indicating your theme needs to be upgraded. In generally this should happen when you are using a new feature and thus should occur at development time. Whenever a new template is added, it is recommended to edit and verify your theme right away after upgrade to ensure a smooth migration.
- New themed template
- In support of the HYPR integration, a new template was added that will be used when waiting for the external HYPR authentication to complete.
- New themed template
OAuth2 wait. Starting with version 1.12.0, templates will no longer be automatically migrated into an existing theme. We believe this is a safer choice overall. Instead your theme will be marked as requiring upgrade when viewed in the UI. You will be prompted to complete the missing templates when you edit and you will be provided with the option to copy in the default template as a starting point.
- New themed template
- The following theme messages were added. Until these values have been translated they will be rendered in English. At your earliest convenience you will want to add these new keys to your existing themes. You may wish to review the community provided translations which may already contain these new messages. https://github.com/FusionAuth/fusionauth-localization
wait-title=Complete login on your external device
waiting=Waiting
[ExternalAuthenticationExpired]=Your external authentication request has expired, please re-attempt authentication.- A change has been made to how an event is sent to Webhooks when the Transaction configuration does not require any webhooks to succeed. Prior to this version each webhook would be called in order and once the status was collected from each webhook a decision was made to return to the caller or fail the request. In order to increase the performance of webhooks, when the Transaction configuration does not require any webhooks to succeed each webhook will be called in a separate thread (asynchronously) and the request will return immediately. In this scenario any failed requests will not be retried. See Webhooks for more information.
New#
- Support HYPR IdP native integration. HYPR brings passwordless and biometric options to FusionAuth.
- See the HYPR Identity Provider for additional details
- Administrative actions added to Users -> Manage panel.
- Send password reset
- always available from the drop down menu.
- Resolves GitHub Issue #351, thanks to @nicholasbutlin for the suggestion!
- Resend email verification
- available when the user's email is not yet verified from the drop down menu.
- Resend verification
- available as a new row button in the Registrations tab when a registration is not verified.
- Send password reset
Fixed#
- Modifying user actions with multi tenants returns a missing tenant error.
- Resolves GitHub Issue #328, thanks to @AlvMF1 for reporting the issue!
- The JWT Validate endpoint returns the wrong precision for
iatandexpclaims.- Resolves GitHub Issue #347, thanks to @uncledent for reporting and providing detailed information.
- When using the one time password returned from the Change Password API when a Refresh Token was provided during the change request a Refresh Token is not returned from the Login API.
- Resolves GitHub Issue #382, thanks to @colingm for reporting the issue.
- A "null" Origin header is allowed in the w3 spec, and when this occurs it may cause an exception when validating authorized origins.
- Resolves GitHub Issue #379, thanks to @karice for reporting and excellent assist!
- Better handling on the Start Passwordless API when a user does not exist
- Resolves GitHub Issue #377, thanks to @smoorsausje for reporting!
Enhancement#
- The User Delete API will no longer delete User Actions taken by the user. Instead the API will now disassociate any UserActions created by the deleted user by removing them from the Actioning User. In this scenario, a user will remain in an Action taken by a user that has now been deleted.
- A User Action may be applied to a user in a different tenant than the User taking the action. Prior to this release, using the admin UI to take an action on a user in a different tenant may fail.
- The following APIs now support the
PATCHHTTP method. This enhancement completes GitHub Issue #121./api/application/api/application/role/api/consents/api/email/template/api/group/api/identity-provider/api/integration/api/lambda/api/system-configuration/api/tenant/api/theme/api/user/api/user-action/api/user-action-reason/api/user/consent/api/user/registration/api/webhook
- The FusionAuth client libraries now also support the PATCH method.
- When an encoded JWT is accepted in the Authorization header, FusionAuth will now accept the token in the
Beareror theJWTschema. - When you begin an external login such as Facebook, Google or Twitter an in progress indicator will be added to the login panel to indicate to the user that a request is in progress.
- Resolves GitHub Issue #331, thanks to @davidmw for the suggestion!
- If you are using a theme and want to take advantage of this indicator, you can compare the stock OAuth2 Authorize template, look for the note in the top JavaScript section.
Version 1.11.0 #
October 29th, 2019
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
Security#
- A change was made to the FreeMarker template engine to remove the possibility of malicious code execution through a FreeMarker template. To exploit this vulnerability, one of two scenarios must occur. The first scenario is a user with an API key capable of adding or editing Email or Theme templates, the second scenario is a user with access to the FusionAuth admin UI that has the necessary authority to add or edit Email or Theme templates. In these two scenarios the user would need to add code to the template with the intention of executing a malicious system command. There is a low probably of this exploitation to occur if you have trusted applications and administrative users.
Changed#
- Remove the
sidand theissrequest parameters on the URL provided bypost_logout_redirect_uri. This feature was added in version1.10.0and because the redirect URL may be a previously configured Logout URL or a URL provided by thepost_logout_redirect_uriwe were always adding these additional request parameters to the URL. This change will remove them from the redirect URL and they will only be added to the URLs used to build the iframes in the logout template.- Resolves GitHub Issue #332, thanks to @davidmw for the feedback!
- In support of the OAuth Device Grant feature, the following theme changes have been made.
- New themed template
OAuth device. This template has been added to each of your existing themes. As part of your migration please review this template to ensure it matches your intended style.
- New themed template
- The following theme messages were added. Until these values have been translated they will be rendered in English. At your earliest convenience you will want to add these new keys to your existing themes. You may wish to review the community provided translations which may already contain these new messages. https://github.com/FusionAuth/fusionauth-localization
device-form-title=Device login
device-login-complete=Successfully connected device
device-title=Connect Your Device
userCode=Enter your user code
[blank]user_code=Required
[invalid]user_code=Invalid user code- The following hidden fields were added and you will need to update your
[#macro oauthHiddenFields]in the theme "Helpers" of existing Themes if you intend to utilize the Device Grant orresponse_modein the Authorization grant:
[@hidden name="response_mode"/]
[@hidden name="user_code"/]- An update has been made to the
[@link]macro in the Helpers template. If you intend to utilize the Device Grant you will need to add the missing parameters to your macro or copy the updated macro and usage from the default FusionAuth theme. Theuser_coderequest parameter has been added to this macro.
New#
- Device Authorization Grant
- This satisfies GitHub Issue #320 - OAuth2 Device Authorization Grant
- This grant type is commonly used to connect a set top box application to a user account. For example when you connect your HBO NOW Roku application to your account you are prompted with a 6 digit code on the TV screen and instructed to open a web browser to hbonow.com/tvcode to complete the sign-in process. This process is using the OAuth Device Grant or a variation of this workflow.
- Support for the
response_moderequest parameter during the Authorization Code grant and the Implicit grant workflows.- This will provide support for
response_mode=form_post - Resolves GitHub Issue #159, thanks to @bertiehub for requesting.
- This will provide support for
- An additional API is available in support of Passwordless Login to allow additional flexibility with third party integrations.
- See GitHub Issue #175
- This feature will be available in 3 steps, Start, Send and Complete. Currently the Send API generates a code and sends it to the user, and then a Login API completes the request. The change is backwards compatible, but a Start action will be provided so you may skip the Send and collect the code and send it to the user using a third party system.
- See the Passwordless API documentation for additional information.
Preview#
- The
PATCHHTTP method is available on some APIs in a developer preview. This is not yet documented and should only be used in development. The following APIs support thePATCHmethod, more to come./api/application/api/user/api/user/registration- This is in support of GitHub Issue #121 - Support HTTP method PATCH.
Fixed#
- Return a
400status code with a JSON response body on the Import API when a foreign key constraint causes the import to fail- Resolves GitHub Issue #317, thanks to @AlvMF1 for reporting the issue!
- Return a
401status code on theUserinfoendpoint for invalid tokens- Resolves GitHub Issue #321
- The Passwordless login external identifier complexity settings are not working
- Resolves GitHub Issue #322, thanks to @pawpro for letting us know!
- An error is incorrectly displayed on the Forgot Password form even when the code is valid
- Resolves GitHub Issue #330, thanks to @JesperWe for reporting the issue!
- When a large number of tenants exist such as 3-5k, an exception may be thrown during a key cache reload request
- Resolves GitHub Issue #326, thanks to @johnmaia for reporting!
- When using the
id_token_hinton the Logout endpoint, if the token was issued to a user that is not registered for the application it will not contain theapplicationIdclaim. This claim was being used to resolve theclient_idrequired to complete logout. An alternative strategy is now used so that anid_tokenissued to a user that is registered, or not registered will work as expected when provided on the Logout endpoint.- Resolves GitHub Issue #350, thanks to @paulspencerwilliams for taking the time to let us know!
- Support a SAML SP that does not send the
<samlp:NameIDPolicy />constraint in the AuthN request, in this case we will default tourn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress.
Enhancement#
- Front-channel logout was made more flexible
- Resolves GitHub Issue #324
- A new attribute
Logout behaviorwas added to the Application -> OAuth configurationRedirect only- legacy behavior of only logging out of SSO and redirecting to either the registered logout URL in the application or thepost_logout_redirect_uri.All applications- performs a front channel logout of all registered applications in the tenant. Optionally, the themeableOauth logoutpage can be modified to only logout of those applications the user is registered for.
- In some cases the Facebook IdP configuration requires a permission of
emailto be configured in order for theemailclaim to be returned from the Facebook Me API even whenemailis also specified in thefieldparameter. FusionAuth will default both thefieldsand thepermissionsparameters toemailon create if not provided to make the Facebook IdP work out of the box for more users. Defaults will not be applied if these fields are left blank or omitted on an update. - The Passwordless Send API now takes an optional
codeparameter which will be used as the Passwordless code sent in the email. Thiscodecan be generated by the new Passwordless Start API.
Version 1.10.1 #
October 1st, 2019
Fixed#
- When logging into Google or other external Identity Provider for an Application outside of the default tenant the login may not complete successfully. This issue was introduced in version 1.9.0. A work around is to use an application in the default tenant.
- A status code of
500may occur during the processing of the SAML v2 response from an SAML v2 IdP.- Resolves GitHub Issue #314, thanks to @Raghavsalotra for all his help verifying a fix for this issue.
Version 1.10.0 #
September 30th, 2019
Changed#
- In support of the OpenID Connect Front Channel logout feature, the following theme changes have been made.
- New themed template
OAuth logout. This template has been added to each of your existing themes. As part of your migration please review this template to ensure it matches your intended style.
- New themed template
- The following theme messages were added. Until these values have been translated they will be rendered in English. At your earliest convenience you will want to add these new keys to your existing themes. You may wish to review the community provided translations which may already contain these new messages. https://github.com/FusionAuth/fusionauth-localization
logging-out=Logging out&hellip;
logout-title=Logging out
or=Or
[ExternalAuthenticationException]=%1$s The login request failed.New#
- Support for the OpenID Connect Front Channel logout
- This updates the existing OAuth2 Logout endpoint to be compliant with the OpenID Connect Front-Channel Logout 1.0 - draft 02 specification
- TL;DR The
/oauth2/logoutendpoint will call logout URLs of all tenant applications. A redirect URL can be requested on the URL viapost_logout_redirect_uri. - Resolves GitHub Issue #256, thanks to all who up voted and provided valuable feedback.
- The OpenID Connect discovery endpoint now returns the following attributes:
end_session_endpointfrontchannel_logout_supportedbackchannel_logout_supported
Fixed#
- Send email API may fail with a
500. This issue was introduced in version1.9.0. - SAML v2 Invalid Redirect. This resolves GitHub Issue #287, thanks to @prasanna10021991 for reporting and helping!
Enhancement#
- Allow request parameters to be provided on the Authorization endpoint in the OpenID Connect relaying party configuration. This allows FusionAuth to integrate with the Twitch OpenID Authorization Grant implementation.
- This resolves GitHub Issue #309, thanks to @tauinger-de for reporting and helping out!
- This is a partial fix to work around not supporting the
claimsparameter on the Authorize request. See GitHub Issue #308 for additional information.
Version 1.9.2 #
September 24rd, 2019
Fixed#
- If you have one or more themes defined prior to upgrade you may be unable to login.
- Resolves GitHub Issue #306, thanks to @flangfeldt and @jerryhopper for the assist!
- See workaround in the linked GitHub issue.
- Resolves Internal Server Error after Fusion Auth Upgrade to v 1.9.1, thanks to Tom Bean for reporting!
Version 1.9.1 #
September 23rd, 2019
Fixed#
- Unable to modify the name of the default FusionAuth theme. If you attempt to edit the theme and save the form a validation error occurs that is not expected and will cause an exception. If you encounter this problem you can simply not edit the FusionAuth theme since you are not able to modify the templates anyway. Instead just duplicate the theme if you would like to view any of the default messages.
Version 1.9.0 #
September 23rd, 2019
New#
- Full theme localization support for errors and all other text
- If you're interested in helping us crowd source additional languages check out this Git repo and open an issue or submit a PR.
- https://github.com/FusionAuth/fusionauth-localization
Fixed#
- When editing a new email template that contained
${user.tenantId}the template validation may fail.- Resolves GitHub Issue #294, thanks to @tauinger-de for reporting the issue.
- A locked account may still be able to login via Google or other external identity provider.
- Resolves GitHub Issue #301, thanks to @jerryhopper (a FusionAuth MVP) for the bug report!
- Previous to this change when using the OAuth2 login or the Login API, a locked account was treated as a "soft" lock and a
404would be returned from the Login API which in turn displayed an Invalid credentials error. The account locked (soft delete) state will not return a423status code instead of a404which will result in a different message to the OAuth2 login.
Version 1.8.1 RC1 #
September 10th, 2019
This is a release candidate. This means the version is stable and should work for most cases. However, due to the complexity of the database migration ensure you have adequately tested the upgrade prior to moving it into production. You may also wish to wait for the forthcoming full release of 1.8.1 or 1.9.0 before moving into production.
Fixed#
- The SQL issue described below in the warning message has been resolved.
- Performing a clean install of
1.8.0-RC.1may fail in some cases - When
user.passwordChangeRequiredistrueand you login via an external identity provider you will be redirected to/password/changewith an invalid code so you will not be able to complete the change password workflow. You may work around this change by navigating back to the login page and clicking the forgot password link.
Version 1.8.0 RC1 #
September 8th, 2019
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
Known Issues:
Any rows in the user_external_ids table with a null value in the applications_id column may cause the migration to fail. Prior to upgrading run the following SQL command:
DELETE from user_external_ids WHERE applications_id IS NULL; This issue will be resolved in the final release of 1.8.0.
]
Community MVPs#
Thanks to all of our community members who take the time to open features, report bugs, assist others and help us improve FusionAuth! For this release we would like to thank the following GitHub users who helped us out!
- @AlvMF1
- @colundrum
- @damienherve
- @davidmw
- @fabiojvalente
- @flangfeldt
- @johnmaia
- @petechungtuyco
- @prabhakarreddy1234
- @snmed
- @tombeany
- @unkis
- @whiskerch
- @zbruhnke
Changed#
- Most of the configuration previously available in the System Settings has been moved to the Tenant configuration to allow for additional flexibility. This is important if you will be utilizing more than one tenant, you may now configure password policies, email configuration, etc per tenant. If you are using the System Configuration or Tenant APIs, please be aware of this change and plan accordingly. If you were manually synchronizing these configurations between systems, you will need to update these processes.
- SMTP configuration
- Event configuration
- Password configuration
- Failed Authentication configuration
- Password configuration
- JWT configuration
- Theme
- When using a theme, whenever possible provide the
tenantIdon the request using an HTTP request parameter. This will help ensure FusionAuth will render the page using your chosen theme. In most cases FusionAuth can identify the correct tenant and theme based upon other parameters in the request, but in some circumstances there is not enough information and FusionAuth will default to the stock theme if thetenantIdis not explicitly provided.- For example in each of the shipped email templates the following has been added to the generated URL
?tenantId=${tenantId}. You may wish to add this to your email templates if you're using themes.
- For example in each of the shipped email templates the following has been added to the generated URL
- If you were previously accessing a themed stylesheet in your template as
${loginTheme.stylesheet}it is now accessed like this${theme.stylesheet()}.
New#
- Top level theme menu in FusionAuth UI. Settings -> Themes .
- Create, delete, edit and update themes
- Assign a named theme to a tenant
- Theme preview
- User modifiable CORS configuration
- A public key may also be retrieved by
kidin addition to theapplicationIdwhen using the Public Key API. This resolves GitHub Issue #227. - PKCE support for use during the Implicit Grant
- New User Email Verified and User Registration Verified events. Resolves GitHub Issue #163, thanks to @unkis, @prabhakarreddy1234 and @davidmw for the great feedback!
- Email Verification, Registration Verification, Change Password, Setup Password and Passwordless Login can be optionally configured to use codes made up of digits instead of long strings. This may be helpful if you wish the user to type in a code during an interactive workflow.
- Resolves GitHub Issue #269, thanks to @zbruhnke for helping us get this one delivered.
Fixed#
- Tenant scoped SMTP configuration, password rules, event transactions, JWT signing configuration, etc.
- When viewing Refresh token expiration in the Manage User panel under the Sessions tab, the expiration may be displayed incorrectly if the Refresh Token Time to Live has been set at the Application level. The actual time to live was still correctly enforced, but this display may have been incorrect.
- In some cases an Id Token signed by FusionAuth may not be able to be verified if it is sent back to FusionAuth. This issue was introduced in version
1.6.0. - If the host operating system is not configured for
UTF-8and you specify multi-byte characters in an email template subject, the subject text may not be rendered correctly when viewed by the recipient.- Resolves GitHub Issue #231, thanks to @Lechu67 for reporting via Stack Overflow and helping to diagnose the issue.
- Toggle rendering issue in Firefox. Resolves GitHub issue #260, thanks to @snmed for the assist!
- When creating users and applications programatically, due to a timing issue, you may receive an unexpected error indicating the Application does not exist. Resolves GitHub Issue $252, thanks to @johnmaia for reporting the issue.
- An exception may occur when using the Login with Google feature if the
pictureclaim returned is not a valid URI. Resolves GitHub Issue #249, thanks to @damienherve for reporting the issue. - A tenant may fail to be deleted. Resolves GitHub Issue #221, thanks to @johnmaia for the assist! If you encounter this issue, ensure the search index is updated, generally this will only happen if you programatically create users and then immediately attempt to delete a tenant.
- The relative link on the Change Password themed template to restart the Forgot Password workflow when the code has expired is broken. Resolves GitHub Issue #280, thanks to @flangfeldt for letting us know!
- The Import API may fail due to a false positive during password salt validation. Resolves GitHub Issue #272, thanks to @tombeany for reporting the issue.
- Modifying an Identity Provider configuration when an Application has been disabled may cause an error in the UI. Resolves GitHub Issue #245, thanks to @fabiojvalente for reporting the issue.
- When the FusionAuth schema exists in the database and you reconnect FusionAuth using the database maintenance mode, depending upon the version of PostgreSQL we may not properly detect that the schema exists and return an error instead of continuing. Resolves GitHub Issue #237, thanks to @whiskerch for reporting the issue.
- A typo in the Java FusionAuth client causes the to fail the
generateEmailVerificationIdrequest. Resolves GitHub Issue #282, thanks to @petechungtuyco for reporting the issue and pointing out the solution!
Enhancement#
- JWT Refresh Token Revoke event will contain a User object when available
- Resolves GitHub Issue #255, thanks to @AlvMF1 for the great suggestion!
- In a themed template that may have the
passwordValidationRulesavailable after a password validation field error will now always have thepasswordValidationRulesavailable if you choose to display them. Resolves GitHub Issue #263, thanks to @AlvMF1 for the suggestion! - Updated PostgresSQL connector to support
SCRAM-SHA-256. Thanks to @colundrum for letting us know and assisting in testing. Resolves GitHub Issue #209 - The OpenID Connect discovery endpoint now accepts optional
tenantIdrequest parameter. - A User object is returned in the
jwt.refresh-token.revokeevent JSON. - The field
tenantIdis returned in event JSON.
Version 1.7.4 #
August 22th, 2019
Fixed#
- When configuring a SAML v2 IdP relying party using the FusionAuth SP metadata, the configured ACS may not work properly. If you encounter this issue you may manually modify the relying party configuration to change the ACS endpoint to
/oauth2/callback.- Resolves Stack Overflow : FusionAuth ADFS integration issue, thanks to @johan for reporting the issue.
Version 1.7.3 #
August 15th, 2019
New#
- SAML v2, OpenID Connect, Google, Facebook, Twitter and External JWT Identity Provider configurations now have a debug flag. When enabled a debug Event Log will be created during each request to the Identity Provider to assist in debugging integration issues that may occur. In addition, error cases will be logged in the Event log instead of to the product log.
- SAML v2 Service Provider (Relaying Party) Metadata URL
Fixed#
- In some cases when running FusionAuth behind a proxy without setting the
X-Forwarded-Portheader the URLs returned in the OpenID Configuration discovery document may contain anhttpsURL that is suffixed with port80. If this is encountered prior to this version you may simply add theX-Forwarded-Portheader in your proxy configuration. - SAML v2 fix when using
urn:oasis:names:tc:SAML:2.0:nameid-format:transientorurn:oasis:names:tc:SAML:2.0:nameid-format:persistentName Id formats.- Resolves GitHub Issue #205, thanks to @mikerees for reporting the issue and helping us test a fix.
- SAML v2 fix in the IdP Metadata. The
IDPSSODescriptorwas missing theprotocolSupportEnumerationwhich may cause some SAML metadata parsers to fail processing.- Resolves GitHub Issue #235, thanks to @user1970869 for reporting the issue and helping us test a fix.
- SAML v2 fix in the IdP Metadata. The value returned in the
issuerattribute was not the same as theentityIdprovided in the metadata which may cause some SAML metadata parsers to fail processing.- Resolves GitHub Issue #240, thanks to @user1970869 for reporting the issue and helping us test a fix.
- And audit log entry may not be created for a FusionAuth admin that does not have an email address when modifying configuration with the FusionAuth UI.
- Resolves GitHub Issue #268
Enhancement#
- Integration details have been moved to a view dialog for each Identity Provider configuration. Previously these values were provided as read only fields on the edit panel in the UI.
- See the View action for your Identity Provider configurations by navigating to Settings -> Identity Providers .
Version 1.7.2 #
June 19th, 2019
Fixed#
- Deleting a user that has recently had a failed login may fail when FusionAuth is tracking failed login attempts to lock user accounts.
- Resolves GitHub Issue #184 : Cannot delete user with too many login attempts, thanks to @gmpreussner for reporting the issue.
- Login to a 3rd party SAML IdP may fail
- Resolves GitHub Issue #181 : Trouble with SAML and OpenID logins, thanks to @davidmw for reporting the issue.
- Fix the uptime calculation for nodes when viewed in the About panel. System -> About
Version 1.7.1 #
June 13th, 2019
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
Fixed#
- Possible migration error for PostgreSQL users
Version 1.7.0 #
June 13th, 2019
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
Changed#
- The
timezonefield in the User and UserRegistration must be a IANA time zone. This was previously assumed, but not always enforced. If a timezone is set for a User or UserRegistration that is not a valid IANA timezone,nullwill be returned when retrieving the User or UserRegistration timezone.
New#
- Family and relationship modeling. Yeah, everyone has users, but does your IdP manage family relationships?
- Family concepts
- Family APIs
- Consent management. Need to record parental consent, or track opt-in for your users? Look no further.
- Consent concepts
- Consent APIs
- We will ship FusionAuth with COPPA VPC, and COPPA Email+ consents, additional consents may be added through the Consent management interface and through the Consent APIs.
- Export of Audit Logs to a zipped CSV in the UI and via the Export API
- Export of Login Records to a zipped CSV in the UI and via the Export API
- Login Record view that contains limited search and pagination capability. In the UI see System -> Login Records
- Retention policy for Audit Logs. This feature is disabled by default and may be enabled to retain a configured number of days worth of Audit Logs.
- Retention policy for Login Records. This feature is disabled by default and may be enabled to retain a configured number of days worth of Login Records.
Fixed#
- Some timezones may not be correctly discovered during login. When this occurs an
undefinedvalue is set which may cause an error during login to the FusionAuth UI. - Support importing Bcrypt hashes that contain a
.(dot). The Bcrypt Base64 encoding uses a non standard character set which includes a.(dot) instead of a+(plus) as in the standard character set. Thank you to Diego Souza Rodrigues for discovering this issue and letting us know!. - Better support for third party 2FA devices such as an RSA key fob. When providing FusionAuth with a secret to enable Two Factor authentication we will accept a string in a Bas32 or Base64 encoded format. The documentation has been updated to further clarify this behavior. Previously if you brought your own secret to FusionAuth to enable 2FA, depending upon the format of the key, you may not have been successful in enabling 2FA for a user.
- Managed domains were not being returned properly for a SAML v2 IdP configuration. This means that you could not limit the SAML v2 IdP configuration to users with a specific email domain.
Enhancement#
- The User Registration object is now available as a top level object in the Verify Registration email template. The registration was previously available in the
userobject, but it will now also be a top level objectregistration. - Support arbitrary URIs for OAuth redirects.
- Add
user.mobilePhoneto the search index. For an existing installation, to take advantage of this field for existing users, you may need to rebuild the search index. See System -> Reindex- Resolves GitHub Issue #165 : Add mobilePhone in User Search
- Thanks to @petechungtuyco for letting us know and suggesting the addition.
Version 1.6.1 #
May 2nd, 2019
Fixed#
- Using OpenID Connect with Microsoft Azure AD may fail
- Thanks to @stevenrombauts and @plunkettscott for reporting the issue. OpenID connect fails with Azure AD #153.
Version 1.6.0 #
April 28th, 2019
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
The SAML specification is complex and not all SAML v2 Service Providers are specification compliant. This means your mileage may vary as you utilize the FusionAuth SAML v2 IdP to allow services such as Zendesk, Pivotal and Google G-Suite to log into FusionAuth using SAML v2. If you run into problems open a GitHub issue and we will try to help.
Changed#
- Deprecated the following properties
SystemConfigurationandApplicationdomain. This is all now managed through Key Master, and existing keys have been migrated into Key Master.jwtConfiguration.issuerjwtConfiguration.algorithmjwtConfiguration.secretjwtConfiguration.publicKeyjwtConfiguration.privateKey
- Deprecated the following property
SystemConfiguration.jwtConfiguration.issuer, it has moved toSystemConfiguration.issuer. - A new macro was added to the
_helpers.ftlthat may be managed by your theme. If you have modified the_helpers.ftltemplate as part of your theme, you will either need to reset that template and merge your changes back in, or add the following code to your_helpers.ftlmanaged by your theme. If you encounter an issue with this, you will still likely be able to login to correct the issue, if you do get stuck you may disable your theme to login. See Troubleshooting themes.
[#macro link url text extraParameters=""]
<a href="${url}?tenantId=${(tenantId)!''}&client_id=${(client_id?url)!''}&nonce=${(nonce?url)!''}&redirect_uri=${(redirect_uri?url)!''}&response_type=${(response_type?url)!''}&scope=${(scope?url)!''}&state=${(state?url)!''}&timezone=${(timezone?url)!''}&metaData.device.name=${(metaData.device.name?url)!''}&metaData.device.type=${(metaData.device.type?url)!''}${extraParameters!''}">
${text?html}
</a>
[/#macro]New#
- Support for SAMLv2 IdP. This satisfies GitHub Issue #3
- Support for SAMLv2 Service Provider to support federated authentication to a SAMLv2 Identity Provider. This satisfies GitHub Issue #104
- Lambda support. Lambdas are user defined JavaScript functions that may be executed at runtime to perform various functions. In the initial release of Lambda support they can be used to customize the claims returned in a JWT, reconcile a SAML v2 response or an OpenID Connect response when using these Identity Providers.
- See the Lambda API and the new Lambda settings in the UI Settings -> Lambdas .
- Event Log. The event log will assist developers during integration to debug integrations. The event log will be found in the UI under System -> Event Log .
- SMTP Transport errors
- Lambda execution exceptions
- Lambda debug output
- SAML IdP integration errors and debug
- Runtime exceptions due to email template rendering issues
- And more!
- Key Master, manage HMAC, Elliptic and RSA keys, import, download, generate, we do it all here at Key Master.
- New events
user.login.faileduser.login.successuser.registration.createuser.registration.updateuser.registration.delete
- Easily duplicate email templates using the Duplicate action.
- Manage Access Token and Id Token signing separately
Enhancement#
- Insert instant provided on the Import API for Users and Registrations will be reflected in the historical registration reports
- Additional node information will be available on the About panel when running multiple FusionAuth nodes in a cluster. See System -> About .
Fixed#
- If Passwordless login is disabled because no email template has been configured the button will not be displayed on the login panel. If a user attempts to use the passwordless login and the feature has been disabled or the user does not have an email address a error will be displayed to alert the user.
- If you are using the Implicit Grant and you have Self Service Registration enabled for the same application, the redirect after the registration check will assume you are using the Authorization Code grant. To work around this issue prior to this release, disable Self Service Registration. Thanks to @whiskerch for reporting this issue in GitHub Issue #102.
- Fixed OpenID Connect federated login. Our JavaScript code was throwing an exception due to the removal of the
devicefield from OAuth. This code wasn't updated and therefore would not perform the redirect to the third-party Open ID Connect IdP. To fix this issue in 1.5.0 or below, you can remove this line from OpenIDConnect.js on or near line 48:+ '&device=' + Prime.Document.queryFirst('input[name=device]').getValue(). - When you use the Refresh Grant with a Refresh Token that was obtained using the Authorization Code grant using the
openidscope, the response will not contain anid_tokenas you would expect. This fixes GitHub Issue #110 - OIDC and Refresh Tokens. Thanks to @fabiosimeoni for reporting this issue - When using the OpenID Connect Identity Provider that requires client authentication may fail even when you provide a client secret in your OpenID Connect configuration.
- https://github.com/FusionAuth/fusionauth-issues/issues/118
- https://github.com/FusionAuth/fusionauth-issues/issues/119
- https://github.com/FusionAuth/fusionauth-issues/issues/122
Version 1.5.0 #
March 25th, 2019
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
Changed#
- Removed
/oauth2/tokenfrom the CORS configuration. This change will cause the CORS filter to reject aPOSTrequest to the/oauth2/tokenendpoint when the request originates in JavaScript from a different domain. This will effectively prohibit the use of the OAuth2 Password grant from JavaScript. - The
deviceparameter is no longer required on the Login API or the Authorized endpoint in order to receive a Refresh Token. If thedeviceparameter is provided it will be ignored. - Correct the Refresh API response body to match the documentation. If you are currently consuming the JSON body of this API using the
POSTmethod, you will need to update your integration to match the documented response body.
New#
- Support for Passwordless login via email. See Passwordless API if you'll be integrating with this API to build your own login form.
- To use this feature using the provided FusionAuth login form, enable Passwordless by navigating to your FusionAuth Application and selecting the
Securitytab.
- To use this feature using the provided FusionAuth login form, enable Passwordless by navigating to your FusionAuth Application and selecting the
- Support for the OAuth2 Implicit Grant. See the OAuth 2.0 & OpenID Connect Overview and OAuth 2.0 Endpoints for additional information.
- The
Authorization Code,Password,ImplicitandRefresh Tokengrants maybe enabled or disabled per application. SeeoauthConfiguration.enabledGrantsproperty in the Application API, or theOAuthtab in the Application configuration in the FusionAuth UI. - The Change Password API can be called using a JWT. This provides additional support for the Change Password workflow in a single page web application. See the Change Password API for additional details.
- The Change Password API in some cases will return a One Time password (OTP). This password may then be exchanged for a new JWT and a Refresh Token on the Login API. This allows for a more seamless user experience when performing a change password workflow. See the Change Password and Login API for additional details.
- The Login API can now be restricted to require an API key. The default for new applications will require authentication which can be disabled. Existing applications will not require authentication via API to preserve the existing behavior. The Login API may also be restricted from return Refresh Tokens are allowing an existing Refresh Token be used to refresh an Access Token. These settings will be configurable per Application, see the Application API for additional details, or the
Securitytab in the Application configuration in the UI. If using the Application API, see theapplication.loginConfigurationparameters. - The
c_hash,at_hashandnonceclaims will be added to theid_tokenpayload for the appropriate grants. - Add support for
client_secret_postto the already providedclient_secret_basicClient Authentication method. This means that in addition to using HTTP Basic Authentication, you may also provide theclient_idandclient_secretin the request body.
Enhancement#
- Better ECDSA private and public key validation to ensure the algorithm selected by the user matches the provided key.
- When using the Change Password workflow in the OAuth2 Implicit or Authorization Code grants, the user will be automatically logged in upon completing a change password that is required during login.
- The Two Factor Login API will return the
twoFactorTrustIdas an HTTP Only secure cookie in addition to being returned in the JSON response body. This provides additional support and ease of use when making use of this API in a single page web application. See the Two Factor Login API for additional details.
Fixed#
- When using the Login Report in the UI and searching by user, if you have more than one tenant you will encounter an error.
- Validation errors are not displayed in the Add Claim dialog when configuring claim mapping for an External JWT Identity Provider
- Calling the Tenant API with the
POSTorPUTmethods w/out a request body will result in a500instead of a400with an error message. - When a locale preference has not been set for a FusionAuth admin and the English locale is used the user may see dates displayed in
d/M/yyyyinstead ofM/d/yyyy. - Fix some form validation errors during self-registration.
- The Action user action on the Manage User panel was opening the Comment dialog instead of the Action user dialog
- When a user has 2FA enabled and a password change is required during login, the 2FA will now occur before the change password workflow
- When more than one tenant exists, the Forgot Password link on the FusionAuth login page will not function properly.
- The Logout API may not always delete the
access_tokenandrefresh_tokencookies if they exist on the browser. - The
id_tokenwill be signed with theclient_secretwhenHS256,HS384orHS512is selected as the signing algorithm. This is necessary for compliance with OpenID Connect Core 3.1.3.7 ID Token Validation. This fixes GitHub issue GitHub Issue #57, thanks to @anbraten for reporting this issue. If you encounter this issue prior to this version, copy the Client Secret found in the UI on theOAuthtab of your Application configuration into the HMAC secret on theJWTconfiguration tab. - The Login API will now return a
400with an error JSON response body if theapplicationIdparameter does not belong to any configured applications. Previous to this release, this was treated the same as if the User was not registered to the requested application. - A change to the Docker build for permissions reduced the overall
fusionauth-appimage by ~ 200 MB.
Version 1.4.0 #
February 4th, 2019
The FusionAuth System Requirements have been updated. Please review the updated requirements to ensure you have met the minimum supported versions of operating system and database.
Changed#
- Renamed
Typeenum inDeviceInfoclass toDeviceType. This will only affect you if you are using the Java or C# client and reference this enum directly. If you are using this class directly, you may need to update an import in your client code. - More than one authorization code may exist for a single user at a given time. This will allow multiple asynchronous requests to begin an OAuth2 Authorization Grant workflow and succeed regardless of order.
New#
- Self service registration. You may optionally enable this feature per application and allow users to create a new account or register for new applications without building your own registration forms.
- JSON Web Key set support. This endpoint will be exposed at
/.well-known/jwks.jsonand will be published in the OpenID Configuration metadata endpoint as well. Prior to this release the public keys used to sign JSON Web Tokens were only available in PEM format using the Public Key API, this endpoint will still be available and supported.- See JSON Web Key Set (JWKS) for more information.
- Added Elliptic Curve signature support for JSON Web Tokens, ES256, ES384 and ES512.
- Added Typescript client library https://github.com/FusionAuth/fusionauth-typescript-client
- The Login Report may now be optionally filtered to a particular User in the UI, and the Login Report API will now take
loginIdoruserId.
Fixed#
- When using Docker compose, if you start up with
--pullto update to the latest version of FusionAuth and there happens to be a database schema update, the silent configuration mode may fail. This occurs because the silent configuration was not performing the database schema update automatically. If you encounter this issue, you will need to manually update the schema.- This will only occur if you are running a version of FusionAuth prior to
1.1.0and upgrade using--pullduringdocker compose up.
- This will only occur if you are running a version of FusionAuth prior to
- When you have multiple tenants created, a tenant may be deleted with an API key that is not assigned to the tenant. This has been corrected and a tenant may only be deleted using an API key that is not assigned to any tenant. This issue will only affect you if you have more than one tenant.
- Updated Maintenance Mode (setup wizard) to work with MySQL version 8.0.13 and above. MySQL has changed their SSL/TLS handling and our connections were not correctly handling public keys. This has been fixed by allowing FusionAuth to perform a secondary request to MySQL to fetch the public key.
- Logging in with a Social Login provider such as Google for an existing FusionAuth user may cause them to be unable to login to FusionAuth directly using their original credentials.
- When using the OpenID Connect Identity Provider, the incoming claim
given_namewas being saved in thefullNamefield instead of thefirstName. - When a user is soft deleted, actioned to prevent login, expired, or they have changed their password since their last login, their SSO session will be invalidated instead of waiting for the session to expire.
Internal#
- Upgrade to fusionauth-jwt 3.0.1 in support of Elliptic Curve crypto support.
Version 1.3.1 #
December 19th, 2018
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
Changed#
- API key will take precedence for API authentication if both a JWT and an API key are provided on the request. For example, when making a GET request to the User API, if a JWT is provided in a cookie, and a valid API key is also provided in the
AuthorizationHTTP header, the previous design was to prefer the JWT. This design point meant that even when an API key was provided, even when providing a valid API key, you would be unable to retrieve any user but the one represented by the JWT. - The
client_idis no longer required on the OAuth Token endpoint when client authentication is configured as required, in this scenario the client Id is provided in the HTTP Basic Authorization header.
Fixed#
- When editing the JWT settings in the FusionAuth application the UI a JavaScript error may cause some of the settings to not render properly. This error was introduced in version
1.3.0. - Added missing properties to the Application view dialog in the FusionAuth UI.
- The
openidscope may not be honored during login when a user has Two Factor authentication enabled. The symptom of this issue is that the response from the Token endpoint will not contain anid_tokeneven when theopenidscope was requested. - Validation for the OAuth2 Token endpoint may fail when the
client_idrequest body parameter is omitted and return a500instead of a400status code. - When a OAuth2 redirect URI is registered with a query parameter, the resulting redirect URI will not be built correctly.
- When trying to configure Elasticsearch engine during maintenance mode the index may get created but fail to leave maintenance mode. FusionAuth makes a
HEADrequest to Elasticsearch to check if the required indexes exist during startup and prior to leaving maintenance mode. When connected to an AWS Elasticsearch cluster this request does not behave as expected which causes FusionAuth to stay in maintenance mode. This issue has been resolved and should allow FusionAuth to properly connect to and utilize Elasticsearch running in an AWS cluster.
Version 1.3.0 #
December 5th, 2018
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
New#
- An Application may disable the issue of refresh tokens through configuration. See
oauthConfiguration.generateRefreshTokensin the Application API or theGenerate refresh tokenstoggle in the FusionAuth UI when editing an application. - The OAuth2 client secret may be optionally regenerated using the FusionAuth UI during Application edit.
- Support for OAuth2 confidential clients, this is supported by optionally requiring client authentication via configuration. See
oauthConfiguration.requireClientAuthenticationin the Application API or theRequire authenticationtoggle in the FusionAuth UI when editing an application.
Fixed#
- Calling the Introspect endpoint with a JWT returned from the Issue API may fail due to the missing
audclaim. - The MySQL schema previously was using
random_byteswhich is not available in MariaDB. These usages have been replaced with an equivalent that will function the same in MySQL and MariaDB.- Thanks to @anbraten for bringing this to our attention and suggesting and verifying a solution via GitHub Issue #48 : Support for MariaDB
- When editing or adding a new user in the FusionAuth UI, the
Birthdatefield may get set automatically before the date selector is utilized. A JavaScript error was causing this condition and it has been fixed.
Version 1.2.2 #
November 27th, 2018
Fixed#
- Add
X-FusionAuth-TenantIdto allowed CORS headers. - When FusionAuth is running behind a proxy such as an AWS ALB / ELB the redirect URI required to complete login may not be resolved correctly. This may cause the redirect back to the FusionAuth UI login to fail with a CSRF exception. If you encounter this issue you may see an error message that says
Something doesn't seem right. You have been logged out of FusionAuth. The work-around for this issue if you encounter it will be to perform the redirect from HTTP to HTTPS in your load balancer. - Some minor usability issues in the Identity Provider configuration UI.
Version 1.2.1 #
November 16th, 2018
Enhancement#
- Better error handling when an API caller sends invalid JSON messages. Prior to this enhancement if FusionAuth did not provide a specific error message for a particular field a
500HTTP status code was returned if the JSON could not be parsed properly. This enhancement will ensure that sending a FusionAuth API invalid JSON will consistently result in a400status code with a JSON body describing the error. - Allow an Identity Provider to be enabled and disabled from the UI. You may still choose to enable or disable a specific Application for use with an Identity Provider, but with this enhancement you may not turn off an Identity Provider for all Applications with one switch.
Fixed#
- Preserve Application Identity Provider configuration for disabled Applications when editing a Identity Provider from the UI.
Version 1.2.0 #
November 15th, 2018
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
New#
- Add TTL configuration for Refresh Tokens to the Application configuration. When you enable JWT configuration per Application this value will override the global setting.
Fixed#
- An error in the Twitter OAuth v1 workflow has been resolved.
Version 1.1.1 #
November 13th, 2018
Fixed#
- If you were to have an Identity Provider for federated third party JSON Web Tokens configured prior to upgrading to
1.1.0FusionAuth may fail during the database migration to version1.1.0.
Version 1.1.0 #
November 13th, 2018
This update changes the database schema. Production runtime mode runs this upgrade during startup. For more information about database migrations, see Database Upgrades.
New#
- Social login support
- Facebook Identity Provider
- Google Identity Provider
- Twitter Identity Provider
- OpenID Connect Identity Provider
- Full theme support for login. See the Login Theme tutorial for additional information and examples.
- Better localization support in the FusionAuth UI. You now have the option to set or modify your preferred language for use in the FusionAuth UI.
Providing a preferred language will cause dates to be formatted based upon your preference. For example, the default data format is
M/D/YYYY, but if you are not in the United States this may not be the way you expect a date to be formatted. If you set your locale toFrenchyou will now see a more appropriate format ofD/M/YYYY. This value is stored on the User Registration for FusionAuth in thepreferredLanguagesfield.
Enhancement#
- When viewing sessions (refresh tokens) on the Manage User panel, the start and expiration times will be displayed.
Version 1.0.18 #
October 29th, 2018
Fixed#
- If FusionAuth starts up in maintenance mode and stays there for an extended period of time without the User completing the configuration from the web browser, FusionAuth may get stuck in maintenance mode. If you encounter this issue, where you seemingly are entering the correct credentials on the Database configuration page and are unable to continue, restart FusionAuth and the issue will be resolved.
Version 1.0.17 #
October 5th, 2018
Fixed#
- When running in Docker Compose, FusionAuth cannot connect to the search service when trying to exit the setup wizard.
Version 1.0.16 #
October 5th, 2018
Enhancement#
- Better support for running in Docker. Enhanced silent configuration capability for database and search engine boot strap configuration in Docker Compose to be more resilient.
Fixed#
- If custom data is added to an Application, Group or Tenant before editing the corresponding object in the UI, the custom data may be lost.
Version 1.0.15 #
October 1st, 2018
New#
- Better support for running in Docker. Configuration can be override using environment variables. See Docker Install for additional information.
Fixed#
- The first time a user reached the failed login threshold and a
409response code was returned the response body was empty. Subsequent login requests correctly returned the JSON response body with the409, now the JSON response body is correctly returned the first time the user reaches the failed login threshold.
Version 1.0.14 #
September 17th, 2018
Fixed#
- When using PostgreSQL an exception may occur during an internal cache reload request. If you encounter this issue you will see a stack trace in the
fusionauth-app.log. If you see this error and need assistance, please open an issue in the FusionAuth Issues GitHub project.
Unexpected error. We're missing an internal API key to notify distributed caches.Version 1.0.13 #
September 12th, 2018
New#
- General availability release