Linode Class
Properties Methods Events Config Settings Errors
The Linode class provides an easy way to interface with Linode's Object Storage service.
Class Name
CloudStorage_Linode
Procedural Interface
cloudstorage_linode_open(); cloudstorage_linode_close($res); cloudstorage_linode_register_callback($res, $id, $function); cloudstorage_linode_get_last_error($res); cloudstorage_linode_get_last_error_code($res); cloudstorage_linode_set($res, $id, $index, $value); cloudstorage_linode_get($res, $id, $index); cloudstorage_linode_do_abortmultipartupload($res, $objectname, $uploadid); cloudstorage_linode_do_addmetadata($res, $name, $value); cloudstorage_linode_do_addqueryparam($res, $name, $value); cloudstorage_linode_do_bucketexists($res); cloudstorage_linode_do_checkversioningenabled($res); cloudstorage_linode_do_completemultipartupload($res, $objectname, $uploadid); cloudstorage_linode_do_config($res, $configurationstring); cloudstorage_linode_do_copyobject($res, $srcobjectname, $destbucket, $destobjectname); cloudstorage_linode_do_copypart($res, $srcobjectname, $destbucket, $destobjectname, $destpartnumber, $destuploadid); cloudstorage_linode_do_createbucket($res); cloudstorage_linode_do_createobject($res, $objectname); cloudstorage_linode_do_deletebucket($res); cloudstorage_linode_do_deleteobject($res, $objectname); cloudstorage_linode_do_disableversioning($res); cloudstorage_linode_do_doevents($res); cloudstorage_linode_do_enableversioning($res); cloudstorage_linode_do_getbucketlocation($res); cloudstorage_linode_do_getlink($res, $objectname, $expires); cloudstorage_linode_do_getobject($res, $objectname); cloudstorage_linode_do_getobjectinfo($res, $objectname); cloudstorage_linode_do_interrupt($res); cloudstorage_linode_do_listbuckets($res); cloudstorage_linode_do_listmultipartuploads($res); cloudstorage_linode_do_listobjects($res); cloudstorage_linode_do_listparts($res, $objectname, $uploadid); cloudstorage_linode_do_listversions($res); cloudstorage_linode_do_reset($res); cloudstorage_linode_do_resetheaders($res); cloudstorage_linode_do_sendcustomrequest($res, $httpmethod, $objectname, $requestbody); cloudstorage_linode_do_startmultipartupload($res, $objectname); cloudstorage_linode_do_updatebucketacl($res); cloudstorage_linode_do_updateobjectacl($res, $objectname); cloudstorage_linode_do_uploadpart($res, $objectname, $partnumber, $uploadid);
Remarks
The Linode Object Storage service has an API that is compatible with that of Amazon S3, allowing you to store arbitrary data using the same bucket-and-object paradigm that S3 uses.
To use the Linode class, you will first need to sign up for the Linode Object Storage service and obtain an AccessKey and a SecretKey. Then you can start creating buckets in your account using CreateBucket. The buckets are place holders for your objects allowing you to access them by http URLs. You can then add objects to any of your buckets using CreateObject.
There are other methods such as ListBuckets, ListObjects, GetObject, GetLink, DeleteObject etc. that further enable you to manage your data store.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AccessKey | The access key to use for authentication. |
AccessPolicy | The canned access policy to apply to a bucket or object. |
Bucket | Selects a bucket. |
BucketsCount | The number of records in the Buckets arrays. |
BucketsCreationDate | The property includes the creation date of the bucket. |
BucketsName | The property contains the name of the bucket. |
BucketsOwnerDisplayName | The property contains the display name of the bucket's owner. |
BucketsOwnerId | The property contains the Id of the bucket's owner. |
ContentDisposition | Content disposition to send for an object. |
ContentType | Content type to send for an object. |
EncryptionAlgorithm | The encryption algorithm. |
EncryptionPassword | The encryption password. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of the firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the Transmission Control Protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a username if authentication is to be used when connecting through a firewall. |
FollowRedirects | Determines what happens when the server issues a redirect. |
Idle | This property specifies the current status of the class. |
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. |
MetadataCount | The number of records in the Metadata arrays. |
MetadataName | The property contains the name of the metadata item. |
MetadataValue | This property contains the value of the metadata item. |
ObjectData | The data that was downloaded, or that should be uploaded. |
ObjectDelimiter | The delimiter string to use when listing objects. |
ObjectMarker | A marker indicating what page of objects to return next. |
ObjectPrefix | A prefix used to restrict the results returned when listing objects. |
ObjectsCount | The number of records in the Objects arrays. |
ObjectsDeleted | This property specifies whether this object version is a delete marker. |
ObjectsETag | This property contains the ETag of the object. |
ObjectsLastModified | This property contains the last modified time of the object. |
ObjectsLatestVersion | This property specifies whether this is the latest object version. |
ObjectsName | This property contains the name (key) of the object. |
ObjectsOwnerDisplayName | This property contains the display name of the object's owner. |
ObjectsOwnerId | This property contains the Id of the object's owner. |
ObjectsSize | This property contains the size of the object. |
ObjectsStorageClass | This property contains the storage class of the object. |
ObjectsUploadId | This property contains the upload Id of the multipart upload. |
ObjectsVersionId | This property contains the Id of the object version. |
OtherHeaders | This property includes other headers as determined by the user (optional). |
Overwrite | Determines if local files are overwritten. |
ParsedHeaderCount | The number of records in the ParsedHeader arrays. |
ParsedHeaderField | This property contains the name of the HTTP header (this is the same case as it is delivered). |
ParsedHeaderValue | This property contains the header contents. |
PartMarker | A marker indicating what page of parts to return next. |
PartsCount | The number of records in the Parts arrays. |
PartsETag | This property contains the ETag of the part. |
PartsLastModified | This property contains the last modified time of the part. |
PartsObjectName | This property contains the name (key) of the object that the part was uploaded for. |
PartsOwnerDisplayName | This property contains the display name of the part's owner. |
PartsOwnerId | This property contains the Id of the part's owner. |
PartsNumber | This property contains the number of the part. |
PartsSize | This property contains the size of the part. |
ProxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | This property contains a username if authentication is to be used for the proxy. |
QueryParamCount | The number of records in the QueryParam arrays. |
QueryParamName | The name of the query parameter. |
QueryParamValue | The value of the query parameter. |
Range | The range of bytes to request. |
Region | The region the class will make requests against. |
SecretKey | The secret key to use for authentication. |
SSLAcceptServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | This is the date the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | This is the issuer of the certificate. |
SSLAcceptServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | This is the public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | This is the name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | This is the type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | This property contains the text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | This property contains the certificate's version number. |
SSLAcceptServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLCertExpirationDate | This is the date the certificate expires. |
SSLCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | This is the issuer of the certificate. |
SSLCertPrivateKey | This is the private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | This is the public key of the certificate. |
SSLCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLCertUsage | This property contains the text description of UsageFlags . |
SSLCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLCertVersion | This property contains the certificate's version number. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLServerCertExpirationDate | This is the date the certificate expires. |
SSLServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLServerCertIssuer | This is the issuer of the certificate. |
SSLServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLServerCertPublicKey | This is the public key of the certificate. |
SSLServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLServerCertStore | This is the name of the certificate store for the client certificate. |
SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLServerCertStoreType | This is the type of certificate store for this certificate. |
SSLServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLServerCertUsage | This property contains the text description of UsageFlags . |
SSLServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLServerCertVersion | This property contains the certificate's version number. |
SSLServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
StartByte | The byte offset from which to resume the upload or download. |
Timeout | This property includes the timeout for the class. |
UseVirtualHosting | Determines which style request to use. |
VersionId | The object version to make requests against. |
VersionMarker | A marker indicating what page of object versions to return next. |
Method List
The following is the full list of the methods of the class 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. |
BucketExists | Checks whether the bucket exists. |
CheckVersioningEnabled | Checks whether versioning is enabled for the currently selected bucket. |
CompleteMultipartUpload | Completes a multipart upload by assembling previously uploaded parts. |
Config | Sets or retrieves a configuration setting. |
CopyObject | Copies an object. |
CopyPart | Copies the specified object as a part of a multipart upload. |
CreateBucket | Creates a new bucket. |
CreateObject | Creates a new object in the currently selected bucket. |
DeleteBucket | Deletes a bucket. |
DeleteObject | Deletes an object. |
DisableVersioning | Disables versioning for the currently selected bucket. |
DoEvents | This method processes events from the internal message queue. |
EnableVersioning | Enables versioning for the currently selected bucket. |
GetBucketLocation | Gets a bucket's location. |
GetLink | Creates a link that provides access to an object for a specified amount of time. |
GetObject | Downloads an object. |
GetObjectInfo | Gets an object's information and metadata. |
Interrupt | This method interrupts the current method. |
ListBuckets | Lists all buckets in the currently-selected region. |
ListMultipartUploads | Lists the current multipart uploads. |
ListObjects | Lists the objects in a bucket. |
ListParts | Lists the parts in a multipart upload. |
ListVersions | Lists the object versions in a bucket. |
Reset | Resets the class to its initial state. |
ResetHeaders | Resets all HTTP headers, cookies, and LocalFile. |
SendCustomRequest | Sends a custom request to the server. |
StartMultipartUpload | Starts a new manual multipart upload. |
UpdateBucketACL | Updates a bucket's canned access policy. |
UpdateObjectACL | Updates an object's canned access policy. |
UploadPart | Uploads a multipart upload part. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
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. |
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 object information and metadata is retrieved. |
ObjectList | Fires once for each object, object version, or multipart upload returned when listing such items. |
PartList | Fires once for every part returned when listing a multipart upload's parts. |
PrefixList | Fires once for each common prefix returned when listing objects. |
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 class with short descriptions. Click on the links for further details.
AccumulatePages | Whether the class should accumulate subsequent pages of results when listing them. |
AssumeRoleARN | Amazon Resource Name used when assuming a role for authentication. |
AssumeRoleDuration | The durration for role session in seconds. |
AssumeRoleSessionName | Unique name for current role session. |
AutoDetectSigningRegion | Whether or not to automatically detect the region from the base URL in order to use it for the HMAC signing process. |
AWSProfile | The name of the AWS CLI profile that the class should use to obtain authentication and region information. |
AWSProfileDir | The location of the AWS CLI credentials and config files. |
ContentRange | This contains the range of bytes of the current object that are being returned. |
CopyPartRange | Specifies the range of bytes to copy when calling CopyPart. |
DownloadTempFile | The temporary file used when downloading encrypted data. |
EncodeSlashInObjectName | Whether or not to encode slashes in an object name. |
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. |
EnforceBucketNameRestrictions | Whether or not to enforce bucket naming conventions. |
ETag | The ETag for the object returned by the server. |
FragmentSize | The part size to use when uploading a new object. |
IfMatch | Check to make sure the object has not been modified since the last request. |
IncludeContentMD5 | Whether an MD5 digest of a custom request's data should be included. |
IncludeObjectMD5 | Whether an MD5 digest of a object's data should be included. |
IncludePartMD5 | Whether an MD5 digest of a part's data should be included. |
MaskSensitiveData | Whether sensitive data is masked in the Log event. |
MaxObjects | The maximum number of results to return when listing objects. |
MaxParts | The maximum number of results to return when listing parts. |
Prefix[i] | The i'th common prefix returned. |
PrefixCount | The number of common prefixes returned. |
ProgressAbsolute | Whether the class 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. |
ResponseCacheControl | Sets the Cache-Control header of the response. |
ResponseContentDisposition | Sets the Content-Disposition header of the response. |
ResponseContentEncoding | Sets the Content-Encoding header of the response. |
ResponseContentLanguage | Sets the Content-Language header of the response. |
ResponseContentType | Sets the Content-Type header of the response. |
ResponseExpires | Sets the Expires header of the response. |
ResumableUploadState | Tracks upload state information during an automatic multipart upload. |
SessionToken | The session token to send in the request when using temporary credentials. |
SignCustomRequest | Tells the class to sign the outgoing request. |
SigningTime | A custom date to send to the class to use while signing all requests. |
SimpleUploadLimit | The maximum data size the class should attempt to upload directly when creating an object. |
StoreObjectData | Whether class stores object data or not. |
StorePrefixList | Whether to store the common prefixes returned when listing objects. |
TempPath | The path to the directory where temporary files are created. |
URL | If set, the default URL will be overridden by this value. |
UseEC2RoleCredentials | Whether to authenticate requests with credentials obtained from the IAM role attached to the EC2 instance. |
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. |
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 class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class 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 class. |
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. |
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 class. |
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. |
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). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
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 class 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. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
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. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AccessKey Property (CloudStorage_Linode Class)
The access key to use for authentication.
Object Oriented Interface
public function getAccessKey(); public function setAccessKey($value);
Procedural Interface
cloudstorage_linode_get($res, 1 ); cloudstorage_linode_set($res, 1, $value );
Default Value
''
Remarks
This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations which connect to the server.
Data Type
String
AccessPolicy Property (CloudStorage_Linode Class)
The canned access policy to apply to a bucket or object.
Object Oriented Interface
public function getAccessPolicy(); public function setAccessPolicy($value);
Procedural Interface
cloudstorage_linode_get($res, 2 ); cloudstorage_linode_set($res, 2, $value );
Default Value
0
Remarks
This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called:
- CopyObject (for the destination object)
- CreateBucket
- CreateObject
- StartMultipartUpload
- UpdateBucketACL
- UpdateObjectACL
Valid values are:
ptPrivate (0) (default) | Owner gets full control, no one else has access. |
ptPublicRead (1) | Owner gets full control, everyone else gets read access. |
ptPublicReadWrite (2) | Owner gets full control, everyone else gets read/write access. |
ptAuthenticatedRead (3) | Owner gets full control, authenticated users get read access. |
ptBucketOwnerRead (4) | Only applicable for objects. Object owner gets full control, bucket owner gets read access. |
ptBucketOwnerFullControl (5) | Only applicable for objects. Both object and bucket owner get full control. |
ptNone (6) | (Instructs the class to not explicitly set a canned access policy for a bucket or object.) |
Data Type
Integer
Bucket Property (CloudStorage_Linode Class)
Selects a bucket.
Object Oriented Interface
public function getBucket(); public function setBucket($value);
Procedural Interface
cloudstorage_linode_get($res, 3 ); cloudstorage_linode_set($res, 3, $value );
Default Value
''
Remarks
This property selects a bucket, by name, for the class to operate against. It must be set before attempting most operations.
Data Type
String
BucketsCount Property (CloudStorage_Linode Class)
The number of records in the Buckets arrays.
Object Oriented Interface
public function getBucketsCount();
Procedural Interface
cloudstorage_linode_get($res, 4 );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at BucketsCount - 1.This property is read-only and not available at design time.
Data Type
Integer
BucketsCreationDate Property (CloudStorage_Linode Class)
The property includes the creation date of the bucket.
Object Oriented Interface
public function getBucketsCreationDate($bucketsindex);
Procedural Interface
cloudstorage_linode_get($res, 5 , $bucketsindex);
Default Value
''
Remarks
The property includes the creation date of the bucket.
This property reflects the creation date of the bucket.
The $bucketsindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.
This property is read-only and not available at design time.
Data Type
String
BucketsName Property (CloudStorage_Linode Class)
The property contains the name of the bucket.
Object Oriented Interface
public function getBucketsName($bucketsindex);
Procedural Interface
cloudstorage_linode_get($res, 6 , $bucketsindex);
Default Value
''
Remarks
The property contains the name of the bucket.
This property reflects the name of the bucket.
The $bucketsindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.
This property is read-only and not available at design time.
Data Type
String
BucketsOwnerDisplayName Property (CloudStorage_Linode Class)
The property contains the display name of the bucket's owner.
Object Oriented Interface
public function getBucketsOwnerDisplayName($bucketsindex);
Procedural Interface
cloudstorage_linode_get($res, 7 , $bucketsindex);
Default Value
''
Remarks
The property contains the display name of the bucket's owner.
This property reflects the display name of the bucket's owner.
The $bucketsindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.
This property is read-only and not available at design time.
Data Type
String
BucketsOwnerId Property (CloudStorage_Linode Class)
The property contains the Id of the bucket's owner.
Object Oriented Interface
public function getBucketsOwnerId($bucketsindex);
Procedural Interface
cloudstorage_linode_get($res, 8 , $bucketsindex);
Default Value
''
Remarks
The property contains the Id of the bucket's owner.
This property reflects the Id of the bucket's owner.
The $bucketsindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.
This property is read-only and not available at design time.
Data Type
String
ContentDisposition Property (CloudStorage_Linode Class)
Content disposition to send for an object.
Object Oriented Interface
public function getContentDisposition(); public function setContentDisposition($value);
Procedural Interface
cloudstorage_linode_get($res, 9 ); cloudstorage_linode_set($res, 9, $value );
Default Value
''
Remarks
This property can be set before calling CreateObject to have its value submitted as the object's Content-Disposition header value. This same value will then be returned in the Content-Disposition header by the server anytime the object is downloaded.
This property is not available at design time.
Data Type
String
ContentType Property (CloudStorage_Linode Class)
Content type to send for an object.
Object Oriented Interface
public function getContentType(); public function setContentType($value);
Procedural Interface
cloudstorage_linode_get($res, 10 ); cloudstorage_linode_set($res, 10, $value );
Default Value
''
Remarks
This property can be set before calling CreateObject to have its value submitted as the object's Content-Type header value. This same value will then be returned in the Content-Type header by the server anytime the object is downloaded.
This property is not available at design time.
Data Type
String
EncryptionAlgorithm Property (CloudStorage_Linode Class)
The encryption algorithm.
Object Oriented Interface
public function getEncryptionAlgorithm(); public function setEncryptionAlgorithm($value);
Procedural Interface
cloudstorage_linode_get($res, 11 ); cloudstorage_linode_set($res, 11, $value );
Default Value
0
Remarks
This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:
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 |
Data Type
Integer
EncryptionPassword Property (CloudStorage_Linode Class)
The encryption password.
Object Oriented Interface
public function getEncryptionPassword(); public function setEncryptionPassword($value);
Procedural Interface
cloudstorage_linode_get($res, 12 ); cloudstorage_linode_set($res, 12, $value );
Default Value
''
Remarks
If this property is populated when UploadFile or DownloadFile is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.
The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.
However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.
This property is not available at design time.
Data Type
String
FirewallAutoDetect Property (CloudStorage_Linode Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Object Oriented Interface
public function getFirewallAutoDetect(); public function setFirewallAutoDetect($value);
Procedural Interface
cloudstorage_linode_get($res, 13 ); cloudstorage_linode_set($res, 13, $value );
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (CloudStorage_Linode Class)
This property determines the type of firewall to connect through.
Object Oriented Interface
public function getFirewallType(); public function setFirewallType($value);
Procedural Interface
cloudstorage_linode_get($res, 14 ); cloudstorage_linode_set($res, 14, $value );
Default Value
0
Remarks
This property 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. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (CloudStorage_Linode Class)
This property contains the name or IP address of the firewall (optional).
Object Oriented Interface
public function getFirewallHost(); public function setFirewallHost($value);
Procedural Interface
cloudstorage_linode_get($res, 15 ); cloudstorage_linode_set($res, 15, $value );
Default Value
''
Remarks
This property contains the name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.
Data Type
String
FirewallPassword Property (CloudStorage_Linode Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Object Oriented Interface
public function getFirewallPassword(); public function setFirewallPassword($value);
Procedural Interface
cloudstorage_linode_get($res, 16 ); cloudstorage_linode_set($res, 16, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Data Type
String
FirewallPort Property (CloudStorage_Linode Class)
This property contains the Transmission Control Protocol (TCP) port for the firewall Host .
Object Oriented Interface
public function getFirewallPort(); public function setFirewallPort($value);
Procedural Interface
cloudstorage_linode_get($res, 17 ); cloudstorage_linode_set($res, 17, $value );
Default Value
0
Remarks
This property contains the Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (CloudStorage_Linode Class)
This property contains a username if authentication is to be used when connecting through a firewall.
Object Oriented Interface
public function getFirewallUser(); public function setFirewallUser($value);
Procedural Interface
cloudstorage_linode_get($res, 18 ); cloudstorage_linode_set($res, 18, $value );
Default Value
''
Remarks
This property contains a username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
FollowRedirects Property (CloudStorage_Linode Class)
Determines what happens when the server issues a redirect.
Object Oriented Interface
public function getFollowRedirects(); public function setFollowRedirects($value);
Procedural Interface
cloudstorage_linode_get($res, 19 ); cloudstorage_linode_set($res, 19, $value );
Default Value
0
Remarks
This property specifies how the class should behave when the server returns a redirect response (e.g. "Object Moved"). Valid values are:
frNever (0) (default) | Redirects are never followed; the class fails with an error instead. |
frAlways (1) | Redirects are always followed. |
frSameScheme (2) | Redirects are followed if the new URL has the same scheme as the originally requested URL; otherwise, the class fails with an error. |
Data Type
Integer
Idle Property (CloudStorage_Linode Class)
This property specifies the current status of the class.
Object Oriented Interface
public function getIdle();
Procedural Interface
cloudstorage_linode_get($res, 20 );
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.
Data Type
Boolean
LocalFile Property (CloudStorage_Linode Class)
The location of the local file.
Object Oriented Interface
public function getLocalFile(); public function setLocalFile($value);
Procedural Interface
cloudstorage_linode_get($res, 21 ); cloudstorage_linode_set($res, 21, $value );
Default Value
''
Remarks
This property specifies the location of a file on disk. This is used as the source file when calling CreateObject or UploadPart; and as the destination file when calling GetObject.
Data Type
String
LocalHost Property (CloudStorage_Linode Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Object Oriented Interface
public function getLocalHost(); public function setLocalHost($value);
Procedural Interface
cloudstorage_linode_get($res, 22 ); cloudstorage_linode_set($res, 22, $value );
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 class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
MetadataCount Property (CloudStorage_Linode Class)
The number of records in the Metadata arrays.
Object Oriented Interface
public function getMetadataCount(); public function setMetadataCount($value);
Procedural Interface
cloudstorage_linode_get($res, 23 ); cloudstorage_linode_set($res, 23, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MetadataCount - 1.This property is not available at design time.
Data Type
Integer
MetadataName Property (CloudStorage_Linode Class)
The property contains the name of the metadata item.
Object Oriented Interface
public function getMetadataName($metadataindex); public function setMetadataName($metadataindex, $value);
Procedural Interface
cloudstorage_linode_get($res, 24 , $metadataindex); cloudstorage_linode_set($res, 24, $value , $metadataindex);
Default Value
''
Remarks
The property contains the name of the metadata item.
This property specifies the name of the metadata item. The server stores metadata names in lowercase.
Note: The class will automatically prepend the service-appropriate prefix (e.g., x-amz-meta-, x-goog-meta-) to this value when submitting metadata items to the server and will automatically strip that prefix from this value when this property is populated.
The $metadataindex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.
This property is not available at design time.
Data Type
String
MetadataValue Property (CloudStorage_Linode Class)
This property contains the value of the metadata item.
Object Oriented Interface
public function getMetadataValue($metadataindex); public function setMetadataValue($metadataindex, $value);
Procedural Interface
cloudstorage_linode_get($res, 25 , $metadataindex); cloudstorage_linode_set($res, 25, $value , $metadataindex);
Default Value
''
Remarks
This property contains the value of the metadata item.
This property specifies the value of the metadata item.
The $metadataindex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.
This property is not available at design time.
Data Type
String
ObjectData Property (CloudStorage_Linode Class)
The data that was downloaded, or that should be uploaded.
Object Oriented Interface
public function getObjectData(); public function setObjectData($value);
Procedural Interface
cloudstorage_linode_get($res, 26 ); cloudstorage_linode_set($res, 26, $value );
Default Value
''
Remarks
This property is populated with object data after calling GetObject if LocalFile is not set.
This property can also be set before calling CreateObject or UploadPart; its data will be uploaded if LocalFile is not set.
This property is not available at design time.
Data Type
Binary String
ObjectDelimiter Property (CloudStorage_Linode Class)
The delimiter string to use when listing objects.
Object Oriented Interface
public function getObjectDelimiter(); public function setObjectDelimiter($value);
Procedural Interface
cloudstorage_linode_get($res, 27 ); cloudstorage_linode_set($res, 27, $value );
Default Value
''
Remarks
If this property is non-empty when ListObjects or ListVersions is called, any objects (or object versions) whose names contain the same string between the specified ObjectPrefix and the first occurrence of the specified delimiter that follow will be rolled up into a "common prefix" element, which is returned in place of the individual objects themselves.
The PrefixList event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the class will also populate the PrefixCount and Prefix[i] configuration settings
Object Hierarchy Traversal
By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:
- MyCompany/
- MyCompany/Department1/
- MyCompany/Department2/
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:
ObjectPrefix Value | ObjectDelimiter Value | Objects Returned | Prefixes Returned |
(empty) | / | (none) | 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.
Data Type
String
ObjectMarker Property (CloudStorage_Linode Class)
A marker indicating what page of objects to return next.
Object Oriented Interface
public function getObjectMarker(); public function setObjectMarker($value);
Procedural Interface
cloudstorage_linode_get($res, 28 ); cloudstorage_linode_set($res, 28, $value );
Default Value
''
Remarks
This property will be populated when ListObjects is called if the results are paged and there are more pages. To list all objects, continue to call ListObjects until this property returns empty string.
Refer to ListObjects for more information.
This property is not available at design time.
Data Type
String
ObjectPrefix Property (CloudStorage_Linode Class)
A prefix used to restrict the results returned when listing objects.
Object Oriented Interface
public function getObjectPrefix(); public function setObjectPrefix($value);
Procedural Interface
cloudstorage_linode_get($res, 29 ); cloudstorage_linode_set($res, 29, $value );
Default Value
''
Remarks
This property, if non-empty, is used to restrict the results returned by ListObjects (or ListVersions) to only the objects (or object versions) whose names begin with the given value.
Object Hierarchy Traversal
By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:
- MyCompany/
- MyCompany/Department1/
- MyCompany/Department2/
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:
ObjectPrefix Value | ObjectDelimiter Value | Objects Returned | Prefixes Returned |
(empty) | / | (none) | 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.
Data Type
String
ObjectsCount Property (CloudStorage_Linode Class)
The number of records in the Objects arrays.
Object Oriented Interface
public function getObjectsCount();
Procedural Interface
cloudstorage_linode_get($res, 30 );
Default Value
0
Remarks
This property controls the size of the following arrays:
- ObjectsDeleted
- ObjectsETag
- ObjectsLastModified
- ObjectsLatestVersion
- ObjectsName
- ObjectsOwnerDisplayName
- ObjectsOwnerId
- ObjectsSize
- ObjectsStorageClass
- ObjectsUploadId
- ObjectsVersionId
This property is read-only and not available at design time.
Data Type
Integer
ObjectsDeleted Property (CloudStorage_Linode Class)
This property specifies whether this object version is a delete marker.
Object Oriented Interface
public function getObjectsDeleted($objectsindex);
Procedural Interface
cloudstorage_linode_get($res, 31 , $objectsindex);
Default Value
false
Remarks
This property specifies whether this object version is a delete marker.
This property indicates whether this object version is a delete marker. Delete markers are created when an object in a versioning-enabled bucket is "deleted" (i.e., instead of actually deleting any data); refer to DeleteObject for more information.
This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; false in all other cases.
The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.
This property is read-only and not available at design time.
Data Type
Boolean
ObjectsETag Property (CloudStorage_Linode Class)
This property contains the ETag of the object.
Object Oriented Interface
public function getObjectsETag($objectsindex);
Procedural Interface
cloudstorage_linode_get($res, 32 , $objectsindex);
Default Value
''
Remarks
This property contains the ETag of the object.
This property reflects the ETag of the object.
An object's ETag is an MD5 hash of its contents, and as such, it can be used to determine whether its contents have been modified.
This is not applicable when ListMultipartUploads is called.
The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.
This property is read-only and not available at design time.
Data Type
String
ObjectsLastModified Property (CloudStorage_Linode Class)
This property contains the last modified time of the object.
Object Oriented Interface
public function getObjectsLastModified($objectsindex);
Procedural Interface
cloudstorage_linode_get($res, 33 , $objectsindex);
Default Value
''
Remarks
This property contains the last modified time of the object.
This property reflects the last modified time of the object.
This is not applicable when ListMultipartUploads is called.
The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.
This property is read-only and not available at design time.
Data Type
String
ObjectsLatestVersion Property (CloudStorage_Linode Class)
This property specifies whether this is the latest object version.
Object Oriented Interface
public function getObjectsLatestVersion($objectsindex);
Procedural Interface
cloudstorage_linode_get($res, 34 , $objectsindex);
Default Value
true
Remarks
This property specifies whether this is the latest object version.
This property indicates whether this object version is the latest version available.
This is applicable only when ListVersions is called.; true in all other cases.
The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.
This property is read-only and not available at design time.
Data Type
Boolean
ObjectsName Property (CloudStorage_Linode Class)
This property contains the name (key) of the object.
Object Oriented Interface
public function getObjectsName($objectsindex);
Procedural Interface
cloudstorage_linode_get($res, 35 , $objectsindex);
Default Value
''
Remarks
This property contains the name (key) of the object.
This property reflects the name (key) of the object.
The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.
This property is read-only and not available at design time.
Data Type
String
ObjectsOwnerDisplayName Property (CloudStorage_Linode Class)
This property contains the display name of the object's owner.
Object Oriented Interface
public function getObjectsOwnerDisplayName($objectsindex);
Procedural Interface
cloudstorage_linode_get($res, 36 , $objectsindex);
Default Value
''
Remarks
This property contains the display name of the object's owner.
This property reflects the display name of the object's owner.
This is not applicable when GetObjectInfo is called.
The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.
This property is read-only and not available at design time.
Data Type
String
ObjectsOwnerId Property (CloudStorage_Linode Class)
This property contains the Id of the object's owner.
Object Oriented Interface
public function getObjectsOwnerId($objectsindex);
Procedural Interface
cloudstorage_linode_get($res, 37 , $objectsindex);
Default Value
''
Remarks
This property contains the Id of the object's owner.
This property reflects the Id of the object's owner.
This is not applicable when GetObjectInfo is called.
The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.
This property is read-only and not available at design time.
Data Type
String
ObjectsSize Property (CloudStorage_Linode Class)
This property contains the size of the object.
Object Oriented Interface
public function getObjectsSize($objectsindex);
Procedural Interface
cloudstorage_linode_get($res, 38 , $objectsindex);
Default Value
0
Remarks
This property contains the size of the object.
This property reflects the size of the object in bytes.
This is not applicable when ListMultipartUploads is called.
The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.
This property is read-only and not available at design time.
Data Type
Long64
ObjectsStorageClass Property (CloudStorage_Linode Class)
This property contains the storage class of the object.
Object Oriented Interface
public function getObjectsStorageClass($objectsindex);
Procedural Interface
cloudstorage_linode_get($res, 39 , $objectsindex);
Default Value
''
Remarks
This property contains the storage class of the object.
This property reflects the storage class of the object.
The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.
This property is read-only and not available at design time.
Data Type
String
ObjectsUploadId Property (CloudStorage_Linode Class)
This property contains the upload Id of the multipart upload.
Object Oriented Interface
public function getObjectsUploadId($objectsindex);
Procedural Interface
cloudstorage_linode_get($res, 40 , $objectsindex);
Default Value
''
Remarks
This property contains the upload Id of the multipart upload.
This property reflects the upload Id of the multipart upload.
It is applicable only when ListMultipartUploads is called.
The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.
This property is read-only and not available at design time.
Data Type
String
ObjectsVersionId Property (CloudStorage_Linode Class)
This property contains the Id of the object version.
Object Oriented Interface
public function getObjectsVersionId($objectsindex);
Procedural Interface
cloudstorage_linode_get($res, 41 , $objectsindex);
Default Value
''
Remarks
This property contains the Id of the object version.
This property reflects the Id of the object version.
Note: The string null is a valid version Id.
This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; empty in all other cases.
The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.
This property is read-only and not available at design time.
Data Type
String
OtherHeaders Property (CloudStorage_Linode Class)
This property includes other headers as determined by the user (optional).
Object Oriented Interface
public function getOtherHeaders(); public function setOtherHeaders($value);
Procedural Interface
cloudstorage_linode_get($res, 42 ); cloudstorage_linode_set($res, 42, $value );
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 class beyond what is provided.
This property is not available at design time.
Data Type
String
Overwrite Property (CloudStorage_Linode Class)
Determines if local files are overwritten.
Object Oriented Interface
public function getOverwrite(); public function setOverwrite($value);
Procedural Interface
cloudstorage_linode_get($res, 43 ); cloudstorage_linode_set($res, 43, $value );
Default Value
false
Remarks
This property controls whether local files are overwritten when calling GetObject. It is only applicable to local files. The default value is false.
Data Type
Boolean
ParsedHeaderCount Property (CloudStorage_Linode Class)
The number of records in the ParsedHeader arrays.
Object Oriented Interface
public function getParsedHeaderCount();
Procedural Interface
cloudstorage_linode_get($res, 44 );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ParsedHeaderCount - 1.This property is read-only and not available at design time.
Data Type
Integer
ParsedHeaderField Property (CloudStorage_Linode Class)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Object Oriented Interface
public function getParsedHeaderField($parsedheaderindex);
Procedural Interface
cloudstorage_linode_get($res, 45 , $parsedheaderindex);
Default Value
''
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
ParsedHeaderValue Property (CloudStorage_Linode Class)
This property contains the header contents.
Object Oriented Interface
public function getParsedHeaderValue($parsedheaderindex);
Procedural Interface
cloudstorage_linode_get($res, 46 , $parsedheaderindex);
Default Value
''
Remarks
This property contains the Header contents.
The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
PartMarker Property (CloudStorage_Linode Class)
A marker indicating what page of parts to return next.
Object Oriented Interface
public function getPartMarker(); public function setPartMarker($value);
Procedural Interface
cloudstorage_linode_get($res, 47 ); cloudstorage_linode_set($res, 47, $value );
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.
Data Type
String
PartsCount Property (CloudStorage_Linode Class)
The number of records in the Parts arrays.
Object Oriented Interface
public function getPartsCount();
Procedural Interface
cloudstorage_linode_get($res, 48 );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at PartsCount - 1.This property is read-only and not available at design time.
Data Type
Integer
PartsETag Property (CloudStorage_Linode Class)
This property contains the ETag of the part.
Object Oriented Interface
public function getPartsETag($partsindex);
Procedural Interface
cloudstorage_linode_get($res, 49 , $partsindex);
Default Value
''
Remarks
This property contains the ETag of the part.
This property reflects the ETag of the part.
The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.
This property is read-only and not available at design time.
Data Type
String
PartsLastModified Property (CloudStorage_Linode Class)
This property contains the last modified time of the part.
Object Oriented Interface
public function getPartsLastModified($partsindex);
Procedural Interface
cloudstorage_linode_get($res, 50 , $partsindex);
Default Value
''
Remarks
This property contains the last modified time of the part.
This property reflects the last modified time of the part.
The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.
This property is read-only and not available at design time.
Data Type
String
PartsObjectName Property (CloudStorage_Linode Class)
This property contains the name (key) of the object that the part was uploaded for.
Object Oriented Interface
public function getPartsObjectName($partsindex);
Procedural Interface
cloudstorage_linode_get($res, 51 , $partsindex);
Default Value
''
Remarks
This property contains the name (key) of the object that the part was uploaded for.
This property reflects the name (key) of the object that the part was uploaded for.
The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.
This property is read-only and not available at design time.
Data Type
String
PartsOwnerDisplayName Property (CloudStorage_Linode Class)
This property contains the display name of the part's owner.
Object Oriented Interface
public function getPartsOwnerDisplayName($partsindex);
Procedural Interface
cloudstorage_linode_get($res, 52 , $partsindex);
Default Value
''
Remarks
This property contains the display name of the part's owner.
This property reflects the display name of the part's owner.
The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.
This property is read-only and not available at design time.
Data Type
String
PartsOwnerId Property (CloudStorage_Linode Class)
This property contains the Id of the part's owner.
Object Oriented Interface
public function getPartsOwnerId($partsindex);
Procedural Interface
cloudstorage_linode_get($res, 53 , $partsindex);
Default Value
''
Remarks
This property contains the Id of the part's owner.
This property reflects the Id of the part's owner.
The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.
This property is read-only and not available at design time.
Data Type
String
PartsNumber Property (CloudStorage_Linode Class)
This property contains the number of the part.
Object Oriented Interface
public function getPartsNumber($partsindex);
Procedural Interface
cloudstorage_linode_get($res, 54 , $partsindex);
Default Value
0
Remarks
This property contains the number of the part.
This property reflects the number of the part.
The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.
This property is read-only and not available at design time.
Data Type
Integer
PartsSize Property (CloudStorage_Linode Class)
This property contains the size of the part.
Object Oriented Interface
public function getPartsSize($partsindex);
Procedural Interface
cloudstorage_linode_get($res, 55 , $partsindex);
Default Value
0
Remarks
This property contains the size of the part.
This property reflects the size of the part in bytes.
The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.
This property is read-only and not available at design time.
Data Type
Long64
ProxyAuthScheme Property (CloudStorage_Linode Class)
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Object Oriented Interface
public function getProxyAuthScheme(); public function setProxyAuthScheme($value);
Procedural Interface
cloudstorage_linode_get($res, 56 ); cloudstorage_linode_set($res, 56, $value );
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (CloudStorage_Linode Class)
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Object Oriented Interface
public function getProxyAutoDetect(); public function setProxyAutoDetect($value);
Procedural Interface
cloudstorage_linode_get($res, 57 ); cloudstorage_linode_set($res, 57, $value );
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Data Type
Boolean
ProxyPassword Property (CloudStorage_Linode Class)
This property contains a password if authentication is to be used for the proxy.
Object Oriented Interface
public function getProxyPassword(); public function setProxyPassword($value);
Procedural Interface
cloudstorage_linode_get($res, 58 ); cloudstorage_linode_set($res, 58, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (CloudStorage_Linode Class)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Object Oriented Interface
public function getProxyPort(); public function setProxyPort($value);
Procedural Interface
cloudstorage_linode_get($res, 59 ); cloudstorage_linode_set($res, 59, $value );
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (CloudStorage_Linode Class)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Object Oriented Interface
public function getProxyServer(); public function setProxyServer($value);
Procedural Interface
cloudstorage_linode_get($res, 60 ); cloudstorage_linode_set($res, 60, $value );
Default Value
''
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (CloudStorage_Linode Class)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Object Oriented Interface
public function getProxySSL(); public function setProxySSL($value);
Procedural Interface
cloudstorage_linode_get($res, 61 ); cloudstorage_linode_set($res, 61, $value );
Default Value
0
Remarks
This property 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 class will use the psTunnel option. If the URL is an http URL, the class 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. |
Data Type
Integer
ProxyUser Property (CloudStorage_Linode Class)
This property contains a username if authentication is to be used for the proxy.
Object Oriented Interface
public function getProxyUser(); public function setProxyUser($value);
Procedural Interface
cloudstorage_linode_get($res, 62 ); cloudstorage_linode_set($res, 62, $value );
Default Value
''
Remarks
This property contains a username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
QueryParamCount Property (CloudStorage_Linode Class)
The number of records in the QueryParam arrays.
Object Oriented Interface
public function getQueryParamCount(); public function setQueryParamCount($value);
Procedural Interface
cloudstorage_linode_get($res, 63 ); cloudstorage_linode_set($res, 63, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at QueryParamCount - 1.This property is not available at design time.
Data Type
Integer
QueryParamName Property (CloudStorage_Linode Class)
The name of the query parameter.
Object Oriented Interface
public function getQueryParamName($queryparamindex); public function setQueryParamName($queryparamindex, $value);
Procedural Interface
cloudstorage_linode_get($res, 64 , $queryparamindex); cloudstorage_linode_set($res, 64, $value , $queryparamindex);
Default Value
''
Remarks
The name of the query parameter.
This property specifies the name of the query parameter.
The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.
This property is not available at design time.
Data Type
String
QueryParamValue Property (CloudStorage_Linode Class)
The value of the query parameter.
Object Oriented Interface
public function getQueryParamValue($queryparamindex); public function setQueryParamValue($queryparamindex, $value);
Procedural Interface
cloudstorage_linode_get($res, 65 , $queryparamindex); cloudstorage_linode_set($res, 65, $value , $queryparamindex);
Default Value
''
Remarks
The value of the query parameter.
This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.
The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.
This property is not available at design time.
Data Type
String
Range Property (CloudStorage_Linode Class)
The range of bytes to request.
Object Oriented Interface
public function getRange(); public function setRange($value);
Procedural Interface
cloudstorage_linode_get($res, 66 ); cloudstorage_linode_set($res, 66, $value );
Default Value
''
Remarks
This property specifies the range of bytes to request from the server. If this property is non-empty when a GetObject 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 GetObject is called (i.e., when a download is being resumed), and this property is non-empty, the class 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.
Data Type
String
Region Property (CloudStorage_Linode Class)
The region the class will make requests against.
Object Oriented Interface
public function getRegion(); public function setRegion($value);
Procedural Interface
cloudstorage_linode_get($res, 67 ); cloudstorage_linode_set($res, 67, $value );
Default Value
'us-east-1'
Remarks
This property control which region the class will make requests against. By default the class uses us-east-1. This property should be changed to create or access resources in other regions.
Regions:
Value | Region |
us-east-1 (default) | US East (Newark) |
eu-central-1 | EU Central (Frankfurt) |
Important: Each "region" supported by Linode's Object Storage service is actually a completely standalone storage cluster. These clusters do not interact with each other in any way, which causes the following non-standard behaviors:
- Bucket names may be reused in each region (however, they must still be "globally" unique within each region).
- The ListBuckets method will only return buckets located in the currently-selected region; there is no way to retrieve a list of all regions' buckets.
- Similarly, the BucketExists and GetBucketLocation methods only consider buckets located in the currently-selected region.
- The CopyObject method cannot be used to copy objects to a bucket in another region.
The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value.
Data Type
String
SecretKey Property (CloudStorage_Linode Class)
The secret key to use for authentication.
Object Oriented Interface
public function getSecretKey(); public function setSecretKey($value);
Procedural Interface
cloudstorage_linode_get($res, 68 ); cloudstorage_linode_set($res, 68, $value );
Default Value
''
Remarks
This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations which connect to the server.
Data Type
String
SSLAcceptServerCertEffectiveDate Property (CloudStorage_Linode Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLAcceptServerCertEffectiveDate();
Procedural Interface
cloudstorage_linode_get($res, 69 );
Default Value
''
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertExpirationDate Property (CloudStorage_Linode Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLAcceptServerCertExpirationDate();
Procedural Interface
cloudstorage_linode_get($res, 70 );
Default Value
''
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertExtendedKeyUsage Property (CloudStorage_Linode Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLAcceptServerCertExtendedKeyUsage();
Procedural Interface
cloudstorage_linode_get($res, 71 );
Default Value
''
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprint Property (CloudStorage_Linode Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprint();
Procedural Interface
cloudstorage_linode_get($res, 72 );
Default Value
''
Remarks
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
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA1 Property (CloudStorage_Linode Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprintSHA1();
Procedural Interface
cloudstorage_linode_get($res, 73 );
Default Value
''
Remarks
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
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA256 Property (CloudStorage_Linode Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprintSHA256();
Procedural Interface
cloudstorage_linode_get($res, 74 );
Default Value
''
Remarks
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
This property is read-only.
Data Type
String
SSLAcceptServerCertIssuer Property (CloudStorage_Linode Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertIssuer();
Procedural Interface
cloudstorage_linode_get($res, 75 );
Default Value
''
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKey Property (CloudStorage_Linode Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKey();
Procedural Interface
cloudstorage_linode_get($res, 76 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (CloudStorage_Linode Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKeyAvailable();
Procedural Interface
cloudstorage_linode_get($res, 77 );
Default Value
false
Remarks
This property shows whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (CloudStorage_Linode Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKeyContainer();
Procedural Interface
cloudstorage_linode_get($res, 78 );
Default Value
''
Remarks
This is the name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (CloudStorage_Linode Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertPublicKey();
Procedural Interface
cloudstorage_linode_get($res, 79 );
Default Value
''
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyAlgorithm Property (CloudStorage_Linode Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLAcceptServerCertPublicKeyAlgorithm();
Procedural Interface
cloudstorage_linode_get($res, 80 );
Default Value
''
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyLength Property (CloudStorage_Linode Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLAcceptServerCertPublicKeyLength();
Procedural Interface
cloudstorage_linode_get($res, 81 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertSerialNumber Property (CloudStorage_Linode Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLAcceptServerCertSerialNumber();
Procedural Interface
cloudstorage_linode_get($res, 82 );
Default Value
''
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertSignatureAlgorithm Property (CloudStorage_Linode Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLAcceptServerCertSignatureAlgorithm();
Procedural Interface
cloudstorage_linode_get($res, 83 );
Default Value
''
Remarks
The property 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.
This property is read-only.
Data Type
String
SSLAcceptServerCertStore Property (CloudStorage_Linode Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLAcceptServerCertStore(); public function setSSLAcceptServerCertStore($value);
Procedural Interface
cloudstorage_linode_get($res, 84 ); cloudstorage_linode_set($res, 84, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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).
Data Type
Binary String
SSLAcceptServerCertStorePassword Property (CloudStorage_Linode Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLAcceptServerCertStorePassword(); public function setSSLAcceptServerCertStorePassword($value);
Procedural Interface
cloudstorage_linode_get($res, 85 ); cloudstorage_linode_set($res, 85, $value );
Default Value
''
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLAcceptServerCertStoreType Property (CloudStorage_Linode Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLAcceptServerCertStoreType(); public function setSSLAcceptServerCertStoreType($value);
Procedural Interface
cloudstorage_linode_get($res, 86 ); cloudstorage_linode_set($res, 86, $value );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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 class. 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 SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword 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. |
Data Type
Integer
SSLAcceptServerCertSubjectAltNames Property (CloudStorage_Linode Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertSubjectAltNames();
Procedural Interface
cloudstorage_linode_get($res, 87 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (CloudStorage_Linode Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintMD5();
Procedural Interface
cloudstorage_linode_get($res, 88 );
Default Value
''
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA1 Property (CloudStorage_Linode Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintSHA1();
Procedural Interface
cloudstorage_linode_get($res, 89 );
Default Value
''
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA256 Property (CloudStorage_Linode Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintSHA256();
Procedural Interface
cloudstorage_linode_get($res, 90 );
Default Value
''
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsage Property (CloudStorage_Linode Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLAcceptServerCertUsage();
Procedural Interface
cloudstorage_linode_get($res, 91 );
Default Value
''
Remarks
This property contains the text description of SSLAcceptServerCertUsageFlags.
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsageFlags Property (CloudStorage_Linode Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertUsageFlags();
Procedural Interface
cloudstorage_linode_get($res, 92 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags 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 SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (CloudStorage_Linode Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLAcceptServerCertVersion();
Procedural Interface
cloudstorage_linode_get($res, 93 );
Default Value
''
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLAcceptServerCertSubject Property (CloudStorage_Linode Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLAcceptServerCertSubject(); public function setSSLAcceptServerCertSubject($value);
Procedural Interface
cloudstorage_linode_get($res, 94 ); cloudstorage_linode_set($res, 94, $value );
Default Value
''
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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.
Data Type
String
SSLAcceptServerCertEncoded Property (CloudStorage_Linode Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLAcceptServerCertEncoded(); public function setSSLAcceptServerCertEncoded($value);
Procedural Interface
cloudstorage_linode_get($res, 95 ); cloudstorage_linode_set($res, 95, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEffectiveDate Property (CloudStorage_Linode Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLCertEffectiveDate();
Procedural Interface
cloudstorage_linode_get($res, 96 );
Default Value
''
Remarks
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.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (CloudStorage_Linode Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLCertExpirationDate();
Procedural Interface
cloudstorage_linode_get($res, 97 );
Default Value
''
Remarks
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.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (CloudStorage_Linode Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLCertExtendedKeyUsage();
Procedural Interface
cloudstorage_linode_get($res, 98 );
Default Value
''
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLCertFingerprint Property (CloudStorage_Linode Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprint();
Procedural Interface
cloudstorage_linode_get($res, 99 );
Default Value
''
Remarks
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
This property is read-only.
Data Type
String
SSLCertFingerprintSHA1 Property (CloudStorage_Linode Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprintSHA1();
Procedural Interface
cloudstorage_linode_get($res, 100 );
Default Value
''
Remarks
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
This property is read-only.
Data Type
String
SSLCertFingerprintSHA256 Property (CloudStorage_Linode Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprintSHA256();
Procedural Interface
cloudstorage_linode_get($res, 101 );
Default Value
''
Remarks
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
This property is read-only.
Data Type
String
SSLCertIssuer Property (CloudStorage_Linode Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLCertIssuer();
Procedural Interface
cloudstorage_linode_get($res, 102 );
Default Value
''
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLCertPrivateKey Property (CloudStorage_Linode Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLCertPrivateKey();
Procedural Interface
cloudstorage_linode_get($res, 103 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (CloudStorage_Linode Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLCertPrivateKeyAvailable();
Procedural Interface
cloudstorage_linode_get($res, 104 );
Default Value
false
Remarks
This property shows whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (CloudStorage_Linode Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLCertPrivateKeyContainer();
Procedural Interface
cloudstorage_linode_get($res, 105 );
Default Value
''
Remarks
This is the name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (CloudStorage_Linode Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLCertPublicKey();
Procedural Interface
cloudstorage_linode_get($res, 106 );
Default Value
''
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (CloudStorage_Linode Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLCertPublicKeyAlgorithm();
Procedural Interface
cloudstorage_linode_get($res, 107 );
Default Value
''
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLCertPublicKeyLength Property (CloudStorage_Linode Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLCertPublicKeyLength();
Procedural Interface
cloudstorage_linode_get($res, 108 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (CloudStorage_Linode Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLCertSerialNumber();
Procedural Interface
cloudstorage_linode_get($res, 109 );
Default Value
''
Remarks
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.
This property is read-only.
Data Type
String
SSLCertSignatureAlgorithm Property (CloudStorage_Linode Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLCertSignatureAlgorithm();
Procedural Interface
cloudstorage_linode_get($res, 110 );
Default Value
''
Remarks
The property 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.
This property is read-only.
Data Type
String
SSLCertStore Property (CloudStorage_Linode Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLCertStore(); public function setSSLCertStore($value);
Procedural Interface
cloudstorage_linode_get($res, 111 ); cloudstorage_linode_set($res, 111, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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).
Data Type
Binary String
SSLCertStorePassword Property (CloudStorage_Linode Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLCertStorePassword(); public function setSSLCertStorePassword($value);
Procedural Interface
cloudstorage_linode_get($res, 112 ); cloudstorage_linode_set($res, 112, $value );
Default Value
''
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (CloudStorage_Linode Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLCertStoreType(); public function setSSLCertStoreType($value);
Procedural Interface
cloudstorage_linode_get($res, 113 ); cloudstorage_linode_set($res, 113, $value );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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 class. 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 SSLCertStore and set SSLCertStorePassword 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. |
Data Type
Integer
SSLCertSubjectAltNames Property (CloudStorage_Linode Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLCertSubjectAltNames();
Procedural Interface
cloudstorage_linode_get($res, 114 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (CloudStorage_Linode Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintMD5();
Procedural Interface
cloudstorage_linode_get($res, 115 );
Default Value
''
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA1 Property (CloudStorage_Linode Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintSHA1();
Procedural Interface
cloudstorage_linode_get($res, 116 );
Default Value
''
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA256 Property (CloudStorage_Linode Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintSHA256();
Procedural Interface
cloudstorage_linode_get($res, 117 );
Default Value
''
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLCertUsage Property (CloudStorage_Linode Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLCertUsage();
Procedural Interface
cloudstorage_linode_get($res, 118 );
Default Value
''
Remarks
This property contains the text description of SSLCertUsageFlags.
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.
This property is read-only.
Data Type
String
SSLCertUsageFlags Property (CloudStorage_Linode Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLCertUsageFlags();
Procedural Interface
cloudstorage_linode_get($res, 119 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLCertUsageFlags 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 SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (CloudStorage_Linode Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLCertVersion();
Procedural Interface
cloudstorage_linode_get($res, 120 );
Default Value
''
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (CloudStorage_Linode Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLCertSubject(); public function setSSLCertSubject($value);
Procedural Interface
cloudstorage_linode_get($res, 121 ); cloudstorage_linode_set($res, 121, $value );
Default Value
''
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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.
Data Type
String
SSLCertEncoded Property (CloudStorage_Linode Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLCertEncoded(); public function setSSLCertEncoded($value);
Procedural Interface
cloudstorage_linode_get($res, 122 ); cloudstorage_linode_set($res, 122, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLProvider Property (CloudStorage_Linode Class)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Object Oriented Interface
public function getSSLProvider(); public function setSSLProvider($value);
Procedural Interface
cloudstorage_linode_get($res, 123 ); cloudstorage_linode_set($res, 123, $value );
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
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 class will select a provider depending on the current platform.
When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
Data Type
Integer
SSLServerCertEffectiveDate Property (CloudStorage_Linode Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLServerCertEffectiveDate();
Procedural Interface
cloudstorage_linode_get($res, 124 );
Default Value
''
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertExpirationDate Property (CloudStorage_Linode Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLServerCertExpirationDate();
Procedural Interface
cloudstorage_linode_get($res, 125 );
Default Value
''
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertExtendedKeyUsage Property (CloudStorage_Linode Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLServerCertExtendedKeyUsage();
Procedural Interface
cloudstorage_linode_get($res, 126 );
Default Value
''
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLServerCertFingerprint Property (CloudStorage_Linode Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprint();
Procedural Interface
cloudstorage_linode_get($res, 127 );
Default Value
''
Remarks
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
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA1 Property (CloudStorage_Linode Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprintSHA1();
Procedural Interface
cloudstorage_linode_get($res, 128 );
Default Value
''
Remarks
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
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA256 Property (CloudStorage_Linode Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprintSHA256();
Procedural Interface
cloudstorage_linode_get($res, 129 );
Default Value
''
Remarks
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
This property is read-only.
Data Type
String
SSLServerCertIssuer Property (CloudStorage_Linode Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLServerCertIssuer();
Procedural Interface
cloudstorage_linode_get($res, 130 );
Default Value
''
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLServerCertPrivateKey Property (CloudStorage_Linode Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLServerCertPrivateKey();
Procedural Interface
cloudstorage_linode_get($res, 131 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLServerCertPrivateKeyAvailable Property (CloudStorage_Linode Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLServerCertPrivateKeyAvailable();
Procedural Interface
cloudstorage_linode_get($res, 132 );
Default Value
false
Remarks
This property shows whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLServerCertPrivateKeyContainer Property (CloudStorage_Linode Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLServerCertPrivateKeyContainer();
Procedural Interface
cloudstorage_linode_get($res, 133 );
Default Value
''
Remarks
This is the name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLServerCertPublicKey Property (CloudStorage_Linode Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLServerCertPublicKey();
Procedural Interface
cloudstorage_linode_get($res, 134 );
Default Value
''
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyAlgorithm Property (CloudStorage_Linode Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLServerCertPublicKeyAlgorithm();
Procedural Interface
cloudstorage_linode_get($res, 135 );
Default Value
''
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyLength Property (CloudStorage_Linode Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLServerCertPublicKeyLength();
Procedural Interface
cloudstorage_linode_get($res, 136 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLServerCertSerialNumber Property (CloudStorage_Linode Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLServerCertSerialNumber();
Procedural Interface
cloudstorage_linode_get($res, 137 );
Default Value
''
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertSignatureAlgorithm Property (CloudStorage_Linode Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLServerCertSignatureAlgorithm();
Procedural Interface
cloudstorage_linode_get($res, 138 );
Default Value
''
Remarks
The property 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.
This property is read-only.
Data Type
String
SSLServerCertStore Property (CloudStorage_Linode Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLServerCertStore();
Procedural Interface
cloudstorage_linode_get($res, 139 );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password protected, specify the password in SSLServerCertStorePassword.
SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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).
This property is read-only.
Data Type
Binary String
SSLServerCertStorePassword Property (CloudStorage_Linode Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLServerCertStorePassword();
Procedural Interface
cloudstorage_linode_get($res, 140 );
Default Value
''
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
This property is read-only.
Data Type
String
SSLServerCertStoreType Property (CloudStorage_Linode Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLServerCertStoreType();
Procedural Interface
cloudstorage_linode_get($res, 141 );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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 class. 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 SSLServerCertStore and set SSLServerCertStorePassword 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. |
This property is read-only.
Data Type
Integer
SSLServerCertSubjectAltNames Property (CloudStorage_Linode Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLServerCertSubjectAltNames();
Procedural Interface
cloudstorage_linode_get($res, 142 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (CloudStorage_Linode Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintMD5();
Procedural Interface
cloudstorage_linode_get($res, 143 );
Default Value
''
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA1 Property (CloudStorage_Linode Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintSHA1();
Procedural Interface
cloudstorage_linode_get($res, 144 );
Default Value
''
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA256 Property (CloudStorage_Linode Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintSHA256();
Procedural Interface
cloudstorage_linode_get($res, 145 );
Default Value
''
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLServerCertUsage Property (CloudStorage_Linode Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLServerCertUsage();
Procedural Interface
cloudstorage_linode_get($res, 146 );
Default Value
''
Remarks
This property contains the text description of SSLServerCertUsageFlags.
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.
This property is read-only.
Data Type
String
SSLServerCertUsageFlags Property (CloudStorage_Linode Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLServerCertUsageFlags();
Procedural Interface
cloudstorage_linode_get($res, 147 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLServerCertUsageFlags 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 SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLServerCertVersion Property (CloudStorage_Linode Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLServerCertVersion();
Procedural Interface
cloudstorage_linode_get($res, 148 );
Default Value
''
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLServerCertSubject Property (CloudStorage_Linode Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLServerCertSubject();
Procedural Interface
cloudstorage_linode_get($res, 149 );
Default Value
''
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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.
This property is read-only.
Data Type
String
SSLServerCertEncoded Property (CloudStorage_Linode Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLServerCertEncoded();
Procedural Interface
cloudstorage_linode_get($res, 150 );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
StartByte Property (CloudStorage_Linode Class)
The byte offset from which to resume the upload or download.
Object Oriented Interface
public function getStartByte(); public function setStartByte($value);
Procedural Interface
cloudstorage_linode_get($res, 151 ); cloudstorage_linode_set($res, 151, $value );
Default Value
0
Remarks
This property specifies the byte offset from which to resume an automatic multipart upload initiated by CreateObject, or a download initiated by GetObject. Refer to those methods' documentation for more information about resuming uploads and downloads.
This property is not available at design time.
Data Type
Long64
Timeout Property (CloudStorage_Linode Class)
This property includes the timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
cloudstorage_linode_get($res, 152 ); cloudstorage_linode_set($res, 152, $value );
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 class will wait for the operation to complete before returning control.
The class 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 class fails with an error.
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.
Data Type
Integer
UseVirtualHosting Property (CloudStorage_Linode Class)
Determines which style request to use.
Object Oriented Interface
public function getUseVirtualHosting(); public function setUseVirtualHosting($value);
Procedural Interface
cloudstorage_linode_get($res, 153 ); cloudstorage_linode_set($res, 153, $value );
Default Value
true
Remarks
If set to true (default), buckets will be referenced in the request using the hosted-style request: http://yourbucket.us-east-1.linodeobjects.com/yourobject. If false, the class will use the path-style request: http://us-east-1.linodeobjects.com/yourbucket/yourobject.
Note: When set to true, there are more limitations when choosing a bucket name due to DNS server naming restrictions.
This property is not available at design time.
Data Type
Boolean
VersionId Property (CloudStorage_Linode Class)
The object version to make requests against.
Object Oriented Interface
public function getVersionId(); public function setVersionId($value);
Procedural Interface
cloudstorage_linode_get($res, 154 ); cloudstorage_linode_set($res, 154, $value );
Default Value
''
Remarks
This property can be set to the Id of a specific object version before calling the following methods in order to make requests against the specified object version instead of the base object; refer to each one's documentation for more information:
- CopyObject (to copy from a specific object version)
- DeleteObject
- GetLink (to build a link for a specific object version)
- GetObject
- GetObjectInfo
- SendCustomRequest
- UpdateObjectACL
Refer to Amazon's Versioning documentation for more information about versioning.
This property is not available at design time.
Data Type
String
VersionMarker Property (CloudStorage_Linode Class)
A marker indicating what page of object versions to return next.
Object Oriented Interface
public function getVersionMarker(); public function setVersionMarker($value);
Procedural Interface
cloudstorage_linode_get($res, 155 ); cloudstorage_linode_set($res, 155, $value );
Default Value
''
Remarks
This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all object versions, continue to call ListVersions until this property returns empty string.
Refer to ListVersions for more information.
This property is not available at design time.
Data Type
String
AbortMultipartUpload Method (CloudStorage_Linode Class)
Aborts a multipart upload.
Object Oriented Interface
public function doAbortMultipartUpload($objectname, $uploadid);
Procedural Interface
cloudstorage_linode_do_abortmultipartupload($res, $objectname, $uploadid);
Remarks
This method aborts the multipart upload of the object named ObjectName specified by UploadId.
When this method is called, all parts that have been uploaded for the multipart upload are deleted from the server. (Note that if any part uploads are currently in progress, it may be necessary to call this method again after they complete.)
If this method is called successfully, the specified UploadId will no longer be valid.
AddMetadata Method (CloudStorage_Linode Class)
Adds a metadata item to the Metadata properties.
Object Oriented Interface
public function doAddMetadata($name, $value);
Procedural Interface
cloudstorage_linode_do_addmetadata($res, $name, $value);
Remarks
This method adds a metadata item to the Metadata properties. Name specifies the name of the item, and Value specifies the value of the item. Keep in mind that the server stores metadata names in lowercase.
If Name begins with a service-specific metadata (e.g., x-amz-meta-, x-goog-meta-, etc.), it will be stripped off. The class will take care of prepending it when sending metadata to the server.
AddQueryParam Method (CloudStorage_Linode Class)
Adds a query parameter to the QueryParams properties.
Object Oriented Interface
public function doAddQueryParam($name, $value);
Procedural Interface
cloudstorage_linode_do_addqueryparam($res, $name, $value);
Remarks
This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.
All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.
BucketExists Method (CloudStorage_Linode Class)
Checks whether the bucket exists.
Object Oriented Interface
public function doBucketExists();
Procedural Interface
cloudstorage_linode_do_bucketexists($res);
Remarks
This method checks whether the bucket specified by Bucket exists, returning true if so or false if not.
Note: This method only considers buckets located in the currently-selected Region. Refer to the Region property's documentation for more information.
CheckVersioningEnabled Method (CloudStorage_Linode Class)
Checks whether versioning is enabled for the currently selected bucket.
Object Oriented Interface
public function doCheckVersioningEnabled();
Procedural Interface
cloudstorage_linode_do_checkversioningenabled($res);
Remarks
This method can be used to check whether the bucket currently selected by Bucket has versioning enabled.
Note that if Bucket is empty, or refers to a bucket that does not exist, this method will always return false when queried.
Refer to Amazon's Versioning documentation for more information about versioning.
CompleteMultipartUpload Method (CloudStorage_Linode Class)
Completes a multipart upload by assembling previously uploaded parts.
Object Oriented Interface
public function doCompleteMultipartUpload($objectname, $uploadid);
Procedural Interface
cloudstorage_linode_do_completemultipartupload($res, $objectname, $uploadid);
Remarks
This method completes the multipart upload specified by UploadId. The server will assemble all of the parts that have been uploaded into an object named ObjectName.
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 properties, nor does it cause the PartList event to fire.
Config Method (CloudStorage_Linode Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
cloudstorage_linode_do_config($res, $configurationstring);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.
CopyObject Method (CloudStorage_Linode Class)
Copies an object.
Object Oriented Interface
public function doCopyObject($srcobjectname, $destbucket, $destobjectname);
Procedural Interface
cloudstorage_linode_do_copyobject($res, $srcobjectname, $destbucket, $destobjectname);
Remarks
This method copies the object specified by SrcObjectName (in the bucket currently selected by Bucket) to the object specified by DestObjectName in DestBucket. If DestBucket is empty, the bucket specified by Bucket is used as the destination bucket.
If the VersionId property is non-empty, the specified version of the source object will be used as the copy source. In this case, DestObjectName may be the same as SrcObjectName to "promote" the version, copying its contents back to the base object.
If there are any metadata items present in the Metadata properties, they will set on the destination object; otherwise, the server will copy any metadata items present on the source object to the destination object.
Notes:
- Objects may only be copied to buckets that exist within the same region.
- Objects larger than 5GB cannot be copied using this method. To copy such objects, start a new multipart upload for the destination object using StartMultipartUpload, and then use the CopyPart method to create parts for said multipart upload using the source object's data.
CopyPart Method (CloudStorage_Linode Class)
Copies the specified object as a part of a multipart upload.
Object Oriented Interface
public function doCopyPart($srcobjectname, $destbucket, $destobjectname, $destpartnumber, $destuploadid);
Procedural Interface
cloudstorage_linode_do_copypart($res, $srcobjectname, $destbucket, $destobjectname, $destpartnumber, $destuploadid);
Remarks
This method copies data from the object specified by SrcObjectName (in the bucket currently selected by Bucket) to a new multipart upload part for DestObjectName in DestBucket.
The DestPartNumber and DestUploadId parameters should be used in the same manner as the UploadPart method's PartNumber and UploadId parameters.
To copy a specific range of bytes from the source object, set the CopyPartRange configuration setting before calling this method.
CreateBucket Method (CloudStorage_Linode Class)
Creates a new bucket.
Object Oriented Interface
public function doCreateBucket();
Procedural Interface
cloudstorage_linode_do_createbucket($res);
Remarks
This method creates a new bucket using the name specified by the Bucket property. The bucket is created in the region specified by the Region property.
CreateObject Method (CloudStorage_Linode Class)
Creates a new object in the currently selected bucket.
Object Oriented Interface
public function doCreateObject($objectname);
Procedural Interface
cloudstorage_linode_do_createobject($res, $objectname);
Remarks
This method creates a new object named Object in the bucket currently selected by Bucket. If there are any metadata items present in the Metadata properties, they will included in the creation request.
If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ObjectData will be used.
To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.
This method can automatically handle the multipart upload of objects (See Below). If it is desired to manually take control of the multipart upload process see StartMultipartUpload.
Automatic Multipart Uploads
If more than SimpleUploadLimit bytes of data are provided, the class 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 class 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.
DeleteBucket Method (CloudStorage_Linode Class)
Deletes a bucket.
Object Oriented Interface
public function doDeleteBucket();
Procedural Interface
cloudstorage_linode_do_deletebucket($res);
Remarks
This method deletes the bucket currently selected by Bucket. Note that bucket names share a global namespace, and it may not be possible to recreate a deleted bucket if its name has been taken by another user in the meantime.
DeleteObject Method (CloudStorage_Linode Class)
Deletes an object.
Object Oriented Interface
public function doDeleteObject($objectname);
Procedural Interface
cloudstorage_linode_do_deleteobject($res, $objectname);
Remarks
This method deletes the object specified by ObjectName in the bucket currently selected by Bucket.
If the VersionId property is non-empty, this method deletes the specified version of the object instead.
Deleting Versioned Objects
If a bucket has versioning enabled (i.e., CheckVersioningEnabled returns true when queried), and this method is called on an object rather than a specific object version, then instead of actually deleting any data, the server will simply create a special object version called a delete marker.If an object's latest version is a delete marker, then the server treats the object as if it didn't exist (i.e., it doesn't appear when listing objects, cannot be downloaded, etc.). However, all of the previous versions of the object (including one that existed just before the delete marker was created) still exist; they can be listed using ListVersions, and explicitly interacted with by setting VersionId and calling an appropriate method.
To permanently delete objects in a versioning-enabled bucket, each version of the object must be explicitly deleted by setting VersionId before calling this method. This includes any delete marker versions, which can be deleted like any other version.
Refer to Amazon's Deleting Object Versions, Working with Delete Markers, and Removing Delete Markers articles for more information.
DisableVersioning Method (CloudStorage_Linode Class)
Disables versioning for the currently selected bucket.
Object Oriented Interface
public function doDisableVersioning();
Procedural Interface
cloudstorage_linode_do_disableversioning($res);
Remarks
This method can be used to disable versioning for the bucket currently selected by Bucket.
Refer to Amazon's Versioning documentation for more information about versioning.
DoEvents Method (CloudStorage_Linode Class)
This method processes events from the internal message queue.
Object Oriented Interface
public function doEvents();
Procedural Interface
cloudstorage_linode_do_doevents($res);
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
EnableVersioning Method (CloudStorage_Linode Class)
Enables versioning for the currently selected bucket.
Object Oriented Interface
public function doEnableVersioning();
Procedural Interface
cloudstorage_linode_do_enableversioning($res);
Remarks
This method can be used to enable versioning for the bucket currently selected by Bucket.
Refer to Amazon's Versioning documentation for more information about versioning.
GetBucketLocation Method (CloudStorage_Linode Class)
Gets a bucket's location.
Object Oriented Interface
public function doGetBucketLocation();
Procedural Interface
cloudstorage_linode_do_getbucketlocation($res);
Remarks
This method retrieves and returns the location (i.e., region) of the bucket currently selected by Bucket.
Note: This method only considers buckets located in the currently-selected Region. Refer to the Region property's documentation for more information.
GetLink Method (CloudStorage_Linode Class)
Creates a link that provides access to an object for a specified amount of time.
Object Oriented Interface
public function doGetLink($objectname, $expires);
Procedural Interface
cloudstorage_linode_do_getlink($res, $objectname, $expires);
Remarks
This method creates and returns a pre-authenticated link that provides access to the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is non-empty, a link is created for the specified version of the object.
The Expires parameter specifies how many seconds the link should be valid for. The maximum validity period is seven days.
Note that this method is an offline method that simply generates a pre-signed URL; no communication with the server takes place.
GetObject Method (CloudStorage_Linode Class)
Downloads an object.
Object Oriented Interface
public function doGetObject($objectname);
Procedural Interface
cloudstorage_linode_do_getobject($res, $objectname);
Remarks
This methods downloads the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is non-empty, the specified version of the object is downloaded instead. The Range property can be used to download a specific range of bytes from the object.
If LocalFile is set, the object data will be saved to the specified location; otherwise, the object data will be held by ObjectData.
To download and decrypt an encrypted object, set EncryptionAlgorithm and EncryptionPassword before calling this method.
Download Notes
In the simplest use-case, downloading an object looks like this:
s3.LocalFile = "../MyData.zip";
s3.GetObject(s3.Objects[0].Name);
Resuming Downloads
The class 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";
s3.LocalFile = downloadFile;
s3.GetObject(s3.Objects[0].Name);
//The transfer is interrupted and GetObject() above fails. Later, resume the download:
//Get the size of the partially downloaded file
s3.StartByte = new FileInfo(downloadFile).Length;
s3.GetObject(s3.Objects[0].Name);
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 class 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.
s3.LocalFile = "../MyData.zip";
s3.EncryptionPassword = "password";
s3.GetObject(s3.Objects[0].Name);
//The transfer is interrupted and GetObject() above fails. Later, resume the download:
//Get the size of the partially downloaded temp file
s3.StartByte = new FileInfo(s3.Config("DownloadTempFile")).Length;
s3.GetObject(s3.Objects[0].Name);
GetObjectInfo Method (CloudStorage_Linode Class)
Gets an object's information and metadata.
Object Oriented Interface
public function doGetObjectInfo($objectname);
Procedural Interface
cloudstorage_linode_do_getobjectinfo($res, $objectname);
Remarks
This method gets information and metadata for the object specified by Object in the bucket currently selected by Bucket. If the VersionId property is non-empty, information and metadata for the specified version of the object is retrieved instead.
Calling this method will fire the ObjectList and MetadataList events, and will re-populate the Objects and Metadata collection properties.
Interrupt Method (CloudStorage_Linode Class)
This method interrupts the current method.
Object Oriented Interface
public function doInterrupt();
Procedural Interface
cloudstorage_linode_do_interrupt($res);
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListBuckets Method (CloudStorage_Linode Class)
Lists all buckets in the currently-selected region.
Object Oriented Interface
public function doListBuckets();
Procedural Interface
cloudstorage_linode_do_listbuckets($res);
Remarks
This method lists all buckets in the currently-selected Region. (Due to the architecture of the Linode Object Storage service, there is no way to retrieve a list of all regions' buckets; refer to the Region property for more information.)
Calling this method will fire the BucketList event once for each bucket, and will also populate the Buckets properties.
ListMultipartUploads Method (CloudStorage_Linode Class)
Lists the current multipart uploads.
Object Oriented Interface
public function doListMultipartUploads();
Procedural Interface
cloudstorage_linode_do_listmultipartuploads($res);
Remarks
This method lists the current multipart uploads in the bucket currently selected by Bucket.
Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the multipart uploads whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.
Calling this method will fire the ObjectList event once for each multipart upload, and will also populate the Objects properties.
If there are still more multipart uploads available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects properties.
ListObjects Method (CloudStorage_Linode Class)
Lists the objects in a bucket.
Object Oriented Interface
public function doListObjects();
Procedural Interface
cloudstorage_linode_do_listobjects($res);
Remarks
This method lists the objects in the bucket currently selected by Bucket.
Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the objects whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.
Calling this method will fire the ObjectList event once for each object, and will also populate the Objects properties. It may also fire the PrefixList event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.
If there are still more objects available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects properties.
Object Hierarchy Traversal
By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:
- MyCompany/
- MyCompany/Department1/
- MyCompany/Department2/
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:
ObjectPrefix Value | ObjectDelimiter Value | Objects Returned | Prefixes Returned |
(empty) | / | (none) | MyCompany/ |
MyCompany/ | / | MyCompany/ | MyCompany/Department1/
MyCompany/Department2/ |
MyCompany/Department2/ | / | MyCompany/Department2/
MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB | (none) |
ListParts Method (CloudStorage_Linode Class)
Lists the parts in a multipart upload.
Object Oriented Interface
public function doListParts($objectname, $uploadid);
Procedural Interface
cloudstorage_linode_do_listparts($res, $objectname, $uploadid);
Remarks
This method lists the parts in the multipart upload of ObjectName specified by UploadId. The MaxParts configuration setting may be used to limit the number of results returned.
Calling this method will fire the PartList event once for each part, and will also populate the Parts properties.
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 properties.
Note that this method does not need to be called before attempting to complete a multipart upload with CompleteMultipartUpload; the class will automatically collect the necessary information internally. Refer to CompleteMultipartUpload for more information.
ListVersions Method (CloudStorage_Linode Class)
Lists the object versions in a bucket.
Object Oriented Interface
public function doListVersions();
Procedural Interface
cloudstorage_linode_do_listversions($res);
Remarks
This method lists the object versions in the bucket currently selected by Bucket.
Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the object versions whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.
Calling this method will fire the ObjectList event once for each object version, and will also populate the Objects properties. It may also fire the PrefixList event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.
If there are still more object 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 Objects properties.
Object Hierarchy Traversal
By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:
- MyCompany/
- MyCompany/Department1/
- MyCompany/Department2/
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:
ObjectPrefix Value | ObjectDelimiter Value | Objects Returned | Prefixes Returned |
(empty) | / | (none) | MyCompany/ |
MyCompany/ | / | MyCompany/ | MyCompany/Department1/
MyCompany/Department2/ |
MyCompany/Department2/ | / | MyCompany/Department2/
MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB | (none) |
Reset Method (CloudStorage_Linode Class)
Resets the class to its initial state.
Object Oriented Interface
public function doReset();
Procedural Interface
cloudstorage_linode_do_reset($res);
Remarks
This method resets the class to its initial state.
ResetHeaders Method (CloudStorage_Linode Class)
Resets all HTTP headers, cookies, and LocalFile.
Object Oriented Interface
public function doResetHeaders();
Procedural Interface
cloudstorage_linode_do_resetheaders($res);
Remarks
Resets all the HTTP headers as well as LocalFile to "" (empty string), and clears the Metadata and QueryParams collection properties.
Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next one.
SendCustomRequest Method (CloudStorage_Linode Class)
Sends a custom request to the server.
Object Oriented Interface
public function doSendCustomRequest($httpmethod, $objectname, $requestbody);
Procedural Interface
cloudstorage_linode_do_sendcustomrequest($res, $httpmethod, $objectname, $requestbody);
Remarks
This method can be used to send arbitrary requests to the server.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
- PUT
- DELETE
The ObjectName and RequestBody parameters may be empty if not needed.
Usage
When this method is called, the class does the following:
- Builds a request URL, including query parameters, based on the following:
- UseSSL, Region, and UseVirtualHosting for the base URL.
- Alternatively, if a custom URL has been specified using the URL configuration setting, it is used directly, and these properties are ignored.
- Bucket (if non-empty)
- ObjectName (if non-empty)
- VersionId (if both it and ObjectName are non-empty)
- QueryParams
- UseSSL, Region, and UseVirtualHosting for the base URL.
- Adds request headers from:
- Signs the request (unless the SignCustomRequest configuration setting is disabled).
- Sends the request, including RequestBody if non-empty.
- Stores the response headers in the ParsedHeaders properties; and the response body in the specified LocalFile, or ObjectData (using the same logic as GetObject).
If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.
StartMultipartUpload Method (CloudStorage_Linode Class)
Starts a new manual multipart upload.
Object Oriented Interface
public function doStartMultipartUpload($objectname);
Procedural Interface
cloudstorage_linode_do_startmultipartupload($res, $objectname);
Remarks
This method starts a new "manual" multipart upload for an object named ObjectName, in the bucket currently selected by Bucket, and returns the upload Id that the server associates with it. For an "automatic" multipart upload see the CreateObject method. This upload Id can then be used to call the following methods:
If there are any metadata items present in the Metadata properties, they will be included in the creation request, and will be applied to the final object after the multipart upload is completed with CompleteMultipartUpload.
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.
UpdateBucketACL Method (CloudStorage_Linode Class)
Updates a bucket's canned access policy.
Object Oriented Interface
public function doUpdateBucketACL();
Procedural Interface
cloudstorage_linode_do_updatebucketacl($res);
Remarks
This method updates the canned access policy of the bucket selected by Bucket to the value specified by AccessPolicy
UpdateObjectACL Method (CloudStorage_Linode Class)
Updates an object's canned access policy.
Object Oriented Interface
public function doUpdateObjectACL($objectname);
Procedural Interface
cloudstorage_linode_do_updateobjectacl($res, $objectname);
Remarks
This method updates the caned access policy of the objects specified by ObjectName, in the bucket currently selected by Bucket, to the value specified by AccessPolicy.
If the VersionId property is non-empty, the canned access policy of the specified version of the object is updated instead.
UploadPart Method (CloudStorage_Linode Class)
Uploads a multipart upload part.
Object Oriented Interface
public function doUploadPart($objectname, $partnumber, $uploadid);
Procedural Interface
cloudstorage_linode_do_uploadpart($res, $objectname, $partnumber, $uploadid);
Remarks
This method uploads a part for the multipart upload of the object named ObjectName specified by UploadId.
PartNumber specifies the part's number; it must be a value in the range 1 to 10000, inclusive. If a part with the given number already exists in the specified multipart upload, it is replaced with the newly-uploaded part.
The data to upload is taken from either LocalFile or ObjectData (whichever data is found in first, when checked in that order). Each part must be at least 5MB in size, except for the last part in the overall multipart upload, which can be any non-zero size.
If the IncludePartMD5 configuration setting is true, the class will include an MD5 digest of its data when sending it to the server. The server will then verify that the data was received without corruption.
BucketList Event (CloudStorage_Linode Class)
Fires once for each bucket returned when listing buckets.
Object Oriented Interface
public function fireBucketList($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 1, array($this, 'fireBucketList'));
Parameter List
'bucketname'
'creationdate'
'ownerid'
'ownername'
Remarks
This event fires once for each bucket returned when ListBuckets is called.
BucketName reflects the name of the bucket.
CreationDate reflects the bucket's creation date.
OwnerId and OwnerName reflect the Id and display name of the bucket's owner, respectively.
EndTransfer Event (CloudStorage_Linode Class)
This event fires when a document finishes transferring.
Object Oriented Interface
public function fireEndTransfer($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 2, array($this, 'fireEndTransfer'));
Parameter List
'direction'
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 (CloudStorage_Linode Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 3, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
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.
FragmentComplete Event (CloudStorage_Linode Class)
Fires after each part in an automatic multipart upload is complete.
Object Oriented Interface
public function fireFragmentComplete($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 4, array($this, 'fireFragmentComplete'));
Parameter List
'fragmentnumber'
'fragmentcount'
'interrupt'
Remarks
If, when CreateObject is called, more than SimpleUploadLimit bytes of upload data are present, the class 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 CreateObject for more information.
Header Event (CloudStorage_Linode Class)
This event is fired every time a header line comes in.
Object Oriented Interface
public function fireHeader($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 5, array($this, 'fireHeader'));
Parameter List
'field'
'value'
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 (CloudStorage_Linode Class)
This event fires once for each log message.
Object Oriented Interface
public function fireLog($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 6, array($this, 'fireLog'));
Parameter List
'loglevel'
'message'
'logtype'
Remarks
This event fires once for each log message generated by the class. 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 (CloudStorage_Linode Class)
Fires once for each metadata item returned when object information and metadata is retrieved.
Object Oriented Interface
public function fireMetadataList($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 7, array($this, 'fireMetadataList'));
Parameter List
'name'
'value'
Remarks
This event fires once for each metadata item returned when GetObjectInfo is called.
Name is the name of the metadata item, without the service-specific prefix (e.g., x-amz-meta-, x-goog-meta-, etc.). Keep in mind that the server stores metadata names in lowercase.
Value is the metadata item's value.
ObjectList Event (CloudStorage_Linode Class)
Fires once for each object, object version, or multipart upload returned when listing such items.
Object Oriented Interface
public function fireObjectList($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 8, array($this, 'fireObjectList'));
Parameter List
'bucketname'
'objectname'
'lastmodified'
'size'
'etag'
'ownerid'
'ownername'
'uploadid'
'versionid'
'latestversion'
'deleted'
Remarks
This event fires once for each object, object version, or multipart upload returned when GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads is called.
BucketName reflects the name of the bucket that the object is in.
ObjectName reflects the name of the object.
LastModified reflects the last modified time of the object. Not applicable when ListMultipartUploads is called.
Size reflects the size, in bytes, of the object. Not applicable when ListMultipartUploads is called.
ETag reflects the object's ETag. Not applicable when ListMultipartUploads is called.
OwnerId and OwnerName reflect the Id and display name of the object's owner, respectively. Not applicable when GetObjectInfo is called.
UploadId reflects the Id of the multipart upload. Only applicable when ListMultipartUploads is called.
VersionId reflects the Id of the object version (note that the string null is a valid version Id). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; empty in all other cases.
LatestVersion indicates whether this is the latest object version. Only applicable when ListVersions is called; true in all other cases.
Deleted indicates whether this object version is a delete marker (refer to DeleteObject for more information). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; false in all other cases.
PartList Event (CloudStorage_Linode Class)
Fires once for every part returned when listing a multipart upload's parts.
Object Oriented Interface
public function firePartList($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 9, array($this, 'firePartList'));
Parameter List
'partnumber'
'objectname'
'lastmodified'
'size'
'etag'
'ownerid'
'ownername'
Remarks
This event fires once for each multipart upload part returned when ListParts is called.
PartNumber reflects the part's number.
ObjectName reflects the name of the object the multipart upload is for.
LastModified reflects the last modified time of the part.
Size reflects the size, in bytes, of the part.
ETag reflects the part's ETag of the part.
OwnerId and OwnerName reflect the Id and display name of the part's owner, respectively.
PrefixList Event (CloudStorage_Linode Class)
Fires once for each common prefix returned when listing objects.
Object Oriented Interface
public function firePrefixList($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 10, array($this, 'firePrefixList'));
Parameter List
'bucketname'
'prefix'
Remarks
This event fires once for each common prefix returned when ListObjects or ListVersions is called when ObjectDelimiter is non-empty. Refer to ObjectDelimiter for more information.
BucketName reflects the name of the bucket that the prefix is in.
Prefix is the common prefix.
Progress Event (CloudStorage_Linode Class)
Fires during an upload or download to indicate transfer progress.
Object Oriented Interface
public function fireProgress($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 11, array($this, 'fireProgress'));
Parameter List
'direction'
'bytestransferred'
'totalbytes'
'percentdone'
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 class 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 class 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 (CloudStorage_Linode Class)
Fired after the server presents its certificate to the client.
Object Oriented Interface
public function fireSSLServerAuthentication($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 12, array($this, 'fireSSLServerAuthentication'));
Parameter List
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'
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 (CloudStorage_Linode Class)
Fired when secure connection progress messages are available.
Object Oriented Interface
public function fireSSLStatus($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 13, array($this, 'fireSSLStatus'));
Parameter List
'message'
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (CloudStorage_Linode Class)
This event fires when a document starts transferring (after the headers).
Object Oriented Interface
public function fireStartTransfer($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 14, array($this, 'fireStartTransfer'));
Parameter List
'direction'
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 (CloudStorage_Linode Class)
This event is fired while a document transfers (delivers document).
Object Oriented Interface
public function fireTransfer($param);
Procedural Interface
cloudstorage_linode_register_callback($res, 15, array($this, 'fireTransfer'));
Parameter List
'direction'
'bytestransferred'
'percentdone'
'text'
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.
Config Settings (Linode Class)
The class 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 class, access to these internal properties is provided through the Config method.Linode Config Settings
By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.
The class supports key-based credential profiles; i.e., those which include the aws_access_key_id, aws_secret_access_key, and (optionally) aws_session_token elements. Role-based profiles are not supported at this time.
In addition to the authentication-related elements mentioned above, the class also supports the region element, if it is present in the specified profile.
The class searches for the specified profile's information in the credentials and config files. The AWSProfileDir setting can be used to configure the directory where the class looks for these files. If the aforementioned files do not exist, or the specified profile cannot be found or is missing information, an error will occur.
Note: If the profile specified using this setting includes credential information, the UseEC2RoleCredentials setting will be ignored (if it is enabled).
By default, this setting is empty, which will cause the class to check the default location used by the AWS CLI: an .aws directory in the current user's home directory; i.e., %UserProfile%\.aws (Windows) or ~/.aws (Linux/macOS).
When downloading encrypted data with LocalFile set, the class 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 accepts a hex encoded value.
This setting accepts a hex encoded value.
- 0 (default) - PBKDF1
- 1 - PBKDF2
- Bucket names can contain lowercase letters, numbers, periods, underscores, and dashes.
- Bucket names must start with a number or letter.
- Bucket names must be between 3 and 63 characters long.
- Bucket names should not end with a dash.
- Bucket names cannot contain two adjacent periods.
- Bucket names cannot contain dashes next to periods.
- Bucket names must not be formatted as an IP address (eg: 192.168.5.4).
The ETag is used to determine if the object has changed since the last operation on the file. Set the IfMatch config to the ETag to ensure a new version of the object does not already exist on the server.
Valid values are 5242880 (5MB) to 2147483647 (2GB). The default is 26214400 (25MB). Note that applications may need to increase this setting's value in order to upload very large objects; Amazon only allows 10000 parts to be uploaded for any given multipart upload.
If the amount of upload data provided when creating an object is less than SimpleUploadLimit bytes, it will be uploaded directly, so this setting will not apply.
The default value is false. Note that this setting is only applicable if the SignCustomRequest setting is true; it is ignored otherwise.
The default value is false.
The default value is false.
If this setting is -1 (default), the server's default (1000) is used. Acceptable values are 1 to 1000 (inclusive).
If this setting is -1 (default), the server's default (1000) is used. Acceptable values are 1 to 1000 (inclusive).
Valid values for i are from 0 to (PrefixCount - 1).
This setting is always -1 when StorePrefixList is disabled.
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 class 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 class will behave as if this setting were 0 for the duration of the transfer.
Refer to CreateObject for more information.
This value must be provided as a traditional Unix timestamp. A Unix timestamp is the number of seconds since the Unix Epoch (00:00:00 January 1, 1970 UTC). An example value for the timestamp would be 1236626334.
Valid values are -1 to 5368709120 (5GB), inclusive. The default is 104857600 (100MB). If this setting is set to 0, the class will always perform a multipart upload when creating an object; if it is set to -1, the class will never perform a multipart upload.
The default value for this setting is true.
By default, this setting is disabled.
In order for the class to be able to auto-obtain authentication credentials, the EC2 instance must have an "instance profile" with an appropriate IAM role attached to it. Refer to the "Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances" page in the Amazon IAM documentation for more information.
By default, this setting is false. When set to true the class will do the following before each request:
- Make a request against the EC2 instance to get the name of the role attached to it.
- Make a request against the metadata service to initiate a session. The request returns a token that must be included in subsequent requests.
- Parse the response, automatically populating the AccessKey and SecretKey properties and the SessionToken configuration setting.
- Execute the original request using the temporary security credentials that were acquired.
Note: This setting is ignored if the AWSProfile setting is set to a profile that includes credential information.
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 class 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 class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
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 class fails with an error.
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 class fails with an error 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 class 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/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).
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 class 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. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.
Note: This setting is applicable only to Mac/iOS editions.
When True (default), the class 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 classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs 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 classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs 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 class 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 class initiate connections (or accept in the case of server classs) only through that interface.
If the class 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
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.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the class 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 class is the same.
The value is formatted as a list of paths separated by semicolons. The class 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
-----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 class. 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 class 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 class 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 class 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 class 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.
When set, the class 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 class 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 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 class 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 class fails with an error.
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 class 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 class 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
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- 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 classes: 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 classes 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 class 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.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (Linode Class)
Common Errors
600 | A server error occurred, and/or the class 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 class 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. |
The class may also return one of the following error codes, which are inherited from other classes.
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 class may also return one of the following error codes, which are inherited from other classes.
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 class 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. |
302 | 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). |