![\"FIWARE](\"https://img.shields.io/badge/FIWARE-Security-ff7059.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABsAAAAVCAYAAAC33pUlAAAABHNCSVQICAgIfAhkiAAAA8NJREFUSEuVlUtIFlEUx+eO+j3Uz8wSLLJ3pBiBUljRu1WLCAKXbXpQEUFERSQF0aKVFAUVrSJalNXGgmphFEhQiZEIPQwKLbEUK7VvZrRvbr8zzjfNl4/swplz7rn/8z/33HtmRhn/MWzbXmloHVeG0a+VSmAXorXS+oehVD9+0zDN9mgk8n0sWtYnHo5tT9daH4BsM+THQC8naK02jCZ83/HlKaVSzBey1sm8BP9nnUpdjOfl/Qyzj5ust6cnO5FItJLoJqB6yJ4QuNcjVOohegpihshS4F6S7DTVVlNtFFxzNBa7kcaEwUGcbVnH8xOJD67WG9n1NILuKtOsQG9FngOc+lciic1iQ8uQGhJ1kVAKKXUs60RoQ5km93IfaREvuoFj7PZsy9rGXE9G/NhBsDOJ63Acp1J82eFU7OIVO1OxWGwpSU5hb0GqfMydMHYSdiMVnncNY5Vy3VbwRUEydvEaRxmAOSSqJMlJISTxS9YWTYLcg3B253xsPkc5lXk3XLlwrPLuDPKDqDIutzYaj3eweMkPeCCahO3+fEIF8SfLtg/5oI3Mh0ylKM4YRBaYzuBgPuRnBYD3mmhA1X5Aka8NKl4nNz7BaKTzSgsLCzWbvyo4eK9r15WwLKRAmmCXXDoA1kaG2F4jWFbgkxUnlcrB/xj5iHxFPiBN4JekY4nZ6ccOiQ87hgwhe+TOdogT1nfpgEDTvYAucIwHxBfNyhpGrR+F8x00WD33VCNTOr/Wd+9C51Ben7S0ZJUq3qZJ2OkZz+cL87ZfWuePlwRcHZjeUMxFwTrJZAJfSvyWZc1VgORTY8rBcubetdiOk+CO+jPOcCRTF+oZ0okUIyuQeSNL/lPrulg8flhmJHmE2gBpE9xrJNkwpN4rQIIyujGoELCQz8ggG38iGzjKkXufJ2Klun1iu65bnJub2yut3xbEK3UvsDEInCmvA6YjMeE1bCn8F9JBe1eAnS2JksmkIlEDfi8R46kkEkMWdqOv+AvS9rcp2bvk8OAESvgox7h4aWNMLd32jSMLvuwDAwORSE7Oe3ZRKrFwvYGrPOBJ2nZ20Op/mqKNzgraOTPt6Bnx5citUINIczX/jUw3xGL2+ia8KAvsvp0ePoL5hXkXO5YvQYSFAiqcJX8E/gyX8QUvv8eh9XUq3h7mE9tLJoNKqnhHXmCO+dtJ4ybSkH1jc9XRaHTMz1tATBe2UEkeAdKu/zWIkUbZxD+veLxEQhhUFmbnvOezsJrk+zmqMo6vIL2OXzPvQ8v7dgtpoQnkF/LP8Ruu9zXdJHg4igAAAABJRU5ErkJgggA=\"){kind=icon}
This tutorial uses the FIWARE Wilma PEP Proxy combined with Keyrock to secure access to endpoints exposed by\nFIWARE generic enablers. Users (or other actors) must log-in and use a token to gain access to services. The application\ncode created in the previous tutorial is expanded to authenticate\nusers throughout a distributed system. The design of FIWARE Wilma - a PEP Proxy is discussed, and the parts of the\nKeyrock GUI and REST API relevant to authenticating other services are described in detail.
\nThe docker-compose files for this tutorial can be found on GitHub:
![\"GitHub\"](\"https://fiware.github.io/tutorials.PEP-Proxy/icon/GitHub-Mark-32px.png\"){kind=icon}
FIWARE 404: Securing Microservices with a PEP Proxy
\n\n\"Oh, it's quite simple. If you are a friend, you speak the password, and the doors will open.\"
\n— Gandalf (The Fellowship of the Ring by J.R.R Tolkien)
\n
The previous tutorial demonstrated that it is possible to Permit or Deny access\nto resources based on an authenticated user identifying themselves within an application. It was simply a matter of the code following\na different line of execution if the access_token was not found (Level 1 - Authentication Access), or confirming that a given access_token\nhad appropriate rights (Level 2 - Basic Authorization). The same method of securing access can be applied by placing a Policy Enforcement\nPoint (PEP) in front of other services within a FIWARE-based Smart Solution.
A PEP Proxy lies in front of a secured resource and is an endpoint found at \"well-known\" public location. It serves\nas a gatekeeper for resource access. Users or other actors must supply sufficient information to the PEP Proxy to allow their request\nto succeed and pass through the PEP proxy. The PEP proxy then passes the request on to the real location of the\nsecured resource itself - the actual location of the secured resource is unknown to the outside user - it could be held\nin a private network behind the PEP proxy or found on a different machine altogether.
\nFIWARE Wilma is a simple implentation of a PEP proxy designed to work with the FIWARE Keyrock Generic Enabler. Whenever a user tries to gain access to the resource behind the PEP proxy, the\nPEP will describe the user's attributes to the Policy Decision Point (PDP), request a security decision, and enforce the decision.\n(Permit or Deny). There is mimimal disruption of access for authorized users - the response received is the same as if they had\naccessed the secured service directly. Unauthorized users are simply returned a 401 - Unauthorized response.
\nThe following common objects are found with the Keyrock Identity Management database:
\nAdditionally two further non-human application objects can be secured within a FIWARE application:
\nThe relationship between the objects can be seen below - the entities marked in red are used directly within this tutorial:
\n![\"\"](\"https://fiware.github.io/tutorials.PEP-Proxy/img/entities.png\")
![\"\"](\"http://img.youtube.com/vi/8tGbUI18udM/0.jpg\")
Click on the image above to see an introductory video
\nTo keep things simple both components will be run using Docker. Docker is a\ncontainer technology which allows to different components isolated into their respective environments.
\nDocker Compose is a tool for defining and running multi-container Docker applications. A\nYAML file is used\nconfigure the required services for the application. This means all container services can be brought up in a single\ncommand. Docker Compose is installed by default as part of Docker for Windows and Docker for Mac, however Linux users\nwill need to follow the instructions found here
\nWe will start up our services using a simple bash script. Windows users should download cygwin to provide a\ncommand line functionality similar to a Linux distribution on Windows.
\nThis application protects access to the existing Stock Management and Sensors-based application by adding PEP Proxy instances around the services created in previous tutorials and uses data pre-populated into the MySQL database used by Keyrock. It\nwill make use of four FIWARE components - the Orion Context Broker,the IoT Agent for UltraLight 2.0, the Keyrock Generic enabler\nand adds one or two instances Wilma PEP Proxy dependent upon which interfaces are to be secured.\nUsage of the Orion Context Broker is sufficient for an application to qualify as “Powered by FIWARE”.
\nBoth the Orion Context Broker and the IoT Agent rely on open source MongoDB technology to keep persistence of the information they hold. We will also be using the dummy IoT devices created in the previous tutorial. Keyrock uses its own MySQL database.
\nTherefore the overall architecture will consist of the following elements:
\nSince all interactions between the elements are initiated by HTTP requests, the entities can be containerized and run from exposed ports.
\nThe specific architecture of each section of the tutorial is discussed below.
\nTo start the installation, do the following:
\ngit clone git@github.com:Fiware/tutorials.PEP-Proxy.git\ncd tutorials.PEP-Proxy\n\n./services create\n\n\nNote The initial creation of Docker images can take up to three minutes
\n
Thereafter, all services can be initialized from the command line by running the services Bash script provided within the repository:
\n./services <command>\nWhere <command> will vary depending upon the exercise we wish to activate.
\n\n:information_source: Note: If you want to clean up and start over again you can do so with the following command:
\n\n./services stop\n
The following people at test.com legitimately have accounts within the Application
The following people at example.com have signed up for accounts, but have no reason to be granted access
Two organizations have also been set up by Alice:
\nOne application, with appropriate roles and permissions has also been created:
\nTo save time, the data creating users and organizations from the previous tutorial has been downloaded and is automatically persisted to the MySQL\ndatabase on start-up so the assigned UUIDs do not change and the data does not need to be entered again.
\nThe Keyrock MySQL database deals with all aspects of application security including storing users, password etc; defining access rights and dealing with OAuth2 authorization protocols.\nThe complete database relationship diagram can be found here
\nTo refresh your memory about how to create users and organizations and applications, you can log in at http://localhost:3005/idm\nusing the account alice-the-admin@test.com with a password of test.
![\"\"](\"https://fiware.github.io/tutorials.PEP-Proxy/img/keyrock-log-in.png\")
and look around.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Securing Microservices with a PEP Proxy","slug":"securing-microservices-with-a-pep-proxy"},{"content":"Prerequisites","slug":"prerequisites"},{"content":"Architecture","slug":"architecture"},{"content":"Start Up","slug":"start-up"}],"owner":"513743","collectionId":"8ddc19dc-bc5f-47a4-82a9-94640db14a62","publishedId":"RWaHxUgP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF7059"},"publishDate":"2020-01-02T11:02:20.000Z"},"item":[{"name":"Logging In to Keyrock","item":[{"name":"Create token with Password","id":"8caf9b30-5af4-45e8-855c-b717a01b03f4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"alice-the-admin@test.com\",\n \"password\": \"test\"\n}"},"url":"http://localhost:3005/v1/auth/tokens","description":"The following example logs in using the Admin Super-User - it is the equivalent of using the log-in screen of the GUI.
\nThe response header returns an X-Subject-token which identifies who has logged on the application.\nThis token is required in all subsequent requests to gain access.
You can use the long-lasting X-Auth-token=aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa to pretend to be Alice throughout this\ntutorial.
The presence of a (time-limited) token is sufficient to find out more information about the user.\nTo find information about Bob, use the long-lasting token X-Subject-token=bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb
This request indicates that the\nuser authorized with the token aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa (i.e Alice) is enquiring about the user holding the token aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa i.e Bob
The response will return the details of the associated user. As you can see Bob holds a long-lasting token until 2026.
\n","urlObject":{"protocol":"http","path":["v1","auth","tokens"],"host":["localhost:3005"],"query":[],"variable":[]}},"response":[],"_postman_id":"990969ec-0c34-435a-912b-ad1b2adfe669"}],"id":"f99e0d24-7b24-45f7-853d-90125242973d","description":"Enter a username and password to enter the application. The default super-user has the values alice-the-admin@test.com and test. The URL https://localhost:3443/v1/auth/tokens should also work in a secure system.
To create a new PEP Proxy account within an application , send a POST request to the //v1/applications/tutorial-dckr-site-0000-xpresswebapp/pep_proxies endpoint along with the X-Auth-token header from a previously logged in administrative user.
Provided there is no previously existing PEP Proxy account associated with the application, a new account will be created with a unique id and password and the values will be returned in the response.
Making a GET request the /v1/applications/tutorial-dckr-site-0000-xpresswebapp/pep_proxies/ endpoint will return the details of the associated PEP Proxy Account. The X-Auth-token must be supplied in the headers.
To renew the password of a PEP Proxy Account, make a PATCH request to the /v1/applications/tutorial-dckr-site-0000-xpresswebapp/pep_proxies endpoint will return the details of the associated PEP Proxy Account. The X-Auth-token must be supplied in the headers.
The response returns a new password.
\n","urlObject":{"protocol":"http","path":["v1","applications","tutorial-dckr-site-0000-xpresswebapp","pep_proxies"],"host":["localhost:3005"],"query":[],"variable":[]}},"response":[],"_postman_id":"545f1cfb-382f-4a9d-902b-5acb0a6045e2"},{"name":"Delete PEP Proxy","id":"8ac7334c-397b-4ec2-8b2c-b7fc8352340a","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Type","value":"{{Content-Type}}"},{"key":"X-Auth-token","value":"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"}],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:3005/v1/applications/tutorial-dckr-site-0000-xpresswebapp/pep_proxies","description":"An existing PEP Proxy Account can be deleted by making a DELETE request to the /v1/applications/tutorial-dckr-site-0000-xpresswebapp/pep_proxies endpoint. The X-Auth-token must be supplied in the headers.
Once signed-in, users are able to create and update PEP Proxies associated to their applications for themselves.
\n![](\"https://fiware.github.io/tutorials.PEP-Proxy/img/create-pep-proxy.png\")
Alternatively, the standard CRUD actions are assigned to the appropriate HTTP verbs (POST, GET, PATCH and DELETE) under the /v1/applications/tutorial-dckr-site-0000-xpresswebapp/pep_proxies endpoint.
To create a new IoT Agent account within an application, send a POST request to the /v1/applications/tutorial-dckr-site-0000-xpresswebapp/iot_agents endpoint along with the X-Auth-token header from a previously logged in administrative user.
A new account will be created with a unique id and password and the values will be returned in the response.
Making a GET request the /v1/applications/tutorial-dckr-site-0000-xpresswebapp/iot_agents/iot_sensor_00000000-0000-0000-0000-000000000000 endpoint will return the details of the associated IoT Agent Account. The X-Auth-token must be supplied in the headers.
A list of all IoT Agents associated with an application can be obtained by making a GET request the /v1/applications/tutorial-dckr-site-0000-xpresswebapp/iot_agents endpoint. The X-Auth-token must be supplied in the headers.
To renew the password of an individual IoT Agent Account, make a PATCH request to the /v1/applications/tutorial-dckr-site-0000-xpresswebapp//iot_agents/iot_sensor_00000000-0000-0000-0000-000000000000 endpoint. \nThe X-Auth-token must be supplied in the headers.
The response returns a new password.
\n","urlObject":{"protocol":"http","path":["v1","applications","tutorial-dckr-site-0000-xpresswebapp","iot_agents","iot_sensor_00000000-0000-0000-0000-000000000000"],"host":["localhost:3005"],"query":[],"variable":[]}},"response":[],"_postman_id":"810362a0-89de-46a1-92e3-dca60b94bfac"},{"name":"Delete an IoT Agent","id":"31aa4636-fb29-496e-93b4-646570fef140","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Auth-token","value":"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"}],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:3005/v1/applications/tutorial-dckr-site-0000-xpresswebapp/iot_agents/iot_sensor_00000000-0000-0000-0000-000000000000","description":"An existing IoT Agent Account can be deleted by making a DELETE request to the /v1/applications/tutorial-dckr-site-0000-xpresswebapp/iot_agents/iot_sensor_00000000-0000-0000-0000-000000000000 endpoint. \nThe X-Auth-token must be supplied in the headers.
In a similar manner to PEP Proxy creation, signed-in, users are able to create and update IoT Sensor Accounts associated to their \napplications.
\n![](\"https://fiware.github.io/tutorials.PEP-Proxy/img/create-iot-sensor.png\")
Alternatively, the standard CRUD actions are assigned to the
\n","event":[{"listen":"prerequest","script":{"id":"19ac2874-e6e9-43d4-8560-de18473d7a3a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b544eada-13d0-40bd-b53c-b715a1f94dd2","type":"text/javascript","exec":[""]}}],"_postman_id":"566306fb-15bf-469e-963c-79c3f948b4d3"}],"id":"bd81ee58-ed8f-49ac-8c01-091d82aff238","description":"User accounts have been created in a previous tutorial. Non-human\nactors such as a PEP Proxy can be set up in the same manner. The account for each PEP Proxy, IoT Agent or IoT Sensor will \nmerely consist of a Username and password linked to an application within Keyrock. PEP Proxy and IoT Agents accounts can\nbe created by using either the Keyrock GUI or by using the REST API.
\n![](\"http://img.youtube.com/vi/b4sYU78skrw/0.jpg\")
Click on the image above to see a video about configuring the Wilma PEP Proxy using the Keyrock GUI
\nTo start the system run the following command:
\n![here](\"https://fiware.github.io/tutorials.Securing-Access/img/keyrock-db.png\"){kind=link}
./services orion\nThis will start up Keyrock with a series of users. There are already two existing applications \nand an existing PEP Proxy Account associated with the application.
\n","event":[{"listen":"prerequest","script":{"id":"58d4e080-c9bf-4e19-aab9-08d332b71cba","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f1ed306e-fcb8-470c-9d81-0e0e2d385f7f","type":"text/javascript","exec":[""]}}],"_postman_id":"bd81ee58-ed8f-49ac-8c01-091d82aff238"},{"name":"Securing the Orion Context Broker","item":[{"name":"PEP Proxy - No Access to Orion without an Access Token","id":"0ca4b27b-3392-4207-a84e-ba6abf4edfe6","request":{"method":"GET","header":[{"key":"X-Auth-Token","value":" 79d07d0139c66b75fc25f56a88008553f12f6ac7"}],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:1027/v2/entities/","description":"Secured Access can be ensured by requiring all requests to the secured service are made indirectly via a PEP Proxy (in this case the PEP Proxy is found in front of the Context Broker). Requests must include an X-Auth-Token, failure to present a valid token results in a denial of access.
if a request to the PEP Proxy is made without any access token as shown, the response is a 401 Unauthorized error code, with a text explanation.
\n","urlObject":{"protocol":"http","port":"1027","path":["v2","entities",""],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ca4b27b-3392-4207-a84e-ba6abf4edfe6"},{"name":"Keyrock - User Obtains an Access Token","id":"0d2332e5-cd2e-4624-888d-16acfdd12a7f","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic dHV0b3JpYWwtZGNrci1zaXRlLTAwMDAteHByZXNzd2ViYXBwOnR1dG9yaWFsLWRja3Itc2l0ZS0wMDAwLWNsaWVudHNlY3JldA==","description":"base64 concatenation of Client Id and Client Secret
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"username=alice-the-admin@test.com&password=test&grant_type=password"},"url":"http://localhost:3005/oauth2/token","description":"To log in to an application using the user-credentials flow send a POST request to the oauth2/token endpoint with the grant_type=password
The response returns an access_code to identify the user.
An access_code can also be done by entering the Tutorial Application on http:/localhost and logging in using any of the OAuth2 grants\non the page. A successful log-in will return an access token.
If a request to the PEP Proxy is made including a valid access token in the X-Auth-Token header as shown, the request\nis permitted and the service behind the PEP Proxy (in this case the Orion Context Broker) will return the data as\nexpected.
If a request to the PEP Proxy is made including a valid access token in the X-Auth-Token header as shown, the request\nis permitted and the service behind the PEP Proxy (in this case the Orion Context Broker) will return the data as\nexpected.
The standard Authorization: Bearer header can also be used to identity the user,\nthe request from an authorized user is permitted and the service behind the PEP Proxy (in this case the Orion Context Broker) will return the data as\nexpected.
If a request to the PEP Proxy is made including a valid access token in the X-Auth-Token header as shown, the request\nis permitted and the service behind the PEP Proxy (in this case the Orion Context Broker) will return the data as\nexpected.
![](\"https://fiware.github.io/tutorials.PEP-Proxy/img/pep-proxy-orion.png\")
The orion-proxy container is an instance of FIWARE Wilma listening on port 1027, it is configured to forward traffic to\norion on port 1026, which is the default port that the Orion Context Broker is listening to for NGSI Requests.
orion-proxy:\n image: fiware/pep-proxy\n container_name: fiware-orion-proxy\n hostname: orion-proxy\n networks:\n default:\n ipv4_address: 172.18.1.10\n depends_on:\n - keyrock\n ports:\n - \"1027:1027\"\n expose:\n - \"1027\"\n environment:\n - PEP_PROXY_APP_HOST=orion\n - PEP_PROXY_APP_PORT=1026\n - PEP_PROXY_PORT=1027\n - PEP_PROXY_IDM_HOST=keyrock\n - PEP_PROXY_HTTPS_ENABLED=false\n - PEP_PROXY_AUTH_ENABLED=false\n - PEP_PROXY_IDM_SSL_ENABLED=false\n - PEP_PROXY_IDM_PORT=3005\n - PEP_PROXY_APP_ID=tutorial-dckr-site-0000-xpresswebapp\n - PEP_PROXY_USERNAME=pep_proxy_00000000-0000-0000-0000-000000000000\n - PEP_PASSWORD=test\n - PEP_PROXY_PDP=idm\n - PEP_PROXY_MAGIC_KEY=1234\nThe PEP_PROXY_APP_ID and PEP_PROXY_USERNAME would usually be obtained by adding new entries to the application in Keyrock,\nhowever, in this tutorial, they have been pre-defined by populating the MySQL database with data on start-up.
The orion-proxy container is listening on a single port:
1027 is exposed purely for tutorial access - so that cUrl or Postman can requests directly to the Wilma instance\nwithout being part of the same network.For this example, the PEP Proxy is checking for Level 1 - Authentication Access not Level 2 - Basic Authorization or \nLevel 3 - Advanced Authorization.
\nThe tutorial application has already been registered in Keyrock, programmatically the tutorial application will\nbe making requests to the Wilma PEP Proxy in front of the Orion Conext Broker. Every request must now include\nan additional access_token header.
tutorial-app:\n image: fiware/tutorials.context-provider\n hostname: tutorial-app\n container_name: tutorial-app\n depends_on:\n - orion-proxy\n - iot-agent\n - keyrock\n networks:\n default:\n ipv4_address: 172.18.1.7\n aliases:\n - iot-sensors\n expose:\n - \"3000\"\n - \"3001\"\n ports:\n - \"3000:3000\"\n - \"3001:3001\"\n environment:\n - \"WEB_APP_PORT=3000\"\n - \"SECURE_ENDPOINTS=true\"\n - \"CONTEXT_BROKER=http://orion-proxy:1027/v2\"\n - \"KEYROCK_URL=http://localhost\"\n - \"KEYROCK_IP_ADDRESS=http://172.18.1.5\"\n - \"KEYROCK_PORT=3005\"\n - \"KEYROCK_CLIENT_ID=tutorial-dckr-site-0000-xpresswebapp\"\n - \"KEYROCK_CLIENT_SECRET=tutorial-dckr-site-0000-clientsecret\"\n - \"CALLBACK_URL=http://localhost:3000/login\"\nAll of the tutorial container settings have been described in previous tutorials. One important change is necessary however,\nrather than accessing Orion directly on the default port 1026 as shown in all previous tutorials, all context broker\ntraffic is now sent to orion-proxy on port 1027. As a reminder, the relevant settings are detailed below:
To start the system with a PEP Proxy protecting access to Orion, run the following command:
\n./services orion\n![](\"http://img.youtube.com/vi/coxFQEY0_So/0.jpg\")
Click on the image above to see a video about securing a REST API using the Wilma PEP Proxy
\nWhen a User logs in to the application using the User Credentials Grant, an access_token is obtained which identifies the User.\nThe access_token is stored in session:
function userCredentialGrant(req, res){\n debug('userCredentialGrant');\n\n const email = req.body.email;\n const password = req.body.password;\n\n oa.getOAuthPasswordCredentials(email, password)\n .then(results => {\n req.session.access_token = results.access_token;\n return;\n })\n}\nFor each subsequent request, the access_token is supplied in the X-Auth-Token Header
function setAuthHeaders(req){\n const headers = {};\n if (req.session.access_token) {\n headers['X-Auth-Token'] = req.session.access_token;\n }\n return headers;\n}\nFor example, when buying an item, two requests are made, the same X-Auth-Token Header must be added to each request - therefore\nthe User can be identified and access granted.
async function buyItem(req, res) {\n\n const inventory = await retrieveEntity(req.params.inventoryId, {\n options: 'keyValues',\n type: 'InventoryItem',\n }, setAuthHeaders(req));\n const count = inventory.shelfCount - 1;\n\n await updateExistingEntityAttributes(\n req.params.inventoryId,\n { shelfCount: { type: 'Integer', value: count } },\n {\n type: 'InventoryItem',\n }, setAuthHeaders(req)\n );\n res.redirect(`/app/store/${inventory.refStore}/till`);\n}\nbase64 concatenation of Client Id and Client Secret
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"username=iot_sensor_00000000-0000-0000-0000-000000000000&password=test&grant_type=password"},"url":"http://localhost:3005/oauth2/token","description":"Logging in as an IoT Sensor follows the same user-credentials flow as for a User.\nTo log in and identify the sensor iot_sensor_00000000-0000-0000-0000-000000000000 with password test
The response returns an access code to identify the IoT Device
\n","urlObject":{"protocol":"http","path":["oauth2","token"],"host":["localhost:3005"],"query":[],"variable":[]}},"response":[],"_postman_id":"5271fd3d-db77-4f8d-863c-cbb76de0d15e"},{"name":"PEP Proxy - Accessing IoT Agent with an Access Token","id":"8340f73f-7a57-44e5-9c88-7526efd73ba6","request":{"method":"POST","header":[{"key":"X-Auth-Token","value":" 79d07d0139c66b75fc25f56a88008553f12f6ac7"}],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:7897/iot/d?k=4jggokgpepnvsb2uv4s40d59ov&i=motion001","description":"This example simulates a secured request coming from the device motion001
The POST request to a PEP Proxy in front to the Ultralight IoT Agent identifies\na previously provisioned resource iot/dendpoint and passes a measurement for\ndevice motion001. The addition of the X-Auth-Token Header identifies the source\nof the request as being registered in Keyrock, and therefore the measurement will \nbe passed on to the IoT Agent itself.
![](\"https://fiware.github.io/tutorials.PEP-Proxy/img/pep-proxy-south-port.png\")
The iot-agent-proxy container is an instance of FIWARE Wilma listening on port 7897, it is configured to forward traffic to\niot-agent on port 7896, which is the default port that the Ultralight agent is listening to for HTTP Requests.
iot-agent-proxy:\n image: fiware/pep-proxy\n container_name: fiware-iot-agent-proxy\n hostname: iot-agent-proxy\n networks:\n default:\n ipv4_address: 172.18.1.11\n depends_on:\n - keyrock\n ports:\n - \"7897:7897\"\n expose:\n - \"7897\"\n environment:\n - PEP_PROXY_APP_HOST=iot-agent\n - PEP_PROXY_APP_PORT=7896\n - PEP_PROXY_PORT=7897\n - PEP_PROXY_IDM_HOST=keyrock\n - PEP_PROXY_HTTPS_ENABLED=false\n - PEP_PROXY_AUTH_ENABLED=false\n - PEP_PROXY_IDM_SSL_ENABLED=false\n - PEP_PROXY_IDM_PORT=3005\n - PEP_PROXY_APP_ID=tutorial-dckr-site-0000-xpresswebapp\n - PEP_PROXY_USERNAME=pep_proxy_00000000-0000-0000-0000-000000000000\n - PEP_PASSWORD=test\n - PEP_PROXY_PDP=idm\n - PEP_PROXY_MAGIC_KEY=1234\nThe PEP_PROXY_APP_ID and PEP_PROXY_USERNAME would usually be obtained by adding new entries to the application in Keyrock,\nhowever, in this tutorial, they have been pre-defined by populating the MySQL database with data on start-up.
The iot-agent-proxy container is listening on a single port:
7897 is exposed purely for tutorial access - so that cUrl or Postman can requests directly to this Wilma instance\nwithout being part of the same network.For this example, the PEP Proxy is checking for Level 1 - Authentication Access not Level 2 - Basic Authorization or \nLevel 3 - Advanced Authorization.
\nThe tutorial application also plays the role of providing data from our dummy IoT Sensors. The IoT Sensors are\nmaking HTTP request containing commands and measurements in Ultralight syntax. An IoT Sensor username and password\nhave already been registered in Keyrock, programmatically each sensor must obtain an OAuth2 access token and\nwill then make requests to a second Wilma PEP Proxy in front of the IoT Agent.
\n tutorial-app:\n image: fiware/tutorials.context-provider\n hostname: tutorial-app\n container_name: tutorial-app\n depends_on:\n - orion-proxy\n - iot-agent-proxy\n - keyrock\n networks:\n default:\n ipv4_address: 172.18.1.7\n aliases:\n - iot-sensors\n expose:\n - \"3000\"\n - \"3001\"\n ports:\n - \"3000:3000\"\n - \"3001:3001\"\n environment:\n - \"IOTA_HTTP_HOST=iot-agent-proxy\"\n - \"IOTA_HTTP_PORT=7897\"\n - \"DUMMY_DEVICES_PORT=3001\" # Port used by the dummy IOT devices to receive commands\n - \"DUMMY_DEVICES_TRANSPORT=HTTP\" # Default transport used by dummy Io devices\n - \"DUMMY_DEVICES_API_KEY=4jggokgpepnvsb2uv4s40d59ov\"\n - \"DUMMY_DEVICES_USER=iot_sensor_00000000-0000-0000-0000-000000000000\"\n - \"DUMMY_DEVICES_PASSWORD=test\"\nThe tutorial container hosts the dummy Ultralight sensors. Rather than accessing the IoT Agent directly on port 7896 as\nshown in all previous tutorials, all traffic is forwarded to iot-agent-proxy on port 7897. Most of the relevant tutorial\ncontainer settings have been described in previous tutorials, the DUMMY_DEVICES_USER and DUMMY_DEVICES_PASSWORD are new\nadditions.
The DUMMY_DEVICES_USER and DUMMY_DEVICES_PASSWORD would usually be obtained by adding new entries to the application in Keyrock,\nhowever, in this tutorial, they have been pre-defined by populating the MySQL database with data on start-up.
To start the system with a PEP Proxies protecting access to both Orion and the IoT Agent run the following command:
\n./services southport\nWhen an IoT Sensor starts up, it must log-in like any other user to obtain an access token:
\nconst DUMMY_DEVICE_HTTP_HEADERS = { 'Content-Type': 'text/plain' };\nfunction initSecureDevices(){\n Security.oa.getOAuthPasswordCredentials(process.env.DUMMY_DEVICES_USER, process.env.DUMMY_DEVICES_PASSWORD)\n .then(results => {\n DUMMY_DEVICE_HTTP_HEADERS['X-Auth-Token'] = results.access_token;\n return;\n })\n .catch(error => {\n debug(error);\n return;\n });\n}\nEach HTTP request thereafter includes the X-Auth-Token Header in the request identifying the IoT Sensor:
const options = { method: 'POST',\n url: UL_URL,\n qs: { k: UL_API_KEY, i: deviceId },\n headers: DUMMY_DEVICE_HTTP_HEADERS,\n body: state };\n\nrequest(options, (error) => {\n if (error){\n debug( debugText + \" \" + error.code)\n } \n});\nbase64 concatenation of Client Id and Client Secret
\n","key":"Authorization","value":"Basic dHV0b3JpYWwtZGNrci1zaXRlLTAwMDAteHByZXNzd2ViYXBwOnR1dG9yaWFsLWRja3Itc2l0ZS0wMDAwLWNsaWVudHNlY3JldA=="},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"username=alice-the-admin@test.com&password=test&grant_type=password&scope=permanent"},"url":"http://localhost:3005/oauth2/token","description":"The Keyrock application has been configured to offer permanent tokens
\nThe standard Authorization: Basic header holds the base 64 concatentation of the client id and secret. The parameter\nscope=permanent is added to retrieve permanent tokens when available. The response contains an access_token which\ncan be used for device provisioning.
The Access token (also known as a Trust Token) must be added to the service group.
\n","urlObject":{"protocol":"http","port":"4041","path":["iot","services"],"host":["localhost"],"query":[{"key":"resource","value":"/iot/d"},{"key":"apikey","value":"1068318794"}],"variable":[]}},"response":[],"_postman_id":"07fbab9f-cba8-4265-8e4a-8e3004126f89"},{"name":"IoT Agent - Provisioning a sensor","id":"2e3bc39b-26fa-4ab7-a726-d5e0eaf9b082","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"fiware-service","value":"openiot"},{"key":"fiware-service-path","value":"/","type":"text"},{"key":"Accept","value":"application/json","type":"text","name":"Accept"}],"body":{"mode":"raw","raw":"{\n \"devices\": [\n {\n \"device_id\": \"motion001\",\n \"entity_name\": \"urn:ngsi-ld:Motion:001\",\n \"entity_type\": \"Motion\",\n \"timezone\": \"Europe/Berlin\",\n \"attributes\": [\n { \"object_id\": \"c\", \"name\": \"count\", \"type\": \"Integer\" }\n ],\n \"static_attributes\": [\n { \"name\":\"refStore\", \"type\": \"Relationship\", \"value\": \"urn:ngsi-ld:Store:001\"}\n ]\n }\n ]\n}"},"url":"http://localhost:4041/iot/devices","description":"Once a trusted service group has been created, a device can be provisioned in the usual manner
\n","urlObject":{"protocol":"http","port":"4041","path":["iot","devices"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e3bc39b-26fa-4ab7-a726-d5e0eaf9b082"}],"id":"5c3e32b4-3054-43e1-a1d5-fde7bf580d62","description":"![](\"https://fiware.github.io/tutorials.PEP-Proxy/img/pep-proxy-north-port.png\")
The iot-agent container is listening on port 4041, it is configured to forward traffic to orion-proxy on port\n1027.
iot-agent:\n image: fiware/iotagent-ul:${ULTRALIGHT_VERSION}\n hostname: iot-agent\n container_name: fiware-iot-agent\n depends_on:\n - mongo-db\n - orion\n networks:\n - default\n ports:\n - \"4041:4041\"\n - \"7896:7896\"\n environment:\n - IOTA_CB_HOST=orion-proxy\n - IOTA_CB_PORT=1027\n - IOTA_NORTH_PORT=4041\n - IOTA_REGISTRY_TYPE=mongodb\n - IOTA_LOG_LEVEL=DEBUG\n - IOTA_TIMESTAMP=true\n - IOTA_CB_NGSI_VERSION=v2\n - IOTA_AUTOCAST=true\n - IOTA_MONGO_HOST=mongo-db\n - IOTA_MONGO_PORT=27017\n - IOTA_MONGO_DB=iotagentul\n - IOTA_HTTP_PORT=7896\n - IOTA_PROVIDER_URL=http://iot-agent:4041\n - IOTA_AUTH_ENABLED=true\n - IOTA_AUTH_TYPE=oauth2\n - IOTA_AUTH_HEADER=Authorization\n - IOTA_AUTH_HOST=keyrock\n - IOTA_AUTH_PORT=3005\n - IOTA_AUTH_URL=http://keyrock:3005\n - IOTA_AUTH_TOKEN_PATH=/oauth2/token\n - IOTA_AUTH_PERMANENT_TOKEN=true\n - IOTA_AUTH_CLIENT_ID=tutorial-dckr-site-0000-xpresswebapp\n - IOTA_AUTH_CLIENT_SECRET=tutorial-dckr-host-0000-clientsecret\nTo start the system with a PEP Proxy protecting access to between Orion and the IoT Agent North Port run the\nfollowing command:
\n./services northport\n