Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/iantrich/restriction-card

🔒 Apply restrictions to Lovelace cards
https://github.com/iantrich/restriction-card
custom-card home-assistant lovelace security
Last synced: 7 days ago
JSON representation
🔒 Apply restrictions to Lovelace cards
Host: GitHub
URL: https://github.com/iantrich/restriction-card
Owner: iantrich
License: mit
Created: 2019-10-16T19:59:16.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-07-31T15:16:30.000Z (3 months ago)
Last Synced: 2024-10-14T08:47:16.954Z (25 days ago)
Topics: custom-card, home-assistant, lovelace, security
Language: TypeScript
Homepage:
Size: 3.52 MB
Stars: 271
Watchers: 9
Forks: 23
Open Issues: 12
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project

awesome-home-assistant - Restriction Card - A card to provide restrictions on Lovelace cards defined within. (Dashboards / Custom Cards)
README

        # 🔒 Restriction Card

A card to provide restrictions on Lovelace cards defined within.

## Disclaimer

This card is not to be used as a means to truly protect an instance. Someone with the means and knowledge will be able to bypass the restrictions presented by this card should they choose to.

[![GitHub Release][releases-shield]][releases]

[![License][license-shield]](LICENSE.md)

[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/hacs/integration)

![Project Maintenance][maintenance-shield]

[![GitHub Activity][commits-shield]][commits]

[![Discord][discord-shield]][discord]

[![Community Forum][forum-shield]][forum]

## Minimum Home Assistant Version

Home Assistant version 0.110.0 or higher is required as of release 1.2.0 of restriction-card

## Support

Hey dude! Help me out for a couple of :beers: or a :coffee:!

