Skip to content

Commit 39e2dda

Browse files
committed
Updates per review comments.
1 parent b341f89 commit 39e2dda

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

docs/user-manual/index.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: User Manual
44
advertise: User Manual
55
---
66

7-
Version 2.1, released 2017-05-05
7+
Version 2.1rc1, released 2017-05-05
88

99
This document has all the information you need to get up and
1010
running with User Sync. It presumes familiarity with the use of
@@ -305,7 +305,7 @@ any file containing sensitive information except from the user
305305
account that runs the sync process.
306306

307307
If you choose to use the operating system to store credentials,
308-
you still setup the same configuration files but rather than storing
308+
you still create the same configuration files but rather than storing
309309
the actual credentials, they store key ids that are used to look up
310310
the actual credentials. Details are shown in
311311
[Security recommendations](#security-recommendations).
@@ -444,11 +444,16 @@ secure them properly**, as described in the
444444
[Security Considerations](#security-considerations) section of
445445
this document.
446446
447-
The sample configuration files include entries that define the actual
448-
credential values and entries that reference credentials in the operating system
449-
credential store. You would keep only one of each pair and comment out or
450-
remove the other. Another example user-sync-config.yaml show how to reference
451-
umapi and ldap configuration files stored in a secure store that you define.
447+
There are three techniques supported by User Sync for securing credentials.
448+
449+
1. Credentials can be placed in the connector-umapi.yml and connector-ldap.yml files directly and the files protected with operating system access control.
450+
2. Credentials can be placed in the operating system secure credential store and referenced from the two configuration files.
451+
3. The two files in their entirety can be stored securely or encrypted and a program that returns their contents is referenced from the main configuration file.
452+
453+
454+
The example configuration files include entries that illustrate each of
455+
these techniques. You would keep only one set of configuration items
456+
and comment out or remove the others.
452457
453458
#### Configure connection to the Adobe Admin Console (UMAPI)
454459
@@ -1697,7 +1702,7 @@ Starting in User Sync 2.1, there are two additional techniques available
16971702
for protecting credentials. The first uses the operating system credential
16981703
store to store individual configuration credential values. The second uses
16991704
a mechanism you must provide to store the entire configuration file for umapi
1700-
and ldap access which includes all the credentials required. These are
1705+
and/or ldap which includes all the credentials required. These are
17011706
detailed in the next two sections.
17021707

17031708
#### Storing Credentials in OS Level Storage
@@ -1715,7 +1720,7 @@ connector-umapi.yml
17151720
tech_acct: your tech [email protected]
17161721
secure_priv_key_data_key: umapi_private_key_data
17171722

1718-
Note the change of `api_key`, `client_secret`, and `priv_key_path` to `secure_api_key_key`, `secure_client_secret_key`, and `secure_priv_key_data_key`, respectively. These alternate configuration values give the key names to be looked up in keyring (or the equivalent service on other platforms) to retrieve the actual credential values. In this example, the credential key names are `umapi_api_key`, `umapi_client_secret`, and `umapi_private_key_data`.
1723+
Note the change of `api_key`, `client_secret`, and `priv_key_path` to `secure_api_key_key`, `secure_client_secret_key`, and `secure_priv_key_data_key`, respectively. These alternate configuration values give the key names to be looked up in the user keychain (or the equivalent service on other platforms) to retrieve the actual credential values. In this example, the credential key names are `umapi_api_key`, `umapi_client_secret`, and `umapi_private_key_data`.
17191724

17201725
The contents of the private key file is used as the value of `umapi_private_key_data` in the credential store.
17211726

@@ -1761,8 +1766,6 @@ user-sync-config.yml (showing partial file only)
17611766
connectors:
17621767
# umapi: connector-umapi.yml # instead of this file reference, use:
17631768
umapi: $(read_umapi_config_from_s3)
1764-
# if a working directory is required:
1765-
# umapi $([temp]read_umapi_config_from_s3) # runs command in "temp" folder
17661769
17671770
directory_users:
17681771
connectors:
@@ -1771,18 +1774,17 @@ user-sync-config.yml (showing partial file only)
17711774

17721775
The general format for external command references is
17731776

1774-
$([working directory pathname]command args)
1777+
$(command args)
17751778

1776-
The working directory pathname is optional. If present, it is enclosed
1777-
in square brackets. If the working directory pathname is not fully qualified
1778-
it is interpreted as relative to the folder of the configuration file containing
1779-
the reference.
1779+
The above examples assume there is a command with the name `read_umapi_config_from_s3`
1780+
and `read_ldap_config_from_server` that you have supplied.
17801781

1781-
The remainder of the line is the shell command name
1782-
followed by any arguments. A command shell is launched by User Sync which
1782+
A command shell is launched by User Sync which
17831783
runs the command. The standard output from the command is captured and that
17841784
output is used as the umapi or ldap configuration file.
17851785

1786+
The command is run with the working directory as the directory containing the configuration file.
1787+
17861788
If the command terminates abnormally, User Sync will terminate with an error.
17871789

17881790
The command can reference a new or existing program or a script.

0 commit comments

Comments
 (0)