From 4a1409460a7c0a5d26fe10b5f84368b3cb8b8b5a Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jos=C3=A9=20Bollo?= Date: Wed, 26 Oct 2016 18:24:13 +0200 Subject: [PATCH] doc: switch to mkdocs MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: JosÃ© Bollo --- doc/afm-system-daemon.html | 153 ----------- doc/afm-user-daemon.html | 457 --------------------------------- doc/application-framework.html | 94 ------- doc/doc.css | 37 --- doc/overview.html | 167 ------------ doc/quick-tutorial.html | 178 ------------- doc/quick-tutorial.iotstyled.html | 190 -------------- doc/security-framework.html | 53 ---- doc/updt.sh | 53 ---- doc/widgets.html | 176 ------------- doc/writing-config.xml.html | 190 -------------- {doc => docs}/afm-system-daemon.md | 0 {doc => docs}/afm-user-daemon.md | 0 {doc => docs}/application-framework.md | 0 docs/index.md | 1 + {doc => docs}/overview.md | 0 {doc => docs}/quick-tutorial.md | 0 {doc => docs}/security-framework.md | 0 {doc => docs}/triskel_iot_bzh.svg | 0 {doc => docs}/widgets.md | 0 {doc => docs}/writing-config.xml.md | 0 mkdocs.yml | 13 + 22 files changed, 14 insertions(+), 1748 deletions(-) delete mode 100644 doc/afm-system-daemon.html delete mode 100644 doc/afm-user-daemon.html delete mode 100644 doc/application-framework.html delete mode 100644 doc/doc.css delete mode 100644 doc/overview.html delete mode 100644 doc/quick-tutorial.html delete mode 100644 doc/quick-tutorial.iotstyled.html delete mode 100644 doc/security-framework.html delete mode 100755 doc/updt.sh delete mode 100644 doc/widgets.html delete mode 100644 doc/writing-config.xml.html rename {doc => docs}/afm-system-daemon.md (100%) rename {doc => docs}/afm-user-daemon.md (100%) rename {doc => docs}/application-framework.md (100%) create mode 120000 docs/index.md rename {doc => docs}/overview.md (100%) rename {doc => docs}/quick-tutorial.md (100%) rename {doc => docs}/security-framework.md (100%) rename {doc => docs}/triskel_iot_bzh.svg (100%) rename {doc => docs}/widgets.md (100%) rename {doc => docs}/writing-config.xml.md (100%) create mode 100644 mkdocs.yml diff --git a/doc/afm-system-daemon.html b/doc/afm-system-daemon.html deleted file mode 100644 index 199bf38..0000000 --- a/doc/afm-system-daemon.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - - - - The afm-system-daemon - - - - - -

The afm-system-daemon

JosÃ© Bollo

Fulup Ar Foll

24 juin 2016

- -

The afm-system-daemon

Foreword

This document describes application framework system daemon fundamentals. FCF (Fully Conform to Specification) implementation is still under development. It may happen that current implementation somehow diverges with specifications.

Introduction

The daemon afm-system-daemon is in charge of installing applications on AGL system. Its main tasks are:

installs applications and setup security framework for newly installed application.
uninstall applications

The afm-system-daemon takes its orders from system instance of D-Bus.

The figure below summarizes the situation of afm-system-daemon in the system.

+------------------------------------------------------------+
-|                          User                              |
-|                                                            |
-|     +-------------------------------------------------+    |
-|     |                                                 |    |
-|     |                  afm-user-daemon                |    |
-|     |                                                 |    |
-|     +----------+----------------------+----------+----+    |
-|                |                      |          :         |
-|                |                      |          :         |
-:================|======================|==========:=========:
-|                |                      |          :         |
-|     +----------+----------+     +-----+-----+    :         |
-|     |   D-Bus   system    +-----+  CYNARA   |    :         |
-|     +----------+----------+     +-----+-----+    :         |
-|                |                      |          :         |
-|     +----------+---------+    +-------+----------+----+    |
-|     | afm-system-daemon  +----+   SECURITY-MANAGER    |    |
-|     +--------------------+    +-----------------------+    |
-|                                                            |
-|                          System                            |
-+------------------------------------------------------------+

Starting afm-system-daemon

afm-system-daemon is launched as a systemd service attached to system. Normally, the service file is located at /lib/systemd/system/afm-system-daemon.service.

The options for launching afm-system-daemon are:

-r
---root directory
-
-     Set the root application directory.
-
-     Note that the default root directory is defined
-     to be /usr/share/afm/applications (may change).
-
--d
---daemon
-
-     Daemonizes the process. It is not needed by sytemd.
-
--q
---quiet
-
-     Reduces the verbosity (can be repeated).
-
--v
---verbose
-
-     Increases the verbosity (can be repeated).
-
--h
---help
-
-     Prints a short help.

The D-Bus interface

Overview of the dbus interface

afm-system-daemon takes its orders from the session instance of D-Bus. The use of D-Bus is great because it allows to implement discovery and signaling.

The afm-system-daemon is listening with the destination name org.AGL.afm.system at the object of path /org/AGL/afm/system on the interface org.AGL.afm.system for the below detailed members install and uninstall.

D-Bus is mainly used for signaling and discovery. Its optimized typed protocol is not used except for transmitting only one string in both directions.

The client and the service are using JSON serialization to exchange data.

The D-Bus interface is defined by:

DESTINATION: org.AGL.afm.system
PATH: /org/AGL/afm/system
INTERFACE: org.AGL.afm.system

The signature of any member of the interface is string -> string for JSON -> JSON.

This is the normal case. In case of error, the current implementation returns a dbus error that is a string.

Here is an example using dbus-send to query data on installed applications.

dbus-send --session --print-reply \
-    --dest=org.AGL.afm.system \
-    /org/AGL/afm/system \
-    org.AGL.afm.system.install 'string:"/tmp/appli.wgt"'

The protocol over D-Bus

Method org.AGL.afm.system.install

Description: Install an application from a widget file.

When an application with the same id and version already exists. Outside of using force=true the application is not reinstalled.

Applications are installed the subdirectories of applications common directory. If root is specified, the application is installed under the sub-directories of the root defined.

Note that this methods is a simple accessor method of org.AGL.afm.system.install from afm-system-daemon.

After the installation and before returning to the sender, afm-system-daemon sends a signal org.AGL.afm.system.changed.

Input: The path of the widget file to install and, optionally, a flag to force reinstallation, and, optionally, a root directory.

Either just a string being the absolute path of the widget file:

"/a/path/driving/to/the/widget"

Or an object:

{
-  "wgt": "/a/path/to/the/widget",
-  "force": false,
-  "root": "/a/path/to/the/root"
-}

"wgt" and "root" must be absolute paths.

output: An object with the field "added" being the string for the id of the added application.

{"added":"appli@x.y"}

Method org.AGL.afm.system.uninstall

Description: Uninstall an application from its id.

Note that this methods is a simple method accessor of org.AGL.afm.system.uninstall from afm-system-daemon.

After the uninstallation and before returning to the sender, afm-system-daemon sends a signal org.AGL.afm.system.changed.

Input: the id of the application and optionally the application root path.

Either a string:

"appli@x.y"

Or an object:

{
-  "id": "appli@x.y",
-  "root": "/a/path/to/the/root"
-}

output: the value 'true'.

- - diff --git a/doc/afm-user-daemon.html b/doc/afm-user-daemon.html deleted file mode 100644 index 5bf56f7..0000000 --- a/doc/afm-user-daemon.html +++ /dev/null @@ -1,457 +0,0 @@ - - - - - - - - - The afm-user-daemon - - - - - -

The afm-user-daemon

JosÃ© Bollo

Fulup Ar Foll

24 juin 2016

- -

The afm-user-daemon

Foreword

This document describes application framework user daemon fundamentals. FCF (Fully Conform to Specification) implementation is still under development. It may happen that current implementation somehow diverges with specifications.

Introduction

The daemon afm-user-daemon is in charge of handling applications on behalf of a user. Its main tasks are:

