Merge 5769033 into fa365fe

lets-fiware · Dec 10, 2021 · 17a68a5 · 17a68a5
2 parents fa365fe + 5769033
commit 17a68a5
Show file tree

Hide file tree

Showing 9 changed files with 410 additions and 51 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 ## NGSI Go v0.9.0-next
 
+-   Hardening: Add feature to support OpenID for Keyrock (#206)
 -   Update: Update docker images (#205)
 -   Improve: Add --serial flag to print serial value as NGSI Go version (#204)
 -   Improve: Add colon as a valid character for alias name (#203)

diff --git a/docs/keyrock/applications.md b/docs/keyrock/applications.md
@@ -140,22 +140,22 @@ ngsi application [command options] create [options]
 
 ### Options
 
-| Options                              | Description                            |
-| ------------------------------------ | -------------------------------------- |
-| --host VALUE, -h VALUE               | broker or server host VALUE (required) |
-| --data VALUE, -d VALUE               | application data                       |
-| --name VALUE, -n VALUE               | application name                       |
-| --description VALUE, -D VALUE        | description                            |
-| --url VALUE, -u VALUE                | url                                    |
-| --redirectUri VALUE, -R VALUE        | redirect uri                           |
-| --redirectSignOutUri VALUE, -S VALUE | redirect redirect sign out uri         |
-| --grantType VALUE, -g VALUE          | grant type                             |
-| --tokenTypes VALUE, -t VALUE         | token types                            |
-| --responseType VALUE, -r VALUE       | response type                          |
-| --clientType VALUE, -c VALUE         | client type                            |
-| --verbose, -v                        | verbose (default: false)               |
-| --pretty, -P                         | pretty format (default: false)         |
-| --help                               | show help (default: true)              |
+| Options                              | Description                                                 |
+| ------------------------------------ | ----------------------------------------------------------- |
+| --host VALUE, -h VALUE               | broker or server host VALUE (required)                      |
+| --data VALUE, -d VALUE               | application data                                            |
+| --name VALUE, -n VALUE               | application name                                            |
+| --description VALUE, -D VALUE        | description                                                 |
+| --url VALUE, -u VALUE                | url                                                         |
+| --redirectUri VALUE, -R VALUE        | redirect uri                                                |
+| --redirectSignOutUri VALUE, -S VALUE | redirect redirect sign out uri                              |
+| --grantType VALUE, -g VALUE          | grant type                                                  |
+| --tokenTypes VALUE, -t VALUE         | token types                                                 |
+| --scope VALUE, -s VALUE              | scopes to limit an application's access to a user's account |
+| --openid, -o                         | enable OpenID Connect Authentication (default: false)       |
+| --verbose, -v                        | verbose (default: false)                                    |
+| --pretty, -P                         | pretty format (default: false)                              |
+| --help                               | show help (default: true)                                   |
 
 ### Examples
 
@@ -174,6 +174,33 @@ ngsi applications create --name "Test_application 1" \
 58de156f-0fec-400b-bc7c-86265a885bee
 ```
 
+#### Request
+
+```console
+ngsi applications create --name "FIWARE Draco" \
+  --url https://draco.example.com \
+  --redirectUri https://draco.example.com:443/nifi-api/access/oidc/callback \
+  --openid
+```
+
+```console
+6418de2a-c50e-485e-bdc1-e714c6522d93
+```
+
+#### Request
+
+```console
+ngsi applications create --name "FIWARE Draco" \
+  --url https://draco.example.com \
+  --redirectUri https://draco.example.com:443/nifi-api/access/oidc/callback \
+  --scope openid \
+  --tokenTypes jwt
+```
+
+```console
+247d64f7-a479-4b55-8047-46da8004506c
+```
+
 <a name="update-an-application"></a>
 
 ## Update an application
@@ -186,23 +213,23 @@ ngsi application [command options] update [options]
 
 ### Options
 
-| Options                              | Description                            |
-| ------------------------------------ | -------------------------------------- |
-| --host VALUE, -h VALUE               | broker or server host VALUE (required) |
-| --aid VALUE, -i VALUE                | application id (required)              |
-| --data VALUE, -d VALUE               | application data                       |
-| --name VALUE, -n VALUE               | application name                       |
-| --description VALUE, -D VALUE        | description                            |
-| --url VALUE, -u VALUE                | url                                    |
-| --redirectUri VALUE, -R VALUE        | redirect uri                           |
-| --redirectSignOutUri VALUE, -S VALUE | redirect redirect sign out uri         |
-| --grantType VALUE, -g VALUE          | grant type                             |
-| --tokenTypes VALUE, -t VALUE         | token types                            |
-| --responseType VALUE, -r VALUE       | response type                          |
-| --clientType VALUE, -c VALUE         | client type                            |
-| --verbose, -v                        | verbose (default: false)               |
-| --pretty, -P                         | pretty format (default: false)         |
-| --help                               | show help (default: true)              |
+| Options                              | Description                                                 |
+| ------------------------------------ | ----------------------------------------------------------- |
+| --host VALUE, -h VALUE               | broker or server host VALUE (required)                      |
+| --aid VALUE, -i VALUE                | application id (required)                                   |
+| --data VALUE, -d VALUE               | application data                                            |
+| --name VALUE, -n VALUE               | application name                                            |
+| --description VALUE, -D VALUE        | description                                                 |
+| --url VALUE, -u VALUE                | url                                                         |
+| --redirectUri VALUE, -R VALUE        | redirect uri                                                |
+| --redirectSignOutUri VALUE, -S VALUE | redirect redirect sign out uri                              |
+| --grantType VALUE, -g VALUE          | grant type                                                  |
+| --tokenTypes VALUE, -t VALUE         | token types                                                 |
+| --scope VALUE, -s VALUE              | scopes to limit an application's access to a user's account |
+| --openid, -o                         | enable OpenID Connect Authentication (default: false)       |
+| --verbose, -v                        | verbose (default: false)                                    |
+| --pretty, -P                         | pretty format (default: false)                              |
+| --help                               | show help (default: true)                                   |
 
 ### Examples
 

diff --git a/e2e/cases/1000_common/0003_help.test b/e2e/cases/1000_common/0003_help.test
@@ -2241,8 +2241,8 @@ OPTIONS:
    --redirectSignOutUri VALUE, -S VALUE  redirect redirect sign out uri
    --grantType VALUE, -g VALUE           grant type
    --tokenTypes VALUE, -t VALUE          token types
-   --responseType VALUE, -r VALUE        response type
-   --clientType VALUE, -c VALUE          client type
+   --scope VALUE, -s VALUE               scopes to limit an application's access to a user's account
+   --openid, -o                          enable OpenID Connect Authentication (default: false)
    --verbose, -v                         verbose (default: false)
    --pretty, -P                          pretty format (default: false)
    --help                                show help (default: true)
@@ -2285,8 +2285,8 @@ OPTIONS:
    --redirectSignOutUri VALUE, -S VALUE  redirect redirect sign out uri
    --grantType VALUE, -g VALUE           grant type
    --tokenTypes VALUE, -t VALUE          token types
-   --responseType VALUE, -r VALUE        response type
-   --clientType VALUE, -c VALUE          client type
+   --scope VALUE, -s VALUE               scopes to limit an application's access to a user's account
+   --openid, -o                          enable OpenID Connect Authentication (default: false)
    --verbose, -v                         verbose (default: false)
    --pretty, -P                          pretty format (default: false)
    --help                                show help (default: true)