1.7.21

Personiumアプリ

Personiumアプリ規約はあまり明文化されておらず、新たにアプリ開発に取り組むディベロッパーに対する障壁となっているため、まずはこのWikiにおいてドラフトのドラフトとして、体裁等はさておき情報公開のために記述していくこととする。

Personiumアプリについて

Personiumのインターフェースは基本的にREST APIのみでありGUIを持たない実装となっている。
とはいえ、エンドユーザが利用するためにGUIは必須であるので、PersoniumプロジェクトではサンプルとなるGUI実装を公開している。

公開しているサンプルを用いて、アプリディベロッパーによって自由に開発することが可能である。

ただし、Personiumアプリにおいて注意すべきことは、Openなエコシステムとして多くのプレーヤーにアプリ開発を参入してもらうことを想定し、ある程度の規約が存在することである。（その点についてはWebにおける各種プロトコルや、AndroidなどのMobile OSと同様である）

Diagram

挙動イメージ

YouTube動画

アプリの種類

Personiumでは、使用するAPIの権限レベルに応じて、大きく以下の3種類のGUIに分類される。APIの分類についての詳細はここを参照。

  1. 一般アプリ
  2. Cell管理クライアント（Homeアプリ）
  3. Unit管理クライアント

以降はこれらのそれぞれについて、定義やデプロイ方法を記載する。

1. 一般アプリ

一般アプリは、個人の所有するPDS（Cell）内の、アプリ毎の特定領域（Box）に対してのみデータの操作が可能なGUIである。
対象となるデータは、アプリ提供者が実際に行っている（Webなどの）各サービスに特化したものが想定される。
通常のアプリディベロッパーは、この一般アプリの枠組みでアプリを開発し、Personium Cell の所有者にインストールしてもらうことで、Personiumプラットフォーム上で自身のサービスを展開できる。

メリット

Personiumアプリの枠組みを利用してサービスアプリケーションを利用・提供するメリットは以下である。

  • ユーザ：自身のPDS(Personium Cell)内にデータを一元的に保持しつつ、様々なWebサービスを利用することが可能である。サービス提供者に提供するデータ範囲も規定でき、さらにサービサーによる情報漏洩のリスクを軽減できる。
  • サービス提供者：パーソナルデータはユーザ自身のPersonium Cellにあるため、最低限のデータ管理を行う程度で済む（漏洩リスク軽減）。また、ユーザがPDSに一元管理している、サービスとは本来関係ないデータに対して参照アクセス依頼をかけることができ、ユーザから承認さえされればデータを閲覧することも可能となる（マーケット調査やアンケート機能の代替）
実装例
フォルダ構造

GitHubで公開している各種アプリのフォルダ構成は一定のルールでリソースを格納されており、このリソースをPersoniumのCell（アプリCell）にデプロイすることで、ユーザがBarfileをインストールし、アプリを利用することが可能となる。

アプリCellは通常の「人」に対応しない、「アプリ」というオブジェクトに対応する特殊なCellの一つである。

│  launch.json
│  profile.json
│  relations.json
│  roles.json
│  
├─bar
│  └─00_meta
│          00_manifest.json
│          90_rootprops.xml
│          
├─doc
│      
├─icon
│      
├─locales
│  ├─en
│  │      profile.json
│  │      
│  └─ja
│          profile.json
│          
└─src
    └─html
        │  app.html
        │  
        ├─css
        │      common.css
        │      
        ├─Engine
        │      getAppAuthToken.js
        │      
        ├─img
        │      github.png
        │      
        ├─js
        │      app.js
        │      common.js
        │      common_personium.js
        │      
        └─locales
            ├─en
            │      common.json
            │      glossary.json
            │      
            └─ja
                    common.json
                    glossary.json

以下にGitHubで公開しているアプリリソースの構造と、デプロイ方法をまとめる。

