diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 000000000..68adbda1a --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + + - package-ecosystem: "npm" + directory: "/docs" + schedule: + interval: "weekly" + open-pull-requests-limit: 10 diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 7d4544298..bf8cf618e 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -12,17 +12,17 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 with: # fetch all commits to get last updated time or other git log info fetch-depth: 0 - + - name: Setup Node.js - uses: actions/setup-node@v3 + uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: # choose node.js version to use node-version: 24 - + - name: Install dependencies run: cd docs && npm ci @@ -32,7 +32,7 @@ jobs: # please check out the docs of the workflow for more details # @see https://github.com/crazy-max/ghaction-github-pages - name: Deploy to GitHub Pages - uses: crazy-max/ghaction-github-pages@v4 + uses: crazy-max/ghaction-github-pages@df5cc2bfa78282ded844b354faee141f06b41865 # v4.2.0 with: # deploy to gh-pages branch target_branch: gh-pages diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 125503931..44060071e 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -12,14 +12,14 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - + - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + - name: Setup Node.js - uses: actions/setup-node@v3 + uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: # choose node.js version to use node-version: 24 - + - name: Install dependencies run: cd docs && npm ci diff --git a/docs/package-lock.json b/docs/package-lock.json index 9e3f833c1..609fc5469 100644 --- a/docs/package-lock.json +++ b/docs/package-lock.json @@ -14,15 +14,16 @@ "@vuepress/plugin-markdown-math": "2.0.0-rc.121", "@vuepress/plugin-markdown-tab": "2.0.0-rc.121", "@vuepress/plugin-slimsearch": "2.0.0-rc.121", - "katex": "^0.16.28", - "sass-embedded": "^1.97.3", - "sass-loader": "^16.0.7", - "vue": "^3.5.28", + "katex": "0.16.28", + "sass-embedded": "1.97.3", + "sass-loader": "16.0.7", + "tsx": "4.22.4", + "vue": "3.5.28", "vuepress": "2.0.0-rc.26", "vuepress-theme-hope": "2.0.0-rc.102" }, "optionalDependencies": { - "@rollup/rollup-linux-x64-gnu": "^4.57.1" + "@rollup/rollup-linux-x64-gnu": "4.59.0" } }, "node_modules/@babel/helper-string-parser": { @@ -6030,6 +6031,481 @@ "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", "dev": true }, + "node_modules/tsx": { + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.22.4.tgz", + "integrity": "sha512-X8EX+XV4QR5xCsrgxaED954zTDfY8KqlDtskKEL0cHhyS/P8b4IFOvGDQpsC9Q1XnLq915wEfwwY/zzskCtmhg==", + "dev": true, + "dependencies": { + "esbuild": "~0.28.0" + }, + "bin": { + "tsx": "dist/cli.mjs" + }, + "engines": { + "node": ">=18.0.0" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + } + }, + "node_modules/tsx/node_modules/@esbuild/aix-ppc64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.28.0.tgz", + "integrity": "sha512-lhRUCeuOyJQURhTxl4WkpFTjIsbDayJHih5kZC1giwE+MhIzAb7mEsQMqMf18rHLsrb5qI1tafG20mLxEWcWlA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/android-arm": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.28.0.tgz", + "integrity": "sha512-wqh0ByljabXLKHeWXYLqoJ5jKC4XBaw6Hk08OfMrCRd2nP2ZQ5eleDZC41XHyCNgktBGYMbqnrJKq/K/lzPMSQ==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/android-arm64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.28.0.tgz", + "integrity": "sha512-+WzIXQOSaGs33tLEgYPYe/yQHf0WTU0X42Jca3y8NWMbUVhp7rUnw+vAsRC/QiDrdD31IszMrZy+qwPOPjd+rw==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/android-x64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.28.0.tgz", + "integrity": "sha512-+VJggoaKhk2VNNqVL7f6S189UzShHC/mR9EE8rDdSkdpN0KflSwWY/gWjDrNxxisg8Fp1ZCD9jLMo4m0OUfeUA==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/darwin-arm64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.28.0.tgz", + "integrity": "sha512-0T+A9WZm+bZ84nZBtk1ckYsOvyA3x7e2Acj1KdVfV4/2tdG4fzUp91YHx+GArWLtwqp77pBXVCPn2We7Letr0Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/darwin-x64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.28.0.tgz", + "integrity": "sha512-fyzLm/DLDl/84OCfp2f/XQ4flmORsjU7VKt8HLjvIXChJoFFOIL6pLJPH4Yhd1n1gGFF9mPwtlN5Wf82DZs+LQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/freebsd-arm64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.28.0.tgz", + "integrity": "sha512-l9GeW5UZBT9k9brBYI+0WDffcRxgHQD8ShN2Ur4xWq/NFzUKm3k5lsH4PdaRgb2w7mI9u61nr2gI2mLI27Nh3Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/freebsd-x64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.28.0.tgz", + "integrity": "sha512-BXoQai/A0wPO6Es3yFJ7APCiKGc1tdAEOgeTNy3SsB491S3aHn4S4r3e976eUnPdU+NbdtmBuLncYir2tMU9Nw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/linux-arm": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.28.0.tgz", + "integrity": "sha512-CjaaREJagqJp7iTaNQjjidaNbCKYcd4IDkzbwwxtSvjI7NZm79qiHc8HqciMddQ6CKvJT6aBd8lO9kN/ZudLlw==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/linux-arm64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.28.0.tgz", + "integrity": "sha512-RVyzfb3FWsGA55n6WY0MEIEPURL1FcbhFE6BffZEMEekfCzCIMtB5yyDcFnVbTnwk+CLAgTujmV/Lgvih56W+A==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/linux-ia32": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.28.0.tgz", + "integrity": "sha512-KBnSTt1kxl9x70q+ydterVdl+Cn0H18ngRMRCEQfrbqdUuntQQ0LoMZv47uB97NljZFzY6HcfqEZ2SAyIUTQBQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/linux-loong64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.28.0.tgz", + "integrity": "sha512-zpSlUce1mnxzgBADvxKXX5sl8aYQHo2ezvMNI8I0lbblJtp8V4odlm3Yzlj7gPyt3T8ReksE6bK+pT3WD+aJRg==", + "cpu": [ + "loong64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/linux-mips64el": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.28.0.tgz", + "integrity": "sha512-2jIfP6mmjkdmeTlsX/9vmdmhBmKADrWqN7zcdtHIeNSCH1SqIoNI63cYsjQR8J+wGa4Y5izRcSHSm8K3QWmk3w==", + "cpu": [ + "mips64el" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/linux-ppc64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.28.0.tgz", + "integrity": "sha512-bc0FE9wWeC0WBm49IQMPSPILRocGTQt3j5KPCA8os6VprfuJ7KD+5PzESSrJ6GmPIPJK965ZJHTUlSA6GNYEhg==", + "cpu": [ + "ppc64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/linux-riscv64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.28.0.tgz", + "integrity": "sha512-SQPZOwoTTT/HXFXQJG/vBX8sOFagGqvZyXcgLA3NhIqcBv1BJU1d46c0rGcrij2B56Z2rNiSLaZOYW5cUk7yLQ==", + "cpu": [ + "riscv64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/linux-s390x": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.28.0.tgz", + "integrity": "sha512-SCfR0HN8CEEjnYnySJTd2cw0k9OHB/YFzt5zgJEwa+wL/T/raGWYMBqwDNAC6dqFKmJYZoQBRfHjgwLHGSrn3Q==", + "cpu": [ + "s390x" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/linux-x64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.28.0.tgz", + "integrity": "sha512-us0dSb9iFxIi8srnpl931Nvs65it/Jd2a2K3qs7fz2WfGPHqzfzZTfec7oxZJRNPXPnNYZtanmRc4AL/JwVzHQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/netbsd-arm64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.28.0.tgz", + "integrity": "sha512-CR/RYotgtCKwtftMwJlUU7xCVNg3lMYZ0RzTmAHSfLCXw3NtZtNpswLEj/Kkf6kEL3Gw+BpOekRX0BYCtklhUw==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/netbsd-x64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.28.0.tgz", + "integrity": "sha512-nU1yhmYutL+fQ71Kxnhg8uEOdC0pwEW9entHykTgEbna2pw2dkbFSMeqjjyHZoCmt8SBkOSvV+yNmm94aUrrqw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/openbsd-arm64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.28.0.tgz", + "integrity": "sha512-cXb5vApOsRsxsEl4mcZ1XY3D4DzcoMxR/nnc4IyqYs0rTI8ZKmW6kyyg+11Z8yvgMfAEldKzP7AdP64HnSC/6g==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/openbsd-x64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.28.0.tgz", + "integrity": "sha512-8wZM2qqtv9UP3mzy7HiGYNH/zjTA355mpeuA+859TyR+e+Tc08IHYpLJuMsfpDJwoLo1ikIJI8jC3GFjnRClzA==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/openharmony-arm64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.28.0.tgz", + "integrity": "sha512-FLGfyizszcef5C3YtoyQDACyg95+dndv79i2EekILBofh5wpCa1KuBqOWKrEHZg3zrL3t5ouE5jgr94vA+Wb2w==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/sunos-x64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.28.0.tgz", + "integrity": "sha512-1ZgjUoEdHZZl/YlV76TSCz9Hqj9h9YmMGAgAPYd+q4SicWNX3G5GCyx9uhQWSLcbvPW8Ni7lj4gDa1T40akdlw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/win32-arm64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.28.0.tgz", + "integrity": "sha512-Q9StnDmQ/enxnpxCCLSg0oo4+34B9TdXpuyPeTedN/6+iXBJ4J+zwfQI28u/Jl40nOYAxGoNi7mFP40RUtkmUA==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/win32-ia32": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.28.0.tgz", + "integrity": "sha512-zF3ag/gfiCe6U2iczcRzSYJKH1DCI+ByzSENHlM2FcDbEeo5Zd2C86Aq0tKUYAJJ1obRP84ymxIAksZUcdztHA==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/@esbuild/win32-x64": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.28.0.tgz", + "integrity": "sha512-pEl1bO9mfAmIC+tW5btTmrKaujg3zGtUmWNdCw/xs70FBjwAL3o9OEKNHvNmnyylD6ubxUERiEhdsL0xBQ9efw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/tsx/node_modules/esbuild": { + "version": "0.28.0", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.28.0.tgz", + "integrity": "sha512-sNR9MHpXSUV/XB4zmsFKN+QgVG82Cc7+/aaxJ8Adi8hyOac+EXptIp45QBPaVyX3N70664wRbTcLTOemCAnyqw==", + "dev": true, + "hasInstallScript": true, + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.28.0", + "@esbuild/android-arm": "0.28.0", + "@esbuild/android-arm64": "0.28.0", + "@esbuild/android-x64": "0.28.0", + "@esbuild/darwin-arm64": "0.28.0", + "@esbuild/darwin-x64": "0.28.0", + "@esbuild/freebsd-arm64": "0.28.0", + "@esbuild/freebsd-x64": "0.28.0", + "@esbuild/linux-arm": "0.28.0", + "@esbuild/linux-arm64": "0.28.0", + "@esbuild/linux-ia32": "0.28.0", + "@esbuild/linux-loong64": "0.28.0", + "@esbuild/linux-mips64el": "0.28.0", + "@esbuild/linux-ppc64": "0.28.0", + "@esbuild/linux-riscv64": "0.28.0", + "@esbuild/linux-s390x": "0.28.0", + "@esbuild/linux-x64": "0.28.0", + "@esbuild/netbsd-arm64": "0.28.0", + "@esbuild/netbsd-x64": "0.28.0", + "@esbuild/openbsd-arm64": "0.28.0", + "@esbuild/openbsd-x64": "0.28.0", + "@esbuild/openharmony-arm64": "0.28.0", + "@esbuild/sunos-x64": "0.28.0", + "@esbuild/win32-arm64": "0.28.0", + "@esbuild/win32-ia32": "0.28.0", + "@esbuild/win32-x64": "0.28.0" + } + }, "node_modules/uc.micro": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", diff --git a/docs/package.json b/docs/package.json index df52c905b..74c0059da 100644 --- a/docs/package.json +++ b/docs/package.json @@ -8,6 +8,7 @@ "docs:build": "vuepress build src", "docs:clean-dev": "vuepress dev src --clean-cache", "docs:dev": "vuepress dev src", + "docs:generate-llms": "npx tsx src/.vuepress/scripts/generate-llms.ts", "docs:update-package": "npx vp-update" }, "devDependencies": { @@ -16,14 +17,15 @@ "@vuepress/plugin-markdown-math": "2.0.0-rc.121", "@vuepress/plugin-markdown-tab": "2.0.0-rc.121", "@vuepress/plugin-slimsearch": "2.0.0-rc.121", - "katex": "^0.16.28", - "sass-embedded": "^1.97.3", - "sass-loader": "^16.0.7", - "vue": "^3.5.28", + "katex": "0.16.28", + "sass-embedded": "1.97.3", + "sass-loader": "16.0.7", + "tsx": "4.22.4", + "vue": "3.5.28", "vuepress": "2.0.0-rc.26", "vuepress-theme-hope": "2.0.0-rc.102" }, "optionalDependencies": { - "@rollup/rollup-linux-x64-gnu": "^4.57.1" + "@rollup/rollup-linux-x64-gnu": "4.59.0" } } diff --git a/docs/src/.vuepress/client.ts b/docs/src/.vuepress/client.ts index 5d8b1b1b5..7ee02bc47 100644 --- a/docs/src/.vuepress/client.ts +++ b/docs/src/.vuepress/client.ts @@ -5,11 +5,11 @@ import Layout from './layouts/PageLayout.vue' import NotFoundLayout from './layouts/NotFoundLayout.vue' import BlogLayout from './layouts/BlogLayout.vue'; - +import OldVersions from './components/OldVersions.vue'; export default defineClientConfig({ enhance({ app }) { - + app.component('OldVersions', OldVersions); }, layouts: { ParentLayout, diff --git a/docs/src/.vuepress/components/OldVersions.vue b/docs/src/.vuepress/components/OldVersions.vue new file mode 100644 index 000000000..6793ec0ee --- /dev/null +++ b/docs/src/.vuepress/components/OldVersions.vue @@ -0,0 +1,19 @@ + + + diff --git a/docs/src/.vuepress/data/releases.ts b/docs/src/.vuepress/data/releases.ts index 4e2275624..f49e036e6 100644 --- a/docs/src/.vuepress/data/releases.ts +++ b/docs/src/.vuepress/data/releases.ts @@ -26,6 +26,38 @@ export const releases: Record = { }, }; +// --- Version registry (single source of truth) --- +// Sidebar keys reference generator functions by name; mapped in theme.ts. +// Ordered newest-first. +export type SidebarKey = 'v2_latest' | 'v2_0_0' | 'v1_latest' | 'v1_gte_1_7' | 'v1_gte_1_5' | 'v1_gte_1_0'; + +export interface VersionEntry { + tag: string; + sidebar: SidebarKey; +} + +export const allVersions: VersionEntry[] = [ + { tag: '2.1.0', sidebar: 'v2_latest' }, + { tag: '2.0.2', sidebar: 'v2_0_0' }, + { tag: '2.0.1', sidebar: 'v2_0_0' }, + { tag: '2.0.0', sidebar: 'v2_0_0' }, + { tag: '1.9.0', sidebar: 'v1_latest' }, + { tag: '1.8.0', sidebar: 'v1_gte_1_7' }, + { tag: '1.7.1', sidebar: 'v1_gte_1_7' }, + { tag: '1.7.0', sidebar: 'v1_gte_1_7' }, + { tag: '1.6.0', sidebar: 'v1_gte_1_5' }, + { tag: '1.5.2', sidebar: 'v1_gte_1_5' }, + { tag: '1.5.1', sidebar: 'v1_gte_1_5' }, + { tag: '1.5.0', sidebar: 'v1_gte_1_5' }, + { tag: '1.4.0', sidebar: 'v1_gte_1_0' }, + { tag: '1.3.2', sidebar: 'v1_gte_1_0' }, + { tag: '1.3.1', sidebar: 'v1_gte_1_0' }, + { tag: '1.3.0', sidebar: 'v1_gte_1_0' }, + { tag: '1.2.0', sidebar: 'v1_gte_1_0' }, + { tag: '1.1.0', sidebar: 'v1_gte_1_0' }, + { tag: '1.0.0', sidebar: 'v1_gte_1_0' }, +]; + export const latestVersion = '2.1.0'; export function getReleaseFromPath(path: string): Release | undefined { diff --git a/docs/src/.vuepress/layouts/PageLayout.vue b/docs/src/.vuepress/layouts/PageLayout.vue index daab1228f..c730251b1 100644 --- a/docs/src/.vuepress/layouts/PageLayout.vue +++ b/docs/src/.vuepress/layouts/PageLayout.vue @@ -2,10 +2,10 @@ import { Layout as ParentLayout, PageContent } from 'vuepress-theme-hope/client' import { useRoute, useRouter } from "vue-router"; import { ref, onMounted } from 'vue' +import { allVersions, latestVersion } from '../data/releases' const version = ref(""); -const latestVersion = "v2.1.0"; - +const latestTag = `v${latestVersion}`; function setVersionBasedOnCurrentPath() : void { if (route.path.startsWith('/operations/')) { @@ -13,11 +13,9 @@ function setVersionBasedOnCurrentPath() : void { const firstSlash = input.indexOf("/"); var result = firstSlash !== -1 ? input.slice(0, firstSlash) : input; if (result === "latest") { - result = latestVersion; + result = latestTag; } version.value = result; - - } else { version.value = ""; } @@ -25,7 +23,6 @@ function setVersionBasedOnCurrentPath() : void { const route = useRoute(); - const router = useRouter(); router.afterEach((_to, _from) => { setVersionBasedOnCurrentPath(); @@ -39,11 +36,10 @@ function navigateToNewVersion() { const input = route.path.substring('/operations/'.length); const firstSlash = input.indexOf("/"); const result = firstSlash !== -1 ? input.slice(firstSlash + 1) : ""; - if (version.value === latestVersion) { + if (version.value === latestTag) { router.push('/operations/' + "latest" + "/" + result); } else { router.push('/operations/' + version.value + "/" + result); - } } @@ -55,25 +51,9 @@ function navigateToNewVersion() {
@@ -84,4 +64,4 @@ function navigateToNewVersion() { .version-selector { margin-top: 20px; } - \ No newline at end of file + diff --git a/docs/src/.vuepress/public/llms-full.txt b/docs/src/.vuepress/public/llms-full.txt new file mode 100644 index 000000000..419f480a1 --- /dev/null +++ b/docs/src/.vuepress/public/llms-full.txt @@ -0,0 +1,11033 @@ +# Data Sharing Framework (DSF) + +> The Data Sharing Framework (DSF) is a secure middleware for distributing data sharing processes based on BPMN 2.0 and FHIR R4 standards. It enables biomedical researchers to extract, merge, pseudonymize, and share data across organizational boundaries. Funded by the German Federal Ministry of Research, Technology and Space within the Medical Informatics Initiative (MII). Website: https://dsf.dev + +--- + +## Introduction +Source: https://dsf.dev/explore/concepts/introduction.html + +The [German Federal Ministry of Research, Technology and Space](https://www.bmftr.bund.de/) is funding the [Medical Informatics Initiative](https://www.medizininformatik-initiative.de/en/start) with the aim of making routine data available digitally, reliably and quickly for medical research. University hospitals have founded consortia with partners such as research institutions and other companies to create the conditions for research and patient care to share their data across sites. Data Integration Centers (DIC) have been established at the university hospitals and partner institutions to create the technical and organizational conditions for data exchange between patient care and medical research. + +![MII =300x150](/photos/learnmore/funding/mii.png) + +The **Data Sharing Framework (DSF)** was developed within the HiGHmed consortium of the Medical Informatics Initiative and is now funded as an independent project by the German Federal Ministry of Research, Technology and Space within the Medical Informatics structure as *[DSF Community](https://www.gesundheitsforschung-bmbf.de/de/dsf-medizininformatik-struktur-data-sharing-framework-community-16133.php)*. + +The DSF is a concept for a secure middleware to distribute data sharing processes, aiming to extract, merge, pseudonymize and provide data stored in multiple distributed DICs. A researcher can use the DSF for example to submit feasibility queries to several DICs and thus has the opportunity to obtain sufficient data from different locations for his or her research. By using international standards such as FHIR and BPMN 2.0, the problem of heterogeneous data models, primary systems, architectures and federated legislation between DICs can be solved. The aim is to enable secure and syntactically-, semantically- and process-interoperable data exchange across organisational boundaries. + +![DSF concept](/photos/info/introduction/dsf-concept.png) + +The DSF is a secure communication infrastructure, that (1) scales with communication relationships, (2) orchestrates processes and instances, (3) separates execution logic from program code, (4) enables automated and user-centeric process steps ​(5) and can be used for heterogeny structures. + +![Federated data exchange between distributed DICs (CRP=Central Research Portal, DMU=Data Management Unit) =500x320](/photos/info/introduction/dic-structure.png) + +--- + +## Basics +Source: https://dsf.dev/explore/concepts/basics.html + +Here you can find some basic information about interoperability and the standards were using within the DSF before we go into details about the architecture. Here we only describe how the standards (FHIR and BPMN) are used within the DSF. If you want to gain a deeper knowledge of the standards, we recommend visiting these websites: [HL7 FHIR](https://www.hl7.org/fhir/) and [BPMN](https://www.bpmn.org/) + +## Interoperability +Interoperability is the ability of different systems to work together as seamlessly as possible. We can divide interoperability into four levels. +- The *foundational level* defines the basic interconnectivity requirements which are necessary for a system or application to securely transmit data to and receive data from another system or application. Techniques such as HTTPS or REST are used for this. +- The second level is the *structural level*. It defines the format and the syntax of the data exchange. Therefore, data formats like JSON or XML can be used. +- The *semantic level* ensures the correct interpretation of the contents of the exchanged data between the different systems. Therefore, information models as FHIR or CDA or medical terminology systems like SNOMED CT or ICD can be used. +- The final level, the *organizational level*, includes policy, social, legal and organizational aspects that enable secure, seamless and timely communication and use of data both within and between organizations. And importantly, these components enable shared consent, trust and integrated end-user processes and workflows. + + +![Levels of interoperability =600x](/photos/info/basics/interoperability.png ) + +## HL7 FHIR :fire: +[HL7 FHIR](https://www.hl7.org/fhir/) is a standard for data exchange that can be used as an information model for communication within and between systems. The standard is based on resources, references and profiles. With this concept, FHIR offers interoperability out of the box. The resources describe data formats. 150 specified resources cover the entire health system. An example of a resource would be a patient, which consists of data such as name or gender. These resources can refer to other resources by means of references. This connects the information units into a network. For seamless exchange of information, FHIR supports RESTful architectures and web standards such as XML or JSON, which makes it easier for developers to use FHIR. +The FHIR profiles can be understood as a set of rules. They explain, for example, which attributes must be mandatorily specified or which terminology may be used. In addition, profiles and controlled vocabulary can be validated. + +## BPMN +[Business Process Modelling Notation](https://www.bpmn.org/) is a modelling language that can be used to model and implement processes. The models can be used for the documentation of processes and for communication between different stakeholders. Furthermore, BPMN forms a standardised bridge between process design and process implementation. This is because it simplifies implementation. These processes are executed by a Business Process Engine. Basically, a BPE is a server that can read and execute the business process. More about this in the section on architecture. + +![Example of a BPMN model (Ping-Pong-Process of the DSF)](/photos/info/basics/bpmn1.png) + +## Why are we using FHIR and BPMN? +On the one hand we use FHIR because of the mentioned benefits. On the other hand FHIR fits great with BPMN and these two in combination are a great fit for what we do: +*Execute distributed data sharing Processes.* + +We do not need all 150 FHIR resources. The following FHIR resources are the ones we need and have implemented: *ActivityDefinition, Binary, Bundle, CodeSystem, DocumentReference, Endpoint, Group, Library, Measure, MeasureReport, NamingSystem, Organization, Questionnaire, QuestionnaireResponse, ResearchStudy, StructureDefinition, Subscription, Task and ValueSet.* + +Don't worry, it is not important to understand them all now. But to understand why we use FHIR and BPMN, it is important to look at the *ActivityDefinition* and *TaskResources* on the FHIR side and the *Message Events* on the BPMN side. +In the following picture you can see parts of BPMN. These *Message Events* enable the communication between different organizations. Every time there is a *Message Event* between two business processes, there is a corresponding *TaskResource* on the FHIR side. When one organization sends a message for example “do some work” to another organization or when we send a message to ourselves to start or continue a process, we do this by creating a FHIR *TaskResource* with the status “requested”. After that the Business Process Engine starts the work and the status switches to “in-progress” and if the work is done to “completed” or if there is a problem to “failed”. + +The *ActivityDefinition* is needed to publish what can be done in an instance. That means the *ActivityDefinition* contains the process description with the authorisation who is allowed to send a message. + +![BPMN *MessageEvents* =250x400](/photos/info/basics/bpmn2.png ) + +--- + +## Architecture +Source: https://dsf.dev/explore/concepts/architecture.html + +The Data Sharing Framework implements a distributed business process engine based on the BPMN 2.0 and FHIR R4 standards. Every participating organisation (e.g. ORG. A) runs a FHIR endpoint accessible by other sites and a business process engine (BPE) in the local secured network. Once the DSF has been installed in an organisation, it can be used for multiple use cases. + +![Simplified DSF Architecture](/photos/info/architecture/architecture1.png) + +The following architecture diagram also shows three organisations, each of which has installed the DSF. The FHIR endpoint (green) is located in a demilitarised zone (DMZ) and is accessible from outside for communication with other organisations. It can be compared to a mailbox. The Business Process Engine (BPE - blue) is located in the intranet of an organisation and is responsible for the execution of processes. The metaphor: control centre helps here. + +![](/photos/info/architecture/architecture.svg#light) + +![DSF Architecture](/photos/info/architecture/architecture-dark.svg#dark) + +## DSF FHIR Server +As mentioned above, the externally accessible DSF FHIR server acts as a mailbox for communication. This means that an organisation creates a task resource in its DSF and drops the task resource (letters) into the mailbox of another organisation, requesting that something happen. Task resources have been explained in more detail in the section [Basics and Standards](basics). +It is important to understand that the DSF FHIR server is not used for persisting medical data. + +![](/photos/info/architecture/fhir-server.svg#light) + +![DSF FHIR Server](/photos/info/architecture/fhir-server-dark.svg#dark) + +## Business Process Engine (BPE) +The BPE located in the secure internal network executes the processes (BPMN/Java). The BPE is deployed in the internal network and has access to the local systems, such as the organisation's own FHIR server, on which medical data is stored. These FHIR servers are not to be confused with the DSF FHIR server, on which no medical data is persisted. +Different processes can be executed simultaneously. For this, only a new process plugin file has to be added and configured. More about this in the [Process Plugins](process-plugins). + +![BPE](/photos/info/architecture/bpe-light.svg#light) + +![BPE](/photos/info/architecture/bpe-dark.svg#dark) + +The DSF BPE uses websocket (WSS) and webservice (HTTPS) connections to communicate with the DSF FHIR server. FHIR resources are created, read, updated and deleted via HTTP requests against the FHIR webservice API. The FHIR subscription mechanism is used to communicate Task resources with status 'requested' and QuestionnaireResponse resources with status 'completed' to the BPE via websockets. When the BPE starts and before the websocket connections are established, 'requested' Task resources and 'completed' QuestionnaireResponse not seen by the BPE are read via webservice requests. + +## Flexible Deployment +The deployment of the architecture is flexible. The organisations can be deployed as a *star* schema (left) or as a *mesh* schema (right). In the Star schema (left), all Data Integration Centres (DIC) are connected to a central node (CRR - Central Research Repository), which transfers the information to all nodes (DIC). For security reasons, a data transfer hub (DTH) is connected upstream, which provides additional security so that the medical data is never transferred together with the authenticating data. + +In the mesh scheme (right), the nodes (DIC) are all directly connected to each other and the information is transferred from node to node. Here in the FDPG (Forschungsdatenportal - Research Data Portal), the data can then be accessed for research purposes. More about this [here](/explore/use-cases/feasibility). + +![Star schema =400x300](/photos/info/architecture/star.png) ![Mesh schema =350x300](/photos/info/architecture/mesh.png) + +## Network Setup & Additional Reverse Proxy in external DMZ +You can find more information about the network setup [here](/explore/concepts/network-setup) + +--- + +## Security +Source: https://dsf.dev/explore/concepts/security.html + +## Basics Security +The open-source Data Sharing Framework is EU-GDPR compliant and meets the highest security standards by design. DSF FHIR servers only accept certain FHIR resources from internal systems/administrators (e.g. tasks, binary resources...). In addition, the communication partners are defined via Allow Lists. This means that an organisation can only communicate with organisations that are included in the allow list of approved organisations of the participating organisations. More information about allow lists can be found in the [next chapter](allow-list). +For transport encryption, the TLS protocol is used. Secure Web Socket (WSS) connections provide security for the connection between the DSF FHIR server (DMZ) and the BPE (internal network). In addition, the DSF is being actively developed and there is an excellent community, both of which guarantee fast security patches. + +![Certificates](/photos/info/security/certificates-light.svg#light) + +![Certificates](/photos/info/security/certificates-dark.svg#dark) + +## Authentication +Authentication of organizations within the DSF is handled by the use of X.509 client and server certificates. The DSF supports a configurable whitelist of certificate authorities. All participating organizations are entered in a distributed and synchronized allow-list of valid organizations and certificates. + +A webserver certificate is needed to run the FHIR endpoint and a 802.1X client certificate is used to authenticate against other organizations endpoints and as a server certificate for the business process engine. + +More information about client and server certificates can be found [here](/operations/latest/install#client-server-certificates). + +--- + +## Allow List +Source: https://dsf.dev/explore/concepts/allow-list.html + +## Goal +The main objective is to allow only authorized organizations to do what "we" allow them to do (e.g. query data). +First, we need a list of organizations that we trust. Secondly, we need a way to ensure that the other party is a member of the parent organization. Thirdly, a list of actions we want to allow the organization to perform is needed. An organization can have different roles in different use cases. + +The Allow List consists of Organization-, Endpoint- and OrganisationAffiliation- resources. With these resources the allow list defines communication partners and and parent organizations like research consortia and groups as well as the roles of each organization. Each DSF FHIR server stores their own allow list. To make sure that processes can be executed, parties must allow access via their allow list. + +## Allow List Managment +[Here](/operations/latest/allowList-mgm.md) you can read all the information if you want to create or update an Allow List. + +If you have the need for allowlist management feel free to contact us via E-Mail (dsf-gecko@hs-heilbronn.de) and we will take care of your request as soon as possible. + +--- + +## Process Plugins +Source: https://dsf.dev/explore/concepts/process-plugins.html + +## Overview +It is important to understand that the DSF is *only* the silent helper in the background: a middleware. The DSF is use case agnostic. This means that process plugins make it possible to execute almost any use case you can imagine with the DSF. Process plugins provide individual functionality. + +However, it is possible to deploy several process plugins parallel on the same DSF instance, even the same process plugin in different versions. A process plugin is basically an archive of BPMN 2.0 models, FHIR R4 resources and Java code. This process plugin is deployed as a Jar file on the BPE. + +## BPMN: Example +BPMN models can be created with [Camunda Modeler](https://camunda.com/de). The following model is a BPMN model consisting of two lanes: These are the square boxes, i.e. Organization A and B. This process is intended only as an example to illustrate the formalities. + +![BPMN: Example](/photos/info/plugins/bpmn-example.png) + +## Ping Pong Process as an example Process Plugin +The [ping process plugin](https://github.com/datasharingframework/dsf-process-ping-pong) can be used for (periodic) connection testing between organizations that are part of your DSF allow list. The following figure shows a representation of the process. + +![Ping-Pong Process v.2](/photos/info/use-cases/ping-pongv2.png) + + +The ping pong process is composed of 3 different subprocesses: +### Autostart Ping Process +The autostart ping process is used to execute connection tests in a predefined interval. This subprocess performs the following steps: + +- Start a timer with a predefined interval (default 24 h) +- Start the ping process once per interval +- Stop the timer after the current interval completes + +### Ping Process +The ping process is used to check outgoing and incoming connections to organizations in your allow-list. This subprocess performs the following steps: + +- Select organizations in your allow list that should receive a ping message +- Send ping message to selected organizations +- Receive pong message from selected organizations +- Log status of ping/pong messages +- Log errors if any occur + +### Pong Process +The pong process is used to send a response during the connection test to the requesting organization. This subprocess performs the following steps: + +- Receive ping message from requesting organizations +- Send pong message to requesting organizations +- Log status of ping/pong message +- Log errors if any occur + + + +--- + +## Network Setup +Source: https://dsf.dev/explore/concepts/network-setup.html + +The Data Sharing Framework consists of two components: A FHIR Endpoint Server used to except Task resources and provide resources for download by other organizations and a Business Process Engine Server run internal and not accessible by other organization to execute and coordinate processes. + +![Network Setup Diagramm](/photos/guideline/generalInformation/highmed_dsf_network_setup.svg) + +- FHIR Reverse Proxy: The FHIR Reverse Proxy is used to terminate incoming https connections to the FHIR App Server. The Reverse Proxy needs to be accessible on port 443 from the internet. Incoming https connection will be delegate as http on a docker internal network to the FHIR App Server. +- FHIR App Server: The FHIR App Server is used as a FHIR Endpoint for incoming Task resources and providing resources for download by other organizations. In order to validate incoming FHIR resources the server will communicate with FHIR Servers at other organizations. Access to resources and authorization for creating or updating resources is granted based on the content of the resource and/or based on the client (identified by its client certificate) being part of an allow list. JDBC connections to the FHIR DB Server +- FHIR DB Server: PostgreSQL database for the FHIR App Server. +- BPE App Server: The BPE App Server is executing BPMN 2.0 business processes with the included business process engine. Automatic BPMN service tasks are used for example to check resource, access the PDP- and MPI-servers as well as the MDAT repository. The calculation of record linkage bit vectors (Record Bloom Filters) is also performed using an automatic service task. As of version 0.3.0 the BPE server does not provide any webservices for modifying an server resources. +- BPE DB Server: PostgreSQL database for the BPE App Server. +- PDP: IHE Policy Decision Point for deciding on patient consent. +- MDAT Repo: Repository (e.g. openEHR) for storing medical data (MDAT). +- MPI: IHE Master Patient Index for storing identifying patient date (IDAT) e.g. first name, last name, date of birth. +- Cohort Browser: Example for a system to trigger patient cohort size estimations across multiple organizations. + +More information on Client- and Server-Certificates are available on the dedicated wiki page: [Authentication: Client/Server Certificates](Authentication) + +## Additional Reverse Proxy in external DMZ +In some organizations an additional reverse proxy in an external DMZ is needed. This can be accomplished by using for example nginx or haproxy as a TCP-Proxy. Example configurations routing traffic using SNI can be found below. Configuring an additional reverse proxy to terminate the incoming TLS connection early is not recommended. + +![Network Setup Diagramm](/photos/guideline/generalInformation/highmed_dsf_network_setup_ext_dmz.svg) + + +--- + +## Feasibility +Source: https://dsf.dev/explore/use-cases/feasibility.html + +::: warning Work in progress + +The use cases are being reworked and are currently a work in progress. Please check back later. +::: + +## Overview +Funded by the German Federal Ministry of Research and Education, 25 [sites](https://forschen-fuer-gesundheit.de/en/locations/) have installed the DSF to execute the [Feasibility](https://github.com/medizininformatik-initiative/feasibility-dsf-process/) process. To perform feasibility queries, a researcher can register and query data on the [FDPG (Forschungsdaten Portal für Gesundheit - Research Data Portal)](https://www.forschen-fuer-gesundheit.de/) website. Basic data of hospitalizations of over 8 million patients with over 40 million diagnoses and much more such as laboratory values or drug prescriptions are available. After a successful query, the data is made available in standardized FHIR format. Further information can be found in the [flyer](https://www.medizininformatik-initiative.de/sites/default/files/2023-05/20230509_TMF_Faltflyer_A4_digital.pdf). + +## The Feasibility Process +Medical routine data holds great promise for advancing research, yet its integration into a research context poses significant challenges. To address this, Medical Data Integration Centers have been established, by the medical informatics initiative to consolidate data from primary information systems into a central repository. However, relying on data from only one organization is rarely sufficient to answer complex research questions, so merging data across institutional boundaries is necessary. + +To enable researchers to leverage this integrated data for specific research projects, there is a critical need for the ability to query cohort sizes across institutions. The [feasibility](https://github.com/medizininformatik-initiative/feasibility-dsf-process/) process allows researchers to conduct automated and distributed feasibility queries, i.e., cohort size estimates. This process is executed according to the open standard BPMN 2.0, the underlying process data model is based on HL7 FHIR R4 resources. + +## Technical Information +- [DSF Middleware Setup](https://github.com/medizininformatik-initiative/feasibility-deploy/wiki/DSF-Middleware-Setup): The DSF middleware connects your site to the central platform. This allows it to receive feasibility query requests as well as reporting back any results of these queries. +- [Feasibility Process](https://github.com/medizininformatik-initiative/feasibility-dsf-process/): Core Feasibility Process +- [Feasibility Triangle](https://github.com/medizininformatik-initiative/feasibility-deploy/tree/main/feasibility-triangle): The Feasibility Triangle part of this repository provides a site (data integration center) with all the necessary components to set up in order to allow feasibility queries from the central feasibility portal. +- [Data Transfer](https://github.com/medizininformatik-initiative/mii-dsf-processes/tree/main) +- [Data extraction after successful feasibility query](https://github.com/medizininformatik-initiative/mii-dsf-processes/blob/main/mii-dsf-processes-docker-test-setup/README-Process-Projectathon-Data-Sharing.md) + +--- + +## NUM (Network University Medicine) +Source: https://dsf.dev/explore/use-cases/num.html + +::: warning Work in progress + +The use cases are being reworked and are currently a work in progress. Please check back later. +::: + +The [Network University Medicine](https://www.netzwerk-universitaetsmedizin.de/) was established in April 2020 as part of the COVID-19 pandemic crisis management. The aim of the NUM is to better coordinate COVID-19 research at all 36 university hospitals in Germany.' +::: center +![NUM =370x220](/photos/learnmore/projects/num.png ) +::: + +As part of the *[CODEX | COVID-19 Data Exchange Platform](https://www.netzwerk-universitaetsmedizin.de/projekte/codex#c599)* project, a nationwide, uniform, privacy-compliant infrastructure for storing and providing COVID-19 research datasets was established. Since 2022, the work continues within the project [NUM RDP](https://www.netzwerk-universitaetsmedizin.de/projekte/num-rdp). All 36 university hospitals have installed the DSF to share Covid-19 research data. + +### The Data Transfer Process +The [Data Transfer Process](https://github.com/num-codex/codex-processes-ap1) is used in NUM CODEX to send data from a Data Integration Center (DIC), via the Gecco Transfer Hub (GTH), to the Central Research Repository (CRR). The infrastructure and communincation messages on which the process is based can be seen in the following figure. All organizations use the Data Sharing Framework (DSF) for deployment and execution of the process. + +![](/photos/learnmore/projects/ap1.png) + +More technical information can be found on [GitHub](https://github.com/num-codex/codex-processes-ap1/wiki/Process-Description-v1.0.0.0). + +--- + +## Internal MII Data Sharing +Source: https://dsf.dev/explore/use-cases/internal-mii-data-sharing.html + +## Video + + + + + +## References + +- https://github.com/medizininformatik-initiative/mii-process-data-sharing/wiki/Process-Data-Sharing-Start-v1.0.x.x#dic-prepare-kds-fhir-store-before-answering-a-manual-user-task +- https://dsf.dev/sprechstunde + +--- + +## Get Started +Source: https://dsf.dev/operations/get-started.html + + + +--- + +## Installation Guide +Source: https://dsf.dev/operations/latest/install.html + +In the following installation manual we will show you how you can install your own DSF instance to be part of an already existing DSF network. + + +## Prerequisites +### Virtual Machines +* DSF FHIR VM: min. 4 GB RAM, 4 vCPU, 100 GB HDD +* DSF BPE VM: min. 8 GB RAM, 4 vCPU, 20 GB HDD + +If you plan to transfer a lot of large files, we recommend a larger FHIR VM disk for temporary storage (if your largest file to transfer is 200GB in size, we recommend a disk with a size of at least 1TB). + +Please make sure to use a CPU with a modern instruction set with crypto acceleration enabled. We saw large performance drops on systems with inadequate hardware. + +### Docker / Docker-Compose +Both VMs need latest docker and docker compose. For the latest install guide see https://docs.docker.com/engine/install. + +``` +sudo apt-get update +sudo apt-get install apt-transport-https ca-certificates curl gnupg lsb-release +curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg +echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null +sudo apt-get update +sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin +sudo systemctl enable docker.service +sudo systemctl enable containerd.service +``` + +The current version of docker compose is installed with the current docker version. + +### Client/Server Certificates +Two Certificates from a list of allowed certificate authorities (see [details about certificates](root-certificates.html)) are needed: +* Certificate _A_: Server Certificate - `TLS Web Server Authentication` +* Certificate _B_: Client Certificate - `TLS Web Client Authentication` + +If you use GÉANT TCS certificates, then they are configured by default with the necessary *X509v3 Extended Key Usage*s until the end of February 2026: `TLS Web Server Authentication, TLS Web Client Authentication`. + +For further details on supported Root Certificate Authorities click [here](root-certificates.html#list-of-default-trusted-certificate-authorities) + + +### Network setup / Network access + +* The DSF FHIR server needs to be accessible via the internet and able to access the internet without TLS interception. +* The BPE FHIR server should only be accessible by the internal network and able to access your DSF FHIR server via its external FQDN and the internet without TLS interception. + +Here is a quick overview of the expected network setup. + +| Source | Target | Port | Protocol | +| ----------------------------- | ----------------------------- | ---- | ---------------------- | +| DSF BPE (local) | DSF FHIR (local) | 443 | https, wss | +| DSF BPE (local) | DSF FHIR (other DSF communication partners) | 443 | https | +| DSF FHIR (local) | DSF FHIR (other DSF communication partners) | 443 | https (HTTP HEAD only) | +| DSF BPE (other DSF communication partners) | DSF FHIR (local) | 443 | https | +| DSF FHIR (other DSF communication partners) | DSF FHIR (local) | 443 | https (HTTP HEAD only) | + + Connections to services that are used by process plugins (e.g. a fTTP, a terminology server, simplifier.net or a local FHIR server) are not listed. Please refer to the respective process plugin documentation pages for more information. + + + +## Setup +### Prepare Certificates +1. Server Certificate (certificate _A_) + _This certificate will be used as the DSF FHIR servers server certificate (ssl_certificate_file.pem, ssl_certificate_key_file.pem)_ + * Store PEM encoded certificate as `ssl_certificate_file.pem` + * Store unencrypted, PEM encoded private-key as `ssl_certificate_key_file.pem` + * Store PEM encoded certificate chain (all intermediate CAs between the server and the root certificate, excluding root) as `ssl_certificate_chain_file.pem` + +1. Client Certificate (Certificate _B_) + _This certificate will be used as the DSF BPE servers client certificate (client_certificate.pem, client_certificate_private_key.pem) as well as the DSF FHIR servers client certificate (client_certificate.pem, client_certificate_private_key.pem)_ + * Store PEM encoded certificate as `client_certificate.pem` + * Store encrypted or not encrypted, PEM encoded private-key as `client_certificate_private_key.pem` + +### DSF FHIR Server +1. Add Group/User + Add group and user used by the DSF FHIR java application. Ubuntu compatible commands below: + ``` + sudo groupadd --gid 2101 fhir + sudo useradd --system --no-create-home --uid 2101 --gid 2101 fhir + ``` + +1. Download and Extract Config Files + Download and unpack the prepared DSF FHIR server config files and folder structure: + ``` + cd /opt + wget https://dsf.dev/download/dsf_fhir_2_1_0.tar.gz + sudo tar --same-owner -zxvf dsf_fhir_2_1_0.tar.gz + ``` + _The `tar` command will unpack the config files at `/opt/fhir` assuming you changed into the `/opt` directory._ + +1. Verify that the `fhir` system user or group can write into the following folder + * `/opt/fhir/log` + +1. Add certificates and keys + * Add the server certificate (certificate _A_), the corresponding private-key and the certificate chain (one file with all intermediate certificates, excluding the root CA) to **/opt/fhir/secrets/** + * ssl_certificate_file.pem (chmod: 440, chown: root:4101, 4101 is the user of the fhir proxy) + * ssl_certificate_key_file.pem (chmod: 440, chown: root:4101) + * ssl_certificate_chain_file.pem (chmod: 444, chown: root:fhir) + * Add the client certificate (Certificate _B_) and the corresponding private-key to **/opt/fhir/secrets/** + * client_certificate.pem (chmod: 440, chown: root:fhir) + * client_certificate_private_key.pem (chmod: 440, chown: root:fhir) + * If the private key is encrypted, add a password file with the password as the only content to **/opt/fhir/secrets/client_certificate_private_key.pem.password** + * If the private key is not encrypted, remove the corresponding docker secret lines from the `docker-compose.yml` file + ``` + L37: - app_client_certificate_private_key.pem.password + ... + L50: DEV_DSF_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE: /run/secrets/app_client_certificate_private_key.pem.password + ... + L108: app_client_certificate_private_key.pem.password: + L109: file: ./secrets/client_certificate_private_key.pem.password + ``` + + ::: tip How to chmod / chown + For the example *ssl_certificate_file.pem (chmod: 440, chown: root:4101)* you must: + + 1. Set the file content as requested + 2. Change the file permissions to 440 (allow read access to the owner of the file and the group the file belongs to, deny write access to everybody and deny read for other users): + `chmod 440 /opt/fhir/secrets/ssl_certificate_file.pem` + 3. Change the owner of the file to the user root and the group the file belongs to to the id 4101: + `chown fhir:docker /opt/fhir/secrets/ssl_certificate_file.pem` + + ::: + +1. Modify database passwords + * **/opt/fhir/secrets/db_liquibase.password** + * Generate a random password (min. 32 characters recommended) and replace the content of the file. + * **/opt/fhir/secrets/db_user.password** + * Generate a random password (min. 16 characters recommended) and replace the content of the file. + * **/opt/fhir/secrets/db_user_permanent_delete.password** + * Generate a random password (min. 16 characters recommended) and replace the content of the file. + +1. Modify the docker-compose.yml file and set environment variables to the appropriate values + * **services -> proxy -> environment:** + * **HTTPS_SERVER_NAME_PORT**: `dsf.todo.organization.com:443` + Set your FHIR servers external FQDN, e.g. `https://foo.bar.de` -> `foo.bar.de:443` + * For additional environment variables, see the FHIR Reverse Proxy [Configuration Parameters](fhir-reverse-proxy/configuration) page. + * **services -> app -> environment:** + * **DEV_DSF_FHIR_SERVER_ORGANIZATION_IDENTIFIER_VALUE**: `todo.organization.com` + Set your Organizations DSF identifier, aka the shortest FQDN that resolves to the main homepage of the organization, e.g. `hs-heilbronn.de` + * **DEV_DSF_FHIR_SERVER_BASE_URL**: `https://dsf.todo.organization.com/fhir` + Set your FHIR servers external FQDN, e.g. `foo.bar.de` -> `https://foo.bar.de/fhir` + * **DEV_DSF_FHIR_SERVER_ROLECONFIG**: `|` + (Optional) You can add other client certificates (e.g. personal certificates from admins) to your DSF instance. For additional information, see the FHIR server [Access Control](fhir/access-control) page. + + * For additional environment variables, see the FHIR server [Configuration Parameters](fhir/configuration) page. + +1. Start the DSF FHIR Server + Start using: `docker compose up -d && docker compose logs -f` (Ctrl-C will close log, but not stop container) + +### DSF BPE Server +1. Add Group/User + Add group and user used by the DSF BPE java application. Ubuntu compatible commands below: + ``` + sudo groupadd --gid 2202 bpe + sudo useradd --system --no-create-home --uid 2202 --gid 2202 bpe + ``` +1. Download and Extract Config Files + Download and extract prepared DSF BPE server config files and folder structure: + ``` + cd /opt + wget https://dsf.dev/download/dsf_bpe_2_1_0.tar.gz + sudo tar --same-owner -zxvf dsf_bpe_2_1_0.tar.gz + ``` + _The `tar` command will unpack the config files at `/opt/bpe` assuming you changed into the `/opt` directory._ + +1. Verify that the `bpe` system user or group can write into the following folders + * `/opt/bpe/log` + +1. Add certificates and keys + * Add the client certificate (Certificate _B_) and the corresponding private-key to **/opt/bpe/secrets/** + * client_certificate.pem (chmod: 440 chown: root:bpe) + * client_certificate_private_key.pem (chmod: 440 chown: root:bpe) + * If the private key is encrypted, add a password file with the password as the only content to **/opt/bpe/secrets/client_certificate_private_key.pem.password** + * If the private key is not encrypted, remove the corresponding docker secret lines from the `docker-compose.yml` file + ``` + L11: - app_client_certificate_private_key.pem.password + ... + L31: DEV_DSF_BPE_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE: /run/secrets/app_client_certificate_private_key.pem.password + ... + L82: app_client_certificate_private_key.pem.password: + L83: file: ./secrets/client_certificate_private_key.pem.password + ``` +1. Modify database passwords + * **/opt/bpe/secrets/db_liquibase.password** + * Generate a random password (min. 32 characters recommended) and replace the content of the file. + * **/opt/bpe/secrets/db_user.password** + * Generate a random password (min. 16 characters recommended) and replace the content of the file. + * **/opt/bpe/secrets/db_user_camunda.password** + * Generate a random password (min. 16 characters recommended) and replace the content of the file. + +1. Modify the docker-compose.yml file and set environment variables to the appropriate values + * **services -> app -> environment:** + * **DEV_DSF_BPE_FHIR_SERVER_BASE_URL**: `https://dsf.todo.organization.com/fhir` + Set your FHIR servers external FQDN, e.g. `foo.bar.de` -> `https://foo.bar.de/fhir` + + * For additional environment variables, see the BPE server [Configuration Parameters](bpe/configuration) page. + +1. Start the DSF BPE Server (without process plugins) + Start using: `docker compose up -d && docker compose logs -f` (Ctrl-C will close log, but not stop container) + +1. Verify DSF BPE Startup + * Check that the BPE was able to download new Task resources from the DSF FHIR server during startup. + * Check that the BPE was able to download a Subscription resource from the DSF FHIR server during startup. + * Check that the BPE was able to connect to the websocket endpoint of the DSF FHIR server during startup. + + If you need to debug the TLS connection to your DSF FHIR server use for example: + `docker run -it --rm alpine/openssl s_client your-fhir-server.fqdn:443` + The command above should print the server certificate of your DSF FHIR server (certificate _A_) and end with a message like `[...]tlsv13 alert certificate required[...]` + + +### Logs +By default, we will log both to the console (collected by docker) and to files in the log directory, so you can use `docker compose logs -f` in `/opt/bpe` and `/opt/fhir` to view informational, warning and error logs. If you encounter any error and the reported information is not detailed enough, you can also check the logs in the `/opt/fhir/log` and `/opt/bpe/log` directories with debugging logs. There, you will also find older log files. If you have any questions and can't resolve them by yourself please always include the latest logs from `/opt/fhir/log` and `/opt/bpe/log` in your support request. + +On a successful BPE start, you should see the following entries in your BPE log: + +``` +INFO Grizzly(1) - INFO Grizzly(1) - ClientEndpoint.onOpen(37) | Websocket open, session SOME_RANDOM_UUID1 +INFO Grizzly(1) - INFO Grizzly(1) - ClientEndpoint.onOpen(37) | Websocket open, session SOME_RANDOM_UUID2 +``` + +### On-Boarding +Please visit the on boarding website of your network for more information. + +::: tip Ideas for improvement? +Have you found an error or is something unclear to you? Then please feel free to write to us at dsf-gecko@hs-heilbronn.de. Thank you very much! +::: + +--- + +## Release Notes +Source: https://dsf.dev/operations/latest/release-notes.html + +## [Release Notes for v2.1.0](https://github.com/datasharingframework/dsf/releases/tag/v2.1.0) + +::: tip Release Notes +You can access all release notes on our [GitHub](https://github.com/datasharingframework/dsf/releases). +::: + +### 2.1.0 - Security and Performance +General remarks: + +- This is a feature update for DSF 2.x with security and performance improvements. +- To Update from an existing 2.x installation, please see the [2.x -> 2.1.0 Upgrade Guide](https://dsf.dev/operations/v2.1.0/upgrade-from-2.html). +- For a fresh deployment, follow the [installation instructions](https://dsf.dev/operations/v2.1.0/install.html). + +Security Advisories: +- Missing Session Timeout for OIDC Sessions: [GHSA-gj7p-595x-qwf5](https://github.com/datasharingframework/dsf/security/advisories/GHSA-gj7p-595x-qwf5) +- Inverted Time Comparison in OIDC JWKS and Token Cache: [GHSA-xmj9-7625-f634](https://github.com/datasharingframework/dsf/security/advisories/GHSA-xmj9-7625-f634) + +Bug Fixes: +- In previous versions starting processes via the FHIR server front-end failed, if `Task` resources used input parameter codes (`Task.input.type`) that were substrings of other input parameter codes ([#442](https://github.com/datasharingframework/dsf/issues/442)). The front-end code was fixed to handle these edge-cases. +- Process instances started with DSF 1.x failed to continue on DSF 2.x ([#438](https://github.com/datasharingframework/dsf/issues/438)). Fallback code was added to correctly read the old DSF 1.x Task process variables. +- A configuration error in the `DsfClient` used by v2 process plugins via the [FHIR client connections API](https://dsf.dev/operations/v2.1.0/bpe/fhir-client-connections.html) resulted in bearer tokens and basic authentication credentials not being send ([#432](https://github.com/datasharingframework/dsf/issues/432)). The feature registration order was fixed to send authentication credentials in the `DsfClient` implementation. + +Feature Summary: +- An identifier constraint rule was added to the `Task` base profile http://dsf.dev/fhir/StructureDefinition/task for resources with status `draft`. The constraint adds a rule to the base profile that was previously only enforced via the [TaskAuthorizationRule](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-server/src/main/java/dev/dsf/fhir/authorization/TaskAuthorizationRule.java#L357). +- The DSF FHIR server front-end was improved to display the `Binary` resource content inline. This feature is enabled for `Binary` resources with content-types: `text/html` and `text/plain`. +- The performance of allow-list and other bundle executions was improved by modifying the database schema and optimizing the FHIR server code base. A new `current` column was added to resource tables together with a number of new database indexes. A "not found" cache was added for metadata resources to reduce unnecessary database calls. +- Other security improvements were implemented and are detailed in the [DSF 2.1.0 hardening measures](https://dsf.dev/operations/v2.1.0/hardening-measures.html) document. +- Starting with this release our docker images are cryptographically signed. Take a look at the [Verify Image Signatures](https://dsf.dev/operations/latest/image-verification.html) document for details. + +Docker images for this release can be accessed via the GitHub Docker registry - ghcr.io: +* **bpe**: [ghcr.io/datasharingframework/bpe:2.1.0](https://github.com/datasharingframework/dsf/pkgs/container/bpe/796016761?tag=2.1.0) + Digest: sha256:3ee7ef0ac201fc3776273fbfc2569bdc4edf724a2bb9f1b4a889eb7e13ff4049 +* **bpe_proxy**: [ghcr.io/datasharingframework/bpe_proxy:2.1.0](https://github.com/datasharingframework/dsf/pkgs/container/bpe_proxy/796013677?tag=2.1.0) + Digest: sha256:c67da4a1720ea75a383764db2bf25619fe70f57773b1069029f5b49588eb1ecc +* **fhir**: [ghcr.io/datasharingframework/fhir:2.1.0](https://github.com/datasharingframework/dsf/pkgs/container/fhir/796016727?tag=2.1.0) + Digest: sha256:71599af143f0262a7265aa2bc4ea5a9660f11de6248a053e060b5667070203fd +* **fhir_proxy**: [ghcr.io/datasharingframework/fhir_proxy:2.1.0](https://github.com/datasharingframework/dsf/pkgs/container/fhir_proxy/796013880?tag=2.1.0) + Digest: sha256:9f11a3580c970314532f5951808be6fe72f1de7d53348e625d2dd0c95bcf1d96 + +Process Plugin API v1 on Maven Central: +```xml + + dev.dsf + dsf-bpe-process-api-v1 + 2.1.0 + +``` +Process Plugin API v2 on Maven Central: +```xml + + dev.dsf + dsf-bpe-process-api-v2 + 2.1.0 + +``` +DSF Maven Plugin on Maven Central: +```xml + + dev.dsf + dsf-maven-plugin + 2.1.0 + +``` + +Issues closed: +- Security Improvements / Defense-in-Depth [#453](https://github.com/datasharingframework/dsf/issues/453) +- Upgrade Dependencies [#448](https://github.com/datasharingframework/dsf/issues/448) +- Improve Allow-List Bundle Execution Performance [#443](https://github.com/datasharingframework/dsf/issues/443) +- Form.js builds invalid Task resource when submitting form [#442](https://github.com/datasharingframework/dsf/issues/442) +- Add Identifier Constraint to Task Profile [#440](https://github.com/datasharingframework/dsf/issues/440) +- Process Instances from DSF 1.x Fail to Continue on DSF 2.x [#438](https://github.com/datasharingframework/dsf/issues/438) +- Start New Development Cycle [#435](https://github.com/datasharingframework/dsf/issues/435) +- Automate Docker Image Builds and Maven Central Deploys [#434](https://github.com/datasharingframework/dsf/issues/434) +- ClientConfig in DsfClientJersey overwrites Authentication Features [#432](https://github.com/datasharingframework/dsf/issues/432) + +This release contains contributions from [@EmteZogaf](https://github.com/EmteZogaf), [@hhund](https://github.com/hhund), [@jaboehri](https://github.com/jaboehri), [@schwzr](https://github.com/schwzr) and [@wetret](https://github.com/wetret). + +--- + +## FHIR Server Configuration +Source: https://dsf.dev/operations/latest/fhir/configuration.html + +### DEV_DSF_FHIR_CLIENT_CERTIFICATE +- **Property:** dev.dsf.fhir.client.certificate +- **Required:** Yes +- **Description:** PEM encoded file with local client certificate for https connections to remote DSF FHIR servers +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/app_client_certificate.pem` + + +### DEV_DSF_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY +- **Property:** dev.dsf.fhir.client.certificate.private.key +- **Required:** Yes +- **Description:** Private key corresponding to the local client certificate as PEM encoded file. Use *DEV_DSF_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD* or *DEV_DSF_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE* if private key is encrypted +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/app_client_certificate_private_key.pem` + + +### DEV_DSF_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD or DEV_DSF_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE +- **Property:** dev.dsf.fhir.client.certificate.private.key.password +- **Required:** No +- **Description:** Password to decrypt the local client certificate encrypted private key +- **Recommendation:** Use docker secret file to configure using *DEV_DSF_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE* +- **Example:** `/run/secrets/app_client_certificate_private_key.pem.password` + + +### DEV_DSF_FHIR_CLIENT_TIMEOUT_CONNECT +- **Property:** dev.dsf.fhir.client.timeout.connect +- **Required:** No +- **Description:** Timeout until a connection is established between this DSF FHIR server and a remote DSF FHIR server +- **Recommendation:** Change default value only if timeout exceptions occur +- **Default:** `PT2S` + + +### DEV_DSF_FHIR_CLIENT_TIMEOUT_READ +- **Property:** dev.dsf.fhir.client.timeout.read +- **Required:** No +- **Description:** Timeout until a reading a resource from a remote DSF FHIR server is aborted +- **Recommendation:** Change default value only if timeout exceptions occur +- **Default:** `PT10S` + + +### DEV_DSF_FHIR_CLIENT_TRUST_SERVER_CERTIFICATE_CAS +- **Property:** dev.dsf.fhir.client.trust.server.certificate.cas +- **Required:** No +- **Description:** Folder with PEM encoded files (*.crt, *.pem) or a single PEM encoded file with one or more trusted root certificates to validate server certificates for https connections to remote DSF FHIR servers +- **Recommendation:** Add file to default folder via bind mount or use docker secret file to configure +- **Example:** `/run/secrets/app_client_trust_certificates.pem` +- **Default:** `ca/server_root_cas` + + +### DEV_DSF_FHIR_CLIENT_VERBOSE +- **Property:** dev.dsf.fhir.client.verbose +- **Required:** No +- **Description:** To enable verbose logging of requests to and replies from remote DSF FHIR servers, set to `true` +- **Default:** `false` + + +### DEV_DSF_FHIR_DB_LIQUIBASE_FORCEUNLOCK +- **Property:** dev.dsf.fhir.db.liquibase.forceUnlock +- **Required:** No +- **Description:** To force liquibase to unlock the migration lock set to `true` +- **Recommendation:** Only use this option temporarily to unlock a stuck DB migration step +- **Default:** `false` + + +### DEV_DSF_FHIR_DB_LIQUIBASE_LOCKWAITTIME +- **Property:** dev.dsf.fhir.db.liquibase.lockWaitTime +- **Required:** No +- **Description:** Liquibase change lock wait time in minutes, default 2 minutes +- **Default:** `2` + + +### DEV_DSF_FHIR_DB_LIQUIBASE_PASSWORD or DEV_DSF_FHIR_DB_LIQUIBASE_PASSWORD_FILE +- **Property:** dev.dsf.fhir.db.liquibase.password +- **Required:** Yes +- **Description:** Password to access the database from the DSF FHIR server to execute database migrations +- **Recommendation:** Use docker secret file to configure by using *DEV_DSF_FHIR_DB_LIQUIBASE_PASSWORD_FILE* +- **Example:** `/run/secrets/db_liquibase.password` + + +### DEV_DSF_FHIR_DB_LIQUIBASE_USERNAME +- **Property:** dev.dsf.fhir.db.liquibase.username +- **Required:** No +- **Description:** Username to access the database from the DSF FHIR server to execute database migrations +- **Default:** `liquibase_user` + + +### DEV_DSF_FHIR_DB_URL +- **Property:** dev.dsf.fhir.db.url +- **Required:** Yes +- **Description:** Address of the database used for the DSF FHIR server +- **Recommendation:** Change only if you don't use the provided docker-compose from the installation guide or made changes to the database settings/networking in the docker-compose +- **Example:** `jdbc:postgresql://db/fhir` + + +### DEV_DSF_FHIR_DB_USER_GROUP +- **Property:** dev.dsf.fhir.db.user.group +- **Required:** No +- **Description:** Name of the user group to access the database from the DSF FHIR server +- **Default:** `fhir_users` + + +### DEV_DSF_FHIR_DB_USER_PASSWORD or DEV_DSF_FHIR_DB_USER_PASSWORD_FILE +- **Property:** dev.dsf.fhir.db.user.password +- **Required:** Yes +- **Description:** Password to access the database from the DSF FHIR server +- **Recommendation:** Use docker secret file to configure using *DEV_DSF_FHIR_DB_USER_PASSWORD_FILE* +- **Example:** `/run/secrets/db_user.password` + + +### DEV_DSF_FHIR_DB_USER_PERMANENT_DELETE_GROUP +- **Property:** dev.dsf.fhir.db.user.permanent.delete.group +- **Required:** No +- **Description:** Name of the user group to access the database from the DSF FHIR server for permanent deletes +- **Default:** `fhir_permanent_delete_users` + + +### DEV_DSF_FHIR_DB_USER_PERMANENT_DELETE_PASSWORD or DEV_DSF_FHIR_DB_USER_PERMANENT_DELETE_PASSWORD_FILE +- **Property:** dev.dsf.fhir.db.user.permanent.delete.password +- **Required:** Yes +- **Description:** Password to access the database from the DSF FHIR server for permanent deletes +- **Recommendation:** Use docker secret file to configure using *DEV_DSF_FHIR_DB_USER_PERMANENT_DELETE_PASSWORD_FILE* +- **Example:** `/run/secrets/db_user_permanent_delete.password` + + +### DEV_DSF_FHIR_DB_USER_PERMANENT_DELETE_USERNAME +- **Property:** dev.dsf.fhir.db.user.permanent.delete.username +- **Required:** No +- **Description:** Username to access the database from the DSF FHIR server for permanent deletes +- **Recommendation:** Use a different user then *DEV_DSF_FHIR_DB_USER_USERNAME* +- **Default:** `fhir_server_permanent_delete_user` + + +### DEV_DSF_FHIR_DB_USER_USERNAME +- **Property:** dev.dsf.fhir.db.user.username +- **Required:** No +- **Description:** Username to access the database from the DSF FHIR server +- **Default:** `fhir_server_user` + + +### DEV_DSF_FHIR_DEBUG_LOG_MESSAGE_CURRENTUSER +- **Property:** dev.dsf.fhir.debug.log.message.currentUser +- **Required:** No +- **Description:** To enable logging of the currently requesting user set to `true` +- **Recommendation:** This debug function should only be activated during development; WARNING: Confidential information may be leaked via the debug log! +- **Default:** `false` + + +### DEV_DSF_FHIR_DEBUG_LOG_MESSAGE_DBSTATEMENT +- **Property:** dev.dsf.fhir.debug.log.message.dbStatement +- **Required:** No +- **Description:** To enable logging of DB queries set to `true` +- **Recommendation:** This debug function should only be activated during development; WARNING: Confidential information may be leaked via the debug log! +- **Default:** `false` + + +### DEV_DSF_FHIR_DEBUG_LOG_MESSAGE_WEBSERVICEREQUEST +- **Property:** dev.dsf.fhir.debug.log.message.webserviceRequest +- **Required:** No +- **Description:** To enable logging of webservices requests set to `true` +- **Recommendation:** This debug function should only be activated during development; WARNING: Confidential information may be leaked via the debug log! +- **Default:** `false` + + +### DEV_DSF_FHIR_SERVER_BASE_URL +- **Property:** dev.dsf.fhir.server.base.url +- **Required:** Yes +- **Description:** Base address of this DSF FHIR server to read/store fhir resources +- **Example:** `https://foo.bar/fhir` + + +### DEV_DSF_FHIR_SERVER_INIT_BUNDLE +- **Property:** dev.dsf.fhir.server.init.bundle +- **Required:** No +- **Description:** Fhir bundle containing the initial Allow-List, loaded on startup of the DSF FHIR server +- **Recommendation:** Change only if you don't use the provided files from the installation guide, have local changes in the Allow-List or received an Allow-List from another source +- **Default:** `conf/bundle.xml` + + +### DEV_DSF_FHIR_SERVER_ORGANIZATION_IDENTIFIER_VALUE +- **Property:** dev.dsf.fhir.server.organization.identifier.value +- **Required:** Yes +- **Description:** Local identifier value used in the Allow-List +- **Recommendation:** By convention: The shortest possible FQDN that resolve the homepage of the organization +- **Example:** `hospital.com` + + +### DEV_DSF_FHIR_SERVER_ORGANIZATION_THUMBPRINT +- **Property:** dev.dsf.fhir.server.organization.thumbprint +- **Required:** No +- **Description:** The SHA-512 thumbprint of the local organization client certificate; will be calculated on startup based on the client certificate specified via *DEV_DSF_FHIR_CLIENT_CERTIFICATE* +- **Recommendation:** Do not specify this variable when using the same client certificate for the FHIR and BPE server; the thumbprint can be calculated via `certtool --fingerprint --hash=sha512 --infile=client_certificate.pem` + + +### DEV_DSF_FHIR_SERVER_PAGE_COUNT +- **Property:** dev.dsf.fhir.server.page.count +- **Required:** No +- **Description:** Page size returned by the DSF FHIR server when reading/searching fhir resources +- **Default:** `20` + + +### DEV_DSF_FHIR_SERVER_ROLECONFIG +- **Property:** dev.dsf.fhir.server.roleConfig +- **Required:** No +- **Description:** Role config YAML as defined in [FHIR Server: Access Control](access-control) + + +### DEV_DSF_FHIR_SERVER_STATIC_RESOURCE_CACHE +- **Property:** dev.dsf.fhir.server.static.resource.cache +- **Required:** No +- **Description:** To disable static resource caching, set to `false` +- **Recommendation:** Only set to `false` for development +- **Default:** `true` + + +### DEV_DSF_FHIR_SERVER_UI_THEME +- **Property:** dev.dsf.fhir.server.ui.theme +- **Required:** No +- **Description:** UI theme parameter, adds a color indicator to the ui to distinguish `dev`, `test` and `prod` environments if configured; supported values: `dev`, `test` and `prod` + + +### DEV_DSF_LOG_AUDIT_CONSOLE_ERR_ENABLED +- **Property:** dev.dsf.log.audit.console.err.enabled +- **Required:** No +- **Description:** Set to `true` to enable console err output of the audit logger +- **Default:** `false` + + +### DEV_DSF_LOG_AUDIT_CONSOLE_ERR_STYLE +- **Property:** dev.dsf.log.audit.console.err.style +- **Required:** No +- **Description:** Audit logger console err style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT` +- **Default:** `STYLE_TEXT` + + +### DEV_DSF_LOG_AUDIT_CONSOLE_OUT_ENABLED +- **Property:** dev.dsf.log.audit.console.out.enabled +- **Required:** No +- **Description:** Set to `true` to enable console out output of the audit logger +- **Default:** `false` + + +### DEV_DSF_LOG_AUDIT_CONSOLE_OUT_STYLE +- **Property:** dev.dsf.log.audit.console.out.style +- **Required:** No +- **Description:** Audit logger console out style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT` +- **Default:** `STYLE_TEXT` + + +### DEV_DSF_LOG_AUDIT_FILE_ENABLED +- **Property:** dev.dsf.log.audit.file.enabled +- **Required:** No +- **Description:** Set to `false` to disable log file output of the audit logger +- **Default:** `true` + + +### DEV_DSF_LOG_AUDIT_FILE_STYLE +- **Property:** dev.dsf.log.audit.file.style +- **Required:** No +- **Description:** Audit logger file style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT` +- **Default:** `TEXT_MDC` + + +### DEV_DSF_LOG_CONFIG +- **Property:** dev.dsf.log.config +- **Required:** No +- **Description:** Location of a log4j configuration xml file; if file is readable, overrides configuration specified via *DEV_DSF_LOG_...* parameters +- **Default:** `conf/log4j2.xml` + + +### DEV_DSF_LOG_CONSOLE_ERR_ENABLED +- **Property:** dev.dsf.log.console.err.enabled +- **Required:** No +- **Description:** Set to `true` to enable console err output of the standard logger +- **Default:** `false` + + +### DEV_DSF_LOG_CONSOLE_ERR_LEVEL +- **Property:** dev.dsf.log.console.err.level +- **Required:** No +- **Description:** Standard logger console err output level, one of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR` +- **Default:** `INFO` + + +### DEV_DSF_LOG_CONSOLE_ERR_STYLE +- **Property:** dev.dsf.log.console.err.style +- **Required:** No +- **Description:** Standard logger console err output style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`, `TEXT_COLOR_MDC`, `TEXT_COLOR` +- **Default:** `TEXT_COLOR` + + +### DEV_DSF_LOG_CONSOLE_OUT_ENABLED +- **Property:** dev.dsf.log.console.out.enabled +- **Required:** No +- **Description:** Set to `false` to disable console out output of the standard logger +- **Default:** `true` + + +### DEV_DSF_LOG_CONSOLE_OUT_LEVEL +- **Property:** dev.dsf.log.console.out.level +- **Required:** No +- **Description:** Standard logger console out output level, one of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR` +- **Default:** `INFO` + + +### DEV_DSF_LOG_CONSOLE_OUT_STYLE +- **Property:** dev.dsf.log.console.out.style +- **Required:** No +- **Description:** Standard logger console out output style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`, `TEXT_COLOR_MDC`, `TEXT_COLOR` +- **Default:** `TEXT_COLOR` + + +### DEV_DSF_LOG_FILE_ENABLED +- **Property:** dev.dsf.log.file.enabled +- **Required:** No +- **Description:** Set to `false` to disable log file output of the standard logger +- **Default:** `true` + + +### DEV_DSF_LOG_FILE_LEVEL +- **Property:** dev.dsf.log.file.level +- **Required:** No +- **Description:** Standard logger log file output level, one of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR` +- **Default:** `DEBUG` + + +### DEV_DSF_LOG_FILE_STYLE +- **Property:** dev.dsf.log.file.style +- **Required:** No +- **Description:** Standard logger log file output style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT` +- **Default:** `TEXT_MDC` + + +### DEV_DSF_LOG_MIN_LEVEL_LOGGERS +- **Property:** dev.dsf.log.min.level.loggers +- **Required:** No +- **Description:** List of logger names that are enabled to produce log output with the minimal configured log level from `DEV_DSF_LOG_CONSOLE_OUT_LEVEL`, `DEV_DSF_LOG_CONSOLE_ERR_LEVEL` and `DEV_DSF_LOG_FILE_LEVEL` +- **Default:** `dev.dsf` + + +### DEV_DSF_PROXY_NOPROXY +- **Property:** dev.dsf.proxy.noProxy +- **Required:** No +- **Description:** Forward proxy no-proxy list, entries will match exactly or against (one level) sub-domains, if no port is specified - all ports are matched; comma or space separated list, YAML block scalars supported +- **Example:** `foo.bar, test.com:8080` + + +### DEV_DSF_PROXY_PASSWORD or DEV_DSF_PROXY_PASSWORD_FILE +- **Property:** dev.dsf.proxy.password +- **Required:** No +- **Description:** Forward Proxy password +- **Recommendation:** Configure password if proxy requires authentication, use docker secret file to configure using *DEV_DSF_PROXY_PASSWORD_FILE* + + +### DEV_DSF_PROXY_URL +- **Property:** dev.dsf.proxy.url +- **Required:** No +- **Description:** Forward (http/https) proxy url, use *DEV_DSF_BPE_PROXY_NOPROXY* to list domains that do not require a forward proxy +- **Example:** `http://proxy.foo:8080` + + +### DEV_DSF_PROXY_USERNAME +- **Property:** dev.dsf.proxy.username +- **Required:** No +- **Description:** Forward proxy username +- **Recommendation:** Configure username if proxy requires authentication + + +### DEV_DSF_SERVER_API_HOST +- **Property:** dev.dsf.server.api.host +- **Required:** No +- **Description:** API connector host, default in docker image: `0.0.0.0` +- **Default:** `127.0.0.1` + + +### DEV_DSF_SERVER_API_PORT +- **Property:** dev.dsf.server.api.port +- **Required:** No +- **Description:** API connector port, default in docker image: `8080` + + +### DEV_DSF_SERVER_AUTH_CLIENT_CERTIFICATE_HEADER +- **Property:** dev.dsf.server.auth.client.certificate.header +- **Required:** No +- **Description:** Name of HTTP header with client certificate from reverse proxy +- **Default:** `X-ClientCert` + + +### DEV_DSF_SERVER_AUTH_OIDC_AUTHORIZATION_CODE_FLOW +- **Property:** dev.dsf.server.auth.oidc.authorization.code.flow +- **Required:** No +- **Description:** Set to `true` to enable OIDC authorization code flow +- **Recommendation:** Requires *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL*, *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID* and *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET* or *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET_FILE* to be specified +- **Default:** `false` + + +### DEV_DSF_SERVER_AUTH_OIDC_BACK_CHANNEL_LOGOUT +- **Property:** dev.dsf.server.auth.oidc.back.channel.logout +- **Required:** No +- **Description:** Set to `true` to enable OIDC back-channel logout +- **Recommendation:** Requires *DEV_DSF_SERVER_AUTH_OIDC_AUTHORIZATION_CODE_FLOW* to be set to `true` (enabled), *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID* and *DEV_DSF_SERVER_AUTH_OIDC_BACK_CHANNEL_LOGOUT_PATH* to be specified +- **Default:** `false` + + +### DEV_DSF_SERVER_AUTH_OIDC_BACK_CHANNEL_LOGOUT_PATH +- **Property:** dev.dsf.server.auth.oidc.back.channel.logout.path +- **Required:** No +- **Description:** Path called by the OIDC provide to request back-channel logout +- **Default:** `/back-channel-logout` + + +### DEV_DSF_SERVER_AUTH_OIDC_BEARER_TOKEN +- **Property:** dev.dsf.server.auth.oidc.bearer.token +- **Required:** No +- **Description:** Set to `true` to enable OIDC bearer token authentication +- **Recommendation:** Requires *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL* to be specified +- **Default:** `false` + + +### DEV_DSF_SERVER_AUTH_OIDC_BEARER_TOKEN_AUDIENCE +- **Property:** dev.dsf.server.auth.oidc.bearer.token.audience +- **Required:** No +- **Description:** Audience (aud) value to verify before accepting OIDC bearer tokens, uses value from `DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID` by default, set blank string e.g. `''` to disable +- **Recommendation:** Requires *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL* to be specified and *DEV_DSF_SERVER_AUTH_OIDC_BEARER_TOKEN* set tor `true` + + +### DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID +- **Property:** dev.dsf.server.auth.oidc.client.id +- **Required:** No +- **Description:** OIDC provider client_id, must be specified if *DEV_DSF_SERVER_AUTH_OIDC_AUTHORIZATION_CODE_FLOW* is enabled + + +### DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET or DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET_FILE +- **Property:** dev.dsf.server.auth.oidc.client.secret +- **Required:** No +- **Description:** OIDC provider client_secret, must be specified if *DEV_DSF_SERVER_AUTH_OIDC_AUTHORIZATION_CODE_FLOW* is enabled + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CACHE_TIMEOUT_CONFIGURATION_RESOURCE +- **Property:** dev.dsf.server.auth.oidc.provider.client.cache.timeout.configuration.resource +- **Required:** No +- **Description:** OIDC provider client cache timeout of the 'openid-configuration' discovery resource +- **Default:** `PT1H` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CACHE_TIMEOUT_JWKS_RESOURCE +- **Property:** dev.dsf.server.auth.oidc.provider.client.cache.timeout.jwks.resource +- **Required:** No +- **Description:** OIDC provider client cache timeout of the jwks resource +- **Default:** `PT1H` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE +- **Property:** dev.dsf.server.auth.oidc.provider.client.certificate +- **Required:** No +- **Description:** PEM encoded file with client certificate for https connections to the OIDC provider +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/oidc_provider_client_certificate.pem` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE_PRIVATE_KEY +- **Property:** dev.dsf.server.auth.oidc.provider.client.certificate.private.key +- **Required:** No +- **Description:** Private key corresponding to the client certificate for the OIDC provider as PEM encoded file. Use *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD* or *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE* if private key is encrypted +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/oidc_provider_client_certificate_private_key.pem` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD or DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE +- **Property:** dev.dsf.server.auth.oidc.provider.client.certificate.private.key.password +- **Required:** No +- **Description:** Password to decrypt the client certificate for the OIDC provider encrypted private key +- **Recommendation:** Use docker secret file to configure using *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE* +- **Example:** `/run/secrets/oidc_provider_client_certificate_private_key.pem.password` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TIMEOUT_CONNECT +- **Property:** dev.dsf.server.auth.oidc.provider.client.timeout.connect +- **Required:** No +- **Description:** OIDC provider client connect timeout +- **Default:** `PT5S` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TIMEOUT_READ +- **Property:** dev.dsf.server.auth.oidc.provider.client.timeout.read +- **Required:** No +- **Description:** OIDC provider client read timeout +- **Default:** `PT30S` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TRUST_SERVER_CERTIFICATE_CAS +- **Property:** dev.dsf.server.auth.oidc.provider.client.trust.server.certificate.cas +- **Required:** No +- **Description:** Folder with PEM encoded files (*.crt, *.pem) or a single PEM encoded file with one or more trusted root certificates to validate server certificates for https connections to the OIDC provider +- **Recommendation:** Add file to default folder via bind mount or use docker secret file to configure +- **Example:** `/run/secrets/oidc_provider_trust_certificates.pem` +- **Default:** `ca/server_root_cas` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_DISCOVERY_PATH +- **Property:** dev.dsf.server.auth.oidc.provider.discovery.path +- **Required:** No +- **Description:** OIDC provider discovery path +- **Default:** `/.well-known/openid-configuration` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL +- **Property:** dev.dsf.server.auth.oidc.provider.realm.base.url +- **Required:** No +- **Description:** OIDC provider realm base url +- **Example:** `https://keycloak.test.com:8443/realms/example-realm-name` + + +### DEV_DSF_SERVER_AUTH_OIDC_SESSION_TIMEOUT +- **Property:** dev.dsf.server.auth.oidc.session.timeout +- **Required:** No +- **Description:** Maximum inactivity period after which the server session for OIDC logins is invalidated; the access token may expire earlier, resulting in earlier session invalidation +- **Default:** `PT30M` + + +### DEV_DSF_SERVER_AUTH_TRUST_CLIENT_CERTIFICATE_CAS +- **Property:** dev.dsf.server.auth.trust.client.certificate.cas +- **Required:** No +- **Description:** Folder with PEM encoded files (*.crt, *.pem) or a single PEM encoded file with one or more trusted full CA chains to validate client certificates for https connections from local and remote clients +- **Recommendation:** Add file to default folder via bind mount or use docker secret file to configure +- **Example:** `/run/secrets/app_client_trust_certificates.pem` +- **Default:** `ca/client_ca_chains` + + +### DEV_DSF_SERVER_CERTIFICATE +- **Property:** dev.dsf.server.certificate +- **Required:** No +- **Description:** Server certificate file for testing +- **Recommendation:** Only specify For testing when terminating TLS in jetty server + + +### DEV_DSF_SERVER_CERTIFICATE_CHAIN +- **Property:** dev.dsf.server.certificate.chain +- **Required:** No +- **Description:** Server certificate chain file for testing +- **Recommendation:** Only specify For testing when terminating TLS in jetty server + + +### DEV_DSF_SERVER_CERTIFICATE_KEY +- **Property:** dev.dsf.server.certificate.key +- **Required:** No +- **Description:** Server certificate private key file for testing +- **Recommendation:** Only specify For testing when terminating TLS in jetty server + + +### DEV_DSF_SERVER_CERTIFICATE_KEY_PASSWORD or DEV_DSF_SERVER_CERTIFICATE_KEY_PASSWORD_FILE +- **Property:** dev.dsf.server.certificate.key.password +- **Required:** No +- **Description:** Server certificate private key file password for testing +- **Recommendation:** Only specify For testing when terminating TLS in jetty server + + +### DEV_DSF_SERVER_CONTEXT_PATH +- **Property:** dev.dsf.server.context.path +- **Required:** No +- **Description:** Web application context path, default in `bpe` docker image: `/bpe`, default in `fhir` docker image: `/fhir` +- **Recommendation:** Only modify for testing + + +### DEV_DSF_SERVER_STATUS_HOST +- **Property:** dev.dsf.server.status.host +- **Required:** No +- **Description:** Status connector host +- **Default:** `127.0.0.1` + + +### DEV_DSF_SERVER_STATUS_PORT +- **Property:** dev.dsf.server.status.port +- **Required:** No +- **Description:** Status connector port, default in docker image: `10000` + +--- + +## BPE Configuration +Source: https://dsf.dev/operations/latest/bpe/configuration.html + +### DEV_DSF_BPE_DB_LIQUIBASE_FORCEUNLOCK +- **Property:** dev.dsf.bpe.db.liquibase.forceUnlock +- **Required:** No +- **Description:** To force liquibase to unlock the migration lock set to `true` +- **Recommendation:** Only use this option temporarily to unlock a stuck DB migration step +- **Default:** `false` + + +### DEV_DSF_BPE_DB_LIQUIBASE_LOCKWAITTIME +- **Property:** dev.dsf.bpe.db.liquibase.lockWaitTime +- **Required:** No +- **Description:** Liquibase change lock wait time in minutes, default 2 minutes +- **Default:** `2` + + +### DEV_DSF_BPE_DB_LIQUIBASE_PASSWORD or DEV_DSF_BPE_DB_LIQUIBASE_PASSWORD_FILE +- **Property:** dev.dsf.bpe.db.liquibase.password +- **Required:** Yes +- **Description:** Password to access the database from the DSF BPE server to execute database migrations +- **Recommendation:** Use docker secret file to configure by using *DEV_DSF_BPE_DB_LIQUIBASE_PASSWORD_FILE* +- **Example:** `/run/secrets/db_liquibase.password` + + +### DEV_DSF_BPE_DB_LIQUIBASE_USERNAME +- **Property:** dev.dsf.bpe.db.liquibase.username +- **Required:** No +- **Description:** Username to access the database from the DSF BPE server to execute database migrations +- **Default:** `liquibase_user` + + +### DEV_DSF_BPE_DB_URL +- **Property:** dev.dsf.bpe.db.url +- **Required:** Yes +- **Description:** Address of the database used for the DSF BPE server +- **Recommendation:** Change only if you don't use the provided docker-compose from the installation guide or made changes to the database settings/networking in the docker-compose +- **Example:** `jdbc:postgresql://db/bpe` + + +### DEV_DSF_BPE_DB_USER_ENGINE_GROUP +- **Property:** dev.dsf.bpe.db.user.engine.group +- **Required:** No +- **Description:** Name of the user group to access the database from the DSF BPE server workflow engine +- **Default:** `bpe_engine_users` + + +### DEV_DSF_BPE_DB_USER_ENGINE_PASSWORD or DEV_DSF_BPE_DB_USER_ENGINE_PASSWORD_FILE +- **Property:** dev.dsf.bpe.db.user.engine.password +- **Required:** Yes +- **Description:** Password to access the database from the DSF BPE server workflow engine +- **Recommendation:** Use docker secret file to configure using *DEV_DSF_BPE_DB_USER_ENGINE_PASSWORD_FILE* +- **Example:** `/run/secrets/db_user_engine.password` + + +### DEV_DSF_BPE_DB_USER_ENGINE_USERNAME +- **Property:** dev.dsf.bpe.db.user.engine.username +- **Required:** No +- **Description:** Username to access the database from the DSF BPE server workflow engine +- **Recommendation:** Use a different user then in *DEV_DSF_BPE_DB_USER_USERNAME* +- **Default:** `bpe_server_engine_user` + + +### DEV_DSF_BPE_DB_USER_GROUP +- **Property:** dev.dsf.bpe.db.user.group +- **Required:** No +- **Description:** Name of the user group to access the database from the DSF BPE server +- **Default:** `bpe_users` + + +### DEV_DSF_BPE_DB_USER_PASSWORD or DEV_DSF_BPE_DB_USER_PASSWORD_FILE +- **Property:** dev.dsf.bpe.db.user.password +- **Required:** Yes +- **Description:** Password to access the database from the DSF BPE server +- **Recommendation:** Use docker secret file to configure using *DEV_DSF_BPE_DB_USER_PASSWORD_FILE* +- **Example:** `/run/secrets/db_user.password` + + +### DEV_DSF_BPE_DB_USER_USERNAME +- **Property:** dev.dsf.bpe.db.user.username +- **Required:** No +- **Description:** Username to access the database from the DSF BPE server +- **Default:** `bpe_server_user` + + +### DEV_DSF_BPE_DEBUG_LOG_MESSAGE_CURRENTUSER +- **Property:** dev.dsf.bpe.debug.log.message.currentUser +- **Required:** No +- **Description:** To enable logging of the currently requesting user set to `true` +- **Recommendation:** This debug function should only be activated during development; WARNING: Confidential information may be leaked via the debug log! +- **Default:** `false` + + +### DEV_DSF_BPE_DEBUG_LOG_MESSAGE_DBSTATEMENT +- **Property:** dev.dsf.bpe.debug.log.message.dbStatement +- **Required:** No +- **Description:** To enable logging of DB queries set to `true` +- **Recommendation:** This debug function should only be activated during development; WARNING: Confidential information may be leaked via the debug log! +- **Default:** `false` + + +### DEV_DSF_BPE_DEBUG_LOG_MESSAGE_ONACTIVITYEND +- **Property:** dev.dsf.bpe.debug.log.message.onActivityEnd +- **Required:** No +- **Description:** To enable debug log messages for every bpmn activity end, set to `true` +- **Recommendation:** This debug function should only be activated during process plugin development +- **Default:** `false` + + +### DEV_DSF_BPE_DEBUG_LOG_MESSAGE_ONACTIVITYSTART +- **Property:** dev.dsf.bpe.debug.log.message.onActivityStart +- **Required:** No +- **Description:** To enable debug log messages for every bpmn activity start, set to `true` +- **Recommendation:** This debug function should only be activated during process plugin development +- **Default:** `false` + + +### DEV_DSF_BPE_DEBUG_LOG_MESSAGE_VARIABLES +- **Property:** dev.dsf.bpe.debug.log.message.variables +- **Required:** No +- **Description:** To enable logging of bpmn variables for every bpmn activity start or end, when logging of these events is enabled, set to `true` +- **Recommendation:** This debug function should only be activated during process plugin development; WARNING: Confidential information may be leaked via the debug log! +- **Default:** `false` + + +### DEV_DSF_BPE_DEBUG_LOG_MESSAGE_VARIABLESLOCAL +- **Property:** dev.dsf.bpe.debug.log.message.variablesLocal +- **Required:** No +- **Description:** To enable logging of local bpmn variables for every bpmn activity start or end, when logging of these events is enabled, set to `true` +- **Recommendation:** This debug function should only be activated during process plugin development; WARNING: Confidential information may be leaked via the debug log! +- **Default:** `false` + + +### DEV_DSF_BPE_DEBUG_LOG_MESSAGE_WEBSERVICEREQUEST +- **Property:** dev.dsf.bpe.debug.log.message.webserviceRequest +- **Required:** No +- **Description:** To enable logging of webservices requests set to `true` +- **Recommendation:** This debug function should only be activated during development; WARNING: Confidential information may be leaked via the debug log! +- **Default:** `false` + + +### DEV_DSF_BPE_FHIR_CLIENT_CERTIFICATE +- **Property:** dev.dsf.bpe.fhir.client.certificate +- **Required:** Yes +- **Description:** PEM encoded file with local client certificate for https connections to local and remote DSF FHIR servers +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/app_client_certificate.pem` + + +### DEV_DSF_BPE_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY +- **Property:** dev.dsf.bpe.fhir.client.certificate.private.key +- **Required:** Yes +- **Description:** Private key corresponding to the local client certificate as PEM encoded file. Use DEV_DSF_BPE_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD* or *DEV_DSF_BPE_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE* if private key is encrypted +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/app_client_certificate_private_key.pem` + + +### DEV_DSF_BPE_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD or DEV_DSF_BPE_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE +- **Property:** dev.dsf.bpe.fhir.client.certificate.private.key.password +- **Required:** No +- **Description:** Password to decrypt the local client certificate encrypted private key +- **Recommendation:** Use docker secret file to configure using *DEV_DSF_BPE_FHIR_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE* +- **Example:** `/run/secrets/app_client_certificate_private_key.pem.password` + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG +- **Property:** dev.dsf.bpe.fhir.client.connections.config +- **Required:** No +- **Description:** FHIR server connections YAML config for v2 process plugins + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_DEFAULT_ENABLE_DEBUG_LOGGING +- **Property:** dev.dsf.bpe.fhir.client.connections.config.default.enable.debug.logging +- **Required:** No +- **Description:** FHIR server connections YAML: Default value for properties `enable-debug-logging` and `oidc-auth.enable-debug-logging` +- **Recommendation:** To enable debug logging of requests and responses to configured FHIR servers by default set to `true` +- **Default:** `false` + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_DEFAULT_OIDC_DISCOVERY_PATH +- **Property:** dev.dsf.bpe.fhir.client.connections.config.default.oidc.discovery.path +- **Required:** No +- **Description:** FHIR server connections YAML: Default value for property `oidc-auth.discovery-path` +- **Default:** `/.well-known/openid-configuration` + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_DEFAULT_OIDC_VERIFY_AUTHORIZED_PARTY +- **Property:** dev.dsf.bpe.fhir.client.connections.config.default.oidc.verify.authorized.party +- **Required:** No +- **Description:** FHIR server connections YAML: Default value for property `oidc-auth.verify-authorized-party` +- **Recommendation:** To disable verification of the authorized party (aud) claim by default set to `false` +- **Default:** `true` + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_DEFAULT_TEST_CONNECTION_ON_STARTUP +- **Property:** dev.dsf.bpe.fhir.client.connections.config.default.test.connection.on.startup +- **Required:** No +- **Description:** FHIR server connections YAML: Default value for properties `test-connection-on-startup` and `oidc-auth.test-connection-on-startup` +- **Recommendation:** To perform connection tests on BPE startup to configured FHIR servers by default set to `true` +- **Default:** `false` + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_DEFAULT_TIMEOUT_CONNECT +- **Property:** dev.dsf.bpe.fhir.client.connections.config.default.timeout.connect +- **Required:** No +- **Description:** FHIR server connections YAML: Default value for properties `connect-timeout` and `oidc-auth.connect-timeout` +- **Default:** `PT2S` + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_DEFAULT_TIMEOUT_READ +- **Property:** dev.dsf.bpe.fhir.client.connections.config.default.timeout.read +- **Required:** No +- **Description:** FHIR server connections YAML: Default value for properties `read-timeout` and `oidc-auth.read-timeout` +- **Default:** `PT10M` + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_DEFAULT_TRUST_SERVER_CERTIFICATE_CAS +- **Property:** dev.dsf.bpe.fhir.client.connections.config.default.trust.server.certificate.cas +- **Required:** No +- **Description:** FHIR server connections YAML: Default value for properties `trusted-root-certificates-file` and `oidc-auth.trusted-root-certificates-file`. Folder with PEM encoded files (*.crt, *.pem) or a single PEM encoded file with one or more trusted root certificates. +- **Recommendation:** Add file to default folder via bind mount or use docker secret file to configure +- **Example:** `/run/secrets/app_client_trust_certificates.pem` +- **Default:** `ca/server_root_cas` + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_OIDC_CACHE +- **Property:** dev.dsf.bpe.fhir.client.connections.config.oidc.cache +- **Required:** No +- **Description:** Set `false` to disable caching of OIDC discovery and jwks resources as well as access tokens in the 'Client Credentials Grant' client; access tokens are evicted 10 seconds before they expire +- **Default:** `true` + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_OIDC_CACHE_TIMEOUT_ACCESS_TOKEN +- **Property:** dev.dsf.bpe.fhir.client.connections.config.oidc.cache.timeout.access.token +- **Required:** No +- **Description:** OIDC 'Client Credentials Grant' client cache timeout of access tokens before they expire, duration is subtracted from the expires at value of the access token +- **Default:** `PT10S` + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_OIDC_CACHE_TIMEOUT_CONFIGURATION_RESOURCE +- **Property:** dev.dsf.bpe.fhir.client.connections.config.oidc.cache.timeout.configuration.resource +- **Required:** No +- **Description:** OIDC 'Client Credentials Grant' client cache timeout of the 'openid-configuration' discovery resource +- **Default:** `PT1H` + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_OIDC_CACHE_TIMEOUT_JWKS_RESOURCE +- **Property:** dev.dsf.bpe.fhir.client.connections.config.oidc.cache.timeout.jwks.resource +- **Required:** No +- **Description:** OIDC 'Client Credentials Grant' client cache timeout of the jwks resource +- **Default:** `PT1H` + + +### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_OIDC_TIME_VALIDATION_LEEWAY +- **Property:** dev.dsf.bpe.fhir.client.connections.config.oidc.time.validation.leeway +- **Required:** No +- **Description:** OIDC 'Client Credentials Grant' client access token time validation leeway for 'Not Before', 'Issued At' and 'Expires At' values +- **Default:** `PT10S` + + +### DEV_DSF_BPE_FHIR_CLIENT_LOCAL_TIMEOUT_CONNECT +- **Property:** dev.dsf.bpe.fhir.client.local.timeout.connect +- **Required:** No +- **Description:** Timeout until a connection is established with the local DSF FHIR server +- **Recommendation:** Change default value only if timeout exceptions occur +- **Default:** `PT2S` + + +### DEV_DSF_BPE_FHIR_CLIENT_LOCAL_TIMEOUT_READ +- **Property:** dev.dsf.bpe.fhir.client.local.timeout.read +- **Required:** No +- **Description:** Timeout until reading a resource from the local DSF FHIR server is aborted +- **Recommendation:** Change default value only if timeout exceptions occur +- **Default:** `PT60S` + + +### DEV_DSF_BPE_FHIR_CLIENT_LOCAL_VERBOSE +- **Property:** dev.dsf.bpe.fhir.client.local.verbose +- **Required:** No +- **Description:** To enable verbose logging of requests to and replies from the local DSF FHIR server, set to `true` +- **Default:** `false` + + +### DEV_DSF_BPE_FHIR_CLIENT_REMOTE_TIMEOUT_CONNECT +- **Property:** dev.dsf.bpe.fhir.client.remote.timeout.connect +- **Required:** No +- **Description:** Timeout until a connection is established with a remote DSF FHIR server +- **Recommendation:** Change default value only if timeout exceptions occur +- **Default:** `PT5S` + + +### DEV_DSF_BPE_FHIR_CLIENT_REMOTE_TIMEOUT_READ +- **Property:** dev.dsf.bpe.fhir.client.remote.timeout.read +- **Required:** No +- **Description:** Timeout until a reading a resource from a remote DSF FHIR server is aborted +- **Recommendation:** Change default value only if timeout exceptions occur +- **Default:** `PT60S` + + +### DEV_DSF_BPE_FHIR_CLIENT_REMOTE_VERBOSE +- **Property:** dev.dsf.bpe.fhir.client.remote.verbose +- **Required:** No +- **Description:** To enable verbose logging of requests to and replies from remote DSF FHIR servers, set to `true` +- **Default:** `false` + + +### DEV_DSF_BPE_FHIR_CLIENT_TRUST_SERVER_CERTIFICATE_CAS +- **Property:** dev.dsf.bpe.fhir.client.trust.server.certificate.cas +- **Required:** No +- **Description:** Folder with PEM encoded files (*.crt, *.pem) or a single PEM encoded file with one or more trusted root certificates to validate server certificates for https connections to local and remote DSF FHIR servers +- **Recommendation:** Add file to default folder via bind mount or use docker secret file to configure +- **Example:** `/run/secrets/app_client_trust_certificates.pem` +- **Default:** `ca/server_root_cas` + + +### DEV_DSF_BPE_FHIR_QUESTIONNAIRE_RESPONSE_SUBSCRIPTION_SEARCH_PARAMETER +- **Property:** dev.dsf.bpe.fhir.questionnaire.response.subscription.search.parameter +- **Required:** No +- **Description:** Subscription to receive notifications about questionnaire response resources from the DSF FHIR server +- **Default:** `?criteria:exact=QuestionnaireResponse%3Fstatus%3Dcompleted&status=active&type=websocket&payload=application/fhir%2Bjson` + + +### DEV_DSF_BPE_FHIR_SERVER_BASE_URL +- **Property:** dev.dsf.bpe.fhir.server.base.url +- **Required:** Yes +- **Description:** Base address of the local DSF FHIR server to read/store fhir resources +- **Example:** `https://foo.bar/fhir` + + +### DEV_DSF_BPE_FHIR_TASK_SUBSCRIPTION_RETRY_MAX +- **Property:** dev.dsf.bpe.fhir.task.subscription.retry.max +- **Required:** No +- **Description:** Number of retries until a websocket connection can be established with the DSF FHIR server, `-1` means infinite number of retries +- **Default:** `-1` + + +### DEV_DSF_BPE_FHIR_TASK_SUBSCRIPTION_RETRY_SLEEP +- **Property:** dev.dsf.bpe.fhir.task.subscription.retry.sleep +- **Required:** No +- **Description:** Time between two retries to establish a websocket connection with the DSF FHIR server +- **Default:** `PT5S` + + +### DEV_DSF_BPE_FHIR_TASK_SUBSCRIPTION_SEARCH_PARAMETER +- **Property:** dev.dsf.bpe.fhir.task.subscription.search.parameter +- **Required:** No +- **Description:** Subscription to receive notifications about task resources from the DSF FHIR server +- **Default:** `?criteria:exact=Task%3Fstatus%3Drequested&status=active&type=websocket&payload=application/fhir%2Bjson` + + +### DEV_DSF_BPE_MAIL_CLIENT_CERTIFICATE +- **Property:** dev.dsf.bpe.mail.client.certificate +- **Required:** No +- **Description:** PEM encoded file with client certificate used to authenticate against the SMTP server. Requires SMTP over TLS to be enabled via *DEV_DSF_BPE_MAIL_USESMTPS* +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/smtp_server_client_certificate.pem` + + +### DEV_DSF_BPE_MAIL_CLIENT_CERTIFICATE_PRIVATE_KEY +- **Property:** dev.dsf.bpe.mail.client.certificate.private.key +- **Required:** No +- **Description:** Private key corresponging to the SMTP server client certificate as PEM encoded file. Use DEV_DSF_BPE_MAIL_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD* or *DEV_DSF_BPE_MAIL_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE* if private key is encrypted. Requires SMTP over TLS to be enabled via *DEV_DSF_BPE_MAIL_USESMTPS* +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/smtp_server_client_certificate_private_key.pem` + + +### DEV_DSF_BPE_MAIL_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD or DEV_DSF_BPE_MAIL_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE +- **Property:** dev.dsf.bpe.mail.client.certificate.private.key.password +- **Required:** No +- **Description:** Password to decrypt the local client certificate encrypted private key +- **Recommendation:** Use docker secret file to configure using *DEV_DSF_BPE_MAIL_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE* +- **Example:** `/run/secrets/smtp_server_client_certificate_private_key.pem.password` + + +### DEV_DSF_BPE_MAIL_FROMADDRESS +- **Property:** dev.dsf.bpe.mail.fromAddress +- **Required:** No +- **Description:** Mail service sender address +- **Example:** `sender@localhost` + + +### DEV_DSF_BPE_MAIL_HOST +- **Property:** dev.dsf.bpe.mail.host +- **Required:** No +- **Description:** SMTP server hostname +- **Example:** `smtp.server.de` + + +### DEV_DSF_BPE_MAIL_MAILONERRORLOGEVENTBUFFERSIZE +- **Property:** dev.dsf.bpe.mail.mailOnErrorLogEventBufferSize +- **Required:** No +- **Description:** Number of previous INFO, WARN log messages to include in ERROR log event mails (>=0); requires send mail on ERROR log event option to be enabled to have an effect +- **Default:** `4` + + +### DEV_DSF_BPE_MAIL_MAILONERRORLOGEVENTDEBUGLOGLOCATION +- **Property:** dev.dsf.bpe.mail.mailOnErrorLogEventDebugLogLocation +- **Required:** No +- **Description:** Location of the BPE debug log as displayed in the footer of ERROR log event mails, does not modify the actual location of the debug log file; requires send mail on ERROR log event option to be enabled to have an effect +- **Default:** `/opt/bpe/log/bpe.log` + + +### DEV_DSF_BPE_MAIL_PASSWORD or DEV_DSF_BPE_MAIL_PASSWORD_FILE +- **Property:** dev.dsf.bpe.mail.password +- **Required:** No +- **Description:** SMTP server authentication password +- **Recommendation:** Configure if the SMTP server requires username/password authentication; use docker secret file to configure using *DEV_DSF_BPE_MAIL_PASSWORD_FILE*; enable SMTP over TLS via *DEV_DSF_BPE_MAIL_USESMTPS* + + +### DEV_DSF_BPE_MAIL_PORT +- **Property:** dev.dsf.bpe.mail.port +- **Required:** No +- **Description:** SMTP server port +- **Example:** `465` +- **Default:** `0` + + +### DEV_DSF_BPE_MAIL_REPLYTOADDRESSES +- **Property:** dev.dsf.bpe.mail.replyToAddresses +- **Required:** No +- **Description:** Mail service reply to addresses; comma or space separated list, YAML block scalars supported +- **Example:** `reply.to@localhost` + + +### DEV_DSF_BPE_MAIL_SENDMAILONERRORLOGEVENT +- **Property:** dev.dsf.bpe.mail.sendMailOnErrorLogEvent +- **Required:** No +- **Description:** To enable mails being send for every ERROR logged, set to `true`; requires SMTP server to be configured +- **Default:** `false` + + +### DEV_DSF_BPE_MAIL_SENDTESTMAILONSTARTUP +- **Property:** dev.dsf.bpe.mail.sendTestMailOnStartup +- **Required:** No +- **Description:** To enable a test mail being send on startup of the BPE, set to `true`; requires SMTP server to be configured +- **Default:** `false` + + +### DEV_DSF_BPE_MAIL_SMIME_P12KEYSTORE +- **Property:** dev.dsf.bpe.mail.smime.p12Keystore +- **Required:** No +- **Description:** PKCS12 encoded file with S/MIME certificate, private key and certificate chain to enable send mails to be S/MIME signed +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/smime_certificate.p12` + + +### DEV_DSF_BPE_MAIL_SMIME_P12KEYSTORE_PASSWORD or DEV_DSF_BPE_MAIL_SMIME_P12KEYSTORE_PASSWORD_FILE +- **Property:** dev.dsf.bpe.mail.smime.p12Keystore.password +- **Required:** No +- **Description:** Password to decrypt the PKCS12 encoded S/MIMIE certificate file +- **Recommendation:** Use docker secret file to configure using *DEV_DSF_BPE_MAIL_SMIME_P12KEYSTORE_PASSWORD_FILE* +- **Example:** `/run/secrets/smime_certificate.p12.password` + + +### DEV_DSF_BPE_MAIL_TOADDRESSES +- **Property:** dev.dsf.bpe.mail.toAddresses +- **Required:** No +- **Description:** Mail service recipient addresses, configure at least one; comma or space separated list, YAML block scalars supported +- **Example:** `recipient@localhost` + + +### DEV_DSF_BPE_MAIL_TOADDRESSESCC +- **Property:** dev.dsf.bpe.mail.toAddressesCc +- **Required:** No +- **Description:** Mail service CC recipient addresses; comma or space separated list, YAML block scalars supported +- **Example:** `cc.recipient@localhost` + + +### DEV_DSF_BPE_MAIL_TRUST_SERVER_CERTIFICATE_CAS +- **Property:** dev.dsf.bpe.mail.trust.server.certificate.cas +- **Required:** No +- **Description:** Folder with PEM encoded files (*.crt, *.pem) or a single PEM encoded file with one or more trusted root certificates to validate the server certificate of the SMTP server. Requires SMTP over TLS to be enabled via *DEV_DSF_BPE_MAIL_USESMTPS* +- **Recommendation:** Add file to default folder via bind mount or use docker secret file to configure +- **Example:** `/run/secrets/smtp_server_trust_certificates.pem` +- **Default:** `ca/server_root_cas` + + +### DEV_DSF_BPE_MAIL_USERNAME +- **Property:** dev.dsf.bpe.mail.username +- **Required:** No +- **Description:** SMTP server authentication username +- **Recommendation:** Configure if the SMTP server requires username/password authentication; enable SMTP over TLS via *DEV_DSF_BPE_MAIL_USESMTPS* + + +### DEV_DSF_BPE_MAIL_USESMTPS +- **Property:** dev.dsf.bpe.mail.useSmtps +- **Required:** No +- **Description:** To enable SMTP over TLS (smtps), set to `true` +- **Default:** `false` + + +### DEV_DSF_BPE_PROCESS_API_ALLOWED_BPE_CLASSES +- **Property:** dev.dsf.bpe.process.api.allowed.bpe.classes +- **Required:** No +- **Description:** Map with files containing qualified class names allowed to be loaded by plugins for api versions; map key must match v([1-9]+[0-9]*) +- **Recommendation:** Change only during development +- **Example:** `{v1: 'some/example.file', v2: 'other.file'}` +- **Default:** `{:}` + + +### DEV_DSF_BPE_PROCESS_API_ALLOWED_BPE_RESOURCE +- **Property:** dev.dsf.bpe.process.api.allowed.bpe.resource +- **Required:** No +- **Description:** Map with files containing resources allowed to be loaded by plugins for api versions; map key must match v([1-9]+[0-9]*) +- **Recommendation:** Change only during development +- **Example:** `{v1: 'some/example.file', v2: 'other.file'}` +- **Default:** `{:}` + + +### DEV_DSF_BPE_PROCESS_API_DIRECTORY +- **Property:** dev.dsf.bpe.process.api.directory +- **Required:** No +- **Description:** Directory containing the DSF BPE process plugin api jar files +- **Recommendation:** Change only during development +- **Default:** `api` + + +### DEV_DSF_BPE_PROCESS_API_RESOURCES_WITH_PRIORITY +- **Property:** dev.dsf.bpe.process.api.resources.with.priority +- **Required:** No +- **Description:** Map with files containing api/plugin resource with priority over bpe resources for plugins for api versions; map key must match v([1-9]+[0-9]*) +- **Recommendation:** Change only during development +- **Example:** `{v1: 'some/example.file', v2: 'other.file'}` +- **Default:** `{:}` + + +### DEV_DSF_BPE_PROCESS_ENGINE_COREPOOLSIZE +- **Property:** dev.dsf.bpe.process.engine.corePoolSize +- **Required:** No +- **Description:** Process engine job executor core pool size +- **Default:** `4` + + +### DEV_DSF_BPE_PROCESS_ENGINE_MAXPOOLSIZE +- **Property:** dev.dsf.bpe.process.engine.maxPoolSize +- **Required:** No +- **Description:** Process engine job executor max pool size, additional threads until max pool size are created if the queue is full +- **Default:** `10` + + +### DEV_DSF_BPE_PROCESS_ENGINE_QUEUESIZE +- **Property:** dev.dsf.bpe.process.engine.queueSize +- **Required:** No +- **Description:** Process engine job executor queue size, jobs are added to the queue if all core pool threads are busy +- **Default:** `40` + + +### DEV_DSF_BPE_PROCESS_EXCLUDED +- **Property:** dev.dsf.bpe.process.excluded +- **Required:** No +- **Description:** List of process names that should be excluded from deployment during startup of the DSF BPE server; comma or space separated list, YAML block scalars supported +- **Recommendation:** Only deploy processes that can be started depending on your organization's roles in the Allow-List +- **Example:** `dsfdev_updateAllowList|1.0, another_process|x.y` + + +### DEV_DSF_BPE_PROCESS_FHIR_SERVER_RETRY_MAX +- **Property:** dev.dsf.bpe.process.fhir.server.retry.max +- **Required:** No +- **Description:** Number of retries until a connection can be established with the local DSF FHIR server during process deployment, `-1` means infinite number of retries +- **Default:** `-1` + + +### DEV_DSF_BPE_PROCESS_FHIR_SERVER_RETRY_SLEEP +- **Property:** dev.dsf.bpe.process.fhir.server.retry.sleep +- **Required:** No +- **Description:** Time between two retries to establish a connection with the local DSF FHIR server during process deployment +- **Default:** `PT5S` + + +### DEV_DSF_BPE_PROCESS_FHIR_VALIDATION_ENABLED +- **Property:** dev.dsf.bpe.process.fhir.validation.enabled +- **Required:** No +- **Description:** Set to true to enable FHIR validation feature for process plugins, not implemented for DSF version 2.0.x +- **Default:** `false` + + +### DEV_DSF_BPE_PROCESS_PLUGIN_DIRECTORY +- **Property:** dev.dsf.bpe.process.plugin.directory +- **Required:** No +- **Description:** Directory containing the DSF BPE process plugins for deployment on startup of the DSF BPE server +- **Recommendation:** Change only if you don't use the provided directory structure from the installation guide or made changes to tit +- **Default:** `process` + + +### DEV_DSF_BPE_PROCESS_PLUGIN_EXPLODED +- **Property:** dev.dsf.bpe.process.plugin.exploded +- **Required:** No +- **Description:** Directories containing exploded DSF BPE process plugins for deployment on startup of the DSF BPE server; comma or space separated list, YAML block scalars supported +- **Recommendation:** Only for testing + + +### DEV_DSF_BPE_PROCESS_RETIRED +- **Property:** dev.dsf.bpe.process.retired +- **Required:** No +- **Description:** List of already deployed process names that should be retired during startup of the DSF BPE server; comma or space separated list, YAML block scalars supported +- **Recommendation:** Retire processes that where deployed previously but are not anymore available +- **Example:** `old_process|x.y` + + +### DEV_DSF_BPE_PROCESS_THREADS +- **Property:** dev.dsf.bpe.process.threads +- **Required:** No +- **Description:** Number of parallel Task / QuestionnaireResponse threads to start new or continue existing processes, a value `<= 0` means number of cpu cores +- **Default:** `-1` + + +### DEV_DSF_BPE_SERVER_BASE_URL +- **Property:** dev.dsf.bpe.server.base.url +- **Required:** No +- **Description:** Base address of the BPE server, configure when exposing the web-ui +- **Example:** `https://foo.bar/bpe` +- **Default:** `https://localhost/bpe` + + +### DEV_DSF_BPE_SERVER_ROLECONFIG +- **Property:** dev.dsf.bpe.server.roleConfig +- **Required:** No +- **Description:** Role config YAML as defined in [BPE Server: Access Control](access-control) + + +### DEV_DSF_BPE_SERVER_STATIC_RESOURCE_CACHE +- **Property:** dev.dsf.bpe.server.static.resource.cache +- **Required:** No +- **Description:** To disable static resource caching, set to `false` +- **Recommendation:** Only set to `false` for development +- **Default:** `true` + + +### DEV_DSF_BPE_SERVER_UI_THEME +- **Property:** dev.dsf.bpe.server.ui.theme +- **Required:** No +- **Description:** UI theme parameter, adds a color indicator to the ui to distinguish `dev`, `test` and `prod` environments if configured; supported values: `dev`, `test` and `prod` + + +### DEV_DSF_LOG_CONFIG +- **Property:** dev.dsf.log.config +- **Required:** No +- **Description:** Location of a log4j configuration xml file; if file is readable, overrides configuration specified via *DEV_DSF_LOG_...* parameters +- **Default:** `conf/log4j2.xml` + + +### DEV_DSF_LOG_CONSOLE_ERR_ENABLED +- **Property:** dev.dsf.log.console.err.enabled +- **Required:** No +- **Description:** Set to `true` to enable console err output of the standard logger +- **Default:** `false` + + +### DEV_DSF_LOG_CONSOLE_ERR_LEVEL +- **Property:** dev.dsf.log.console.err.level +- **Required:** No +- **Description:** Standard logger console err output level, one of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR` +- **Default:** `INFO` + + +### DEV_DSF_LOG_CONSOLE_ERR_STYLE +- **Property:** dev.dsf.log.console.err.style +- **Required:** No +- **Description:** Standard logger console err output style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`, `TEXT_COLOR_MDC`, `TEXT_COLOR` +- **Default:** `TEXT_COLOR` + + +### DEV_DSF_LOG_CONSOLE_OUT_ENABLED +- **Property:** dev.dsf.log.console.out.enabled +- **Required:** No +- **Description:** Set to `false` to disable console out output of the standard logger +- **Default:** `true` + + +### DEV_DSF_LOG_CONSOLE_OUT_LEVEL +- **Property:** dev.dsf.log.console.out.level +- **Required:** No +- **Description:** Standard logger console out output level, one of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR` +- **Default:** `INFO` + + +### DEV_DSF_LOG_CONSOLE_OUT_STYLE +- **Property:** dev.dsf.log.console.out.style +- **Required:** No +- **Description:** Standard logger console out output style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`, `TEXT_COLOR_MDC`, `TEXT_COLOR` +- **Default:** `TEXT_COLOR` + + +### DEV_DSF_LOG_DATA_CONSOLE_ERR_ENABLED +- **Property:** dev.dsf.log.data.console.err.enabled +- **Required:** No +- **Description:** Set to `true` to enable console err output of the special data logger; the data logger can be used by process plugins to log sensitive data +- **Default:** `false` + + +### DEV_DSF_LOG_DATA_CONSOLE_ERR_STYLE +- **Property:** dev.dsf.log.data.console.err.style +- **Required:** No +- **Description:** Special data logger console err style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT` +- **Default:** `TEXT` + + +### DEV_DSF_LOG_DATA_CONSOLE_OUT_ENABLED +- **Property:** dev.dsf.log.data.console.out.enabled +- **Required:** No +- **Description:** Set to `true` to enable console out output of the special data logger; the data logger can be used by process plugins to log sensitive data +- **Default:** `false` + + +### DEV_DSF_LOG_DATA_CONSOLE_OUT_STYLE +- **Property:** dev.dsf.log.data.console.out.style +- **Required:** No +- **Description:** Special data logger console out style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT` +- **Default:** `TEXT` + + +### DEV_DSF_LOG_DATA_FILE_ENABLED +- **Property:** dev.dsf.log.data.file.enabled +- **Required:** No +- **Description:** Set to `true` to enable log file output of the special data logger; the data logger can be used by process plugins to log sensitive data +- **Default:** `false` + + +### DEV_DSF_LOG_DATA_FILE_STYLE +- **Property:** dev.dsf.log.data.file.style +- **Required:** No +- **Description:** Special data logger file style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT` +- **Default:** `TEXT` + + +### DEV_DSF_LOG_FILE_ENABLED +- **Property:** dev.dsf.log.file.enabled +- **Required:** No +- **Description:** Set to `false` to disable log file output of the standard logger +- **Default:** `true` + + +### DEV_DSF_LOG_FILE_LEVEL +- **Property:** dev.dsf.log.file.level +- **Required:** No +- **Description:** Standard logger log file output level, one of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR` +- **Default:** `DEBUG` + + +### DEV_DSF_LOG_FILE_STYLE +- **Property:** dev.dsf.log.file.style +- **Required:** No +- **Description:** Standard logger log file output style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT` +- **Default:** `TEXT_MDC` + + +### DEV_DSF_LOG_MIN_LEVEL_LOGGERS +- **Property:** dev.dsf.log.min.level.loggers +- **Required:** No +- **Description:** List of logger names that are enabled to produce log output with the minimal configured log level from `DEV_DSF_LOG_CONSOLE_OUT_LEVEL`, `DEV_DSF_LOG_CONSOLE_ERR_LEVEL` and `DEV_DSF_LOG_FILE_LEVEL` +- **Default:** `dev.dsf, de.medizininformatik_initiative.processes.common` + + +### DEV_DSF_PROXY_NOPROXY +- **Property:** dev.dsf.proxy.noProxy +- **Required:** No +- **Description:** Forward proxy no-proxy list, entries will match exactly or against (one level) sub-domains, if no port is specified - all ports are matched; comma or space separated list, YAML block scalars supported +- **Example:** `foo.bar, test.com:8080` + + +### DEV_DSF_PROXY_PASSWORD or DEV_DSF_PROXY_PASSWORD_FILE +- **Property:** dev.dsf.proxy.password +- **Required:** No +- **Description:** Forward Proxy password +- **Recommendation:** Configure password if proxy requires authentication, use docker secret file to configure using *DEV_DSF_PROXY_PASSWORD_FILE* + + +### DEV_DSF_PROXY_URL +- **Property:** dev.dsf.proxy.url +- **Required:** No +- **Description:** Forward (http/https) proxy url, use *DEV_DSF_BPE_PROXY_NOPROXY* to list domains that do not require a forward proxy +- **Example:** `http://proxy.foo:8080` + + +### DEV_DSF_PROXY_USERNAME +- **Property:** dev.dsf.proxy.username +- **Required:** No +- **Description:** Forward proxy username +- **Recommendation:** Configure username if proxy requires authentication + + +### DEV_DSF_SERVER_API_HOST +- **Property:** dev.dsf.server.api.host +- **Required:** No +- **Description:** API connector host, default in docker image: `0.0.0.0` +- **Default:** `127.0.0.1` + + +### DEV_DSF_SERVER_API_PORT +- **Property:** dev.dsf.server.api.port +- **Required:** No +- **Description:** API connector port, default in docker image: `8080` + + +### DEV_DSF_SERVER_AUTH_CLIENT_CERTIFICATE_HEADER +- **Property:** dev.dsf.server.auth.client.certificate.header +- **Required:** No +- **Description:** Name of HTTP header with client certificate from reverse proxy +- **Default:** `X-ClientCert` + + +### DEV_DSF_SERVER_AUTH_OIDC_AUTHORIZATION_CODE_FLOW +- **Property:** dev.dsf.server.auth.oidc.authorization.code.flow +- **Required:** No +- **Description:** Set to `true` to enable OIDC authorization code flow +- **Recommendation:** Requires *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL*, *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID* and *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET* or *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET_FILE* to be specified +- **Default:** `false` + + +### DEV_DSF_SERVER_AUTH_OIDC_BACK_CHANNEL_LOGOUT +- **Property:** dev.dsf.server.auth.oidc.back.channel.logout +- **Required:** No +- **Description:** Set to `true` to enable OIDC back-channel logout +- **Recommendation:** Requires *DEV_DSF_SERVER_AUTH_OIDC_AUTHORIZATION_CODE_FLOW* to be set to `true` (enabled), *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID* and *DEV_DSF_SERVER_AUTH_OIDC_BACK_CHANNEL_LOGOUT_PATH* to be specified +- **Default:** `false` + + +### DEV_DSF_SERVER_AUTH_OIDC_BACK_CHANNEL_LOGOUT_PATH +- **Property:** dev.dsf.server.auth.oidc.back.channel.logout.path +- **Required:** No +- **Description:** Path called by the OIDC provide to request back-channel logout +- **Default:** `/back-channel-logout` + + +### DEV_DSF_SERVER_AUTH_OIDC_BEARER_TOKEN +- **Property:** dev.dsf.server.auth.oidc.bearer.token +- **Required:** No +- **Description:** Set to `true` to enable OIDC bearer token authentication +- **Recommendation:** Requires *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL* to be specified +- **Default:** `false` + + +### DEV_DSF_SERVER_AUTH_OIDC_BEARER_TOKEN_AUDIENCE +- **Property:** dev.dsf.server.auth.oidc.bearer.token.audience +- **Required:** No +- **Description:** Audience (aud) value to verify before accepting OIDC bearer tokens, uses value from `DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID` by default, set blank string e.g. `''` to disable +- **Recommendation:** Requires *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL* to be specified and *DEV_DSF_SERVER_AUTH_OIDC_BEARER_TOKEN* set tor `true` + + +### DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID +- **Property:** dev.dsf.server.auth.oidc.client.id +- **Required:** No +- **Description:** OIDC provider client_id, must be specified if *DEV_DSF_SERVER_AUTH_OIDC_AUTHORIZATION_CODE_FLOW* is enabled + + +### DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET or DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET_FILE +- **Property:** dev.dsf.server.auth.oidc.client.secret +- **Required:** No +- **Description:** OIDC provider client_secret, must be specified if *DEV_DSF_SERVER_AUTH_OIDC_AUTHORIZATION_CODE_FLOW* is enabled + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CACHE_TIMEOUT_CONFIGURATION_RESOURCE +- **Property:** dev.dsf.server.auth.oidc.provider.client.cache.timeout.configuration.resource +- **Required:** No +- **Description:** OIDC provider client cache timeout of the 'openid-configuration' discovery resource +- **Default:** `PT1H` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CACHE_TIMEOUT_JWKS_RESOURCE +- **Property:** dev.dsf.server.auth.oidc.provider.client.cache.timeout.jwks.resource +- **Required:** No +- **Description:** OIDC provider client cache timeout of the jwks resource +- **Default:** `PT1H` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE +- **Property:** dev.dsf.server.auth.oidc.provider.client.certificate +- **Required:** No +- **Description:** PEM encoded file with client certificate for https connections to the OIDC provider +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/oidc_provider_client_certificate.pem` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE_PRIVATE_KEY +- **Property:** dev.dsf.server.auth.oidc.provider.client.certificate.private.key +- **Required:** No +- **Description:** Private key corresponding to the client certificate for the OIDC provider as PEM encoded file. Use *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD* or *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE* if private key is encrypted +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/oidc_provider_client_certificate_private_key.pem` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD or DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE +- **Property:** dev.dsf.server.auth.oidc.provider.client.certificate.private.key.password +- **Required:** No +- **Description:** Password to decrypt the client certificate for the OIDC provider encrypted private key +- **Recommendation:** Use docker secret file to configure using *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE* +- **Example:** `/run/secrets/oidc_provider_client_certificate_private_key.pem.password` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TIMEOUT_CONNECT +- **Property:** dev.dsf.server.auth.oidc.provider.client.timeout.connect +- **Required:** No +- **Description:** OIDC provider client connect timeout +- **Default:** `PT5S` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TIMEOUT_READ +- **Property:** dev.dsf.server.auth.oidc.provider.client.timeout.read +- **Required:** No +- **Description:** OIDC provider client read timeout +- **Default:** `PT30S` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TRUST_SERVER_CERTIFICATE_CAS +- **Property:** dev.dsf.server.auth.oidc.provider.client.trust.server.certificate.cas +- **Required:** No +- **Description:** Folder with PEM encoded files (*.crt, *.pem) or a single PEM encoded file with one or more trusted root certificates to validate server certificates for https connections to the OIDC provider +- **Recommendation:** Add file to default folder via bind mount or use docker secret file to configure +- **Example:** `/run/secrets/oidc_provider_trust_certificates.pem` +- **Default:** `ca/server_root_cas` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_DISCOVERY_PATH +- **Property:** dev.dsf.server.auth.oidc.provider.discovery.path +- **Required:** No +- **Description:** OIDC provider discovery path +- **Default:** `/.well-known/openid-configuration` + + +### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL +- **Property:** dev.dsf.server.auth.oidc.provider.realm.base.url +- **Required:** No +- **Description:** OIDC provider realm base url +- **Example:** `https://keycloak.test.com:8443/realms/example-realm-name` + + +### DEV_DSF_SERVER_AUTH_OIDC_SESSION_TIMEOUT +- **Property:** dev.dsf.server.auth.oidc.session.timeout +- **Required:** No +- **Description:** Maximum inactivity period after which the server session for OIDC logins is invalidated; the access token may expire earlier, resulting in earlier session invalidation +- **Default:** `PT30M` + + +### DEV_DSF_SERVER_AUTH_TRUST_CLIENT_CERTIFICATE_CAS +- **Property:** dev.dsf.server.auth.trust.client.certificate.cas +- **Required:** No +- **Description:** Folder with PEM encoded files (*.crt, *.pem) or a single PEM encoded file with one or more trusted full CA chains to validate client certificates for https connections from local and remote clients +- **Recommendation:** Add file to default folder via bind mount or use docker secret file to configure +- **Example:** `/run/secrets/app_client_trust_certificates.pem` +- **Default:** `ca/client_ca_chains` + + +### DEV_DSF_SERVER_CERTIFICATE +- **Property:** dev.dsf.server.certificate +- **Required:** No +- **Description:** Server certificate file for testing +- **Recommendation:** Only specify For testing when terminating TLS in jetty server + + +### DEV_DSF_SERVER_CERTIFICATE_CHAIN +- **Property:** dev.dsf.server.certificate.chain +- **Required:** No +- **Description:** Server certificate chain file for testing +- **Recommendation:** Only specify For testing when terminating TLS in jetty server + + +### DEV_DSF_SERVER_CERTIFICATE_KEY +- **Property:** dev.dsf.server.certificate.key +- **Required:** No +- **Description:** Server certificate private key file for testing +- **Recommendation:** Only specify For testing when terminating TLS in jetty server + + +### DEV_DSF_SERVER_CERTIFICATE_KEY_PASSWORD or DEV_DSF_SERVER_CERTIFICATE_KEY_PASSWORD_FILE +- **Property:** dev.dsf.server.certificate.key.password +- **Required:** No +- **Description:** Server certificate private key file password for testing +- **Recommendation:** Only specify For testing when terminating TLS in jetty server + + +### DEV_DSF_SERVER_CONTEXT_PATH +- **Property:** dev.dsf.server.context.path +- **Required:** No +- **Description:** Web application context path, default in `bpe` docker image: `/bpe`, default in `fhir` docker image: `/fhir` +- **Recommendation:** Only modify for testing + + +### DEV_DSF_SERVER_STATUS_HOST +- **Property:** dev.dsf.server.status.host +- **Required:** No +- **Description:** Status connector host +- **Default:** `127.0.0.1` + + +### DEV_DSF_SERVER_STATUS_PORT +- **Property:** dev.dsf.server.status.port +- **Required:** No +- **Description:** Status connector port, default in docker image: `10000` + +--- + +## FHIR Reverse Proxy +Source: https://dsf.dev/operations/latest/fhir-reverse-proxy/configuration.html + +### APP_SERVER_IP +- **Required:** Yes +- **Description:** Hostname or IP-Address of the DSF FHIR server application container, the reverse proxy target +- **Example:** `app`, `172.28.1.3` + + +### HTTPS_SERVER_NAME_PORT +- **Required:** Yes +- **Description:** External FQDN of your DSF FHIR server with port, typically `443` +- **Example:** `my-external.fqdn:443` + + +### PROXY_PASS_CONNECTION_TIMEOUT_HTTP +- **Required:** No +- **Description:** Connection timeout (seconds) for reverse proxy to app server http connection, time the proxy waits for a connection to be established +- **Default:** `30` seconds + + +### PROXY_PASS_CONNECTION_TIMEOUT_WS +- **Required:** No +- **Description:** Connection timeout (seconds) for reverse proxy to app server ws connection, time the proxy waits for a connection to be established +- **Default:** `30` seconds + + +### PROXY_PASS_TIMEOUT_HTTP +- **Required:** No +- **Description:** Timeout (seconds) for reverse proxy to app server http connection, time the proxy waits for a reply +- **Default:** `60` seconds + + +### PROXY_PASS_TIMEOUT_WS +- **Required:** No +- **Description:** Timeout (seconds) for reverse proxy to app server ws connection, time the proxy waits for a reply +- **Default:** `60` seconds + + +### SERVER_CONTEXT_PATH +- **Required:** No +- **Description:** Reverse proxy context path that delegates to the app server, `/` character at start, no `/` character at end, use `''` (empty string) to configure root as context path +- **Default:** `/fhir` + + +### SSL_CA_CERTIFICATE_FILE +- **Required:** No +- **Description:** Certificate chain file including all issuing, intermediate and root certificates used to validate client certificates, PEM encoded, sets the apache httpd parameter `SSLCACertificateFile`; not used by default, overrides *SSL_CA_CERTIFICATE_PATH* if not empty + + +### SSL_CA_CERTIFICATE_PATH +- **Required:** No +- **Description:** Folder with trusted full CA chains for validating client certificates +- **Recommendation:** Override default folder content via bind mount or add *.crt files to default folder via bind mount +- **Default:** `ca/client_ca_chains` + + +### SSL_CA_DN_REQUEST_FILE +- **Required:** No +- **Description:** File containing all signing certificates excepted, will be used to specify the `Acceptable client certificate CA names` send to the client, during TLS handshake, sets the apache httpd parameter `SSLCADNRequestFile`; if omitted all entries from *SSL_CA_CERTIFICATE_FILE* are used; not used by default, overrides *SSL_CA_DN_REQUEST_PATH* if not empty + + +### SSL_CA_DN_REQUEST_PATH +- **Required:** No +- **Description:** Folder with trusted client certificate issuing CAs, modifies the "Acceptable client certificate CA names" send to the client, uses all from *SSL_CA_CERTIFICATE_FILE* or *SSL_CA_CERTIFICATE_PATH* if not set or empty +- **Recommendation:** Override default folder content via bind mount or add *.crt files to default folder via bind mount +- **Default:** `ca/client_issuing_cas` + + +### SSL_CERTIFICATE_CHAIN_FILE +- **Required:** No +- **Description:** Certificate chain file, PEM encoded, must contain all certificates between the server certificate and the root ca certificate (excluding the root ca certificate), sets the apache httpd parameter `SSLCertificateChainFile`; can be omitted if either no chain is needed (self signed server certificate) or the file specified via *SSL_CERTIFICATE_FILE* contains the certificate chain +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/ssl_certificate_chain_file.pem` + + +### SSL_CERTIFICATE_CHAIN_FILE +- **Required:** No +- **Description:** Certificate chain file, PEM encoded, must contain all certificates between the server certificate and the root ca certificate (excluding the root ca certificate), sets the apache httpd parameter `SSLCertificateChainFile`; can be omitted if either no chain is needed (self signed server certificate) or the file specified via *SSL_CERTIFICATE_FILE* contains the certificate chain +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/ssl_certificate_chain_file.pem` + + +### SSL_CERTIFICATE_FILE +- **Required:** Yes +- **Description:** Server certificate file, PEM encoded, sets the apache httpd parameter `SSLCertificateFile`, may contain all certificates between the server certificate and the root ca certificate (excluding the root ca certificate). Omit *SSL_CERTIFICATE_CHAIN_FILE* if chain included +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/ssl_certificate_file.pem` + + +### SSL_CERTIFICATE_KEY_FILE +- **Required:** Yes +- **Description:** Server certificate private key file, PEM encoded, unencrypted, sets the apache httpd parameter `SSLCertificateKeyFile` +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/ssl_certificate_key_file.pem` + + +### SSL_EXPECTED_CLIENT_S_DN_C_VALUES +- **Required:** No +- **Description:** Expected client certificate subject DN country `C` values, must be a comma-separated list of strings in single quotation marks, e.g. `'DE', 'FR'`. If a client certificate with a not configured subject country `C` value is used, the server answers with a `403 Forbidden` status code +- **Default:** `'DE'` + + +### SSL_EXPECTED_CLIENT_I_DN_CN_VALUES +- **Required:** No +- **Description:** Expected client certificate issuer DN common-name `CN` values, must be a comma-separated list of strings in single quotation marks. If a client certificate from a not configured issuing ca common-name is used, the server answers with a `403 Forbidden` status code +- **Default:** `'GEANT TLS ECC 1', 'HARICA OV TLS ECC', 'GEANT TLS RSA 1', 'HARICA OV TLS RSA', 'GEANT S/MIME ECC 1', 'HARICA Client Authentication ECC', 'HARICA S/MIME ECC', 'GEANT S/MIME RSA 1', 'HARICA Client Authentication RSA', 'HARICA S/MIME RSA', 'DFN-Verein Global Issuing CA', 'Fraunhofer User CA - G02', 'D-TRUST SSL Class 3 CA 1 2009', 'Sectigo RSA Organization Validation Secure Server CA', 'GEANT OV RSA CA 4', 'GEANT Personal CA 4', 'GEANT eScience Personal CA 4', 'Sectigo ECC Organization Validation Secure Server CA', 'GEANT OV ECC CA 4', 'GEANT Personal ECC CA 4', 'GEANT eScience Personal ECC CA 4', 'D-TRUST Limited Basic CA 1-2 2019', 'D-TRUST Limited Basic CA 1-3 2019'` + + +### SSL_VERIFY_CLIENT +- **Required:** No +- **Description:** Modifies the apache mod_ssl config parameter `SSLVerifyClient` +- **Recommendation:** Set to `optional` when using OIDC authentication +- **Default:** `require` + +--- + +## BPE Reverse Proxy +Source: https://dsf.dev/operations/latest/bpe-reverse-proxy/configuration.html + +### APP_SERVER_IP +- **Required:** Yes +- **Description:** Hostname or IP-Address of the DSF BPE server application container, the reverse proxy target +- **Example:** `app`, `172.28.1.3` + + +### HTTPS_SERVER_NAME_PORT +- **Required:** Yes +- **Description:** FQDN of your DSF BPE server with port, typically `443` +- **Example:** `my-external.fqdn:443` + + +### PROXY_PASS_CONNECTION_TIMEOUT_HTTP +- **Required:** No +- **Description:** Connection timeout (seconds) for reverse proxy to app server http connection, time the proxy waits for a connection to be established +- **Default:** `30` seconds + + +### PROXY_PASS_CONNECTION_TIMEOUT_WS +- **Required:** No +- **Description:** Connection timeout (seconds) for reverse proxy to app server ws connection, time the proxy waits for a connection to be established +- **Default:** `30` seconds + + +### PROXY_PASS_TIMEOUT_HTTP +- **Required:** No +- **Description:** Timeout (seconds) for reverse proxy to app server http connection, time the proxy waits for a reply +- **Default:** `60` seconds + + +### PROXY_PASS_TIMEOUT_WS +- **Required:** No +- **Description:** Timeout (seconds) for reverse proxy to app server ws connection, time the proxy waits for a reply +- **Default:** `60` seconds + + +### SERVER_CONTEXT_PATH +- **Required:** No +- **Description:** Reverse proxy context path that delegates to the app server, `/` character at start, no `/` character at end, use `''` (empty string) to configure root as context path +- **Default:** `/bpe` + + +### SSL_CA_CERTIFICATE_FILE +- **Required:** No +- **Description:** Certificate chain file including all issuing, intermediate and root certificates used to validate client certificates, PEM encoded, sets the apache httpd parameter `SSLCACertificateFile`; not used by default, overrides *SSL_CA_CERTIFICATE_PATH* if not empty + + +### SSL_CA_CERTIFICATE_PATH +- **Required:** No +- **Description:** Folder with trusted full CA chains for validating client certificates +- **Recommendation:** Override default folder content via bind mount or add *.crt files to default folder via bind mount +- **Default:** `ca/client_ca_chains` + + +### SSL_CA_DN_REQUEST_FILE +- **Required:** No +- **Description:** File containing all signing certificates excepted, will be used to specify the `Acceptable client certificate CA names` send to the client, during TLS handshake, sets the apache httpd parameter `SSLCADNRequestFile`; if omitted all entries from *SSL_CA_CERTIFICATE_FILE* are used; not used by default, overrides *SSL_CA_DN_REQUEST_PATH* if not empty + + +### SSL_CA_DN_REQUEST_PATH +- **Required:** No +- **Description:** Folder with trusted client certificate issuing CAs, modifies the "Acceptable client certificate CA names" send to the client, uses all from *SSL_CA_CERTIFICATE_FILE* or *SSL_CA_CERTIFICATE_PATH* if not set or empty +- **Recommendation:** Override default folder content via bind mount or add *.crt files to default folder via bind mount +- **Default:** `ca/client_issuing_cas` + + +### SSL_CERTIFICATE_CHAIN_FILE +- **Required:** No +- **Description:** Certificate chain file, PEM encoded, must contain all certificates between the server certificate and the root ca certificate (excluding the root ca certificate), sets the apache httpd parameter `SSLCertificateChainFile`; can be omitted if either no chain is needed (self signed server certificate) or the file specified via *SSL_CERTIFICATE_FILE* contains the certificate chain +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/ssl_certificate_chain_file.pem` + + +### SSL_CERTIFICATE_FILE +- **Required:** Yes +- **Description:** Server certificate file, PEM encoded, sets the apache httpd parameter `SSLCertificateFile`, may contain all certificates between the server certificate and the root ca certificate (excluding the root ca certificate). Omit *SSL_CERTIFICATE_CHAIN_FILE* if chain included +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/ssl_certificate_file.pem` + + +### SSL_CERTIFICATE_KEY_FILE +- **Required:** Yes +- **Description:** Server certificate private key file, PEM encoded, unencrypted, sets the apache httpd parameter `SSLCertificateKeyFile` +- **Recommendation:** Use docker secret file to configure +- **Example:** `/run/secrets/ssl_certificate_key_file.pem` + + +### SSL_EXPECTED_CLIENT_S_DN_C_VALUES +- **Required:** No +- **Description:** Expected client certificate subject DN country `C` values, must be a comma-separated list of strings in single quotation marks, e.g. `'DE', 'FR'`. If a client certificate with a not configured subject country `C` value is used, the server answers with a `403 Forbidden` status code +- **Default:** `'DE'` + + +### SSL_EXPECTED_CLIENT_I_DN_CN_VALUES +- **Required:** No +- **Description:** Expected client certificate issuer DN common-name `CN` values, must be a comma-separated list of strings in single quotation marks. If a client certificate from a not configured issuing ca common-name is used, the server answers with a `403 Forbidden` status code +- **Default:** `'GEANT TLS ECC 1', 'HARICA OV TLS ECC', 'GEANT TLS RSA 1', 'HARICA OV TLS RSA', 'GEANT S/MIME ECC 1', 'HARICA Client Authentication ECC', 'HARICA S/MIME ECC', 'GEANT S/MIME RSA 1', 'HARICA Client Authentication RSA', 'HARICA S/MIME RSA', 'DFN-Verein Global Issuing CA', 'Fraunhofer User CA - G02', 'D-TRUST SSL Class 3 CA 1 2009', 'Sectigo RSA Organization Validation Secure Server CA', 'GEANT OV RSA CA 4', 'GEANT Personal CA 4', 'GEANT eScience Personal CA 4', 'Sectigo ECC Organization Validation Secure Server CA', 'GEANT OV ECC CA 4', 'GEANT Personal ECC CA 4', 'GEANT eScience Personal ECC CA 4', 'D-TRUST Limited Basic CA 1-2 2019', 'D-TRUST Limited Basic CA 1-3 2019'` + + +### SSL_VERIFY_CLIENT +- **Required:** No +- **Description:** Modifies the apache mod_ssl config parameter `SSLVerifyClient` +- **Recommendation:** Set to `optional` when using OIDC authentication +- **Default:** `require` + +--- + +## Allow List Management +Source: https://dsf.dev/operations/latest/allowList-mgm.html + +You can read all about the concept of Allow Lists [in our introduction](/explore/concepts/allow-list.md). + +## Overview +To simplify the DSF Allow List Management we have built a portal for administration. The portal is managed by the GECKO Institute at Heilbronn University. You as an DSF administrator can create or update your Allow List information. The information you provide on this portal will be transferred to us and will be used to built Allow List bundles that get distributed to the communication partners of the distributed processes. + +The DSF Allow List management tool uses client certificates for authentication. You can either use a personal client certificate or the client certificate from your DSF BPE, which needs to be added to your web-browsers certificate store. + + +## Prerequisites +1. Deployed DSF instance (test or production infrastructure) + 1.1 If none exists yet, read [the installation guide](install) +2. Certificate + 2.1 If none exists yet, read [the certificate requirements](install#client-server-certificates) +3. Organization identifier, shortest FQDN of your organizations website, e.g. `my-hospital.de` +4. FHIR endpoint URL, e.g. `https://dsf.my-hospital.de/fhir` +5. Contact details from a responsible person of your organization +6. Access to the E-Mail address from your organization for verification + + +## Start here +When you have fulfilled all the prerequisites, you can start managing your Allow Lists via the environment specific Allow List Management Tool: + +- [**Test** infrastructure](https://allowlist-test.gecko.hs-heilbronn.de) +- [**Production** infrastructure](https://allowlist.gecko.hs-heilbronn.de) + +We use different highlight colors for the DSF Allow List Management Tool: Green for the **Test** environment and blue for the **Production** infrastructure. To access the site, you have to authenticate yourself with a client certificate. Your web-browser will show a dialog to choose a valid certificate. + +::: tip Ideas for improvement? +Have you found an error or is something unclear to you? Then please feel free to contact us on the MII-Zulip Channel or write us at dsf-gecko@hs-heilbronn.de. Thank you very much! +::: + +--- + +## Process Plugin Deployment +Source: https://dsf.dev/operations/process-plugin-deployment.html + + + +--- + +## Passwords and Secrets +Source: https://dsf.dev/operations/latest/passwords-secrets.html + +Environment variables ending in `_PASSWORD` or `_SECRET` can be configured using plain-text files. To achieve this, environment variable should be defined with `_FILE` appended to the name with the value defined as the location of the file. For all variables ending in `_PASSWORD_FILE` or `_SECRET_FILE` the DSF FHIR and DSF BPE applications will read the content of the fist line of the referenced file and dynamically define the corresponding `_PASSWORD` or `_SECRET` environment variables with the read values. + +### Example Environment Variables +- **DEV_DSF_BPE_DB_USER_PASSWORD_FILE**: If set to `/run/secrets/db_user_password`, the application will read the contents of the `/run/secrets/db_user_password` file and set the `DEV_DSF_BPE_DB_USER_PASSWORD` environment variable with the content from that file. +- **DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET_FILE**: If set to `/run/secrets/oidc_client_secret`, the application will read the contents of the referenced file and set the `DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET` environment variable accordingly. + +### Docker Secrets + +It is recommended to use [docker secrets](https://docs.docker.com/compose/how-tos/use-secrets) as files for these environment variables. Docker secrets are mounted as files in `/run/secrets/` inside the container. + +#### Example docker-compose +```yaml +services: + app: + image: ghcr.io/datasharingframework/fhir + secrets: + - db_user_password + - oidc_client_secret + environment: + DEV_DSF_BPE_DB_USER_PASSWORD_FILE: /run/secrets/db_user_password + DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET_FILE: /run/secrets/oidc_client_secret + +secrets: + db_user_password: + file: ./secrets/db_user.password + api_key: + file: ./secrets/oidc_client.secret +``` + +--- + +## Root Certificates +Source: https://dsf.dev/operations/latest/root-certificates.html + +A number of trusted certificate authorities (CAs) are included in the DSF docker images [fhir_proxy](https://github.com/datasharingframework/dsf/pkgs/container/fhir_proxy), [fhir](https://github.com/datasharingframework/dsf/pkgs/container/fhir), [bpe_proxy](https://github.com/datasharingframework/dsf/pkgs/container/bpe_proxy) and [bpe](https://github.com/datasharingframework/dsf/pkgs/container/bpe) by default. Root and intermediate certificates as well as the configured usage of issuing CAs as either **server**, **client** oder **server and client** CA are listed at the end. + +:::info +Please ensure that you are using an organization-validated certificate (OV). We check for the presence of certain elements in the FHIR proxy. These are not set for domain-validated (DV) certificates. DV-validated certificates cannot be used in the standard setup. +::: + +## Extending or Replacing Trusted Certificate Authorities +X.509 certificates of default trusted CAs are stored as individual .pem files containing one certificate each in the docker images and can be replaced by either using docker [bind mounts](https://docs.docker.com/engine/storage/bind-mounts) or configuring appropriate environment variables with different targets. + +### FHIR Reverse Proxy +Defaults are configured for the list of issuing, intermediate and root CAs used for validating client certificates (Apache httpd mod_ssl configuration option [SSLCACertificatePath](https://httpd.apache.org/docs/2.4/mod/mod_ssl.html#sslcacertificatepath)) as well as the CA Certificates for defining acceptable CA names (option [SSLCADNRequestPath](https://httpd.apache.org/docs/2.4/mod/mod_ssl.html#sslcadnrequestpath)). The default values of the following environment variables point to folders containing .pem files with one file per trusted CA: +* [SSL_CA_CERTIFICATE_PATH](fhir-reverse-proxy/configuration.html#ssl-ca-certificate-path) + Default Value: `ca/client_ca_chains` + Default Folder Content: [client_ca_chains.zip](/download/2.1.0/client_ca_chains.zip) +* [SSL_CA_DN_REQUEST_PATH](fhir-reverse-proxy/configuration.html#ssl-ca-dn-request-path) + Default Value: `ca/client_issuing_cas` + Default Folder Content: [client_issuing_cas.zip](/download/2.1.0/client_issuing_cas.zip) + +Use docker bind mounts to replace all default files or add additional CAs to the folders. + +**Note:** Default file location are relative to the docker image work directory `/usr/local/apache2`. +**Also Note:** Using non default .pem files for the environment variables above may require also modifying the default values of the environment variables [SSL_EXPECTED_CLIENT_S_DN_C_VALUES](fhir-reverse-proxy/configuration.html#ssl-expected-client-s-dn-c-values) and [SSL_EXPECTED_CLIENT_I_DN_CN_VALUES](fhir-reverse-proxy/configuration.html#ssl-expected-client-i-dn-cn-values). + +### FHIR Server +Defaults are configured for the list of issuing, intermediate and root CAs used for validating client certificates as well as root CAs used for validating server certificates of remote DSF FHIR servers and the OIDC provider when using [OpenID Connect](fhir/oidc.html) for authenticating local users. + +**Note:** Default file location are relative to the docker image work directory `/opt/fhir`. + +You can add an additional certificate authority (e.g., your hospital CA) for + +- server certificates by creating a bind-mount of the CA file into the `/opt/fhir/ca/server_root_cas/` directory +- client certificates by creating bind-mounts of the intermediate CA files and their root CA file into the `/opt/fhir/ca/client_ca_chains/` directory. + +See the [BPE Server configuration](#bpe-server) for an example. + +If you can't override the default configuration with bind-mounts, you can use the following environment variables to configure non default .pem file directories or .pem file: +* [DEV_DSF_SERVER_AUTH_TRUST_CLIENT_CERTIFICATE_CAS](fhir/configuration.html#dev-dsf-server-auth-trust-client-certificate-cas) + Default Value: `ca/client_ca_chains` + Default Folder Content: [client_ca_chains.zip](/download/2.1.0/client_ca_chains.zip) +* [DEV_DSF_FHIR_CLIENT_TRUST_SERVER_CERTIFICATE_CAS](fhir/configuration.html#dev-dsf-fhir-client-trust-server-certificate-cas) + Default Value: `ca/server_root_cas` + Default Folder Content: [server_root_cas.zip](/download/2.1.0/server_root_cas.zip) +* [DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TRUST_SERVER_CERTIFICATE_CAS](fhir/configuration.html#dev-dsf-server-auth-oidc-provider-client-trust-server-certificate-cas) + Default Value: `ca/server_root_cas` + Default Folder Content: [server_root_cas.zip](/download/2.1.0/server_root_cas.zip) + +### BPE Reverse Proxy +Defaults are configured for the list of issuing, intermediate and root CAs used for validating client certificates (Apache httpd mod_ssl configuration option [SSLCACertificatePath](https://httpd.apache.org/docs/2.4/mod/mod_ssl.html#sslcacertificatepath)) as well as the CA Certificates for defining acceptable CA names (option [SSLCADNRequestPath](https://httpd.apache.org/docs/2.4/mod/mod_ssl.html#sslcadnrequestpath)). The default values of the following environment variables point to folders containing .pem files with one file per trusted CA: +* [SSL_CA_CERTIFICATE_PATH](bpe-reverse-proxy/configuration.html#ssl-ca-certificate-path) + Default Value: `ca/client_ca_chains` + Default Folder Content: [client_ca_chains.zip](/download/2.1.0/client_ca_chains.zip) +* [SSL_CA_DN_REQUEST_PATH](bpe-reverse-proxy/configuration.html#ssl-ca-dn-request-path) + Default Value: `ca/client_issuing_cas` + Default Folder Content: [client_issuing_cas.zip](/download/2.1.0/client_issuing_cas.zip) + +Use docker bind mounts to replace all default files or add additional CAs to the folders. + +**Note:** Default file location are relative to the docker image work directory `/usr/local/apache2`. +**Also Note:** Using non default .pem files for the environment variables above may require also modifying the default values of the environment variables [SSL_EXPECTED_CLIENT_S_DN_C_VALUES](bpe-reverse-proxy/configuration.html#ssl-expected-client-s-dn-c-values) and [SSL_EXPECTED_CLIENT_I_DN_CN_VALUES](bpe-reverse-proxy/configuration.html#ssl-expected-client-i-dn-cn-values). + +### BPE Server +Defaults are configured for the list of issuing, intermediate and root CAs used for validating client certificates as well as root CAs used for validating server certificates of local and remote DSF FHIR servers, the local mail server (if configured and SMTP over TLS required) and the OIDC provider when using [OpenID Connect](fhir/oidc.html) for authenticating local users. + +**Note:** Default file location are relative to the docker image work directory `/opt/bpe`. + +You can add an additional certificate authority (e.g., your hospital CA) for + +- server certificates by creating a bind-mount of the CA file into the `/opt/bpe/ca/server_root_cas/` directory +- client certificates by creating bind-mounts of the intermediate CA files and their root CA file into the `/opt/bpe/ca/client_ca_chains/` directory. + +If you have an additional certificate authority (e.g., your hospital CA) as `hospital-root-ca.pem` in your `/opt/bpe/secrets` directory, you can add it by adding the following entry in your docker-compose.yml file: + +```diff +services: + app: +... + volumes: ++ - type: bind ++ source: ./secrets/hospital-root-ca.pem ++ target: /opt/bpe/ca/server_root_cas/hospital-root-ca.pem ++ read_only: true +``` + +Use the following environment variable to configure non default .pem files or override the existing files using docker bind mounts: +* [DEV_DSF_SERVER_AUTH_TRUST_CLIENT_CERTIFICATE_CAS](bpe/configuration.html#dev-dsf-server-auth-trust-client-certificate-cas) + Default Value: `ca/client_ca_chains` + Default Folder Content: [client_ca_chains.zip](/download/2.1.0/client_ca_chains.zip) +* [DEV_DSF_BPE_FHIR_CLIENT_TRUST_SERVER_CERTIFICATE_CAS](bpe/configuration.html#dev-dsf-bpe-fhir-client-trust-server-certificate-cas) + Default Value: `ca/server_root_cas` + Default Folder Content: [server_root_cas.zip](/download/2.1.0/server_root_cas.zip) + [DEV_DSF_BPE_MAIL_TRUST_SERVER_CERTIFICATE_CAS](bpe/configuration.html#dev-dsf-bpe-mail-trust-server-certificate-cas) + Default Value: `ca/server_root_cas` + Default Folder Content: [server_root_cas.zip](/download/2.1.0/server_root_cas.zip) +* [DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TRUST_SERVER_CERTIFICATE_CAS](bpe/configuration.html#dev-dsf-server-auth-oidc-provider-client-trust-server-certificate-cas) + Default Value: `ca/server_root_cas` + Default Folder Content: [server_root_cas.zip](/download/2.1.0/server_root_cas.zip) + +## List of Default Trusted Certificate Authorities +If not mentioned explicitly, issuing CAs listed will sign X.509 certificates with [Extended Key Usage](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12) entries `TLS WWW server authentication` and `TLS WWW client authentication`. + +* Root CA: **HARICA TLS ECC Root CA 2021** + Info: https://crt.sh/?caid=202185 + X509 Certificate: https://crt.sh/?id=4147045948 + Not after: Feb 13 11:01:09 2045 GMT + * Issuing CA: **GEANT TLS ECC 1** + Info: https://crt.sh/?caid=390050 + X509 Certificate: https://crt.sh/?id=16099180990 + Not after: Dec 31 11:14:20 2039 GMT + * Issuing CA: **HARICA OV TLS ECC** + Info: https://crt.sh/?caid=207661 + X509 Certificate: https://crt.sh/?id=4442848530 + Not after: Mar 15 09:33:51 2036 GMT +* Root CA: **HARICA TLS RSA Root CA 2021** + Info: https://crt.sh/?caid=202184 + X509 Certificate: https://crt.sh/?id=4147041876 + Not after: Feb 13 10:55:37 2045 GMT + * Issuing CA: **GEANT TLS RSA 1** + Info: https://crt.sh/?caid=390054 + X509 Certificate: https://crt.sh/?id=16099180997 + Not after: Dec 31 11:14:59 2039 GMT + * Issuing CA: **HARICA OV TLS RSA** + Info: https://crt.sh/?caid=207660 + X509 Certificate: https://crt.sh/?id=4442848529 + Not after: Mar 15 09:34:16 2036 GMT +* Root CA: **HARICA Client ECC Root CA 2021** [client certificates only] + Info: https://crt.sh/?caid=202189 + X509 Certificate: https://crt.sh/?id=4147052292 + Not after: Feb 13 11:03:33 2045 GMT + * Issuing CA: **GEANT S/MIME ECC 1** [client certificates only] + Info: https://crt.sh/?caid=390048 + X509 Certificate: https://crt.sh/?id=16099180988 + Not after: Dec 31 11:11:39 2039 GMT + * Issuing CA: **HARICA S/MIME ECC** [client certificates only] + Info: https://crt.sh/?caid=207659 + X509 Certificate: https://crt.sh/?id=4442848523 + Not after: Mar 15 09:36:57 2036 GMT + * Issuing CA: **HARICA Client Authentication ECC** [client certificates only] + Info: https://crt.sh/?caid=207671 + X509 Certificate: https://crt.sh/?id=4442848518 + Not after: Mar 15 09:17:38 2036 GMT +* Root CA: **HARICA Client RSA Root CA 2021** [client certificates only] + Info: https://crt.sh/?caid=202188 + X509 Certificate: https://crt.sh/?id=4147049674 + Not after: Feb 13 10:58:45 2045 GMT + * Issuing CA: **GEANT S/MIME RSA 1** [client certificates only] + Info: https://crt.sh/?caid=390049 + X509 Certificate: https://crt.sh/?id=16099180989 + Not after: Dec 31 11:13:07 2039 GMT + * Issuing CA: **HARICA S/MIME RSA** [client certificates only] + Info: https://crt.sh/?caid=207658 + X509 Certificate: https://crt.sh/?id=4442848517 + Not after: Mar 15 09:37:37 2036 GMT + * Issuing CA: **HARICA Client Authentication RSA** [client certificates only] + Info: https://crt.sh/?caid=207670 + X509 Certificate: https://crt.sh/?id=4442848531 + Not after: Mar 15 09:19:36 2036 GMT +* Root CA: **T-TeleSec GlobalRoot Class 2** [client certificates only, will be removed in a future release, incl. derived CAs] + Info: https://crt.sh/?caid=6068 + X509 Certificate: https://crt.sh/?id=8733622 + Not after: Oct 1 23:59:59 2033 GMT + * Intermediate Root CA: **DFN-Verein Certification Authority 2** [client certificates only, will be removed in a future release, incl. derived CAs] + Info: https://crt.sh/?caid=22818 + X509 Certificate: https://crt.sh/?id=23908438 + Not after: Feb 22 23:59:59 2031 GMT + * Issuing CA: **DFN-Verein Global Issuing CA** [client certificates only, no new certificates] + Info: https://crt.sh/?caid=23770 + X509 Certificate: https://crt.sh/?id=25484751 + Not after: Feb 22 23:59:59 2031 GMT + * Issuing CA: **Fraunhofer User CA - G02** [client certificates only, no new certificates] + Info: https://crt.sh/?caid=23772 + X509 Certificate: https://crt.sh/?id=25484789 + Not after: Feb 22 23:59:59 2031 GMT +* Root CA: **D-TRUST Root Class 3 CA 2 2009** + Info: https://crt.sh/?caid=712 + X509 Certificate: https://crt.sh/?id=133226 + Not after: Nov 5 08:35:58 2029 GMT + * Issuing CA: **D-TRUST SSL Class 3 CA 1 2009** [server certificates via TMF e.V.] + Info: https://crt.sh/?caid=713 + X509 Certificate: https://crt.sh/?id=133227 + Not after: Nov 5 08:35:58 2029 GMT +* Root CA: **D-TRUST BR Root CA 1 2020 (ECC)**, optionally crosssigned by D-TRUST Root Class 3 CA 2 2009 [server only] + Info: https://crt.sh/?caid=192951 + X509 Certificate: https://crt.sh/?id=3699642382 and https://crt.sh/?id=19754747817 + Not after: Feb 11 09:44:59 2035 +* Root CA: **D-TRUST BR Root CA 2 2023 (RSA)**, optionally crosssigned by D-TRUST Root Class 3 CA 2 2009 [server only] + Info: https://crt.sh/?caid=266681 + X509 Certificate: https://crt.sh/?id=9609658147 and https://crt.sh/?id=19754898942 + Not after: May 9 08:56:30 2038 GMT + +* Root CA: **USERTrust ECC Certification Authority** [will be removed in a future release, incl. derived CAs] + Info: https://crt.sh/?caid=1390 + X509 Certificate: https://crt.sh/?id=2841410 + Not after: Jan 18 23:59:59 2038 GMT + * Issuing CA: **Sectigo ECC Organization Validation Secure Server CA** + Info: https://crt.sh/?caid=105483 + X509 Certificate: https://crt.sh/?id=924467859 + Not after: Dec 31 23:59:59 2030 GMT + * Issuing CA: **GEANT OV ECC CA 4** + Info: https://crt.sh/?caid=160140 + X509 Certificate: https://crt.sh/?id=2475254970 + * Issuing CA: **GEANT Personal ECC CA 4** [client certificates only] + Info: https://crt.sh/?caid=160136 + X509 Certificate: https://crt.sh/?id=2475254903 + Not after: May 1 23:59:59 2033 GMT + * Issuing CA: **GEANT eScience Personal ECC CA 4** [client certificates only] + Info: https://crt.sh/?caid=160138 + X509 Certificate: https://crt.sh/?id=2475254888 + Not after: May 1 23:59:59 2033 GMT +* Root CA: **USERTrust RSA Certification Authority** [will be removed in a future release, incl. derived CAs] + Info: https://crt.sh/?caid=1167 + X509 Certificate: https://crt.sh/?id=1199354 + Not after: Jan 18 23:59:59 2038 GMT + * Issuing CA: **Sectigo RSA Organization Validation Secure Server CA** + Info: https://crt.sh/?caid=105487 + X509 Certificate: https://crt.sh/?id=924467857 + Not after: Dec 31 23:59:59 2030 GMT + * Issuing CA: **GEANT OV RSA CA 4** + Info: https://crt.sh/?caid=160137 + X509 Certificate: https://crt.sh/?id=2475254782 + Not after: May 1 23:59:59 2033 GMT + * Issuing CA: **GEANT Personal CA 4** [client certificates only] + Info: https://crt.sh/?caid=160144 + X509 Certificate: https://crt.sh/?id=2475255043 + Not after: May 1 23:59:59 2033 GMT + * Issuing CA: **GEANT eScience Personal CA 4** [client certificates only] + Info: https://crt.sh/?caid=160134 + X509 Certificate: https://crt.sh/?id=2475253350 + Not after: May 1 23:59:59 2033 GMT +* Root CA: **D-TRUST Limited Basic Root CA 1 2019** [client certificates only] + X509 Certificate: https://www.d-trust.net/cgi-bin/D-TRUST_Limited_Basic_Root_CA_1_2019.crt + Not after: Jun 19 08:15:51 2034 GMT + * Issuing CA: **D-TRUST Limited Basic CA 1-2 2019** [client certificates via TMF e.V.] + X509 Certificate: https://www.d-trust.net/cgi-bin/D-TRUST_Limited_Basic_CA_1-2_2019.crt + Not after: Jun 19 08:15:51 2034 GMT + * Issuing CA: **D-TRUST Limited Basic CA 1-3 2019** [client certificates via TMF e.V.] + X509 Certificate: https://www.d-trust.net/cgi-bin/D-TRUST_Limited_Basic_CA_1-3_2019.crt + Not after: Jun 19 08:15:51 2034 GMT +* Root CA: **DFN-Verein Community Root CA 2022** [client certificates only] + X509 Certificate: https://doku.tid.dfn.de/_media/de:dfnpki:ca:dfn-verein_community_root_ca_2022.pem + Not after: Jan 21 14:08:41 2042 GMT + * Issuing CA: **DFN-Verein Community Issuing CA 2022** [client certificates only] + X509 Certificate: https://doku.tid.dfn.de/_media/de:dfnpki:ca:dfn-verein_community_issuing_ca_2022.pem + Not after: Jan 21 14:08:41 2042 GMT + * Issuing CA: **Fraunhofer Service CA 2022** [client certificates only] + X509 Certificate: https://doku.tid.dfn.de/_media/de:dfnpki:ca:fraunhofer_service_ca_2022.pem + Not after: Jan 21 14:08:41 2042 GMT + * Issuing CA: **Fraunhofer User CA 2022** [client certificates only] + X509 Certificate: https://doku.tid.dfn.de/_media/de:dfnpki:ca:fraunhofer_user_ca_2022.pem + Not after: Jan 21 14:08:41 2042 GMT + * Issuing CA: **MPG Community CA** [client certificates only] + X509 Certificate: https://doku.tid.dfn.de/_media/de:dfnpki:ca:mpg_community_ca.pem + Not after: Jan 21 14:08:41 2042 GMT + +--- + +## Image Verification +Source: https://dsf.dev/operations/latest/image-verification.html + +# How to Verify Image Signatures + +Starting with DSF 2.1.0, all official Docker images published to [ghcr.io/datasharingframework](https://github.com/orgs/datasharingframework/packages) are signed using [Cosign](https://docs.sigstore.dev/cosign/overview/) with [keyless signing](https://docs.sigstore.dev/cosign/signing/overview/) backed by GitHub's OIDC identity provider. Each image additionally has a CycloneDX SBOM attached to the registry, which is signed the same way. + +Verifying signatures before pulling images into production is strongly recommended. It ensures that the image was built and published by the official DSF GitHub Actions release workflow and has not been tampered with. + +## Prerequisites + +- [Cosign](https://docs.sigstore.dev/cosign/installation/) v2.0 or newer installed on the host running the verification. +- Network access to `ghcr.io` and the public Sigstore transparency log (`rekor.sigstore.dev`). +- The exact image digest (`sha256:...`) of the image you want to verify. The digest can be looked up on the [GitHub package page](https://github.com/orgs/datasharingframework/packages) of the respective image or via: + + ```bash + docker buildx imagetools inspect ghcr.io/datasharingframework/: + ``` + +::: warning Always pin the digest +Verifying by tag alone (`:2.1.0`) is not sufficient — tags can be reassigned. Always include the immutable `@sha256:` in the verification command and in your production `docker-compose.yml`. +::: + +## Verify the Image Signature + +A successful verification prints the verified claims to stdout and exits with status `0`. The certificate identity confirms the signature was created by a workflow inside the `datasharingframework/dsf` repository, the OIDC issuer confirms it was a GitHub Actions run. + +The commands below are pre-filled with the correct image tag for this release. Replace `` with the digest you looked up for the image you intend to deploy. + +### FHIR Server (`fhir`) + +- Image: [`ghcr.io/datasharingframework/fhir`](https://github.com/datasharingframework/dsf/pkgs/container/fhir) + +```bash +cosign verify \ + ghcr.io/datasharingframework/fhir:2.1.0@sha256:71599af143f0262a7265aa2bc4ea5a9660f11de6248a053e060b5667070203fd \ + --certificate-identity-regexp "https://github.com/datasharingframework/dsf/.*" \ + --certificate-oidc-issuer "https://token.actions.githubusercontent.com" +``` + +### FHIR Reverse Proxy (`fhir_proxy`) + +- Image: [`ghcr.io/datasharingframework/fhir_proxy`](https://github.com/datasharingframework/dsf/pkgs/container/fhir_proxy) + +```bash +cosign verify \ + ghcr.io/datasharingframework/fhir_proxy:2.1.0@sha256:9f11a3580c970314532f5951808be6fe72f1de7d53348e625d2dd0c95bcf1d96 \ + --certificate-identity-regexp "https://github.com/datasharingframework/dsf/.*" \ + --certificate-oidc-issuer "https://token.actions.githubusercontent.com" +``` + +### BPE Server (`bpe`) + +- Image: [`ghcr.io/datasharingframework/bpe`](https://github.com/datasharingframework/dsf/pkgs/container/bpe) + +```bash +cosign verify \ + ghcr.io/datasharingframework/bpe:2.1.0@sha256:3ee7ef0ac201fc3776273fbfc2569bdc4edf724a2bb9f1b4a889eb7e13ff4049 \ + --certificate-identity-regexp "https://github.com/datasharingframework/dsf/.*" \ + --certificate-oidc-issuer "https://token.actions.githubusercontent.com" +``` + +### BPE Reverse Proxy (`bpe_proxy`) + +- Image: [`ghcr.io/datasharingframework/bpe_proxy`](https://github.com/datasharingframework/dsf/pkgs/container/bpe_proxy) + +```bash +cosign verify \ + ghcr.io/datasharingframework/bpe_proxy:2.1.0@sha256:c67da4a1720ea75a383764db2bf25619fe70f57773b1069029f5b49588eb1ecc \ + --certificate-identity-regexp "https://github.com/datasharingframework/dsf/.*" \ + --certificate-oidc-issuer "https://token.actions.githubusercontent.com" +``` + +## Verify the SBOM Attestation + +Each image has a signed CycloneDX SBOM attached. Substitute `` with one of `fhir`, `fhir_proxy`, `bpe`, `bpe_proxy` and `` with the digest of the image you are verifying: + +```bash +cosign verify-attestation \ + --type cyclonedx \ + ghcr.io/datasharingframework/:2.1.0@sha256: \ + --certificate-identity-regexp "https://github.com/datasharingframework/dsf/.*" \ + --certificate-oidc-issuer "https://token.actions.githubusercontent.com" +``` + +To extract the SBOM payload for further processing (e.g. dependency or vulnerability analysis): + +```bash +cosign download attestation \ + --predicate-type https://cyclonedx.org/bom \ + ghcr.io/datasharingframework/:2.1.0@sha256: \ + | jq -r .payload | base64 -d | jq .predicate > sbom.cdx.json +``` + +## Troubleshooting + +- **`no matching signatures`** — The image was not signed by the official DSF release workflow. Do not use it in production. Re-check the registry path (`ghcr.io/datasharingframework/...`) and the digest. +- **`certificate identity ... did not match`** — The signature exists but was produced by a different repository or workflow. Verify you are pulling from the official `datasharingframework/dsf` org. +- **Network errors against `rekor.sigstore.dev`** — Cosign queries the public transparency log during verification. In air-gapped environments, pre-fetch and cache the log entries, or run cosign with `--insecure-ignore-tlog=true` only after carefully assessing the security implications. + +## Further Reading + +- [Cosign documentation](https://docs.sigstore.dev/cosign/overview/) +- [Sigstore keyless signing](https://docs.sigstore.dev/cosign/signing/overview/) +- [CycloneDX SBOM specification](https://cyclonedx.org/specification/overview/) + +--- + +## Hardening Measures +Source: https://dsf.dev/operations/latest/hardening-measures.html + +# Defense-in-Depth Hardening Measures + +For DSF 2.1.0 we performed a number of IT security hardening measures. The following changes follow security best practices. They reduce risk for non-standard deployments, protect against future code changes that could introduce new attack paths, and align with common security audit expectations. + +Each entry describes the change and why we consider it not exploitable in the standard DSF deployment model. + +## Deployment Context + +The standard DSF deployment uses: + +- **Apache2 reverse proxy** with `mod_ssl` performing TLS termination and client certificate validation (`SSLVerifyClient require`, DN checks against trusted CA list) +- **Docker containers** with network isolation (frontend / backend / inter-service networks) +- **Jetty application** on internal port 8080, not directly reachable from outside +- **Status port** on `127.0.0.1:10000` (localhost only), separate Jetty connector +- **Configuration** via Docker environment variables / secrets, only admin-writable +- **PostgreSQL** not exposed to host, only accessible from the application container + +The assessments below consider this standard deployment. Non-standard deployments (e.g., Jetty directly exposed, no reverse proxy) may have different risk profiles. + +## Improved XML Transformer Configuration + +Disabled external entity resolution and enabled secure processing on `TransformerFactory` instances in `ProcessService`, `ThymeleafTemplateServiceImpl`, and `BundleGenerator`. We consider this not exploitable because although external organizations and authorized users can create FHIR resources (e.g., Tasks), the content never reaches the TransformerFactory as raw XML. The data path is: user input is parsed by HAPI FHIR into a Java object model (stripping any XML-level constructs like DOCTYPE/ENTITY declarations), stored as JSONB in PostgreSQL, and then re-serialized to well-formed XML by HAPI's serializer when displayed. The TransformerFactory only pretty-prints HAPI's serialized output, where all text content is properly XML-escaped. `BundleGenerator` is a Maven build-time tool, not a runtime component. Hardening against CWE-611 (XXE). + +Commit: [`b89c512dc`](https://github.com/datasharingframework/dsf/commit/b89c512dc) + +## Database Username/Group Validation + +Added regex validation (`^[a-zA-Z_][a-zA-Z0-9_$]{0,62}$`) for PostgreSQL identifier config parameters used in DDL statements. We consider this not exploitable because these values come exclusively from admin-managed config files and Docker environment variables — an attacker with write access to these already has full system control. Hardening against CWE-89. + +Commit: [`7e2de0ed8`](https://github.com/datasharingframework/dsf/commit/7e2de0ed8) + +## HTTPS Enforcement for OIDC Endpoints + +Added explicit check that OIDC token and JWKS endpoints use HTTPS. We consider this not exploitable because a compromised OIDC provider can already issue arbitrary tokens directly, making HTTP interception redundant. In the MITM scenario (legitimate provider, network attacker), the provider URL is admin-configured as HTTPS and legitimate providers always return HTTPS endpoints in their discovery documents. In both cases, obtained tokens are constrained by the admin-managed `roleConfig` — no privilege escalation beyond configured roles is possible. Hardening against CWE-918 / CWE-319. + +Commit: [`bdeddf308`](https://github.com/datasharingframework/dsf/commit/bdeddf308) + +## JWKS Minimum Key Size and `use=sig` Filtering + +Added 2048-bit minimum RSA key length and `use=sig` check for JWKS keys used in JWT verification. We consider this not exploitable because no mainstream OIDC provider (Keycloak, etc.) publishes RSA keys below 2048 bits. Even if an attacker could forge tokens via weak keys, privileges are constrained by the admin-managed `roleConfig` — the same limitation as with a compromised OIDC provider. Hardening against CWE-326 / CWE-347. + +Commit: [`31c2e974d`](https://github.com/datasharingframework/dsf/commit/31c2e974d) + +## Removed Access Token Claim Logging + +Removed DEBUG-level logging of token claims (groups, roles) in `AbstractIdentityProvider` and `BearerTokenAuthenticator`. We consider this not exploitable because DEBUG logging is disabled in production by default, and the logged data (group memberships, roles) is operational metadata — not secrets like passwords or signing keys. Hardening against CWE-532. + +Commit: [`cc0bb71ef`](https://github.com/datasharingframework/dsf/commit/cc0bb71ef) + +## Session Cookie Security Attributes + +Added `Secure`, `HttpOnly`, and `SameSite=LAX` flags to session cookies. We consider this not exploitable because TLS is terminated at the Apache HTTP Server reverse proxy (clients only communicate over HTTPS), the `HttpOnly` flag is only relevant if an XSS vulnerability exists (none is exploitable, see `th:utext` below), and `SameSite` has limited impact since primary authentication uses mTLS, not cookies. Hardening against CWE-614 / CWE-1004. + +Commit: [`5cc00611b`](https://github.com/datasharingframework/dsf/commit/5cc00611b) + +## JSON Serialization in JSONB Query Parameters + +Replaced string concatenation with Jackson `ObjectMapper` serialization for JSONB query parameters in all DAO classes and search filters. We consider this not exploitable because user-controlled values are bound via `PreparedStatement.setString()`, which transmits query template and parameter values separately to PostgreSQL — the parameter value is never parsed as SQL and there is no way to inject `JOIN`, `UNION`, or subqueries. Within the JSONB domain, the identity filter (access control) operates as a separate `AND` condition with server-side parameters that cannot be influenced by search parameter manipulation, the `@>` containment operator becomes more restrictive with additional injected elements (not less), and result sets are always a subset of authorized resources — no enumeration of unauthorized data is possible. Hardening against CWE-89. + +Commit: [`37c0282c6`](https://github.com/datasharingframework/dsf/commit/37c0282c6) + +## Client Certificate Expiration Check + +Added explicit certificate expiration check and changed auth type from `"RSA"` to `"UNKNOWN"` in `ClientCertificateAuthenticator`. We consider this not exploitable because the Apache HTTP Server reverse proxy performs TLS termination with `SSLVerifyClient require` and validates certificate expiration, chain trust, and revocation before requests reach Jetty. The Jetty-level check is a redundant second validation. Hardening against CWE-295 / CWE-324. + +Commit: [`c6d369828`](https://github.com/datasharingframework/dsf/commit/c6d369828) + +## Safe YAML Deserialization + +Replaced `new Yaml()` with `new Yaml(new SafeConstructor(new LoaderOptions()))` in `RoleConfigReader`. We consider this not exploitable because the YAML content comes exclusively from admin-managed config files (`config.properties`) and Docker environment variables — an attacker with write access to these can already execute arbitrary code through simpler means. Hardening against CWE-502. + +Commit: [`e0b6cf00a`](https://github.com/datasharingframework/dsf/commit/e0b6cf00a) + +## Thymeleaf `th:utext` Replaced with `th:text` + +Replaced `th:utext` (unescaped HTML output) with `th:text` / `th:each` for page headings built from URL segments. We consider this not exploitable because the old code applied `HtmlUtils.htmlEscape()` to all user inputs before concatenation — this escapes `& < > " '`, preventing tag injection (`<` `>` escaped to `<` `>`) and attribute breakout (`"` escaped to `"`, which per HTML spec does not terminate double-quoted attributes). The fix makes XSS structurally impossible and removes reliance on manual escaping — a future developer could have forgotten the `htmlEscape()` call when adding new URL segments. Hardening against CWE-79. + +Commit: [`58edc26c5`](https://github.com/datasharingframework/dsf/commit/58edc26c5) + +## Error Message Removed from Status Endpoint + +Removed database exception messages from the status endpoint error response body. We consider this not exploitable because the status endpoint runs on a separate Jetty connector (port 10000, bound to `127.0.0.1` only) with role-based access control (`STATUS_PORT_ROLE`) — it is not reachable through the Apache HTTP Server reverse proxy or from outside the Docker container. Hardening against CWE-209. + +Commit: [`5103d0e9d`](https://github.com/datasharingframework/dsf/commit/5103d0e9d) + +## Content Security Policy and Binary Inline Display + +Introduced a new inline display mode for `Binary` resources with a strict CSP (`script-src 'none'`), a media type policy, and `ContentTypeSanitizer`. We consider this not a vulnerability fix because the old code served all `Binary` resources with `Content-Disposition: attachment` (forced download, never rendered in browser), so the old `unsafe-inline` CSP was never reachable. This commit implements a new feature with secure defaults. Hardening against CWE-1021. + +Commit: [`454c1197b`](https://github.com/datasharingframework/dsf/commit/454c1197b) + +--- + +## Upgrade from DSF v1 +Source: https://dsf.dev/operations/latest/upgrade-from-1.html + +Upgrading the DSF from 1.9.0 to 2.1.0 involves modifying the docker-compose.yml files and recreating the containers. + +::: warning Update to DSF 1.9.0 first +When upgrading from DSF version < 1.9.0 it is important to migrate to [DSF 1.9.0 first](../v1.9.0/upgrade-from-1). +::: + +For DSF 2, we refined the [system requirements](install.md#prerequisites). If your current DSF 1 setup works, it should also work with DSF 2. As DSF 2 is designed to support large file transfers, you might need to increase the storage on the DSF FHIR Server instance. + +::: info Non-standard configuration changes + +Most non-standard configuration changes working in DSF 1 will continue to work in DSF 2. If you have set custom timeout options in the DSF configuration (starting with `DEV_DSF_...`) please change them to the ISO 8601 standard. `120000` (Milliseconds) must be changed to `PT2M`. The configuration options for process plugins (e.g., starting with `DE_...`) remain unchanged. + +- You can now use more advanced [logging options](./fhir/logging.md). +- If you use your own certificate authority, the [configuration](root-certificates.md) will be easier. +- More granular control in [access control / role config settings](./fhir/access-control.md). +::: + +We recommend upgrading the PostgreSQL DBMS from version 15 to version 18. At present, it is possible to use PostgreSQL version 15, but we exclusively support PostgreSQL version 18 and test the DSF solely with version 18. +The DBMS upgrade is described below in the update instructions. + +DSF 2 was designed to run DSF 1 (APIv1) process plugins, but due to stricter validation rules in DSF 2 we strongly recommend using the latest compatible plugin versions. Updates within the same major and minor version (e.g., from 1.2.3.4 to 1.2.9.9) are generally safe. An overview of the recommended MII/NUM versions can be found [here](./install-plugins.md). + +## Modify DSF FHIR Server Setup +1. Preparation / Backup + * We recommend to create a backup of the `/opt/fhir` directory before proceeding with the upgrade. + For example using: `sudo cp -rp /opt/fhir /opt/fhir_backup_pre_2.1.0_upgrade` + +2. Modify the DSF FHIR docker-compose.yml file, replace the version number with 2.1.0. +```diff + version: '3.8' + services: + proxy: +- image: ghcr.io/datasharingframework/fhir_proxy:1.9.0 ++ image: ghcr.io/datasharingframework/fhir_proxy:2.1.0 + restart: on-failure +... + app: +- image: ghcr.io/datasharingframework/fhir:1.9.0 ++ image: ghcr.io/datasharingframework/fhir:2.1.0 + restart: on-failure +... + environment: +- DEV_DSF_FHIR_SERVER_ORGANIZATION_THUMBPRINT: f4344032fe77bffb... +... + +``` +The environment variable `DEV_DSF_FHIR_SERVER_ORGANIZATION_THUMBPRINT` does not need to be specified starting version 2.0.0. The thumbprint is now calculated based on the client certificate specified via `DEV_DSF_FHIR_CLIENT_CERTIFICATE`. + + +3. Upgrade the DSF FHIR containers + From `/opt/fhir` execute + ``` + docker compose up -d && docker compose logs -f + ``` + +## Modify DSF BPE Server Setup +1. Preparation / Backup + * We recommend to create a backup of the `/opt/bpe` directory before proceeding with the upgrade. + For example using: `sudo cp -rp /opt/bpe /opt/bpe_backup_pre_2.1.0_upgrade` + +2. Modify the DSF BPE docker-compose.yml file, replace the version number with 2.1.0. +```diff + version: '3.8' + services: + app: +- image: ghcr.io/datasharingframework/bpe:1.9.0 ++ image: ghcr.io/datasharingframework/bpe:2.1.0 + restart: on-failure +... + environment: +- DEV_DSF_BPE_DB_USER_CAMUNDA_PASSWORD_FILE: /run/secrets/db_user_camunda.password ++ DEV_DSF_BPE_DB_USER_ENGINE_PASSWORD_FILE: /run/secrets/db_user_camunda.password +... + +``` + +3. Upgrade the DSF BPE containers + From `/opt/bpe` execute + ``` + docker compose up -d && docker compose logs -f + ``` + +5. Verify your upgrade: + * Verify the DSF FHIR server is running in version 2.1.0. The log should contain a message: + `INFO main - BuildInfoReaderImpl.logBuildInfo(137) | Artifact: dsf-fhir-server-jetty, version: 2.1.0, [...]` + * Verify the DSF FHIR server started without errors + * Verify the DSF FHIR server is accessible via https, for example by browsing to https://your-dsf-endpoint.de/fhir/ (authentication with your client-certificate) + * Verify the DSF BPE server is running in version 2.1.0. The log should contain a message: + `INFO main - BuildInfoReaderImpl.logBuildInfo(137) | Artifact: dsf-bpe-server-jetty, version: 2.1.0, [...]` + * Verify the DSF BPE server started without errors + * Verify your install with a ping/pong test + + +## Upgrade PostgreSQL from 15 to 18 +To upgrade your DSF databases, you have to stop the application, dump your database, recreate the bind mount directory, update the version, start it, restore the backup and start the application again. + +### On the DSF FHIR Server + +1. Stop the application + From `/opt/fhir` execute + ``` + docker compose down app + ``` +2. Dump the database + From `/opt/fhir` execute + ``` + docker compose exec db pg_dumpall -U liquibase_user > dump.sql + ``` +3. Stop the database + From `/opt/fhir` execute + ``` + docker compose down db + ``` +4. Recreate the database bind mount directory + From `/opt/fhir` execute + ``` + mv postgres-data postgres-data-psql-15 + mkdir postgres-data + ``` +5. Update the version and change the bind mount target to respect the [PostgreSQL best practices](https://github.com/docker-library/postgres/pull/1259) in `/opt/fhir/docker-compose.yml` + ```diff + db: + - image: postgres:15 + + image: postgres:18 + restart: always + healthcheck: + test: ["CMD-SHELL", "pg_isready -U liquibase_user -d fhir"] + interval: 10s + timeout: 5s + retries: 5 + volumes: + - type: bind + source: ./postgres-data + - target: /var/lib/postgresql/data + + target: /var/lib/postgresql + ``` +6. Start the new database + From `/opt/fhir` execute + ``` + docker compose up -d db + ``` +7. Restore the database dump + From `/opt/fhir` execute + ``` + cat dump.sql | docker compose exec -T db psql -U liquibase_user fhir + ``` +8. Start the application + From `/opt/fhir` execute + ``` + docker compose up -d && docker compose logs -f app + ``` + +### On the DSF BPE Server + +1. Stop the application + From `/opt/bpe` execute + ``` + docker compose down app + ``` +2. Dump the database + From `/opt/bpe` execute + ``` + docker compose exec db pg_dumpall -U liquibase_user > dump.sql + ``` +3. Stop the database + From `/opt/bpe` execute + ``` + docker compose down db + ``` +4. Recreate the database bind mount directory + From `/opt/bpe` execute + ``` + mv postgres-data postgres-data-psql-15 + mkdir postgres-data + ``` +5. Update the version and change the bind mount target to respect the [PostgreSQL best practices](https://github.com/docker-library/postgres/pull/1259) in `/opt/bpe/docker-compose.yml` + ```diff + db: + - image: postgres:15 + + image: postgres:18 + restart: always + healthcheck: + test: ["CMD-SHELL", "pg_isready -U liquibase_user -d bpe"] + interval: 10s + timeout: 5s + retries: 5 + volumes: + - type: bind + source: ./postgres-data + - target: /var/lib/postgresql/data + + target: /var/lib/postgresql + ``` +6. Start the new database + From `/opt/bpe` execute + ``` + docker compose up -d db + ``` +7. Restore the database dump + From `/opt/bpe` execute + ``` + cat dump.sql | docker compose exec -T db psql -U liquibase_user bpe + ``` +8. Start the application + From `/opt/bpe` execute + ``` + docker compose up -d && docker compose logs -f app + ``` + +Once you have ensured that DSF is working successfully with the new database, you can remove the dump.sql file and the postgres-data-psql-15 directory. As a precaution, we recommend keeping the postgres-data-psql-15 directory for some time. + +--- + +## Upgrade within DSF v2 +Source: https://dsf.dev/operations/latest/upgrade-from-2.html + +Upgrading the DSF from 2.0.2 to 2.1.0 involves modifying the image versions in the docker-compose.yml files and recreating the containers. + + +DSF 2 was designed to run DSF 1 (APIv1) process plugins, but due to stricter validation rules in DSF 2 we strongly recommend using the latest compatible plugin versions. Updates within the same major and minor version (e.g., from 1.2.3.4 to 1.2.9.9) are generally safe. An overview of the recommended MII/NUM versions can be found [here](./install-plugins.md). + +If you have installed the NUM Dashboard Process Plugin, you can [remove the workaround](./install-plugins.md). + +## Modify DSF FHIR Server Setup +1. Preparation / Backup + * We recommend to create a backup of the `/opt/fhir` directory before proceeding with the upgrade. + For example using: `sudo cp -rp /opt/fhir /opt/fhir_backup_pre_2.1.0_upgrade` + +2. Modify the DSF FHIR docker-compose.yml file, replace the version number with 2.1.0. +```diff + version: '3.8' + services: + proxy: +- image: ghcr.io/datasharingframework/fhir_proxy:2.0.2 ++ image: ghcr.io/datasharingframework/fhir_proxy:2.1.0 + restart: on-failure +... + app: +- image: ghcr.io/datasharingframework/fhir:2.0.2 ++ image: ghcr.io/datasharingframework/fhir:2.1.0 + restart: on-failure +... + +``` + + + +3. Upgrade the DSF FHIR containers + From `/opt/fhir` execute + ``` + docker compose up -d && docker compose logs -f + ``` + +## Modify DSF BPE Server Setup +1. Preparation / Backup + * We recommend to create a backup of the `/opt/bpe` directory before proceeding with the upgrade. + For example using: `sudo cp -rp /opt/bpe /opt/bpe_backup_pre_2.1.0_upgrade` + +2. Modify the DSF BPE docker-compose.yml file, replace the version number with 2.1.0. +```diff + version: '3.8' + services: + app: +- image: ghcr.io/datasharingframework/bpe:2.0.2 ++ image: ghcr.io/datasharingframework/bpe:2.1.0 + restart: on-failure +... + + +``` + +3. Upgrade the DSF BPE containers + From `/opt/bpe` execute + ``` + docker compose up -d && docker compose logs -f + ``` + +5. Verify your upgrade: + * Verify the DSF FHIR server is running in version 2.1.0. The log should contain a message: + `INFO main - BuildInfoReaderImpl.logBuildInfo(137) | Artifact: dsf-fhir-server-jetty, version: 2.1.0, [...]` + * Verify the DSF FHIR server started without errors + * Verify the DSF FHIR server is accessible via https, for example by browsing to https://your-dsf-endpoint.de/fhir/ (authentication with your client-certificate) + * Verify the DSF BPE server is running in version 2.1.0. The log should contain a message: + `INFO main - BuildInfoReaderImpl.logBuildInfo(137) | Artifact: dsf-bpe-server-jetty, version: 2.1.0, [...]` + * Verify the DSF BPE server started without errors + * Verify your install with a ping/pong test + +--- + +## OIDC Configuration (FHIR) +Source: https://dsf.dev/operations/latest/fhir/oidc.html + +## Overview +Access to the DSF FHIR server REST API and user interface can be configured via [access control roles](access-control). By default users are only authenticated using X.509 client certificates, but authentication for local users via OAuth 2.0 OpenID Connect can also be enabled. + +The DSF FHIR server supports [Authorization Code Flow](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth) for the user interface as well as [Bearer Token Authentication](https://datatracker.ietf.org/doc/html/rfc6750) for the REST API. [Back-Channel Logout](https://openid.net/specs/openid-connect-backchannel-1_0.html) is also supported. + + +::: tip FHIR Reverse Proxy +The DSF FHIR reverse proxy requires client certificates by default. To use OpenID Connect authentication the configuration parameter [SSL_VERIFY_CLIENT](../fhir-reverse-proxy/configuration.html#ssl-verify-client) needs to be set to `optional`. +::: + + +## Authorization Code Flow + +To enable authentication via OpenID Connect authorization code flow, set the configuration parameter [DEV_DSF_SERVER_AUTH_OIDC_AUTHORIZATION_CODE_FLOW](configuration#dev-dsf-server-auth-oidc-authorization-code-flow) to `true` and specify the following parameters: + +- [DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL](configuration#dev-dsf-server-auth-oidc-provider-realm-base-url) +- [DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID](configuration#dev-dsf-server-auth-oidc-client-id) +- [DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET](configuration#dev-dsf-server-auth-oidc-client-secret) + +Optionally, back channel logout can be enabled by setting [DEV_DSF_SERVER_AUTH_OIDC_BACK_CHANNEL_LOGOUT](configuration#dev-dsf-server-auth-oidc-back-channel-logout) to `true`. The DSF FHIR server accepts logout tokens at [DEV_DSF_FHIR_SERVER_BASE_URL](configuration#dev-dsf-fhir-server-base-url) + `/back-channel-logout`. The path can be modified via [DEV_DSF_SERVER_AUTH_OIDC_BACK_CHANNEL_LOGOUT_PATH](configuration#dev-dsf-server-auth-oidc-back-channel-logout-path). + + +## Bearer Token Authentication + +To enable bearer token authentication, set the configuration parameter [DEV_DSF_SERVER_AUTH_OIDC_BEARER_TOKEN](configuration#dev-dsf-server-auth-oidc-bearer-token) to `true` and specify the following parameter: +- [DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL](configuration#dev-dsf-server-auth-oidc-provider-realm-base-url) + + +## Additional ODIC Configuration Parameter + +A number of additional `DEV_DSF_SERVER_AUTH_OIDC ...` configuration parameter are specify on the DSF FHIR server [configuration parameter page](configuration). + +For example the configuration parameter [DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TRUST_SERVER_CERTIFICATE_CAS](configuration#dev-dsf-server-auth-oidc-provider-client-trust-server-certificate-cas) can be used to specify a PEM encoded file with trusted root certificates to be used when accessing the OpenID Connect provider. If not specify the JVM default trusted root certificates are used for this connection. + + +## Example +```yaml +services: + app: + image: ghcr.io/datasharingframework/fhir:1.5.2 + # ... + secrets: + - keycloak_root_ca.pem + # ... + environment: + # ... + DEV_DSF_SERVER_AUTH_OIDC_AUTHORIZATION_CODE_FLOW: 'true' + DEV_DSF_SERVER_AUTH_OIDC_BACK_CHANNEL_LOGOUT: 'true' + DEV_DSF_SERVER_AUTH_OIDC_BEARER_TOKEN: 'true' + DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL: https://keycloak.test.org/realms/dsf + DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TRUST_SERVER_CERTIFICATE_CAS: /run/secrets/keycloak_root_ca.pem + DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID: dsf-fhir + DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET: n9bCMtjugv3Y_.szktXyQ2RH5se+J%o3 + # ... +secrets: + keycloak_root_ca.pem: + file: ./secrets/keycloak_root_ca.pem +``` + +--- + +## OIDC Configuration (BPE) +Source: https://dsf.dev/operations/latest/bpe/oidc.html + +## Overview +Access to the DSF BPE server user interface can be configured via [access control roles](access-control). By default users are only authenticated using X.509 client certificates, but authentication for local users via OAuth 2.0 OpenID Connect can also be enabled. + +The DSF BPE server supports [Authorization Code Flow](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth) for the user interface. [Back-Channel Logout](https://openid.net/specs/openid-connect-backchannel-1_0.html) is also supported. + + +::: tip BPE Reverse Proxy +The DSF BPE reverse proxy requires client certificates by default. To use OpenID Connect authentication the configuration parameter [SSL_VERIFY_CLIENT](../bpe-reverse-proxy/configuration.html#ssl-verify-client) needs to be set to `optional`. +::: + + +## Authorization Code Flow + +To enable authentication via OpenID Connect authorization code flow, set the configuration parameter [DEV_DSF_SERVER_AUTH_OIDC_AUTHORIZATION_CODE_FLOW](configuration#dev-dsf-server-auth-oidc-authorization-code-flow) to `true` and specify the following parameters: + +- [DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL](configuration#dev-dsf-server-auth-oidc-provider-realm-base-url) +- [DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID](configuration#dev-dsf-server-auth-oidc-client-id) +- [DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET](configuration#dev-dsf-server-auth-oidc-client-secret) + +Optionally, back channel logout can be enabled by setting [DEV_DSF_SERVER_AUTH_OIDC_BACK_CHANNEL_LOGOUT](configuration#dev-dsf-server-auth-oidc-back-channel-logout) to `true`. The DSF BPE server accepts logout tokens at [DEV_DSF_BPE_SERVER_BASE_URL](configuration#dev-dsf-bpe-server-base-url) + `/back-channel-logout`. The path can be modified via [DEV_DSF_SERVER_AUTH_OIDC_BACK_CHANNEL_LOGOUT_PATH](configuration#dev-dsf-server-auth-oidc-back-channel-logout-path). + +## Additional ODIC Configuration Parameter + +A number of additional `DEV_DSF_SERVER_AUTH_OIDC ...` configuration parameter are specify on the DSF BPE server [configuration parameter page](configuration). + +For example the configuration parameter [DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TRUST_SERVER_CERTIFICATE_CAS](configuration#dev-dsf-server-auth-oidc-provider-client-trust-server-certificate-cas) can be used to specify a PEM encoded file with trusted root certificates to be used when accessing the OpenID Connect provider. If not specify the JVM default trusted root certificates are used for this connection. + + +## Example +```yaml +services: + app: + image: ghcr.io/datasharingframework/bpe:1.5.2 + # ... + secrets: + - keycloak_root_ca.pem + # ... + environment: + # ... + DEV_DSF_SERVER_AUTH_OIDC_AUTHORIZATION_CODE_FLOW: 'true' + DEV_DSF_SERVER_AUTH_OIDC_BACK_CHANNEL_LOGOUT: 'true' + DEV_DSF_SERVER_AUTH_OIDC_BEARER_TOKEN: 'true' + DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL: https://keycloak.test.org/realms/dsf + DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TRUST_SERVER_CERTIFICATE_CAS: /run/secrets/keycloak_root_ca.pem + DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID: dsf-bpe + DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET: n9bCMtjugv3Y_.szktXyQ2RH5se+J%o3 + # ... +secrets: + keycloak_root_ca.pem: + file: ./secrets/keycloak_root_ca.pem +``` + +--- + +## Access Control (FHIR) +Source: https://dsf.dev/operations/latest/fhir/access-control.html + +## Overview + +The DSF FHIR server implements a subset of the FHIR R4 [REST API](http://hl7.org/fhir/R4/http.html). When accessing the API with a web browser a limited graphical user interface is shown. Without any additional configuration the API and user interface is only accessible with the X.509 client certificate configured for the organization via the client certificate configuration parameter [DEV_DSF_FHIR_CLIENT_CERTIFICATE](configuration##dev-dsf-fhir-client-certificate) or the manual override option [DEV_DSF_FHIR_SERVER_ORGANIZATION_THUMBPRINT](configuration#dev-dsf-fhir-server-organization-thumbprint). + +::: tip OpenID Connect +To enable OpenID Connect authentication of local user, see the DSF FHIR server OpenID Connect [configuration page](oidc). +::: + +Access to the API and user interface can be enabled for additional client certificates and local users authenticating via OAuth 2.0 OpenID Connect. Access can be configured for so called roles, with all roles specified using the configuration parameter [DEV_DSF_FHIR_SERVER_ROLECONFIG](configuration#dev-dsf-fhir-server-roleconfig). The value for this environment variable is specified as YAML using the block scalar `|`. + +The listing below shows a minimal configuration to enable read access for all resources for a specific client-certificate: + +```yaml + DEV_DSF_FHIR_SERVER_ROLECONFIG: | + - example_read_only_role: + thumbprint: 00474993fa261b0225f93c5a66aa6fcc... [a-f0-9]{128} + dsf-role: + - READ + - SEARCH + - HISTORY +``` + +The list of user roles above contains a single rule-entry `example_read_only_role`, matching the user via a client certificate SHA-512 thumbprint and assigning three DSF roles. Any string can be used as the name for the rule-entry. + +With DSF 2, you can now restrict the granted priviledges to specific resource types. If you want to restrict the rule-entry `example_read_only_role` to Organization resources, you can specify the resource type per dsf-role ("action"): + +```yaml + DEV_DSF_FHIR_SERVER_ROLECONFIG: | + - example_read_only_organization_role: + thumbprint: 00474993fa261b0225f93c5a66aa6fcc... [a-f0-9]{128} + dsf-role: + - READ: [Organization] + - SEARCH: [Organization] + - HISTORY: [Organization] +``` + +::: tip Certificate Thumbprints +SHA-512 certificate thumbprints in HEX form `[a-f0-9]{128}` can be calculated using: +```sh +certtool --fingerprint --hash=sha512 --infile=certificate.pem +``` +::: + +Multiple user roles can be specified and all matching roles will be applied to an authenticated users. Use an empty string `""` or a single block scalar `|` character as the value for the configuration parameter [DEV_DSF_FHIR_SERVER_ROLECONFIG](configuration#dev-dsf-fhir-server-roleconfig) if no roles should be configured. + +## Matching Users + +To apply roles, users can be matched via the `thumbprint`, `email`, `token-role` or `token-group` properties. A single value or a list of values can be specified. + +#### thumbprint + +The property `thumbprint` can used to specify one or multiple SHA-512 certificate thumbprints. Roles from this rule are applied to the authenticating user if the certificate matches one of the specified thumbprints. + +#### email + +Using the property `email` users can be matched against e-mail addresses specified in X.509 client certificates and in OpenID Connect access tokens. Values will be matched against e-mail addresses specified in the subject DN (via PKCS#9 extension 1.2.840.113549.1.9.1) and RFC-822 Name entries of the Subject Alternative Name field. If the user authenticates via OpenID Connect, the `email` [claim](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims) from the access token will be matched against the property values. + +#### token-role and token-group + +With the properties `token-role` and `token-group` role and group names can be specified to match against role and group claims within OAuth 2.0 access tokens. + + +## DSF and Practitioner Roles + +Two types of roles can be applied to matched users. + +#### dsf-role + +DSF roles specified via the `dsf-role` property define general access to the REST API and user interface. Allowed values are: + +`CREATE`, `READ`, `UPDATE`, `DELETE`, `SEARCH`, `HISTORY`, `PERMANENT_DELETE` and `WEBSOCKET`. + + +#### practitioner-role + +In order to allow users to start processes, the property `practitioner-role` can be used to assign codes from FHIR [CodeSystem](http://hl7.org/fhir/R4/codesystem.html) resources. Codes are specified in the form `system-url|code`. +If the uses has a code specified here that match with a `requester` extension within the process plugin's [ActivityDefinition](http://hl7.org/fhir/R4/activitydefinition.html) resource, the user can start the process if he also has the `dsf-role` `CREATE`. + +Process plugins can define and use their own code-systems. However, the DSF specifies a standard set of practitioner roles within the CodeSystem `http://dsf.dev/fhir/CodeSystem/practitioner-role`: + +`UAC_USER`, `COS_USER`, `CRR_USER`, `DIC_USER`, `DMS_USER`, `DTS_USER`, `HRP_USER`, `TTP_USER`, `AMS_USER`, `ASP_USER`, `SPR_USER`, `TSP_USER`, `PPH_USER`, `BIO_USER`, and `DSF_ADMIN`. + + +## Examples + +The first example defines a group of DSF administrators. Two client certificates match against this role: + +```yaml + DEV_DSF_FHIR_SERVER_ROLECONFIG: | + - certificate-admins: + thumbprint: + - afb68b1d9d47e691b8b3d50fd9848467cada8b1c76f5f4b45f00c9f8432d505361a3ee27805f4aa06799d9ac8dace94b3f1942fce44d84866961259b13be825d + - 2441bfddcad97eeb83c8c31fe181b90652787b8b59bf4e569219da7db4429e389479cb7c4a2f311e34217357d594ecad7d58ccfeef2a9e93c6fcf8d98897d88c + dsf-role: + - CREATE + - READ + - UPDATE + - DELETE + - SEARCH + - HISTORY + practitioner-role: + - http://dsf.dev/fhir/CodeSystem/practitioner-role|DSF_ADMIN + +``` + + +The second example defines an administrator group consisting of all users with the OAuth role admin plus two additional administrators identified by their client-certificate thumbprints. These administrators may perform the basic DSF tasks: starting and continuing of new process instances (by creating tasks and answering QuestionnaireResponses) and reading all resources on the DSF FHIR server. + +```yaml + DEV_DSF_FHIR_SERVER_ROLECONFIG: | + - example_minimal_admin: + thumbprint: + - 0123...cdef + - abcd...6789 + token-role: admin + dsf-role: + - CREATE: [Task] + - READ + - UPDATE: [QuestionnaireResponse] + - SEARCH + - HISTORY + practitioner-role: + - http://dsf.dev/fhir/CodeSystem/practitioner-role|DSF_ADMIN + +``` + + +The third example allows read-only access, restricted to QuestionnaireResponse resources only. Two e-mail addresses are used to match this role. E-mail addresses from X.509 client certificates and OAuth 2.0 access tokens are matched: + +```yaml + DEV_DSF_FHIR_SERVER_ROLECONFIG: | + - read-only: + email: + - first.user@test.org + - second.user@test.org + dsf-role: + - READ: [QuestionnaireResponse] + - UPDATE: [QuestionnaireResponse] + - SEARCH: [QuestionnaireResponse] + - HISTORY: [QuestionnaireResponse] +``` + +--- + +## Access Control (BPE) +Source: https://dsf.dev/operations/latest/bpe/access-control.html + +## Overview + +The DSF BPE server provides a user interface for administrators. Without any additional configuration the user interface is not accessible with the organizations X.509 client certificate or any other certificate or OpenID Connect authenticated user. + +::: tip OpenID Connect +To enable OpenID Connect authentication of local user, see the DSF BPE server OpenID Connect [configuration page](oidc). +::: + +Access to the user interface can be enabled for client certificates and local users authenticating via OAuth 2.0 OpenID Connect. Access can be configured for so called roles, with all roles specified using the configuration parameter [DEV_DSF_BPE_SERVER_ROLECONFIG](configuration#dev-dsf-bpe-server-roleconfig). The value for this environment variable is specified as YAML using the block scalar `|`. + +The listing below shows a minimal configuration to enable access for a specific client-certificate: + +```yaml + DEV_DSF_BPE_SERVER_ROLECONFIG: | + - example_read_only_role: + thumbprint: 00474993fa261b0225f93c5a66aa6fcc... [a-f0-9]{128} + dsf-role: + - ADMIN +``` +The list of user roles above contains a single rule-entry `example_read_only_role`, matching the user via a client certificate SHA-512 thumprint and assigning three DSF roles. Any string can be used as the name for the rule-enty. + +::: tip Certificate Thumbprints +SHA-512 certificate thumbprints in HEX form `[a-f0-9]{128}` can be calculated using: +```sh +certtool --fingerprint --hash=sha512 --infile=certificate.pem +``` +::: + +Multiple user roles can be specified and all matching roles will be applied to an authenticated users. Use an empty string `""` or a single block scalar `|` character as the value for the configuration parameter [DEV_DSF_BPE_SERVER_ROLECONFIG](configuration#dev-dsf-bpe-server-roleconfig) if no roles should be configured. + +## Matching Users + +To apply roles, users can be matched via the `thumbprint`, `email`, `token-role` or `token-group` properties. A single value or a list of values can be specified. + +#### thumbprint + +The property `thumbprint` can used to specify one or multiple SHA-512 certificate thumbprints. Roles from this rule are applied to the authenticating user if the certificate matches one of the specified thumbprints. + +#### email + +Using the property `email` users can be matched against e-mail addresses specified in X.509 client certificates and in OpenID Connect access tokens. Values will be matched against e-mail addresses specified in the subject DN (via PKCS#9 extension 1.2.840.113549.1.9.1) and RFC-822 Name entries of the Subject Alternative Name field. If the user authenticates via OpenID Connect, the `email` [claim](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims) from the access token will be matched against the property values. + +#### token-role and token-group + +With the properties `token-role` and `token-group` role and group names can be specified to match against role and group claims within OAuth 2.0 access tokens. + + +## DSF and Practitioner Roles + +Two types of roles can be applied to matched users. + +#### dsf-role + +DSF roles specified via the `dsf-role` property define general access to the user interface. Allowed values are: + +`ADMIN`. + +#### practitioner-role + +The BPE server currently does not support any practionier-roles. + + +## Examples + +The first example defines a group of DSF administrators. Two client certificates match against this role: + +```yaml + DEV_DSF_BPE_SERVER_ROLECONFIG: | + - certificate-admins: + thumbprint: + - afb68b1d9d47e691b8b3d50fd9848467cada8b1c76f5f4b45f00c9f8432d505361a3ee27805f4aa06799d9ac8dace94b3f1942fce44d84866961259b13be825d + - 2441bfddcad97eeb83c8c31fe181b90652787b8b59bf4e569219da7db4429e389479cb7c4a2f311e34217357d594ecad7d58ccfeef2a9e93c6fcf8d98897d88c + dsf-role: + - ADMIN +``` + + +The second example defines a group of DSF administrators by specifying an `admin` role that gets matched against OAuth 2.0 access tokens: + +```yaml + DEV_DSF_BPE_SERVER_ROLECONFIG: | + - token-role-admins: + token-role: admin + dsf-role: + - ADMIN +``` + + +The third example allows administrator access and users e-mail addresses to match this role. E-mail addresses from X.509 client certificates and OAuth 2.0 access tokens are matched: + +```yaml + DEV_DSF_BPE_SERVER_ROLECONFIG: | + - email-admins: + email: + - first.user@test.org + - second.user@test.org + dsf-role: + - ADMIN +``` + +--- + +## Common HTTP Status Codes +Source: https://dsf.dev/operations/troubleshooting/common-http-status-codes.html + +# 401 Unauthorized +This HTTP status code may be a result of an allow list mismatch. Either the requesting party is using a client certificate that was not updated after making changes to the allow list or the receiving party is using an outdated version of the allow list. + +# 403 Forbidden +This HTTP status code may be encountered in different ways in the context of the DSF: +- Process plugin is not installed at FHIR server where the Task resource was posted +- Client certificate of the FHIR server where the Task resource was posted is invalid e.g. because it is expired + +# 413 Content Too Large +This HTTP status code is a result of trying to upload a resource that is too large for the server to handle. This might be due to a misconfiguration of the DSF FHIR server's reverse proxy not allowing this much data to be uploaded. + +# 500 Internal Server Error +This HTTP status may be a result of a connection timeout if a forward proxy is used or when using ping pong 2.x in DSF 1.x with a download resource size of >400MB. + +# 502 Bad Gateway +This HTTP status code is usually the response of a proxy because the upstream server sent an invalid response. + +# 504 Gateway Timeout +This HTTP status code is usually the response of a proxy because the upstream server did not send a response in time. + +--- + +## Connection Refused +Source: https://dsf.dev/operations/troubleshooting/connection-refused.html + +This error occurs when there is nothing listening on the port at the receiving end of a connection attempt or the firewall is blocking the connection. The former might indicate the reverse proxy for the DSF FHIR server being offline. + +--- + +## Connection Timeout +Source: https://dsf.dev/operations/troubleshooting/connection-timeout.html + +A connection timeout happens when a connection attempt is made but there is no response from the endpoint in a certain timeframe. +There are many possible reasons for why this happens: +- The server is currently down or unreachable due to network configuration +- The server is under heavy load and thus unresponsive +- Firewalls might be blocking outgoing connections to the server +- Arbitrary network issues + +If this is happens during the execution of a DSF process, it is recommended to try starting the process again to see if the issue persists. If the issue persists, further troubleshooting might have include system administrators or a member of the [DSF team](../../community/communication.md). + +--- + +## Read Timeout +Source: https://dsf.dev/operations/troubleshooting/read-timeout.html + +A read timeout is a network error that usually happens when a resource is read from a server but the resource takes too long to arrive at the client. +There are many possible reasons for why this happens: +- The server unexpectedly went down during transmission +- The server is under heavy load and unable to process the request in a timely manner +- Ping pong 2.x may run in read timeouts if the download resource size too large. This can be mitigated by setting the `pong-timeout-duration` when starting the ping pong process, the environment variables `DEV_DSF_BPE_FHIR_CLIENT_REMOTE_TIMEOUT_READ` and `DEV_DSF_BPE_FHIR_CLIENT_LOCAL_TIMEOUT_READ` of the BPE and/or the `DEV_DSF_FHIR_CLIENT_TIMEOUT_READ` of the DSF FHIR server to higher values +- Arbitrary network issues + +If this is happens during the execution of a DSF process, it is recommended to try starting the process again to see if the issue persists. If the issue persists, further troubleshooting might have include system administrators or a member of the [DSF team](../../community/communication.md). + +--- + +## SSL Issues +Source: https://dsf.dev/operations/troubleshooting/ssl.html + +SSL issues arise if there is a misconfiguration of client/server certificates. +Client certificates may: +- Be expired +- Have an untrusted root +- Be revoked + +Server certificates may: +- Be expired +- Have an untrusted root +- Be revoked +- Have the wrong host as the subject + +It is recommended to use [OpenSSL](https://openssl.org/) for further debugging. + +--- + +## Unknown Host +Source: https://dsf.dev/operations/troubleshooting/unknown-host.html + +This error occurs if a host name cannot be mapped to an IP address. Either because of a spelling mistake of the host name or because of DNS problems. If this happens in the context of a DSF process, it is recommended to review the configuration of the process plugin or contact the process plugin's maintainers. DNS problems have a wide variety of sources like network misconfiguration or the DNS server being unavailable. + +--- + +## Concept +Source: https://dsf.dev/process-development/api-v2/concept.html + +## BPMN +- [Conditions](bpmn/conditions.md) +- [Execution Listener](bpmn/execution-listeners.md) +- [Gateways](bpmn/gateways.md) +- [Messaging](bpmn/messaging.md) +- [Sequence Flow](bpmn/sequence-flow.md) +- [Service Tasks](bpmn/service-tasks.md) +- [Timer Intermediate Catching Events](bpmn/timer-intermediate-catching-events.md) + +## FHIR +- [ActivityDefinition](fhir/activitydefinition.md) +- [Codesystem](fhir/codesystem.md) +- [Questionnaire and QuestionnaireResponse](fhir/questionnaire-and-questionnaireresponse.md) +- [Task](fhir/task.md) +- [ValueSet](fhir/valueset.md) + +## DSF +- [Activities](dsf/activities.md) +- [BPMN Process Variables](dsf/bpmn-process-variables.md) +- [Draft Task Resources](dsf/draft-task-resources.md) +- [Environment Variables](dsf/environment-variables.md) +- [Message Correlation](dsf/message-correlation.md) +- [Message Activities](dsf/message-activities.md) +- [Messaging](dsf/messaging.md) +- [Organization Identifiers](dsf/organization-identifiers.md) +- [Process Plugin API](dsf/process-plugin-api.md) +- [Process Plugin Definition](dsf/process-plugin-definition.md) +- [Read Access Tag](dsf/read-access-tag.md) +- [Requester and Recipient](dsf/requester-and-recipient.md) +- [Spring Framework Integration](dsf/spring-framework-integration.md) +- [Target and Targets](dsf/target-and-targets.md) +- [Versions, Placeholders and URLs](dsf/versions-placeholders-urls.md) + +## Guides +- [Accessing BPMN Process Variables](guides/accessing-bpmn-process-variables.md) +- [Accessing Task Resources During Execution](guides/accessing-task-resources-during-execution.md) +- [Adding Task Parameters to Task Profiles](guides/adding-task-parameters-to-task-profiles.md) +- [Configuring Read Access Tags](guides/configuring-read-access-tags.md) +- [Creating ActivityDefinitions](guides/creating-activity-definitions.md) +- [Creating CodeSystems for DSF Processes](guides/creating-codesystems-for-dsf-processes.md) +- [Creating Task Resources Based on a Definition](guides/creating-task-resources-based-on-a-definition.md) +- [Creating ValueSets for DSF Processes](guides/creating-valuesets-for-dsf-processes.md) +- [Managing Multiple Incoming Messages and Missing Messages](guides/managing-mutiple-incoming-messages-and-missing-messages.md) +- [Starting a Process via Task Resources](guides/starting-a-process-via-task-resources.md) + +--- + +## Get Started +Source: https://dsf.dev/process-development/api-v2/get-started.html + +## How to start a new Project + +::: warning Work in progress + +This site is work in progress, please come back later. +::: + +--- + +## Create a Process Plugin +Source: https://dsf.dev/process-development/api-v2/create.html + +::: warning Work in progress + +This site is work in progress, please come back later. +::: + +--- + +## Implementation +Source: https://dsf.dev/process-development/api-v2/implementation.html + +You can find the FHIR Implementation Guide [here](../../dsf-development/v2/fhir-ig.md). + +--- + +## Testing +Source: https://dsf.dev/process-development/api-v2/testing.html + +::: warning Work in progress + +This site is work in progress, please come back later. +::: + +--- + +## Best Practices +Source: https://dsf.dev/process-development/api-v2/best-practices.html + +::: warning Work in progress + +This site is work in progress, please come back later. +::: + +--- + +## Migration from API v1 +Source: https://dsf.dev/process-development/api-v2/migration.html + +## Migration from API 1 to API 2 + +::: warning Work in progress + +This site is work in progress, please come back later. +::: + +--- + +## Javadoc +Source: https://dsf.dev/process-development/api-v2/javadoc.html + +Open Fullscreen +