README.md

   1
   2                                  .lOX0c0k;           ,o00k;'
   3                                     'o0WMMW0o;.         ,doX0.
   4                                  .cxk',MMMMMMMMMWNNWWNX0x,:MMMk'
   5                    ':loxxxxdoodkNMMMMN oMMMMMMMMMMMMMMMMMMlkMMMMXd'     .
   6                 ,OMMMMMMMMMMMMMMMMMMMM'.MMMMMMMMMMMMMMMMMW.OMMMMMMMWOo,  O0c
   7               .0W:kMMMMMMMMMMMMMMMMMMMl XMMMMMMMMMMMMMMMK.dMMMMMMMMMMMMW;l0;K:
   8               ::;c:lkWMMMMMMMMMMMMMMMMX oMMMMMMMMMMMMMMo.OMMMMMMMMMMMMM0,NMMMM.
   9                .kMWOl,;OMMMMMMMMMMMMMMMo.WMMMMMMMMMMMW,'NMMMMMMMMMMMM0,:WMMMMM'
  10               lWMMMMMMNd:xWMMMMMMMMMMMMM.:MMMMMMMMMMM;cMMMMMMMMMMMWx.;KMMMMMMM.
  11            .lNMMMMMMMMMMMO:lXMMMMMMMMMMM0 oMO;WMMMMModW;OMMMMMMM0c,oNMMMMMMMMMx    .
  12         'oKMMMMMMMMMMMMMMMMK:,xWMMMNWMMMMx .cl;''',c;;':xKXX0ddoxXMMMMMMMMMMMMM;   Xd
  13       'KMMMMMMMMMMMMMMMMMMMMMWd':OWckMX, 'c.:c;,,;ccdoK'      kMk;WMMMMMMMMMMMMW. 'NdO
  14      .WMMMMMMMMMMMMMMMMMMMMMMMMMKl:lko   ':;xNMMMMMMd0MMKxl.O: ,OK0kdl::cdkkkxdo:xWMMM,
  15      'N;0MMMWWWMMMMMMMMMMMMMMMMMMMMl     .OWKocxWMMMMlMMMMN,dOo   lWoXMMWNXXXNMMMMMMMW
  16       KXd,. .dlc:::cxKWMMMMMMMKKMMd  .:dKMMMMMMKloKk0cOxXk'kMMWo   ':lx0WMMMMMMMMMMMMc
  17             lMMMMMMWKkooolokKNkkMd ;kMMMMMMMMMMMMNodc  ,.'d,x0Ox'  xldl' .:dKMMMMMMMk
  18             OMMMMMMMMMMMMMNOxolo   Wl:.,kkxxxxkkko',              cMNMMMM0o;..;dKWNo .lc
  19            .MMMMMMMMMMMMMMMMMMMM.  ;   oMMMMMMMMMNKd            .'lWMMMMMMMMMN0kdlld0XdO
  20            0MMMMMMMMMMMMMMMMMMMMN.    :WMMMMMMMMMKld.         dNXdK,cXMMMMMMMMMMMMMMMMX'
  21           lMMMMMMMMMMMMMMMMMMMMMMN.  lMMMMMMXkoooxNMMKl:.xd0:,MMMMMMd.:XMMMMMMMMMMMWk,
  22          'MMMMMMMMMMMMMMMMMMMMMk;Nk  KMMM0xdxKWMMMMMMWd,XMNN: WMMMMMMNc :XMMMMMMMNc
  23          kKOMMMWKkdlc:;,''''''''''.  l0kd.XMMMMMMMMM0,lWMMMMl 0MMMMMMMMWd.:XMMMMk
  24          o0x0:.                       cO   xMMMMMMW:'XMMMMMMk OMMMMMMMMMMMKloxk;
  25           Od                                cMMMMMo KMMMMMMMW dMMMMMMMMMMMMMMXlOOl
  26                                              lMMMM0.,d0WMMMMM0.xOkdlccloxkOOOd::.
  27                                               ,kWMMKc:  ,dXMMMWd;.
  28                                                  .;:cxk;   .,co,ckk;
  29     ,clc,       cc:'
  30     lMMMMK     oMMMMo
  31      XMMMM,   .WMMMW.  ,lxOOOOxc.     .cdkOOkd;   :xxo.    cxxl.   xxd: ,dOOOxc .cxOOkd,
  32      :MMMMk   OMMMM; .NMMMX0NMMMMo   OMMMKOXMMMl  XMMMK    NMMMx  'MMMMWWKXMMMMXWN0WMMMM;
  33       KMMMW  ;MMMMl  .kXXl   NMMM0  'MMMX,  xxc   MMMMx   .MMMMo  cMMMMK.  XMMMMc  'MMMM:
  34       'MMMMc NMMMo    ;dOKNNWMMMMd   cXMMMMNOl.  .MMMM:   :MMMM;  xMMMM.   WMMMO   ;MMMM'
  35        kMMMXkMMMx   ;WMMMc. oMMMMc     .'c0MMMW. ;MMMM;  .NMMMM.  0MMMX   .MMMMc   dMMMM
  36        .WMMMMMMd    xMMMMX0NWMMMMMO.NMNOkkXMMMX  .WMMMMKKMWMMMW   XMMMk   :MMMM,   kMMMX
  37         .oxxxx:      cxO0Od; :k0Od. 'lxkO0Oko;    .ckO0kl..lxxo   'dxx,    lxxx    .oxxc
  38
  39
  40 # Vasum
  41 [Vasum](https://wiki.tizen.org/wiki/Security:Vasum) is a Linux daemon and a set of utilities used for managing para-virtualization. It uses Linux Containers to create separate, graphical environments called *zones*. One can concurrently run several zones on one physical device. Vasum exports a rich C/Dbus API that the application frameworks can use to interact with zones.
  42
  43 For now Vasum uses [LXC](https://linuxcontainers.org/lxc/introduction/) for Linux Containers management. The project is mostly written in modern C++, is [well tested](https://wiki.tizen.org/wiki/Weekly_test_results_for_Tizen_3.X_security_framework).
  44
  45 Vasum's development takes place on [review.tizen.org/gerrit/](http://review.tizen.org/gerrit/) (registration on [tizen.org](http://tizen.org) is required).
  46
  47 ## Installation and usage
  48 The installation process and simple verification is described [here](https://wiki.tizen.org/wiki/Security:Vasum:Usage).
  49
  50 ## Client interface
  51 Vasum daemon can be accessed via C API or Dbus. You can find the API documentation [here](https://wiki.tizen.org/wiki/Security:Vasum:API). Be aware that the API will most likely change in the near future.
  52
  53 ## Documentation
  54 More comprehensive documentation is kept [here](https://wiki.tizen.org/wiki/Security:Vasum). You can generate the code documentation by executing *generate_documentation.sh* script from *doc* directory. Documentation will be generated in doc/html directory.
  55
  56     cd ./doc
  57     ./generate_documentation.sh
  58
  59
  60 ## Code formatting
  61 We use [astyle](http://astyle.sourceforge.net/) for code formatting (Use the latest version)
  62 You can find the options file in the root of the project.
  63
  64 For example to format all .cpp and .hpp files run in the project directory:
  65
  66     astyle --options=./astylerc --recursive ./*.cpp ./*.hpp