Diffusion C API 6.11.5
Loading...
Searching...
No Matches
security.h File Reference

Security feature. More...

Data Structures

struct  change_principal_handlers_s
 
struct  change_principal_params_s
 Structure supplied when issuing a change_principal() request. More...
 
struct  diffusion_get_global_permissions_params_s
 Structure supplied when issuing a diffusion_get_global_permissions request. More...
 
struct  diffusion_get_path_permissions_params_s
 Structure supplied when issuing a diffusion_get_path_permissions request. More...
 

Macros

#define CHANGE_PRINCIPAL_HANDLERS
 Structure holding callbacks to be invoked after a request to change the principal has been sent to and processed by Diffusion.
 

Typedefs

typedef int(* on_change_principal_cb) (SESSION_T *session, void *context)
 Callback indicating that a response has been received to a change principal request.
 
typedef int(* on_get_global_permissions_cb) (const SET_T *global_permissions, void *context)
 Callback for diffusion_get_global_permissions.
 
typedef int(* on_get_path_permissions_cb) (const SET_T *path_permissions, void *context)
 Callback for diffusion_get_path_permissions.
 
typedef struct change_principal_params_s CHANGE_PRINCIPAL_PARAMS_T
 Structure supplied when issuing a change_principal() request.
 
typedef struct diffusion_get_global_permissions_params_s DIFFUSION_GET_GLOBAL_PERMISSIONS_PARAMS_T
 Structure supplied when issuing a diffusion_get_global_permissions request.
 
typedef struct diffusion_get_path_permissions_params_s DIFFUSION_GET_PATH_PERMISSIONS_PARAMS_T
 Structure supplied when issuing a diffusion_get_path_permissions request.
 

Functions

void change_principal (SESSION_T *session, const CHANGE_PRINCIPAL_PARAMS_T params)
 Issue a request to change the principal for the current (active) session.
 
bool diffusion_get_global_permissions (SESSION_T *session, const DIFFUSION_GET_GLOBAL_PERMISSIONS_PARAMS_T params, DIFFUSION_API_ERROR *api_error)
 Query the global permissions assigned to the calling session.
 
bool diffusion_get_path_permissions (SESSION_T *session, const DIFFUSION_GET_PATH_PERMISSIONS_PARAMS_T params, DIFFUSION_API_ERROR *api_error)
 Query the path permissions assigned to the calling session on a given path.
 

Detailed Description

Security feature.

Typedef Documentation

◆ on_change_principal_cb

typedef int(* on_change_principal_cb) (SESSION_T *session, void *context)

Callback indicating that a response has been received to a change principal request.

Parameters
sessionThe current active session.
contextUser-supplied context from the original change_principal() call.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.

◆ on_get_global_permissions_cb

typedef int(* on_get_global_permissions_cb) (const SET_T *global_permissions, void *context)

Callback for diffusion_get_global_permissions.

Parameters
global_permissionsa SET_T containing GLOBAL_PERMISSIONS_Ts
contextUser-supplied context from the originating call.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.

◆ on_get_path_permissions_cb

typedef int(* on_get_path_permissions_cb) (const SET_T *path_permissions, void *context)

Callback for diffusion_get_path_permissions.

Since
6.5
Parameters
path_permissionsa SET_T containing PATH_PERMISSIONS_Ts
contextUser-supplied context from the originating call.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.