├── .github ├── demo.gif └── dependabot.yml ├── .gitignore ├── .isort.cfg ├── .vscode └── tasks.json ├── LICENSE ├── Makefile ├── README.md ├── custom_components └── auth_header │ ├── __init__.py │ ├── headers.py │ ├── manifest.json │ └── store-token.js ├── hacs.json ├── poetry.lock ├── pyproject.toml └── scripts ├── authentik-blueprint.yaml ├── docker-compose.yml └── fixed_config └── configuration.yaml /.github/demo.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BeryJu/hass-auth-header/29bbab11c22b946d587b2bdd8307ea6c5e8b7d37/.github/demo.gif -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: pip 4 | directory: "/" 5 | schedule: 6 | interval: daily 7 | time: "04:00" 8 | open-pull-requests-limit: 10 9 | assignees: 10 | - BeryJu 11 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.gitignore.io/api/python 3 | # Edit at https://www.gitignore.io/?templates=python 4 | 5 | ### Python ### 6 | # Byte-compiled / optimized / DLL files 7 | __pycache__/ 8 | *.py[cod] 9 | *$py.class 10 | 11 | # C extensions 12 | *.so 13 | 14 | # Distribution / packaging 15 | .Python 16 | build/ 17 | develop-eggs/ 18 | dist/ 19 | downloads/ 20 | eggs/ 21 | .eggs/ 22 | lib/ 23 | lib64/ 24 | parts/ 25 | sdist/ 26 | var/ 27 | wheels/ 28 | pip-wheel-metadata/ 29 | share/python-wheels/ 30 | *.egg-info/ 31 | .installed.cfg 32 | *.egg 33 | MANIFEST 34 | 35 | # PyInstaller 36 | # Usually these files are written by a python script from a template 37 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 38 | *.manifest 39 | *.spec 40 | 41 | # Installer logs 42 | pip-log.txt 43 | pip-delete-this-directory.txt 44 | 45 | # Unit test / coverage reports 46 | htmlcov/ 47 | .tox/ 48 | .nox/ 49 | .coverage 50 | .coverage.* 51 | .cache 52 | nosetests.xml 53 | coverage.xml 54 | *.cover 55 | .hypothesis/ 56 | .pytest_cache/ 57 | 58 | # Translations 59 | *.mo 60 | *.pot 61 | 62 | # Scrapy stuff: 63 | .scrapy 64 | 65 | # Sphinx documentation 66 | docs/_build/ 67 | 68 | # PyBuilder 69 | target/ 70 | 71 | # pyenv 72 | .python-version 73 | 74 | # pipenv 75 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 76 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 77 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 78 | # install all needed dependencies. 79 | #Pipfile.lock 80 | 81 | # celery beat schedule file 82 | celerybeat-schedule 83 | 84 | # SageMath parsed files 85 | *.sage.py 86 | 87 | # Spyder project settings 88 | .spyderproject 89 | .spyproject 90 | 91 | # Rope project settings 92 | .ropeproject 93 | 94 | # Mr Developer 95 | .mr.developer.cfg 96 | .project 97 | .pydevproject 98 | 99 | # mkdocs documentation 100 | /site 101 | 102 | # mypy 103 | .mypy_cache/ 104 | .dmypy.json 105 | dmypy.json 106 | 107 | # Pyre type checker 108 | .pyre/ 109 | 110 | # End of https://www.gitignore.io/api/python 111 | config/ 112 | -------------------------------------------------------------------------------- /.isort.cfg: -------------------------------------------------------------------------------- 1 | [settings] 2 | multi_line_output=3 3 | include_trailing_comma=True 4 | force_grid_wrap=0 5 | use_parentheses=True 6 | line_length=88 7 | -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "2.0.0", 3 | "tasks": [ 4 | { 5 | "label": "Restart HASS", 6 | "type": "shell", 7 | "command": "make hass-restart", 8 | "problemMatcher": [], 9 | "group": { 10 | "kind": "build", 11 | "isDefault": true 12 | }, 13 | "presentation": { 14 | "reveal": "never", 15 | "close": true 16 | }, 17 | } 18 | ] 19 | } 20 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .SHELLFLAGS += -x -e 2 | .ONESHELL: 3 | PY_SOURCES = custom_components scripts 4 | HASS_VERSION = $(shell pip freeze | grep \^homeassistant | sed 's/==/\n/g' | tail -n 1) 5 | COMPOSE_ARGS = -f scripts/docker-compose.yml -p hass-auth-header 6 | 7 | all: lint-fix lint 8 | 9 | lint-fix: 10 | isort $(PY_SOURCES) 11 | black $(PY_SOURCES) 12 | ruff $(PY_SOURCES) 13 | 14 | lint: 15 | pylint $(PY_SOURCES) 16 | 17 | test-env-start: 18 | VERSION=${HASS_VERSION} docker-compose $(COMPOSE_ARGS) up -d 19 | 20 | test-env-stop: 21 | VERSION=${HASS_VERSION} docker compose $(COMPOSE_ARGS) down 22 | 23 | test-env-remove: 24 | VERSION=${HASS_VERSION} docker compose $(COMPOSE_ARGS) down -v 25 | 26 | hass-restart: 27 | docker-compose $(COMPOSE_ARGS) exec homeassistant killall -HUP python3 28 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Header Auth for Home Assistant 2 | 3 | This custom component allows you to delegate authentication to a reverse proxy. 4 | 5 | This integrations checks the value of a configured header and authenticates based on its value. The value of the header is 6 | checked against usernames AND full names. Users have to be created in Home Assistant by hand. 7 | 8 | **Use with caution. If misconfigured, this can lead to a Home Assistant instance that anyone can access** 9 | 10 | ## Installation 11 | 12 | 1. Add this repository to [HACS](https://hacs.xyz/). 13 | 14 | [![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=BeryJu&repository=hass-auth-header&category=integration) 15 | 16 | 17 | 2. Update your configuration.yaml file with 18 | 19 | ```yaml 20 | http: 21 | use_x_forwarded_for: true 22 | trusted_proxies: 23 | - 1.2.3.4/32 # This needs to be set to the IP of your reverse proxy 24 | auth_header: 25 | # Optionally set this if you're not using authentik proxy or oauth2_proxy 26 | # username_header: X-Forwarded-Preferred-Username 27 | # Optionally set this if you don't want to bypass the login prompt 28 | # allow_bypass_login: false 29 | # Optionally enable debug mode to see the headers Home-Assistant gets 30 | # debug: false 31 | # Optionally, if something is not working right, add this block below to get more information 32 | logger: 33 | default: info 34 | logs: 35 | custom_components.auth_header: debug 36 | ``` 37 | 3. Afterwards, restart Home Assistant. 38 | 39 | ![](./.github/demo.gif) 40 | 41 | ## CSRF Errors when used with oauth2_proxy or authentik 42 | 43 | See https://github.com/goauthentik/authentik/issues/884#issuecomment-851542477 44 | 45 | ## How it works 46 | 47 | On boot, two main things are done when the integration is enabled: 48 | 49 | 1. The default `LoginFlowIndexView` view is replaced. This view is called when you submit the login form. The replacement for this view, `RequestLoginFlowResourceView`, simply adds the HTTP Request to the context. This context is passed to authentication Providers. 50 | 51 | Normally the Request is not included, as none of the providers require it. 52 | 53 | 2. The Header Authentication Provider is injected into the providers, *before* the other authentication providers. 54 | 55 | This ensures that Header auth is tried first, and if it fails the user can still use username/password. 56 | 57 | 58 | ## Help! Everything is broken! 59 | 60 | If anything goes wrong or Home Assistant fails to load the component correctly, simply remove the `auth_header` block from your configuration file and restart HASS. 61 | -------------------------------------------------------------------------------- /custom_components/auth_header/__init__.py: -------------------------------------------------------------------------------- 1 | import logging 2 | from http import HTTPStatus 3 | import os.path 4 | from ipaddress import ip_address 5 | from typing import Any, OrderedDict, TYPE_CHECKING 6 | 7 | import homeassistant.helpers.config_validation as cv 8 | import voluptuous as vol 9 | from aiohttp.web import Request, Response 10 | from homeassistant import data_entry_flow 11 | from homeassistant.components.auth import DOMAIN as AUTH_DOMAIN 12 | from homeassistant.components.auth import indieauth 13 | from homeassistant.components.auth.login_flow import LoginFlowIndexView 14 | from homeassistant.components.http import StaticPathConfig 15 | from homeassistant.components.http.ban import log_invalid_auth 16 | from homeassistant.components.http.data_validator import RequestDataValidator 17 | from homeassistant.core import HomeAssistant 18 | from homeassistant.components.frontend import add_extra_js_url 19 | 20 | from . import headers 21 | 22 | if TYPE_CHECKING: 23 | from homeassistant.components.http import FastUrlDispatcher 24 | from aiohttp.web_urldispatcher import UrlDispatcher, AbstractResource 25 | 26 | DOMAIN = "auth_header" 27 | _LOGGER = logging.getLogger(__name__) 28 | CONFIG_SCHEMA = vol.Schema( 29 | { 30 | DOMAIN: vol.Schema( 31 | { 32 | vol.Optional("username_header", default="X-Forwarded-Preferred-Username"): cv.string, 33 | vol.Optional("allow_bypass_login", default=True): cv.boolean, 34 | vol.Optional("debug", default=False): cv.boolean, 35 | } 36 | ) 37 | }, 38 | extra=vol.ALLOW_EXTRA, 39 | ) 40 | 41 | 42 | async def async_setup(hass: HomeAssistant, config): 43 | """Register custom view which includes request in context""" 44 | # Because we start after auth, we have access to store_result 45 | store_result = hass.data[AUTH_DOMAIN] 46 | router: "FastUrlDispatcher" | "UrlDispatcher" = hass.http.app.router 47 | # Remove old LoginFlowIndexView 48 | # HASS < 2023.8 just has a list of all routes, which we can directly remove from 49 | for route in router._resources: 50 | if route.canonical == RequestLoginFlowIndexView.url: 51 | _LOGGER.debug("Removed original login_flow route (UrlDispatcher) %s", route) 52 | hass.http.app.router._resources.remove(route) 53 | # HASS 2023.8+ uses the "FastUrlDispatcher", which also keeps a dict for faster lookups 54 | if hasattr(router, "_resource_index"): 55 | resource_index: dict[str, list["AbstractResource"]] = router._resource_index 56 | routes = resource_index.get(RequestLoginFlowIndexView.url, None) 57 | if routes: 58 | for route in routes: 59 | if route.canonical == RequestLoginFlowIndexView.url: 60 | _LOGGER.debug("Removed original login_flow route (FastUrlDispatcher) %s", route) 61 | routes.remove(route) 62 | _LOGGER.debug("Add new login_flow route") 63 | hass.http.register_view( 64 | RequestLoginFlowIndexView( 65 | hass.auth.login_flow, store_result, config[DOMAIN]["debug"] 66 | ) 67 | ) 68 | 69 | # Load script to store tokens in local storage, else we'll re-auth on every browser refresh. 70 | await hass.http.async_register_static_paths( 71 | [StaticPathConfig( 72 | "/auth_header/store-token.js", 73 | os.path.join(os.path.dirname(__file__), 'store-token.js'), 74 | True 75 | ) 76 | ] 77 | ) 78 | 79 | add_extra_js_url(hass, '/auth_header/store-token.js') 80 | 81 | # Inject Auth-Header provider. 82 | providers = OrderedDict() 83 | provider = headers.HeaderAuthProvider( 84 | hass, 85 | hass.auth._store, 86 | config[DOMAIN], 87 | ) 88 | providers[(provider.type, provider.id)] = provider 89 | providers.update(hass.auth._providers) 90 | hass.auth._providers = providers 91 | _LOGGER.debug("Injected auth_header provider") 92 | return True 93 | 94 | 95 | def get_actual_ip(request: Request) -> str: 96 | """Get remote from `request` without considering overrides. This is because 97 | when behind a reverse proxy, hass overrides the .remote attributes with the X-Forwarded-For 98 | value. We still need to check the actual remote though, to verify its from a valid proxy. 99 | """ 100 | if isinstance(request._transport_peername, (list, tuple)): 101 | return request._transport_peername[0] 102 | return request._transport_peername 103 | 104 | 105 | class RequestLoginFlowIndexView(LoginFlowIndexView): 106 | debug: bool 107 | 108 | def __init__(self, flow_mgr, store_result, debug=False) -> None: 109 | super().__init__(flow_mgr, store_result) 110 | self.debug = debug 111 | 112 | @RequestDataValidator( 113 | vol.Schema( 114 | { 115 | vol.Required("client_id"): str, 116 | vol.Required("handler"): vol.Any(str, list), 117 | vol.Required("redirect_uri"): str, 118 | vol.Optional("type", default="authorize"): str, 119 | } 120 | ) 121 | ) 122 | @log_invalid_auth 123 | async def post(self, request: Request, data: dict[str, Any]) -> Response: 124 | """Create a new login flow.""" 125 | client_id: str = data["client_id"] 126 | redirect_uri: str = data["redirect_uri"] 127 | 128 | if not indieauth.verify_client_id(client_id): 129 | return self.json_message("Invalid client id", HTTPStatus.BAD_REQUEST) 130 | 131 | handler: tuple[str, ...] | str 132 | if isinstance(data["handler"], list): 133 | handler = tuple(data["handler"]) 134 | else: 135 | handler = data["handler"] 136 | 137 | try: 138 | _LOGGER.debug(request.headers) 139 | actual_ip = get_actual_ip(request) 140 | _LOGGER.debug("Got actual IP %s", actual_ip) 141 | result = await self._flow_mgr.async_init( 142 | handler, # type: ignore[arg-type] 143 | context={ 144 | "request": request, 145 | "ip_address": ip_address(request.remote), # type: ignore[arg-type] 146 | "conn_ip_address": ip_address(actual_ip), # type: ignore[arg-type] 147 | "credential_only": data.get("type") == "link_user", 148 | "redirect_uri": redirect_uri, 149 | }, 150 | ) 151 | except data_entry_flow.UnknownHandler: 152 | return self.json_message("Invalid handler specified", HTTPStatus.NOT_FOUND) 153 | except data_entry_flow.UnknownStep: 154 | return self.json_message( 155 | "Handler does not support init", HTTPStatus.BAD_REQUEST 156 | ) 157 | 158 | return await self._async_flow_result_to_response(request, client_id, result) 159 | -------------------------------------------------------------------------------- /custom_components/auth_header/headers.py: -------------------------------------------------------------------------------- 1 | """Header Authentication provider. 2 | 3 | Allow access to users based on a header set by a reverse-proxy. 4 | """ 5 | import logging 6 | from typing import Any, Dict, List, Optional, cast 7 | 8 | from aiohttp.web import Request 9 | from homeassistant.auth.models import Credentials, User, UserMeta 10 | from homeassistant.auth.providers import AUTH_PROVIDERS, AuthProvider, LoginFlow 11 | from homeassistant.auth.providers.trusted_networks import ( 12 | InvalidAuthError, 13 | InvalidUserError, 14 | IPAddress, 15 | ) 16 | from homeassistant.core import callback 17 | 18 | CONF_USERNAME_HEADER = "username_header" 19 | CONF_ALLOW_BYPASS_LOGIN = "allow_bypass_login" 20 | _LOGGER = logging.getLogger(__name__) 21 | 22 | 23 | @AUTH_PROVIDERS.register("header") 24 | class HeaderAuthProvider(AuthProvider): 25 | """Header Authentication Provider. 26 | 27 | Allow access to users based on a header set by a reverse-proxy. 28 | """ 29 | 30 | DEFAULT_TITLE = "Header Authentication" 31 | 32 | @property 33 | def type(self) -> str: 34 | return "auth_header" 35 | 36 | @property 37 | def support_mfa(self) -> bool: 38 | """Header Authentication Provider does not support MFA.""" 39 | return False 40 | 41 | async def async_login_flow(self, context: Optional[Dict]) -> LoginFlow: 42 | """Return a flow to login.""" 43 | assert context is not None 44 | header_name = self.config[CONF_USERNAME_HEADER] 45 | request = cast(Request, context.get("request")) 46 | if header_name not in request.headers: 47 | _LOGGER.info("No header set, returning empty flow") 48 | return HeaderLoginFlow( 49 | self, 50 | None, 51 | [], 52 | cast(IPAddress, context.get("conn_ip_address")), 53 | self.config[CONF_ALLOW_BYPASS_LOGIN], 54 | ) 55 | remote_user = request.headers[header_name].casefold() 56 | # Translate username to id 57 | users = await self.store.async_get_users() 58 | available_users = [ 59 | user for user in users if not user.system_generated and user.is_active 60 | ] 61 | return HeaderLoginFlow( 62 | self, 63 | remote_user, 64 | available_users, 65 | cast(IPAddress, context.get("conn_ip_address")), 66 | self.config[CONF_ALLOW_BYPASS_LOGIN], 67 | ) 68 | 69 | async def async_user_meta_for_credentials( 70 | self, credentials: Credentials 71 | ) -> UserMeta: 72 | """Return extra user metadata for credentials. 73 | 74 | Trusted network auth provider should never create new user. 75 | """ 76 | raise NotImplementedError 77 | 78 | async def async_get_or_create_credentials( 79 | self, flow_result: Dict[str, str] 80 | ) -> Credentials: 81 | """Get credentials based on the flow result.""" 82 | user_id = flow_result["user"] 83 | 84 | users = await self.store.async_get_users() 85 | for user in users: 86 | if not user.system_generated and user.is_active and user.id == user_id: 87 | for credential in await self.async_credentials(): 88 | if credential.data["user_id"] == user_id: 89 | return credential 90 | cred = self.async_create_credentials({"user_id": user_id}) 91 | await self.store.async_link_user(user, cred) 92 | return cred 93 | 94 | # We only allow login as exist user 95 | raise InvalidUserError 96 | 97 | @callback 98 | def async_validate_access(self, ip_addr: IPAddress) -> None: 99 | """Make sure the access is from trusted_proxies. 100 | 101 | Raise InvalidAuthError if not. 102 | Raise InvalidAuthError if trusted_proxies is not configured. 103 | """ 104 | if not self.hass.http.trusted_proxies: 105 | _LOGGER.warning("trusted_proxies is not configured") 106 | raise InvalidAuthError("trusted_proxies is not configured") 107 | 108 | if not any( 109 | ip_addr in trusted_network 110 | for trusted_network in self.hass.http.trusted_proxies 111 | ): 112 | _LOGGER.warning("Remote IP not in trusted proxies: %s", ip_addr) 113 | raise InvalidAuthError("Not in trusted_proxies") 114 | 115 | 116 | class HeaderLoginFlow(LoginFlow): 117 | """Handler for the login flow.""" 118 | 119 | def __init__( 120 | self, 121 | auth_provider: HeaderAuthProvider, 122 | remote_user: str, 123 | available_users: List[User], 124 | ip_address: IPAddress, 125 | allow_bypass_login: bool, 126 | ) -> None: 127 | """Initialize the login flow.""" 128 | super().__init__(auth_provider) 129 | self._available_users = available_users 130 | self._remote_user = remote_user 131 | self._ip_address = ip_address 132 | self._allow_bypass_login = allow_bypass_login 133 | 134 | async def async_step_init(self, user_input=None) -> Dict[str, Any]: 135 | """Handle the step of the form.""" 136 | 137 | if user_input is not None or self._allow_bypass_login: 138 | try: 139 | _LOGGER.debug("Validating access for IP: %s", self._ip_address) 140 | cast(HeaderAuthProvider, self._auth_provider).async_validate_access( 141 | self._ip_address 142 | ) 143 | except InvalidAuthError as exc: 144 | _LOGGER.debug("Invalid auth: %s", exc) 145 | return self.async_abort(reason="not_allowed") 146 | 147 | for user in self._available_users: 148 | _LOGGER.debug("Checking user: %s", user.name) 149 | for cred in user.credentials: 150 | if "username" in cred.data: 151 | _LOGGER.debug("Found username in credentials: %s", cred.data["username"]) 152 | if cred.data["username"] == self._remote_user: 153 | _LOGGER.debug("Username match found, finishing login flow") 154 | return await self.async_finish({"user": user.id}) 155 | if user.name == self._remote_user: 156 | _LOGGER.debug("User name match found, finishing login flow") 157 | return await self.async_finish({"user": user.id}) 158 | 159 | _LOGGER.debug("No matching user found") 160 | return self.async_abort(reason="not_allowed") 161 | 162 | _LOGGER.debug("Showing login form with remote_user: %s", self._remote_user) 163 | return self.async_show_form( 164 | step_id="init", 165 | data_schema=None, 166 | ) 167 | -------------------------------------------------------------------------------- /custom_components/auth_header/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "domain": "auth_header", 3 | "name": "HTTP Header Authentication", 4 | "documentation": "https://github.com/BeryJu/hass-auth-header", 5 | "requirements": [], 6 | "ssdp": [], 7 | "zeroconf": [], 8 | "homekit": {}, 9 | "dependencies": [ 10 | "auth" 11 | ], 12 | "codeowners": ["@BeryJu"], 13 | "version": "1.4" 14 | } 15 | -------------------------------------------------------------------------------- /custom_components/auth_header/store-token.js: -------------------------------------------------------------------------------- 1 | (() => { 2 | // Store the login token in localStorage as soon as they are available. This is normally done (depending on whether the user enabled the "Keep me logged in" option) in https://github.com/home-assistant/frontend/blob/6653a8f63426755d6a58bce0ef3d55d83d8ec99c/src/common/auth/token_storage.ts 3 | let attemptsRemaining = 10; 4 | const interval = setInterval(() => { 5 | attemptsRemaining -= 1; 6 | if (window.__tokenCache.tokens) { 7 | localStorage.setItem("hassTokens", JSON.stringify(window.__tokenCache.tokens)) 8 | window.__tokenCache.writeEnabled = true; 9 | attemptsRemaining = 0; 10 | } 11 | if (attemptsRemaining <= 0) { 12 | clearInterval(interval); 13 | } 14 | }, 1000); 15 | })(); 16 | -------------------------------------------------------------------------------- /hacs.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Header Authentication", 3 | "render_readme": true, 4 | "homeassistant": "2021.5" 5 | } 6 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.poetry] 2 | name = "hass-auth-header" 3 | version = "0.1.0" 4 | description = "" 5 | authors = ["Jens Langhammer "] 6 | license = "GPL" 7 | 8 | [tool.poetry.dependencies] 9 | python = "^3.10" 10 | 11 | [tool.poetry.group.dev.dependencies] 12 | homeassistant = "*" 13 | pylint = "*" 14 | black = "*" 15 | isort = "*" 16 | 17 | [tool.pylint.master] 18 | disable = [ 19 | "protected-access" 20 | ] 21 | 22 | [tool.isort] 23 | line_length = 100 24 | 25 | [tool.black] 26 | line-length = 100 27 | 28 | [tool.ruff] 29 | line-length = 100 30 | -------------------------------------------------------------------------------- /scripts/authentik-blueprint.yaml: -------------------------------------------------------------------------------- 1 | # yaml-language-server: $schema=https://goauthentik.io/blueprints/schema.json 2 | version: 1 3 | metadata: 4 | name: hass-auth-header - Testing setup 5 | context: 6 | # Needs to be changed if the test setup is completely in docker 7 | internal_host: http://localhost:8123 8 | entries: 9 | - model: authentik_providers_proxy.proxyprovider 10 | id: provider 11 | identifiers: 12 | name: hass-auth-header 13 | attrs: 14 | authorization_flow: !Find [authentik_flows.flow, [slug, default-provider-authorization-implicit-consent]] 15 | mode: proxy 16 | internal_host: !Context internal_host 17 | external_host: http://hass-auth-header.127.0.0.1.nip.io:9000 18 | - model: authentik_core.application 19 | identifiers: 20 | slug: hass-auth-header 21 | attrs: 22 | name: Homeassistant 23 | provider: !KeyOf provider 24 | - model: authentik_outposts.outpost 25 | identifiers: 26 | managed: goauthentik.io/outposts/embedded 27 | attrs: 28 | providers: 29 | - !KeyOf provider 30 | -------------------------------------------------------------------------------- /scripts/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | homeassistant: 4 | image: "ghcr.io/home-assistant/home-assistant:${VERSION}" 5 | volumes: 6 | - temp_config:/config 7 | - ../custom_components:/config/custom_components 8 | - ./fixed_config/configuration.yaml:/config/configuration.yaml 9 | - /etc/localtime:/etc/localtime:ro 10 | restart: unless-stopped 11 | ports: 12 | - 8123:8123 13 | 14 | volumes: 15 | temp_config: 16 | -------------------------------------------------------------------------------- /scripts/fixed_config/configuration.yaml: -------------------------------------------------------------------------------- 1 | # Loads default set of integrations. Do not remove. 2 | default_config: 3 | 4 | http: 5 | use_x_forwarded_for: true 6 | trusted_proxies: 7 | - 0.0.0.0/0 8 | auth_header: 9 | username_header: X-authentik-username 10 | 11 | logger: 12 | default: info 13 | logs: 14 | custom_components.auth_header: debug 15 | --------------------------------------------------------------------------------