CloudFiles Class

Properties   Methods   Events   Config Settings   Errors  

The CloudFiles class provides an easy way to upload, download, and manage files and folders with multiple service providers.

Class Name

CloudStorage_CloudFiles

Procedural Interface

 cloudstorage_cloudfiles_open();
 cloudstorage_cloudfiles_close($res);
 cloudstorage_cloudfiles_register_callback($res, $id, $function);
 cloudstorage_cloudfiles_get_last_error($res);
 cloudstorage_cloudfiles_get_last_error_code($res);
 cloudstorage_cloudfiles_set($res, $id, $index, $value);
 cloudstorage_cloudfiles_get($res, $id, $index);
 cloudstorage_cloudfiles_do_config($res, $configurationstring);
 cloudstorage_cloudfiles_do_copyfile($res, $newfilepath);
 cloudstorage_cloudfiles_do_deletefile($res, $filename);
 cloudstorage_cloudfiles_do_download($res);
 cloudstorage_cloudfiles_do_interrupt($res);
 cloudstorage_cloudfiles_do_listdirectory($res);
 cloudstorage_cloudfiles_do_makedirectory($res, $newdir);
 cloudstorage_cloudfiles_do_removedirectory($res, $dirname);
 cloudstorage_cloudfiles_do_renamefile($res, $newname);
 cloudstorage_cloudfiles_do_reset($res);
 cloudstorage_cloudfiles_do_upload($res);

Remarks

The CloudFiles class provides a single interface that can be used to work with a variety of services. By supporting multiple providers with a single API code may be written once and used to support multiple services. The following providers are currently supported by this class:

• Amazon S3
• Azure Blob
• Azure File
• Backblaze B2
• Box.com
• Digital Ocean Spaces
• Dropbox
• Google Cloud Storage
• Google Drive
• Hadoop DFS
• IBM Cloud Object Storage
• Linode Object Storage
• Microsoft OneDrive
• Wasabi

The class supports simple file and folder management as well as encryption. Capabilities include uploading and downloading files, strong encryption support, creating folders, and more.

To begin, first create an account and register your application. Consult the documentation of the individual service provider for instructions on this process.

Authentication

The following providers use OAuth 2.0 for authentication:

• Box.com
• Dropbox
• Google Cloud Storage*
• Google Drive
• Microsoft OneDrive

Use the OAuth class included in the toolkit, or any other OAuth implementation to perform authentication and retrieve an authorization string. Once you've obtained an authorization string like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ

To authenticate with the remaining providers, set the Account properties shown in the table below:

*Google Cloud Storage supports two authentication methods. To authenticate with OAuth 2.0 (preferred) set the Authorization property and the AccountProjectId property. To authenticate with an access and secret key, set the AccountAccessKey and AccountSecretKey properties instead.

Selecting a Provider

To specify the provider simply set ServiceProvider. This tells the class to which service requests will be made.

Listing Files and Folders

ListDirectory lists files and folder the path specified by RemotePath.

The directory entries are provided through the DirList event and also via the DirList property.

 
 Copy
cloudfiles.RemoteFile = ""; //Clear filemask
cloudfiles.RemotePath = "MyFolder";
cloudfiles.ListDirectory();
for (int i = 0; i < cloudfiles.DirList.Count; i++)
{
  Console.WriteLine(cloudfiles.DirList[i].FileName);
  Console.WriteLine(cloudfiles.DirList[i].FileSize);
  Console.WriteLine(cloudfiles.DirList[i].FileTime);
  Console.WriteLine(cloudfiles.DirList[i].IsDir);
}

The RemoteFile property may also be used as a filemask when listing files. For instance:

 
 Copy
component.RemoteFile = "*.txt"
component.ListDirectory()

Note: Since RemoteFile is used as a filemask be sure to clear or reset this value before calling ListDirectory

Downloading Files

The Download method downloads a specific file.

Set RemoteFile to the name the file to download before calling this method. If RemoteFile only specifies a filename it will be downloaded from the path specified by RemotePath. RemoteFile may also be set to an absolute path.

If LocalFile is set the file will be saved to the specified location. If LocalFile is not set the file data will be held by ResourceData.

