summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 18 insertions, 24 deletions
diff --git a/README.md b/README.md
index 4da3969..9942a16 100644
--- a/README.md
+++ b/README.md
@@ -9,14 +9,14 @@ Overview
The binding currently reads its configuration from a file.
-Then, it starts a GATT Bluetooth LE "User Data" service.
-
-When the email characteristic is written, the server is queried to
-get the data associated with the key (keytoken=...) for the
-current vehicle (vin=...). The key is the email value set.
-This is the login process.
-
-An event notifying that a user logged is sent to applications.
+When an NFC tag is detected, the server is queried to
+get the data associated with the key provided (keytoken=...) for
+the current vehicle (vin=...). This key is an alfanumeric value
+linked to the user.
+If this query is successful, the user is considered to be
+logged in. An event notifying that a new user logged in, is sent
+to the applications that registered an interest (i.e., this is not
+a broadcasted event).
The configuration file
----------------------
@@ -68,18 +68,6 @@ Not setting *idp* or *appli* implies that no token is queried.
Verbs of API
------------
-### agl-identity-agent/advise
-
-Starts offering service on BT interface (hci0).
-
-No argument needed.
-
-### agl-identity-agent/unadvise
-
-Stops offering service on BT interface (hci0).
-
-No argument needed.
-
### agl-identity-agent/subscribe
Subscribes to event notifications.
@@ -92,11 +80,12 @@ Unsubscribes from event notifications.
No argument needed.
-### agl-identity-agent/login
+### agl-identity-agent/fake-login
-Not implemented, always fails.
-
-No argument needed.
+Test identity agent interface sending login event to interested
+parties.
+This case allows to isolate the agent from the
+agl-service-nfc and oidc interface.
### agl-identity-agent/logout
@@ -104,6 +93,11 @@ Logout from the current identity.
No argument needed.
+### agl-identity-agent/fake-auth
+
+Test the identity agent functionality without the need for
+agl-service-nfc.
+
### agl-identity-agent/get
Returns the data for the current identity.