Skip to content

Commit ad93dc4

Browse files
committed
docs(agama-typekey): update agama typekey readme doc
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
1 parent 8f40295 commit ad93dc4

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
## About Agama-typekey
1010

11-
This repo is home to the Gluu Agama-typekey project. This project allows you to
12-
record behavioural keystroke data and use it as a second factor of authentication
11+
This repo is home to the Gluu Agama-typekey project. This project allows you to
12+
Record behavioral keystroke data and use it as a second factor of authentication
1313
by leveraging the Typekey API.
1414

1515

@@ -107,7 +107,7 @@ From the incoming authentication request, the Janssen Server reads the `ACR`
107107
parameter value to identify which authentication method should be used.
108108
To invoke the `org.gluu.agama.typekey` flow contained in the Agama-typekey project,
109109
specify the ACR value as `agama_<qualified-name-of-the-top-level-flow>`,
110-
i.e `agama_org.gluu.agama.typekey`.
110+
i.e `agama_org.gluu.agama.typekey`.
111111

112112

113113
## Customize and Make It Your Own
@@ -145,17 +145,22 @@ validate the provided keystroke data using the training data stored during
145145
enrollment. If the behavioral data is sufficiently different from the trained
146146
data, Typekey API will deny the request.
147147

148-
In case the Typekey API denies the request, Agama Typekey falls back to password
149-
authentication, and retrains the API on the provided data.
148+
In case the Typekey API denies the request, Agama Typekey falls back to password authentication, and retrains the API on the provided data.
150149

151150

152151
#### Parameter Details
153152

154-
- `keystoreName` and `keystorePassword` are optional, in case you want to include a signature when sending the Typekey data. Leave them as blank otherwise.
155-
- `orgId` is the organization ID that can be obtained by decoding the software statement JWT and looking at the `org_id` claim (you may use `https://jwt.io` to decode the SSA).
156-
- `scan_ssa` is the JWT string you obtain from Agama Lab.
157-
- `authHost` and `scanHost` can be left as is.
158-
- `phrases` is a dictionary of strings from which the phrase used for behavioral metrics is selected. The dictionary pairs must be in format `string:string` where keys are unique numbers in string format and values are unique phrases.
153+
154+
| Name | Description | Notes |
155+
| ----------------- | --------------------------------------------------------------------- | --------------------------------------- |
156+
| `keystoreName` | Optional name for the keystore if you want to include a signature when sending Typekey data. | Leave blank if not needed.|
157+
| `keystorePassword` | Optional password for the keystore for signature inclusion. | Leave blank if not needed.|
158+
| `orgId` | Organization ID obtained by decoding the software statement JWT.| Look for the org_id claim; use https://jwt.io to decode.|
159+
| `scan_ssa` | JWT string obtained from Agama Lab.| |
160+
| `authHost` | Host URL for authentication. | Can be left as is.|
161+
| `scanHost` | Host URL for scanning. | Can be left as is.|
162+
| `phrases` | Dictionary of strings for selecting phrases used in behavioral metrics. | Use format string:string with unique keys and values.|
163+
159164

160165

161166
## Demo
@@ -168,16 +173,16 @@ series for a quick demo on this flow.
168173

169174
*Note:*
170175
While the video shows how the flow works overall, it may be dated. Do check the
171-
[Test The Flow](#test-the-flow) section to understand the current
176+
[Test the Flow](#test-the-flow) section to understand the current
172177
method of passing the ACR parameter when invoking the flow.
173178

174-
Enrollment:
179+
### Enrollment
175180

176181
https://github.com/SafinWasi/agama-typekey/assets/6601566/2256877b-3b49-48d8-b292-3d9da4a3a4c5
177182

178183

179184

180-
Typekey API approval:
185+
### Typekey API approval
181186

182187

183188

@@ -186,7 +191,7 @@ https://github.com/SafinWasi/agama-typekey/assets/6601566/de5dcb19-9fbb-41f3-b89
186191

187192

188193

189-
Typekey API denied, fallback to password:
194+
### Typekey API denied, fallback to password
190195

191196

192197
https://github.com/SafinWasi/agama-typekey/assets/6601566/b0288f5c-6a84-4ea0-b6a4-ac9052409189

0 commit comments

Comments
 (0)