To decrypt an encrypted file set EncryptionAlgorithm and EncryptionPassword before calling this method.

 
 Copy
cloudfiles.RemotePath = "My Folder";
cloudfiles.RemoteFile = "MyFile.zip";
cloudfiles.LocalFile = "../MyFile.zip";
cloudfiles.Download();

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If the download was interrupted, set StartByte to the appropriate offset before calling this method to resume the download.

 
 Copy
cloudfiles.RemotePath = myRemoteFolder;
cloudfiles.RemoteFile = myRemoteFile;
cloudfiles.LocalFile = downloadFile;
cloudfiles.Download();

//The transfer is interrupted and Download() above fails. Later, resume the download:

//Get the size of the partially downloaded file
cloudfiles.StartByte = new FileInfo(downloadFile).Length; 
cloudfiles.RemotePath = myRemoteFolder;
cloudfiles.RemoteFile = myRemoteFile;
cloudfiles.LocalFile = downloadFile;
cloudfiles.Download();

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt. When beginning an encrypted download if LocalFile is set the class will create a temporary file in TempPath to hold the encrypted data until it is complete.

If the download is interrupted DownloadTempFile will be populated with the temporary file holding the partial data. When resuming, DownloadTempFile must be populated along with StartByte to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile.

 
 Copy
cloudfiles.RemotePath = myRemoteFolder;
cloudfiles.RemoteFile = myRemoteFile;
cloudfiles.LocalFile = downloadFile;
cloudfiles.EncryptionPassword = "password";
cloudfiles.Download();

//The transfer is interrupted and Download() above fails. Later, resume the download:

//Get the size of the partially download temp file
cloudfiles.StartByte = new FileInfo(cloudfiles.Config("DownloadTempFile")).Length; 
cloudfiles.RemotePath = myRemoteFolder;
cloudfiles.RemoteFile = myRemoteFile;
cloudfiles.LocalFile = downloadFile;
cloudfiles.EncryptionPassword = "password";
cloudfiles.Download();

Uploading Files

The Upload method is used to upload files.

RemoteFile should be set to either a relative or absolute path. If RemoteFile is not an absolute path it will be uploaded relative to RemotePath.

To encrypt a file before uploading set EncryptionAlgorithm and EncryptionPassword.

Note: Resuming uploads is not currently supported.

Code Example:

 
 Copy
//Upload with a relative path
cloudfiles.LocalFile = "C:\localfile.txt"
cloudfiles.RemoteFile = "remotefile.txt"
cloudfiles.Upload()

//Upload with an absolute path
cloudfiles.LocalFile = "C:\localfile2.txt"
cloudfiles.RemoteFile = "/folder/remotefile2.txt"
cloudfiles.Upload()

Additional Functionality

The CloudFiles class offers advanced functionality beyond simple uploads and downloads. For instance:

• Encrypt and decrypt files using EncryptionAlgorithm and EncryptionPassword.
• DeleteFile provides a way to delete files.
• MakeDirectory and RemoveDirectory support creating and deleting folders.
• RenameFile allows renaming of existing files on the server.
• And more!

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AccountAccessKey Property (CloudStorage_CloudFiles Class)

A storage service provider access key.

Object Oriented Interface

public function getAccountAccessKey();
public function setAccountAccessKey($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 1 );
cloudstorage_cloudfiles_set($res, 1, $value );

Default Value

''

Remarks

A storage service provider access key.

This property specifies the access key to use for authentication. It must be populated when using one of these storage service providers:

• cspAmazonS3 (0)
• cspAzureBlob (6)
• cspWasabi (7)
• cspDigitalOcean (8)
• cspGoogleStorage (9) (only if Authorization and AccountProjectId are not populated)
• cspAzureFile (11)
• cspIBMStorage (13)
• cspLinode (14)

Data Type

String

AccountAccount Property (CloudStorage_CloudFiles Class)

A storage service provider account string.

Object Oriented Interface

public function getAccountAccount();
public function setAccountAccount($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 2 );
cloudstorage_cloudfiles_set($res, 2, $value );

Default Value

''

