From 0e0241f252a25158636c08a4ec4aeb0428783648 Mon Sep 17 00:00:00 2001 From: Thomas Jaeckle Date: Mon, 6 Mar 2023 20:12:58 +0100 Subject: [PATCH 01/42] [#1592] provide "Bearer" authentication for devops resources controlled via UI * added radiobutton groups so that "Authorize" modal clearly shows/states which authentication to use where * reduced to a single "Authorize" button in modal * simplified environment a bit Signed-off-by: Thomas Jaeckle --- ui/index.css | 4 + ui/modules/api.js | 29 +++-- ui/modules/environments/authorization.html | 126 ++++++++++++--------- ui/modules/environments/authorization.js | 56 ++++++--- ui/templates/environmentTemplates.json | 23 ++-- 5 files changed, 148 insertions(+), 90 deletions(-) diff --git a/ui/index.css b/ui/index.css index 0f725c5f5e..347968dbfe 100644 --- a/ui/index.css +++ b/ui/index.css @@ -46,6 +46,10 @@ body { padding-top: 60px; } +#authorizationModal label { + display: inline; +} + .toast-header { color: #842029; background-color: #f8d7da; diff --git a/ui/modules/api.js b/ui/modules/api.js index cdadd62a39..eb343316f2 100644 --- a/ui/modules/api.js +++ b/ui/modules/api.js @@ -277,18 +277,25 @@ let authHeaderValue; * @param {boolean} forDevOps if true, the credentials for the dev ops api will be used. */ export function setAuthHeader(forDevOps) { - if (forDevOps && Environments.current().useBasicAuth) { - authHeaderKey = 'Authorization'; - authHeaderValue = 'Basic ' + window.btoa(Environments.current().usernamePasswordDevOps); - } else if (Environments.current().useBasicAuth) { - authHeaderKey = 'Authorization'; - authHeaderValue = 'Basic ' + window.btoa(Environments.current().usernamePassword); - } else if (Environments.current().useDittoPreAuthenticatedAuth) { - authHeaderKey = 'x-ditto-pre-authenticated'; - authHeaderValue = Environments.current().dittoPreAuthenticatedUsername; + if (forDevOps) { + if (Environments.current().devopsAuth === 'basic') { + authHeaderKey = 'Authorization'; + authHeaderValue = 'Basic ' + window.btoa(Environments.current().usernamePasswordDevOps); + } else if (Environments.current().devopsAuth === 'bearer') { + authHeaderKey = 'Authorization'; + authHeaderValue ='Bearer ' + Environments.current().bearerDevOps; + } } else { - authHeaderKey = 'Authorization'; - authHeaderValue ='Bearer ' + Environments.current().bearer; + if (Environments.current().mainAuth === 'basic') { + authHeaderKey = 'Authorization'; + authHeaderValue = 'Basic ' + window.btoa(Environments.current().usernamePassword); + } else if (Environments.current().mainAuth === 'pre') { + authHeaderKey = 'x-ditto-pre-authenticated'; + authHeaderValue = Environments.current().dittoPreAuthenticatedUsername; + } else if (Environments.current().mainAuth === 'bearer') { + authHeaderKey = 'Authorization'; + authHeaderValue ='Bearer ' + Environments.current().bearer; + } } } diff --git a/ui/modules/environments/authorization.html b/ui/modules/environments/authorization.html index 91637f2fe0..ef3a0b8848 100644 --- a/ui/modules/environments/authorization.html +++ b/ui/modules/environments/authorization.html @@ -18,78 +18,94 @@
-
Basic Auth
-
-
- -
-
-
- - +
Basic Auth
+
+
+
+ +
-
- - +
+
+ + +
+
+ + +
-
-
-
- -
-
-
- - +
+
+ +
-
- - +
+
+ + +
+
+ + +
-
- -
-
Bearer
-
-
-
- +
+
Bearer
+
+
+
+ + +
+
+
+ + +
+
-
-
- - +
+
+ + +
+
+
+ + +
+
-
-
- -
-
Ditto Pre Authenticated
-
-
-
-
-
-
- - +
+
+
Ditto Pre Authenticated
+
+
+
+ + +
+
+
+ + +
+ id="authorizeSubmit">Authorize
diff --git a/ui/modules/environments/authorization.js b/ui/modules/environments/authorization.js index 6c261a8fe1..9a1752f6a0 100644 --- a/ui/modules/environments/authorization.js +++ b/ui/modules/environments/authorization.js @@ -21,6 +21,7 @@ let dom = { bearer: null, userName: null, password: null, + bearerDevOps: null, devOpsUserName: null, devOpsPassword: null, dittoPreAuthenticatedUsername: null, @@ -30,24 +31,50 @@ let dom = { export function ready() { Utils.getAllElementsById(dom); - document.getElementById('authorizeBearer').onclick = () => { - Environments.current().useBasicAuth = false; - Environments.current().useDittoPreAuthenticatedAuth = false; - Environments.current().bearer = dom.bearer.value; - Environments.environmentsJsonChanged('authorization'); + document.getElementById('authorize').onclick = () => { + let mainAuth = Environments.current().mainAuth; + let devopsAuth = Environments.current().devopsAuth; + + if (!mainAuth) { + if (dom.dittoPreAuthenticatedUsername.value && dom.dittoPreAuthenticatedUsername.value.length > 0) { + mainAuth = 'pre'; + } else if (dom.bearer.value && dom.bearer.value.length > 0) { + mainAuth = 'bearer'; + } else if (dom.userName.value && dom.userName.value.length > 0) { + mainAuth = 'basic'; + } + } + if (!devopsAuth) { + if (dom.bearerDevOps.value && dom.bearerDevOps.value.length > 0) { + devopsAuth = 'bearer'; + } else if (dom.devOpsUserName.value && dom.devOpsUserName.value.length > 0) { + devopsAuth = 'basic'; + } + } + + const mainAuths = document.querySelectorAll('input[name="main-auth"]'); + for(let i = 0; i < mainAuths.length; i++) { + mainAuths[i].checked = mainAuths[i].value === mainAuth; + } + + const devopsAuths = document.querySelectorAll('input[name="devops-auth"]'); + for(let i = 0; i < devopsAuths.length; i++) { + devopsAuths[i].checked = devopsAuths[i].value === devopsAuth; + } + }; - document.getElementById('authorizeBasic').onclick = () => { - Environments.current().useBasicAuth = true; - Environments.current().useDittoPreAuthenticatedAuth = false; + document.getElementById('authorizeSubmit').onclick = () => { + const mainAuthSelector = document.querySelector('input[name="main-auth"]:checked'); + const mainAuth = mainAuthSelector ? mainAuthSelector.value : undefined; + const devopsAuthSelector = document.querySelector('input[name="devops-auth"]:checked'); + const devopsAuth = devopsAuthSelector ? devopsAuthSelector.value : undefined; + Environments.current().mainAuth = mainAuth; + Environments.current().devopsAuth = devopsAuth; Environments.current().usernamePassword = dom.userName.value + ':' + dom.password.value; Environments.current().usernamePasswordDevOps = dom.devOpsUserName.value + ':' + dom.devOpsPassword.value; - Environments.environmentsJsonChanged('authorization'); - }; - - document.getElementById('authorizePreAuthenticated').onclick = () => { - Environments.current().useBasicAuth = false; - Environments.current().useDittoPreAuthenticatedAuth = true; + Environments.current().bearer = dom.bearer.value; + Environments.current().bearerDevOps = dom.bearerDevOps.value; Environments.current().dittoPreAuthenticatedUsername = dom.dittoPreAuthenticatedUsername.value; Environments.environmentsJsonChanged(); }; @@ -63,6 +90,7 @@ export function onEnvironmentChanged() { dom.devOpsUserName.value = usernamePassword.split(':')[0]; dom.devOpsPassword.value = usernamePassword.split(':')[1]; dom.bearer.value = Environments.current().bearer ? Environments.current().bearer : ''; + dom.bearerDevOps.value = Environments.current().bearerDevOps ? Environments.current().bearerDevOps : ''; dom.dittoPreAuthenticatedUsername.value = Environments.current().dittoPreAuthenticatedUsername ? Environments.current().dittoPreAuthenticatedUsername : ''; diff --git a/ui/templates/environmentTemplates.json b/ui/templates/environmentTemplates.json index 6cbfe8e24a..5bca6192b7 100644 --- a/ui/templates/environmentTemplates.json +++ b/ui/templates/environmentTemplates.json @@ -3,30 +3,33 @@ "api_uri": "http://localhost:8080", "ditto_version": 3, "bearer": null, + "bearerDevOps": null, "defaultUsernamePassword": "ditto:ditto", + "defaultDittoPreAuthenticatedUsername": null, "defaultUsernamePasswordDevOps": "devops:foobar", - "useBasicAuth": true, - "useDittoPreAuthenticatedAuth": false, - "defaultDittoPreAuthenticatedUsername": null + "mainAuth": "basic", + "devopsAuth": "basic" }, "local_ditto_ide": { "api_uri": "http://localhost:8080", "ditto_version": 3, "bearer": null, + "bearerDevOps": null, "defaultUsernamePassword": null, - "defaultUsernamePasswordDevOps": null, - "useBasicAuth": false, - "useDittoPreAuthenticatedAuth": true, - "defaultDittoPreAuthenticatedUsername": "pre:ditto" + "defaultDittoPreAuthenticatedUsername": "pre:ditto", + "defaultUsernamePasswordDevOps": "devops:foobar", + "mainAuth": "pre", + "devopsAuth": "basic" }, "ditto_sandbox": { "api_uri": "https://ditto.eclipseprojects.io", "ditto_version": 3, "bearer": null, + "bearerDevOps": null, "defaultUsernamePassword": "ditto:ditto", + "defaultDittoPreAuthenticatedUsername": null, "defaultUsernamePasswordDevOps": null, - "useBasicAuth": true, - "useDittoPreAuthenticatedAuth": false, - "defaultDittoPreAuthenticatedUsername": null + "mainAuth": "basic", + "devopsAuth": null } } \ No newline at end of file From a0fd0f12660cd54d1d594e6df6e461d571d50adb Mon Sep 17 00:00:00 2001 From: Thomas Jaeckle Date: Tue, 7 Mar 2023 07:55:20 +0100 Subject: [PATCH 02/42] [#1592] switched grouping of different auth* methods based on "main / devops" auth Signed-off-by: Thomas Jaeckle --- ui/modules/environments/authorization.html | 67 +++++++++++----------- 1 file changed, 32 insertions(+), 35 deletions(-) diff --git a/ui/modules/environments/authorization.html b/ui/modules/environments/authorization.html index ef3a0b8848..c0e2b7051f 100644 --- a/ui/modules/environments/authorization.html +++ b/ui/modules/environments/authorization.html @@ -19,12 +19,12 @@
-
Basic Auth
+
Main authentication
- +
@@ -37,42 +37,58 @@
Basic Auth
-
+
- - + +
- - + +
+
+
+
+
+ + +
+
- - + +
-
Bearer
+
DevOps authentication
+ (for Connections and administrative tasks, optional)
- - + +
- - + + +
+
+ +
-
+
- +
@@ -84,25 +100,6 @@
Bearer
-
-
Ditto Pre Authenticated
-
-
-
- - -
-
-
- - -
-
-
-
From 7db85d78bf99f284b0ff7a1067ec129f862346c2 Mon Sep 17 00:00:00 2001 From: Thomas Jaeckle Date: Tue, 7 Mar 2023 17:11:19 +0100 Subject: [PATCH 03/42] prepare Ditto 3.2.0 release Signed-off-by: Thomas Jaeckle --- documentation/README.md | 2 +- documentation/src/main/resources/_config.yml | 2 + .../src/main/resources/_data/authors.yml | 4 +- .../_data/sidebars/ditto_sidebar.yml | 3 + .../src/main/resources/_includes/head.html | 14 +- .../src/main/resources/_includes/topnav.html | 2 +- .../src/main/resources/_layouts/start.html | 2 +- .../_posts/2018-02-08-feature-definition.md | 2 +- .../2018-05-02-connecting-ditto-hono.md | 18 +-- .../2018-12-05-example-command-and-control.md | 12 +- .../2023-03-08-release-announcement-320.md | 77 +++++++++ .../resources/pages/ditto/basic-feature.md | 2 +- .../resources/pages/ditto/basic-signals.md | 2 +- .../pages/ditto/basic-wot-integration.md | 2 +- .../pages/ditto/connectivity-mapping.md | 2 +- .../connectivity-protocol-bindings-amqp10.md | 6 +- .../connectivity-protocol-bindings-mqtt.md | 2 +- .../pages/ditto/release_notes_150.md | 2 +- .../pages/ditto/release_notes_310.md | 2 +- .../pages/ditto/release_notes_320.md | 150 ++++++++++++++++++ .../2018_02_07-virtualiot-meetup/index.html | 6 +- .../2018_05_23-meetup-iot-hessen/index.html | 9 +- .../index.html | 2 +- .../3rd-party-dependencies/maven-plugins.txt | 4 +- pom.xml | 8 +- 25 files changed, 284 insertions(+), 53 deletions(-) create mode 100644 documentation/src/main/resources/_posts/2023-03-08-release-announcement-320.md create mode 100644 documentation/src/main/resources/pages/ditto/release_notes_320.md diff --git a/documentation/README.md b/documentation/README.md index 706f130e04..878139c3b3 100755 --- a/documentation/README.md +++ b/documentation/README.md @@ -49,7 +49,7 @@ bundle exec jekyll serve --verbose --unpublished Validate that the HTML does not contain dead links, etc.: ```bash -htmlproofer --assume-extension --allow-hash-href --disable-external --enforce-https=false --ignore-urls "/http-api-doc.html.*/" src/main/resources/_site/ +htmlproofer --assume-extension --allow-hash-href --disable-external --ignore-urls "/http-api-doc.html.*/","http://localhost:4000/feed.xml","http://www.ontology-of-units-of-measure.org/page/om-2" src/main/resources/_site/ ``` #### Alternative 2: use Maven (UNIX) diff --git a/documentation/src/main/resources/_config.yml b/documentation/src/main/resources/_config.yml index 517bf8d789..e87bf43154 100644 --- a/documentation/src/main/resources/_config.yml +++ b/documentation/src/main/resources/_config.yml @@ -114,6 +114,8 @@ plugins: docVersions: - label: "development" basePath: "" + - label: "3.2" + basePath: "3.2" - label: "3.1" basePath: "3.1" - label: "3.0" diff --git a/documentation/src/main/resources/_data/authors.yml b/documentation/src/main/resources/_data/authors.yml index ef679a63b1..1e286541d9 100644 --- a/documentation/src/main/resources/_data/authors.yml +++ b/documentation/src/main/resources/_data/authors.yml @@ -1,6 +1,6 @@ thomas_jaeckle: name: Thomas Jäckle - email: ditto@jaeckles.de + email: thomas.jaeckle@beyonnex.io web: https://github.com/thjaeckle florian_fendt: @@ -10,7 +10,7 @@ florian_fendt: juergen_fickel: name: Jürgen Fickel - email: juergen.fickel@bosch.io + email: eclipse-foundation@retujo.de web: https://github.com/jufickel-b philipp_michalski: diff --git a/documentation/src/main/resources/_data/sidebars/ditto_sidebar.yml b/documentation/src/main/resources/_data/sidebars/ditto_sidebar.yml index 689dadad93..2dec4961e8 100644 --- a/documentation/src/main/resources/_data/sidebars/ditto_sidebar.yml +++ b/documentation/src/main/resources/_data/sidebars/ditto_sidebar.yml @@ -23,6 +23,9 @@ entries: - title: Release Notes output: web folderitems: + - title: 3.2.0 + url: /release_notes_320.html + output: web - title: 3.1.2 url: /release_notes_312.html output: web diff --git a/documentation/src/main/resources/_includes/head.html b/documentation/src/main/resources/_includes/head.html index 8e92a1e37f..89e575f0cd 100644 --- a/documentation/src/main/resources/_includes/head.html +++ b/documentation/src/main/resources/_includes/head.html @@ -6,17 +6,17 @@ {% if page.title %} {% if page.layout == "post" %} {{ page.title }} • {{ site.topnav_title }}{% else %} {{ page.title }} • {{ site.short_title }}{% endif %}{% else %}{{ site.site_title }}{% endif %} - + - + - - - + + + @@ -36,5 +36,5 @@ - - + + diff --git a/documentation/src/main/resources/_includes/topnav.html b/documentation/src/main/resources/_includes/topnav.html index b97d3cfb6a..d17e798b33 100644 --- a/documentation/src/main/resources/_includes/topnav.html +++ b/documentation/src/main/resources/_includes/topnav.html @@ -72,7 +72,7 @@
    - + - +