index.adoc

MONARC Objects Sharing Platform

Table of Contents

• 1. Introduction
• 2. Objects involved in MOSP
  • 2.1. JSON schema
    • 2.1.1. Example of schemas
  • 2.2. Objects
    • 2.2.1. Example of objects
• 3. Using the platform
  • 3.1. Creating a new object
  • 3.2. Select a schema
  • 3.3. Edit object definition
  • 3.4. Exporting an object for use in MONARC
• 4. Using the API
• 5. Permissions
  • 5.1. Schemas
  • 5.2. Objects
• 6. Schemas external references

1. Introduction

This document is intended to be a presentation and a user guide to MOSP, a platform to create, edit and share valid JSON objects.

MOSP supports any kind of JSON objects, you just have to specify a JSON schema. The instance objects.monarc.lu is operated by CASES. It is dedicated to gather security related objects, in the first place aimed to be used with MONARC.

Objects officially provided by the MONARC project are available here. Note that any object created with a JSON schema provided by the MONARC project will be compatible with the MONARC software. In other words, you can use our JSON schemas in order to create objects (standards, mapping, etc.) for a usage in your own security analysis.

2. Objects involved in MOSP

The core concept of MOSP lies on the JSON schemas and JSON Objects. Each objects you create within MOSP will conform to a selected schema.

2.1. JSON schema

A JSON schema describes and validates your existing data format(s). This ensures the quality of client submitted data. MOSP also uses JSON schemas for the generation of the object editor.

For example, the JSON schema available here validates the security standards used in MONARC.

2.1.1. Example of schemas

• Security standards

• Security standards mapping

2.2. Objects

2.2.1. Example of objects

• Internet of Things - IoT [EN]

• ISO/IEC 27002

3. Using the platform

3.1. Creating a new object

When creating a new object with MOSP you have to:

• choose a JSON schema from the ones available on the platform;

• specify a name and a brief description;

• choose an owning organization (a user account can be bound to one or multiple organizations);

• choose at least one license from the proposed.

You can use any available schemas in order to create shareable JSON objects.

3.2. Select a schema

3.3. Edit object definition

The form above is generated thanks to the JSON schema. Using this form ensures that you will create valid objects.

If you update the schema related to an already defined object, eventual validation errors will be displayed in the gray box at the right of the interface.

3.4. Exporting an object for use in MONARC

Objects exported from MOSP can be imported in your projects via the knowledge base of MONARC.

MONARC will be able to handle the CSV or the JSON export.

4. Using the API

APIs are provided in order to interact with the service programmatically.

The section API v2 describes the API v2.

The API v1 is still available but is really discouraged to be used.

5. Permissions

This section details the management of permissions in MOSP.

5.1. Schemas

You can only create an object in one of the organizations your account is linked to.

In order to edit a schema your account must be linked to the owning organization of the schema.

5.2. Objects

You can only create an object in one of the organizations your account is linked to. Since all schemas are public you can instantiate a new object with the schema of your choice.

In order to edit an object your account should be linked to the owning organization of this object.

6. Schemas external references

If there are external references between the schemas available in your MOSP instance, the relations will be analyzed by MOSP in order to link objects.

Theses links are considered during the edition of objects (Edit object definition).