son‐access

The son-access component provides a secured connection based on authentication and authorization processes between SDK end-users and the Service Platform, which offers possibilities to use end-user credentials and JSON Web Tokens to access the Service Platform features such the unified SP Catalogue and enable end-users to submit and request package files and descriptors from the SP Catalogue.

This tool is internally divided in sub-components following different functionalities, which is further detailed in the following sections.

Sub-components

Auth

This sub-component implements the security layer (authentication and authorization of end-users) to the communications with the Service Platform and performs automatically required authentication processes for each interaction. The following features are highlighted:

• Full integration with Service Platform Gatekeeper API to perform authentication and authorization processes;
• Integrated with son-cli components, it supports shared use of the access token between different CLI tools for the same end-user;
• Access token included in each message header to authenticate and authorize developers;
• Full integration with Service Platform Gatekeeper API to perform authentication and authorization processes;

Push

It enables submission of Package files generated by son-package, including Service and Function descriptors to the SP Catalogue. The Gatekeeper API requires package files as input, however the son-access is still able to submit descriptors. This is useful in order to be able to connect the son-access to other platforms that accepting this input element or son-emu.

Pull

This sub-component is fully integrated with the other son-access sub-components, and it also works along with son-workspace SDK tool in order to retrieve package files (son-packages), service and functions descriptors, from the SP and store them in the end-user configured file system or storage system according to their preferences set in the workspace configuration file. This component is able to downstream SP Catalogue contents using access sub-component as interface, authenticating the developer and providing the required access token to the requests.

Usage

usage: son-access [optional] command [<args>]
        The supported commands are:
           auth     Authenticate a user
           list     List available resources (service, functions, packages,...)
           push     Submit a son-package or request a service instantiation
           pull     Request resources (services, functions, packages, ...)
           config   Configure access parameters
        

Authenticates users to submit and request resources from SONATA Service
Platform

positional arguments:
  command               Command to run

optional arguments:
  -h, --help            show this help message and exit
  -w WORKSPACE_PATH, --workspace WORKSPACE_PATH
                        Specify workspace to work on. If not specified will
                        assume '/home/lconceicao/.son-workspace'
  --platform PLATFORM_ID
                        Specify the ID of the Service Platform to use from
                        workspace configuration. If not specified will assume
                        the ID in 'default_service_platform'
  --debug               Set logging level to debug