[![coffee](https://www.buymeacoffee.com/assets/img/custom_images/black_img.png)](https://www.buymeacoffee.com/zJtVxUAgH)

## Installation

Use [HACS](https://hacs.xyz) or follow this [guide](https://github.com/thomasloven/hass-config/wiki/Lovelace-Plugins)

```yaml

resources:

  url: /local/restriction-card.js

  type: module

```

## Options

| Name          | Type    | Requirement  | Description                                                                                     |

| ------------- | ------- | ------------ | ----------------------------------------------------------------------------------------------- |

| type          | string  | **Required** | `custom:restriction-card`                                                                       |

| card          | map     | **Required** | Card to render within `restriction-card`.                                                       |

| restrictions  | map     | **Optional** | Additional restrictions. See [Restrictions Options](#restrictions-options).                     |

| exemptions    | list    | **Optional** | List of exemption objects. See [Exemption Options](#exemption-options).                         |

| condition     | map     | **Optional** | Conditional object to make lock active. See [Condition Options](#condition-options).            |

| row           | boolean | **Optional** | Set to true to give a default `margin:left: 24px`                                               |

| duration      | number  | **Optional** | Duration of unlock in seconds. Default is `5`                                                   |

| action        | string  | **Optional** | Action type to trigger the unlock. Options are `tap`, `double_tap`, or `hold`. Default is `tap` |

| locked_icon   | string  | **Optional** | Icon to show when locked. Default is `mdi:lock-outline`                                         |

| unlocked_icon | string  | **Optional** | Icon to show when unlocked instead of fading the icon away                                      |

## Restrictions Options

| Name    | Type | Requirement  | Description                                                               |

| ------- | ---- | ------------ | ------------------------------------------------------------------------- |

| confirm | map  | **Optional** | Confirmation unlock restriction. See [Confirm Options](#confirm-options). |

| pin     | map  | **Optional** | Pin code restriction. See [Pin Options](#pin-options).                    |

| block   | map  | **Optional** | Block interaction restriction. See [Block Options](#block-options).       |

| hide    | map  | **Optional** | Hide card restriction. See [Hide Options](#hide-options)..                |

## Confirm Options

| Name       | Type   | Requirement  | Description                                                                                 |

| ---------- | ------ | ------------ | ------------------------------------------------------------------------------------------- |

| text       | string | **Optional** | Text to display in confirmation dialog                                                      |

| exemptions | list   | **Optional** | List of exemption objects. See [Exemption Options](#exemption-options).                     |

| condition  | map    | **Optional** | Conditional object to make restriction active. See [Condition Options](#condition-options). |

## Pin Options

| Name              | Type   | Requirement  | Description                                                                                                               |

| ----------------- | ------ | ------------ | ------------------------------------------------------------------------------------------------------------------------- |

| code               | string | **Required** | Pin code the user needs to enter to unlock                                                                                |

| text              | string | **Optional** | Text to display in prompt dialog                                                                                          |

| exemptions        | list   | **Optional** | List of exemption objects. See [Exemption Options](#exemption-options).                                                   |

| condition         | map    | **Optional** | Conditional object to make restriction active. See [Condition Options](#condition-options).                               |

| retry_delay       | number | **Optional** | Number of seconds that you want to delay next attempt to unlock. Default is `0`                                           |

| max_retries       | number | **Optional** | Number of consecutive invalid retries allowed before blocking for the `max_retries_delay` seconds. Default is `unlimited` |

| max_retries_delay | number | **Optional** | Number of seconds to block attempts to unlock after the `max_retries` has been reached                                    |

## Block Options

| Name       | Type   | Requirement  | Description                                                                                 |

| ---------- | ------ | ------------ | ------------------------------------------------------------------------------------------- |

| text       | string | **Optional** | Text to display in alert                                                                    |

| exemptions | list   | **Optional** | List of exemption objects. See [Exemption Options](#exemption-options).                     |

| condition  | map    | **Optional** | Conditional object to make restriction active. See [Condition Options](#condition-options). |

## Hide Options

| Name       | Type | Requirement  | Description                                                                                 |

| ---------- | ---- | ------------ | ------------------------------------------------------------------------------------------- |

| exemptions | list | **Optional** | List of exemption objects. See [Exemption Options](#exemption-options).                     |

| condition  | map  | **Optional** | Conditional object to make restriction active. See [Condition Options](#condition-options). |

## Exemption Options

| Name | Type   | Requirement  | Description                                                |

| ---- | ------ | ------------ | ---------------------------------------------------------- |

| user | string | **Required** | User id to exempt. This is found in the user profile `ID`. |

## Condition Options

| Name      | Type   | Requirement  | Description                                                                                         |

| --------- | ------ | ------------ | --------------------------------------------------------------------------------------------------- |

| value     | string | **Required** | String representing the state.                                                                      |

| entity    | string | **Required** | Entity to use condition and is what also causes the card to update                                  |

| attribute | string | **Optional** | Attribute of the entity to use instead of the state.                                                |

| operator  | string | **Optional** | Operator to use in the comparison. Can be `==`,`<=`,`<`,`>=`,`>`,`!=`, or `regex`. Default is `==`. |

## Theme Variables

The following variables are available and can be set in your theme to change the appearance of the lock.

Can be specified by color name, hexadecimal, rgb, rgba, hsl, hsla, basically anything supported by CSS.

| name                               | Default              | Description                                            |

| ---------------------------------- | -------------------- | ------------------------------------------------------ |

| `restriction-regular-lock-color`   | `primary-text-color` | Lock color                                             |

| `restriction-success-lock-color`   | `primary-color`      | Lock color when unlocked                               |

| `restriction-blocked-lock-color`   | `error-state-color`  | Lock color when card is blocked                        |

| `restriction-invalid--color`       | `error-state-color`  | Lock color after an invalid attempt to unlock          |

| `restriction-lock-margin-left`     | `0px`                | Manually bump the left margin of the lock icon         |

| `restriction-lock-row-margin-left` | `24px`               | Manually bump the left margin of the lock icon in rows |

| `restriction-lock-row-margin-top`  | `0px`                | Manually bump the top margin of the lock icon in rows  |

| `restriction-lock-icon-size`       | `24px`               | Lock icon size                                         |

| `restriction-lock-opacity`         | `0.5`                | Lock icon opacity                                      |

## Example Configurations

Simple Lock example

![lock](lock.gif)

```yaml

type: custom:restriction-card

card:

  type: thermostat

  entity: climate.house

```

More complex example

![complex](pin.gif)

```yaml

type: custom:restriction-card

restrictions:

  confirm:

    exemptions:

      - user: adminid

  pin:

    code: 1234

    exemptions:

      - user: wifeid

      - user: adminid

  block:

    exemptions:

      - user: guestid

      - user: wifeid

      - user: adminid

exemptions:

  - user: ianid

card:

  type: thermostat

  entity: climate.house

```

Row example

![row](row.png)

```yaml

type: 'custom:hui-entities-card'

entities:

  - card:

      entity: cover.garage_door

    restrictions:

      block: true

    type: 'custom:restriction-card'

    row: true

  - entity: light.kitchen

```

Special Consideration for Input Selects:

If you find that the restriction card is blocking something you don't want blocked like an input select, try adjusting the z-index using mod-card

```

card:

  type: custom:mod-card

  card_mod:

    style: |

      ha-card {

        z-index: 7;

        }

  card:

    type: custom:restriction-card

```

## [Troubleshooting](https://github.com/thomasloven/hass-config/wiki/Lovelace-Plugins)

[commits-shield]: https://img.shields.io/github/commit-activity/y/custom-cards/restriction-card.svg?style=for-the-badge

[commits]: https://github.com/custom-cards/restriction-card/commits/master

[discord]: https://discord.gg/5e9yvq

[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge

[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge

[forum]: https://community.home-assistant.io/t/lovelace-restriction-card-client-side-security/142889

[license-shield]: https://img.shields.io/github/license/custom-cards/restriction-card.svg?style=for-the-badge

[maintenance-shield]: https://img.shields.io/badge/maintainer-Ian%20Richardson%20%40iantrich-blue.svg?style=for-the-badge

[releases-shield]: https://img.shields.io/github/release/custom-cards/restriction-card.svg?style=for-the-badge

[releases]: https://github.com/custom-cards/restriction-card/releases