design/revisedclientarchitecture.mdwn

   1 ## Revised Client Architecture
   2
   3 The architecture of the initial implementation needs to be re-factored to with give better Model, View, Controller separation, allowing for:
   4
   5 - more ways of interacting with the server than the ID Selector App and Web Provisioning;
   6 - different storage strategies;
   7 - ease of maintenance.
   8
   9 Specific requirements from the Statement of Work are
  10
  11     6.1 Abstract the interface between the Identity Selector and its backend datastore.
  12         This is required to allow different such datastores to be used at will (e.g. Gnome
  13         Keyring, Mac Keychain, etc).
  14
  15     6.2 Abstract the interface between the core logical component of the Identity Selector
  16         and the current UI elements. This is required to enable other interfaces to the Identity
  17         Selector to work, such as a platform specific UI or a Command Line Interface to enable
  18         headless operation. Any policy or invariant or constraint logic currently independent of
  19         the core logical component must be abstracted into the core so that no matter what
  20         backend datastore or UI frontend is used, all policy or invariant or constraint logic is
  21         always used and enforced.
  22
  23 ### Overview
  24
  25 This diagram shows the proposed new architecture.
  26 ![image](https://gitorious.org/petefoth-public-docs/petefoth-public-docs/blobs/raw/master/Moonshot/Proposed%20New%20Architecture.jpg)
  27 The re-factored Moonshot Client software will have the following components:
  28
  29 *_identity-server_*  shared library offering C and Vala APIs.
  30
  31 - provides Create / Read / Update / Delete functionality for IDs
  32 - is the only means of accessing the _identity-storage-server_
  33 - includes the server functionality initially implemented in UI
  34
  35 *_identity-storage-server_*  encapsulates the Identity Store in a shared library offering a CRUD API to access the store.
  36
  37 - protects the store from multiple concurrent write access
  38 - re-implemented per platform and per storage strategy so
  39
  40   * one version each for Linux, Mac OS and Windows, local storage. DBus provides an appropriate mechanism under Linux and Mac OSX for protecting the store from multiple concurrent write access. It is not supported on Windows, so the Windows implementation will use a different mechanism. This version will re-use storage-related code from src/moonshot-window.vala etc.
  41   * one version for web storage, restful API. (Not in scope for this iteration).
  42   * other versions as required for different storage solutions  (Not in scope for this iteration).
  43
  44 *_identity-provisioning_* - not currently implemented. Provides CRUD operations via (for now) .msht and XML files, and via command line. Implemented in portable code as far as possible. Uses *_identity-server_*. Consists of
  45
  46 - *_identity-provisioning-file-handler_* - processes .msht (and, in future iterations, XML and/or json, and maybe other format) files for file-based provisioning operations. Currently implemented as *_moonshot-webp_*, allowing only install access. In future iterations it will also allow uninstall/revoke access.
  47 - *_identity-provisioning-cli-handler_* - provides a command line API to identity CRUD functions
  48
  49 All of the components will be implemented in Vala.
  50
  51 ### Detail _identity-server_ component
  52
  53 Implemented as a shared library in Vala. Built with the -H option to enable access from C code, and introspection generated to allow use from other languages.
  54
  55 Replaces the _libmoonshot_ component from the initial implementation.
  56
  57 Owns the public APIs for accessing the Identity Store (rather than exposing currently APIs provided via DBus by moonshot-ui).
  58
  59 Provides new APIs needed by identity-selector-ui to manage identities (e.g. CreateNewIdCard(), UpdateIdCard(), DeleteIdCard()) as well as the existing APIs provided by lib-moonshot (getIdentity(), GetDefaultIdentity(), InstallId_card()).
  60
  61 Uses the APIs provided by the *_identity-storage-server_* component (_-dbus-local-storage-server_ on Linux and Mac, _-windows-local-storage-server_ on Windows).
  62
  63 It has no UI, so that it can be used in circumstances where interaction with a user is not possible (e.g. in headless servers). Any needed interaction with the User is done by client software.
  64
  65 ### Detail _identity-selector-ui_ component
  66
  67 This is now just an App for managing Identities. It's *only* function is to allows a User to manage Identities and Services.
  68
  69 It no longer owns the IdentityStore.
  70
  71 It no longer *provides* APIs (via DBus) for use by others via libmoonshot.
  72
  73 Instead, it *uses* APIs provided by _identity-server_.
  74
  75 Implemented in Vala using GTK widgets, reusing code from src/moonshot-window.vala and other UI related code..
  76
  77 ### Detail _identity-provisioning_ component
  78
  79 The *_identity-provisioning-file-handler_* component replaces the moonshot-webp component. It provides the same InstallIdentityCard() functionality as the moonshot-webp component in the initial implementation. In future iterations, it will provide new functions to uninstall and revoke identities. It has no UI - any interaction with the User is done when the file is processed by the *_identity-server_*
  80
  81 The *_identity-provisioning-cli-handler_* component is not part of the current iteration. In a future iterations it is intended to provide via the command line the same functionality as *_identity-provisioning-file-handler_* but without requiring any interaction with the user.
  82
  83 ### Use Case Implementation
  84
  85 The re-factored software is designed to implement the following use cases that were part of the first iteration:
  86
  87 1. User installs and identity by clicking on a .msht file downloaded from the Web
  88 1. User creates and installs an identity card using the UI
  89 1. User modifies an existing identity card using the UI
  90 1. User deletes an existing identity card using the UI
  91
  92 It is designed to extend the above Uses cases as follows:
  93
  94 1. User can install .msht files when attached to emails
  95 1. User can use .msht files to delete or revoke identities
  96 1. User can create, view, update and delete installed identities via the command line
  97 1. User can create, view, update and delete installed identities using a script file
  98
  99 Not all of these will be implemented in the current phase, but the software will be implemented in a way that facilitates their implementation in future phases.
 100