Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better developer documentation on MFA #269

Open
brynwhyman opened this issue May 11, 2020 · 2 comments
Open

Better developer documentation on MFA #269

brynwhyman opened this issue May 11, 2020 · 2 comments

Comments

@brynwhyman
Copy link

brynwhyman commented May 11, 2020

There are a couple of nuances with using the MFA modules on a CWP site.

These should be captured as Developer documentation on the CWP.govt.nz website.

Points to touch on:

  • Highlight that it will be part of the installer in version CWP 2.6
  • The TOTP base secret is provided by default on standard CWP stacks, not for the CWP Cloud (AWS) stacks
  • Docs to ensure that Developers get the TOTP encryption key .env variable for their local dev environment
  • Point to docs on how to install the modules if not on CWP 2.6
  • Summary of the feature set, what CMS users it applies to, how to customise the functionality, etc.
  • Highlight the known limitations and edge cases. This is currently scattered in module documentation and internal support docs. This includes how MFA relates to working with snapshots between environments
  • Direct readers to more information about the Security Key method, the known limitations, and in what situations it might be a suitable option for sites
  • Note about WebAuthn in the CWP 2.6 changelog, see: Changelog for 2.6.0 #275 (review)
@michalkleiner
Copy link
Contributor

One thing to add to the list would be how MFA relates to working with snapshots between environments, e.g. when PROD content is moved to UAT for testing or UAT to local DEV etc.

@brynwhyman
Copy link
Author

Thanks @michalkleiner, added to the description. We'll be getting to this within the next fortnight.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants