From 459396440bf35ace1046723a8efab9a9c22629bf Mon Sep 17 00:00:00 2001 From: José Bollo Date: Sat, 28 May 2016 18:52:26 +0200 Subject: improve naming of sample plugins MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I81cbb40c937bc087079d1605d163aea968bb9250 Signed-off-by: José Bollo --- plugins/CMakeLists.txt | 1 - plugins/samples/AuthLogin.c | 129 +++++++++++++++++++++++++++++++++ plugins/samples/CMakeLists.txt | 49 +++++++++---- plugins/samples/ClientCtx.c | 160 ----------------------------------------- plugins/samples/ClientLogin.c | 129 --------------------------------- plugins/samples/DemoContext.c | 160 +++++++++++++++++++++++++++++++++++++++++ plugins/samples/DemoPost.c | 100 ++++++++++++++++++++++++++ plugins/samples/SamplePost.c | 100 -------------------------- plugins/session/CMakeLists.txt | 10 --- plugins/session/export.map | 1 - plugins/session/token-api.c | 127 -------------------------------- 11 files changed, 426 insertions(+), 540 deletions(-) create mode 100644 plugins/samples/AuthLogin.c delete mode 100644 plugins/samples/ClientCtx.c delete mode 100644 plugins/samples/ClientLogin.c create mode 100644 plugins/samples/DemoContext.c create mode 100644 plugins/samples/DemoPost.c delete mode 100644 plugins/samples/SamplePost.c delete mode 100644 plugins/session/CMakeLists.txt delete mode 100644 plugins/session/export.map delete mode 100644 plugins/session/token-api.c (limited to 'plugins') diff --git a/plugins/CMakeLists.txt b/plugins/CMakeLists.txt index 5f830fb1..c8928b53 100644 --- a/plugins/CMakeLists.txt +++ b/plugins/CMakeLists.txt @@ -1,4 +1,3 @@ -ADD_SUBDIRECTORY(session) ADD_SUBDIRECTORY(samples) ADD_SUBDIRECTORY(audio) ADD_SUBDIRECTORY(radio) diff --git a/plugins/samples/AuthLogin.c b/plugins/samples/AuthLogin.c new file mode 100644 index 00000000..efecf240 --- /dev/null +++ b/plugins/samples/AuthLogin.c @@ -0,0 +1,129 @@ +/* + * Copyright (C) 2015, 2016 "IoT.bzh" + * Author "Fulup Ar Foll" + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#define _GNU_SOURCE +#include +#include + +#include + +// Dummy sample of Client Application Context +typedef struct { + int something; + void *whateveryouwant; +} MyClientApplicationHandle; + + +// This function is call when Client Session Context is removed +// Note: when freeCtxCB==NULL standard free/malloc is called +static void clientContextFree(void *context) { + fprintf (stderr,"Plugin[token] Closing Session\n"); + free (context); +} + +// Request Creation of new context if it does not exist +static void clientContextConnect (struct afb_req request) +{ + json_object *jresp; + + // add an application specific client context to session + afb_req_context_set(request, malloc (sizeof (MyClientApplicationHandle)), clientContextFree); + + // do something intelligent to check if we should or not update level of assurance from 0(anonymous) to 1(logged) + afb_req_session_set_LOA(request, 1); + + // Send response to UI + jresp = json_object_new_object(); + json_object_object_add(jresp, "token", json_object_new_string ("A New Token and Session Context Was Created")); + + afb_req_success(request, jresp, NULL); + +} + +// Before entering here token will be check and renew +static void clientContextRefresh (struct afb_req request) { + json_object *jresp; + + + jresp = json_object_new_object(); + json_object_object_add(jresp, "token", json_object_new_string ("Token was refreshed")); + + afb_req_success(request, jresp, NULL); +} + + +// Session token will we verified before entering here +static void clientContextCheck (struct afb_req request) { + + json_object *jresp = json_object_new_object(); + json_object_object_add(jresp, "isvalid", json_object_new_boolean (TRUE)); + + afb_req_success(request, jresp, NULL); +} + + +// Close and Free context +static void clientContextLogout (struct afb_req request) { + json_object *jresp; + + /* after this call token will be reset + * - no further access to API will be possible + * - every context from any used plugin will be freed + */ + + jresp = json_object_new_object(); + json_object_object_add(jresp, "info", json_object_new_string ("Token and all resources are released")); + + // WARNING: if you free context resource manually here do not forget to set *request.context=NULL; + afb_req_success(request, jresp, NULL); + + afb_req_session_set_LOA(request, 0); +} +// Close and Free context +static void clientGetPing (struct afb_req request) { + static int count=0; + json_object *jresp; + + jresp = json_object_new_object(); + json_object_object_add(jresp, "count", json_object_new_int (count ++)); + + afb_req_success(request, jresp, NULL); +} + + +static const struct AFB_verb_desc_v1 verbs[]= { + {"ping" , AFB_SESSION_NONE , clientGetPing ,"Ping Rest Test Service"}, + {"connect" , AFB_SESSION_LOA_EQ_0 | AFB_SESSION_RENEW, clientContextConnect,"Connect/Login Client"}, + {"refresh" , AFB_SESSION_LOA_GE_1 | AFB_SESSION_RENEW, clientContextRefresh,"Refresh Client Authentication Token"}, + {"check" , AFB_SESSION_LOA_GE_1 , clientContextCheck ,"Check Client Authentication Token"}, + {"logout" , AFB_SESSION_LOA_GE_1 | AFB_SESSION_CLOSE, clientContextLogout ,"Logout Client and Free resources"}, + {NULL} +}; + +static const struct AFB_plugin plugin_desc = { + .type = AFB_PLUGIN_VERSION_1, + .v1 = { + .info = "Application Framework Binder Authentication sample", + .prefix = "auth", + .verbs = verbs + } +}; + +const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *itf) +{ + return &plugin_desc; +} diff --git a/plugins/samples/CMakeLists.txt b/plugins/samples/CMakeLists.txt index 9f600c82..eb6e0112 100644 --- a/plugins/samples/CMakeLists.txt +++ b/plugins/samples/CMakeLists.txt @@ -1,33 +1,57 @@ INCLUDE_DIRECTORIES(${include_dirs}) -ADD_LIBRARY(helloWorld-api MODULE HelloWorld.c) -SET_TARGET_PROPERTIES(helloWorld-api PROPERTIES +################################################## +# AuthLogin +################################################## +ADD_LIBRARY(authLogin MODULE AuthLogin.c) +SET_TARGET_PROPERTIES(authLogin PROPERTIES PREFIX "" LINK_FLAGS "-Wl,--version-script=${CMAKE_CURRENT_SOURCE_DIR}/export.map" ) -TARGET_LINK_LIBRARIES(helloWorld-api ${link_libraries}) -INSTALL(TARGETS helloWorld-api +TARGET_LINK_LIBRARIES(authLogin ${link_libraries}) +INSTALL(TARGETS authLogin LIBRARY DESTINATION ${plugin_install_dir}) -ADD_LIBRARY(samplePost-api MODULE SamplePost.c) -SET_TARGET_PROPERTIES(samplePost-api PROPERTIES +################################################## +# DemoContext +################################################## +ADD_LIBRARY(demoContext MODULE DemoContext.c) +SET_TARGET_PROPERTIES(demoContext PROPERTIES PREFIX "" LINK_FLAGS "-Wl,--version-script=${CMAKE_CURRENT_SOURCE_DIR}/export.map" ) -TARGET_LINK_LIBRARIES(samplePost-api ${link_libraries}) -INSTALL(TARGETS samplePost-api +TARGET_LINK_LIBRARIES(demoContext ${link_libraries}) +INSTALL(TARGETS demoContext LIBRARY DESTINATION ${plugin_install_dir}) -ADD_LIBRARY(clientCtx-api MODULE ClientCtx.c) -SET_TARGET_PROPERTIES(clientCtx-api PROPERTIES +################################################## +# DemoPost +################################################## +ADD_LIBRARY(demoPost MODULE DemoPost.c) +SET_TARGET_PROPERTIES(demoPost PROPERTIES PREFIX "" LINK_FLAGS "-Wl,--version-script=${CMAKE_CURRENT_SOURCE_DIR}/export.map" ) -TARGET_LINK_LIBRARIES(clientCtx-api ${link_libraries}) -INSTALL(TARGETS clientCtx-api +TARGET_LINK_LIBRARIES(demoPost ${link_libraries}) +INSTALL(TARGETS demoPost LIBRARY DESTINATION ${plugin_install_dir}) +################################################## +# HelloWorld +################################################## +ADD_LIBRARY(helloWorld MODULE HelloWorld.c) +SET_TARGET_PROPERTIES(helloWorld PROPERTIES + PREFIX "" + LINK_FLAGS "-Wl,--version-script=${CMAKE_CURRENT_SOURCE_DIR}/export.map" +) +TARGET_LINK_LIBRARIES(helloWorld ${link_libraries}) +INSTALL(TARGETS helloWorld + LIBRARY DESTINATION ${plugin_install_dir}) + +################################################## +# tic-tac-toe +################################################## ADD_LIBRARY(tic-tac-toe MODULE tic-tac-toe.c) SET_TARGET_PROPERTIES(tic-tac-toe PROPERTIES PREFIX "" @@ -36,3 +60,4 @@ SET_TARGET_PROPERTIES(tic-tac-toe PROPERTIES TARGET_LINK_LIBRARIES(tic-tac-toe ${link_libraries}) INSTALL(TARGETS tic-tac-toe LIBRARY DESTINATION ${plugin_install_dir}) + diff --git a/plugins/samples/ClientCtx.c b/plugins/samples/ClientCtx.c deleted file mode 100644 index ef703759..00000000 --- a/plugins/samples/ClientCtx.c +++ /dev/null @@ -1,160 +0,0 @@ -/* - * Copyright (C) 2015, 2016 "IoT.bzh" - * Author "Fulup Ar Foll" - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#define _GNU_SOURCE -#include -#include - -#include - -typedef struct { - /* - * client context is attached a session but private to a each plugin. - * Context is passed to each API under request->context - * - * Note: - * -client context is free when a session is closed. Developer should not - * forget that even if context is private to each plugin, session is unique - * to a client. When session close, every plugin are notified to free there - * private context. - * -by default standard "free" function from libc is used to free context. - * Developer may define it own under plugin->freeCB. This call received - * FreeCtxCb(void *ClientCtx, void*PluginHandle, char*SessionUUID) if - * FreeCtxCb=(void*)-1 then context wont be free by session manager. - * -when an API use AFB_SESSION_RESET this close the session and each plugin - * will be notified to free ressources. - */ - - int count; - char *abcd; - -} MyClientContextT; - -// This function is call at session open time. Any client trying to -// call it with an already open session will be denied. -// Ex: http://localhost:1234/api/context/create?token=123456789 -static void myCreate (struct afb_req request) -{ - MyClientContextT *ctx = malloc (sizeof (MyClientContextT)); - - // store something in our plugin private client context - ctx->count = 0; - ctx->abcd = "SomeThingUseful"; - - afb_req_context_set(request, ctx, free); - afb_req_success_f(request, NULL, "SUCCESS: create client context for plugin [%s]", ctx->abcd); -} - -// This function can only be called with a valid token. Token should be renew before -// session timeout a standard renew api is avaliable at /api/token/renew this API -// can be called automatically with HTML5 widget. -// ex: http://localhost:1234/api/context/action?token=xxxxxx-xxxxxx-xxxxx-xxxxx-xxxxxx -static void myAction (struct afb_req request) -{ - MyClientContextT *ctx = (MyClientContextT*) afb_req_context_get(request); - - // store something in our plugin private client context - ctx->count++; - afb_req_success_f(request, NULL, "SUCCESS: plugin [%s] Check=[%d]\n", ctx->abcd, ctx->count); -} - -// After execution of this function, client session will be close and if they -// created a context [request->context != NULL] every plugins will be notified -// that they should free context resources. -// ex: http://localhost:1234/api/context/close?token=xxxxxx-xxxxxx-xxxxx-xxxxx-xxxxxx -static void myClose (struct afb_req request) -{ - MyClientContextT *ctx = (MyClientContextT*) afb_req_context_get(request); - - // store something in our plugin private client context - ctx->count++; - afb_req_success_f(request, NULL, "SUCCESS: plugin [%s] Close=[%d]\n", ctx->abcd, ctx->count); -} - -// Set the LOA -static void setLOA(struct afb_req request, unsigned loa) -{ - if (afb_req_session_set_LOA(request, loa)) - afb_req_success_f(request, NULL, "loa set to %u", loa); - else - afb_req_fail_f(request, "failed", "can't set loa to %u", loa); -} - -static void clientSetLOA0(struct afb_req request) -{ - setLOA(request, 0); -} - -static void clientSetLOA1(struct afb_req request) -{ - setLOA(request, 1); -} - -static void clientSetLOA2(struct afb_req request) -{ - setLOA(request, 2); -} - -static void clientSetLOA3(struct afb_req request) -{ - setLOA(request, 3); -} - -static void clientCheckLOA(struct afb_req request) -{ - afb_req_success(request, NULL, "LOA checked and okay"); -} - -// NOTE: this sample does not use session to keep test a basic as possible -// in real application most APIs should be protected with AFB_SESSION_CHECK -static const struct AFB_verb_desc_v1 verbs[]= { - {"create", AFB_SESSION_CREATE, myCreate , "Create a new session"}, - {"action", AFB_SESSION_CHECK , myAction , "Use Session Context"}, - {"close" , AFB_SESSION_CLOSE , myClose , "Free Context"}, - {"set_loa_0", AFB_SESSION_RENEW, clientSetLOA0 ,"Set level of assurance to 0"}, - {"set_loa_1", AFB_SESSION_RENEW, clientSetLOA1 ,"Set level of assurance to 1"}, - {"set_loa_2", AFB_SESSION_RENEW, clientSetLOA2 ,"Set level of assurance to 2"}, - {"set_loa_3", AFB_SESSION_RENEW, clientSetLOA3 ,"Set level of assurance to 3"}, - {"check_loa_ge_0", AFB_SESSION_LOA_GE_0, clientCheckLOA ,"Check whether level of assurance is greater or equal to 0"}, - {"check_loa_ge_1", AFB_SESSION_LOA_GE_1, clientCheckLOA ,"Check whether level of assurance is greater or equal to 1"}, - {"check_loa_ge_2", AFB_SESSION_LOA_GE_2, clientCheckLOA ,"Check whether level of assurance is greater or equal to 2"}, - {"check_loa_ge_3", AFB_SESSION_LOA_GE_3, clientCheckLOA ,"Check whether level of assurance is greater or equal to 3"}, - {"check_loa_le_0", AFB_SESSION_LOA_LE_0, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 0"}, - {"check_loa_le_1", AFB_SESSION_LOA_LE_1, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 1"}, - {"check_loa_le_2", AFB_SESSION_LOA_LE_2, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 2"}, - {"check_loa_le_3", AFB_SESSION_LOA_LE_3, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 3"}, - {"check_loa_eq_0", AFB_SESSION_LOA_EQ_0, clientCheckLOA ,"Check whether level of assurance is equal to 0"}, - {"check_loa_eq_1", AFB_SESSION_LOA_EQ_1, clientCheckLOA ,"Check whether level of assurance is equal to 1"}, - {"check_loa_eq_2", AFB_SESSION_LOA_EQ_2, clientCheckLOA ,"Check whether level of assurance is equal to 2"}, - {"check_loa_eq_3", AFB_SESSION_LOA_EQ_3, clientCheckLOA ,"Check whether level of assurance is equal to 3"}, - {NULL} -}; - -static const struct AFB_plugin plugin_desc = { - .type = AFB_PLUGIN_VERSION_1, - .v1 = { - .info = "Sample of Client Context Usage", - .prefix = "context", - .verbs = verbs, - } -}; - -const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *itf) -{ - return &plugin_desc; -} - diff --git a/plugins/samples/ClientLogin.c b/plugins/samples/ClientLogin.c deleted file mode 100644 index efecf240..00000000 --- a/plugins/samples/ClientLogin.c +++ /dev/null @@ -1,129 +0,0 @@ -/* - * Copyright (C) 2015, 2016 "IoT.bzh" - * Author "Fulup Ar Foll" - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#define _GNU_SOURCE -#include -#include - -#include - -// Dummy sample of Client Application Context -typedef struct { - int something; - void *whateveryouwant; -} MyClientApplicationHandle; - - -// This function is call when Client Session Context is removed -// Note: when freeCtxCB==NULL standard free/malloc is called -static void clientContextFree(void *context) { - fprintf (stderr,"Plugin[token] Closing Session\n"); - free (context); -} - -// Request Creation of new context if it does not exist -static void clientContextConnect (struct afb_req request) -{ - json_object *jresp; - - // add an application specific client context to session - afb_req_context_set(request, malloc (sizeof (MyClientApplicationHandle)), clientContextFree); - - // do something intelligent to check if we should or not update level of assurance from 0(anonymous) to 1(logged) - afb_req_session_set_LOA(request, 1); - - // Send response to UI - jresp = json_object_new_object(); - json_object_object_add(jresp, "token", json_object_new_string ("A New Token and Session Context Was Created")); - - afb_req_success(request, jresp, NULL); - -} - -// Before entering here token will be check and renew -static void clientContextRefresh (struct afb_req request) { - json_object *jresp; - - - jresp = json_object_new_object(); - json_object_object_add(jresp, "token", json_object_new_string ("Token was refreshed")); - - afb_req_success(request, jresp, NULL); -} - - -// Session token will we verified before entering here -static void clientContextCheck (struct afb_req request) { - - json_object *jresp = json_object_new_object(); - json_object_object_add(jresp, "isvalid", json_object_new_boolean (TRUE)); - - afb_req_success(request, jresp, NULL); -} - - -// Close and Free context -static void clientContextLogout (struct afb_req request) { - json_object *jresp; - - /* after this call token will be reset - * - no further access to API will be possible - * - every context from any used plugin will be freed - */ - - jresp = json_object_new_object(); - json_object_object_add(jresp, "info", json_object_new_string ("Token and all resources are released")); - - // WARNING: if you free context resource manually here do not forget to set *request.context=NULL; - afb_req_success(request, jresp, NULL); - - afb_req_session_set_LOA(request, 0); -} -// Close and Free context -static void clientGetPing (struct afb_req request) { - static int count=0; - json_object *jresp; - - jresp = json_object_new_object(); - json_object_object_add(jresp, "count", json_object_new_int (count ++)); - - afb_req_success(request, jresp, NULL); -} - - -static const struct AFB_verb_desc_v1 verbs[]= { - {"ping" , AFB_SESSION_NONE , clientGetPing ,"Ping Rest Test Service"}, - {"connect" , AFB_SESSION_LOA_EQ_0 | AFB_SESSION_RENEW, clientContextConnect,"Connect/Login Client"}, - {"refresh" , AFB_SESSION_LOA_GE_1 | AFB_SESSION_RENEW, clientContextRefresh,"Refresh Client Authentication Token"}, - {"check" , AFB_SESSION_LOA_GE_1 , clientContextCheck ,"Check Client Authentication Token"}, - {"logout" , AFB_SESSION_LOA_GE_1 | AFB_SESSION_CLOSE, clientContextLogout ,"Logout Client and Free resources"}, - {NULL} -}; - -static const struct AFB_plugin plugin_desc = { - .type = AFB_PLUGIN_VERSION_1, - .v1 = { - .info = "Application Framework Binder Authentication sample", - .prefix = "auth", - .verbs = verbs - } -}; - -const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *itf) -{ - return &plugin_desc; -} diff --git a/plugins/samples/DemoContext.c b/plugins/samples/DemoContext.c new file mode 100644 index 00000000..ef703759 --- /dev/null +++ b/plugins/samples/DemoContext.c @@ -0,0 +1,160 @@ +/* + * Copyright (C) 2015, 2016 "IoT.bzh" + * Author "Fulup Ar Foll" + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#define _GNU_SOURCE +#include +#include + +#include + +typedef struct { + /* + * client context is attached a session but private to a each plugin. + * Context is passed to each API under request->context + * + * Note: + * -client context is free when a session is closed. Developer should not + * forget that even if context is private to each plugin, session is unique + * to a client. When session close, every plugin are notified to free there + * private context. + * -by default standard "free" function from libc is used to free context. + * Developer may define it own under plugin->freeCB. This call received + * FreeCtxCb(void *ClientCtx, void*PluginHandle, char*SessionUUID) if + * FreeCtxCb=(void*)-1 then context wont be free by session manager. + * -when an API use AFB_SESSION_RESET this close the session and each plugin + * will be notified to free ressources. + */ + + int count; + char *abcd; + +} MyClientContextT; + +// This function is call at session open time. Any client trying to +// call it with an already open session will be denied. +// Ex: http://localhost:1234/api/context/create?token=123456789 +static void myCreate (struct afb_req request) +{ + MyClientContextT *ctx = malloc (sizeof (MyClientContextT)); + + // store something in our plugin private client context + ctx->count = 0; + ctx->abcd = "SomeThingUseful"; + + afb_req_context_set(request, ctx, free); + afb_req_success_f(request, NULL, "SUCCESS: create client context for plugin [%s]", ctx->abcd); +} + +// This function can only be called with a valid token. Token should be renew before +// session timeout a standard renew api is avaliable at /api/token/renew this API +// can be called automatically with HTML5 widget. +// ex: http://localhost:1234/api/context/action?token=xxxxxx-xxxxxx-xxxxx-xxxxx-xxxxxx +static void myAction (struct afb_req request) +{ + MyClientContextT *ctx = (MyClientContextT*) afb_req_context_get(request); + + // store something in our plugin private client context + ctx->count++; + afb_req_success_f(request, NULL, "SUCCESS: plugin [%s] Check=[%d]\n", ctx->abcd, ctx->count); +} + +// After execution of this function, client session will be close and if they +// created a context [request->context != NULL] every plugins will be notified +// that they should free context resources. +// ex: http://localhost:1234/api/context/close?token=xxxxxx-xxxxxx-xxxxx-xxxxx-xxxxxx +static void myClose (struct afb_req request) +{ + MyClientContextT *ctx = (MyClientContextT*) afb_req_context_get(request); + + // store something in our plugin private client context + ctx->count++; + afb_req_success_f(request, NULL, "SUCCESS: plugin [%s] Close=[%d]\n", ctx->abcd, ctx->count); +} + +// Set the LOA +static void setLOA(struct afb_req request, unsigned loa) +{ + if (afb_req_session_set_LOA(request, loa)) + afb_req_success_f(request, NULL, "loa set to %u", loa); + else + afb_req_fail_f(request, "failed", "can't set loa to %u", loa); +} + +static void clientSetLOA0(struct afb_req request) +{ + setLOA(request, 0); +} + +static void clientSetLOA1(struct afb_req request) +{ + setLOA(request, 1); +} + +static void clientSetLOA2(struct afb_req request) +{ + setLOA(request, 2); +} + +static void clientSetLOA3(struct afb_req request) +{ + setLOA(request, 3); +} + +static void clientCheckLOA(struct afb_req request) +{ + afb_req_success(request, NULL, "LOA checked and okay"); +} + +// NOTE: this sample does not use session to keep test a basic as possible +// in real application most APIs should be protected with AFB_SESSION_CHECK +static const struct AFB_verb_desc_v1 verbs[]= { + {"create", AFB_SESSION_CREATE, myCreate , "Create a new session"}, + {"action", AFB_SESSION_CHECK , myAction , "Use Session Context"}, + {"close" , AFB_SESSION_CLOSE , myClose , "Free Context"}, + {"set_loa_0", AFB_SESSION_RENEW, clientSetLOA0 ,"Set level of assurance to 0"}, + {"set_loa_1", AFB_SESSION_RENEW, clientSetLOA1 ,"Set level of assurance to 1"}, + {"set_loa_2", AFB_SESSION_RENEW, clientSetLOA2 ,"Set level of assurance to 2"}, + {"set_loa_3", AFB_SESSION_RENEW, clientSetLOA3 ,"Set level of assurance to 3"}, + {"check_loa_ge_0", AFB_SESSION_LOA_GE_0, clientCheckLOA ,"Check whether level of assurance is greater or equal to 0"}, + {"check_loa_ge_1", AFB_SESSION_LOA_GE_1, clientCheckLOA ,"Check whether level of assurance is greater or equal to 1"}, + {"check_loa_ge_2", AFB_SESSION_LOA_GE_2, clientCheckLOA ,"Check whether level of assurance is greater or equal to 2"}, + {"check_loa_ge_3", AFB_SESSION_LOA_GE_3, clientCheckLOA ,"Check whether level of assurance is greater or equal to 3"}, + {"check_loa_le_0", AFB_SESSION_LOA_LE_0, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 0"}, + {"check_loa_le_1", AFB_SESSION_LOA_LE_1, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 1"}, + {"check_loa_le_2", AFB_SESSION_LOA_LE_2, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 2"}, + {"check_loa_le_3", AFB_SESSION_LOA_LE_3, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 3"}, + {"check_loa_eq_0", AFB_SESSION_LOA_EQ_0, clientCheckLOA ,"Check whether level of assurance is equal to 0"}, + {"check_loa_eq_1", AFB_SESSION_LOA_EQ_1, clientCheckLOA ,"Check whether level of assurance is equal to 1"}, + {"check_loa_eq_2", AFB_SESSION_LOA_EQ_2, clientCheckLOA ,"Check whether level of assurance is equal to 2"}, + {"check_loa_eq_3", AFB_SESSION_LOA_EQ_3, clientCheckLOA ,"Check whether level of assurance is equal to 3"}, + {NULL} +}; + +static const struct AFB_plugin plugin_desc = { + .type = AFB_PLUGIN_VERSION_1, + .v1 = { + .info = "Sample of Client Context Usage", + .prefix = "context", + .verbs = verbs, + } +}; + +const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *itf) +{ + return &plugin_desc; +} + diff --git a/plugins/samples/DemoPost.c b/plugins/samples/DemoPost.c new file mode 100644 index 00000000..b61b91c4 --- /dev/null +++ b/plugins/samples/DemoPost.c @@ -0,0 +1,100 @@ +/* + * Copyright (C) 2015, 2016 "IoT.bzh" + * Author "Fulup Ar Foll" + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#define _GNU_SOURCE +#include +#include +#include + +#include + + +// Sample Generic Ping Debug API +static void getPingTest(struct afb_req request) +{ + static int pingcount = 0; + json_object *query = afb_req_json(request); + + afb_req_success_f(request, query, "Ping Binder Daemon count=%d", ++pingcount); +} + +// With content-type=json data are directly avaliable in request->post->data +static void GetJsonByPost (struct afb_req request) +{ + struct afb_arg arg; + json_object* jresp; + json_object *query = afb_req_json(request); + + arg = afb_req_get(request, ""); + jresp = arg.value ? json_tokener_parse(arg.value) : NULL; + afb_req_success_f(request, jresp, "GetJsonByPost query={%s}", json_object_to_json_string(query)); +} + +// Upload a file and execute a function when upload is done +static void Uploads (struct afb_req request, const char *destination) +{ + struct afb_arg a = afb_req_get(request, "file"); + if (a.value == NULL || *a.value == 0) + afb_req_fail(request, "failed", "no file selected"); + else + afb_req_success_f(request, NULL, "uploaded file %s of path %s for destination %s", a.value, a.path, destination); +} + +// Upload a file and execute a function when upload is done +static void UploadAppli (struct afb_req request) +{ + Uploads(request, "applications"); +} + +// Simples Upload case just upload a file +static void UploadMusic (struct afb_req request) +{ + Uploads(request, "musics"); +} + +// PostForm callback is called multiple times (one or each key within form, or once per file buffer) +// When file has been fully uploaded call is call with item==NULL +static void UploadImage (struct afb_req request) +{ + Uploads(request, "images"); +} + + +// NOTE: this sample does not use session to keep test a basic as possible +// in real application upload-xxx should be protected with AFB_SESSION_CHECK +static const struct AFB_verb_desc_v1 verbs[]= { + {"ping" , AFB_SESSION_NONE , getPingTest ,"Ping Rest Test Service"}, + {"upload-json" , AFB_SESSION_NONE , GetJsonByPost ,"Demo for Json Buffer on Post"}, + {"upload-image" , AFB_SESSION_NONE , UploadImage ,"Demo for file upload"}, + {"upload-music" , AFB_SESSION_NONE , UploadMusic ,"Demo for file upload"}, + {"upload-appli" , AFB_SESSION_NONE , UploadAppli ,"Demo for file upload"}, + {NULL} +}; + +static const struct AFB_plugin plugin_desc = { + .type = AFB_PLUGIN_VERSION_1, + .v1 = { + .info = "Sample with Post Upload Files", + .prefix = "post", + .verbs = verbs + } +}; + +const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *itf) +{ + return &plugin_desc; +}; diff --git a/plugins/samples/SamplePost.c b/plugins/samples/SamplePost.c deleted file mode 100644 index b61b91c4..00000000 --- a/plugins/samples/SamplePost.c +++ /dev/null @@ -1,100 +0,0 @@ -/* - * Copyright (C) 2015, 2016 "IoT.bzh" - * Author "Fulup Ar Foll" - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#define _GNU_SOURCE -#include -#include -#include - -#include - - -// Sample Generic Ping Debug API -static void getPingTest(struct afb_req request) -{ - static int pingcount = 0; - json_object *query = afb_req_json(request); - - afb_req_success_f(request, query, "Ping Binder Daemon count=%d", ++pingcount); -} - -// With content-type=json data are directly avaliable in request->post->data -static void GetJsonByPost (struct afb_req request) -{ - struct afb_arg arg; - json_object* jresp; - json_object *query = afb_req_json(request); - - arg = afb_req_get(request, ""); - jresp = arg.value ? json_tokener_parse(arg.value) : NULL; - afb_req_success_f(request, jresp, "GetJsonByPost query={%s}", json_object_to_json_string(query)); -} - -// Upload a file and execute a function when upload is done -static void Uploads (struct afb_req request, const char *destination) -{ - struct afb_arg a = afb_req_get(request, "file"); - if (a.value == NULL || *a.value == 0) - afb_req_fail(request, "failed", "no file selected"); - else - afb_req_success_f(request, NULL, "uploaded file %s of path %s for destination %s", a.value, a.path, destination); -} - -// Upload a file and execute a function when upload is done -static void UploadAppli (struct afb_req request) -{ - Uploads(request, "applications"); -} - -// Simples Upload case just upload a file -static void UploadMusic (struct afb_req request) -{ - Uploads(request, "musics"); -} - -// PostForm callback is called multiple times (one or each key within form, or once per file buffer) -// When file has been fully uploaded call is call with item==NULL -static void UploadImage (struct afb_req request) -{ - Uploads(request, "images"); -} - - -// NOTE: this sample does not use session to keep test a basic as possible -// in real application upload-xxx should be protected with AFB_SESSION_CHECK -static const struct AFB_verb_desc_v1 verbs[]= { - {"ping" , AFB_SESSION_NONE , getPingTest ,"Ping Rest Test Service"}, - {"upload-json" , AFB_SESSION_NONE , GetJsonByPost ,"Demo for Json Buffer on Post"}, - {"upload-image" , AFB_SESSION_NONE , UploadImage ,"Demo for file upload"}, - {"upload-music" , AFB_SESSION_NONE , UploadMusic ,"Demo for file upload"}, - {"upload-appli" , AFB_SESSION_NONE , UploadAppli ,"Demo for file upload"}, - {NULL} -}; - -static const struct AFB_plugin plugin_desc = { - .type = AFB_PLUGIN_VERSION_1, - .v1 = { - .info = "Sample with Post Upload Files", - .prefix = "post", - .verbs = verbs - } -}; - -const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *itf) -{ - return &plugin_desc; -}; diff --git a/plugins/session/CMakeLists.txt b/plugins/session/CMakeLists.txt deleted file mode 100644 index e13a16b3..00000000 --- a/plugins/session/CMakeLists.txt +++ /dev/null @@ -1,10 +0,0 @@ - -ADD_LIBRARY(token-api MODULE token-api.c) -SET_TARGET_PROPERTIES(token-api PROPERTIES - PREFIX "" - LINK_FLAGS "-Wl,--version-script=${CMAKE_CURRENT_SOURCE_DIR}/export.map" -) -TARGET_LINK_LIBRARIES(token-api ${link_libraries}) -INCLUDE_DIRECTORIES(${include_dirs}) -INSTALL(TARGETS token-api - LIBRARY DESTINATION ${plugin_install_dir}) diff --git a/plugins/session/export.map b/plugins/session/export.map deleted file mode 100644 index e2da85ca..00000000 --- a/plugins/session/export.map +++ /dev/null @@ -1 +0,0 @@ -{ global: pluginAfbV1Register; local: *; }; diff --git a/plugins/session/token-api.c b/plugins/session/token-api.c deleted file mode 100644 index d550c20d..00000000 --- a/plugins/session/token-api.c +++ /dev/null @@ -1,127 +0,0 @@ -/* - * Copyright (C) 2015, 2016 "IoT.bzh" - * Author "Fulup Ar Foll" - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#define _GNU_SOURCE -#include -#include - -#include - -// Dummy sample of Client Application Context -typedef struct { - int something; - void *whateveryouwant; -} MyClientApplicationHandle; - - -// This function is call when Client Session Context is removed -// Note: when freeCtxCB==NULL standard free/malloc is called -static void clientContextFree(void *context) { - fprintf (stderr,"Plugin[token] Closing Session\n"); - free (context); -} - -// Request Creation of new context if it does not exist -static void clientContextLogin (struct afb_req request) -{ - json_object *jresp; - - // add an application specific client context to session - afb_req_context_set(request, malloc (sizeof (MyClientApplicationHandle)), clientContextFree); - - // Send response to UI - jresp = json_object_new_object(); - json_object_object_add(jresp, "token", json_object_new_string ("A New Token and Session Context Was Created")); - - afb_req_success(request, jresp, NULL); - - afb_req_session_set_LOA(request, 1); -} - -// Before entering here token will be check and renew -static void clientContextRefresh (struct afb_req request) { - json_object *jresp; - - - jresp = json_object_new_object(); - json_object_object_add(jresp, "token", json_object_new_string ("Token was refreshed")); - - afb_req_success(request, jresp, NULL); -} - - -// Session token will we verified before entering here -static void clientContextCheck (struct afb_req request) { - - json_object *jresp = json_object_new_object(); - json_object_object_add(jresp, "isvalid", json_object_new_boolean (TRUE)); - - afb_req_success(request, jresp, NULL); -} - - -// Close and Free context -static void clientContextLogout (struct afb_req request) { - json_object *jresp; - - /* after this call token will be reset - * - no further access to API will be possible - * - every context from any used plugin will be freed - */ - - jresp = json_object_new_object(); - json_object_object_add(jresp, "info", json_object_new_string ("Token and all resources are released")); - - // WARNING: if you free context resource manually here do not forget to set *request.context=NULL; - afb_req_success(request, jresp, NULL); - - afb_req_session_set_LOA(request, 0); -} -// Close and Free context -static void clientGetPing (struct afb_req request) { - static int count=0; - json_object *jresp; - - jresp = json_object_new_object(); - json_object_object_add(jresp, "count", json_object_new_int (count ++)); - - afb_req_success(request, jresp, NULL); -} - - -static const struct AFB_verb_desc_v1 verbs[]= { - {"ping" , AFB_SESSION_NONE , clientGetPing ,"Ping Rest Test Service"}, - {"login" , AFB_SESSION_LOA_EQ_0 | AFB_SESSION_RENEW, clientContextLogin ,"Login Client"}, - {"refresh" , AFB_SESSION_LOA_GE_1 | AFB_SESSION_RENEW, clientContextRefresh,"Refresh Client Authentication Token"}, - {"check" , AFB_SESSION_LOA_GE_1 , clientContextCheck ,"Check Client Authentication Token"}, - {"logout" , AFB_SESSION_LOA_GE_1 | AFB_SESSION_CLOSE, clientContextLogout ,"Logout Client and Free resources"}, - {NULL} -}; - -static const struct AFB_plugin plugin_desc = { - .type = AFB_PLUGIN_VERSION_1, - .v1 = { - .info = "Application Framework Binder Authentication sample", - .prefix = "auth", - .verbs = verbs - } -}; - -const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *itf) -{ - return &plugin_desc; -} -- cgit 1.2.3-korg