Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ging/fiware-pep-proxy
Support for proxy functions within OAuth2-based authentication schemas. Also implements PEP functions within an XACML-based access control schema.
https://github.com/ging/fiware-pep-proxy
access-control fiware pep pep-proxy
Last synced: about 1 month ago
JSON representation
Support for proxy functions within OAuth2-based authentication schemas. Also implements PEP functions within an XACML-based access control schema.
- Host: GitHub
- URL: https://github.com/ging/fiware-pep-proxy
- Owner: ging
- License: mit
- Created: 2013-07-24T15:43:34.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T08:38:31.000Z (9 months ago)
- Last Synced: 2024-08-02T01:21:15.875Z (4 months ago)
- Topics: access-control, fiware, pep, pep-proxy
- Language: JavaScript
- Homepage: https://fiware-pep-proxy.rtfd.io/
- Size: 2.2 MB
- Stars: 27
- Watchers: 21
- Forks: 47
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - Wilma - A PEP Proxy which can be used to secure NGSI endpoints. Integrates with Keyrock and Authzforce. (FIWARE Catalogue / Security)
README
# PEP Proxy - Wilma
[](https://www.fiware.org/developers/catalogue/)
[](https://opensource.org/licenses/MIT)
[](https://quay.io/repository/fiware/pep-proxy)
[](https://stackoverflow.com/questions/tagged/fiware-wilma)
[](https://fiware-pep-proxy.readthedocs.io/en/latest/)
[](https://github.com/ging/fiware-pep-proxy/actions?query=workflow%3ACI)
[](https://coveralls.io/github/ging/fiware-pep-proxy?branch=master)
[](https://bestpractices.coreinfrastructure.org/projects/4417)
Wilma is a PEP Proxy - it can be combined with other security components such as
[Keyrock](https://github.com/ging/fiware-idm) and [Authzforce](https://github.com/authzforce/server) to enforce access
control to your backend applications. This means that only permitted users will be able to access your Generic Enablers
or REST services. Identity Management allows you to manage specific permissions and policies to resources allowing
different access levels for your users.
This project is part of [FIWARE](https://www.fiware.org/). For more information check the FIWARE Catalogue entry for
[Security](https://github.com/Fiware/catalogue/tree/master/security).
| :books: [Documentation](https://fiware-pep-proxy.readthedocs.io/en/latest/) | :mortar_board: [Academy](https://fiware-academy.readthedocs.io/en/latest/security/wilma) | 
[quay.io](https://quay.io/repository/fiware/pep-proxy) | :dart: [Roadmap](https://github.com/ging/fiware-pep-proxy/blob/master/roadmap.md) |
| --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------- |
## Content
- [Install](#how-to-build--install)
- [Docker](#docker)
- [API](#api-overview)
- [Tests](#tests)
- [Advanced Documentation](#advanced-documentation)
- [Quality Assurance](#quality-assurance)
- [License](#license)
## Install
- Software requirements:
- nodejs >= v8.x.x
- npm >= 5.x.x
Note: Both can be installed from [Node.js](http://nodejs.org/download/)
- Clone Proxy repository:
```console
git clone https://github.com/ging/fiware-pep-proxy.git
```
- Install the dependencies:
```console
cd fiware-pep-proxy/
npm install
```
- Duplicate config.template in `config.js` and configure app host there.
```javascript
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
```console
sudo npm start
```
> **ATTENTION!!!**
>
> There is an existing security exploit in all versions older than 2.15 of Log4J. Although not
> using this software currently, the older 7.x.x versions of PEP-Proxy used to use Log4j for logging.
> Prior to the release 8.0.0, older versions of this software were affected by this exploit as well.
> Logging was updated to use Debug and Morgan in March 2021. We released a new version 8.0.0 on dockerhub.
> Also latest is updated already. If still using 7.x.x please update as soon as possible.
### Docker
We also provide a Docker image to facilitate you the building of this GE.
- [Here](https://github.com/ging/fiware-pep-proxy/tree/master/extras/docker) you will find the Dockerfile and the
documentation explaining how to use it.
- In [Docker Hub](https://hub.docker.com/r/fiware/pep-proxy/) you will find the public image.
## API
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 requests:
```text
GET / HTTP/1.1
Host: proxy_host
Authorization: Bearer z2zXk...ANOXvZrmvxvSg
```
```text
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:
```console
curl --header "X-Auth-Token: z2zXk...ANOXvZrmvxvSg" http://proxy_host
```
or
```console
curl --header "Authorization: Bearer z2zXk...ANOXvZrmvxvSg" http://proxy_host
```
Once authenticated, the forwarded request will include additional HTTP headers with user info:
```text
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
```
## Tests
For performing a basic end-to-end test, you have to follow the next steps. A detailed description about how to run tests
can be found [here](https://fiware-pep-proxy.readthedocs.io/en/latest/admin_guide#end-to-end-testing).
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 requests:
```text
GET / HTTP/1.1
Host: proxy_host
Authorization: Bearer z2zXk...ANOXvZrmvxvSg
```
```text
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:
```console
curl --header "X-Auth-Token: z2zXk...ANOXvZrmvxvSg" http://proxy_host
```
or
```console
curl --header "Authorization: Bearer z2zXk...ANOXvZrmvxvSg" http://proxy_host
```
Once authenticated, the forwarded request will include additional HTTP headers with user info:
```text
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](https://fiware-pep-proxy.readthedocs.io/en/latest/admin_guide#end-to-end-testing)
- [User & Programmers Manual](https://fiware-pep-proxy.readthedocs.io/en/latest/user_guide/)
- [Installation & Administration Guide](https://fiware-pep-proxy.readthedocs.io/en/latest/admin_guide/)
## Quality Assurance
This project is part of [FIWARE](https://www.fiware.org/) and has been rated as follows:
- **Version Tested:**
- **Documentation:**
- **Responsiveness:**
- **FIWARE Testing:**
---
## License
Wilma PEP Proxy is licensed under the [MIT](LICENSE) License.
© 2018 - 2023 Universidad Politécnica de Madrid.