Skip to content

Add notify MFA module#6131

Merged
DubhAd merged 4 commits intonextfrom
awarecan-patch-1
Sep 24, 2018
Merged

Add notify MFA module#6131
DubhAd merged 4 commits intonextfrom
awarecan-patch-1

Conversation

@awarecan
Copy link
Copy Markdown
Contributor

@awarecan awarecan commented Sep 1, 2018

Description:
Add notify MFA module

Pull request in home-assistant (if applicable): home-assistant/core#16314

Checklist:

  • Branch: Fixes, changes and adjustments should be created against current. New documentation for platforms/components and features should go to next.
  • The documentation follow the standards.

@ghost ghost assigned awarecan Sep 1, 2018
@ghost ghost added the ready-for-review This PR needs to be reviewed label Sep 1, 2018
DubhAd
DubhAd previously approved these changes Sep 1, 2018
Copy link
Copy Markdown
Contributor

@DubhAd DubhAd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@DubhAd DubhAd added awaits-parent Awaits the merge of an parent PR and removed ready-for-review This PR needs to be reviewed labels Sep 1, 2018
Copy link
Copy Markdown
Contributor

@DubhAd DubhAd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A small wall of wording/spelling bits


### {% linkable_title Notify mutli-factor authentication module %}

Notify MFA module using [notify component](https://www.home-assistant.io/components/notify/) to delivery a [HMAC-based One-Time Password](https://en.wikipedia.org/wiki/HMAC-based_One-time_Password_algorithm) to user configured target.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The notify MFA module uses notify component to deliver a HMAC-based One-Time Password to the user configured target.


Notify MFA module using [notify component](https://www.home-assistant.io/components/notify/) to delivery a [HMAC-based One-Time Password](https://en.wikipedia.org/wiki/HMAC-based_One-time_Password_algorithm) to user configured target.

User need first set up the MFA module by select one of the aviliable notify service. A 8 digit one-time password will be sent by this notify service, user need to input it to verify the setup.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user needs to first set up the MFA module by selecting one of the available notify service. An 8 digit one-time password will be sent using this notify service, the user needs to input it to verify the setup.


User need first set up the MFA module by select one of the aviliable notify service. A 8 digit one-time password will be sent by this notify service, user need to input it to verify the setup.

During the login process, an 8 digit one-time password will be sent again, user need to input it to verify his/her identity. If the validation failed, a new one-time password will be sent again.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

During the login process, an 8 digit one-time password will be sent again, the user needs to input it to verify their identity. If the validation failed, a new one-time password will be sent.

During the login process, an 8 digit one-time password will be sent again, user need to input it to verify his/her identity. If the validation failed, a new one-time password will be sent again.

<p class='note'>
Notify MFA module would not verify the one-time password deliveried success, so that if user cannot received the message due any reason, he/she may not be login again. Edit or remove `[your_config_dir]/.storage/auth_module.notify` can disable nofiy MFA module to resolve the issue.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The notify MFA module cannot verify the one-time password delivery success, so that if the user cannot received the message for any reason, they may not be login again. Edit or remove [your_config_dir]/.storage/auth_module.notify to disable the notify MFA module to resolve the issue.


By default, one TOTP multi-factor named "Authenticator app" will be auto loaded if no `auth_mfa_modules` configuration section defined in the `configuration.yaml` file.

By default one TOTP multi-factor auth module named "Authenticator app" will be auto loaded if no `auth_mfa_modules` config section defined in `configuration.yaml`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By default one TOTP multi-factor auth module named "Authenticator app" will be auto loaded if no auth_mfa_modules config section is defined in configuration.yaml.

@frenck frenck added new-feature This PR adds documentation for a new Home Assistant feature to an existing integration next This PR goes into the next branch has-parent This PR has a parent PR in another repo labels Sep 9, 2018
@frenck frenck added the parent-merged The parent PR has been merged already label Sep 24, 2018
@frenck frenck added this to the 0.79 milestone Sep 24, 2018
@DubhAd DubhAd merged commit 3203fde into next Sep 24, 2018
@ghost ghost removed the awaits-parent Awaits the merge of an parent PR label Sep 24, 2018
@balloob balloob deleted the awarecan-patch-1 branch September 24, 2018 19:45
@balloob balloob added the cherry-picked This PR has been manually picked and merged into the current branch label Sep 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cherry-picked This PR has been manually picked and merged into the current branch has-parent This PR has a parent PR in another repo new-feature This PR adds documentation for a new Home Assistant feature to an existing integration next This PR goes into the next branch parent-merged The parent PR has been merged already

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants