From: Loïc Collignon Date: Mon, 18 Dec 2017 09:23:02 +0000 (+0100) Subject: remove obsolete description from readme X-Git-Tag: 4.99.5~4 X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=commitdiff_plain;h=1ea091379abc654e6d5f66320dc930877fb27ba8;p=apps%2Fagl-service-data-persistence.git remove obsolete description from readme Change-Id: Ia529a09deed894551f31bf74850e1d3f3f6f1b7c Signed-off-by: Loïc Collignon --- diff --git a/README.md b/README.md index 5fee4cc..1d1a1e8 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,2 @@ -# agl-identity +# agl-service-data-persistence -## Binding - -This binding provide the following API: -* `login`: Try to login the specified identity. -* `logout`: Try to logout the specified identity. -* `open_session`: Try to authenticate an identity using PAM. -* `close_session`: Try to close an opened session. -* `set_data`: Store a json for an identity/application pair. -* `get_data`: Get a json for an identity/application pair. - -# PAM's module - -This binding make use of PAM to authenticate a user. -A sample PAM module is provided, but you can write your own to allow different authentication workflows. - -The sample module assume there is a `identity.json` file located at the root of an usb-stick. When the user plug-in the key, an udev's rule notify the binding and make a call to the `pam_auth` verb. The binding will then call the PAM module to authenticate the user. The sample PAM module will mount and read the file and open a session if the identity is valid. - -When the user unplug the usb-stick, udev will notify the binding which will close the session. - -# Udev's rules - -The sample PAM module work with usb-stick. In order to detect plug and unplug action, some udev's rules are required.