#PEP Proxy - Wilma

• Introduction
• How to Build & Install
  • Docker
• API Overview
• Advanced documentation
• License

---

Introduction

This project is part of FIWARE. You will find more information about this FIWARE GE here.

• You will find the source code of this project in GitHub here
• You will find the documentation of this project in Read the Docs here

Thanks to this component and together with Identity Management and Authorization PDP GEs, you will add authentication and authorization security to your backend applications. Thus, only FIWARE users will be able to access your GEs or REST services. But you will be able also to manage specific permissions and policies to your resources allowing different access levels to your users.

How to Build & Install

• Software requirements:

  • nodejs >= v0.10.37
  • npm >= 1.3.6 Note: Both can be installed from (http://nodejs.org/download/)

• Clone Proxy repository:

git clone https://github.com/ging/fiware-pep-proxy.git

• Install the dependencies:

cd fiware-pep-proxy/
npm install

• Duplicate config.template in config.js and configure app host there.

config.app_host = 'www.google.es'; // Hostname to forward authenticated requests
config.app_port = '80';            // Port where the HTTP server is running

• Start proxy server

sudo node server

Docker

We also provide a Docker image to facilitate you the building of this GE.

• Here you will find the Dockerfile and the documentation explaining how to use it.
• In Docker Hub you will find the public image.

API Overview

Requests to proxy should be made with a special HTTP Header: X-Auth-Token. This header contains the OAuth access token obtained from FIWARE IDM GE.

Example of request:

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

To test the proxy you can generate this request running the following command:

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

Once authenticated, the forwarded request will include additional HTTP headers with user info:

X-Nick-Name: nickname of the user in IdM
X-Display-Name: display name of user in IdM
X-Roles: roles of the user in IdM
X-Organizations: organizations in IdM

Advanced Documentation

• How to run tests
• User & Programmers Manual
• Installation & Administration Guide

License

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.