Remarks

A storage service provider account string.

This property specifies the account string to use for authentication. It must be populated when using one of these storage service providers:

• cspAzureBlob (6)
• cspAzureFile (11)

Data Type

String

AccountApplicationKey Property (CloudStorage_CloudFiles Class)

A storage service provider application key.

Object Oriented Interface

public function getAccountApplicationKey();
public function setAccountApplicationKey($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 3 );
cloudstorage_cloudfiles_set($res, 3, $value );

Default Value

''

Remarks

A storage service provider application key.

This property specifies the application key to use for authentication. It must be populated when using one of these storage service providers:

• cspBackblazeB2 (12)

Data Type

String

AccountApplicationKeyId Property (CloudStorage_CloudFiles Class)

A storage service provider application key Id.

Object Oriented Interface

public function getAccountApplicationKeyId();
public function setAccountApplicationKeyId($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 4 );
cloudstorage_cloudfiles_set($res, 4, $value );

Default Value

''

Remarks

A storage service provider application key Id.

This property specifies the application key Id to use for authentication. It must be populated when using one of these storage service providers:

• cspBackblazeB2 (12)

Data Type

String

AccountAuthMechanism Property (CloudStorage_CloudFiles Class)

The HTTP authentication scheme to use (for storage service providers that support multiple).

Object Oriented Interface

public function getAccountAuthMechanism();
public function setAccountAuthMechanism($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 5 );
cloudstorage_cloudfiles_set($res, 5, $value );

Default Value

0

Remarks

The HTTP authentication scheme to use (for storage service providers that support multiple).

For storage service providers that support more than one HTTP authentication scheme, this property specifies which should be used. This property is only relevant for the following storage service providers:

• cspHadoopDFS (10)

Usage

Possible values for this property are:

When set to camSimple (1), the value of the AccountUser property is automatically sent in every request using the user.name query parameter. (Note: This authentication scheme is only valid for the cspHadoopDFS (10) storage service provider.)

When set to camBasic (2), camNTLM (3), or camNegotiate (4), the values held by the AccountUser and AccountPassword properties will be used to perform Basic, NTLM, or Negotiate authentication.

When set to camOAuth (5), the value of the Authorization property is automatically sent in every request using the Authorization HTTP header.

Data Type

Integer

AccountHadoopURL Property (CloudStorage_CloudFiles Class)

The URL of the Hadoop WebHDFS server.

Object Oriented Interface

public function getAccountHadoopURL();
public function setAccountHadoopURL($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 6 );
cloudstorage_cloudfiles_set($res, 6, $value );

Default Value

''

Remarks

The URL of the Hadoop WebHDFS server.

This property specifies the URL of the Hadoop WebHDFS server to make requests against. It must be set when ServiceProvider is set to cspHadoopDFS (10).

A full WebHDFS URL looks like http[s]://<HOST>:<PORT>/webhdfs/v1. The class will automatically append /webhdfs/v1 when making requests (if necessary).

The class automatically detects whether to secure the connection using SSL/TLS based on whether the value begins with http (not secured) or https (secured).

Data Type

String

AccountPassword Property (CloudStorage_CloudFiles Class)

A storage service provider password.

Object Oriented Interface

public function getAccountPassword();
public function setAccountPassword($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 7 );
cloudstorage_cloudfiles_set($res, 7, $value );

Default Value

''

Remarks

A storage service provider password.

This property specifies the password to use for authentication. It must be populated when using one of these storage service providers:

• cspHadoopDFS (10) (only required for certain AccountAuthMechanism options)

Data Type

String

AccountProjectId Property (CloudStorage_CloudFiles Class)

A Google Cloud Platform project Id string.

Object Oriented Interface

public function getAccountProjectId();
public function setAccountProjectId($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 8 );
cloudstorage_cloudfiles_set($res, 8, $value );

Default Value

''

Remarks

A Google Cloud Platform project Id string.

This property specifies the Google Cloud Platform project Id string to use for authentication. It must be set when using OAuth 2.0 authentication (i.e., the Authorization property is populated) with one of these storage service providers:

• cspGoogleStorage (9)

