summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2017-09-19 12:16:42 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2017-10-09 14:08:29 +0200
commit15d0dae1cd6ab982137a7c2848de9303a9c969f0 (patch)
treeba156b222ae058c8f0120def427f0abf3564190c /docs
parent33e615ea0cc26131532f4615ef4a2034488fa48e (diff)
Add function 'afb_req_get_application_id'
This function is intended to return an identifier of the calling application. At this time, the identifier is just derived from the application id but it can be changed in the future. Change-Id: Idacde8979ac5bb525352de9cab19e3fc1ed48627 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'docs')
-rw-r--r--docs/afb-binding-references.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/docs/afb-binding-references.md b/docs/afb-binding-references.md
index f5ab66d1..185f3ef4 100644
--- a/docs/afb-binding-references.md
+++ b/docs/afb-binding-references.md
@@ -694,11 +694,11 @@ Instead, you should use the macros:
void afb_req_verbose(struct afb_req req, int level, const char *file, int line, const char * func, const char *fmt, ...);
```
-The function below allows a binding to check whether a client
-has a permission of not.
+The functions below allow a binding involved in the platform security
+to explicitely check a permission of a client or to get the calling
+application identity.
```C
-
/*
* Check whether the 'permission' is granted or not to the client
* identified by 'req'.
@@ -706,6 +706,18 @@ has a permission of not.
* Returns 1 if the permission is granted or 0 otherwise.
*/
int afb_req_has_permission(struct afb_req req, const char *permission);
+
+/*
+ * Get the application identifier of the client application for the
+ * request 'req'.
+ *
+ * Returns the application identifier or NULL when the application
+ * can not be identified.
+ *
+ * The returned value if not NULL must be freed by the caller
+ */
+inline char *afb_req_get_application_id(struct afb_req req);
+
```
## Logging macros