home-assistant.io/source/_components/sensor.haveibeenpwned.markdown
2018-07-09 14:23:01 +02:00

1.8 KiB

layout title description date sidebar comments sharing footer logo ha_category ha_release ha_iot_class
page HaveIBeenPwned Sensor Instructions on how to integrate HaveIBeenPwned sensor into Home Assistant. 2016-09-29 18:00 true false true true haveibeenpwned.png Sensor 0.31 Cloud Polling

The haveibeenpwned sensor platform creates sensors that check for breached email accounts on haveibeenpwned.

{% linkable_title Configuration %}

To enable this sensor, add the following lines to your configuration.yaml, it will list every specified email address as a sensor showing the number of breaches on that email account.

# Example configuration.yaml entry using cloud based emoncms
sensor:
  - platform: haveibeenpwned
    email: 
      - your_email1@domain.com
      - your_email2@domain.com

{% configuration %} email: description: List of email addresses. required: true type: list {% endconfiguration %}

{% linkable_title Breach meta data %}

If one of your email accounts is breached the sensor will display breach meta data. It will list the title of the site where your email account has been breached as well as the added date of the breach data. This data is displayed in descending order so that the state attribute breach 1 will always contain the last known breach for the specific email account, if there are any breaches detected.

The sensor will scan all email addresses specified with a 5 second delay between all breach data requests on Home Assistant startup. After this initial startup scanning, the sensor will only scan one email account per 15 minutes to prevent abuse, and not hammer "the Have I been Pwned" service, as this breach data almost never changes.