Git Product home page Git Product logo

ban_allowlist's Introduction

Home Assistant IP Ban Allowlist plugin

Status: GIANT HACK, USE AT YOUR OWN RISK

Home Assistant has a very useful IP banning feature which is nice for when you've got a private but externally facing instance that you'd like to reduce the odds on getting hacked.

However, it's got one little missing feature: IP allowlists. Without this, sometimes you get the problem that your home IP gets banned (because you've got something internal to your house using the external naming), which is a bit frustrating. The position of the core devs appears to be "this is a bug with something else that we shouldn't workaround", but meanwhile we're stuck with the banning happening every so often.

This integration (well, kinda) fixes this, but does so in the hackiest way possible, by reaching into the HTTP handler code and adding a wrapper around the banning code.

This does have a decent unit test suite, and is explicitly integration tested against every latest patch version of HA from 2023.8.4 up (i.e. for every x.y.z version, we test all values of x.y using the latest z value), but it's also doing something hacky enough that no guarantees are given. YMMV!

Config

To use this, install with HACS as a custom repository.

Then add to your configuration.yaml something like the following:

ban_allowlist:
  ip_addresses: ["my.ip.address", "another.ip.address"]

ban_allowlist's People

Contributors

palfrey avatar

Watchers

 avatar  avatar

ban_allowlist's Issues

Error during setup of component ban_allowlist

Hello,
Thank you for your project, but impossible to add it on my HA ... :/
Can you please help ?

PS : Possible to add IP range feature ?

Error during setup of component ban_allowlist
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/setup.py", line 404, in _async_setup_component
    result = await task
             ^^^^^^^^^^
  File "/config/custom_components/ban_allowlist/__init__.py", line 33, in async_setup
    ban_manager: IpBanManager = hass.http.app[KEY_BAN_MANAGER]
                                ~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/aiohttp/web_app.py", line 194, in __getitem__
    return self._state[key]
           ~~~~~~~~~~~^^^^^
KeyError: <AppKey(homeassistant.components.http.ban.ha_banned_ips_manager, type=ForwardRef('IpBanManager'))>

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.