Note that the above providers will fall back to using an AccountAccessKey and AccountSecretKey for authentication if either this property or the Authorization property is empty.

Data Type

String

AccountSecretKey Property (CloudStorage_CloudFiles Class)

A storage service provider access key.

Object Oriented Interface

public function getAccountSecretKey();
public function setAccountSecretKey($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 9 );
cloudstorage_cloudfiles_set($res, 9, $value );

Default Value

''

Remarks

A storage service provider access key.

This property specifies the access key to use for authentication. It must be populated when using one of these storage service providers:

• cspAmazonS3 (0)
• cspWasabi (7)
• cspDigitalOcean (8)
• cspGoogleStorage (9) (only if Authorization and AccountProjectId are not populated)
• cspIBMStorage (13)
• cspLinode (14)

Data Type

String

AccountUser Property (CloudStorage_CloudFiles Class)

A storage service provider user name.

Object Oriented Interface

public function getAccountUser();
public function setAccountUser($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 10 );
cloudstorage_cloudfiles_set($res, 10, $value );

Default Value

''

Remarks

A storage service provider user name.

This property specifies the user name to use for authentication. It must be populated when using one of these storage service providers:

• cspHadoopDFS (10) (only required for certain AccountAuthMechanism options)

Data Type

String

Authorization Property (CloudStorage_CloudFiles Class)

OAuth 2.0 Authorization Token.

Object Oriented Interface

public function getAuthorization();
public function setAuthorization($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 11 );
cloudstorage_cloudfiles_set($res, 11, $value );

Default Value

''

Remarks

This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property, using the OAuth class or a separate process. If using the OAuth property, then the Authorization property will not be used.

Bearer ACCESS_TOKEN

Data Type

String

DirListCount Property (CloudStorage_CloudFiles Class)

The number of records in the DirList arrays.

Object Oriented Interface

public function getDirListCount();

Procedural Interface

