Security Agent Plugin

Version: 1.0

Status:

SecurityAgent plugin for Thunder framework.

Table of Contents

• Introduction
• Description
• Configuration
• Interfaces
• Methods

Introduction

Scope

This document describes purpose and functionality of the SecurityAgent plugin. It includes detailed specification about its configuration and methods provided.

Case Sensitivity

All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.

Acronyms, Abbreviations and Terms

The table below provides and overview of acronyms used in this document and their definitions.

Acronym	Description
API	Application Programming Interface
HTTP	Hypertext Transfer Protocol
JSON	JavaScript Object Notation; a data interchange format
JSON-RPC	A remote procedure call protocol encoded in JSON

The table below provides and overview of terms and abbreviations used in this document and their definitions.

Term	Description
callsign	The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique.

References

Ref ID	Description
HTTP	HTTP specification
JSON-RPC	JSON-RPC 2.0 specification
JSON	JSON specification
Thunder	Thunder API Reference

Description

Security Agent of thunder is responsible to allow or block access to the Thunder API.

The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [Thunder].

Configuration

The table below lists configuration options of the plugin.

Name	Type	M/O	Description
callsign	string	mandatory	Plugin instance name (default: SecurityAgent)
classname	string	mandatory	Class name: SecurityAgent
locator	string	mandatory	Library name: libThunderSecurityAgent.so
startmode	string	mandatory	Determines in which state the plugin should be moved to at startup of the framework
configuration	object	optional	...
configuration?.acl	string	optional	ACL
configuration?.connector	string	optional	Connector

Interfaces

This plugin implements the following interfaces:

• ISecurityAgent (ISecurityAgent.h) (version 1.0.0) (compliant format)

  This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.

Methods

The following methods are provided by the SecurityAgent plugin:

SecurityAgent interface methods:

Method	Description
validate	Validates a token

validate ^method

Validates a token.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.token	string	mandatory	...

Result

Name	Type	M/O	Description
result	boolean	mandatory	...

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "SecurityAgent.1.validate",
  "params": {
    "token": "..."
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": false
}