home-assistant.io/providers.markdown at c1a0c4e87e0c67d986282f19d67c2cb9ddbfcf8c

mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-04-27 14:57:35 +00:00

Paulus Schoutsen 7b3961d127 Merge branch 'rc' into current

2018-08-29 12:13:23 +02:00

3.2 KiB

Raw Blame History

layout	title	description	date	redirect_from	sidebar	comments	sharing	footer
page	Authentication Providers	Guide on configuring different auth providers.	2018-08-23 09:40	/components/auth/	true	false	true	true

This page only apply to release 0.77 and above.

This is an advanced feature. If misconfigured, you will not be able to access Home Assistant anymore!

When a user logs in, it needs to authenticate against an auth provider. An auth provider will check the users' credentials, and if credentials are linked to a user in the system, allows the user to log in.

By default, Home Assistant has enabled an auth provider that stores the users in the configuration directory. An owner account can manage these users from the frontend.

To make the transition from API password to authentication system easier, we've added a legacy API password auth provider. This enables users to log in with the API password. This authentication provider is enabled by default if a user has an API password configured.

{% linkable_title Configuring auth providers %}

By configuring your own instead of using the default configuration, you take full responsibility for the authentication of the system.

Authentication providers are configured in your configuration.yaml under the homeassistant: block:

homeassistant:
  auth_providers:
   - type: homeassistant
   - type: legacy_api_password

{% linkable_title Available auth providers %}

Below is a list of currently available auth providers.

{% linkable_title Home Assistant auth provider %}

This is the default auth provider which stores the users in your configuration directory. All passwords are stored hashed and with a salt, making it almost impossible for an attacker to figure out the password from the storage.

Users for this auth provider can be managed via the UI by the owner. Navigate to the configuration panel and click on users.

homeassistant:
  auth_providers:
   - type: homeassistant

{% linkable_title Trusted Networks %}

With the trusted networks auth provider you can whitelist an IP range for which no authentication will be required. The user will be prompted to pick a user to log in as.

The [multi-factor autentication module](../multi-factor-auth) will not participate in login process by using this auth provider.

homeassistant:
  auth_providers:
   - type: trusted_networks

# Temporary, this will be moved to be part of auth provider config
# https://github.com/home-assistant/home-assistant/issues/16149
http:
  trusted_networks:
    - 127.0.0.1
    - ::1
    - 192.168.0.0/24
    - fd00::/8

{% linkable_title Legacy API password %}

Activating this auth provider will allow you to authenticate with the API password set in the HTTP component.

homeassistant:
  auth_providers:
   - type: legacy_api_password

http:
  api_password: !secret http_password

Activating this auth provider will also allow you to provide the API password using an authentication header to make requests against the Home Assistant API. This feature will be dropped in the future in favor of long-lived access tokens.

3.2 KiB Raw Blame History