cloudstorage_cloudfiles_get($res, 12 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DirListFileName
• DirListFileSize
• DirListFileTime
• DirListIsDir

The array indices start at 0 and end at DirListCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

DirListFileName Property (CloudStorage_CloudFiles Class)

This property holds the name of the file or folder.

Object Oriented Interface

public function getDirListFileName($entryindex);

Procedural Interface

cloudstorage_cloudfiles_get($res, 13 , $entryindex);

Default Value

''

Remarks

This property holds the name of the file or folder.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only and not available at design time.

Data Type

String

DirListFileSize Property (CloudStorage_CloudFiles Class)

This property holds the size of the file in bytes.

Object Oriented Interface

public function getDirListFileSize($entryindex);

Procedural Interface

cloudstorage_cloudfiles_get($res, 14 , $entryindex);

Default Value

0

Remarks

This property holds the size of the file in bytes. This is also applicable to folders for depending on the ServiceProvider.

The table below summarizes the applicability of this value on a per-provider basis:

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only and not available at design time.

Data Type

Long64

DirListFileTime Property (CloudStorage_CloudFiles Class)

This property holds the modified date of the file.

Object Oriented Interface

public function getDirListFileTime($entryindex);

Procedural Interface

cloudstorage_cloudfiles_get($res, 15 , $entryindex);

Default Value

''

Remarks

This property holds the modified date of the file. By default the datetime format used is "yyyy-MM-dd'T'HH:mm:ss". To modify this format set DateFormat.

Note: Modified times are not applicable to directories for the following providers:

• cspAmazonS3 (0)
• cspDropbox (2)
• cspWasabi (7)
• cspDigitalOcean (8)
• cspGoogleStorage (9)
• cspBackblazeB2 (12)
• cspIBMStorage (13)
• cspLinode (14)

Additionally, the following providers do not return modified times at all:

• cspAzureFile (11)

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only and not available at design time.

Data Type

String

DirListIsDir Property (CloudStorage_CloudFiles Class)

This property specifies whether the entry is a directory.

Object Oriented Interface

public function getDirListIsDir($entryindex);

Procedural Interface

cloudstorage_cloudfiles_get($res, 16 , $entryindex);

Default Value

false

Remarks

This property specifies whether the entry is a directory. If false the entry is a file.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only and not available at design time.

Data Type

Boolean

EncryptionAlgorithm Property (CloudStorage_CloudFiles Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 17 );
cloudstorage_cloudfiles_set($res, 17, $value );

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

Data Type

Integer

EncryptionPassword Property (CloudStorage_CloudFiles Class)

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();
public function setEncryptionPassword($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 18 );
cloudstorage_cloudfiles_set($res, 18, $value );

Default Value

''

Remarks

If this property is populated when UploadFile or DownloadFile is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (CloudStorage_CloudFiles Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 19 );
cloudstorage_cloudfiles_set($res, 19, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CloudStorage_CloudFiles Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 20 );
cloudstorage_cloudfiles_set($res, 20, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudStorage_CloudFiles Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 21 );
cloudstorage_cloudfiles_set($res, 21, $value );

Default Value

''

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (CloudStorage_CloudFiles Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 22 );
cloudstorage_cloudfiles_set($res, 22, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (CloudStorage_CloudFiles Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 23 );
cloudstorage_cloudfiles_set($res, 23, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (CloudStorage_CloudFiles Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 24 );
cloudstorage_cloudfiles_set($res, 24, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (CloudStorage_CloudFiles Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudstorage_cloudfiles_get($res, 25 );

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (CloudStorage_CloudFiles Class)

The location of the local file.

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 26 );
cloudstorage_cloudfiles_set($res, 26, $value );

Default Value

''

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling Upload, and as the destination file when calling Download.

Data Type

String

LocalHost Property (CloudStorage_CloudFiles Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 27 );
cloudstorage_cloudfiles_set($res, 27, $value );

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

Overwrite Property (CloudStorage_CloudFiles Class)

Whether to overwrite the local or remote file.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 28 );
cloudstorage_cloudfiles_set($res, 28, $value );

Default Value

false

Remarks

When calling DownloadFile, this property determines if LocalFile should be overwritten if it already exists.

When calling UploadFile, this property determines if the remote file should be overwritten if it already exists.

Data Type

Boolean

ProxyAuthScheme Property (CloudStorage_CloudFiles Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 29 );
cloudstorage_cloudfiles_set($res, 29, $value );

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the class will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (CloudStorage_CloudFiles Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 30 );
cloudstorage_cloudfiles_set($res, 30, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CloudStorage_CloudFiles Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 31 );
cloudstorage_cloudfiles_set($res, 31, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (CloudStorage_CloudFiles Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 32 );
cloudstorage_cloudfiles_set($res, 32, $value );

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (CloudStorage_CloudFiles Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 33 );
cloudstorage_cloudfiles_set($res, 33, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (CloudStorage_CloudFiles Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 34 );
cloudstorage_cloudfiles_set($res, 34, $value );

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (CloudStorage_CloudFiles Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 35 );
cloudstorage_cloudfiles_set($res, 35, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RemoteFile Property (CloudStorage_CloudFiles Class)

The name of the remote file.

Object Oriented Interface

public function getRemoteFile();
public function setRemoteFile($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 36 );
cloudstorage_cloudfiles_set($res, 36, $value );

Default Value

''

Remarks

This property contains the name of the remote file to upload or download. This value is either an absolute or relative path based on RemotePath.

Example (Setting RemoteFile)

 
 Copy
component.LocalFile = "C:\\test.txt";
component.RemoteFile = "test.txt";
component.Upload();

component.LocalFile = "C:\\test.txt";
component.RemoteFile = "/MyFolder/SubFolder/file.txt";
component.Upload();

Example (Using RemoteFile as a file mask):

 
 Copy
component.RemoteFile = "*.txt"
component.ListDirectory()

The following special characters are supported for pattern matching:

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

Data Type

String

RemotePath Property (CloudStorage_CloudFiles Class)

The current path on the server.

Object Oriented Interface

public function getRemotePath();
public function setRemotePath($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 37 );
cloudstorage_cloudfiles_set($res, 37, $value );

Default Value

''

Remarks

This property shows the current working directory on the server. It can also be used to change the working directory by setting an absolute or relative path.

If the path begins with a "/" it is considered an absolute path.

If the first two characters of the path are ".." this indicates a change to the parent directory.

Example (Changing Directory)

 
 Copy
component.RemotePath = "/MyFolder/Child"; //absolute
component.RemotePath = "GrandChild"; //relative, change to a sub-folder of the current directory
component.RemotePath = "../.."; //relative, use ".." to navigate to parent folders

Data Type

String

ServiceProvider Property (CloudStorage_CloudFiles Class)

The storage service provider.

Object Oriented Interface

public function getServiceProvider();
public function setServiceProvider($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 38 );
cloudstorage_cloudfiles_set($res, 38, $value );

Default Value

0

Remarks

This property specifies the storage service provider which will be used. It is important to note that the ServiceProvider property must be set before setting any configuration settings through the Config method.

Possible values are:

• cspAmazonS3 (0) (default): Amazon S3
• cspBox (1): Box.com
• cspDropbox (2): Dropbox
• cspGoogleDrive (3): Google Drive
• cspOneDrive (4): Microsoft OneDrive
• cspAzureBlob (6): Azure Blob
• cspWasabi (7): Wasabi
• cspDigitalOcean (8): Digital Ocean Spaces
• cspGoogleStorage (9): Google Cloud Storage
• cspHadoopDFS (10): Hadoop DFS
• cspAzureFile (11): Azure File
• cspBackblazeB2 (12): Backblaze B2
• cspIBMStorage (13): IBM Cloud Object Storage
• cspLinode (14): Linode Object Storage

This property is not available at design time.

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (CloudStorage_CloudFiles Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudstorage_cloudfiles_get($res, 39 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (CloudStorage_CloudFiles Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudstorage_cloudfiles_get($res, 40 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudStorage_CloudFiles Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_cloudfiles_get($res, 41 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (CloudStorage_CloudFiles Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudstorage_cloudfiles_get($res, 42 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (CloudStorage_CloudFiles Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_cloudfiles_get($res, 43 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (CloudStorage_CloudFiles Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_cloudfiles_get($res, 44 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (CloudStorage_CloudFiles Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudstorage_cloudfiles_get($res, 45 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (CloudStorage_CloudFiles Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudstorage_cloudfiles_get($res, 46 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (CloudStorage_CloudFiles Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_cloudfiles_get($res, 47 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (CloudStorage_CloudFiles Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_cloudfiles_get($res, 48 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (CloudStorage_CloudFiles Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudstorage_cloudfiles_get($res, 49 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (CloudStorage_CloudFiles Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_cloudfiles_get($res, 50 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (CloudStorage_CloudFiles Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudstorage_cloudfiles_get($res, 51 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (CloudStorage_CloudFiles Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudstorage_cloudfiles_get($res, 52 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (CloudStorage_CloudFiles Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_cloudfiles_get($res, 53 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (CloudStorage_CloudFiles Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 54 );
cloudstorage_cloudfiles_set($res, 54, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudStorage_CloudFiles Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 55 );
cloudstorage_cloudfiles_set($res, 55, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (CloudStorage_CloudFiles Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 56 );
cloudstorage_cloudfiles_set($res, 56, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (CloudStorage_CloudFiles Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudstorage_cloudfiles_get($res, 57 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudStorage_CloudFiles Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudstorage_cloudfiles_get($res, 58 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (CloudStorage_CloudFiles Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_cloudfiles_get($res, 59 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (CloudStorage_CloudFiles Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_cloudfiles_get($res, 60 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (CloudStorage_CloudFiles Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudstorage_cloudfiles_get($res, 61 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudStorage_CloudFiles Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudstorage_cloudfiles_get($res, 62 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (CloudStorage_CloudFiles Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudstorage_cloudfiles_get($res, 63 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (CloudStorage_CloudFiles Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 64 );
cloudstorage_cloudfiles_set($res, 64, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (CloudStorage_CloudFiles Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 65 );
cloudstorage_cloudfiles_set($res, 65, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (CloudStorage_CloudFiles Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudstorage_cloudfiles_get($res, 66 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudStorage_CloudFiles Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudstorage_cloudfiles_get($res, 67 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudStorage_CloudFiles Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudstorage_cloudfiles_get($res, 68 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudStorage_CloudFiles Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudstorage_cloudfiles_get($res, 69 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudStorage_CloudFiles Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudstorage_cloudfiles_get($res, 70 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudStorage_CloudFiles Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudstorage_cloudfiles_get($res, 71 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudStorage_CloudFiles Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudstorage_cloudfiles_get($res, 72 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudStorage_CloudFiles Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudstorage_cloudfiles_get($res, 73 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudStorage_CloudFiles Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_cloudfiles_get($res, 74 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudStorage_CloudFiles Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudstorage_cloudfiles_get($res, 75 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudStorage_CloudFiles Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudstorage_cloudfiles_get($res, 76 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudStorage_CloudFiles Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_cloudfiles_get($res, 77 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudStorage_CloudFiles Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudstorage_cloudfiles_get($res, 78 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudStorage_CloudFiles Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudstorage_cloudfiles_get($res, 79 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudStorage_CloudFiles Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudstorage_cloudfiles_get($res, 80 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (CloudStorage_CloudFiles Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 81 );
cloudstorage_cloudfiles_set($res, 81, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CloudStorage_CloudFiles Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 82 );
cloudstorage_cloudfiles_set($res, 82, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (CloudStorage_CloudFiles Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 83 );
cloudstorage_cloudfiles_set($res, 83, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Data Type

Integer

SSLCertSubjectAltNames Property (CloudStorage_CloudFiles Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudstorage_cloudfiles_get($res, 84 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudStorage_CloudFiles Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudstorage_cloudfiles_get($res, 85 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudStorage_CloudFiles Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudstorage_cloudfiles_get($res, 86 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudStorage_CloudFiles Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudstorage_cloudfiles_get($res, 87 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudStorage_CloudFiles Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudstorage_cloudfiles_get($res, 88 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudStorage_CloudFiles Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudstorage_cloudfiles_get($res, 89 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudStorage_CloudFiles Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudstorage_cloudfiles_get($res, 90 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudStorage_CloudFiles Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 91 );
cloudstorage_cloudfiles_set($res, 91, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (CloudStorage_CloudFiles Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 92 );
cloudstorage_cloudfiles_set($res, 92, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (CloudStorage_CloudFiles Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 93 );
cloudstorage_cloudfiles_set($res, 93, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (CloudStorage_CloudFiles Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudstorage_cloudfiles_get($res, 94 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (CloudStorage_CloudFiles Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudstorage_cloudfiles_get($res, 95 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudStorage_CloudFiles Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_cloudfiles_get($res, 96 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (CloudStorage_CloudFiles Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudstorage_cloudfiles_get($res, 97 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (CloudStorage_CloudFiles Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_cloudfiles_get($res, 98 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (CloudStorage_CloudFiles Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_cloudfiles_get($res, 99 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (CloudStorage_CloudFiles Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudstorage_cloudfiles_get($res, 100 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (CloudStorage_CloudFiles Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudstorage_cloudfiles_get($res, 101 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (CloudStorage_CloudFiles Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_cloudfiles_get($res, 102 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (CloudStorage_CloudFiles Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_cloudfiles_get($res, 103 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (CloudStorage_CloudFiles Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudstorage_cloudfiles_get($res, 104 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (CloudStorage_CloudFiles Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_cloudfiles_get($res, 105 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (CloudStorage_CloudFiles Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudstorage_cloudfiles_get($res, 106 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (CloudStorage_CloudFiles Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudstorage_cloudfiles_get($res, 107 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (CloudStorage_CloudFiles Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_cloudfiles_get($res, 108 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (CloudStorage_CloudFiles Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudstorage_cloudfiles_get($res, 109 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudStorage_CloudFiles Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudstorage_cloudfiles_get($res, 110 );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (CloudStorage_CloudFiles Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudstorage_cloudfiles_get($res, 111 );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudStorage_CloudFiles Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudstorage_cloudfiles_get($res, 112 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudStorage_CloudFiles Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudstorage_cloudfiles_get($res, 113 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (CloudStorage_CloudFiles Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_cloudfiles_get($res, 114 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (CloudStorage_CloudFiles Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_cloudfiles_get($res, 115 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (CloudStorage_CloudFiles Class)

The text description of UsageFlags .

Object Oriented Interface