Releases: christiaangoossens/hass-oidc-auth
Release list
v1.2.1
Fixes CSS issue in v1.2.0 on update (#402)
v1.2.0 changes
Minor release with some fixes (security & mobile login getting stuck) and a refreshed UI to match the Home Assistant login UI. Please update to this release as soon as possible.
What's Changed
- docs: fix typo in FAQ by @SSDWGG in #353
- ui: align login look and feel with Home Assistant authorize page (Tailwind) by @edmogeor in #357
- Fix device-code login getting stuck when the SSE connection drops by @kiegsgroot in #369
- Fix open redirect on the /auth/welcome path by @christiaangoossens in #400 (GHSA-gg9c-6c2r-6x28, reported by @stjohnb)
New Contributors
- @SSDWGG made their first contribution in #353
- @edmogeor made their first contribution in #357
- @kiegsgroot made their first contribution in #369
- @stjohnb made their first contribution in GHSA-gg9c-6c2r-6x28
Full Changelog: v1.1.1...v1.2.1
v1.2.0
Minor release with some fixes (security & mobile login getting stuck) and a refreshed UI to match the Home Assistant login UI. Please update to this release as soon as possible.
What's Changed
- docs: fix typo in FAQ by @SSDWGG in #353
- ui: align login look and feel with Home Assistant authorize page (Tailwind) by @edmogeor in #357
- Fix device-code login getting stuck when the SSE connection drops by @kiegsgroot in #369
- Fix open redirect on the /auth/welcome path by @christiaangoossens in #400 (GHSA-gg9c-6c2r-6x28, reported by @stjohnb)
New Contributors
- @SSDWGG made their first contribution in #353
- @edmogeor made their first contribution in #357
- @kiegsgroot made their first contribution in #369
- @stjohnb made their first contribution in GHSA-gg9c-6c2r-6x28
Full Changelog: v1.1.1...v1.2.0
v1.1.1
Minor update to fix issues found in v1.1.0.
The README has also been updated to clarify that this integration is RP/client only and does not implement an OIDC provider within Home Assistant. Thank you @davux for requesting this clarification.
Fixes
- Login with Home Assistant to external apps using the OAuth2 integration now works again, such as for Music Assistant or EVCC (#318)
- Login with 'alternative method' in the mobile app now works again (#338)
- Removed the incorrect 'you have already signed in' blue box upon login
- Resolved possible issue with argument order when setting up the auth page (#334)
What's Changed
- Fix UX issues with external OAuth2 apps by @christiaangoossens in #328
- Increment JS counter by @christiaangoossens in #329
- Clarify RP-only implementation by @christiaangoossens in #330
- Update dependency joserfc to ~=1.7.0 in #335
- Fix possible extra argument injection by @christiaangoossens in #342
Full Changelog: v1.1.0...v1.1.1
v1.1.0
What has changed?
- You can now use the built-in trusted networks auth provider alongside OIDC. It will be automatically detected without any further configuration.
- See #283 for more details.
- The order of configuration of the auth providers matters, just as described in the HA docs.
- Fixes an issue where the redirect URI would be HTTP instead of HTTPS if force_https was on
- Fixes an issue where the auth page injection would not always work
- Fixes the broken 'back' button on the normal HA login screen
Full changelog
- Add Keycloak configuration guide and refine setup instructions by @NiklasUni in #291
- Implement trusted_networks support by @christiaangoossens in #283
- Do not reveal existance of trusted networks provider by @christiaangoossens in #302
- Use HTTP proxy for connecting to auth server if configured via env by @amarshall in #299
- Redirect native-picker click on OIDC provider to /auth/oidc/welcome (fix dead-end) by @mexican75 in #266
- Respect force https on the initial redirect URI by @christiaangoossens in #303
- Release/1.1.0 (and fix #309) by @christiaangoossens in #313
New Contributors
- @NiklasUni made their first contribution in #291
- @amarshall made their first contribution in #299
- @mexican75 made their first contribution in #266
Full Changelog: v1.0.2...v1.1.0
v1.0.2
It's major release time! 🎉 ✨
It's time to declare this integration stable, as it has been tested in many setups over the last two years and has reached a feature state I am happy with.
Starting with v1.0.0, you will no longer have to manually visit /auth/oidc/welcome or /auth/oidc/redirect, as the UI now automatically takes care of the OIDC integration. You can replace any manual links to the welcome page with direct links to your Home Assistant base URL.
New users can also configure the integration fully from the UI, if you are running Authelia, Authentik or Pocket ID. The guides have been updated with all new instructions to reflect this change.
Power users, and those who wish to do so or need the feature flags, can use YAML. YAML will remain supported for this integration besides the UI config indefinitely, but you can only use one or the other, not both at the same time.
Warning
Please note that you might need to change your config and/or setup to update to v1.
Take special care if:
- you were running pre-releases (v0.7-rc*). If so, you might need to update your YAML configuration as the
features.disable_frontend_injectionflag was removed. - you have some sort of non-standard code or proxy setup on top of this integration. You might need to remove it to use the new automatic redirect.
Most users should not experience any issues. If you have a standard YAML config with no features enabled, you do not need to change anything.
If you are experiencing issues, please check the new Frequently Asked Questions first!
What's Changed
- Integration can now be configured either using YAML (all options/full config) or the Home Assistant interface (limited config) thanks to @dbaines
- Automatic redirect from the HA login screen to OIDC (#19)
- If you have disabled Home Assistant default login, it will automatically redirect to the SSO provider
- You can still use the /auth/oidc/welcome and /auth/oidc/redirect paths, but it is no longer necessary to do so.
- Added automatic security testing (pysentry-rs), thanks to @nyudenkov
- Added docs for Zitadel, thanks to @vslee
- Many automated integration and unit tests have been added, almost entirely covering the code.
- v1.0.1: Added a new feature flag for
default_redirect: you can now skip the welcome screen and automatically redirect all the way to your SSO provider. This feature is also automatically enabled if you disable the default Home Assistant username/password login. - v1.0.2: Fix type casting error by @christiaangoossens in #278
If you would like to contribute to this project, see https://github.com/christiaangoossens/hass-oidc-auth/blob/main/CONTRIBUTING.md for more info. You can also donate through https://github.com/sponsors/christiaangoossens.
Full Changelog: v1.0.1...v1.0.2
v1.0.1
It's major release time! 🎉 ✨
It's time to declare this integration stable, as it has been tested in many setups over the last two years and has reached a feature state I am happy with.
Starting with v1.0.0, you will no longer have to manually visit /auth/oidc/welcome or /auth/oidc/redirect, as the UI now automatically takes care of the OIDC integration. You can replace any manual links to the welcome page with direct links to your Home Assistant base URL.
New users can also configure the integration fully from the UI, if you are running Authelia, Authentik or Pocket ID. The guides have been updated with all new instructions to reflect this change.
Power users, and those who wish to do so or need the feature flags, can use YAML. YAML will remain supported for this integration besides the UI config indefinitely, but you can only use one or the other, not both at the same time.
Warning
Please note that you might need to change your config and/or setup to update to v1.
Take special care if:
- you were running pre-releases (v0.7-rc*). If so, you might need to update your YAML configuration as the
features.disable_frontend_injectionflag was removed. - you have some sort of non-standard code or proxy setup on top of this integration. You might need to remove it to use the new automatic redirect.
Most users should not experience any issues. If you have a standard YAML config with no features enabled, you do not need to change anything.
If you are experiencing issues, please check the new Frequently Asked Questions first!
What's Changed
- Integration can now be configured either using YAML (all options/full config) or the Home Assistant interface (limited config) thanks to @dbaines
- Automatic redirect from the HA login screen to OIDC (#19)
- If you have disabled Home Assistant default login, it will automatically redirect to the SSO provider
- You can still use the /auth/oidc/welcome and /auth/oidc/redirect paths, but it is no longer necessary to do so.
- Added automatic security testing (pysentry-rs), thanks to @nyudenkov
- Added docs for Zitadel, thanks to @vslee
- Many automated integration and unit tests have been added, almost entirely covering the code.
- Added a new feature flag for
default_redirect: you can now skip the welcome screen and automatically redirect all the way to your SSO provider. This feature is also automatically enabled if you disable the default Home Assistant username/password login.
New Contributors
- Special thanks to those that contributed to the UI injection attempts (in #19): @jtdroste @jthoward64 @jasoncodes (as well as @Lachee and @emanuelbesliu for updating it when HA broke it through updates)
- @dbaines made their first contribution in #123
- @nyudenkov made their first contribution in #208
- @vslee made their first contribution in #221
- All testers of the pre-releases, with a special mention to @tomfrenzel and @adriansalamon for testing the iOS app thoroughly.
If you would also like to contribute to this project, see https://github.com/christiaangoossens/hass-oidc-auth/blob/main/CONTRIBUTING.md for more info. You can also donate through https://github.com/sponsors/christiaangoossens.
Full Changelog: v0.6.5-alpha...v1.0.1
v1.0.0-rc3
Caution
This pre-release is replaced by https://github.com/christiaangoossens/hass-oidc-auth/releases/tag/v1.0.1.
Warning
This is the first pre-release with the new build system. You should now use the zip file (hass-oidc-auth.zip) within this release if you don't want to use HACS, instead of directly using the source code zip.
If you use HACS, please click "Update information" in the dropdown menu first before downloading, otherwise you will get no styling. See #268 (comment) for more information.
It's major release time (soon)! 🎉 ✨
Starting with v1.0.0 you no longer have to manually visit /auth/oidc/welcome or /auth/oidc/redirect, as the UI now automatically takes care of the OIDC integration. You may remove manual links, although they should still work.
New users can also configure the integration fully from the UI, if you are running Authelia, Authentik or Pocket ID. Power users, and those who wish to do so or need the feature flags, can use YAML. YAML will remain supported for this integration besides the UI config.
Warning
Please note that you might need to change your config and/or setup to update to v1.
Take special care if:
- you were running pre-releases (with the new UI). If so, you might need to update your YAML configuration as the
features.disable_frontend_injectionflag was removed. - you have some sort of non-standard code or proxy setup on top of this integration. You might need to remove it to use the new automatic redirect.
If you have a standard YAML config with no features enabled, you do not need to change anything.
What's Changed
- Integration can now be configured either using YAML (all options/full config) or the Home Assistant interface (limited config) thanks to @dbaines
- Automatic redirect from the HA login screen to OIDC (#19)
- If you have disabled Home Assistant default login, it will automatically redirect to the SSO provider
- You can still use the /auth/oidc/welcome and /auth/oidc/redirect paths, but it is no longer necessary to do so.
- Added automatic security testing (pysentry-rs), thanks to @nyudenkov
- Added docs for Zitadel, thanks to @vslee
- Many automated integration and unit tests have been added, almost entirely covering the code.
- Fixes for known issues with rc1 (#241)
- Fixes regression of the ?storeToken parameter (#248)
New Contributors
- Special thanks to those that contributed to the UI injection attempts (in #19): @jtdroste @jthoward64 @jasoncodes (as well as @Lachee and @emanuelbesliu for updating it when HA broke it through updates)
- @dbaines made their first contribution in #123
- @nyudenkov made their first contribution in #208
- @vslee made their first contribution in #221
If you would also like to contribute to this project, see https://github.com/christiaangoossens/hass-oidc-auth/blob/main/CONTRIBUTING.md for more info. You can also donate through https://github.com/sponsors/christiaangoossens.
Full Changelog: v0.6.5-alpha...v1.0.0-rc3
v1.0.0-rc2
Caution
This pre-release is replaced by https://github.com/christiaangoossens/hass-oidc-auth/releases/tag/v1.0.1.
It's major release time (soon)! 🎉 ✨
Starting with v1.0.0 you no longer have to manually visit /auth/oidc/welcome or /auth/oidc/redirect, as the UI now automatically takes care of the OIDC integration. You may remove manual links, although they should still work.
New users can also configure the integration fully from the UI, if you are running Authelia, Authentik or Pocket ID. Power users, and those who wish to do so or need the feature flags, can use YAML. YAML will remain supported for this integration besides the UI config.
Warning
Please note that you might need to change your config and/or setup to update to v1.
Take special care if:
- you were running pre-releases (with the new UI). If so, you might need to update your YAML configuration as the
features.disable_frontend_injectionflag was removed. - you have some sort of non-standard code or proxy setup on top of this integration. You might need to remove it to use the new automatic redirect.
If you have a standard YAML config with no features enabled, you do not need to change anything.
What's Changed
- Integration can now be configured either using YAML (all options/full config) or the Home Assistant interface (limited config) thanks to @dbaines
- Automatic redirect from the HA login screen to OIDC (#19)
- If you have disabled Home Assistant default login, it will automatically redirect to the SSO provider
- You can still use the /auth/oidc/welcome and /auth/oidc/redirect paths, but it is no longer necessary to do so.
- Added automatic security testing (pysentry-rs), thanks to @nyudenkov
- Added docs for Zitadel, thanks to @vslee
- Many automated integration and unit tests have been added, almost entirely covering the code.
- Fixes for known issues with rc1 (#241)
New Contributors
- Special thanks to those that contributed to the UI injection attempts (in #19): @jtdroste @jthoward64 @jasoncodes (as well as @Lachee and @emanuelbesliu for updating it when HA broke it through updates)
- @dbaines made their first contribution in #123
- @nyudenkov made their first contribution in #208
- @vslee made their first contribution in #221
If you would also like to contribute to this project, see https://github.com/christiaangoossens/hass-oidc-auth/blob/main/CONTRIBUTING.md for more info. You can also donate through https://github.com/sponsors/christiaangoossens.
Full Changelog: v0.6.5-alpha...v1.0.0-rc2
v1.0.0-rc1
Caution
This pre-release is replaced by https://github.com/christiaangoossens/hass-oidc-auth/releases/tag/v1.0.1.
It's major release time (soon)! 🎉 ✨
Starting with v1.0.0 you no longer have to manually visit /auth/oidc/welcome or /auth/oidc/redirect, as the UI now automatically takes care of the OIDC integration. You may remove manual links, although they should still work.
New users can also configure the integration fully from the UI, if you are running Authelia, Authentik or Pocket ID. Power users, and those who wish to do so or need the feature flags, can use YAML. YAML will remain supported for this integration besides the UI config.
Warning
Please note that you might need to change your config and/or setup to update to v1.
Take special care if:
- you were running pre-releases (with the new UI). If so, you might need to update your YAML configuration as the
features.disable_frontend_injectionflag was removed. - you have some sort of non-standard code or proxy setup on top of this integration. You might need to remove it to use the new automatic redirect.
If you have a standard YAML config with no features enabled, you do not need to change anything.
Tip
If you are presented with a login aborted error after updating, please refresh your browser cache for the web page or your cache data for the Android/iOS app. After clearing the cache, the issue should be fixed.
What's Changed
- Integration can now be configured either using YAML (all options/full config) or the Home Assistant interface (limited config) thanks to @dbaines
- Automatic redirect from the HA login screen to OIDC (#19)
- If you have disabled Home Assistant default login, it will automatically redirect to the SSO provider
- You can still use the /auth/oidc/welcome and /auth/oidc/redirect paths, but it is no longer necessary to do so.
- Added automatic security testing (pysentry-rs), thanks to @nyudenkov
- Added docs for Zitadel, thanks to @vslee
- Many automated integration and unit tests have been added, almost entirely covering the code.
New Contributors
- Special thanks to those that contributed to the UI injection attempts (in #19): @jtdroste @jthoward64 @jasoncodes (as well as @Lachee and @emanuelbesliu for updating it when HA broke it through updates)
- @dbaines made their first contribution in #123
- @nyudenkov made their first contribution in #208
- @vslee made their first contribution in #221
If you would also like to contribute to this project, see https://github.com/christiaangoossens/hass-oidc-auth/blob/main/CONTRIBUTING.md for more info. You can also donate through https://github.com/sponsors/christiaangoossens.
Full Changelog: v0.6.5-alpha...v1.0.0-rc1
v0.6.5-alpha
Alpha release, use at your own risk.
Maintenance update. Fixes potential XSS vulnerability and updates packages.
What's Changed
- Use tailwind cli to compile css instead of tailwind cdn by @Tricked-dev in #132
- Migrate to joserfc, remove python-jose by @christiaangoossens in #150
- Fix manifest json requirements by @christiaangoossens in #152
- Enable Jinja2 autoescaping by @werdnum in #200
- Fix 500 on redirect path by @christiaangoossens and @anntnzrb in #201
New Contributors
- @Tricked-dev made their first contribution in #132
- @werdnum made their first contribution in #200
- @anntnzrb made their first contribution in #201 and #170
Full Changelog: v0.6.3-alpha...v0.6.5-alpha