This page is for data modellers who need to provide securely-stored credentials to access data via HTTP.
Overview
When importing data via HTTP, you sometimes need to provide authentication to an external site. To provide a username and/or password securely, configure a key/value pair.
- In a HTTP Datasource properties → Secret Key Details, create a secret key.
- In the Secret field, click to create a new Local Secret item.
- In the local secret → Secret field, add the value, which PhixFlow stores encrypted.
You can use the secret key name to refer to the encrypted value in:
- HTTP collectors and exporters → URL Expression or Statement Expression fields in
- HTTP Headers Properties → Basic Settings → Value.
by specifying ${_datasource.key}
where key
is the Name of the secret key.
When you run analysis, PhixFlow uses the secret key Name to find the key, which finds the encrypted secret. It then provides the de-encrypted value to authenticate to the external site.
To create a key/value pair, in an HTTP datasource properties → Secret Key Details section, click
to create a new secret key.
Insert excerpt |
---|
| _property_toolbar |
---|
| _property_toolbar |
---|
nopanel | true |
---|
|
Secret Key
Insert excerpt |
---|
| _property_tabs |
---|
| _property_tabs |
---|
name | basic-h |
---|
nopanel | true |
---|
|
Insert excerpt |
---|
| _parent |
---|
| _parent |
---|
nopanel | true |
---|
|
Basic Settings
Field | Description |
---|
Name | Enter a name. the properties. Use this name in expressions to refer to this key. |
Key | Read-only. When you save the secret key, PhixFlow automatically generates a unique key in this field. |
Enabled | Insert excerpt |
---|
| _check_box_tick |
---|
| _check_box_tick |
---|
nopanel | true |
---|
| to indicate you have completed configuring the secret key and associated local secret value, and it is ready to use. The local secret value may be null. Insert excerpt |
---|
| _check_box_untick |
---|
| _check_box_untick |
---|
nopanel | true |
---|
| means a reference to this secret key in an expression will fail.
|
Secret | Click to create a local secret item, where you can enter the value, such as a password, that is paired with this secret key; see Local Secret Properties, below. When you save the local secret, PhixFlow displays asterisks here to show that the secret value has been encrypted. To edit a secret value, click . To delete a secret value, click Insert excerpt |
---|
| _delete |
---|
| _delete |
---|
nopanel | true |
---|
|
. |
Insert excerpt |
---|
| _description |
---|
| _description |
---|
nopanel | true |
---|
|
Local Secret
Insert excerpt |
---|
| _property_tabs |
---|
| _property_tabs |
---|
name | basic-h |
---|
nopanel | true |
---|
|
Field | Description |
---|
Key | Read only. The same automatically-generated key in the secret key paired with this local secret. |
Secret | Enter the value that you want to encrypt, such as a password. To switch between displaying or hiding the value, click Insert excerpt |
---|
| _password_view |
---|
| _password_view |
---|
nopanel | true |
---|
|
. PhixFlow encrypts the value when storing it in the database, but when it is required to authenticate to an external site, PhixFlow supplies the unencrypted string. |
Using a Keystore
todo-fiona
Internal IDs
If you have configured a Java keystore Configure a Keystore and Aliases and Adding Data to a Keystore you can use this to store secure credentials instead of using a Local Secret.
Datasource and HTTP Datasource modelling objects have properties → Advanced → Internal ID.
This is a read-only field that provides the database identifier for the datasource.
You can supply a key-value pair to the keystore. However, the username and password key or value requires the datasource ID.
EG. Datasource needs a username XYZ and password ABC
Key datasource1-username - internalIDXYZ
Key datasource1-pw - internalIABC
Datasource
- Store the username key-value pair in the keystore.
- Store the password key-value pair in the keystore.
To reference them, in the expressions, use ${_datasource.key}
where key
is the key.