mirror of
https://github.com/house-of-abbey/GarminHomeAssistant.git
synced 2026-03-13 01:06:44 +00:00
79ede44ea1
Added new example for two user supplied HTTP headers, subject to checking by the author of the issue. (Missed off the previous commit this this file.)
41 lines
2.4 KiB
Markdown
41 lines
2.4 KiB
Markdown
[Home](README.md) | [Switches](examples/Switches.md) | [Actions](examples/Actions.md) | [Templates](examples/Templates.md) | [Numeric](examples/Numeric.md) | [Glance](examples/Glance.md) | [Background Service](BackgroundService.md) | [Wi-Fi](Wi-Fi.md) | [HTTP Headers](HTTP_Headers.md) | [Trouble Shooting](TroubleShooting.md) | [Version History](HISTORY.md)
|
|
|
|
# User Specified Custom HTTP Headers
|
|
|
|
Principally for those who use HomeAssistant add-on [Cloudflared](https://github.com/brenner-tobias/addon-cloudflared) in order to provide additional security via Cloudflare's Web Application Firewall (WAF). But Garmin does not support certificates in requests. And the solution is generic enough for other use cases.
|
|
|
|
Please let us know if this solution is found to be useful for other situations.
|
|
|
|
## Setup
|
|
|
|
The settings contain two options for users to specify both the HTTP header name and the value as two free form strings.
|
|
|
|
<img src="images/http_header_settings.png" width="400" title="Application Settings"/>
|
|
|
|
If you don't know why you need these, leave them empty and ignore.
|
|
|
|
### Cloudflare WAF rule example
|
|
|
|
`(any(http.request.headers["your-header-name"][*] eq "your-header-key"))`
|
|
|
|
Make the key strong enough!
|
|
|
|
### Cloudflare WAF IP Access example
|
|
|
|
In order to safely allow API access, both a `cf-access-client-id` and `cf-access-client-secret` HTTP headers must be present. Essentially a username and password pair. Please note that the settings do not attempt to hide your password value with '*' characters, it should be private enough on your personal phone Connect IQ app.
|
|
|
|
## Support
|
|
|
|
**None!**
|
|
|
|
The authors of the Garmin HomeAssistant application do not use, and hence do not know, the [Cloudflared](https://github.com/brenner-tobias/addon-cloudflared) add-on. While we have enabled the HTTP headers to support using this add-on, it does mean _you support yourself_. Please do not raise issues about this functionality unless you are supplying the answers for any required changes too!
|
|
|
|
## Credits
|
|
|
|
With thanks to Lars Pöpperl ([@tispokes](https://github.com/tispokes)) for contributing to this solution.
|
|
|
|
## References
|
|
|
|
* [Using Cloudflare ZeroTrust and mTLS to securely access HomeAssistant via the internet](https://kcore.org/2024/06/28/using-cloudflare-zerotrust-and-mtls-with-home-assistant-via-the-internet/)
|
|
* [HomeAssistant Add-on: Cloudflared](https://github.com/brenner-tobias/addon-cloudflared)
|