How to set header in OPAL_DATA_CONFIG_SOURCES & opal-server /data/config?

[hongbo-miao]

Assume to access API https://example.com/api needs a header called secret-key with a key.

Question 1

How can I set that token in this OPAL_DATA_CONFIG_SOURCES?

OPAL_DATA_CONFIG_SOURCES='{"config":{"entries":[{"url":"https://example.com/api","topics":["policy_data"]}]}}'

Question 2

What about when calling opal-server at /data/config?

I saw the authorization in the doc
https://opal.authorizon.com/redoc#operation/get_data_sources_config_data_config_get

but I think that is for authorizon.com

My question is if I call my own opal-server /data/config with data body

{
  "entries": [
    {
      "url": "https://api.jsonbin.io/b/60dfbe5f9328b059d7b55ce4",
      "topics": [
        "policy_data"
      ]
    }
  ],
  "reason": "update data"
}

How can I pass that header secret-key inside?

Thanks!

[asafc]

Hi @hongbo-miao, it’s very simple to pass the secret key (or any other header for that matter) in the configuration.

The shape of DataSourceEntry is the same both for:

• OPAL_DATA_CONFIG_SOURCES (which dictates the initial data sources that should be fetched when opal-client starts or when the opal-client resumes connection after disconnect)
• /data/config updates (realtime updates that can be sent whenever something changes).

in any case i will simply re-edit both you examples for simplicity:

Question 1

How can I set that token in this OPAL_DATA_CONFIG_SOURCES?

Answer:

OPAL_DATA_CONFIG_SOURCES='{"config":{"entries":[{"url":"https://example.com/api","config":{"headers":{"secret-key":"MY_SECRET_KEY"}},"topics":["policy_data"]}]}}

Question 2

What about when calling opal-server at /data/config?

Answer:

{
  "entries": [
    {
      "url": "https://api.jsonbin.io/b/60dfbe5f9328b059d7b55ce4",
      "config": {
        "headers": {
          "secret-key": "MY_SECRET_KEY"
        }
      },
      "topics": [
        "policy_data"
      ]
    }
  ],
  "reason": "update data"
}

I should mention - because generally your secret key should stay private - it is important that a deployed OPAL server will be protected with HTTPS so that the traffic is e2e encrypted.

[hongbo-miao]

Works perfect. Thanks @asafc !
Is there any document about these? If not, it would be great to document those.

[asafc]

I will definitely add all these steps to the documentation. Hopefully Sunday 🤞😉