Drives
The following values can be configured independently for each drive, at HKEY_LOCAL_MACHINE\SOFTWARE\nsoftware\SFTPDrive\2\Drives\{Drive Name}:
| Name | Type | Description |
| DriveLetter | String | Contains the drive letter where the drive will be mounted (e.g. "Z:"). |
| DriveName | String | Contains the name that will be displayed for the drive. |
| DriveType | DWORD | Determines the type of drive that will be mounted:
|
| Enabled | DWORD | Determines whether or not the drive will be mounted when SFTP Drive is started.
|
| Index | DWORD | The position of the drive in the list of drives. |
| OpenRemoteFolder | DWORD | Determines whether or not SFTP Drive will automatically open a folder after mounting the drive.
|
| OpenSpecifiedFolder | String | Contains the folder that SFTP Drive will open if OpenRemoteFolder is enabled. |
| ReadOnly | DWORD | Determines whether or not SFTP Drive will mount the drive in read-only mode.
|
| RemoteRoot | String | Contains the folder on the server that SFTP Drive will use as the root of the mounted drive. |
| Shared | DWORD | Determines whether or not other users can access the mounted drive.
|
| AuthType | DWORD | Determines the type of authentication used to connect to the server:
|
| CertStore | String | The name of the certificate store for the client certificate |
| CertStoreType | DWORD | The type of certificate store for this certificate
|
| CertStorePassword | String | If the certificate store is of a type that requires a password, this registry setting is used to specify that password in order to open the certificate store. |
| CertSubject | String | The subject of the certificate used for client authentication. The certificate subject is a comma separated list of distinguished name properties and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". |
| ForceRename | DWORD |
Determines whether or not to forcefully rename a file if the destination file already exists. By default, renaming a file will fail if the destination file already exists. If enabled and the destination file already exists, the destination file will be renamed to have a temporary extension as a backup. The original file will be renamed to the destination file and the temporary file will be deleted. If the rename operation fails for any reason the temporary file is renamed back to the destination file so effectively no changes occur when the rename fails.
|
| Host | String | Contains the remote host that SFTP Drive will connect to. |
| Password | String | Contains the password for the SFTP server. |
| Port | DWORD | Contains the port on the remote host that SFTP Drive will connect to. |
| QueryAvailableSpace | DWORD | Whether to query the remote server for available space when connecting. Possible values are:
|
| RemoteRootType | DWORD | Determines how the drive decides what folder to use as the root of the drive.
|
| SecurityKeyAccount | String | An opaque token holding information about the certificate selected from the security key. This value is created by the application and should not be set manually. |
| SecurityKeyName | String | A friendly name of the chosen key. This is populated after selecting a key. For instance "PIV AUTH pubkey" |
| SecurityKeyPIN | String | The encrypted PIN of the security key. |
| SecurityKeyPKCS11LibPath | String | The path to the library which implements the PKCS11 interface. This may be provided by the security key vendor, or may be an alternative implementation like OpenSC. For instance "C:\Program Files\OpenSC Project\OpenSC\pkcs11\onepin-opensc-pkcs11.dll" |
| SecurityKeySavePIN | DWORD | Whether to save the PIN. If saved, the PIN is encrypted. |
| SignedSSHCert | String |
The CA signed client public key used when authenticating. When authenticating via public key authentication this setting may be set to the CA signed client's public key. This is useful when the server has been configured to trust client keys signed by a particular CA. For instance: SignedSSHCert=ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...") The algorithm such as ssh-rsa-cert-v01@openssh.com in the above string is used as part of the authentication process. To use a different algorithm simply change this value. For instance all of the following are acceptable with the same signed public key:
|
| UseIPv6 | String | If "False", the drive will use IPv4 to connect. If "True", the drive will use IPv6. |
| Username | String | Contains the username for the SFTP server. |