Expose the active Home Assistant user to the addon through ingress

TheSeal · August 22, 2020, 7:04pm

I’m trying to create an addon (ingress only) for a multi-user application which can handle authentication with the request headers. It would be very useful if Home Assistant through ingress could tell the application about the user in the headers (X-Hass-User-ID?).

Think other addons that can be used by multiple users could benefit from this as well, like Grafana:

github.com

hassio-addons/addon-grafana/blob/5566447a54a7606b2e5ddfd1f11d84fa82a2690d/grafana/rootfs/etc/nginx/servers/ingress.conf#L10


server {
    listen %%interface%%:1337 default_server;

    include /etc/nginx/includes/server_params.conf;
    include /etc/nginx/includes/proxy_params.conf;

    location / {
        allow   172.30.32.2;
        deny    all;
        proxy_set_header X-WEBAUTH-USER %%grafana_user%%;
        proxy_pass http://backend;
    }
}

baflo · February 12, 2023, 3:14pm

Any updates on this?

TheSeal · February 15, 2023, 7:18pm

I haven’t heard anything and I don’t think it has been added.

LelouBil · September 5, 2024, 10:38pm

I don’t know why this doesn’t have more visibility. It would be great news for addons that package multi-user apps that currently have a second login inside the ingress.

LelouBil · September 5, 2024, 11:11pm

It is done !!!

github.com/home-assistant/supervisor

Allows the supervisor to send a session's user to addon with header X-Remote-User (#4152)

committed 08:11AM - 22 Aug 23 UTC

baflo

+224 -12

* Working draft for x-remote-user * Renames prop to remote_user * Allows t…o set in addon description whether it requests the username * Fixes addon-options schema * Sends user ID instead of username to addons * Adds tests * Removes configurability of remote-user forwarding * Update const.py * Also adds username header * Fetches full user info object from homeassistant * Cleaner validation and dataclasses * Fixes linting * Fixes linting * Tries to fix test * Updates tests * Updates tests * Updates tests * Updates tests * Updates tests * Updates tests * Updates tests * Updates tests * Resolves PR comments * Linting * Fixes tests * Update const.py * Removes header keys if not required * Moves ignoring user ID headers if no session_data is given * simplify * fix lint with new job --------- Co-authored-by: Pascal Vizeli <[email protected]> Co-authored-by: Pascal Vizeli <[email protected]>

Documentation here :

TheSeal · September 7, 2024, 6:00pm

That is great news! My add on is abandoned upstream so I won’t implement this but for future development this is awesome.