feat: agama prod

Signed-off-by: Milton Ch <[email protected]>
GluuFederation · Feb 18, 2024 · 6cba7d3 · 6cba7d3
1 parent 6724b23
commit 6cba7d3
Show file tree

Hide file tree

Showing 28 changed files with 7,937 additions and 1 deletion.
diff --git a/LICENSE b/LICENSE
@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/

diff --git a/README.md b/README.md
@@ -1 +1,157 @@
-# agama-passkey
+# Agama Passkey Project
+
+<!-- These are statistics for this repository-->
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![Apache License][license-shield]][license-url]
+
+Use this project to authenticate using security devices (Android Touch, iOS Face Id, Yubico Key, Windows Hello, Touch ID on Mac, etc.)
+
+## How it works at a glance
+
+When a main flow of this project is launched (namely `org.gluu.agama.passkey.main`) the user's browser is
+redirected to a view where he/she must first enter your username and password, then show a list of passkeys that you have
+registered, in case you do not have one you must register one, once you have registered your passkey you can complete
+the authentication step with passkey.
+But you can also log in from the initial screen without entering a c redential.
+
+## Project Deployment
+
+To deploy this project we need to meet the requirements.
+
+### Requirements
+
+1. Running instance of `Jans Auth Server`, `Jans Fido2`, `Jans Casa` and `Jans Scim`
+
+### Add Java dependencies
+
+1. Download
+   latest [agama-passkey-custom.jar](https://github.com/GluuFederation/agama-passkey/releases/latest/download/agama-passkey-custom.jar)
+   from [Releases](https://github.com/GluuFederation/agama-passkey/releases)
+2. `scp` the jar file to `/opt/jans/jetty/jans-auth/custom/libs/` on Auth Server
+3. On Auth Server, edit `/opt/jans/jetty/jans-auth/webapps/jans-auth.xml` and
+   add the jar file to the `<set name="extractClasspath">...</Set>` element. For example:
+
+```
+<Configure class="org.eclipse.jetty.webapp.WebAppContext">
+   <Set name="contextPath">/jans-auth</Set>
+   <Set name="war">
+       <Property name="jetty.webapps" default="." />/jans-auth.war
+   </Set>
+   <Set name="extractWAR">true</Set>
+   <Set name="extraClasspath">
+      ...
+      /opt/jans/jetty/jans-auth/custom/libs/agama-passkey-custom.jar,
+      ...
+   </Set>
+ </Configure>
+```
+
+4. Restart Auth Server to load the new jar:
+
+```
+systemctl restart jans-auth
+````
+
+### Deployment
+
+Download the
+latest [agama-passkey.gama](https://github.com/GluuFederation/agama-passkey/releases/latest/download/agama-passkey.gama)
+file and deploy it in Auth Sever.
+
+Follow the steps below:
+
+- Copy (SCP/SFTP) the gama file of this project to a location in your `Jans Server`
+- Connect (SSH) to your `Jans Server` and open TUI: `python3 /opt/jans/jans-cli/jans_cli_tui.py`
+- Navigate to the `Agama` tab and then select `"Upload project"`. Choose the gama file
+- Wait for about one minute and then select the row in the table corresponding to this project
+- Press `d` and ensure there were not deployment errors
+- Pres `ESC` to close the dialog
+
+![TUI_AGAMA_DEPLOY](https://github.com/GluuFederation/agama-passkey/assets/86965029/1d6b8cab-ddad-451c-b620-d19be1b7f9e3)
+
+### Configure Jans Scim
+
+- Once we have deployed the `agama project`, we need to configure the `jans scim` parameters, then we proceed to create a new user `jans scim` with scope `https://jans.io/scim/fido2.read` and `https://jans.io/scim/fido2.write`.
+- Now that we have the jans scim client, we proceed to configure this client using TUI.
+- We open TUI and we are located in agama, we select in the table where our application is deployed and press `c`, this will open a configuration panel, where we must first hit `Export Sample Config` and save the file in some path.
+- Now we go to the exported file and edit it and enter the credentials
+
+```
+{
+  "org.gluu.agama.passkey.add": {},
+  "org.gluu.agama.passkey.nickname": {},
+  "org.gluu.agama.passkey.list": {},
+  "org.gluu.agama.passkey.main": {
+    "scimClientId": "YOUR_SCIM_CLIENT_ID",
+    "scimClientSecret": "YOUR_SCIM_CLIENT_SECRET"
+  }
+}
+```
+
+- We go back to the TUI and click on `Import Configuration` and select the modified configuration file with our parameters.
+- With this, our `agama project` is now configured and we can start testing.
+
+![TUI_SCIM_CONFIGURATION](https://github.com/GluuFederation/agama-passkey/assets/86965029/404b066e-a6f3-4c1e-9bf8-afe3f63121e7)
+
+## Testing
+
+You'll need an OpenID Connect test RP. You can try [oidcdebugger](https://oidcdebugger.com/),
+[jans-tarp](https://github.com/JanssenProject/jans/tree/main/demos/jans-tarp)
+or [jans-tent](https://github.com/JanssenProject/jans/tree/main/demos/jans-tent). Check out this video to see an example
+of **agama-passkey** in action:
+
+### Use case 1:
+
+Login with credentials and configure your first passkey device and as a last step complete the login with your new configured key.
+
+![TEST_USE_CASE_1](https://github.com/GluuFederation/agama-passkey/assets/86965029/0e5cc346-a576-499a-a9e3-6069d6932a4b)
+
+### Use case 2:
+
+Log in without credentials, use the `Login with passkey` button.
+
+
+![TEST_USE_CASE_2](https://github.com/GluuFederation/agama-passkey/assets/86965029/200328ec-888a-4767-8242-1c50a126a979)
+
+# Contributors
+
+<table>
+<tr>
+    <td align="center" style="word-wrap: break-word; width: 150.0; height: 150.0">
+        <a href=https://github.com/Milton-Ch>
+            <img src=https://avatars.githubusercontent.com/u/86965029?v=4 width="100;"  style="border-radius:50%;align-items:center;justify-content:center;overflow:hidden;padding-top:10px" alt=Milton Ch/>
+            <br />
+            <sub style="font-size:14px"><b>Milton Ch.</b></sub>
+        </a>
+    </td>
+</tr>
+</table>
+
+# License
+
+This project is licensed under the [Apache 2.0](https://github.com/GluuFederation/agama-security-key/blob/main/LICENSE)
+
+<!-- This are stats url reference for this repository -->
+
+[contributors-shield]: https://img.shields.io/github/contributors/GluuFederation/agama-passkey.svg?style=for-the-badge
+
+[contributors-url]: https://github.com/GluuFederation/agama-passkey/graphs/contributors
+
+[forks-shield]: https://img.shields.io/github/forks/GluuFederation/agama-passkey.svg?style=for-the-badge
+
+[forks-url]: https://github.com/GluuFederation/agama-passkey/network/members
+
+[stars-shield]: https://img.shields.io/github/stars/GluuFederation/agama-passkey?style=for-the-badge
+
+[stars-url]: https://github.com/GluuFederation/agama-passkey/stargazers
+
+[issues-shield]: https://img.shields.io/github/issues/GluuFederation/agama-passkey.svg?style=for-the-badge
+
+[issues-url]: https://github.com/GluuFederation/agama-passkey/issues
+
+[license-shield]: https://img.shields.io/github/license/GluuFederation/agama-passkey.svg?style=for-the-badge
+
+[license-url]: https://github.com/GluuFederation/agama-passkey/blob/main/LICENSE
diff --git a/code/README.md b/code/README.md
@@ -0,0 +1 @@
+### Web folder
diff --git a/code/org.gluu.agama.passkey.add.flow b/code/org.gluu.agama.passkey.add.flow
@@ -0,0 +1,35 @@
+Flow org.gluu.agama.passkey.add
+     Basepath ""
+     Inputs userData
+inum = userData.inum
+fidoEnroller = Call org.gluu.agama.passkey.enroll.FidoEnroller#new 
+obj = { attestation: "{}", isAttestation: false, showError: false, errorTitle: "", errorMessage: "" }
+Repeat 50 times max
+     addDeviceForm = RRF "passkey-add.ftlh" obj
+     When addDeviceForm.addPasskeyBtn is ""
+          detestable = Call fidoEnroller getAttestationMessage inum
+          obj.isAttestation = true
+          obj.attestation = detestable
+          obj.showError = false
+     When addDeviceForm.skipped is "skipped"
+          obj.isAttestation = false
+          obj.showError = true
+          obj.errorTitle = "Passkey registration failed."
+          obj.errorMessage = addDeviceForm.errorMessage
+     When addDeviceForm.tokenResponse is not ""
+          key | E = Call fidoEnroller verifyRegistration inum addDeviceForm.tokenResponse
+          When E is null and key is not null
+               nicknameTrigger = Trigger org.gluu.agama.passkey.nickname key userData
+               obj.isAttestation = false
+               it_lyocp = {success:true, data: { userId: inum, response: nicknameTrigger }}
+               Finish it_lyocp
+          When E is not null
+               obj.isAttestation = false
+               obj.showError = true
+               obj.errorTitle = "Passkey registration failed."
+               obj.errorMessage = E.message
+     When addDeviceForm.cancelBtn is ""
+          it_bksml = {success:false, error: "Cancel event"}
+          Finish it_bksml
+it_zodfn = {success:false, error: "Passkey registration attempt exceeded."}
+Finish it_zodfn