Skip to content

BrowserSecurity API

Version: 1.0.0

Status: ⚫⚪⚪

BrowserSecurity interface for Thunder framework.

(Defined with IBrowserSecurity in IBrowser.h)

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the BrowserSecurity interface (version 1.0.0). It includes detailed specification about its properties 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

BrowserSecurity JSON-RPC interface.

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

Properties

The following properties are provided by the BrowserSecurity interface:

BrowserSecurity interface properties:

Property R/W Description
securityprofile read/write Security profile for secure connections
mixedcontentpolicy read/write Mixed content policy

securityprofile property

Provides access to the security profile for secure connections.

Value

Name Type M/O Description
(property) string mandatory Security profile for secure connections
Name Type M/O Description
(property) string mandatory Security profile for secure connections

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.securityprofile"
}

Get Response

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

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.securityprofile",
  "params": "..."
}

Set Response

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

mixedcontentpolicy property

Provides access to the mixed content policy.

Value

Name Type M/O Description
(property) string mandatory Mixed content policy (must be one of the following: allowed, blocked)
Name Type M/O Description
(property) string mandatory Mixed content policy type (must be one of the following: allowed, blocked)

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.mixedcontentpolicy"
}

Get Response

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

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.mixedcontentpolicy",
  "params": "blocked"
}

Set Response

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