#フォルダ、ファイル用途
1bar各ユーザのbox内にデータ構造を展開するarchiveファイルのソース。.bar形式にZip圧縮してデプロイする（barファイル詳細
2iconHomeアプリ内で表示されるicon
3launch.jsonアプリの起動URIを記述したドキュメント。
URLスキームをカスタムすることにより、ネイティブアプリを起動することが可能となる予定。
4アプリのDefaultファイル
profile.jsonアプリの概要を記載したドキュメント。
インストール画面で表示。
relations.jsonアプリで定義したRelationの表示名・説明・アイコンを記載したドキュメント。
Relationを定義していないの場合、JSONファイルに空のHashを記載して置いてください。
roles.jsonアプリで定義したRoleの表示名・説明・アイコンを記載したドキュメント。
Roleを定義していないの場合、JSONファイルに空のHashを記載して置いてください。
5アプリの多言語対応向けファイル
locales/en/*.json英語版のファイル
locales/ja/*.json日本語版のファイル
6src/androidAndroidアプリソース。
7src/html一般もしくはMobile browser向けアプリソース。直接アクセスする
8src/iosiOSアプリソース。

2. Cell管理クライアント（Homeアプリ）

Cell管理クライアントは、Cellの所有者であるユーザがCellの管理権限相当の操作を行うためのGUIのことを指す。 Cellの管理権限相当の操作はCellレベルAPIで 詳細はここを参照。

機能

Cell管理クライアントはおおまかに以下の機能を有しています。

  1. Cell管理権限（root）によるデータ全体管理
  2. AccountやRoleなどのCell制御オブジェクトや、ユーザプロフィールの登録・変更
  3. 他Cellとの関係登録、メッセージによる登録依頼 (いわゆる友達登録のようなもの)
  4. 関係登録後、アクセス許可された他Cell内データの参照
  5. アプリに紐づくBox(データ構造）のインストール
  6. アプリの起動（ランチャー）
  7. Boxに紐づかないメッセージの送受信

また以下の機能は計画中です

  1. アプリ利用データ権限管理、BOXアンインストール
  2. Cell内データのエクスプローラ
  3. ネイティブアプリ実装
  4. QRコード、NFC等によるCell URLの入力不要化
  5. ユーザ定義Eventの設定、発火ログの閲覧

サンプル実装

  1. ホームアプリ

3. Unit管理クライアント

Unit管理クライアントはUnitレベルの操作（Cellの新規作成や削除などの管理操作）を実施するためのGUIである。現状以下のものが公開されている。

  1. UnitManager
    Unit/Cell Manager YouTube
  2. Cell作成クライアント
    Cell Creator Wizard YouTube
  3. (参考)PCUI

これらはUnit管理権限を持つ特別なToken(Personium Serverで定義されたUnitAdmin Cellで発行可能)を使用するため、ログイン時にはそれらを取得するための情報(以下4つ)を何らかの形でインプットする必要がある。

  1. Personium環境のURL
  2. UnitAdminCellのCell名（PersoniumのUnitConfigで規定）
  3. UnitAdminアカウント
  4. UnitAdminのパスワード

デプロイ方法

UnitManagerに関しては、Homeアプリと同様に、一般的なWebサーバにデプロイすることで使用可能である。

Electronフレームワークを用いてネイティブ化することも検討中

アプリ認証

Personiumのアプリエコシステムにおいて、PDSに対する不正なアクセスを試みるフィッシングアプリからの防衛を考慮する必要があります。アプリが定義するBoxにはアプリ認証による保護を有効にすべきです。

アプリ認証とは、リソースにアクセスする主体が、個人のCell認証に加えて、サービサーが管理するアプリCellによって認証する枠組みであり。アクセス制限されたBoxのaccess tokenの取得に関してはここを参照されたい。

開発作業者が、デバッグ等で一般アプリをHomeアプリから起動しない場合、Box内にアクセスするためにはアプリ認証後トークンを別途取得する必要がある。

補足:
今後、アプリ認証においては、URLハッシュなどを用いて複数Schemaを定義することを可能とする予定である。

← クライアント登録&認証古いバージョンのAPIリファレンス →