enumerate applications that end user can run and keep this list available on demand
start applications on behalf of end user, set user running environment, set user security context
list current runnable or running applications
stop (aka pause), continue (aka resume), terminate a running instance of a given application
transfer requests for installation/uninstallation of applications to the corresponding system daemon afm-system-daemon

The afm-user-daemon takes its orders from the session instance of D-Bus.

The figure below summarizes the situation of afm-user-daemon in the system.

+------------------------------------------------------------+
-|                          User                              |
-|                                 +---------------------+    |
-|     +---------------------+     |   Smack isolated    |    |
-|     |   D-Bus   session   +     |    APPLICATIONS     |    |
-|     +----------+----------+     +---------+-----------+    |
-|                |                          |                |
-|                |                          |                |
-|     +----------+--------------------------+-----------+    |
-|     |                                                 |    |
-|     |                  afm-user-daemon                |    |
-|     |                                                 |    |
-|     +----------+----------------------+----------+----+    |
-|                |                      |          :         |
-|                |                      |          :         |
-:================|======================|==========:=========:
-|                |                      |          :         |
-|     +----------+----------+     +-----+-----+    :         |
-|     |   D-Bus   system    +-----+  CYNARA   |    :         |
-|     +----------+----------+     +-----+-----+    :         |
-|                |                      |          :         |
-|     +----------+---------+    +-------+----------+----+    |
-|     | afm-system-daemon  +----+   SECURITY-MANAGER    |    |
-|     +--------------------+    +-----------------------+    |
-|                                                            |
-|                          System                            |
-+------------------------------------------------------------+

Tasks of afm-user-daemon

Maintaining list of applications

At start afm-user-daemon scans the directories containing applications and load in memory a list of avaliable applications accessible by current user.

When afm-system-daemon installs or removes an application. On success it sends the signal org.AGL.afm.system.changed. When receiving such a signal, afm-user-daemon rebuilds its applications list.

afm-user-daemon provides the data it collects about applications to its clients. Clients may either request the full list of avaliable applications or a more specific information about a given application.

Launching application

afm-user-daemon launches application. Its builds a secure environment for the application before starting it within a secured environment.

Different kind of applications can be launched.

This is set using a configuration file that describes how to launch an application of a given kind within a given mode.

There is two launching modes: local or remote.

Launching an application locally means that the application and its binder are launched together.

Launching application remotely translates in only launching the application binder. The UI by itself has to be activated remotely by the requested (ie: HTML5 homescreen in a browser)

Once launched, running instances of application receive a runid that identify them.

Managing instances of running applications

afm-user-daemon manages the list of applications that it launched.

When owning the right permissions, a client can get the list of running instances and details about a specific running instance. It can also terminates, stops or continues a given application.

Installing and uninstalling applications

If the client own the right permissions, afm-user-daemon delegates that task to afm-system-daemon.

Starting afm-user-daemon

afm-user-daemon is launched as a systemd service attached to user sessions. Normally, the service file is located at /usr/lib/systemd/user/afm-user-daemon.service.

The options for launching afm-user-daemon are:

-a
---application directory
-
-     Includes the given application directory to
-     the database base of applications.
-
-     Can be repeated.
-
--r
---root directory 
-
-     Includes root application directory or directories when
-     passing multiple rootdir to
-     applications database.
-
-     Note that default root directory for
-     applications is always added. In current version
-     /usr/share/afm/applications is used as default.
-    
--m
---mode (local|remote)
-
-     Set the default launch mode.
-     The default value is 'local'
-
--d
---daemon
-
-     Daemonizes the process. It is not needed by sytemd.
-
--q
---quiet
-
-     Reduces the verbosity (can be repeated).
-
--v
---verbose
-
-     Increases the verbosity (can be repeated).
-
--h
---help
-
-     Prints a short help.

Launcher Configuration

It contains rules for launching applications. When afm-user-daemon has to launch an application, it looks for launch mode (local or remote), as well as for the type of application describe in config.xml widget configuration file.

This tuple mode+type allows to select the adequate rule.

Configuration file is /etc/afm/afm-launch.conf.

It contains sections and rules. It can also contain comments and empty lines to improve readability.

The separators are space and tabulation, any other character should have a meaning.

The format is line oriented. The new line character separate the lines.

Lines having only separators are blank lines and ignored. Line having character #(sharp) at first position are comment lines and ignored.

Lines not starting with a separator are different from lines starting with a separator character.

The grammar of the configuration file is defined below:

CONF: *COMMENT *SECTION
-
-SECTION: MODE *RULE
-
-RULE: +TYPE VECTOR ?VECTOR
-
-MODE: 'mode' +SEP ('local' | 'remote') *SEP EOL
-
-TYPE: DATA *SEP EOL
-
-VECTOR: +SEP DATA *(+SEP NDATA) *SEP EOL
-
-DATA: CHAR *NCHAR
-NDATA: +NCHAR
-
-EOL: NL *COMMENT
-COMMENT: *SEP CMT *(SEP | NCHAR) NL
-
-NL: '\x0a'
-SEP: '\x20' | '\x09'
-CMT: '#'
-CHAR: '\x00'..'\x08' | '\x0b'..'\x1f' | '\x21' | '\x22' | '\x24'..'\xff'
-NCHAR: CMT | CHAR

Here is a sample of configuration file for defining how to launch an application of types application/x-executable, text/x-shellscript and text/html in local mode:

mode local
-
-application/x-executable
-text/x-shellscript
-    %r/%c
-
-text/html
-    /usr/bin/afb-daemon --mode=local --readyfd=%R --alias=/icons:%I --port=%P --rootdir=%r --token=%S --sessiondir=%D/.afb-daemon
-    /usr/bin/web-runtime http://localhost:%P/%c?token=%S

This shows that:

within a section, several rules can be defined
within a rule, several types can be defined
within a rule, one or two vectors can be defined
vectors are using %substitution
launched binaries must be defined with their full path

mode local

Within this mode, the launchers have either one or two description vectors. All of those vectors are treated as programs and are executed with 'execve' system call.

The first vector is the leader vector and it defines the process group. The second vector (if any) is attached to the group defined by this first vector.

mode remote

Within this mode, the launchers have either one or two vectors describing them.

The first vector is process as a program and is executed with system call 'execve'.

The second vector (if any) defines a text that is returned to the caller. This mechanism can be used to return a uri for remote UI to connect on the newly launched application.

The daemon afm-user-daemon allocates a port for each new remote application. The current implementation port allocation is incremental. A smarter (cacheable and discoverable) allocation should be defined.

%substitutions

Vectors can include sequences of 2 characters that have a special meaning. These sequences are named %substitution because their first character is the percent sign (%) and because each occurrence of the sequence is replaced, at launch time, by the value associated to sequences.

Here is the list of %substitutions:

%%: %.

This simply emits the percent sign %

%a: appid

Holds application Id of launched application.

Defined by the attribute id of the element of config.xml.

%b: bindings

In the future should represent the list of bindings and bindings directory separated by ','. Warning: not supported in current version.

%c: content

The file within the widget directory that is the entry point.

For HTML applications, it represents the relative path to main page (aka index.html).

Defined by attribute src of the element within config.xml.

%D: datadir

Path of the directory where the application runs (cwd) and stores its data.

It is equal to %h/%a.

%H: height

Requested height for the widget.

Defined by the attribute height of the element of config.xml.

%h: homedir

Path of the home directory for all applications.

It is generally equal to $HOME/app-data

%I: icondir

Path of the directory were the icons of the applications can be found.

%m: mime-type

Mime type of the launched application.

Defined by the attribute type of the element of config.xml.

%n: name

Name of the application as defined by the content of the element of config.xml.

%P: port

A port to use. It is currently a kind of random port. The precise model is to be defined later.

%R: readyfd

Number of file descriptor to use for signaling readiness of launched process.

%r: rootdir

Path of directory containing the widget and its data.

%S: secret

An hexadecimal number that can be used to initialize pairing of client and application binder.

%W: width

Requested width for the widget.

Defined by the attribute width of the element of config.xml.

