Skip to content

Commit bb6ed47

Browse files
GufCabrosieks
andauthored
Merged stage into master for release 1.3 (#35)
* Updated with documentation for the FIWARE OAuth 2.0 mechanism Authored by @rosieks * Added documentation about the KOMBIT public certificate (#34) Co-authored-by: Sławomir Rosiek <[email protected]>
1 parent fd2c44e commit bb6ed47

File tree

3 files changed

+13
-1
lines changed

3 files changed

+13
-1
lines changed

source/external-interface-design/external-interface-design.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -481,7 +481,7 @@ The context (part of the NGSI-LD standard) can be provided in the request body o
481481

482482
The Fiware data target supports the multitenancy of the Context Broker (but not every context broker supports multitenancy). The name of the tenant can be specified in the configuration. If no value is provided, the default tenant will be used. To specify the tenant OS2IoT is using :code:`NGSILD-Tenant` header.
483483

484-
484+
If your Context Broker is secured with OAuth2 it's possible to configure target to obtain necessary client credentials from Authentication Server. To do that it's required to provide token endpoint together with Client ID and Client Secret while configuring the target.
485485

486486
Opendata.dk
487487
^^^^^^^^^^^

source/installation-guide/installation-guide.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,8 @@ OS2IoT-backend takes several environment variables as configuration, if these ar
235235
+-------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
236236
| KOMBIT_CERTIFICATEPRIVATEKEY | The certificate private key for KOMBIT adgangsstyring | :code:`null` |
237237
+-------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
238+
| KOMBIT_CERTIFICATEPUBLICKEY | Public certificate from the KOMBIT idp for verifying SAML response | :code:`"INSERT_KOMBIT_CERT"` |
239+
+-------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
238240
| KOMBIT_ROLE_NAME | This string must be a substring of the brugersystemrolle you grant users for them to be given access | :code:`http://os2iot.dk/roles/usersystemrole/adgang/` |
239241
+-------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
240242
| CHIRPSTACK_JWTSECRET | Secret to generate JWT for Chirpstack | :code:`verysecret` |

source/kombit-adgangsstyring/kombit-adgangsstyring.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ Prerequisites:
1616

1717
2. A NemID FOCES or VOCES (FOCES is preferred) for production use (Issued by: TRUST2408 OCES CA). If the OS2IoT installation is a TEST system, and the test environment for KOMBIT adgangsstyring is being used, then a FOCES/VOCES for the NemID integration environment is sufficent (Issued by: TRUST2408 Systemtest).
1818

19+
3. The public certificate from the KOMBIT IDP. Can be retrieved from
20+
a. **KOMBIT Test endpoint:** https://adgangsstyring.eksterntest-stoettesystemerne.dk/runtime/saml2/metadata.idp
21+
b. **KOMBIT Prod endpoint:** https://adgangsstyring.stoettesystemerne.dk/runtime/saml2/metadata.idp
1922

2023
Once the prerequisites are in order the configuration can begin.
2124

@@ -91,6 +94,13 @@ Steps:
9194
.. code-block:: javascript
9295
9396
KOMBIT_ENTRYPOINT="https://adgangsstyring.eksterntest-stoettesystemerne.dk/runtime/saml2/issue.idp"
97+
98+
iiiii. The variable :code:`KOMBIT_CERTIFICATEPUBLICKEY` must be set to the public key of the KOMBIT idp. If unset, the backend will not validate responses from KOMBIT, even if they are valid. Must be one line, with only the key part as shown below
99+
d. An example for :code:`.env` could be:
100+
101+
.. code-block:: javascript
102+
103+
KOMBIT_CERTIFICATEPUBLICKEY="MIIGHTCCBQWgAwIBAgIEXgiTCTA[...]H0QDoU9mHDP17gSZZ"
94104
95105
96106
Test:

0 commit comments

Comments
 (0)