PEP Proxy - Wilma

License badge Documentation badge Docker badge Support badge


イントロダクション

このプロジェクトは FIWARE の一部です。この FIWARE GE の詳細については、こちらをご覧ください。

  • このプロジェクトのソースコードは GitHub のこちら にあります
  • このプロジェクトのドキュメントは、こちらのドキュメントをご覧ください

このコンポーネントのおかげで、Identity Management および Authorization PDP GE とともに、バックエンド・アプリケーションに認証および認可のセキュリティを追加します。したがって、FIWARE ユーザのみが GEs または REST サービスにアクセスできます。しかし、リソースに対する特定のアクセス許可やポリシーを管理して、ユーザに異なるアクセスレベルを許可することもできます。

ビルドとインストール方法

  • ソフトウェア要件 :

  • Proxy リポジトリをクローン :

git clone https://github.com/ging/fiware-pep-proxy.git
  • 依存関係をインストール :
cd fiware-pep-proxy/
npm install
  • config.js に config.template を複製し、そこに app ホストを設定
config.app_host = 'www.google.es'; //認証されたリクエストを転送するホスト名
config.app_port = '80'; // HTTPサーバが動作しているポート
  • Proxy サーバを起動
sudo node server

Docker

また、この GE の構築を容易にする Docker イメージも提供しています。

  • ここでは、Dockerfile とそれを使用する方法を説明するドキュメントがあります
  • Docker Hub では、パブリック・イメージを見つけることができます

API の概要

プロキシへのリクエストは特別な HTTP Header: X-Auth-Token で行う必要があります。このヘッダには、FIWARE IDM GE から取得した OAuth アクセストークンが含まれています。

リクエストの例 :

GET / HTTP/1.1
Host: proxy_host
X-Auth-Token:z2zXk...ANOXvZrmvxvSg

Proxy をテストするには、次のコマンドを実行してこのリクエストを生成します :

curl --header "X-Auth-Token:z2zXk...ANOXvZrmvxvSg" http://proxy_host

認証されると、転送されたリクエストには、ユーザ情報を含む追加の HTTP ヘッダが含まれます :

X-Nick-Name : IdM のユーザのニックネーム
X-Display-Name : IdM のユーザの表示名
X-Roles : IdM におけるユーザの役割
X-Organisation : IdM の組織

高度なドキュメント

ライセンス

The MIT License

Copyright (C) 2012 Universidad Politécnica de Madrid.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.