The D-Bus interface

Overview of the dbus interface

afm-user-daemon takes its orders from the session instance of D-Bus. D-Bus is nice to use in this context because it allows discovery and signaling.

The dbus session is by default addressed by environment variable DBUS_SESSION_BUS_ADDRESS. Using systemd variable DBUS_SESSION_BUS_ADDRESS is automatically set for user sessions.

The afm-user-daemon is listening on destination name org.AGL.afm.user at object path /org/AGL/afm/user on interface org.AGL.afm.user for following members: runnables, detail, start, terminate, stop, continue, runners, state, install and uninstall.

D-Bus is mainly used for signaling and discovery. Its optimized typed protocol is not used except for transmission of standalone strings.

Clients and Services are using JSON serialisation to exchange data.

The D-Bus interface is defined by:

DESTINATION: org.AGL.afm.user
PATH: /org/AGL/afm/user
INTERFACE: org.AGL.afm.user

The signature of any member of the interface is string -> string for JSON -> JSON.

This is the normal case. In case of error, the current implementation returns a dbus error as a string.

Here an example using dbus-send to query data on installed applications.

dbus-send --session --print-reply \
-    --dest=org.AGL.afm.user \
-    /org/AGL/afm/user \
-    org.AGL.afm.user.runnables string:true

Using afm-util

The command line tool afm-util uses dbus-send to send orders to afm-user-daemon. This small scripts allows to send command to afm-user-daemon either interactively at shell prompt or scriptically.

The syntax is simple: it accept a command and when requires attached arguments.

Here is the summary of afm-util:

afm-util runnables :

list the runnable widgets installed

afm-util install wgt :

install the wgt file

afm-util uninstall id :

remove the installed widget of id

afm-util detail id :

print detail about the installed widget of id

afm-util runners :

list the running instance

afm-util start id :

start an instance of the widget of id

afm-util terminate rid :

terminate the running instance rid

afm-util stop rid :

stop the running instance rid

afm-util continue rid :

continue the previously rid

afm-util state rid :

get status of the running instance rid

Here is how to list applications using afm-util:

afm-util runnables

The protocol over D-Bus

Recall:

DESTINATION: org.AGL.afm.user
PATH: /org/AGL/afm/user
INTERFACE: org.AGL.afm.user

Method org.AGL.afm.user.detail

Description: Get details about an application from its id.

Input: the id of the application as below.

Either just a string:

"appli@x.y"

Or an object having the field "id" of type string:

{"id":"appli@x.y"}

Output: A JSON object describing the application containing the fields described below.

{
-  "id":          string, the application id (id@version)
-  "version":     string, the version of the application
-  "width":       integer, requested width of the application
-  "height":      integer, resqueted height of the application
-  "name":        string, the name of the application
-  "description": string, the description of the application
-  "shortname":   string, the short name of the application
-  "author":      string, the author of the application
-}

Method org.AGL.afm.user.runnables

Description: Get the list of applications that can be run.

Input: any valid json entry, can be anything except null.

output: An array of description of the runnable applications. Each item of the array contains an object containing the detail of an application as described above for the method org.AGL.afm.user.detail.

Method org.AGL.afm.user.install

Description: Install an application from its widget file.

If an application of the same id and version exists, it is not reinstalled except when force=true.

Applications are installed in the subdirectories of the common directory reserved for applications. If root is specified, the application is installed under sub-directories of defined root.

Note that this methods is a simple accessor to the method org.AGL.afm.system.install of afm-system-daemon.

After the installation and before returning to the sender, afm-user-daemon sends the signal org.AGL.afm.user.changed.

Input: The path of widget file to be installed. Optionally, a flag to force reinstallation and/or a root directory.

Simple form a simple string containing the absolute widget path:

"/a/path/driving/to/the/widget"

Or an object:

{
-  "wgt": "/a/path/to/the/widget",
-  "force": false,
-  "root": "/a/path/to/the/root"
-}

"wgt" and "root" MUST be absolute paths.

output: An object containing field "added" to use as application ID.

{"added":"appli@x.y"}

Method org.AGL.afm.user.uninstall

Description: Uninstall an application from its id.

Note that this methods is a simple accessor to org.AGL.afm.system.uninstall method from afm-system-daemon.

After the uninstallation and before returning to the sender, afm-user-daemon sends the signal org.AGL.afm.user.changed.

Input: the id of the application and, optionally, the path to application root.

Either a string:

"appli@x.y"

Or an object:

{
-  "id": "appli@x.y",
-  "root": "/a/path/to/the/root"
-}

output: the value 'true'.

Method org.AGL.afm.user.start

Description:

Input: the id of the application and, optionally, the start mode as below.

Either just a string:

"appli@x.y"

Or an object containing field "id" of type string and optionally a field mode:

{"id":"appli@x.y","mode":"local"}

The field "mode" is a string equal to either "local" or "remote".

output: The runid of the application launched. runid is an integer.

Method org.AGL.afm.user.terminate

Description: Terminates the application attached to runid.

Input: The runid (an integer) of running instance to terminate.

output: the value 'true'.

Method org.AGL.afm.user.stop

Description: Stops the application attached to runid until terminate or continue.

Input: The runid (integer) of the running instance to stop.

output: the value 'true'.

Method org.AGL.afm.user.continue

Description: Continues the application attached to runid previously stopped.

Input: The runid (integer) of the running instance to continue.

output: the value 'true'.

Method org.AGL.afm.user.state

Description: Get informations about a running instance of runid.

Input: The runid (integer) of the running instance inspected.

output: An object describing instance state. It contains: the runid (integer), the id of the running application (string), the state of the application (string either: "starting", "running", "stopped").

Example of returned state:

{
-  "runid": 2,
-  "state": "running",
-  "id": "appli@x.y"
-}

Method org.AGL.afm.user.runners

Description: Get the list of currently running instances.

Input: anything.

output: An array of states, one per running instance, as returned by the methodd org.AGL.afm.user.state.

- - diff --git a/doc/application-framework.html b/doc/application-framework.html deleted file mode 100644 index 8d0e0e3..0000000 --- a/doc/application-framework.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - - Application framework - - - - - -

Application framework

JosÃ© Bollo

Fulup Ar Foll

24 juin 2016

- -

Application framework

Foreword

This document describes application framework fundamentals. FCF (Fully Conform to Specification) implementation is still under development. It may happen that current implementation somehow diverges with specifications.

Overview

The application framework on top of the security framework provides components to install and uninstall applications as well as to run them in a secured environment.

The goal of the framework is to manage applications and hide security details to applications.

For the reasons explained in introduction, it was choose not to reuse Tizen application framework directly, but to rework a new framework inspired from Tizen.

fundamentals remain identical: the applications are distributed in a digitally signed container that should match widget specifications normalized by the W3C. This is described by the technical recommendations widgets and widgets-digsig of the W3 consortium.

As today this model allows the distribution of HTML, QML and binary applications but it could be extended to any other class of applications.

The management of widget package signatures. Current model is only an initial step, it might be extended in the future to include new feature (ie: incremental delivery).

Comparison to other frameworks

Tizen framework

xdg-app

ostro

organization of directory of applications

The main path for applications are: APPDIR/PKGID/VER.

Where:

APPDIR is as defined above
PKGID is a directory whose name is the package identifier
VER is the version of the package MAJOR.MINOR

The advantage of such an organization is to allow several versions to live together. This is required for multiple reasons (ie: roll back) and to comply with developers habits.

Identity of installed files

All the files are installed as user "userapp" and group "userapp". All files have rw(x) for user and r-(x) for group and others.

This allows any user to read files.

labeling the directories of applications

organization of data

The data of a user are contain within its directory and are labeled using the application labels

Setting Smack rules for the application

For Tizen, the following rules are set by the security manager for each application.

