Skip to content

Commit f9dc1ab

Browse files
leefine02leefine02
authored andcommitted
2 parents 6aa94b6 + a91af57 commit f9dc1ab

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,11 @@ Before installing the Remote File Universal Orchestrator extension, we recommend
120120
(f) - RFKDB store type only
121121

122122
2. When orchestrating management of local or external certificate stores, the Remote File Orchestrator Extension makes
123-
use of SFTP and/or SCP to transfer files to and from the orchestrated server. `SFTP/SCP` cannot make use of `sudo`, so
124-
all folders containing certificate stores will need to allow SFTP/SCP file transfer for the user assigned to the
123+
use of SCP or SFTP to transfer files to and from the orchestrated server. SCP is attempted first, and if that
124+
fails, SFTP is attempted. `SCP/SFTP` cannot make use of `sudo`, so
125+
all folders containing certificate stores will need to allow SCP/SFTP file transfer for the user assigned to the
125126
certificate store/discovery job. If this is not possible, set the values in the `config.json` appropriately to use an
126-
alternative upload/download folder that does allow `SFTP/SCP` file transfer. If the certificate store/discovery job is
127+
alternative upload/download folder that does allow `SCP/SFTP` file transfer. If the certificate store/discovery job is
127128
configured for local (agent) access, the account running the Keyfactor Universal Orchestrator service must have
128129
access to read/write to the certificate store location, OR the `config.json` file must be set up to use the alternative
129130
upload/download file.
@@ -160,8 +161,8 @@ Please reference [Certificate Stores and Discovery Jobs](#certificate-stores-and
160161
creating certificate stores for the `RemoteFile` Orchestrator Extension.
161162

162163
</details>
163-
164-
Please consult with your system administrator for more information on configuring `SSH/SFTP/SCP` or `WinRM` in your environment.
164+
C
165+
Please consult with your system administrator for more information on configuring `SSH/SCP/SFTP` or `WinRM` in your environment.
165166

166167

167168
## Certificate Store Types
@@ -274,7 +275,6 @@ the Keyfactor Command Portal
274275
| SudoImpersonatingUser | Sudo Impersonating User | The SudoImpersonatingUser field should contain a valid user ID to impersonate using sudo on the destination Linux server. Example: 'impersonatedUserID'. Overrides DefaultSudoImpersonatedUser [config.json](#post-installation) setting. | String | | 🔲 Unchecked |
275276
| RemoveRootCertificate | Remove Root Certificate from Chain | Remove root certificate from chain when adding/renewing a certificate in a store. | Bool | False | 🔲 Unchecked |
276277
| IncludePortInSPN | Include Port in SPN for WinRM | Internally set the -IncludePortInSPN option when creating the remote PowerShell connection. Needed for some Kerberos configurations. | Bool | False | 🔲 Unchecked |
277-
| FileTransferProtocol | File Transfer Protocol to Use | Which protocol should be used when uploading/downloading files - SCP, SFTP, or Both (try one, and then if necessary, the other). Overrides FileTransferProtocol [config.json](#post-installation) setting. | MultipleChoice | ,SCP,SFTP,Both | 🔲 Unchecked |
278278
| SSHPort | SSH Port | Integer value representing the port that should be used when connecting to Linux servers over SSH. Overrides SSHPort [config.json](#post-installation) setting. | String | | 🔲 Unchecked |
279279
| UseShellCommands | Use Shell Commands | Recommended to be set to the default value of 'Y'. For a detailed explanation of this setting, please refer to [Use Shell Commands Setting](#use-shell-commands-setting) | Bool | True | 🔲 Unchecked |
280280

@@ -929,7 +929,6 @@ The Remote File Orchestrator Extension uses a JSON configuration file. It is loc
929929
"CreateStoreIfMissing": "N",
930930
"UseNegotiate": "N",
931931
"SeparateUploadFilePath": "",
932-
"FileTransferProtocol": "SCP",
933932
"DefaultLinuxPermissionsOnStoreCreation": "600",
934933
"DefaultOwnerOnStoreCreation": "",
935934
"SSHPort": "",
@@ -944,7 +943,6 @@ The Remote File Orchestrator Extension uses a JSON configuration file. It is loc
944943
| `CreateStoreIfMissing` | `N` | `Y/N` | Determines if a certificate store should be created during a Management-Add job if it doesn't exist. If `N`, the job will return an error. If `Y`, the store will be created and the certificate added. |
945944
| `UseNegotiate` | `N` | `Y/N` | Determines if WinRM should use Negotiate (Y) when connecting to the remote server. Only applicable for Windows hosted certificate stores. |
946945
| `SeparateUploadFilePath` | | Any valid, existing Linux path | Path on the orchestrated server for uploading/downloading temporary work files. If empty, the certificate store location will be used. Only applicable for Linux hosted certificate stores. |
947-
| `FileTransferProtocol` | `SCP` | `SCP, SFTP, Both` | Protocol used for uploading/downloading files. If `Both`, `SCP` will be tried first, then `SFTP`. Only applicable for Linux hosted certificate stores. |
948946
| `DefaultLinuxPermissionsOnStoreCreation` | `600` | Any 3-digit value from 000-777 | Linux file permissions set on new certificate stores. If blank, permissions from the parent folder will be used. Only applicable for Linux hosted certificate stores. |
949947
| `DefaultOwnerOnStoreCreation` | | Any valid user id | Sets the owner for newly created certificate stores. Can include group with format `ownerId:groupId`. If blank, the owner of the parent folder will be used. Only applicable for Linux hosted certificate stores. |
950948
| `SSHPort` | | Any valid integer representing a port | The port that SSH is listening on. Default is 22. Only applicable for Linux hosted certificate stores. |
@@ -987,7 +985,6 @@ The Remote File Universal Orchestrator extension implements 6 Certificate Store
987985
| SudoImpersonatingUser | The SudoImpersonatingUser field should contain a valid user ID to impersonate using sudo on the destination Linux server. Example: 'impersonatedUserID'. Overrides DefaultSudoImpersonatedUser [config.json](#post-installation) setting. |
988986
| RemoveRootCertificate | Remove root certificate from chain when adding/renewing a certificate in a store. |
989987
| IncludePortInSPN | Internally set the -IncludePortInSPN option when creating the remote PowerShell connection. Needed for some Kerberos configurations. |
990-
| FileTransferProtocol | Which protocol should be used when uploading/downloading files - SCP, SFTP, or Both (try one, and then if necessary, the other). Overrides FileTransferProtocol [config.json](#post-installation) setting. |
991988
| SSHPort | Integer value representing the port that should be used when connecting to Linux servers over SSH. Overrides SSHPort [config.json](#post-installation) setting. |
992989
| UseShellCommands | Recommended to be set to the default value of 'Y'. For a detailed explanation of this setting, please refer to [Use Shell Commands Setting](#use-shell-commands-setting) |
993990

@@ -1023,7 +1020,6 @@ The Remote File Universal Orchestrator extension implements 6 Certificate Store
10231020
| Properties.SudoImpersonatingUser | The SudoImpersonatingUser field should contain a valid user ID to impersonate using sudo on the destination Linux server. Example: 'impersonatedUserID'. Overrides DefaultSudoImpersonatedUser [config.json](#post-installation) setting. |
10241021
| Properties.RemoveRootCertificate | Remove root certificate from chain when adding/renewing a certificate in a store. |
10251022
| Properties.IncludePortInSPN | Internally set the -IncludePortInSPN option when creating the remote PowerShell connection. Needed for some Kerberos configurations. |
1026-
| Properties.FileTransferProtocol | Which protocol should be used when uploading/downloading files - SCP, SFTP, or Both (try one, and then if necessary, the other). Overrides FileTransferProtocol [config.json](#post-installation) setting. |
10271023
| Properties.SSHPort | Integer value representing the port that should be used when connecting to Linux servers over SSH. Overrides SSHPort [config.json](#post-installation) setting. |
10281024
| Properties.UseShellCommands | Recommended to be set to the default value of 'Y'. For a detailed explanation of this setting, please refer to [Use Shell Commands Setting](#use-shell-commands-setting) |
10291025

@@ -1654,7 +1650,7 @@ permissions and ownership when creating certificate stores will be based on the
16541650
other Linux environmental settings.
16551651
3. Discovery jobs are excluded and will still use the `find` shell command
16561652
4. A rare issue exists where the user id assigned to a certificate store has an expired password causing the orchestrator to hang
1657-
when attempting an SFTP/SCP connection. A modification was added to RemoteFile to check for this condition. Running RemoteFile
1653+
when attempting an SCP/SFTP connection. A modification was added to RemoteFile to check for this condition. Running RemoteFile
16581654
with Use Shell Commands = N will cause this validation check to NOT occur.
16591655
5. Both RFORA and RFKDB use proprietary CLI commands in order to manage their respective certificate stores. These commands
16601656
will still be executed when Use Shell Commands is set to Y.

0 commit comments

Comments
 (0)