Changes between Initial Version and Version 1 of net.sf.basedb.webauthn/using

Timestamp:

Jun 3, 2022, 12:08:55 PM (23 months ago)

Author:

Nicklas Nordborg

Comment:

Started to write user documentation

net.sf.basedb.webauthn/using

@@ +1 @@
+= How to use the !WebAuthn authentication extension =
+
+== Logging in ==
+
+Before it is possible to login with a !WebAuthn Security Key the server administrator need to register the key and connect it to the user account. It is not possible for users to register the key by themselves.
+
+ 1. Start by entering the '''Login''' and '''Password''' information in the form.
+ 2. Press '''ENTER''' or click on the '''Login''' button.
+ 3. The browser should ask you to insert the security into an USB port (unless it is already inserted).
+ 4. Press the button on the security key (do not click on the '''Cancel''' button).
+ 5. You should now be logged in.
+
+{{{
+#!html
+<div style="background-color: #fffff0; border: 2px solid #6060A0; border-radius: 5px; padding: 1em; max-width: 60em;">
+<b>Note!</b><br>
+The exact prompts and dialogs that the browser displays vary by the browser and operating system you are using. Below are some examples:
+</div>
+}}}
+
+TODO
+
+== Assigning security keys to users ==
+
+ 1. To assign a !WebAuthn security to a user, the BASE administrator should
+    locate that user in the '''Administrate->Users''' list and open the edit dialog.
+ 2. Switch to the '''!WebAuthn''' tab. This should state that no security key is enabled for 
+    the account.
+ 3. Insert the security key into an USB port and click on the '''Register''' button.
+ 4. Press the button on the security for verification.
+ 4. If the registration is successful the dialog should switch to reflect the
+    fact that the account is now !WebAuthn-enabled. Take out the key and
+    enter the serial number into the '''Serial #''' field (optional). Save!
+
+
+== Unassign a security key ==
+
+Click on the '''Remove''' in the '''!WebAuthn''' tab in the '''Edit user''' dialog. Save!
+
+== Notes! ==
+
+ 1. It is possible to assign the same security key to more than one user account. This might be 
+    practical for persons that have one regular account for daily usage and one account for 
+    administrative needs. 
+ 2. The administrator may allow other authentication methods.
+
+