System ~APP~             rwx
-System ~PKG~             rwxat
-System ~PKG~::RO         rwxat
-~APP~  System            wx
-~APP~  System::Shared    rxl
-~APP~  System::Run       rwxat
-~APP~  System::Log       rwxa
-~APP~  _                 l
-User   ~APP~             rwx
-User   ~PKG~             rwxat
-User   ~PKG~::RO         rwxat
-~APP~  User              wx
-~APP~  User::Home        rxl
-~APP~  User::App::Shared rwxat
-~APP~  ~PKG~             rwxat
-~APP~  ~PKG~::RO         rxl

Here, _PKG is the identifier of the package and _APP is the identifier of the application.

What user can run an application?

Not all user are able to run all applications. How to manage that?

- - diff --git a/doc/doc.css b/doc/doc.css deleted file mode 100644 index 8c327c0..0000000 --- a/doc/doc.css +++ /dev/null @@ -1,37 +0,0 @@ -body { - background: #fff url(triskel_iot_bzh.svg) no-repeat fixed right top; - font-family: "Verdana"; - color: #000; -} - -h1, h2, h3, h4 { - color: #306; - text-decoration: underline; -} - -pre { - border: medium dashed #306; - border-width: 0.1em; - background-color: #eee; - margin-left: 2em; - margin-right: 2em; - padding: 1em; - outline: #555; -} - -blockquote { - border-left: solid thick black; - background-color: #ff8; - font: bolder; - padding: 0.7em 1.5em; -} - -table { - margin-left: 2em; - background-color: #dff; - outline: 0.25em solid #a6f; -/* padding: 0.25em;*/ -} -thead {background-color: #a6f;} -tr:nth-child(even) {background-color: #aee;} -td { padding: 0.1em 0.5em; } diff --git a/doc/overview.html b/doc/overview.html deleted file mode 100644 index 055d5d5..0000000 --- a/doc/overview.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - - AGL framework, overview of the proposal of IoT.bzh - - - - - -

AGL framework, overview of the proposal of IoT.bzh

JosÃ© Bollo

24 juin 2016

- -

AGL framework, overview of the proposal of IoT.bzh

Foreword

This document describes what we intend to do. It may happen that our current implementation and the content of this document differ.

In case of differences, it is assumed that this document is right and the implementation is wrong.

Introduction

During the first works in having the security model of Tizen integrated in AGL (Automotive Grade Linux) distribution, it became quickly obvious that the count of components specific to Tizen to integrate was huge.

Here is a minimal list of what was needed:

platform/appfw/app-installers
platform/core/security/cert-svc
platform/core/appfw/ail
platform/core/appfw/aul-1
platform/core/appfw/libslp-db-util
platform/core/appfw/pkgmgr-info
platform/core/appfw/slp-pkgmgr

But this list is complete because many dependencies are hidden. Those hidden dependencies are including some common libraries but also many tizen specific sub-components (iniparser, bundle, dlog, libtzplatform-config, db-util, vconf-buxton, ...).

This is an issue because AGL is not expected to be Tizen. Taking it would either need to patch it for removing unwanted components or to take all of them.

However, a careful study of the core components of the security framework of Tizen showed that their dependencies to Tizen are light (and since some of our work, there is no more dependency to tizen). Those components are cynara, security-manager, D-Bus aware of cynara.

Luckyly, these core security components of Tizen are provided by meta-intel-iot-security, a set of yocto layers. These layers were created by Intel to isolate Tizen specific security components from the initial port of Tizen to Yocto. The 3 layers are providing components for:

Implementing Smack LSM
Implementing Integrity Measurement Architecture
Implementing Tizen Security Framework

The figure below shows the history of these layers.

                  2014         2015
-Tizen OBS ----------+--------------------------->
-                     \
-                      \
-     Tizen Yocto       +---------+-------------->
-                                  \
-                                   \
-       meta-intel-iot-security      +----------->

We took the decision to use these security layers that provides the basis of the Tizen security, the security framework.

For the components of the application framework, built top of the security framework, instead of pulling the huge set of packages from Tizen, we decided to refit it by developping a tiny set of components that would implement the same behaviour but without all the dependencies and with minor architectural improvements for AGL.

These components are afm-system-daemon and afm-user-daemon. They provides infrastructure for installing, uninstalling, launching, terminating, stopping and resuming applications in a multi user secure environment.

A third component exists in the framework, the binder afb-daemon. The binder provides the easiest way to provide secured API for any tier. Currently, the use of the binder is not absolutely mandatory.

This documentation explains the framework created by IoT.bzh by rewriting the Tizen Application Framework. Be aware of the previous foreword.

Overview

The figure below shows the major components of the framework and their interactions going through the following scenario: APPLICATION installs an other application and then launch it.

+-----------------------------------------------------------------------+
-|                                 User                                  |
-|  ................................                                     |
-|  :   Smack isolation context    :                                     |
-|  :                              :      ...........................    |
-|  :  +-----------------------+   :      : Smack isolation context :    |
-|  :  |                       |   :      :                         :    |
-|  :  |      APPLICATION      |   :      :     OTHER application   :    |
-|  :  |                       |   :      :.........................:    |
-|  :  +-----------+-----------+   :                ^                    |
-|  :              |               :                |                    |
-|  :              |(1),(7)        :                |(13)                |
-|  :              |               :                |                    |
-|  :  +-----------v-----------+   :      +---------+---------------+    |
-|  :  |   binder afb-daemon   |   :      |                         |    |
-|  :  +-----------------------+   :      |      afm-user-daemon    |    |
-|  :  |    afm-main-binding   |   :      |                         |    |
-|  :  +-----+--------------+--+   :      +------^-------+------+---+    |
-|  :........|..............|......:             |       |      :        |
-|           |(2)           |(8)                 |(10)   |      :        |
-|           |              |                    |       |      :        |
-|           |         +----v--------------------+---+   |      :        |
-|           |         |        D-Bus   session      |   |(11)  :(12)    |
-|           |         +-------------------------+---+   |      :        |
-|           |                                   |       |      :        |
-|           |                                   |(9)    |      :        |
-|           |                                   |       |      :        |
-:===========|===================================|=======|======:========:
-|           |                                   |       |      :        |
-|           |                               +---v-------v--+   :        |
-|    +------v-------------+     (3)         |              |   :        |
-|    |  D-Bus   system    +----------------->    CYNARA    |   :        |
-|    +------+-------------+                 |              |   :        |
-|           |                               +------^-------+   :        |
-|           |(4)                                   |           :        |
-|           |                                      |(6)        v        |
-|    +------v--------------+             +---------+---------------+    |
-|    |                     |    (5)      |                         |    |
-|    |  afm-system-daemon  +------------->     SECURITY-MANAGER    |    |
-|    |                     |             |                         |    |
-|    +---------------------+             +-------------------------+    |
-|                                                                       |
-|                              System                                   |
-+-----------------------------------------------------------------------+

Let follow the sequence of calls:

APPLICATION calls its binder to install the OTHER application.
The binding afm-main-binding of the binder calls, through D-Bus system, the system daemon to install the OTHER application.
The system D-Bus checks wether APPLICATION has the permission or not to install applications by calling CYNARA.
The system D-Bus transmits the request to afm-system-daemon.

afm-system-daemon checks the application to install, its signatures and rights and install it.

afm-system-daemon calls SECURITY-MANAGER for fullfilling security context of the installed application.
SECURITY-MANAGER calls CYNARA to install initial permissions for the application.
APPLICATION call its binder to start the nearly installed OTHER application.
The binding afm-main-binding of the binder calls, through D-Bus session, the user daemon to launch the OTHER application.
The session D-Bus checks wether APPLICATION has the permission or not to start an application by calling CYNARA.
The session D-Bus transmits the request to afm-user-daemon.
afm-user-daemon checks wether APPLICATION has the permission or not to start the OTHER application CYNARA.
afm-user-daemon uses SECURITY-MANAGER features to set the seciruty context for the OTHER application.
afm-user-daemon launches the OTHER application.

This scenario does not cover all the features of the frameworks. Shortly because details will be revealed in the next chapters, the components are:

SECURITY-MANAGER: in charge of setting Smack contexts and rules, of setting groups, and, of creating initial content of CYNARA rules for applications.
CYNARA: in charge of handling API access permissions by users and by applications.
D-Bus: in charge of checking security of messaging. The usual D-Bus security rules are enhanced by CYNARA checking rules.
afm-system-daemon: in charge of installing and uninstalling applications.
afm-user-daemon: in charge of listing applications, querying application details, starting, terminating, stopping, resuming applications and their instances for a given user context.
afb-binder: in charge of serving resources and features through an HTTP interface.
afm-main-binding: This binding allows applications to use the API of the AGL framework.

Links between the "Security framework" and the "Application framework"

The security framework refers to the security model used to ensure security and to the tools that are provided for implementing that model.

The security model refers to how DAC (Discretionnary Access Control), MAC (Mandatory Access Control) and Capabilities are used by the system to ensure security and privacy. It also includes features of reporting using audit features and by managing logs and alerts.

The application framework manages the applications: installing, uninstalling, starting, stopping, listing ...

The application framework uses the security model/framework to ensure the security and the privacy of the applications that it manages.

The application framework must be compliant with the underlyiong security model/framework. But it should hide it to the applications.

The security framework

The implemented security model is the security model of Tizen 3. This model is described here.

The security framework then comes from Tizen 3 but through the meta-intel. It includes: Security-Manager, Cynara and D-Bus compliant to Cynara.

Two patches are applied to the security-manager. These patches are removing dependencies to packages specific of Tizen but that are not needed by AGL. None of these patches adds or removes any behaviour.

Theoritically, the security framework/model is an implementation details that should not impact the layers above the application framework.

The security framework of Tizen provides "nice lad" a valuable component to scan log files and analyse auditing. This component is still in developement.

The application framework

The application framework on top of the security framework provides the components to install and uninstall applications and to run it in a secured environment.

The goal is to manage applications and to hide the details of the security framework to the applications.

For the reasons explained in introduction, we did not used the application framework of Tizen as is but used an adaptation of it.

The basis is kept identical: the applications are distributed in a digitally signed container that must match the specifications of widgets (web applications). This is described by the technical recomendations widgets and widgets-digsig of the W3 consortium.

This model allows the distribution of HTML, QML and binary applications.

The management of signatures of the widget packages This basis is not meant as being rigid and it can be extended in the futur to include for example incremental delivery.

- - diff --git a/doc/quick-tutorial.html b/doc/quick-tutorial.html deleted file mode 100644 index 3b5c6a9..0000000 --- a/doc/quick-tutorial.html +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - - - AGL Application Framework: A Quick Tutorial - - - - - -

AGL Application Framework: A Quick Tutorial

Stephane Desneux

JosÃ© Bollo

24 juin 2016

- -

AGL Application Framework: A Quick Tutorial

Introduction

This document proposes a quick tutorial to demonstrate the major functionnalities of the AGL Application Framework. For more complete information, please refer to the inline documentation available in the main git repository: https://gerrit.automotivelinux.org/gerrit/#/admin/projects/src/app-framework-main https://gerrit.automotivelinux.org/gerrit/#/admin/projects/src/app-framework-binder

For more information on AGL, please visit: https://www.automotivelinux.org/

Sample applications

4 sample applications (.wgt files) are prebuilt and available at the following address: https://github.com/iotbzh/afm-widget-examples

You can get them by cloning this git repository on your desktop (will be useful later in this tutorial):

$ git clone https://github.com/iotbzh/afm-widget-examples

Using the CLI tool

Setup Environment

Connect your AGL target board to the network and copy some sample widgets on it through SSH (set BOARDIP with your board IP address) :

$ cd afm-widget-examples
-$ BOARDIP=1.2.3.4
-$ scp *.wgt root@$BOARDIP:~/

Connect through SSH on the target board and check for Application Framework daemons:

$ ssh root@$BOARDIP
-root@porter:~# ps -ef|grep bin/afm
-afm        409     1  0 13:00 ?        00:00:00 /usr/bin/afm-system-daemon
-root       505   499  0 13:01 ?        00:00:00 /usr/bin/afm-user-daemon
-root       596   550  0 13:22 pts/0    00:00:00 grep afm

We can see that there are two daemons running: * afm-system-daemon runs with a system user 'afm' and is responsible for installing/uninstalling packages * afm-user-daemon runs as a user daemon (currently as root because it's the only real user on the target board) and is responsible for the whole lifecycle of the applications running inside the user session.

The application framework has a tool running on the Command Line Interface (CLI). Using the afm-util command, you can install, uninstall, list, run, stop ... applications.

To begin, run 'afm-util help' to get a quick help on commands:

root@porter:~# afm-util help
-usage: afm-util command [arg]
-
-The commands are:
-
-  list
-  runnables      list the runnable widgets installed
-
-  add wgt
-  install wgt    install the wgt file
-
-  remove id
-  uninstall id   remove the installed widget of id
-
-  info id
-  detail id      print detail about the installed widget of id
-
-  ps
-  runners        list the running instance
-
-  run id
-  start id       start an instance of the widget of id
-
-  kill rid
-  terminate rid       terminate the running instance rid
-
-  stop rid
-  pause rid      stop the running instance rid
-
-  resume rid
-  continue rid   continue the previously rid
-
-  status rid
-  state rid     get status of the running instance rid

Install an application

You can then install your first application:

root@porter:~# afm-util install /home/root/annex.wgt 
-{ "added": "webapps-annex@0.0" }

Let's install a second application:

root@porter:~# afm-util install /home/root/memory-match.wgt 
-{ "added": "webapps-memory-match@1.1" }

Note that usually, afm-util will return a JSON result, which is the common format for messages returned by the Application Framework daemons.

List installed applications

You can then list all installed applications:

root@porter:~# afm-util list
-[ { "id": "webapps-annex@0.0", "version": "0.0.10", "width": 0, "height": 0, "name": "Annex", "description": "Reversi\/Othello", "shortname": "", "author": "Todd Brandt <todd.e.brandt@intel.com>" },
- { "id": "webapps-memory-match@1.1", "version": "1.1.7", "width": 0, "height": 0, "name": "MemoryMatch", "description": "Memory match", "shortname": "", "author": "Todd Brandt <todd.e.brandt@intel.com>" } ]

Here, we can see the two previously installed applications.

Get information about an application

Let's get some details about the first application:

root@porter:~# afm-util info webapps-annex@0.0
-{ "id": "webapps-annex@0.0", "version": "0.0.10", "width": 0, "height": 0, "name": "Annex", "description": "Reversi\/Othello", "shortname": "", "author": "Todd Brandt <todd.e.brandt@intel.com>" }

Note that AGL applications are mostly handled by afm-util through their IDs. In our example, the application ID is 'webapps-annex@0.0'.

Start application

Let's start the first application Annex:

root@porter:~# afm-util start webapps-annex@0.0
-1

As the application is a HTML5 game, you should then get a webview running with QML on the board display.

Security Context

The application has been started in the user session, with a dedicated security context, enforced by SMACK. To illustrate this, we can take a look at the running processes and their respective SMACK labels:

root@porter:~# ps -efZ |grep webapps-annex | grep -v grep
-User::App::webapps-annex        root       716   491  0 13:19 ?        00:00:00 /usr/bin/afb-daemon --mode=local --readyfd=8 --alias=/icons /usr/share/afm/icons --port=12348 --rootdir=/usr/share/afm/applications/webapps-annex/0.0 --token=7D6D2F16 --sessiondir=/home/root/app-data/webapps-annex/.afb-daemon
-User::App::webapps-annex        root       717   491  0 13:19 ?        00:00:00 /usr/bin/qt5/qmlscene http://localhost:12348/index.html?token=7D6D2F16 /usr/bin/web-runtime-webkit.qml

In the previous result, we see that the application is composed of two processes: * the application binder (afb-daemon) * the application UI (qmlscene ...)

While most system processes run with the label 'System', we see that the application runs with a specific SMACK label 'User::App::webapps-annex': this label is used to force the application to follow a Mandatory Access Control (MAC) scheme. This means that those processes run in their own security context, isolated from the rest of the system (and other applications). Global security rules can then be applied to restrict access to all other user or system resources.

Check running applications

To check for running applications, just run:

root@porter:~# afm-util ps
-[ { "runid": 1, "state": "running", "id": "webapps-annex@0.0" } ]

The 'runid' is the application instance ID and is used as an argument for the subcommands controlling the application runtime state (kill/stop/resume/status)

Stop application

To stop the application that was just started (the one with RUNID 1), just run the stop command:

root@porter:~# afm-util terminate 1
-true

The application is now stopped, as confirmed by a list of running apps:

root@porter:~# afm-util ps
-[ ]

Uninstall application

To uninstall an application, simply use its ID:

root@porter:~# afm-util uninstall webapps-annex@0.0
-true

Then list the installed apps to confirm the removal:

root@porter:~# afm-util list
-[ { "id": "webapps-memory-match@1.1", "version": "1.1.7", "width": 0, "height": 0, "name": "MemoryMatch", "description": "Memory match", "shortname": "", "author": "Todd Brandt <todd.e.brandt@intel.com>" } ]

afm-client: a sample HTML5 'Homescreen'

afm-client is a HTML5 UI that allows to install/uninstall applications as well as starting/stopping them as already demonstrated with afm-util.

The HTML5 UI is accessible remotely through this URL: http://[board_ip]:1234/opa?token=132456789

Installing an application

By clicking on the 'Upload' button on the right, you can send an application package (WGT file) and install it. Select for example the file 'rabbit.wgt' that was cloned initially from the git repository afm-widget-examples.

Then a popup requester ask for a confirmation: 'Upload Application rabbit.wgt ?'. Click on the 'Install' button.

You should then see some changes in the toolbar: a new icon appeared, representing the freshly installed application.

Running an application

In the toolbar, click on the button representing the Rabbit application. You'll get a popup asking to: * start the application * or get some info about it * or uninstall it

Click on the 'start' item: the application starts and should be visible as a webview on the target board display. Note that at this point, we could also run the application remotely, that is in the same browser as the Homescreen app. By default, the application framework is configured to run applications 'locally' on the board display.

Stopping an application

In the Homescreen application, click again on the Rabbit application button, then select 'stop': the application then stops.

Uninstalling an application

From the same popup menu, you can select 'uninstall' to remove the application from the system. As a consequence, the application icon should disappear from the toolbar.

afb-client: a template for Angular Applications

Another package 'afb-client' is also available for testing. This is a sample HTML5 application demonstrating various basic capabilities of the Binder daemon. It can be used by developers as a template to start writing real AGL Applications.

This application is not available as WGT file yet and it should be started manually without any specific security context:

root@porter:~# /usr/bin/afb-daemon --mode=remote --port=1235 --token='' --sessiondir=/home/root/.afm-daemon --rootdir=/usr/share/agl/afb-client --alias=/icons:/usr/share/afm/icons

Then you can access it from a browser: http://[board_ip]:1235/opa/?token=132456789

afb-client is a simple application to demonstrate the built-in capabilities of the binder daemon (handling sessions and security tokens, testing POSTs uploads...) and was used during the application framework development to validate the proposed features.

- - diff --git a/doc/quick-tutorial.iotstyled.html b/doc/quick-tutorial.iotstyled.html deleted file mode 100644 index 42304f0..0000000 --- a/doc/quick-tutorial.iotstyled.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - - - - - - -

AGL Application Framework: A Quick Tutorial

Introduction

For more information on AGL, please visit: https://www.automotivelinux.org/

Sample applications

4 sample applications (.wgt files) are prebuilt and available at the following address: https://github.com/iotbzh/afm-widget-examples

You can get them by cloning this git repository on your desktop (will be useful later in this tutorial):

$ git clone https://github.com/iotbzh/afm-widget-examples

Using the CLI tool

Setup Environment

Connect your AGL target board to the network and copy some sample widgets on it through SSH (set BOARDIP with your board IP address) :

$ cd afm-widget-examples
-$ BOARDIP=1.2.3.4
-$ scp *.wgt root@$BOARDIP:~/

Connect through SSH on the target board and check for Application Framework daemons:

$ ssh root@$BOARDIP
-root@porter:~# ps -ef|grep bin/afm
-afm        409     1  0 13:00 ?        00:00:00 /usr/bin/afm-system-daemon
-root       505   499  0 13:01 ?        00:00:00 /usr/bin/afm-user-daemon
-root       596   550  0 13:22 pts/0    00:00:00 grep afm

The application framework has a tool running on the Command Line Interface (CLI). Using the afm-util command, you can install, uninstall, list, run, stop ... applications.

To begin, run 'afm-util help' to get a quick help on commands:

root@porter:~# afm-util help
-usage: afm-util command [arg]
-
-The commands are:
-
-  list
-  runnables      list the runnable widgets installed
-
-  add wgt
-  install wgt    install the wgt file
-
-  remove id
-  uninstall id   remove the installed widget of id
-
-  info id
-  detail id      print detail about the installed widget of id
-
-  ps
-  runners        list the running instance
-
-  run id
-  start id       start an instance of the widget of id
-
-  kill rid
-  terminate rid       terminate the running instance rid
-
-  stop rid
-  pause rid      stop the running instance rid
-
-  resume rid
-  continue rid   continue the previously rid
-
-  status rid
-  state rid     get status of the running instance rid

Install an application

You can then install your first application:

root@porter:~# afm-util install /home/root/annex.wgt 
-{ "added": "webapps-annex@0.0" }

Let's install a second application:

root@porter:~# afm-util install /home/root/memory-match.wgt 
-{ "added": "webapps-memory-match@1.1" }

Note that usually, afm-util will return a JSON result, which is the common format for messages returned by the Application Framework daemons.

List installed applications

You can then list all installed applications:

root@porter:~# afm-util list
-[ { "id": "webapps-annex@0.0", "version": "0.0.10", "width": 0, "height": 0, "name": "Annex", "description": "Reversi\/Othello", "shortname": "", "author": "Todd Brandt <todd.e.brandt@intel.com>" },
- { "id": "webapps-memory-match@1.1", "version": "1.1.7", "width": 0, "height": 0, "name": "MemoryMatch", "description": "Memory match", "shortname": "", "author": "Todd Brandt <todd.e.brandt@intel.com>" } ]

Here, we can see the two previously installed applications.

Get information about an application

Let's get some details about the first application:

root@porter:~# afm-util info webapps-annex@0.0
-{ "id": "webapps-annex@0.0", "version": "0.0.10", "width": 0, "height": 0, "name": "Annex", "description": "Reversi\/Othello", "shortname": "", "author": "Todd Brandt <todd.e.brandt@intel.com>" }

Note that AGL applications are mostly handled by afm-util through their IDs. In our example, the application ID is 'webapps-annex@0.0'.

Start application

Let's start the first application Annex:

root@porter:~# afm-util start webapps-annex@0.0
-1

As the application is a HTML5 game, you should then get a webview running with QML on the board display.

Security Context

root@porter:~# ps -efZ |grep webapps-annex | grep -v grep
-User::App::webapps-annex        root       716   491  0 13:19 ?        00:00:00 /usr/bin/afb-daemon --mode=local --readyfd=8 --alias=/icons /usr/share/afm/icons --port=12348 --rootdir=/usr/share/afm/applications/webapps-annex/0.0 --token=7D6D2F16 --sessiondir=/home/root/app-data/webapps-annex/.afb-daemon
-User::App::webapps-annex        root       717   491  0 13:19 ?        00:00:00 /usr/bin/qt5/qmlscene http://localhost:12348/index.html?token=7D6D2F16 /usr/bin/web-runtime-webkit.qml

In the previous result, we see that the application is composed of two processes: * the application binder (afb-daemon) * the application UI (qmlscene ...)

Check running applications

To check for running applications, just run:

root@porter:~# afm-util ps
-[ { "runid": 1, "state": "running", "id": "webapps-annex@0.0" } ]

The 'runid' is the application instance ID and is used as an argument for the subcommands controlling the application runtime state (kill/stop/resume/status)

Stop application

To stop the application that was just started (the one with RUNID 1), just run the stop command:

root@porter:~# afm-util terminate 1
-true

The application is now stopped, as confirmed by a list of running apps:

root@porter:~# afm-util ps
-[ ]

Uninstall application

To uninstall an application, simply use its ID:

root@porter:~# afm-util uninstall webapps-annex@0.0
-true

Then list the installed apps to confirm the removal:

root@porter:~# afm-util list
-[ { "id": "webapps-memory-match@1.1", "version": "1.1.7", "width": 0, "height": 0, "name": "MemoryMatch", "description": "Memory match", "shortname": "", "author": "Todd Brandt <todd.e.brandt@intel.com>" } ]

afm-client: a sample HTML5 'Homescreen'

afm-client is a HTML5 UI that allows to install/uninstall applications as well as starting/stopping them as already demonstrated with afm-util.

The HTML5 UI is accessible remotely through this URL: http://[board_ip]:1234/opa?token=132456789

Installing an application

Then a popup requester ask for a confirmation: 'Upload Application rabbit.wgt ?'. Click on the 'Install' button.

You should then see some changes in the toolbar: a new icon appeared, representing the freshly installed application.

Running an application

In the toolbar, click on the button representing the Rabbit application. You'll get a popup asking to: * start the application * or get some info about it * or uninstall it

Stopping an application

In the Homescreen application, click again on the Rabbit application button, then select 'stop': the application then stops.

Uninstalling an application

From the same popup menu, you can select 'uninstall' to remove the application from the system. As a consequence, the application icon should disappear from the toolbar.

afb-client: a template for Angular Applications

This application is not available as WGT file yet and it should be started manually without any specific security context:

root@porter:~# /usr/bin/afb-daemon --mode=remote --port=1235 --token='' --sessiondir=/home/root/.afm-daemon --rootdir=/usr/share/agl/afb-client --alias=/icons:/usr/share/afm/icons

Then you can access it from a browser: http://[board_ip]:1235/opa/?token=132456789

- - diff --git a/doc/security-framework.html b/doc/security-framework.html deleted file mode 100644 index bf4dd48..0000000 --- a/doc/security-framework.html +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - The security framework - - - - - -

The security framework

JosÃ© Bollo

24 juin 2016

- -

The security framework

NOT STARTED !!!!!!

Setting Smack rules for the application

For Tizen, the following rules are set by the security manager for each application.

System ~APP~             rwx
-System ~PKG~             rwxat
-System ~PKG~::RO         rwxat
-~APP~  System            wx
-~APP~  System::Shared    rxl
-~APP~  System::Run       rwxat
-~APP~  System::Log       rwxa
-~APP~  _                 l
-User   ~APP~             rwx
-User   ~PKG~             rwxat
-User   ~PKG~::RO         rwxat
-~APP~  User              wx
-~APP~  User::Home        rxl
-~APP~  User::App::Shared rwxat
-~APP~  ~PKG~             rwxat
-~APP~  ~PKG~::RO         rxl

Here, _PKG is the identifier of the package and _APP is the identifier of the application.

What user can run an application?

Not all user are able to run all applications. How to manage that?

- - diff --git a/doc/updt.sh b/doc/updt.sh deleted file mode 100755 index d0c02e7..0000000 --- a/doc/updt.sh +++ /dev/null @@ -1,53 +0,0 @@ -#!/bin/bash - -title() { - sed '/^[ \t]*$/d' "$1" | - sed '/^===/Q' | - sed '/^---/Q' | - sed 's/^# //;T;Q' | - sed 's/^## //;T;Q' | - sed '/^---/Q' -} - -authors() { - git log --numstat --format='A %aN' -- "$1" | - awk '$1=="A"{sub(/^A /,"");a=$0; s[a]+=0; next}NF==3{s[a]+=($1+0)}END{for(a in s)print s[a]" : "a}' | - sort -nr | - sed 's/[^:]* : //' | - sed '1!s/^/; /' | - tr -d '\n' -} - -dateof() { - local file="$1" - local t=$(git log -n 1 --format=%ct "$file") - [[ -n "$t" ]] || t=$(stat -c %Y "$file") - LANG= date -d @$t +"%d %B %Y" -} - -meta() { - local file="$1" - local t=$(title "$file") - local a=$(authors "$file") - local d=$(dateof "$file") - echo "% $t" - echo "% $a" - echo "% $d" - cat "$file" -} - - -# make the html file for $1 -mkhtml() { - local x=$1 - local h=${x%%.md}.html - echo updating $h from $x - meta "$x" | - pandoc --css doc.css -f markdown -t html5 --toc > "$h" -} - -# apply -for x in *.md; do - mkhtml $x -done - diff --git a/doc/widgets.html b/doc/widgets.html deleted file mode 100644 index 8c27577..0000000 --- a/doc/widgets.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - - - The widgets - - - - - - -

The widgets

JosÃ© Bollo

Fulup Ar Foll

24 juin 2016

- -

The widgets

The widgets are described by the technical recommendations widgets and widgets-digsig.

In summary, widgets are ZIP files that can be signed and whose content is described by the file .

The configuration file config.xml

This is one of the important file of the widget. It fully describes the widget.

Here is the example of the config file for the QML application SmartHome.

<?xml version="1.0" encoding="UTF-8"?>
-<widget xmlns="http://www.w3.org/ns/widgets" id="smarthome" version="0.1">
-  <name>SmartHome</name>
-  <icon src="smarthome.png"/>
-  <content src="qml/smarthome/smarthome.qml" type="text/vnd.qt.qml"/>
-  <description>This is the Smarthome QML demo application. It shows some user interfaces for controlling an 
-automated house. The user interface is completely done with QML.</description>
-  <author>Qt team</author>
-  <license>GPL</license>
-</widget>

The most important items are:

<widget id="......">: gives the id of the widget. It must be unique.
<widget version="......">: gives the version of the widget
<icon src="...">: gives a path to the icon of the application (can be repeated with different sizes)
<content src="..." type="...">: this indicates the entry point and its type. The types handled are set through the file /etc/afm/afm-launch.conf

Further development will add handling of for requiring and providing permissions and services.

Tools for managing widgets

This project includes tools for managing widgets. These tools are:

wgtpkg-info: command line tool to display informations about a widget file.
wgtpkg-installer: command line tool to install a widget file.
wgtpkg-pack: command line tool to create a widget file from a widget directory.
wgtpkg-sign: command line tool to add a signature to a widget directory.

For all these commands, a tiny help is available with options -h or --help.

There is no tool for unpacking a widget. For doing such operation, you can use the command unzip.

To list the files of a widget:

$ unzip -l WIDGET

To extract a widget in some directory:

$ unzip WIDGET -d DIRECTORY

Note that DIRECTORY will be created if needed.

- -

To sign a widget, you need a private key and its certificate.

The tool wgtpkg-sign creates or replace a signature file in the directory of the widget BEFORE its packaging.

There are two types of signature files: author and distributor.

Example 1: add an author signature

$ wgtpkg-sign -a -k me.key.pem -c me.cert.pem DIRECTORY

Example 2: add a distributor signature

$ wgtpkg-sign -k authority.key.pem -c authority.cert.pem DIRECTORY

- -

This operation can be done using the command zip but we provide the tool wgtpkg-pack that may add checking.

Example:

$ wgtpkg-pack DIRECTORY -o file.wgt

- -

The command wgtpkg-info opens a widget file, reads its config.xml file and displays its content in a human readable way.

- -

What kind of application?

The file /etc/afm/afm-launch.conf explain how to launch applications. (It is the current state that use afm-user-daemon. In a future, it may be replace by systemd features.)

Currently the applications that can be run are:

binary applications: their type is application/x-executable
HTML5 applications: their type is text/html
QML applications: their type is text/vnd.qt.qml

- -

make your application
create its configuration file config.xml
sign it
pack it

Fairly easy, no?

Organization of directory of applications

directory where are stored applications

Applications can be installed in different places: the system itself, extension device. On a phone application are typically installed on the sd card.

This translates to:

/usr/applications: system wide applications
/opt/applications: removable applications

From here those paths are referenced as: "APPDIR".

The main path for applications is: APPDIR/PKGID/VER.

Where:

APPDIR is as defined above
PKGID is a directory whose name is the package identifier
VER is the version of the package MAJOR.MINOR

This organization has the advantage to allow several versions to leave together. This is needed for some good reasons (rolling back) and also for less good reasons (user habits).

Identity of installed files

All files are installed as user "afm" and group "afm". All files have rw(x) for user and r-(x) for group and others.

This allows every user to read every file.

labeling the directories of applications

The data of a user are in its directory and are labelled by the security-manager using the labels of the application.

- - diff --git a/doc/writing-config.xml.html b/doc/writing-config.xml.html deleted file mode 100644 index 2024b94..0000000 --- a/doc/writing-config.xml.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - - - Writing the configuration file "config.xml" - - - - - - -

Writing the configuration file "config.xml"

JosÃ© Bollo

19 septembre 2016

- -

Writing the configuration file "config.xml"

About "config.xml"

The file config.xml describes important data of the application to the framework:

the unique identifier of the application
the name of the application
the type of the application
the icon of the application
the permissions linked to the application
the services and dependancies of the application

The file MUST be at the root of the widget and MUST be case sensitively name config.xml.

The file config.xml is a XML file described by the document widgets.

Example of "config.xml"

Here is the example of the config file for the QML application SmartHome.

<?xml version="1.0" encoding="UTF-8"?>
-<widget xmlns="http://www.w3.org/ns/widgets" id="smarthome" version="0.1">
-  <name>SmartHome</name>
-  <icon src="smarthome.png"/>
-  <content src="qml/smarthome/smarthome.qml" type="text/vnd.qt.qml"/>
-  <description>
-    This is the Smarthome QML demo application.
-    It shows some user interfaces for controlling an automated house.
-    The user interface is completely done with QML.
-  </description>
-  <author>Qt team</author>
-  <license>GPL</license>
-</widget>

Standard elements of "config.xml"

- - -

The attribute id is mandatory (for version 2.x, blowfish) and must be unique.

Values for id are any non empty string containing only latin letters, arabic digits, and the three characters '.' (dot), '-' (dash) and '_' (underscore).

Authors can use a mnemonic id or can pick a unique id using command uuid or uuidgen.

- -

The attribute version is mandatory (for version 2.x, blowfish).

Values for id are any non empty string containing only latin letters, arabic digits, and the three characters '.' (dot), '-' (dash) and '_' (underscore).

Version values are dot separated fields MAJOR.MINOR.REVISION.

The element content

The element content is mandatory (for version 2.x, blowfish) and must designate a file (subject to localisation) with its attribute src.

The content designed depends on its type. See below for the known types.

The element icon

The element icon is mandatory (for version 2.x, blowfish) and must be unique. It must designate an image file with its attribute src.

- -

The configuration file /etc/afm/afm-launch.conf defines the types of widget known and how to launch it.

Known types for the type of content are (for version 2.x, blowfish):

text/html: HTML application, content.src designates the home page of the application
application/x-executable: Native application, content.src designates the relative path of the binary
application/vnd.agl.url: Internet url, content.src designates the url to be used
application/vnd.agl.service: AGL service defined as a binder, content.src designates the directory of provided binders, http content, if any, must be put in the subdirectory htdocs of the widget
application/vnd.agl.native: Native application with AGL service defined as a binder, content.src designates the relative path of the binary, bindings, if any must be put in the subdirectory lib of the widget, http content, if any, must be put in the subdirectory htdocs of the widget
text/vnd.qt.qml, application/vnd.agl.qml: QML application, content.src designate the relative path of the QML root, imports must be put in the subdirectory imports of the widget
application/vnd.agl.qml.hybrid: QML application with bindings, content.src designate the relative path of the QML root, bindings, if any must be put in the subdirectory lib of the widget, imports must be put in the subdirectory imports of the widget
application/vnd.agl.html.hybrid: HTML application, content.src designates the home page of the application, bindings, if any must be put in the subdirectory lib of the widget, http content must be put in the subdirectory htdocs of the widget

AGL features

The AGL framework uses the feature tag for specifying security and binding requirement of the widget.

The current version of AGL (up to 2.0.1, blowfish) has no fully implemented features.

The features planned to be implemented are described below.

feature name="urn:AGL:required-binding"

List of the bindings required by the widget.

Each required binding must be explicited using a entry.

param name=[required binding name]

The value is either:

required: the binding is mandatorily needed except if the feature isn't required (required="false") and in that case it is optional.
optional: the binding is optional

feature name="urn:AGL:required-permission"

List of the permissions required by the widget.

Each required permission must be explicited using a entry.

param name=[required permission name]

The value is either:

required: the permission is mandatorily needed except if the feature isn't required (required="false") and in that case it is optional.
optional: the permission is optional

feature name="urn:AGL:provided-binding"

Use this feature for each provided binding of the widget. The parameters are:

param name="name"

REQUIRED

The value is the string that must match the binding prefix. It must be unique.

param name="src"

REQUIRED

The value is the path of the shared library for the binding.

param name="type"

REQUIRED

Currently it must be application/vnd.agl.binding.v1.

param name="scope"

REQUIRED

The value indicate the availability of the binidng:

private: used only by the widget
public: available to allowed clients as a remote service (requires permission+)
inline: available to allowed clients inside their binding (unsafe, requires permission+++)

param name="needed-binding"

OPTIONAL

The value is a space separated list of binding's names that the binding needs.

feature name="urn:AGL:defined-permission"

Each required permission must be explicited using a entry.

param name=[defined permission name]

The value is the level of the defined permission. Standard levels are:

system
platform
partner
public

This level defines the level of accreditation required to get the given permission. The accreditions are given by signatures of widgets.

- - diff --git a/doc/afm-system-daemon.md b/docs/afm-system-daemon.md similarity index 100% rename from doc/afm-system-daemon.md rename to docs/afm-system-daemon.md diff --git a/doc/afm-user-daemon.md b/docs/afm-user-daemon.md similarity index 100% rename from doc/afm-user-daemon.md rename to docs/afm-user-daemon.md diff --git a/doc/application-framework.md b/docs/application-framework.md similarity index 100% rename from doc/application-framework.md rename to docs/application-framework.md diff --git a/docs/index.md b/docs/index.md new file mode 120000 index 0000000..75cc59e --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +overview.md \ No newline at end of file diff --git a/doc/overview.md b/docs/overview.md similarity index 100% rename from doc/overview.md rename to docs/overview.md diff --git a/doc/quick-tutorial.md b/docs/quick-tutorial.md similarity index 100% rename from doc/quick-tutorial.md rename to docs/quick-tutorial.md diff --git a/doc/security-framework.md b/docs/security-framework.md similarity index 100% rename from doc/security-framework.md rename to docs/security-framework.md diff --git a/doc/triskel_iot_bzh.svg b/docs/triskel_iot_bzh.svg similarity index 100% rename from doc/triskel_iot_bzh.svg rename to docs/triskel_iot_bzh.svg diff --git a/doc/widgets.md b/docs/widgets.md similarity index 100% rename from doc/widgets.md rename to docs/widgets.md diff --git a/doc/writing-config.xml.md b/docs/writing-config.xml.md similarity index 100% rename from doc/writing-config.xml.md rename to docs/writing-config.xml.md diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..065b230 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,13 @@ +site_name: AGL Application Framework +theme: readthedocs +docs_dir: docs +pages: + - 'Overview' : 'index.md' + - 'Quick tutorial' : 'quick-tutorial.md' + - 'The system daemon' : 'afm-system-daemon.md' + - 'The user daemon' : 'afm-user-daemon.md' + - 'Widgets of the framework' : 'widgets.md' + - 'Writing widget''s configuration' : 'writing-config.xml.md' + - 'The security framework' : 'security-framework.md' + - 'The application framework' : 'application-framework.md' + -- 2.16.6