experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

* Restructure and more generic plugin API (cli,backend,restconf,netconf)

Browse source 
* For preparation for authorization RFC8341
  * Plugins add clixon_plugin_init() and api struct for function pointers, eg:
```
static const struct clixon_plugin_api api = {
    "example",
    clixon_plugin_init,
    ...
}
clixon_plugin_api *clixon_plugin_init(clicon_handle h)
{
    return (void*)&api;
}
```
  * Moved specific plugin functions from apps/ to generic functions in lib/
    * New generic plugin load function: clixon_plugins_load()
  * Removed client-local netconf plugins netconf_plugin_callbacks()
    * This was code used before generic YANG rpc calls
  * Added username to clixon handle:
    * clicon_username_get() / clicon_username_set()
  * Added authentication plugin callback
  * Removed some obscure plugin code that seem not to be used (please report if needed!)
    * CLI parse hook
    * CLICON_FIND_PLUGIN
    * clicon_valcb()
* Removed username to rpc calls (added below)
This commit is contained in:
Olof hagsand 2018-04-02 10:38:53 +02:00
parent b8e35742b9
commit 79e3fbdaa9
41 changed files with 470 additions and 772 deletions
Download patch file Download diff file Expand all files Collapse all files

32
lib/src/clixon_handle.c
View file

@ -50,9 +50,9 @@
#include "clixon_queue.h"
#include "clixon_hash.h"
#include "clixon_handle.h"
#include "clixon_log.h"
#include "clixon_err.h"
#include "clixon_yang.h"
#include "clixon_plugin.h"
#include "clixon_options.h"
#define CLICON_MAGIC 0x99aafabe
@ -61,15 +61,19 @@
/*! Internal structure of basic handle. Also header of all other handles.
* @note If you change here, you must also change the structs below:
* @see struct cli_handle, struct backend_handle
* @see struct cli_handle
* @see struct backend_handle
*/
struct clicon_handle {
int ch_magic; /* magic (HDR) */
clicon_hash_t *ch_copt; /* clicon option list (HDR) */
clicon_hash_t *ch_data; /* internal clicon data (HDR) */
int ch_magic; /* magic (HDR) */
clicon_hash_t *ch_copt; /* clicon option list (HDR) */
clicon_hash_t *ch_data; /* internal clicon data (HDR) */
};
/*! Internal call to allocate a CLICON handle.
*
* @param[in] size Size of handle (internal) struct.
* @retval h Clicon handle
*
* There may be different variants of handles with some common options.
* So far the only common options is a MAGIC cookie for sanity checks and
@ -102,6 +106,7 @@ clicon_handle_init0(int size)
/*! Basic CLICON init functions returning a handle for API access.
*
* @retval h Clicon handle
* This is the first call to CLICON basic API which returns a handle to be
* used in the API functions. There are other clicon_init functions for more
* elaborate applications (cli/backend/netconf). This should be used by the most
@ -114,6 +119,7 @@ clicon_handle_init(void)
}
/*! Deallocate clicon handle, including freeing handle data.
* @param[in] h Clicon handle
* @Note: handle 'h' cannot be used in calls after this
*/
int
@ -131,9 +137,10 @@ clicon_handle_exit(clicon_handle h)
return 0;
}
/*
* Check struct magic number for sanity checks
* return 0 if OK, -1 if fail.
/*! Check struct magic number for sanity checks
* @param[in] h Clicon handle
* @retval 0 Sanity check OK
* @retval -1 Sanity check failed
*/
int
clicon_handle_check(clicon_handle h)
@ -144,8 +151,8 @@ clicon_handle_check(clicon_handle h)
return ch->ch_magic == CLICON_MAGIC ? 0 : -1;
}
/*
* Return clicon options (hash-array) given a handle.
/*! Return clicon options (hash-array) given a handle.
* @param[in] h Clicon handle
*/
clicon_hash_t *
clicon_options(clicon_handle h)
@ -155,8 +162,8 @@ clicon_options(clicon_handle h)
return ch->ch_copt;
}
/*
* Return clicon data (hash-array) given a handle.
/*! Return clicon data (hash-array) given a handle.
* @param[in] h Clicon handle
*/
clicon_hash_t *
clicon_data(clicon_handle h)
@ -165,4 +172,3 @@ clicon_data(clicon_handle h)
return ch->ch_data;
}