Skip to content

Commit fad9820

Browse files
authored
Merge pull request #225 from eccenca/feature/cmemcCustomHeader-CMEM-7546
update docu for custom extra headers in cmemc
2 parents 40ead1a + 2d563fe commit fad9820

3 files changed

Lines changed: 22 additions & 2 deletions

File tree

  • docs
    • automate/cmemc-command-line-interface/configuration
      • file-based-configuration
      • getting-credentials-from-external-processes
    • release-notes/corporate-memory-26-1

docs/automate/cmemc-command-line-interface/configuration/file-based-configuration/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,3 +269,12 @@ Setting this to a PEM file allows for using private Certificate Authorities for
269269
Please refer to [Certificate handling and SSL verification](../certificate-handling-and-ssl-verification/index.md) for more information.
270270

271271
This variable defaults to `$PYTHON_HOME/site-packages/certifi/cacert.pem`.
272+
273+
274+
#### CMEMC_CUSTOM_HEADER_*
275+
276+
Enabling this setting ensures that all HTTP requests made by cmemc include the specified custom headers.
277+
278+
The CMEMC_CUSTOM_HEADER_ prefix is automatically removed, so only the header name (*) is used in the request.
279+
280+
By default, this variable is set to none.

docs/automate/cmemc-command-line-interface/configuration/getting-credentials-from-external-processes/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ tags:
66
- Security
77
- cmemc
88
---
9+
910
# Getting Credentials from External Processes
1011

1112
## Introduction
@@ -60,6 +61,7 @@ In order to get credential information from an external process you need to use
6061
- `OAUTH_PASSWORD_PROCESS`, to set up the process to get the user password when using the `password` grant type.
6162
- `OAUTH_CLIENT_SECRET_PROCESS`, to set up the process to get the client secret when using `client_credentials` grant type .
6263
- `OAUTH_ACCESS_TOKEN_PROCESS`, to set up the process to get the direct access token (`prefetched_token`).
64+
- `CMEMC_CUSTOM_HEADER_*_PROCESS` to set up the process to get custom http headers if needed (the `*` needs to be replaced with the correct header name using all uppercase and `_` instead of `-`, e.g. `CMEMC_CUSTOM_HEADER_CF_ACCESS_TOKEN_PROCESS` for the `cf-access-token` header variable)
6365

6466
The credential executable can use the other cmemc environment keys of the configuration block for fetching the credentials (e.g. `CMEM_BASE_URI` and `OAUTH_USER`).
6567

@@ -87,6 +89,8 @@ OAUTH_CLIENT_ID=cmem-service-account
8789
OAUTH_CLIENT_SECRET_PROCESS=["getpass.sh", "parameter1", "parameter2"]
8890
```
8991

92+
Note: You need to define a named connection for this to take effect. Using the `[DEFAULT]` section fallback will not execute the process.
93+
9094
### Example: MacOS Keychain
9195

9296
Here is a working example with the MacOS Keychain, which can be queried with the command line tool `security`.

docs/release-notes/corporate-memory-26-1/index.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This release delivers the following component versions:
3434

3535
- eccenca DataIntegration v26.1.0
3636
- eccenca Explore v26.1.1
37-
- eccenca Corporate Memory Control (cmemc) v26.1.1
37+
- eccenca Corporate Memory Control (cmemc) v26.1.2
3838
- eccenca Graph Insights v19.2.0
3939

4040
We tested this release with the following dependency components:
@@ -221,10 +221,17 @@ We are pleased to announce the release of Explore v26.1, which introduces badges
221221
- SPARQL Excel downloads now have clean file names.
222222
- Notifications are now more robust when given non-string input.
223223

224-
## eccenca Corporate Memory Control (cmemc) v26.1.0
224+
## eccenca Corporate Memory Control (cmemc) v26.1.2
225225

226226
We are excited to announce the release of cmemc v26.1, which expands access-condition administration, adds richer project and query catalog operations, and improves list and output consistency across the CLI.
227227

228+
**v26.1.2 of cmemc ships the following features:**
229+
230+
- Support for arbitrary custom HTTP request headers via `CMEMC_CUSTOM_HEADER_*` environment variables and config keys
231+
- Header name is derived from the suffix by replacing underscores with hyphens (e.g. `CMEMC_CUSTOM_HEADER_CF_ACCESS_CLIENT_ID` → `CF-ACCESS-CLIENT-ID`)
232+
- Protected headers (`Authorization`, `User-Agent`) cannot be overridden and raise a configuration error
233+
- Custom headers are cleared when switching connections
234+
228235
**v26.1.1 of cmemc ships the following fixes:**
229236

230237
- `workflow status` command

0 commit comments

Comments
 (0)