Skip to content

Security Agent Plugin

Version: 1.0

Status: ⚫⚫⚫

SecurityAgent plugin for Thunder framework.

Table of Contents

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:

Built-in methods:

Method Description
versions Retrieves a list of JSON-RPC interfaces offered by this service
exists Checks if a JSON-RPC method or property exists

SecurityAgent interface methods:

Method Description
validate Validates a token

versions method

Retrieves a list of JSON-RPC interfaces offered by this service.

Parameters

This method takes no parameters.

Result

Name Type M/O Description
result array mandatory A list ofsinterfaces with their version numbers
Array length must be at most 255 elements.
result[#] object mandatory ...
result[#].name string mandatory Name of the interface
result[#].major integer mandatory Major part of version number
result[#].minor integer mandatory Minor part of version number
result[#].patch integer mandatory Patch part of version version number

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "SecurityAgent.1.versions"
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "name": "JMyInterface",
      "major": 1,
      "minor": 0,
      "patch": 0
    }
  ]
}

exists method

Checks if a JSON-RPC method or property exists.

Description

This method will return True for the following methods/properties: versions, exists, validate.

Parameters

Name Type M/O Description
params object mandatory ...
params.method string mandatory Name of the method or property to look up

Result

Name Type M/O Description
result boolean mandatory Denotes if the method exists or not

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "SecurityAgent.1.exists",
  "params": {
    "method": "methodName"
  }
}

Response

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

validate method

Validates a token.

Parameters

Name Type M/O Description
params object mandatory ...
params.token string mandatory Token that will be validated

Result

Name Type M/O Description
result boolean mandatory Tells whether token's signature is correct

Example

Request

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

Response

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