Release notes

Release 4.1.1, September 4th, 2024

Fix

This is a hotfix release where we fixed the manual update scripts for updating the user databases to v4.1.x and higher. The scripts were not working correctly in the previous release.

Release 4.1.0, August 1st, 2024

Feature

With this release, it is possible to let users log in via the Single Sign-On using external providers flow without them needing a user account in Firely Auth first. Upon logging in, these users will be automatically created via auto-provisioning and stored in the Firely Auth user database.
It is now possible to add and edit client settings via the user interface. Before, these settings could only be changed by altering the appsettings. Note that because of this change, Firely Auth will load clients from the appsettings only once. After this initial load client settings need to be removed from the appsettings, or they will block start up of Firely Auth.
We have made several improvements to the UI for a better user experience.

Configuration

Added Lockout options to customize the lockout period and max amount of failed lock-in requests.
It is now possible to add custom disclaimer templates that will be visible when the user tries to retrieve an access token. For more information, see Disclaimer Registration.

Fix

Allow a missing trailing “/” when comparing the FHIR Server base url against the aud parameter when requesting a token.

Database

Attention

Starting with Firely Auth 4.1.0, every user account needs to contain a fhirUser claim in login. Users will be blocked from receiving an access token if the claim is not present.

This release comes with an upgrade in the database structure to support the user auto-provisioning feature mentioned above. Any necessary database migrations will be automatically performed by Firely Auth upon start up.

Release 4.0.0, June 24th, 2024

Attention

The current release of Firely Auth, version 4.0, features new API capabilities, a redesigned user interface, and enhanced SMART on FHIR capabilities. With this release, Firely is deprecating support for any previous version of Firely Auth. It is recommended that all customers upgrade to the latest version.

Note

Support for .NET 6 ends in November 2024. See .NET Support Policy. This version of Firely Auth supports .NET 8. So, we recommend that you upgrade to Firely Auth 4.0.0 and hence .NET 8 before November 2024.

Feature

(Important) Firely Auth has been upgraded to .NET 8. Please update the .NET runtime accordingly if installing Firely Auth using binaries. The Docker image has been updated for you.
The homepage of Firely Auth provides a logged-in admin user the possibility to visualize the local .well-known/openid-configuration document incl. an overview of exposed endpoints and requestable SMART / OpenID scopes.
The homepage of Firely Auth provides a logged-in admin user the possibility to view statistics about registered clients and users.
Implemented an overview of all registered client applications for logged-in admin users which can be filtered based on different criteria.
The management CLI for Firely Auth has been removed. As an alternative, all functionality has been moved to a management API. See Firely Auth User Management for more details.
The user management for Firely Auth has been redesigned. In-Memory users are no longer available. As an alternative Firely Auth now provides, by default, a SQLite database as an administration backend. Please migrate all In-Memory users manually either through the UI or management API. See Sqlite user store for more details.
Implemented an overview of all registered users (local and SSO) for logged-in admin users.

Configuration

Added the possibility to provide custom email templates for the account verification of local users.
Added the possibility to customize the logo and text on the welcome page of Firely Auth.

Release 3.3.1, April 22nd, 2024

Fix

Fixed an issue were Firely Auth running in docker was unable to connect to a SQL server user store.

Release 3.3.0, March 20th, 2024

Security

Disabling 2FA authentication for a client will now require a 2FA token from the user as an additional security step
Added ‘Require2fa’ to the default appsettings. This replaces the current ‘RequireMfa’ setting.

Feature

Firely Auth will now warn about invalid key/value pairs submitted to the launchContext API
Values in the form of ‘<resourceType>/<id>’ submitted to the launchContext API will now be automatically translate to id-only values

Release 3.3.0-rc3, February 1st, 2024

Configuration

EnableLegacyFhirContext is added to switch the syntax of fhirContext between SoF v2.1 and v2.0. See Firely Auth Settings for details.
ClientClaims and ClientClaimPrefix are added to help a client to define custom claims in the client credential flow. See Firely Auth Settings for details.

Feature

Harmonized Serilog sinks with Firely Server. See Changing the sink for details of all supported sinks.
Enabled clients to add static custom claims in the client credential flow. See Firely Auth Settings for details.

Fix

Fixed the EHR launch context in case of a user login via an external identity provider.
Improved the validation of setting AllowedResourceTypes. Any invalid FHIR resource types will be rejected now.
Improved the validation of setting AllowFirelySpecialScopes. Firely special scopes can now only be requested if an registered client has the setting set to true.
In case of the EHR launch, no System.ArgumentException is thrown if both launch and launch/patient scopes are present in the request for the access token.

Release 3.3.0-rc2, November 23nd, 2023

Feature

You can restrict a client to specific FHIR resource types, using the setting AllowedResourceTypes in the Clients. If the client requests SMART scopes for other resource types, the request will be denied.

Release 3.2.0, June 20th, 2023

Configuration

Attention

To make it easier to understand, some configuration sections are renamed or reorganized. Please check the bullets below for a summary of changes. For the details, please check page Firely Auth Settings.

Section KeyManagementConfig is renamed to KeyManagement.
Section FhirServerConfig is renamed to FhirServer.
Section ClientRegistrationConfig is renamed to ClientRegistration.
Section TokenConfig is removed, the AccessTokenType for each client is moved to the registration of the specific client.
Section TokenIntrospectionConfig is removed, the secret of a token introspection end point can be configured using setting IntrospectionSecret within section FhirServer.
For registering a specific client, the LaunchIds setting is removed. A dynamic Smart on Fhir launch context can be requested via the LaunchContext endpoint. See LaunchContext endpoint for details about how to request launch context dynamically.

Feature

Users now can change their own passwords after login.
A user account will be blocked temporarily after 5 unsuccessful authentication attempts and it will be unblocked in 5 minutes.
Added a setting KeySize to adjust the RSA key size generated by Firely Auth. By default, it is set to 2048.
Added a setting PasswordHashIterations to adjust the password hashing iterations in case of different security considerations. By default it is set to 600000. See User store for more details.
Introduced LaunchContext endpoint for requesting Smart on Fhir launch context dynamically. See LaunchContext endpoint for more details.
Added security attributes to session cookies.

Fix

Disabled Client Initiated Backchannel Authentication (CIBA).

Attention

The aud used in an access token is updated to the FHIR_BASE_URL instead of the name of FHIR server.

Release 3.1.0, March 9th, 2023

Feature

Added a setting to configure CORS support for only a limited set of origins. See AllowedOrigins for more details.

Release 3.0.0, December 2022

This is the first public release of Firely Auth, providing support for SMART on FHIR v1 and v2 and a SQL Server user store.