BackblazeB2 Component
Properties Methods Events Config Settings Errors
The BackblazeB2 component offers an easy to use interface for Backblaze's B2 Cloud Storage service.
Syntax
nsoftware.CloudStorage.BackblazeB2
Remarks
The BackblazeB2 component provides an easy-to-use API for the Backblaze B2 Cloud Storage service. Capabilities include uploading and downloading files, bucket management, strong encryption support, and more.
Authentication
Authentication works by exchanging a known application key (which consists of a key Id and the key string itself) for an authorization token which is then used to authorize all further requests. The authentication process also returns information about the account, the capabilities and restrictions associated with the application key, and other details that help the component interact with the Backblaze B2 API.
To authenticate the component with the server, supply an application key using the ApplicationKeyId and ApplicationKey properties, and then call Authorize. This will populate the Account property with the aforementioned information, including the Account.AuthToken.
Eventually, the authorization token returned during the authentication process will expire, at which point it should be exchanged for a new one by calling Authorize again.
Usage
Once authenticated, you can start interacting with the Backblaze B2 Cloud Storage service. The following list shows some of the methods used to accomplish common tasks:
- Bucket management: ListBuckets, GetBucketInfo, CreateBucket, UpdateBucket, DeleteBucket
- File management: ListFiles, ListFileVersions, GetFileInfo, UploadFile, CopyFile, DownloadFile, DownloadFileById, HideFile, DeleteFile, DeleteFileVersion
- Multipart uploads: ListMultipartUploads, StartMultipartUpload, CompleteMultipartUpload, AbortMultipartUpload, ListParts, UploadPart, CopyPart
- Application key management: ListAppKeys, CreateAppKey, DeleteAppKey
- Sharing files: GetDownloadAuthToken
Refer to the complete API, below, for more information.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
Account | Details about the account and restrictions associated with currently-authenticated application key. |
AppKeyMarker | A marker indicating what page of application keys to return next. |
AppKeys | A collection of application keys. |
ApplicationKey | The application key to use for authentication. |
ApplicationKeyId | The application key Id to use for authentication. |
Buckets | A collection of buckets. |
ContentType | The content type to send for a file. |
Delimiter | The delimiter string to use when listing files. |
EncryptionAlgorithm | The encryption algorithm. |
EncryptionPassword | The encryption password. |
FileData | The data that was downloaded, or that should be uploaded. |
FileMarker | A marker indicating what page of files to return next. |
Files | A collection of files. |
Firewall | A set of properties related to firewall access. |
Idle | This property specifies the current status of the component. |
LocalFile | The location of the local file. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Metadata | A collection of metadata items. |
OtherHeaders | This property includes other headers as determined by the user (optional). |
Overwrite | Determines if local files are overwritten. |
ParsedHeaders | This property includes a collection of headers returned from the last request. |
PartMarker | A marker indicating what page of parts to return next. |
Parts | A collection of multipart upload parts. |
Prefix | A prefix used to restrict the results returned when listing files. |
Proxy | A set of properties related to proxy access. |
QueryParams | Additional query parameters to be included in the request. |
Range | The range of bytes to request. |
SSLAcceptServerCert | This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
StartByte | The byte offset from which to resume the upload or download. |
Timeout | This property includes the timeout for the component. |
VersionMarker | A marker indicating what page of file versions to return next. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AbortMultipartUpload | Aborts a multipart upload. |
AddMetadata | Adds a metadata item to the Metadata properties. |
AddQueryParam | Adds a query parameter to the QueryParams properties. |
Authorize | Authenticates the component with the server using the current application key and Id. |
CompleteMultipartUpload | Completes a multipart upload by assembling the previously uploaded parts. |
Config | Sets or retrieves a configuration setting. |
CopyFile | Copies a file. |
CopyPart | Copies the specified file as part of a multipart upload. |
CreateAppKey | Creates a new application key. |
CreateBucket | Creates a new bucket. |
DeleteAppKey | Deletes an application key. |
DeleteBucket | Deletes a bucket. |
DeleteFile | Deletes all versions of a file. |
DeleteFileVersion | Deletes a file version. |
DownloadFile | Downloads a file by name. |
DownloadFileById | Downloads a file by Id. |
GetBucketInfo | Gets a bucket's information and metadata. |
GetDownloadAuthToken | Create a download authorization token for one or more files in a bucket. |
GetFileInfo | Gets a file's information and metadata. |
HideFile | Hides a file. |
Interrupt | This method interrupts the current method. |
ListAppKeys | Lists the account's application keys. |
ListBuckets | Lists all buckets in the account. |
ListFiles | Lists the files in a bucket. |
ListFileVersions | Lists the file versions in a bucket. |
ListMultipartUploads | Lists the in-progress multipart uploads in a bucket. |
ListParts | Lists a multipart upload's parts. |
Reset | Resets the component to its initial state. |
SendCustomRequest | Sends a custom request to the Backblaze B2 API. |
SetDownloadStream | Sets the stream to which downloaded data will be written. |
SetUploadStream | Sets the stream from which data is read when uploading. |
StartMultipartUpload | Starts a new multipart upload. |
UpdateBucket | Updates a bucket's kind and/or metadata. |
UploadFile | Uploads a file. |
UploadPart | Uploads a multipart upload part. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
AppKeyList | Fires once for each application key returned when listing application keys. |
BucketList | Fires once for each bucket returned when listing buckets. |
EndTransfer | This event fires when a document finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
FileList | Fires once for each file returned when listing files. |
FragmentComplete | Fires after each part in an automatic multipart upload is complete. |
Header | This event is fired every time a header line comes in. |
Log | This event fires once for each log message. |
MetadataList | Fires once for each metadata item returned when bucket or file information and metadata is retrieved. |
PartList | Fires once for each part returned when listing a multipart upload's parts. |
Progress | Fires during an upload or download to indicate transfer progress. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event fires when a document starts transferring (after the headers). |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AccumulatePages | Whether the component should accumulate subsequent pages of results when listing them. |
APIURL | The base URL used for all except download and upload requests. |
APIVersion | The Backblaze B2 REST API version being used by the component. |
ClientModifiedTime | The client-side last modified time. |
DownloadAuthToken | The download authorization token to use. |
DownloadTempFile | The temporary file used when downloading encrypted data. |
DownloadURL | The base URL used for download requests. |
EncryptionIV | The initialization vector to be used for encryption/decryption. |
EncryptionKey | The key to use during encryption/decryption. |
EncryptionPasswordKDF | The KDF algorithm to use during password based encryption and decryption. |
FragmentSize | The part size to use when uploading a new file. |
IfRevision | The revision number that the bucket must currently have in order for a request to succeed. |
ListWithMetadata | Whether to include metadata items when listing buckets, files, etc. |
MaxAppKeyResults | The maximum number of results to return when listing application keys. |
MaxPartResults | The maximum number of results to return when listing parts. |
MaxResults | The maximum number of results to return when listing files or file versions. |
ProgressAbsolute | Whether the component should track transfer progress absolutely. |
ProgressStep | How often the progress event should be fired, in terms of percentage. |
RawRequest | Returns the data that was sent to the server. |
RawResponse | Returns the data that was received from the server. |
ResumableUploadState | Tracks upload state information during an automatic multipart upload. |
SendMetadataOnCopy | Whether to send metadata items when copying files. |
SimpleUploadLimit | The maximum data size the component should attempt to upload directly when creating a file. |
TempPath | The path to the directory where temporary files are created. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the component will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHTTPCookies | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the component binds to a SOCKS firewall as a server (TCPClient only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Account Property (BackblazeB2 Component)
Details about the account and restrictions associated with currently-authenticated application key.
Syntax
Remarks
This property holds an B2Account object with information about the account and restrictions associated with the currently-authenticated application key; it's populated after calling Authorize.
This property is read-only and not available at design time.
Please refer to the B2Account type for a complete list of fields.AppKeyMarker Property (BackblazeB2 Component)
A marker indicating what page of application keys to return next.
Syntax
Default Value
""
Remarks
This property will be populated when ListAppKeys is called if the results are paged and there are more pages. To list all application keys, continue to call ListAppKeys until this property returns empty string.
Refer to ListAppKeys for more information.
This property is not available at design time.
AppKeys Property (BackblazeB2 Component)
A collection of application keys.
Syntax
public B2AppKeyList AppKeys { get; }
Public ReadOnly Property AppKeys As B2AppKeyList
Remarks
This collection holds a list of B2AppKey items.
Calling ListAppKeys will populate this collection.
This property is read-only and not available at design time.
Please refer to the B2AppKey type for a complete list of fields.ApplicationKey Property (BackblazeB2 Component)
The application key to use for authentication.
Syntax
Default Value
""
Remarks
This property specifies the application key that should be used for authentication. Both this property and ApplicationKeyId must be set before attempting any operations which connect to the server.
ApplicationKeyId Property (BackblazeB2 Component)
The application key Id to use for authentication.
Syntax
Default Value
""
Remarks
This property specifies the application key Id that should be used for authentication. Both this property and ApplicationKey must be set before attempting any operations which connect to the server.
Buckets Property (BackblazeB2 Component)
A collection of buckets.
Syntax
public B2BucketList Buckets { get; }
Public ReadOnly Property Buckets As B2BucketList
Remarks
This collection holds a list of B2Bucket items.
Calling ListBuckets will populate this collection.
This property is read-only and not available at design time.
Please refer to the B2Bucket type for a complete list of fields.ContentType Property (BackblazeB2 Component)
The content type to send for a file.
Syntax
Default Value
""
Remarks
This property can be set before calling UploadFile, StartMultipartUpload, or (if the SendMetadataOnCopy configuration setting is enabled) CopyFile to have its value submitted as the file's Content-Type header value.
If this property is empty, the component will send b2/x-auto, which instructs the server to automatically determine the content type based on the file's extension (or set it to application/octet-stream if it cannot).
This property is not available at design time.
Delimiter Property (BackblazeB2 Component)
The delimiter string to use when listing files.
Syntax
Default Value
""
Remarks
If this property is non-empty when ListFiles or ListFileVersions is called, any items whose names contain the same string between the specified Prefix and the first occurrence of the specified delimiter that follow will be rolled up into a virtual "folder" element, which is returned in place of the individual files themselves.
If a particular item is a "folder" instead of an actual file or file version, then the Files.Kind field will be set to folder. The same is also true of the FileList event's Kind parameter.
File Hierarchy Traversal
By using the Delimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:
- MyCompany
- MyCompany/Department1
- MyCompany/Department2
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With Delimiter set to /, we can set Prefix to successively "deeper" values before calling ListFiles or ListFileVersions for the following effect:
Prefix Value | Files Returned | Folders Returned |
(empty) | MyCompany | MyCompany/ |
MyCompany/ | MyCompany/Department1
MyCompany/Department2 | MyCompany/Department2/ |
MyCompany/Department2/ | MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB | (none) |
This property is not available at design time.
EncryptionAlgorithm Property (BackblazeB2 Component)
The encryption algorithm.
Syntax
public BackblazeB2EncryptionAlgorithms EncryptionAlgorithm { get; set; }
enum BackblazeB2EncryptionAlgorithms { eaAES, eaBlowfish, eaCAST, eaDES, eaIDEA, eaRC2, eaRC4, eaTEA, eaTripleDES, eaTwofish, eaRijndael, eaChaCha, eaXSalsa20 }
Public Property EncryptionAlgorithm As Backblazeb2EncryptionAlgorithms
Enum BackblazeB2EncryptionAlgorithms eaAES eaBlowfish eaCAST eaDES eaIDEA eaRC2 eaRC4 eaTEA eaTripleDES eaTwofish eaRijndael eaChaCha eaXSalsa20 End Enum
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:
Algorithm | Key Size |
0 (eaAES - default) | 256 |
1 (eaBlowfish) | 448 |
2 (eaCAST) | 128 |
3 (eaDES) | 64 |
4 (eaIDEA) | 128 |
5 (eaRC2) | 128 |
6 (eaRC4) | 2048 |
7 (eaTEA) | 128 |
8 (eaTripleDES) | 192 |
9 (eaTwofish) | 256 |
10 (eaRijndael) | 256 |
11 (eaChaCha) | 256 |
12 (eaXSalsa20) | 256 |
EncryptionPassword Property (BackblazeB2 Component)
The encryption password.
Syntax
Default Value
""
Remarks
If this property is populated when UploadFile or DownloadFile is called, the component will attempt to encrypt or decrypt the data before uploading or after downloading it.
The component 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.
FileData Property (BackblazeB2 Component)
The data that was downloaded, or that should be uploaded.
Syntax
Default Value
""
Remarks
This property is populated with file data after calling DownloadFile or DownloadFileById if SetDownloadStream and LocalFile are not set.
This property can also be set before calling UploadFile or UploadPart; its data will be uploaded if SetUploadStream and LocalFile are not set.
This property is not available at design time.
FileMarker Property (BackblazeB2 Component)
A marker indicating what page of files to return next.
Syntax
Default Value
""
Remarks
This property will be populated when ListFiles or ListMultipartUploads is called if the results are paged and there are more pages. To list all files or multipart uploads, continue to call ListFiles or ListMultipartUploads (respectively) until this property returns empty string.
Refer to ListFiles or ListMultipartUploads for more information.
This property is not available at design time.
Files Property (BackblazeB2 Component)
A collection of files.
Syntax
public B2FileList Files { get; }
Public ReadOnly Property Files As B2FileList
Remarks
This collection holds a list of B2File items.
Calling GetFileInfo, ListFiles, ListFileVersions, or ListMultipartUploads will populate this collection.
This property is read-only and not available at design time.
Please refer to the B2File type for a complete list of fields.Firewall Property (BackblazeB2 Component)
A set of properties related to firewall access.
Syntax
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.
Please refer to the Firewall type for a complete list of fields.Idle Property (BackblazeB2 Component)
This property specifies the current status of the component.
Syntax
Default Value
True
Remarks
Idle 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.
LocalFile Property (BackblazeB2 Component)
The location of the local file.
Syntax
Default Value
""
Remarks
This property specifies the location of a file on disk. This is used as the source file when calling UploadFile or UploadPart; and as the destination file when calling DownloadFile or DownloadFileById.
Note: Setting this property to a non-empty value will discard any streams set using SetDownloadStream and SetUploadStream. Similarly, passing a non-null value to either of the aforementioned methods will clear this property.
LocalHost Property (BackblazeB2 Component)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
Default Value
""
Remarks
The LocalHost 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 component initiate connections (or accept in the case of server components) 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 component 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.
Metadata Property (BackblazeB2 Component)
A collection of metadata items.
Syntax
public B2MetadataList Metadata { get; }
Public Property Metadata As B2MetadataList
Remarks
This collection holds a list of B2Metadata items.
This collection is populated when GetBucketInfo or GetFileInfo is called; and its items are used anytime one of the following methods is called:
- CopyFile (if the SendMetadataOnCopy configuration setting is enabled)
- CreateBucket
- StartMultipartUpload
- UpdateBucket (if the NewMetadata parameter is true)
- UploadFile
Note that there is a limit of 10 metadata items per bucket and per file; the component does not enforce this limit, but the server will return an error if it is exceeded. For files specifically, any value set using the ClientModifiedTime configuration setting will count towards this limit; refer that setting's documentation for more information.
This property is not available at design time.
Please refer to the B2Metadata type for a complete list of fields.OtherHeaders Property (BackblazeB2 Component)
This property includes other headers as determined by the user (optional).
Syntax
Default Value
""
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the component beyond what is provided.
This property is not available at design time.
Overwrite Property (BackblazeB2 Component)
Determines if local files are overwritten.
Syntax
Default Value
False
Remarks
This property controls whether local files are overwritten when calling DownloadFile or DownloadFileById. It is only applicable to local files.
ParsedHeaders Property (BackblazeB2 Component)
This property includes a collection of headers returned from the last request.
Syntax
public HeaderList ParsedHeaders { get; }
Public ReadOnly Property ParsedHeaders As HeaderList
Remarks
This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.
MaxHeaders can be used to control the maximum number of headers saved.
This collection is indexed from 0 to count -1.
This property is read-only and not available at design time.
Please refer to the Header type for a complete list of fields.PartMarker Property (BackblazeB2 Component)
A marker indicating what page of parts to return next.
Syntax
Default Value
""
Remarks
This property will be populated when ListParts is called if the results are paged and there are more pages. To list all parts, continue to call ListParts until this property returns empty string.
Refer to ListParts for more information.
This property is not available at design time.
Parts Property (BackblazeB2 Component)
A collection of multipart upload parts.
Syntax
public B2PartList Parts { get; }
Public ReadOnly Property Parts As B2PartList
Remarks
This collection holds a list of B2Part items.
Calling ListParts will populate this collection.
This property is read-only and not available at design time.
Please refer to the B2Part type for a complete list of fields.Prefix Property (BackblazeB2 Component)
A prefix used to restrict the results returned when listing files.
Syntax
Default Value
""
Remarks
This property, if non-empty, is used to restrict the values returned by ListFiles, ListFileVersions, or ListMultipartUploads to only the items whose names begin with the given prefix.
Note: If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the Account.AllowedPrefix field being non-empty), then this property will automatically be set to that prefix if it is empty when one of the aforementioned methods is called.
File Hierarchy Traversal
By using the Delimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:
- MyCompany
- MyCompany/Department1
- MyCompany/Department2
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With Delimiter set to /, we can set Prefix to successively "deeper" values before calling ListFiles or ListFileVersions for the following effect:
Prefix Value | Files Returned | Folders Returned |
(empty) | MyCompany | MyCompany/ |
MyCompany/ | MyCompany/Department1
MyCompany/Department2 | MyCompany/Department2/ |
MyCompany/Department2/ | MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB | (none) |
This property is not available at design time.
Proxy Property (BackblazeB2 Component)
A set of properties related to proxy access.
Syntax
Remarks
This property contains fields describing the proxy through which the component will attempt to connect.
Please refer to the Proxy type for a complete list of fields.QueryParams Property (BackblazeB2 Component)
Additional query parameters to be included in the request.
Syntax
public QueryParamList QueryParams { get; }
Public Property QueryParams As QueryParamList
Remarks
This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.
Please refer to the QueryParam type for a complete list of fields.Range Property (BackblazeB2 Component)
The range of bytes to request.
Syntax
Default Value
""
Remarks
This property specifies the range of bytes to request from the server. If this property is non-empty when a DownloadFile or DownloadFileById request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.
There are two valid formats for this property's value:
- StartByte-
- StartByte-EndByte
Note: If the StartByte property is greater than zero when one of the aforementioned methods is called (i.e., when a download is being resumed), and this property is non-empty, the component will automatically advance the StartByte value in the specified range by StartByte bytes when sending the Range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.
This property is not available at design time.
SSLAcceptServerCert Property (BackblazeB2 Component)
This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate SSLAcceptServerCert { get; set; }
Public Property SSLAcceptServerCert As Certificate
Remarks
If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (BackblazeB2 Component)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate
Remarks
This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLProvider Property (BackblazeB2 Component)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public BackblazeB2SSLProviders SSLProvider { get; set; }
enum BackblazeB2SSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As Backblazeb2SSLProviders
Enum BackblazeB2SSLProviders sslpAutomatic sslpPlatform sslpInternal End Enum
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 component 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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.
When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
The .NET Standard library will always use the internal implementation on all platforms.
SSLServerCert Property (BackblazeB2 Component)
This property includes the server certificate for the last established connection.
Syntax
public Certificate SSLServerCert { get; }
Public ReadOnly Property SSLServerCert As Certificate
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Please refer to the Certificate type for a complete list of fields.StartByte Property (BackblazeB2 Component)
The byte offset from which to resume the upload or download.
Syntax
Default Value
0
Remarks
This property specifies the byte offset from which to resume an automatic multipart upload initiated by UploadFile, or a download initiated by DownloadFile or DownloadFileById. Refer to those methods' documentation for more information about resuming uploads and downloads.
When uploading from a stream, the component will always seek forward in the stream if the value of StartByte is greater than zero when UploadFile is called. Keep this in mind when resuming interrupted uploads.
This property is not available at design time.
Timeout Property (BackblazeB2 Component)
This property includes the timeout for the component.
Syntax
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.
The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the component throws an exception.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
VersionMarker Property (BackblazeB2 Component)
A marker indicating what page of file versions to return next.
Syntax
Default Value
""
Remarks
This property will be populated when ListFileVersions is called if the results are paged and there are more pages. To list all file versions, continue to call ListFileVersions until this property returns empty string.
Refer to ListFileVersions for more information.
This property is not available at design time.
AbortMultipartUpload Method (BackblazeB2 Component)
Aborts a multipart upload.
Syntax
public void AbortMultipartUpload(string multipartFileId); Async Version public async Task AbortMultipartUpload(string multipartFileId); public async Task AbortMultipartUpload(string multipartFileId, CancellationToken cancellationToken);
Public Sub AbortMultipartUpload(ByVal MultipartFileId As String) Async Version Public Sub AbortMultipartUpload(ByVal MultipartFileId As String) As Task Public Sub AbortMultipartUpload(ByVal MultipartFileId As String, cancellationToken As CancellationToken) As Task
Remarks
This method aborts the multipart upload of the file specified by MultipartFileId, and invalidates the given Id.
When this method is called, all parts that have been uploaded for the multipart upload are deleted from the server.
The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
AddMetadata Method (BackblazeB2 Component)
Adds a metadata item to the Metadata properties.
Syntax
Remarks
This method adds a metadata item with the given Name and Value to the Metadata collection. Name may be up to 50 characters in length, and must consist solely of letters, numbers, hyphens (-), and underscores (_). The server stores all metadata item names in lowercase.
A metadata item's name cannot start with b2- unless said name is one those explicitly defined by the Backblaze B2 API documentation. Keep in mind that the value of such a metadata item must comply with the format specified by the Backblaze B2 API documentation as well, otherwise the server will reject it.
Note that there is a limit of 10 metadata items per bucket and per file; the component does not enforce this limit, but the server will return an error if it is exceeded. For files specifically, any value set using the ClientModifiedTime configuration setting will count towards this limit; refer that setting's documentation for more information.
AddQueryParam Method (BackblazeB2 Component)
Adds a query parameter to the QueryParams properties.
Syntax
Remarks
This method is used to add a query parameter to the QueryParams collection. Name specifies the name of the parameter, and Value specifies the value of the parameter.
All specified Values will be URL encoded by the component automatically. Consult the service documentation for details on the available parameters.
Authorize Method (BackblazeB2 Component)
Authenticates the component with the server using the current application key and Id.
Syntax
public void Authorize(); Async Version public async Task Authorize(); public async Task Authorize(CancellationToken cancellationToken);
Public Sub Authorize() Async Version Public Sub Authorize() As Task Public Sub Authorize(cancellationToken As CancellationToken) As Task
Remarks
This method authenticates the component with the server using the values held by ApplicationKey and ApplicationKeyId. A successful call to this method will clear and repopulate the following:
- Account property
- APIURL configuration setting
- DownloadURL configuration setting
- FragmentSize configuration setting (if necessary; refer to its documentation for more information)
- SimpleUploadLimit configuration setting (if necessary; refer to its documentation for more information)
The component must authenticate with the server before any other requests can be attempted; the component will call it automatically if necessary. As part of the authentication process, the server returns an authorization token which must be used to authorize all further requests; this token is valid for up to 24 hours. When it expires, this method must be called again.
CompleteMultipartUpload Method (BackblazeB2 Component)
Completes a multipart upload by assembling the previously uploaded parts.
Syntax
public void CompleteMultipartUpload(string multipartFileId); Async Version public async Task CompleteMultipartUpload(string multipartFileId); public async Task CompleteMultipartUpload(string multipartFileId, CancellationToken cancellationToken);
Public Sub CompleteMultipartUpload(ByVal MultipartFileId As String) Async Version Public Sub CompleteMultipartUpload(ByVal MultipartFileId As String) As Task Public Sub CompleteMultipartUpload(ByVal MultipartFileId As String, cancellationToken As CancellationToken) As Task
Remarks
This method completes the multipart upload of the file specified by MultipartFileId. The server will assemble all of the parts that have been uploaded into a single file. (Note: The assembled file keeps MultipartFileId as its Id.)
Note that this method automatically calls ListParts internally to obtain the information needed to complete the multipart upload. This process does not alter the Parts collection, nor does it cause the PartList event to fire.
The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
Config Method (BackblazeB2 Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
CopyFile Method (BackblazeB2 Component)
Copies a file.
Syntax
public string CopyFile(string srcFileId, string destBucketId, string destFileName); Async Version public async Task<string> CopyFile(string srcFileId, string destBucketId, string destFileName); public async Task<string> CopyFile(string srcFileId, string destBucketId, string destFileName, CancellationToken cancellationToken);
Public Function CopyFile(ByVal SrcFileId As String, ByVal DestBucketId As String, ByVal DestFileName As String) As String Async Version Public Function CopyFile(ByVal SrcFileId As String, ByVal DestBucketId As String, ByVal DestFileName As String) As Task(Of String) Public Function CopyFile(ByVal SrcFileId As String, ByVal DestBucketId As String, ByVal DestFileName As String, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method copies the file version specified by SrcFileId to the bucket specified by DestBucketId with the name DestFileName. The Id of the newly-created file is returned. If DestBucketId is empty, the source file's bucket is used as the destination bucket.
DestFileName is subject to the same restrictions described in the UploadFile method's documentation; refer to it for more information. If a file named DestFileName already exists in the destination bucket, a new version of it is created.
If the SendMetadataOnCopy configuration setting is enabled, and the ContentType property, the Metadata collection, and/or the ClientModifiedTime configuration setting are non-empty, then their values will be applied to the destination file. Otherwise, the server will copy the source file's content type and metadata to the destination file.
Finally, note that this method can only be used to copy files up to 5GB in size (or, if Range is non-empty, a range of up to 5GB of data from a larger file). To copy more than 5GB of data, start a new multipart upload with StartMultipartUpload, and then use the CopyPart method to copy the desired data in parts.
The currently-authenticated application key must have the writeFiles and (if the source file's bucket kind is allPrivate) readFiles capabilities to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
CopyPart Method (BackblazeB2 Component)
Copies the specified file as part of a multipart upload.
Syntax
public void CopyPart(string srcFileId, string multipartFileId, int partNumber); Async Version public async Task CopyPart(string srcFileId, string multipartFileId, int partNumber); public async Task CopyPart(string srcFileId, string multipartFileId, int partNumber, CancellationToken cancellationToken);
Public Sub CopyPart(ByVal SrcFileId As String, ByVal MultipartFileId As String, ByVal PartNumber As Integer) Async Version Public Sub CopyPart(ByVal SrcFileId As String, ByVal MultipartFileId As String, ByVal PartNumber As Integer) As Task Public Sub CopyPart(ByVal SrcFileId As String, ByVal MultipartFileId As String, ByVal PartNumber As Integer, cancellationToken As CancellationToken) As Task
Remarks
This method copies the file version specified by SrcFileId to a new part in the multipart upload of the file specified by MultipartFileId. The part's number is specified by PartNumber; it must be a value in the range 1 to 10000, inclusive. If the specified multipart upload already has a part with the given PartNumber, it is replaced with the one created by this request.
All parts must be between 5MB and 5GB in size (except for the last part, which can be as small as 1 byte). The Range property can optionally be set before calling this method to copy only a specific range of data from the specified source file.
The currently-authenticated application key must have the writeFiles and (if the source file's bucket kind is allPrivate) readFiles capabilities to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
CreateAppKey Method (BackblazeB2 Component)
Creates a new application key.
Syntax
public string CreateAppKey(string keyName, string capabilities, string allowedBucketId, string allowedPrefix, long validityDuration); Async Version public async Task<string> CreateAppKey(string keyName, string capabilities, string allowedBucketId, string allowedPrefix, long validityDuration); public async Task<string> CreateAppKey(string keyName, string capabilities, string allowedBucketId, string allowedPrefix, long validityDuration, CancellationToken cancellationToken);
Public Function CreateAppKey(ByVal KeyName As String, ByVal Capabilities As String, ByVal AllowedBucketId As String, ByVal AllowedPrefix As String, ByVal ValidityDuration As Long) As String Async Version Public Function CreateAppKey(ByVal KeyName As String, ByVal Capabilities As String, ByVal AllowedBucketId As String, ByVal AllowedPrefix As String, ByVal ValidityDuration As Long) As Task(Of String) Public Function CreateAppKey(ByVal KeyName As String, ByVal Capabilities As String, ByVal AllowedBucketId As String, ByVal AllowedPrefix As String, ByVal ValidityDuration As Long, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method creates a new application key named KeyName with the specified Capabilities. If successful, this method returns a string containing the newly-created application key's Id, followed by the key itself, separated by a newline (\n) character; for example:
[application_key_id] [application_key]Important: This is the only time that the application key's key string will be returned, be sure to save it immediately. It is not present in the results returned by the ListAppKeys method (this is a security feature enforced by the server).
The string passed for Capabilities must be formatted as a comma-separated list of one or more of the following:
Capability String | Related Methods |
deleteBuckets | DeleteBucket |
deleteFiles | DeleteFile, DeleteFileVersion |
deleteKeys | DeleteAppKey |
listBuckets | GetBucketInfo, ListBuckets |
listFiles | DeleteFile, ListFiles, ListFileVersions, ListMultipartUploads |
listKeys | ListAppKeys |
readFiles | CopyFile, CopyPart, DownloadFile, DownloadFileById, GetFileInfo |
shareFiles | GetDownloadAuthToken |
writeBuckets | CreateBucket, UpdateBucket |
writeFiles | AbortMultipartUpload, CompleteMultipartUpload, CopyFile, CopyPart, HideFile, ListParts, StartMultipartUpload, UploadFile, UploadPart |
writeKeys | CreateAppKey |
To restrict the new application key to a specific bucket, pass the bucket's Id for AllowedBucketId. To further restrict it to files with a specific prefix within that bucket, pass said prefix for AllowedPrefix. It is not possible to apply a prefix restriction without a bucket restriction.
The ValidityDuration parameter specifies how many seconds the new application key will be valid for. The maximum valid value is 86400000 (1000 days); values less than 1 will cause the application key to remain valid indefinitely.
The currently-authenticated application key must have the writeKeys capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
CreateBucket Method (BackblazeB2 Component)
Creates a new bucket.
Syntax
public string CreateBucket(string bucketName, string kind); Async Version public async Task<string> CreateBucket(string bucketName, string kind); public async Task<string> CreateBucket(string bucketName, string kind, CancellationToken cancellationToken);
Public Function CreateBucket(ByVal BucketName As String, ByVal Kind As String) As String Async Version Public Function CreateBucket(ByVal BucketName As String, ByVal Kind As String) As Task(Of String) Public Function CreateBucket(ByVal BucketName As String, ByVal Kind As String, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method creates a new bucket named BucketName of the specified Kind. Valid values for Kind are allPrivate (default if empty) and allPublic. Each account may have up to 100 buckets.
The value passed for BucketName must comply with the following restrictions:
- Must be between 6 and 50 characters long (inclusive).
- Must consist solely of letters, digits, and hyphens (-).
- Cannot start with the string b2-.
- Must be globally unique (i.e., no two accounts may have a bucket with the same name) when compared case-insensitively.
If any items are present in the Metadata collection, they will also be included in the request and applied to the newly-created bucket. Keep in mind that the server enforces a limit of 10 metadata items per bucket.
The currently-authenticated application key must have the writeBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
DeleteAppKey Method (BackblazeB2 Component)
Deletes an application key.
Syntax
public void DeleteAppKey(string keyId); Async Version public async Task DeleteAppKey(string keyId); public async Task DeleteAppKey(string keyId, CancellationToken cancellationToken);
Public Sub DeleteAppKey(ByVal KeyId As String) Async Version Public Sub DeleteAppKey(ByVal KeyId As String) As Task Public Sub DeleteAppKey(ByVal KeyId As String, cancellationToken As CancellationToken) As Task
Remarks
This method deletes the application key specified by KeyId.
The currently-authenticated application key must have the deleteKeys capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
DeleteBucket Method (BackblazeB2 Component)
Deletes a bucket.
Syntax
public void DeleteBucket(string bucketId); Async Version public async Task DeleteBucket(string bucketId); public async Task DeleteBucket(string bucketId, CancellationToken cancellationToken);
Public Sub DeleteBucket(ByVal BucketId As String) Async Version Public Sub DeleteBucket(ByVal BucketId As String) As Task Public Sub DeleteBucket(ByVal BucketId As String, cancellationToken As CancellationToken) As Task
Remarks
This method deletes the bucket specified by BucketId. A bucket must be completely empty to be deleted.
Note that bucket names are global, and it may not be possible to recreate a deleted bucket if its name is taken by another user in the meantime.
The currently-authenticated application key must have the deleteBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
DeleteFile Method (BackblazeB2 Component)
Deletes all versions of a file.
Syntax
Remarks
This method deletes all versions of the file named FileName from the bucket specified by BucketId. If the latest "version" of the specified file is an incomplete multipart upload, the multipart upload is aborted.
The currently-authenticated application key must have the listFiles and deleteFiles capabilities to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
Note: This method is offered as a convenience, as the Backblaze B2 REST API does not technically provide a way to delete all versions of a file using a single request. When this method is called, the component uses ListFileVersions to obtain a list of all versions of the specified file, and then uses DeleteFileVersion to delete each one, in order from oldest to newest. If any one request made during this process fails, this method will fail immediately. This process does not alter the Files or FileMarker properties, nor does it cause the FileList event to fire.
DeleteFileVersion Method (BackblazeB2 Component)
Deletes a file version.
Syntax
public void DeleteFileVersion(string fileId); Async Version public async Task DeleteFileVersion(string fileId); public async Task DeleteFileVersion(string fileId, CancellationToken cancellationToken);
Public Sub DeleteFileVersion(ByVal FileId As String) Async Version Public Sub DeleteFileVersion(ByVal FileId As String) As Task Public Sub DeleteFileVersion(ByVal FileId As String, cancellationToken As CancellationToken) As Task
Remarks
This method deletes the file version specified by FileId, regardless of whether said version is an actual file or a hide marker
If the most recent version of a file is deleted, and older versions of the file exist, then the most recent older version will become the "current" version. If said version is a hide marker, then the file will become "hidden"; refer to HideFile for more information.
The currently-authenticated application key must have the deleteFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
DownloadFile Method (BackblazeB2 Component)
Downloads a file by name.
Syntax
public void DownloadFile(string bucketName, string fileName); Async Version public async Task DownloadFile(string bucketName, string fileName); public async Task DownloadFile(string bucketName, string fileName, CancellationToken cancellationToken);
Public Sub DownloadFile(ByVal BucketName As String, ByVal FileName As String) Async Version Public Sub DownloadFile(ByVal BucketName As String, ByVal FileName As String) As Task Public Sub DownloadFile(ByVal BucketName As String, ByVal FileName As String, cancellationToken As CancellationToken) As Task
Remarks
This method downloads the latest version of the file named FileName from the bucket named BucketName. The Range property can optionally be set before calling this method to download a specific range of data from the file.
This method can be used to download files that are owned by other accounts, so long as an appropriate download authorization token and download URL are supplied using the DownloadAuthToken and DownloadURL configuration settings; refer to their documentation for more information.
If a stream has been specified using SetDownloadStream, the file data will be sent through it. If a stream is not specified, and LocalFile is set, the file data will be saved to the specified location; otherwise, the file data will be held by FileData.
To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.
Download Notes
In the simplest use-case, downloading a file looks like this:
b2.LocalFile = "../MyData.zip";
b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().
Resuming Downloads
The component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyData.zip";
b2.LocalFile = downloadFile;
b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially downloaded file
b2.StartByte = new FileInfo(downloadFile).Length;
b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.
If LocalFile is set when beginning an encrypted download, the component creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, 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.
b2.LocalFile = "../MyData.zip";
b2.EncryptionPassword = "password";
b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially downloaded temp file
b2.StartByte = new FileInfo(b2.Config("DownloadTempFile")).Length;
b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().
The currently-authenticated application key must have the readFiles capability (unless the bucket is public) to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
DownloadFileById Method (BackblazeB2 Component)
Downloads a file by Id.
Syntax
public void DownloadFileById(string fileId); Async Version public async Task DownloadFileById(string fileId); public async Task DownloadFileById(string fileId, CancellationToken cancellationToken);
Public Sub DownloadFileById(ByVal FileId As String) Async Version Public Sub DownloadFileById(ByVal FileId As String) As Task Public Sub DownloadFileById(ByVal FileId As String, cancellationToken As CancellationToken) As Task
Remarks
This method downloads the file version specified by FileId. The Range property can optionally be set before calling this method to download a specific range of data from the file.
If a stream has been specified using SetDownloadStream, the file data will be sent through it. If a stream is not specified, and LocalFile is set, the file data will be saved to the specified location; otherwise, the file data will be held by FileData.
To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.
Download Notes
In the simplest use-case, downloading a file looks like this:
b2.LocalFile = "../MyData.zip";
b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().
Resuming Downloads
The component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyData.zip";
b2.LocalFile = downloadFile;
b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially downloaded file
b2.StartByte = new FileInfo(downloadFile).Length;
b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.
If LocalFile is set when beginning an encrypted download, the component creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, 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.
b2.LocalFile = "../MyData.zip";
b2.EncryptionPassword = "password";
b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially downloaded temp file
b2.StartByte = new FileInfo(b2.Config("DownloadTempFile")).Length;
b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().
The currently-authenticated application key must have the readFiles capability (unless the bucket is public) to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
GetBucketInfo Method (BackblazeB2 Component)
Gets a bucket's information and metadata.
Syntax
public void GetBucketInfo(string bucketId); Async Version public async Task GetBucketInfo(string bucketId); public async Task GetBucketInfo(string bucketId, CancellationToken cancellationToken);
Public Sub GetBucketInfo(ByVal BucketId As String) Async Version Public Sub GetBucketInfo(ByVal BucketId As String) As Task Public Sub GetBucketInfo(ByVal BucketId As String, cancellationToken As CancellationToken) As Task
Remarks
This method gets information and metadata for the bucket specified by BucketId.
Calling this method will fire the BucketList and MetadataList events, and will re-populate the Buckets and Metadata collection properties.
The currently-authenticated application key must have the listBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
GetDownloadAuthToken Method (BackblazeB2 Component)
Create a download authorization token for one or more files in a bucket.
Syntax
public string GetDownloadAuthToken(string allowedBucketId, string allowedPrefix, int validityDuration); Async Version public async Task<string> GetDownloadAuthToken(string allowedBucketId, string allowedPrefix, int validityDuration); public async Task<string> GetDownloadAuthToken(string allowedBucketId, string allowedPrefix, int validityDuration, CancellationToken cancellationToken);
Public Function GetDownloadAuthToken(ByVal AllowedBucketId As String, ByVal AllowedPrefix As String, ByVal ValidityDuration As Integer) As String Async Version Public Function GetDownloadAuthToken(ByVal AllowedBucketId As String, ByVal AllowedPrefix As String, ByVal ValidityDuration As Integer) As Task(Of String) Public Function GetDownloadAuthToken(ByVal AllowedBucketId As String, ByVal AllowedPrefix As String, ByVal ValidityDuration As Integer, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method creates and returns a download authorization token for the files in the bucket specified by AllowedBucketId whose names start with AllowedPrefix. The newly-created token will remain valid for the number of seconds specified by ValidityDuration, which must be a value in the range 1 to 604800 (1 week), inclusive.
Download authorization tokens created using this method can be used by anybody to download an applicable file by name; they cannot be used to download a file by Id. Refer to the DownloadFile method for more information.
The currently-authenticated application key must have the shareFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
GetFileInfo Method (BackblazeB2 Component)
Gets a file's information and metadata.
Syntax
public void GetFileInfo(string fileId); Async Version public async Task GetFileInfo(string fileId); public async Task GetFileInfo(string fileId, CancellationToken cancellationToken);
Public Sub GetFileInfo(ByVal FileId As String) Async Version Public Sub GetFileInfo(ByVal FileId As String) As Task Public Sub GetFileInfo(ByVal FileId As String, cancellationToken As CancellationToken) As Task
Remarks
This method gets information and metadata for the file version specified by FileId (which must be a real file version, or a hide marker, not a multipart upload).
Calling this method will fire the FileList and MetadataList events, and will re-populate the Files and Metadata collection properties.
The currently-authenticated application key must have the readFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
HideFile Method (BackblazeB2 Component)
Hides a file.
Syntax
public string HideFile(string bucketId, string fileName); Async Version public async Task<string> HideFile(string bucketId, string fileName); public async Task<string> HideFile(string bucketId, string fileName, CancellationToken cancellationToken);
Public Function HideFile(ByVal BucketId As String, ByVal FileName As String) As String Async Version Public Function HideFile(ByVal BucketId As String, ByVal FileName As String) As Task(Of String) Public Function HideFile(ByVal BucketId As String, ByVal FileName As String, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method hides the file named FileName in the bucket specified by BucketId by creating a special version of the file called a hide marker.
If the latest version of a file is a hide marker, then the file will not appear in the results returned by ListFiles, nor can it be downloaded by name using DownloadFile. However:
- Any version of the file (excluding hide markers) can still be downloaded directly using DownloadFileById.
- All versions of the file can still be deleted, either all at once using DeleteFile, or individually using DeleteFileVersion.
- All versions of the file will still appear in the results returned by ListFileVersions, and can still be queried individually using GetFileInfo.
To unhide a file, simply delete the hide marker using DeleteFileVersion.
The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
Interrupt Method (BackblazeB2 Component)
This method interrupts the current method.
Syntax
public void Interrupt(); Async Version public async Task Interrupt(); public async Task Interrupt(CancellationToken cancellationToken);
Public Sub Interrupt() Async Version Public Sub Interrupt() As Task Public Sub Interrupt(cancellationToken As CancellationToken) As Task
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListAppKeys Method (BackblazeB2 Component)
Lists the account's application keys.
Syntax
public void ListAppKeys(); Async Version public async Task ListAppKeys(); public async Task ListAppKeys(CancellationToken cancellationToken);
Public Sub ListAppKeys() Async Version Public Sub ListAppKeys() As Task Public Sub ListAppKeys(cancellationToken As CancellationToken) As Task
Remarks
This method lists the application keys associated with the account. Note that the account's master application key is not included in the results.
Calling this method will fire the AppKeyList event once for each application key, and will also populate the AppKeys collection.
If there are still more application keys available to list when this method returns, the AppKeyMarker property will be populated. Continue to call this method until AppKeyMarker is empty to accumulate all pages of results in the AppKeys collection.
The MaxAppKeyResults configuration setting can be used to control the maximum number of results returned each time this method is called.
The currently-authenticated application key must have the listKeys capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
ListBuckets Method (BackblazeB2 Component)
Lists all buckets in the account.
Syntax
public void ListBuckets(); Async Version public async Task ListBuckets(); public async Task ListBuckets(CancellationToken cancellationToken);
Public Sub ListBuckets() Async Version Public Sub ListBuckets() As Task Public Sub ListBuckets(cancellationToken As CancellationToken) As Task
Remarks
This method lists all buckets in the account.
Calling this method will fire the BucketList event once for each bucket, and will also populate the Buckets collection. If the ListWithMetadata configuration setting is enabled, the MetadataList event will also be fired, once for each metadata item associated with each bucket.
If the currently-authenticated application key is restricted to a specific bucket (indicated by the Account.AllowedBucketId field being non-empty), the results will only include information for that bucket.
The currently-authenticated application key must have the listBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
ListFiles Method (BackblazeB2 Component)
Lists the files in a bucket.
Syntax
public void ListFiles(string bucketId); Async Version public async Task ListFiles(string bucketId); public async Task ListFiles(string bucketId, CancellationToken cancellationToken);
Public Sub ListFiles(ByVal BucketId As String) Async Version Public Sub ListFiles(ByVal BucketId As String) As Task Public Sub ListFiles(ByVal BucketId As String, cancellationToken As CancellationToken) As Task
Remarks
This method lists the files in the bucket specified by BucketId.
Before calling this method, the Prefix property may be set in order to restrict the results to only the files whose names begin with the a given string. The Delimiter property can also be used to further tune the results returned. The MaxResults configuration setting may also be used to limit the number of results returned.
If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the Account.AllowedPrefix field being non-empty), then the Prefix property will automatically be set to that prefix if it is empty when this method is called.
Calling this method will fire the FileList event once for each file, and will also populate the Files collection. If the ListWithMetadata configuration setting is enabled, the MetadataList event will also be fired, once for each metadata item associated with each file.
If there are still more files available to list when this method returns, the FileMarker property will be populated. Continue to call this method until FileMarker is empty to accumulate all pages of results in the Files collection.
The currently-authenticated application key must have the listFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
File Hierarchy Traversal
By using the Delimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:
- MyCompany
- MyCompany/Department1
- MyCompany/Department2
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With Delimiter set to /, we can set Prefix to successively "deeper" values before calling ListFiles or ListFileVersions for the following effect:
Prefix Value | Files Returned | Folders Returned |
(empty) | MyCompany | MyCompany/ |
MyCompany/ | MyCompany/Department1
MyCompany/Department2 | MyCompany/Department2/ |
MyCompany/Department2/ | MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB | (none) |
ListFileVersions Method (BackblazeB2 Component)
Lists the file versions in a bucket.
Syntax
public void ListFileVersions(string bucketId); Async Version public async Task ListFileVersions(string bucketId); public async Task ListFileVersions(string bucketId, CancellationToken cancellationToken);
Public Sub ListFileVersions(ByVal BucketId As String) Async Version Public Sub ListFileVersions(ByVal BucketId As String) As Task Public Sub ListFileVersions(ByVal BucketId As String, cancellationToken As CancellationToken) As Task
Remarks
This method lists the file versions in the bucket specified by BucketId.
Before calling this method, the Prefix property may be set in order to restrict the results to only the file versions whose names begin with the a given string. The Delimiter property can also be used to further tune the results returned. The MaxResults configuration setting may also be used to limit the number of results returned.
If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the Account.AllowedPrefix field being non-empty), then the Prefix property will automatically be set to that prefix if it is empty when this method is called.
Calling this method will fire the FileList event once for each file version, and will also populate the Files collection. If the ListWithMetadata configuration setting is enabled, the MetadataList event will also be fired, once for each metadata item associated with each file version.
If there are still more files versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Files collection.
The currently-authenticated application key must have the listFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
File Hierarchy Traversal
By using the Delimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:
- MyCompany
- MyCompany/Department1
- MyCompany/Department2
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With Delimiter set to /, we can set Prefix to successively "deeper" values before calling ListFiles or ListFileVersions for the following effect:
Prefix Value | Files Returned | Folders Returned |
(empty) | MyCompany | MyCompany/ |
MyCompany/ | MyCompany/Department1
MyCompany/Department2 | MyCompany/Department2/ |
MyCompany/Department2/ | MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB | (none) |
ListMultipartUploads Method (BackblazeB2 Component)
Lists the in-progress multipart uploads in a bucket.
Syntax
public void ListMultipartUploads(string bucketId); Async Version public async Task ListMultipartUploads(string bucketId); public async Task ListMultipartUploads(string bucketId, CancellationToken cancellationToken);
Public Sub ListMultipartUploads(ByVal BucketId As String) Async Version Public Sub ListMultipartUploads(ByVal BucketId As String) As Task Public Sub ListMultipartUploads(ByVal BucketId As String, cancellationToken As CancellationToken) As Task
Remarks
This method lists the in-progress multipart uploads in the bucket specified by BucketId.
Before calling this method, the Prefix property may be set in order to restrict the results to only the multipart uploads whose file names begin with the a given string.
If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the Account.AllowedPrefix field being non-empty), then the Prefix property will automatically be set to that prefix if it is empty when this method is called.
Calling this method will fire the FileList event once for each multipart upload, and will also populate the Files collection. If the ListWithMetadata configuration setting is enabled, the MetadataList event will also be fired, once for each metadata item associated with each multipart upload.
The currently-authenticated application key must have the listFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
ListParts Method (BackblazeB2 Component)
Lists a multipart upload's parts.
Syntax
public void ListParts(string multipartFileId); Async Version public async Task ListParts(string multipartFileId); public async Task ListParts(string multipartFileId, CancellationToken cancellationToken);
Public Sub ListParts(ByVal MultipartFileId As String) Async Version Public Sub ListParts(ByVal MultipartFileId As String) As Task Public Sub ListParts(ByVal MultipartFileId As String, cancellationToken As CancellationToken) As Task
Remarks
This method lists the parts that have been created for the multipart file upload specified by MultipartFileId.
Calling this method will fire the PartList event once for each part, and will also populate the Parts collection.
If there are still more parts available to list when this method returns, the PartMarker property will be populated. Continue to call this method until PartMarker is empty to accumulate all pages of results in the Parts collection.
The MaxPartResults configuration setting can be used to control the maximum number of results returned each time this method is called.
The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
Reset Method (BackblazeB2 Component)
Resets the component to its initial state.
Syntax
public void Reset(); Async Version public async Task Reset(); public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset() Async Version Public Sub Reset() As Task Public Sub Reset(cancellationToken As CancellationToken) As Task
Remarks
This method resets the component to its initial state.
SendCustomRequest Method (BackblazeB2 Component)
Sends a custom request to the Backblaze B2 API.
Syntax
public void SendCustomRequest(string httpMethod, string operation, string requestBody); Async Version public async Task SendCustomRequest(string httpMethod, string operation, string requestBody); public async Task SendCustomRequest(string httpMethod, string operation, string requestBody, CancellationToken cancellationToken);
Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal Operation As String, ByVal RequestBody As String) Async Version Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal Operation As String, ByVal RequestBody As String) As Task Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal Operation As String, ByVal RequestBody As String, cancellationToken As CancellationToken) As Task
Remarks
This method can be used to send arbitrary requests to the Backblaze B2 API.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
The value passed for Operation must be one of the API operations described in the Backblaze B2 REST API documentation (e.g., b2_list_buckets).
Usage
When this method is called, the component does the following:
- Builds a request URL, including query parameters, as follows:
- The specified Operation is appended to the base Backblaze B2 API URL (refer to the APIURL configuration setting for more information).
- All query parameters in the QueryParams collection are added to the request URL.
- Sends the request using the specified HttpMethod, the request URL built in step 1, the header information built from Account.AuthToken and OtherHeaders, and the given RequestBody (if non-empty).
- Stores the response headers in the ParsedHeaders collection, and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or ResourceData (using the same logic as DownloadFile).
If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.
SetDownloadStream Method (BackblazeB2 Component)
Sets the stream to which downloaded data will be written.
Syntax
public void SetDownloadStream(System.IO.Stream downloadStream); Async Version public async Task SetDownloadStream(System.IO.Stream downloadStream); public async Task SetDownloadStream(System.IO.Stream downloadStream, CancellationToken cancellationToken);
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream) Async Version Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream) As Task Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task
Remarks
If a download stream is set before data is downloaded, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.
Note: Passing a non-null value for DownloadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.
SetUploadStream Method (BackblazeB2 Component)
Sets the stream from which data is read when uploading.
Syntax
public void SetUploadStream(System.IO.Stream uploadStream); Async Version public async Task SetUploadStream(System.IO.Stream uploadStream); public async Task SetUploadStream(System.IO.Stream uploadStream, CancellationToken cancellationToken);
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream) Async Version Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream) As Task Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task
Remarks
If an upload stream is set before data is uploaded, the content of the stream will be read by the component and uploaded to the server. The stream should be open and normally set to position 0.
Note: Passing a non-null value for UploadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.
StartMultipartUpload Method (BackblazeB2 Component)
Starts a new multipart upload.
Syntax
public string StartMultipartUpload(string bucketId, string fileName); Async Version public async Task<string> StartMultipartUpload(string bucketId, string fileName); public async Task<string> StartMultipartUpload(string bucketId, string fileName, CancellationToken cancellationToken);
Public Function StartMultipartUpload(ByVal BucketId As String, ByVal FileName As String) As String Async Version Public Function StartMultipartUpload(ByVal BucketId As String, ByVal FileName As String) As Task(Of String) Public Function StartMultipartUpload(ByVal BucketId As String, ByVal FileName As String, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method starts a new multipart upload for a file named FileName in the bucket specified by BucketId, and returns the Id of the newly-created multipart upload. This Id can then be used to call the following methods:
FileName is subject to the same restrictions described in the UploadFile method's documentation; refer to it for more information. If a file named FileName already exists in the destination bucket, a new version of it is created.
The following information is also included in the request, and will be applied to the final file when the multipart upload is completed with CompleteMultipartUpload:
- All metadata items present in the Metadata collection. Keep in mind that the server enforces a limit of 10 metadata items per file.
- If the ClientModifiedTime configuration setting is non-empty: an additional metadata item with its value (which does count towards the 10 item limit).
- The value of the ContentType property.
Multipart uploads never expire, they must be explicitly completed or aborted using CompleteMultipartUpload or AbortMultipartUpload. The ListMultipartUploads method can be used to retrieve a list of current multipart uploads.
The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
UpdateBucket Method (BackblazeB2 Component)
Updates a bucket's kind and/or metadata.
Syntax
public void UpdateBucket(string bucketId, string newKind, bool newMetadata); Async Version public async Task UpdateBucket(string bucketId, string newKind, bool newMetadata); public async Task UpdateBucket(string bucketId, string newKind, bool newMetadata, CancellationToken cancellationToken);
Public Sub UpdateBucket(ByVal BucketId As String, ByVal NewKind As String, ByVal NewMetadata As Boolean) Async Version Public Sub UpdateBucket(ByVal BucketId As String, ByVal NewKind As String, ByVal NewMetadata As Boolean) As Task Public Sub UpdateBucket(ByVal BucketId As String, ByVal NewKind As String, ByVal NewMetadata As Boolean, cancellationToken As CancellationToken) As Task
Remarks
This method updates the kind and/or metadata of the bucket specified by BucketId.
If NewKind is non-empty, it must be allPrivate or allPublic. If NewKind is empty, the bucket's kind remains unchanged.
If NewMetadata is true, the bucket's current metadata items are replaced with those in the Metadata collection (or cleared, if said collection is empty). If NewMetadata is false, the bucket's current metadata remains unchanged. Keep in mind that the server enforces a limit of 10 metadata items per bucket.
If NewKind is empty and NewMetadata is false, this method does nothing.
The IfRevision setting can optionally be set before calling this method to ensure that the requested changes are only made if the bucket's current revision matches the given one.
The currently-authenticated application key must have the writeBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
UploadFile Method (BackblazeB2 Component)
Uploads a file.
Syntax
public string UploadFile(string bucketId, string fileName); Async Version public async Task<string> UploadFile(string bucketId, string fileName); public async Task<string> UploadFile(string bucketId, string fileName, CancellationToken cancellationToken);
Public Function UploadFile(ByVal BucketId As String, ByVal FileName As String) As String Async Version Public Function UploadFile(ByVal BucketId As String, ByVal FileName As String) As Task(Of String) Public Function UploadFile(ByVal BucketId As String, ByVal FileName As String, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method uploads a new file named FileName to the bucket specified by BucketId, and returns the Id of the newly-created file.
The value passed for FileName must comply with the following restrictions:
- Cannot contain non-printable or DEL characters (i.e., character codes below 32 or equal to 127, respectively).
- Cannot contain backslashes (\).
- Cannot begin or end with a slash (/), and cannot contain two subsequent slashes (//).
- No segment (i.e., a part between slashes) can be more than 250 bytes long (when UTF-8 encoded).
- The overall string can be no more than 1024 bytes long overall (when UTF-8 encoded).
If a file with the specified FileName already exists in the destination bucket, a new version of it is created.
The following information is also included in the request, and will be applied to the newly-created file:
- All metadata items present in the Metadata collection. Keep in mind that the server enforces a limit of 10 metadata items per file.
- If the ClientModifiedTime configuration setting is non-empty: an additional metadata item with its value (which does count towards the 10 item limit).
- The value of the ContentType property.
If SetUploadStream has been used to set an upload stream, it will take priority as the data source. If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in FileData will be used.
To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.
The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
Automatic Multipart Uploads
If more than SimpleUploadLimit bytes of data are provided, the component will automatically perform a multipart upload by splitting the data up into parts (sized according to the FragmentSize configuration setting) and uploading them individually. To accomplish this, the component automatically makes calls to StartMultipartUpload, UploadPart, and CompleteMultipartUpload internally; tracks upload state information using the ResumableUploadState configuration setting; and tracks how much data has been uploaded using the StartByte property. The FragmentComplete event will fire after each part is uploaded.
If, during an automatic multipart upload, any individual request fails, the upload can be resumed be calling this method again with the same parameters, so long as ResumableUploadState and StartByte contain the same values as they did when the upload was interrupted.
When an automatic multipart upload completes successfully, ResumableUploadState is cleared and StartByte is reset to 0.
UploadPart Method (BackblazeB2 Component)
Uploads a multipart upload part.
Syntax
public void UploadPart(string multipartFileId, int partNumber); Async Version public async Task UploadPart(string multipartFileId, int partNumber); public async Task UploadPart(string multipartFileId, int partNumber, CancellationToken cancellationToken);
Public Sub UploadPart(ByVal MultipartFileId As String, ByVal PartNumber As Integer) Async Version Public Sub UploadPart(ByVal MultipartFileId As String, ByVal PartNumber As Integer) As Task Public Sub UploadPart(ByVal MultipartFileId As String, ByVal PartNumber As Integer, cancellationToken As CancellationToken) As Task
Remarks
This method uploads a new part for the multipart file upload specified by MultipartFileId. The part's number is specified by PartNumber; it must be a value in the range 1 to 10000, inclusive. If the specified multipart upload already has a part with the given PartNumber, it is replaced with the one created by this request.
The data to upload is taken from either the stream set using SetUploadStream, LocalFile, or FileData (whichever data is found in first, when checked in that order). All parts must be between 5MB and 5GB in size (except for the last part, which can be as small as 1 byte).
The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the Account.Capabilities field for more information.
AppKeyList Event (BackblazeB2 Component)
Fires once for each application key returned when listing application keys.
Syntax
public event OnAppKeyListHandler OnAppKeyList; public delegate void OnAppKeyListHandler(object sender, BackblazeB2AppKeyListEventArgs e); public class BackblazeB2AppKeyListEventArgs : EventArgs { public string KeyId { get; } public string KeyName { get; } public string Capabilities { get; } public string AllowedBucketId { get; } public string AllowedPrefix { get; } public long ExpirationTime { get; } }
Public Event OnAppKeyList As OnAppKeyListHandler Public Delegate Sub OnAppKeyListHandler(sender As Object, e As BackblazeB2AppKeyListEventArgs) Public Class BackblazeB2AppKeyListEventArgs Inherits EventArgs Public ReadOnly Property KeyId As String Public ReadOnly Property KeyName As String Public ReadOnly Property Capabilities As String Public ReadOnly Property AllowedBucketId As String Public ReadOnly Property AllowedPrefix As String Public ReadOnly Property ExpirationTime As Long End Class
Remarks
This event fires once for each application key returned when ListAppKeys is called.
KeyId reflects the unique Id of the application key.
KeyName reflects the name that was given to the application key when it was created.
Capabilities reflects the capabilities that the application key has. It is formatted as a comma-separated list of one or more of the following:
Capability String | Related Methods |
deleteBuckets | DeleteBucket |
deleteFiles | DeleteFile, DeleteFileVersion |
deleteKeys | DeleteAppKey |
listBuckets | GetBucketInfo, ListBuckets |
listFiles | DeleteFile, ListFiles, ListFileVersions, ListMultipartUploads |
listKeys | ListAppKeys |
readFiles | CopyFile, CopyPart, DownloadFile, DownloadFileById, GetFileInfo |
shareFiles | GetDownloadAuthToken |
writeBuckets | CreateBucket, UpdateBucket |
writeFiles | AbortMultipartUpload, CompleteMultipartUpload, CopyFile, CopyPart, HideFile, ListParts, StartMultipartUpload, UploadFile, UploadPart |
writeKeys | CreateAppKey |
AllowedBucketId reflects the Id of the bucket that the application key is restricted to. It will be empty if the application key is not restricted to any specific bucket.
AllowedPrefix reflects the file name prefix that the application key is restricted to. It will be empty if the application key is not restricted to a specific file name prefix.
ExpirationTime reflects the expiration time of the application key, in milliseconds relative to the Unix epoch. It will be -1 if the application key does not expire.
BucketList Event (BackblazeB2 Component)
Fires once for each bucket returned when listing buckets.
Syntax
public event OnBucketListHandler OnBucketList; public delegate void OnBucketListHandler(object sender, BackblazeB2BucketListEventArgs e); public class BackblazeB2BucketListEventArgs : EventArgs { public string Id { get; } public string Name { get; } public string Kind { get; } public long Revision { get; } }
Public Event OnBucketList As OnBucketListHandler Public Delegate Sub OnBucketListHandler(sender As Object, e As BackblazeB2BucketListEventArgs) Public Class BackblazeB2BucketListEventArgs Inherits EventArgs Public ReadOnly Property Id As String Public ReadOnly Property Name As String Public ReadOnly Property Kind As String Public ReadOnly Property Revision As Long End Class
Remarks
This event fires once for each bucket returned when ListBuckets is called.
Id reflects the unique Id of the bucket.
Name reflects the name of the bucket.
Kind reflects the bucket's kind. Possible values are allPublic, allPrivate, or snapshot.
Revision reflects the bucket's revision number. A bucket's revision number is updated every time the bucket is modified.
EndTransfer Event (BackblazeB2 Component)
This event fires when a document finishes transferring.
Syntax
public event OnEndTransferHandler OnEndTransfer; public delegate void OnEndTransferHandler(object sender, BackblazeB2EndTransferEventArgs e); public class BackblazeB2EndTransferEventArgs : EventArgs { public int Direction { get; } }
Public Event OnEndTransfer As OnEndTransferHandler Public Delegate Sub OnEndTransferHandler(sender As Object, e As BackblazeB2EndTransferEventArgs) Public Class BackblazeB2EndTransferEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer End Class
Remarks
The EndTransfer event is fired when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (BackblazeB2 Component)
Fired when information is available about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, BackblazeB2ErrorEventArgs e); public class BackblazeB2ErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As BackblazeB2ErrorEventArgs) Public Class BackblazeB2ErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
FileList Event (BackblazeB2 Component)
Fires once for each file returned when listing files.
Syntax
public event OnFileListHandler OnFileList; public delegate void OnFileListHandler(object sender, BackblazeB2FileListEventArgs e); public class BackblazeB2FileListEventArgs : EventArgs { public string Id { get; } public string Name { get; } public string BucketId { get; } public long Size { get; } public string ContentType { get; } public long CreatedTime { get; } public long ModifiedTime { get; } public string Kind { get; } public string SHA1Hash { get; } }
Public Event OnFileList As OnFileListHandler Public Delegate Sub OnFileListHandler(sender As Object, e As BackblazeB2FileListEventArgs) Public Class BackblazeB2FileListEventArgs Inherits EventArgs Public ReadOnly Property Id As String Public ReadOnly Property Name As String Public ReadOnly Property BucketId As String Public ReadOnly Property Size As Long Public ReadOnly Property ContentType As String Public ReadOnly Property CreatedTime As Long Public ReadOnly Property ModifiedTime As Long Public ReadOnly Property Kind As String Public ReadOnly Property SHA1Hash As String End Class
Remarks
This event fires once for each file returned when ListFiles, ListFileVersions, or ListMultipartUploads is called.
Id reflects the Id of the file. Always empty when Kind is folder.
Name reflects the name of the file.
BucketId reflects the Id of the bucket that the file is in.
Size reflects the size of the file, in bytes. Always 0 when Kind is folder, hide, or start.
ContentType reflects the content type of the file. Always application/x-bz-hide-marker when Kind is hide; and empty when Kind is folder.
CreatedTime reflects the file's creation time, in milliseconds relative to the Unix epoch. Always 0 when Kind is folder.
ModifiedTime reflects the file's last modified time, in milliseconds relative to the Unix epoch. (Note that this parameter will only be populated if a src_last_modified_millis metadata item is included for the file, and if that metadata item's value can be parsed as a 64-bit integer; otherwise, it will be -1. Refer to the ClientModifiedTime configuration setting for more information.)
Kind reflects the file's kind. Possible values are:
folder | A "folder" (only applicable when listing files with a Delimiter). |
hide | A hide marker file version created by HideFile. |
start | A multipart file upload that has not been completed or abandoned yet. |
upload | An file that has been uploaded (either directly, or via a multipart upload). |
SHA1Hash reflects a hex-encoded SHA1 hash of the file's contents, or empty string if such a hash is not available. Always empty when Kind is folder or hide.
FragmentComplete Event (BackblazeB2 Component)
Fires after each part in an automatic multipart upload is complete.
Syntax
public event OnFragmentCompleteHandler OnFragmentComplete; public delegate void OnFragmentCompleteHandler(object sender, BackblazeB2FragmentCompleteEventArgs e); public class BackblazeB2FragmentCompleteEventArgs : EventArgs { public int FragmentNumber { get; } public int FragmentCount { get; } public bool Interrupt { get; set; } }
Public Event OnFragmentComplete As OnFragmentCompleteHandler Public Delegate Sub OnFragmentCompleteHandler(sender As Object, e As BackblazeB2FragmentCompleteEventArgs) Public Class BackblazeB2FragmentCompleteEventArgs Inherits EventArgs Public ReadOnly Property FragmentNumber As Integer Public ReadOnly Property FragmentCount As Integer Public Property Interrupt As Boolean End Class
Remarks
If, when UploadFile is called, more than SimpleUploadLimit bytes of upload data are present, the component will automatically split the upload data up into parts and perform a multipart upload. During the overall upload process, this event will fire after each part is uploaded, providing an indication of overall upload progress.
FragmentNumber is the number of the current part that has completed. This value starts at 1.
FragmentCount is the total number of parts that will be uploaded.
Interrupt can be set to true to interrupt the upload. The upload may be resumed later.
Refer to UploadFile for more information.
Header Event (BackblazeB2 Component)
This event is fired every time a header line comes in.
Syntax
public event OnHeaderHandler OnHeader; public delegate void OnHeaderHandler(object sender, BackblazeB2HeaderEventArgs e); public class BackblazeB2HeaderEventArgs : EventArgs { public string Field { get; } public string Value { get; } }
Public Event OnHeader As OnHeaderHandler Public Delegate Sub OnHeaderHandler(sender As Object, e As BackblazeB2HeaderEventArgs) Public Class BackblazeB2HeaderEventArgs Inherits EventArgs Public ReadOnly Property Field As String Public ReadOnly Property Value As String End Class
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
Log Event (BackblazeB2 Component)
This event fires once for each log message.
Syntax
public event OnLogHandler OnLog; public delegate void OnLogHandler(object sender, BackblazeB2LogEventArgs e); public class BackblazeB2LogEventArgs : EventArgs { public int LogLevel { get; } public string Message { get; } public string LogType { get; } }
Public Event OnLog As OnLogHandler Public Delegate Sub OnLogHandler(sender As Object, e As BackblazeB2LogEventArgs) Public Class BackblazeB2LogEventArgs Inherits EventArgs Public ReadOnly Property LogLevel As Integer Public ReadOnly Property Message As String Public ReadOnly Property LogType As String End Class
Remarks
This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
MetadataList Event (BackblazeB2 Component)
Fires once for each metadata item returned when bucket or file information and metadata is retrieved.
Syntax
public event OnMetadataListHandler OnMetadataList; public delegate void OnMetadataListHandler(object sender, BackblazeB2MetadataListEventArgs e); public class BackblazeB2MetadataListEventArgs : EventArgs { public string BucketId { get; } public string FileId { get; } public string Name { get; } public string Value { get; } }
Public Event OnMetadataList As OnMetadataListHandler Public Delegate Sub OnMetadataListHandler(sender As Object, e As BackblazeB2MetadataListEventArgs) Public Class BackblazeB2MetadataListEventArgs Inherits EventArgs Public ReadOnly Property BucketId As String Public ReadOnly Property FileId As String Public ReadOnly Property Name As String Public ReadOnly Property Value As String End Class
Remarks
This event fires once for each metadata item returned when GetBucketInfo or GetFileInfo is called. If the ListWithMetadata configuration setting is enabled, it also fires as metadata for each individual bucket or file is returned when ListBuckets, ListFiles, ListFileVersions, or ListMultipartUploads is called.
BucketId reflects the Id of the bucket that the file is in (if FileId is non-empty), or that the metadata item is associated with (if FileId is empty).
FileId, if non-empty, reflects the Id of the file that the metadata item is associated with.
Name reflects the name of the metadata item.
Value reflects the value of the metadata item.
PartList Event (BackblazeB2 Component)
Fires once for each part returned when listing a multipart upload's parts.
Syntax
public event OnPartListHandler OnPartList; public delegate void OnPartListHandler(object sender, BackblazeB2PartListEventArgs e); public class BackblazeB2PartListEventArgs : EventArgs { public int PartNumber { get; } public string MultipartFileId { get; } public long Size { get; } public long CreatedTime { get; } public string SHA1Hash { get; } }
Public Event OnPartList As OnPartListHandler Public Delegate Sub OnPartListHandler(sender As Object, e As BackblazeB2PartListEventArgs) Public Class BackblazeB2PartListEventArgs Inherits EventArgs Public ReadOnly Property PartNumber As Integer Public ReadOnly Property MultipartFileId As String Public ReadOnly Property Size As Long Public ReadOnly Property CreatedTime As Long Public ReadOnly Property SHA1Hash As String End Class
Remarks
This event fires once for each part returned when ListParts is called.
PartNumber reflects the part's number.
MultipartFileId reflects the Id of the multipart file upload that the part is a part of.
Size reflects the size of the part, in bytes.
CreatedTime reflects the part's creation time (i.e., upload time), in milliseconds relative to the Unix epoch.
SHA1Hash reflects a hex-encoded SHA1 hash of the part's contents.
Progress Event (BackblazeB2 Component)
Fires during an upload or download to indicate transfer progress.
Syntax
public event OnProgressHandler OnProgress; public delegate void OnProgressHandler(object sender, BackblazeB2ProgressEventArgs e); public class BackblazeB2ProgressEventArgs : EventArgs { public int Direction { get; } public long BytesTransferred { get; } public long TotalBytes { get; } public int PercentDone { get; } }
Public Event OnProgress As OnProgressHandler Public Delegate Sub OnProgressHandler(sender As Object, e As BackblazeB2ProgressEventArgs) Public Class BackblazeB2ProgressEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer Public ReadOnly Property BytesTransferred As Long Public ReadOnly Property TotalBytes As Long Public ReadOnly Property PercentDone As Integer End Class
Remarks
This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.
Direction indicates whether the transfer is an upload (0) or a download (1).
BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).
TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.
PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.
Note: By default, the component tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.
For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.
This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the component will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.
SSLServerAuthentication Event (BackblazeB2 Component)
Fired after the server presents its certificate to the client.
Syntax
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication; public delegate void OnSSLServerAuthenticationHandler(object sender, BackblazeB2SSLServerAuthenticationEventArgs e); public class BackblazeB2SSLServerAuthenticationEventArgs : EventArgs { public string CertEncoded { get; }
public byte[] CertEncodedB { get; } public string CertSubject { get; } public string CertIssuer { get; } public string Status { get; } public bool Accept { get; set; } }
Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As BackblazeB2SSLServerAuthenticationEventArgs) Public Class BackblazeB2SSLServerAuthenticationEventArgs Inherits EventArgs Public ReadOnly Property CertEncoded As String
Public ReadOnly Property CertEncodedB As Byte() Public ReadOnly Property CertSubject As String Public ReadOnly Property CertIssuer As String Public ReadOnly Property Status As String Public Property Accept As Boolean End Class
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (BackblazeB2 Component)
Fired when secure connection progress messages are available.
Syntax
public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, BackblazeB2SSLStatusEventArgs e); public class BackblazeB2SSLStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnSSLStatus As OnSSLStatusHandler Public Delegate Sub OnSSLStatusHandler(sender As Object, e As BackblazeB2SSLStatusEventArgs) Public Class BackblazeB2SSLStatusEventArgs Inherits EventArgs Public ReadOnly Property Message As String End Class
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (BackblazeB2 Component)
This event fires when a document starts transferring (after the headers).
Syntax
public event OnStartTransferHandler OnStartTransfer; public delegate void OnStartTransferHandler(object sender, BackblazeB2StartTransferEventArgs e); public class BackblazeB2StartTransferEventArgs : EventArgs { public int Direction { get; } }
Public Event OnStartTransfer As OnStartTransferHandler Public Delegate Sub OnStartTransferHandler(sender As Object, e As BackblazeB2StartTransferEventArgs) Public Class BackblazeB2StartTransferEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer End Class
Remarks
The StartTransfer event is fired when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Transfer Event (BackblazeB2 Component)
This event is fired while a document transfers (delivers document).
Syntax
public event OnTransferHandler OnTransfer; public delegate void OnTransferHandler(object sender, BackblazeB2TransferEventArgs e); public class BackblazeB2TransferEventArgs : EventArgs { public int Direction { get; } public long BytesTransferred { get; } public int PercentDone { get; } public string Text { get; }
public byte[] TextB { get; } }
Public Event OnTransfer As OnTransferHandler Public Delegate Sub OnTransferHandler(sender As Object, e As BackblazeB2TransferEventArgs) Public Class BackblazeB2TransferEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer Public ReadOnly Property BytesTransferred As Long Public ReadOnly Property PercentDone As Integer Public ReadOnly Property Text As String
Public ReadOnly Property TextB As Byte() End Class
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
B2Account Type
Backblaze B2 account information.
Remarks
This type provides information about a Backblaze B2 account and the currently-authenticated application key.
Fields
AccountId
string (read-only)
Default: ""
The Id of the account.
This field reflects the Id of the account that the currently-authenticated application key belongs to.
AllowedBucketId
string (read-only)
Default: ""
The Id of the bucket that the application key is restricted to.
This field reflects the Id of the bucket that the currently-authenticated application key is restricted to. It will be empty if the currently-authenticated application key is not restricted to any specific bucket.
AllowedBucketName
string (read-only)
Default: ""
The name of the bucket that the application key is restricted to.
This field reflects the name of the bucket that the currently-authenticated application key is restricted to. It will be empty if the currently-authenticated application key is not restricted to any specific bucket; or if it is, but the bucket has been deleted (AllowedBucketId will still be populated in this case).
AllowedPrefix
string (read-only)
Default: ""
The file name prefix that the application key is restricted to.
This field reflects the file name prefix that the currently-authenticated application key is restricted to. It will be empty if the currently-authenticated application key is not restricted to a specific file name prefix.
AuthToken
string (read-only)
Default: ""
The authorization token that will be used to authorize requests.
This field reflects the actual authorization token that will be used to authorize requests sent to the server. This token is obtained by calling Authorize to authenticate to the server using the current ApplicationKey and ApplicationKeyId values; it is valid for up to 24 hours.
Capabilities
string (read-only)
Default: ""
The capabilities that the application key has.
This field reflects the capabilities that the currently-authenticated application key has. It is formatted as a comma-separated list of one or more of the following strings:
Capability String | Related Methods |
deleteBuckets | DeleteBucket |
deleteFiles | DeleteFile, DeleteFileVersion |
deleteKeys | DeleteAppKey |
listBuckets | GetBucketInfo, ListBuckets |
listFiles | DeleteFile, ListFiles, ListFileVersions, ListMultipartUploads |
listKeys | ListAppKeys |
readFiles | CopyFile, CopyPart, DownloadFile, DownloadFileById, GetFileInfo |
shareFiles | GetDownloadAuthToken |
writeBuckets | CreateBucket, UpdateBucket |
writeFiles | AbortMultipartUpload, CompleteMultipartUpload, CopyFile, CopyPart, HideFile, ListParts, StartMultipartUpload, UploadFile, UploadPart |
writeKeys | CreateAppKey |
MinPartSize
long (read-only)
Default: -1
The minimum allowed multipart upload part size.
This field reflects the minimum allowed multipart upload part size, in bytes.
RecPartSize
long (read-only)
Default: -1
The recommended multipart upload part size.
This field reflects the recommended multipart upload part size, in bytes.
B2AppKey Type
A Backblaze B2 application key.
Remarks
This type represents a Backblaze B2 application key.
Fields
AllowedBucketId
string (read-only)
Default: ""
The Id of the bucket that the application key is restricted to.
This field reflects the Id of the bucket that the application key is restricted to. It will be empty if the application key is not restricted to any specific bucket.
AllowedPrefix
string (read-only)
Default: ""
The file name prefix that the application key is restricted to.
This field reflects the file name prefix that the application key is restricted to. It will be empty if the application key is not restricted to a specific file name prefix.
Capabilities
string (read-only)
Default: ""
The capabilities that the application key has.
This field reflects the capabilities that the application key has. It is formatted as a comma-separated list of one or more of the following:
Capability String | Related Methods |
deleteBuckets | DeleteBucket |
deleteFiles | DeleteFile, DeleteFileVersion |
deleteKeys | DeleteAppKey |
listBuckets | GetBucketInfo, ListBuckets |
listFiles | DeleteFile, ListFiles, ListFileVersions, ListMultipartUploads |
listKeys | ListAppKeys |
readFiles | CopyFile, CopyPart, DownloadFile, DownloadFileById, GetFileInfo |
shareFiles | GetDownloadAuthToken |
writeBuckets | CreateBucket, UpdateBucket |
writeFiles | AbortMultipartUpload, CompleteMultipartUpload, CopyFile, CopyPart, HideFile, ListParts, StartMultipartUpload, UploadFile, UploadPart |
writeKeys | CreateAppKey |
ExpirationTime
long (read-only)
Default: -1
The application key's expiration time.
This field reflects the expiration time of the application key, in milliseconds relative to the Unix epoch. It will be -1 if the application key does not expire.
KeyId
string (read-only)
Default: ""
The Id of the application key.
This field reflects the unique Id of the application key.
Name
string (read-only)
Default: ""
The name of the application key.
This field reflects the name assigned to the application key when it was created. Application key names are not used for identification, so there is no requirement for them to be unique.
B2Bucket Type
A Backblaze B2 bucket.
Remarks
This type represents a Backblaze B2 bucket.
Fields
Id
string (read-only)
Default: ""
The Id of the bucket.
This field reflects the unique Id of the bucket.
Kind
string (read-only)
Default: ""
The kind of bucket.
This field reflects the bucket's kind. Possible values are allPublic, allPrivate, or snapshot.
Name
string (read-only)
Default: ""
The name of the bucket.
This field reflects the name of the bucket.
Revision
long (read-only)
Default: -1
The revision number of the bucket.
This field reflects the bucket's revision number. A bucket's revision number is updated every time the bucket is modified.
B2File Type
A Backblaze B2 file.
Remarks
This type represents a Backblaze B2 file.
Fields
BucketId
string (read-only)
Default: ""
The Id of the bucket that the file is in.
This field reflects the Id of the bucket that the file is in.
ContentType
string (read-only)
Default: ""
The content type of the file.
This field reflects the content type of the file. Always application/x-bz-hide-marker when Kind is hide; and empty when Kind is folder.
CreatedTime
long (read-only)
Default: -1
The file's creation time.
This field reflects the file's creation time, in milliseconds relative to the Unix epoch. Always 0 when Kind is folder.
Id
string (read-only)
Default: ""
The Id of the file.
This field reflects the Id of the file. Always empty when Kind is folder.
Kind
string (read-only)
Default: ""
The kind of file.
This field reflects the file's kind. Possible values are:
MD5Hash
string (read-only)
Default: ""
An MD5 hash of the file's contents.
This field reflects a hex-encoded MD5 hash of the file's contents, or empty string if such a hash is not available.
ModifiedTime
long (read-only)
Default: -1
The file's last modified time.
This field reflects the file's last modified time, in milliseconds relative to the Unix epoch.
Note that this field will only be populated if a src_last_modified_millis metadata item is included for the file, and if that metadata item's value can be parsed as a 64-bit integer; otherwise, it will be -1. Refer to the ClientModifiedTime configuration setting for more information.
SHA1Hash
string (read-only)
Default: ""
A SHA1 hash of the file's contents.
This field reflects a hex-encoded SHA1 hash of the file's contents, or empty string if such a hash is not available. Always empty if Kind is folder or hide.
Size
long (read-only)
Default: 0
The file's size.
This field reflects the file's size, in bytes. Always 0 when Kind is folder, hide, or start.
B2Metadata Type
A Backblaze B2 metadata item.
Remarks
This type represents a Backblaze B2 metadata item.
Fields
Name
string
Default: ""
The name of the metadata item.
This field specifies the name of the metadata item. Metadata item names may be up to 50 characters in length, and must consist solely of letters, numbers, hyphens (-), and underscores (_). The server stores all metadata item names in lowercase.
A metadata item's name cannot start with b2- unless said name is one those explicitly defined by the Backblaze B2 API documentation. Keep in mind that the Value of such a metadata item must comply with the format specified by the Backblaze B2 API documentation as well, otherwise the server will reject it.
Value
string
Default: ""
The value of the metadata item.
This field specifies the value of the metadata item.
Constructors
public B2Metadata();
Public B2Metadata()
public B2Metadata(string name, string value);
Public B2Metadata(ByVal Name As String, ByVal Value As String)
B2Part Type
A Backblaze B2 multipart upload part.
Remarks
This type represents a Backblaze B2 multipart upload part.
Fields
CreatedTime
long (read-only)
Default: -1
The part's creation time.
This field reflects the part's creation time (i.e., upload time), in milliseconds relative to the Unix epoch.
MD5Hash
string (read-only)
Default: ""
An MD5 hash of the part's contents.
This field reflects a hex-encoded MD5 hash of the part's contents, or empty string if such a hash is not available.
PartNumber
int (read-only)
Default: -1
The number of the part.
This field specifies the number of the part. Must a be a value in the range 1 to 10000, inclusive.
SHA1Hash
string (read-only)
Default: ""
A SHA1 hash of the part's contents.
This field reflects a hex-encoded SHA1 hash of the part's contents.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
string (read-only)
Default: ""
This is 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.
ExpirationDate
string (read-only)
Default: ""
This is the date 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.
ExtendedKeyUsage
string (read-only)
Default: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
string (read-only)
Default: ""
This is 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
FingerprintSHA1
string (read-only)
Default: ""
This is 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
FingerprintSHA256
string (read-only)
Default: ""
This is 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
Issuer
string (read-only)
Default: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
string (read-only)
Default: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
bool (read-only)
Default: False
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
string (read-only)
Default: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
string (read-only)
Default: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string (read-only)
Default: ""
This field contains 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.
PublicKeyLength
int (read-only)
Default: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
string (read-only)
Default: ""
This is 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.
SignatureAlgorithm
string (read-only)
Default: ""
The field contains 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.
Store
string
Default: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
byte []
Default: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
string
Default: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default: 0
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This field can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
string (read-only)
Default: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default: ""
This field contains 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.
ThumbprintSHA1
string (read-only)
Default: ""
This field contains 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.
ThumbprintSHA256
string (read-only)
Default: ""
This field contains 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.
Usage
string (read-only)
Default: ""
This field contains the text description of UsageFlags.
This value will be of 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.
UsageFlags
int (read-only)
Default: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
string (read-only)
Default: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
string
Default: ""
This is the subject of the certificate used for client authentication.
This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.
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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
string
Default: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte []
Default: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
public Certificate();
Public Certificate()
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] encoded);
Public Certificate(ByVal Encoded As Byte())
Parses Encoded as an X.509 public key.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
Firewall Type
The firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
bool
Default: False
This field tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType
FirewallTypes
Default: 0
This field determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
string
Default: ""
This field contains the name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the component throws an exception.
Password
string
Default: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.
Port
int
Default: 0
This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
string
Default: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.
Constructors
Header Type
This is an HTTP header as it is received from the server.
Remarks
When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.
Fields
Field
string
Default: ""
This field contains the name of the HTTP Header (this is the same case as it is delivered).
Value
string
Default: ""
This field contains the Header contents.
Constructors
Proxy Type
The proxy the component will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme
ProxyAuthSchemes
Default: 0
This field is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.
AuthScheme should be set to authNone (3) when no authentication is expected.
By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.
If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.
If AuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this field will clear the values of User and Password.
AutoDetect
bool
Default: False
This field tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Password
string
Default: ""
This field contains a password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Port
int
Default: 80
This field contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.
Server
string
Default: ""
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.
SSL
ProxySSLTypes
Default: 0
This field determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. |
psAlways (1) | The connection is always SSL-enabled. |
psNever (2) | The connection is not SSL-enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
User
string
Default: ""
This field contains a username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Constructors
QueryParam Type
A query parameter to send in the request.
Remarks
This type represents a query parameter to send in the request.
Fields
Name
string
Default: ""
The name of the query parameter.
This field specifies the name of the query parameter.
Value
string
Default: ""
The value of the query parameter.
This field specifies the value of the query parameter. The component will automatically URL-encode this value when sending the request.
Constructors
public QueryParam();
Public QueryParam()
public QueryParam(string name, string value);
Public QueryParam(ByVal Name As String, ByVal Value As String)
Config Settings (BackblazeB2 Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.BackblazeB2 Config Settings
By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection property.
Note that this setting cannot be changed, it is returned by the server when Authorize is called.
Note that this setting cannot be changed.
This name and value format are the ones recommended by the Backblaze B2 API documentation to allow different clients to interoperate with each other. That said, it is still a normal metadata item as far as the server is concerned; this setting, as well as the Files.ModifiedTime field and the FileList event's ModifiedTime parameter, are provided as a convenience.
If this setting is non-empty when one of the aforementioned methods is called, the component will always add the src_last_modified_millis metadata item to the request before the items in the Metadata collection. Keep in mind that a file cannot have more than 10 metadata items; the component does not enforce this limit, but the server will return an error if it is exceeded.
Using this setting is only necessary when downloading a file that the currently-authenticated application key does not have access to (either due to restrictions on the key, or because the file is owned by someone else's account). If this setting is set, then the DownloadURL typically needs to be set as well (just remember to back up its current value first, and restore that value after the download is finished).
This setting is not applicable to the DownloadFileById method.
When downloading encrypted data with LocalFile set, the component will automatically create a temporary file at TempPath to hold the encrypted file contents. When the download is complete, the data is decrypted to LocalFile.
If the download is interrupted, the specified file will hold the partially downloaded encrypted file contents. Before resuming the download, this setting must be set to a valid file containing the partially encrypted file contents. See DownloadFile for details.
This setting's value should not be changed manually unless the DownloadAuthToken setting is being used (in which case the current value should be backed up so that it can be restored later); refer to that setting's documentation for more information.
This setting accepts a hex encoded value.
This setting accepts a hex encoded value.
- 0 (default) - PBKDF1
- 1 - PBKDF2
Valid values are 5242880 (5MB) to 2147483647 (2GB). This setting is automatically set to match the Account.RecPartSize field's value (or 2147483647, whichever is smaller) after the first successful call to Authorize for a particular ApplicationKey/ApplicationKeyId combination. Subsequent calls to Authorize will not change this setting's value unless ApplicationKey and/or ApplicationKeyId has changed, or Reset has been called.
Note that applications may need to increase this setting's value in order to upload very large files; Backblaze B2 only allows 10000 parts to be uploaded for any given multipart upload.
If the amount of upload data present when UploadFile is called is less than SimpleUploadLimit bytes, it will be uploaded directly, so this setting will not apply.
Note that calls to the aforementioned methods will never repopulate the Metadata collection, regardless of this setting's value.
If this setting is -1 (default), the server's default (100) is used. Acceptable values are 1 to 10000 (inclusive).
If this setting is -1 (default), the server's default (100) is used. Acceptable values are 1 to 1000 (inclusive).
If this setting is -1 (default), the server's default (100) is used. Acceptable values are 1 to 10000 (inclusive).
If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the Progress event will account for the data that was successfully transferred before the interruption.
If this setting is disabled, then the component will treat resumed transfers as "new" transfers, and the values reported by the Progress event will start at 0 rather than from the number of bytes already transferred.
Refer to the Progress event for more information.
The default value, 1, will cause the Progress event to fire each time the event's PercentDone parameter value increases by one percent. Setting this setting to 0 will cause the Progress event to fire every time data is transferred.
Note that the Progress event will always fire once at the beginning and end of a transfer, regardless of this setting's value. Also, if PercentDone cannot be calculated for a particular transfer (e.g., for downloads that use chunked transfer encoding), then the component will behave as if this setting were 0 for the duration of the transfer.
Refer to UploadFile for more information.
If this setting is disabled (default), or if this setting is enabled but there are no Metadata items (and ClientModifiedTime is also empty), then the server will copy the source file's current metadata to the destination file.
Valid values are -1 to 5368709120 (5GB), inclusive. This setting is automatically set to twice the Account.RecPartSize field's value after the first successful call to Authorize for a particular ApplicationKey/ApplicationKeyId combination. Subsequent calls to Authorize will not change this setting's value unless ApplicationKey and/or ApplicationKeyId has changed, or Reset has been called.
If this setting is set to 0, the component will always perform a multipart upload to create a file; if it is set to -1, the component will never perform a multipart upload.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example, /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair.
Supports single and double quotes. (XML Only) |
. | The current element. |
.. | The parent element. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
JSON:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
The following are examples of valid XPaths for these responses:
Description | XML XPath | JSON XPath |
Document root | / | /json |
Specific element | /firstlevel/one | /json/firstlevel/one |
i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This list is not exhaustive, but it provides a general idea of the possibilities.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
HTTP Config Settings
When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component throws an exception if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component throws an exception.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the component throws an exception instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the component beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified.
When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.
RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.
The connection to the firewall is made by calling the Connect method.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component is connected, the LocalHost setting 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).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
If set to True, the component will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the component is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.
When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available in Java or when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component throws an exception.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.
Note: This setting is static. The value set is applicable to all components used in the application.
When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.
Trappable Errors (BackblazeB2 Component)
Common Errors
600 | A server error occurred, and/or the component was unable to process the server's response. Please refer to the error message for more information. |
601 | An unsupported operation or action was attempted. |
602 | The RawRequest or RawResponse configuration setting was queried without first setting the TransferredRequest configuration setting to ON. |
603 | The login credentials specified were invalid. Please refer to the error message for more information. |
604 | An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified. |
605 | An invalid index was specified. |
606 | An upload was aborted by the user before it could finish. |
607 | The specified resource is a folder and cannot be downloaded. |
608 | A download failed because the specified LocalFile already exists and Overwrite is false. |
609 | The component could not resume a download or upload. Please refer to the error message for more information. |
610 | An encrypted download could not be resumed because the DownloadTempFile configuration setting is not set. |
611 | An exception occurred while working with the specified LocalFile (or the current value of LocalFile is invalid). Please refer to the error message for more information. |
612 | An exception occurred while working with the specified upload or download stream. Please refer to the error message for more information. |
BackblazeB2 Errors
700 | The current Account.AuthToken has expired or is otherwise no longer valid; call Authorize to obtain a new one. |
701 | The specified DownloadAuthToken has expired or is otherwise no longer valid. |
702 | The request failed due to a temporary server error; try again, using exponential backoff if necessary. |
The component may also return one of the following error codes, which are inherited from other components.
HTTP Errors
118 | Firewall Error. Error description contains detailed message. |
143 | Busy executing current method. |
151 | HTTP protocol error. The error message has the server response. |
152 | No server specified in URL |
153 | Specified URLScheme is invalid. |
155 | Range operation is not supported by server. |
156 | Invalid cookie index (out of range). |
301 | Interrupted. |
302 | Can't open AttachedFile. |
The component may also return one of the following error codes, which are inherited from other components.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the component is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
303 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |