Ask users for a pin when interacting with locks/garage doors

[balloob]

Breaking Change:

The allow_unlock option has been removed for both Cloud and manual Google Assistant installations. Instead, you need to define a pin. Google Cloud users can do this in the cloud preferences UI. Manual installation will have to add secure_devices_pin to their config.

Description:

This replaces the allow_unlock toggle with the official approach to interacting with secure devices via Google Assistant: 2FA using a pin challenge.

This change has been requested by Google hence tagged for 0.92.

Related issue (if applicable): fixes #23219

Pull request in home-assistant.io with documentation (if applicable): home-assistant/home-assistant.io#<home-assistant.io PR number goes here>

Checklist:

• The code change is tested and works locally.
• Local tests pass with tox. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.

If the code does not interact with devices:

• Tests have been added to verify that the new code works.

[ghost]

Hey there @home-assistant/core, mind taking a look at this pull request as its been labeled with a integration (cloud) you are listed as a codeowner for? Thanks!

This is a automatic comment generated by codeowners-mention to help ensure issues and pull requests are seen by the right people.

[codecov]

Codecov Report

Merging #23223 into dev will decrease coverage by <.01%.
The diff coverage is 93.54%.

@@            Coverage Diff             @@
##              dev   #23223      +/-   ##
==========================================
- Coverage   94.17%   94.17%   -0.01%     
==========================================
  Files         457      457              
  Lines       37095    37126      +31     
==========================================
+ Hits        34935    34962      +27     
- Misses       2160     2164       +4

Impacted Files	Coverage Δ
homeassistant/components/cloud/client.py	87.25% <ø> (ø)	⬆️
...meassistant/components/google_assistant/helpers.py	96.15% <100%> (+0.11%)	⬆️
homeassistant/components/cloud/http_api.py	99% <100%> (-0.01%)	⬇️
homeassistant/components/cloud/prefs.py	98.11% <100%> (ø)	⬆️
homeassistant/components/google_assistant/http.py	94.28% <100%> (+0.16%)	⬆️
homeassistant/components/cloud/const.py	100% <100%> (ø)	⬆️
...ssistant/components/google_assistant/smart_home.py	91.2% <100%> (ø)	⬆️
homeassistant/components/google_assistant/const.py	100% <100%> (ø)	⬆️
homeassistant/components/google_assistant/error.py	92.3% <88.88%> (-7.7%)	⬇️
homeassistant/components/google_assistant/trait.py	96.03% <89.28%> (-0.58%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c2b4e24...ac42076. Read the comment docs.

[codecov]

Codecov Report

Merging #23223 into dev will decrease coverage by <.01%.
The diff coverage is 93.54%.

@@            Coverage Diff             @@
##              dev   #23223      +/-   ##
==========================================
- Coverage   94.17%   94.17%   -0.01%     
==========================================
  Files         457      457              
  Lines       37095    37126      +31     
==========================================
+ Hits        34935    34962      +27     
- Misses       2160     2164       +4

Impacted Files	Coverage Δ
homeassistant/components/cloud/client.py	87.25% <ø> (ø)	⬆️
...meassistant/components/google_assistant/helpers.py	96.15% <100%> (+0.11%)	⬆️
homeassistant/components/cloud/http_api.py	99% <100%> (-0.01%)	⬇️
homeassistant/components/cloud/prefs.py	98.11% <100%> (ø)	⬆️
homeassistant/components/google_assistant/http.py	94.28% <100%> (+0.16%)	⬆️
homeassistant/components/cloud/const.py	100% <100%> (ø)	⬆️
...ssistant/components/google_assistant/smart_home.py	91.2% <100%> (ø)	⬆️
homeassistant/components/google_assistant/const.py	100% <100%> (ø)	⬆️
homeassistant/components/google_assistant/error.py	92.3% <88.88%> (-7.7%)	⬇️
homeassistant/components/google_assistant/trait.py	96.03% <89.28%> (-0.58%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c2b4e24...ac42076. Read the comment docs.

[pvizeli]

google_secure_devices_pin is very long, maybe google_devices_pin would be enough to hold the code short

[FutureTense]

This change has been requested by Google hence tagged for 0.92.

@balloob is google requiring this change? While the feature is nice to have, I’m not a fan of being forced to use a pin. Is there a way to make the pin optional?

Regardless, how is one supposed to use the pin? What is the syntax to unlock “Front Door” with pin 1234?

OK Google, unlock the front door 1234

[brianjamescarter]

has anyone got this to work? my google just asks for the code then says, "I looked but this can't be played at this time"

this is beyond frustrating thanks google

[brmo]

I got it to work just by adding my cover.garage_door entity to the include_entities section. However even after setting a pin, it never asks me for it, but rather carries on doing the action. Security flaw there.

[MartinHjelmare]

Please open an issue if you suspect a bug. If you need help please use our help channels:
https://home-assistant.io/help/#communication-channels

Merged PRs should not be used for support or bug reports. Thanks!