# ShareFile Class The ShareFile class makes it easy to upload, download, and manage files, folders, and share links within ShareFile. ## Syntax ```text class cloudstorage.ShareFile ``` ## Remarks The ShareFile class provides a simple interface for working with ShareFile. Capabilities include uploading and downloading files, strong encryption support, creating folders, moving and copying items, creating request and send links, and more. ## Authentication This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the o_auth property to set the appropriate fields for the chosen [o_auth_client_profile](#o_auth_client_profile-property) and [o_auth_grant_type](#o_auth_grant_type-property). The class has the following default: | | | | --- | --- | | Authorization Server URL | "https://secure.sharefile.com/oauth/authorize" | For the [o_auth_server_token_url](#o_auth_server_token_url-property), the URL needs to contain the account subdomain of the account that authenticated. For example: | | | | --- | --- | | Token Server URL | "https://{ACCOUNT}.sharefile.com/oauth/token" | Below is a brief description of the different [o_auth_client_profile](#o_auth_client_profile-property) and [o_auth_grant_type](#o_auth_grant_type-property) values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation. ### Application Profile This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect. To start the authentication and authorization process, the [authorize](#authorize-method) method should be called. If the authorization and authentication was successful, then the [o_auth_access_token](#o_auth_access_token-property) property will be populated. Additionally, if a *refresh token* was provided the [o_auth_refresh_token](#o_auth_refresh_token-property) property will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the [o_auth_access_token](#o_auth_access_token-property) will be expired. When a method that makes requests to the service provider is called or the [authorize](#authorize-method) method is called the class will automatically check to see if the *access token* is expired. If it is, it will then automatically try to get a new [o_auth_access_token](#o_auth_access_token-property). If the [authorize](#authorize-method) method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the [o_auth_grant_type](#o_auth_grant_type-property) property. To force the component to only check the *access token* when the [authorize](#authorize-method) method is called, the [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) configuration setting can be set to false. A brief description of the supported values for the [o_auth_grant_type](#o_auth_grant_type-property) property are below. For more information, see the service documentation. **Authorization Code** When using the *Authorization Code* grant type, the class will use an *authorization code* to get an *access token*. For this [o_auth_grant_type](#o_auth_grant_type-property) the class expects a [o_auth_client_id](#o_auth_client_id-property), [o_auth_client_secret](#o_auth_client_secret-property), [o_auth_server_auth_url](#o_auth_server_auth_url-property), and [o_auth_server_token_url](#o_auth_server_token_url-property) to be set. When the [authorize](#authorize-method) method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the *authorization code*, setting the [o_auth_authorization_code](#o_auth_authorization_code-property) property, from the redirect. Immediately, the class will make a request to the token server to exchange the *authorization code* for an *access token*. The token server will return an *access token* and possibly a *refresh token*. If the [o_auth_refresh_token](#o_auth_refresh_token-property) property is set, or a *refresh token* is cached, then the class will not launch the browser and use the *refresh token* in its request to the token server instead of an *authorization code*. **Implicit** Note: This grant type is considered insecure and should only be used when necessary. When using the *Implicit* grant type, the class will request the authorization server to get an *access token*. For this [o_auth_grant_type](#o_auth_grant_type-property) the class expects a [o_auth_client_id](#o_auth_client_id-property), [o_auth_client_secret](#o_auth_client_secret-property), and [o_auth_server_auth_url](#o_auth_server_auth_url-property) to be set. When the [authorize](#authorize-method) method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the *access token* from the redirect. A disadvantage of the grant type is that can not use a *refresh token* to silently get a new *access token*. Most service providers offer a way to silently get a new *access token*. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires. **Password** Note: This grant type is considered insecure and should only be used when necessary. When using the *Resource Owner Password Credentials* grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details. For this [o_auth_grant_type](#o_auth_grant_type-property) the class requires [OAuthPasswordGrantUsername](#OAuthPasswordGrantUsername), [o_auth_client_secret](#o_auth_client_secret-property), and [o_auth_server_token_url](#o_auth_server_token_url-property) to be set. The [o_auth_client_secret](#o_auth_client_secret-property) should be set to the password of the account instead of a typical secret. In some cases, the [o_auth_client_id](#o_auth_client_id-property) also needs to be set. When the [authorize](#authorize-method) method is called, the component will make a request to the token server for an *access token* using the username and password. The token server will return an *access token* if the authentication was successful. When this *access token* is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one. ### Web Profile This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that [o_auth_client_id](#o_auth_client_id-property), [o_auth_client_secret](#o_auth_client_secret-property), [o_auth_server_auth_url](#o_auth_server_auth_url-property), [o_auth_server_token_url](#o_auth_server_token_url-property), and the [o_auth_return_url](#o_auth_return_url-property) properties to be set. Before calling the [authorize](#authorize-method) method, the [o_auth_web_auth_url](#o_auth_web_auth_url-property) property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The *redirect_uri* parameter of this URL is mapped to the [o_auth_return_url](#o_auth_return_url-property) property. The [o_auth_return_url](#o_auth_return_url-property) property should be set to some web server that will parse the *authorization code* out of the query parameter from the redirect. Once the *authorization code* is parsed, it should be passed back to the server where it is then set to the [o_auth_authorization_code](#o_auth_authorization_code-property) property. Once that is set, the [authorize](#authorize-method) method can be called to exchange the *authorization code* for an *access token* and *refresh token* if provided. The class will then cache these values like normal and use them to make requests. If the [o_auth_refresh_token](#o_auth_refresh_token-property) field is set, or a *refresh token* is cached, then the [authorize](#authorize-method) method can immediately be called to make a request to the token server to get a new *access token*. ### External OAuth Support For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using a separate OAuth client. Once complete you should have an authorization string which looks like: ```text Bearer ACCESS_TOKEN_VALUE ``` Assign this value to the [authorization](#authorization-property) property before attempting any operations. Setting the [authorization](#authorization-property) property will cause the class to ignore the values set in the o_auth property. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication. ## Referencing and Creating Items, Links, Permissions, and Users ShareFile typically uses specified ids to reference its objects. When an object is created, through methods such as [create_client](#create_client-method) or [create_folder](#create_folder-method) or uploaded with the [upload_file](#upload_file-method) method; the class will return with the objects ShareFile Id in the form of a string. In certain cases, a path (/parentFolder/ChildFolder) can be used to reference an item. When a link is created using methods like [create_and_email_link](#create_and_email_link-method) , [create_and_email_request_link](#create_and_email_request_link-method), [create_link](#create_link-method), or [create_request_link](#create_request_link-method) then their URL is returned rather than their ShareFile id. To get the newly created id, the class also clears and populates the links properties with the new link. When creating a link, you can use the create_link_options property to set certain options for the link. When a permission is created using the [create_permission](#create_permission-method) method, the class will not return anything as ShareFile uses a combination of a UserId and the ItemId of a folder to reference permissions. When creating a permission, you can use the create_permission_options property to set certain options for the permission. ## Listing and Getting Items, Links, Permissions, and Users When listing out the Links and Users currently available to the authenticated user you will use the corresponding [list_links](#list_links-method) and [list_users](#list_users-method) methods. Both of these methods take no parameters and will populates their corresponding properties. For links the properties is the links properties and for users it is the users properties. When listing the Items within a Folder or Permissions, the corresponding methods will take a folders ItemId. [list_items](#list_items-method) will list the items in the folder to the items properties. The method will not recursively list out items found in child folders. The [list_permissions](#list_permissions-method) method will list all the permissions for the specified folder to the permissions properties. The class can also list out the items associated with a specified link. The [list_link_items](#list_link_items-method) method will take a LinkId and populate items properties. The class also offers the ability to get the specific information about a certain item, link, permission, or user. [get_item_info](#get_item_info-method), [get_link_info](#get_link_info-method) and [get_user_info](#get_user_info-method) each take a corresponding id. For permissions, [get_permission_info](#get_permission_info-method) will take a FolderId and UserId rather than a specific id. Once called, they each clear and populate the corresponding properties. For all list* and get* methods, there is a corresponding event that will fire for each item in the list. The [on_item_list](#on_item_list-event) event will fire when the [list_items](#list_items-method), [list_link_items](#list_link_items-method), or [get_item_info](#get_item_info-method) methods are called; the [on_link_list](#on_link_list-event) event will fire when the [list_links](#list_links-method) or [get_link_info](#get_link_info-method) methods are called; the [on_permission_list](#on_permission_list-event) event will fire when the [list_permissions](#list_permissions-method) or [get_permission_info](#get_permission_info-method) methods are called; and the [on_user_list](#on_user_list-event) event will fire when the [list_users](#list_users-method) or [get_user_info](#get_user_info-method) methods are called. ## Downloading Files The [download_file](#download_file-method) method downloads file or folder items. If [local_file](#local_file-property) is set, the file will be saved to the specified location; otherwise, the file data will be held by [item_data](#item_data-property). To download and decrypt an encrypted file, set [encryption_algorithm](#encryption_algorithm-property) and [encryption_password](#encryption_password-property) before calling this method. ### Download Notes **Simple Download** A simple download is consistent with setting the [local_file](#local_file-property) to the destination of the file when it is downloaded and then calling the method with the item's id. For example: ```text shareFile.LocalFile = "../MyFile.zip"; shareFile.DownloadFile(shareFile.Items[0].Id); ``` ## Uploading Files The [upload_file](#upload_file-method) method uploads new file items. If [local_file](#local_file-property) is set the file will be uploaded from the specified path. If [local_file](#local_file-property) is not set the data in [item_data](#item_data-property) will be used. To encrypt the file before uploading it, set [encryption_algorithm](#encryption_algorithm-property) and [encryption_password](#encryption_password-property). ### Upload Notes ShareFile offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted. **Simple** By default the class uses the simple upload mechanism. ```text ShareFile.LocalFile = "../MyFile.zip"; ShareFile.UploadFile("/MyFile.zip"); ``` **Resumable** To enable resumable uploads set [use_resumable_upload](#use_resumable_upload-property) to *True*. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually. When [use_resumable_upload](#use_resumable_upload-property) is set to *True* and [upload_file](#upload_file-method) is called, a resumable upload session is started by the class. Once called and the class fragments the file, the [resume_url](#resume_url-property) property is populated. This URL needs to be set so that the class can resume the upload if the upload is interrupted. During a resumable upload, the [on_fragment_complete](#on_fragment_complete-event) event fires after each fragment is uploaded to indicate overall progress. The class also updates [start_byte](#start_byte-property) as necessary to indicate the current offset in the file. If the upload is interrupted for any reason, resuming it is easy. First, verify that [resume_url](#resume_url-property) and [start_byte](#start_byte-property) are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). Then call [upload_file](#upload_file-method) again to resume the upload at the specified [start_byte](#start_byte-property) offset. Note that if the upload is not resumed after some time the upload session will expire. ```text shareFile.UseResumableUpload = true; shareFile.LocalFile = "../MyFile.zip"; shareFile.UploadFile("MyFile.zip"); // The transfer is interrupted and UploadFile() above fails. Later, resume the download. // Using the same instance StartByte and ResumeURL are already populated from the previous // upload attempt. shareFile.UploadFile("MyFile.zip"); ``` ## Additional Functionality The ShareFile class offers advanced functionality beyond simple uploads and downloads. For instance: - Encrypt and decrypt files using the [encryption_algorithm](#encryption_algorithm-property) and [encryption_password](#encryption_password-property) properties. - Basic file and folder manipulation and organization using methods such as [copy_item](#copy_item-method) and [move_item](#move_item-method). - And more! ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [account_subdomain](#account_subdomain-property) | Represent a ShareFile domain for the account. | | [authorization](#authorization-property) | The OAuth 2.0 authorization token. | | [create_link_options_access_level](#create_link_options_access_level-property) | The access level for the link. | | [create_link_options_creation_date](#create_link_options_creation_date-property) | The date the link was created. | | [create_link_options_expiration_date](#create_link_options_expiration_date-property) | The expiration date for the link. | | [create_link_options_id](#create_link_options_id-property) | The id of the link. | | [create_link_options_is_view_only](#create_link_options_is_view_only-property) | If the share items can only be viewed. | | [create_link_options_max_downloads](#create_link_options_max_downloads-property) | The maximum downloads for a link. | | [create_link_options_notify_on_access](#create_link_options_notify_on_access-property) | If the creator is notified when a user accesses the link. | | [create_link_options_title](#create_link_options_title-property) | The title of the link. | | [create_link_options_total_downloads](#create_link_options_total_downloads-property) | Total number of times the link has been downloaded from. | | [create_link_options_type](#create_link_options_type-property) | The link's type. | | [create_link_options_url](#create_link_options_url-property) | The url for the link. | | [create_permission_options_can_delete](#create_permission_options_can_delete-property) | If the user can delete the item or from the item. | | [create_permission_options_can_download](#create_permission_options_can_download-property) | If the user can read file content or download the item or from the item. | | [create_permission_options_can_manage_permissions](#create_permission_options_can_manage_permissions-property) | If the user can configure Access Controls in the item. | | [create_permission_options_can_upload](#create_permission_options_can_upload-property) | Whether the user can upload files to the item. | | [create_permission_options_can_view](#create_permission_options_can_view-property) | If the user can view items from the item. | | [create_permission_options_folder_id](#create_permission_options_folder_id-property) | The item id for the folder whose permissions are being defined. | | [create_permission_options_is_owner](#create_permission_options_is_owner-property) | If the user is the owner. | | [create_permission_options_notify_on_download](#create_permission_options_notify_on_download-property) | If the user is notified when the an item is downloaded from the folder. | | [create_permission_options_notify_on_upload](#create_permission_options_notify_on_upload-property) | If the user is notified when the an item is uploaded to the folder. | | [create_permission_options_user_id](#create_permission_options_user_id-property) | The user's ShareFile id. | | [encryption_algorithm](#encryption_algorithm-property) | The encryption algorithm. | | [encryption_password](#encryption_password-property) | The encryption password. | | [firewall_auto_detect](#firewall_auto_detect-property) | Whether to automatically detect and use firewall system settings, if available. | | [firewall_host](#firewall_host-property) | The name or IP address of the firewall (optional). | | [firewall_password](#firewall_password-property) | A password if authentication is to be used when connecting through the firewall. | | [firewall_port](#firewall_port-property) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [firewall_type](#firewall_type-property) | The type of firewall to connect through. | | [firewall_user](#firewall_user-property) | A username if authentication is to be used when connecting through a firewall. | | [idle](#idle-property) | The current status of the class. | | [item_count](#item_count-property) | The number of records in the Item arrays. | | [item_creation_date](#item_creation_date-property) | The date when the item was created. | | [item_creator_first_name](#item_creator_first_name-property) | The first name of the creator. | | [item_creator_last_name](#item_creator_last_name-property) | The last name of the creator. | | [item_description](#item_description-property) | The description of the item. | | [item_expiration_date](#item_expiration_date-property) | The expiration date for the item. | | [item_id](#item_id-property) | The id of the item. | | [item_name](#item_name-property) | The name of the item. | | [item_parent_id](#item_parent_id-property) | The id of the parent item. | | [item_path](#item_path-property) | The path to the parent folder for an item. | | [item_size](#item_size-property) | The size of the item. | | [item_type](#item_type-property) | The item's type. | | [item_data](#item_data-property) | The data that was downloaded, or that should be uploaded by the class. | | [link_count](#link_count-property) | The number of records in the Link arrays. | | [link_access_level](#link_access_level-property) | The access level for the link. | | [link_creation_date](#link_creation_date-property) | The date the link was created. | | [link_expiration_date](#link_expiration_date-property) | The expiration date for the link. | | [link_id](#link_id-property) | The id of the link. | | [link_is_view_only](#link_is_view_only-property) | If the share items can only be viewed. | | [link_max_downloads](#link_max_downloads-property) | The maximum downloads for a link. | | [link_notify_on_access](#link_notify_on_access-property) | If the creator is notified when a user accesses the link. | | [link_title](#link_title-property) | The title of the link. | | [link_total_downloads](#link_total_downloads-property) | Total number of times the link has been downloaded from. | | [link_type](#link_type-property) | The link's type. | | [link_url](#link_url-property) | The url for the link. | | [local_file](#local_file-property) | The location of the local file. | | [local_host](#local_host-property) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [o_auth_access_token](#o_auth_access_token-property) | The access token returned by the authorization server. | | [o_auth_authorization_code](#o_auth_authorization_code-property) | The authorization code that is exchanged for an access token. | | [o_auth_authorization_scope](#o_auth_authorization_scope-property) | The scope request or response parameter used during authorization. | | [o_auth_client_id](#o_auth_client_id-property) | The id of the client assigned when registering the application. | | [o_auth_client_profile](#o_auth_client_profile-property) | The type of client that is requesting authorization. | | [o_auth_client_secret](#o_auth_client_secret-property) | The secret value for the client assigned when registering the application. | | [o_auth_grant_type](#o_auth_grant_type-property) | The OAuth grant type used to acquire an OAuth access token. | | [o_auth_refresh_token](#o_auth_refresh_token-property) | Specifies the refresh token received from or sent to the authorization server. | | [o_auth_request_refresh_token](#o_auth_request_refresh_token-property) | Specifies whether the class will request a refresh token during authorization. | | [o_auth_return_url](#o_auth_return_url-property) | The URL where the user (browser) returns after authenticating. | | [o_auth_server_auth_url](#o_auth_server_auth_url-property) | The URL of the authorization server. | | [o_auth_server_token_url](#o_auth_server_token_url-property) | The URL of the token server used to obtain the access token. | | [o_auth_timeout](#o_auth_timeout-property) | The amount of time (in seconds) the class will wait for a response from the browser in the LaunchBrowser event. | | [o_auth_web_auth_url](#o_auth_web_auth_url-property) | The URL to which the user should be re-directed for authorization. | | [other_headers](#other_headers-property) | Other headers as determined by the user (optional). | | [overwrite](#overwrite-property) | Whether to overwrite the local or remote file. | | [parsed_header_count](#parsed_header_count-property) | The number of records in the ParsedHeader arrays. | | [parsed_header_field](#parsed_header_field-property) | This property contains the name of the HTTP header (this is the same case as it is delivered). | | [parsed_header_value](#parsed_header_value-property) | This property contains the header contents. | | [permission_count](#permission_count-property) | The number of records in the Permission arrays. | | [permission_can_delete](#permission_can_delete-property) | If the user can delete the item or from the item. | | [permission_can_download](#permission_can_download-property) | If the user can read file content or download the item or from the item. | | [permission_can_manage_permissions](#permission_can_manage_permissions-property) | If the user can configure Access Controls in the item. | | [permission_can_upload](#permission_can_upload-property) | Whether the user can upload files to the item. | | [permission_can_view](#permission_can_view-property) | If the user can view items from the item. | | [permission_folder_id](#permission_folder_id-property) | The item id for the folder whose permissions are being defined. | | [permission_is_owner](#permission_is_owner-property) | If the user is the owner. | | [permission_notify_on_download](#permission_notify_on_download-property) | If the user is notified when the an item is downloaded from the folder. | | [permission_notify_on_upload](#permission_notify_on_upload-property) | If the user is notified when the an item is uploaded to the folder. | | [permission_user_id](#permission_user_id-property) | The user's ShareFile id. | | [proxy_auth_scheme](#proxy_auth_scheme-property) | The type of authorization to perform when connecting to the proxy. | | [proxy_auto_detect](#proxy_auto_detect-property) | Whether to automatically detect and use proxy system settings, if available. | | [proxy_password](#proxy_password-property) | A password if authentication is to be used for the proxy. | | [proxy_port](#proxy_port-property) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). | | [proxy_server](#proxy_server-property) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. | | [proxy_ssl](#proxy_ssl-property) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. | | [proxy_user](#proxy_user-property) | A username if authentication is to be used for the proxy. | | [query_param_count](#query_param_count-property) | The number of records in the QueryParam arrays. | | [query_param_name](#query_param_name-property) | The name of the query parameter. | | [query_param_value](#query_param_value-property) | The value of the query parameter. | | [resume_url](#resume_url-property) | The resumable upload URL. | | [search_marker](#search_marker-property) | A marker indicating the number of search results to skip next. | | [ssl_accept_server_cert_effective_date](#ssl_accept_server_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_accept_server_cert_expiration_date](#ssl_accept_server_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_accept_server_cert_extended_key_usage](#ssl_accept_server_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_accept_server_cert_fingerprint](#ssl_accept_server_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha1](#ssl_accept_server_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha256](#ssl_accept_server_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_accept_server_cert_issuer](#ssl_accept_server_cert_issuer-property) | The issuer of the certificate. | | [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_accept_server_cert_private_key_container](#ssl_accept_server_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_accept_server_cert_public_key](#ssl_accept_server_cert_public_key-property) | The public key of the certificate. | | [ssl_accept_server_cert_public_key_algorithm](#ssl_accept_server_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_accept_server_cert_public_key_length](#ssl_accept_server_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_accept_server_cert_serial_number](#ssl_accept_server_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_accept_server_cert_signature_algorithm](#ssl_accept_server_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property) | The type of certificate store for this certificate. | | [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_accept_server_cert_subject_alt_names](#ssl_accept_server_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_accept_server_cert_thumbprint_md5](#ssl_accept_server_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha1](#ssl_accept_server_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha256](#ssl_accept_server_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property) | The text description of UsageFlags . | | [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_accept_server_cert_version](#ssl_accept_server_cert_version-property) | The certificate's version number. | | [ssl_cert_effective_date](#ssl_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_cert_encoded](#ssl_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_cert_expiration_date](#ssl_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_cert_fingerprint](#ssl_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_cert_issuer](#ssl_cert_issuer-property) | The issuer of the certificate. | | [ssl_cert_private_key](#ssl_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_cert_private_key_container](#ssl_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_cert_public_key](#ssl_cert_public_key-property) | The public key of the certificate. | | [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_cert_public_key_length](#ssl_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_cert_serial_number](#ssl_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_cert_store](#ssl_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_cert_store_password](#ssl_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssl_cert_store_type](#ssl_cert_store_type-property) | The type of certificate store for this certificate. | | [ssl_cert_subject](#ssl_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_cert_usage](#ssl_cert_usage-property) | The text description of UsageFlags . | | [ssl_cert_usage_flags](#ssl_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_cert_version](#ssl_cert_version-property) | The certificate's version number. | | [ssl_provider](#ssl_provider-property) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [ssl_server_cert_effective_date](#ssl_server_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_server_cert_expiration_date](#ssl_server_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_server_cert_extended_key_usage](#ssl_server_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_server_cert_fingerprint](#ssl_server_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha1](#ssl_server_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha256](#ssl_server_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_server_cert_issuer](#ssl_server_cert_issuer-property) | The issuer of the certificate. | | [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_server_cert_private_key_container](#ssl_server_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_server_cert_public_key](#ssl_server_cert_public_key-property) | The public key of the certificate. | | [ssl_server_cert_public_key_algorithm](#ssl_server_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_server_cert_public_key_length](#ssl_server_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_server_cert_serial_number](#ssl_server_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_server_cert_signature_algorithm](#ssl_server_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_server_cert_store](#ssl_server_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_server_cert_store_password](#ssl_server_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssl_server_cert_store_type](#ssl_server_cert_store_type-property) | The type of certificate store for this certificate. | | [ssl_server_cert_subject](#ssl_server_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_server_cert_subject_alt_names](#ssl_server_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_server_cert_thumbprint_md5](#ssl_server_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_server_cert_thumbprint_sha1](#ssl_server_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_server_cert_thumbprint_sha256](#ssl_server_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_server_cert_usage](#ssl_server_cert_usage-property) | The text description of UsageFlags . | | [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_server_cert_version](#ssl_server_cert_version-property) | The certificate's version number. | | [start_byte](#start_byte-property) | The byte offset from which to start the upload or download. | | [timeout](#timeout-property) | The timeout for the class. | | [user_count](#user_count-property) | The number of records in the User arrays. | | [user_company](#user_company-property) | The company of the user. | | [user_creation_date](#user_creation_date-property) | The date the user was created. | | [user_email](#user_email-property) | The email address of the user. | | [user_first_name](#user_first_name-property) | The first name of the user. | | [user_id](#user_id-property) | The id of the user. | | [user_last_name](#user_last_name-property) | The last name of the user. | | [use_resumable_upload](#use_resumable_upload-property) | Whether to use resumable uploads. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [add_query_param](#add_query_param-method) | Adds a query parameter to the QueryParams properties. | | [authorize](#authorize-method) | Get the authorization string required to access the protected resource. | | [config](#config-method) | Sets or retrieves a configuration setting. | | [copy_item](#copy_item-method) | Copies the specified item into the specified directory. | | [create_and_email_link](#create_and_email_link-method) | Creates a link for specified items and emails it. | | [create_and_email_request_link](#create_and_email_request_link-method) | Creates a new request link and emails it to the specified emails. | | [create_client](#create_client-method) | Creates a new client. | | [create_folder](#create_folder-method) | Creates a new folder. | | [create_link](#create_link-method) | Creates a new link for specified items. | | [create_permission](#create_permission-method) | Create a new Permissions for the specified folder and user. | | [create_request_link](#create_request_link-method) | Creates a new request link. | | [delete_child_items](#delete_child_items-method) | Removes multiple items from a parent item. | | [delete_client](#delete_client-method) | Deletes a client from the user list. | | [delete_item](#delete_item-method) | Deletes an item permanently. | | [delete_link](#delete_link-method) | Deletes the link specified by the LinkId. | | [delete_permission](#delete_permission-method) | Removes a users permissions for a specific folder. | | [download_file](#download_file-method) | This method downloads the file or the contents of the folder specified by the ItemId. | | [get_item_info](#get_item_info-method) | Gets information about a specific item. | | [get_link_info](#get_link_info-method) | Gets information about a specific link. | | [get_permission_info](#get_permission_info-method) | Gets information about a specific user's permission for a folder. | | [get_user_info](#get_user_info-method) | Gets information about a specific user. | | [interrupt](#interrupt-method) | This method interrupts the current method. | | [list_items](#list_items-method) | Lists the files and folders within a folder. | | [list_link_items](#list_link_items-method) | Lists the files and folders of a link. | | [list_links](#list_links-method) | Lists the request/download links for the currently authenticated user. | | [list_permissions](#list_permissions-method) | Lists the permissions of a folder. | | [list_users](#list_users-method) | Lists the client users of the authenticated account. | | [move_item](#move_item-method) | Moves an item to a different folder. | | [reset](#reset-method) | Resets the class to its initial state. | | [search](#search-method) | Searches for items that match the specified query. | | [send_custom_request](#send_custom_request-method) | Sends a custom request to the ShareFile API. | | [update_client](#update_client-method) | Updates a client's information. | | [update_item_info](#update_item_info-method) | Updates an item with new information. | | [update_link](#update_link-method) | Updates a request or download link. | | [update_permission](#update_permission-method) | Updates the permission from the Permissions properties. | | [upload_file](#upload_file-method) | Will upload a file to a folder. | ## 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.* | | | | --- | --- | | [on_end_transfer](#on_end_transfer-event) | Fired when a document finishes transferring. | | [on_error](#on_error-event) | Fired when information is available about errors during data delivery. | | [on_fragment_complete](#on_fragment_complete-event) | Fires after each fragment of a resumable upload is completed. | | [on_header](#on_header-event) | Fired every time a header line comes in. | | [on_item_list](#on_item_list-event) | This event fires once for each item returned when either ListItems , ListLinkItems or GetItemInfo is called. | | [on_link_list](#on_link_list-event) | This event fires once for each link returned when ListLinks or GetLinkInfo is called. | | [on_log](#on_log-event) | Fired once for each log message. | | [on_permission_list](#on_permission_list-event) | This event fires once for each permission returned when ListPermissions or GetPermissionInfo is called. | | [on_progress](#on_progress-event) | Fires during an upload or download to indicate transfer progress. | | [on_ssl_server_authentication](#on_ssl_server_authentication-event) | Fired after the server presents its certificate to the client. | | [on_ssl_status](#on_ssl_status-event) | Fired when secure connection progress messages are available. | | [on_start_transfer](#on_start_transfer-event) | Fired when a document starts transferring (after the headers). | | [on_transfer](#on_transfer-event) | Fired while a document transfers (delivers document). | | [on_user_list](#on_user_list-event) | This event fires once for each user returned when ListUsers or GetUserInfo is called. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccumulatePages](#AccumulatePages) | Whether the class should accumulate subsequent pages of results when listing them. | | [CreatePermissionNotify](#CreatePermissionNotify) | Whether to notify users of the permission they granted. | | [CreatePermissionNotifyMessage](#CreatePermissionNotifyMessage) | The custom notify message used in permission notification email. | | [DeleteChildItemsPermanently](#DeleteChildItemsPermanently) | Whether ChildItems should be deleted permanently. | | [DeleteUserCompletely](#DeleteUserCompletely) | Whether to delete user completely. | | [ForceSync](#ForceSync) | Whether ShareFile will block the operation from taking place asynchronously. | | [IncludeDeletedItems](#IncludeDeletedItems) | Whether deleted items should be include in the results. | | [IncludeExpiredLinks](#IncludeExpiredLinks) | Whether expired links should be include in the results. | | [ListUsersType](#ListUsersType) | The type used to list users. | | [RawRequest](#RawRequest) | Returns the data that was sent to the server. | | [RawResponse](#RawResponse) | Returns the data that was received from the server. | | [SearchPageSize](#SearchPageSize) | Limits the number of search results. | | [XChildCount](#XChildCount) | The number of child elements of the current element. | | [XChildName\[i\]](#XChildName[i]) | The name of the child element. | | [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. | | [XElement](#XElement) | The name of the current element. | | [XParent](#XParent) | The parent of the current element. | | [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. | | [XSubTree](#XSubTree) | A snapshot of the current element in the document. | | [XText](#XText) | The text of the current element. | | [OAuthAccessTokenExpiration](#OAuthAccessTokenExpiration) | The lifetime of the access token. | | [OAuthAuthorizationTokenType](#OAuthAuthorizationTokenType) | The type of access token returned. | | [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) | Whether or not to refresh an expired access token automatically. | | [OAuthBrowserResponseTimeout](#OAuthBrowserResponseTimeout) | Specifies the amount of time to wait for a response from the browser. | | [OAuthIncludeEmptyRedirectURI](#OAuthIncludeEmptyRedirectURI) | Whether an empty redirect_uri parameter is included in requests. | | [OAuthJWTPayload](#OAuthJWTPayload) | The payload of the JWT access token if present. | | [OAuthJWTXChildCount](#OAuthJWTXChildCount) | The number of child elements of the current element. | | [OauthJWTXChildName\[i\]](#OauthJWTXChildName[i]) | The name of the child element. | | [OAuthJWTXChildXText\[i\]](#OAuthJWTXChildXText[i]) | The inner text of the child element. | | [OAuthJWTXElement](#OAuthJWTXElement) | The name of the current element. | | [OauthJWTXParent](#OauthJWTXParent) | The parent of the current element. | | [OAuthJWTXPath](#OAuthJWTXPath) | Provides a way to point to a specific element in the returned payload of a JWT based access token. | | [OAuthJWTXSubTree](#OAuthJWTXSubTree) | A snapshot of the current element in the document. | | [OAuthJWTXText](#OAuthJWTXText) | The text of the current element. | | [OAuthParamCount](#OAuthParamCount) | Specifies the number of additional parameters variables to include in the request. | | [OAuthParamName\[i\]](#OAuthParamName[i]) | Specifies the parameter name at the specified index. | | [OAuthParamValue\[i\]](#OAuthParamValue[i]) | Specifies the parameter value at the specified index. | | [OAuthPasswordGrantUsername](#OAuthPasswordGrantUsername) | Used in the Resource Owner Password grant type. | | [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) | The PKCE code challenge method to use. | | [OAuthPKCEVerifier](#OAuthPKCEVerifier) | The PKCE verifier used to generate the challenge. | | [OAuthResetData](#OAuthResetData) | Determines if the Reset method applies to the OAuth settings. | | [OAuthReUseWebServer](#OAuthReUseWebServer) | Determines if the same server instance is used between requests. | | [OAuthTransferredRequest](#OAuthTransferredRequest) | The full OAuth request last sent by the client. | | [OAuthUsePKCE](#OAuthUsePKCE) | Specifies if PKCE should be used. | | [OAuthWebServerActive](#OAuthWebServerActive) | Specifies and controls whether the embedded web server is active. | | [OAuthWebServerCertStore](#OAuthWebServerCertStore) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerFailedResponse](#OAuthWebServerFailedResponse) | The custom response that will be displayed to the user if authentication failed. | | [OAuthWebServerHost](#OAuthWebServerHost) | The hostname used by the embedded web server displayed in the ReturnURL. | | [OAuthWebServerPort](#OAuthWebServerPort) | The local port on which the embedded web server listens. | | [OAuthWebServerResponse](#OAuthWebServerResponse) | The custom response that will be displayed to the user. | | [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) | Whether the web server requires SSL connections. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UsePlatformHTTPClient](#UsePlatformHTTPClient) | Whether or not to use the platform HTTP client. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACertFilePaths](#SSLCACertFilePaths) | The paths to CA certificate files on Unix/Linux. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # account_subdomain property Represent a ShareFile domain for the account. ## Syntax ```text def get_account_subdomain() -> str: ... def set_account_subdomain(value: str) -> None: ... account_subdomain = property(get_account_subdomain, set_account_subdomain) ``` ## Default Value "" ## Remarks Used for making requests for accounts with subdomains. The domain is typically the account name which can be found in the admin account summary or in the URL. For example, in https://example.sharefile.com/dashboard, 'example' represents the subdomain. # authorization property The OAuth 2.0 authorization token. ## Syntax ```text def get_authorization() -> str: ... def set_authorization(value: str) -> None: ... authorization = property(get_authorization, set_authorization) ``` ## Default Value "" ## Remarks This property is used to specify the OAuth 2.0 authorization token that was obtained as a result of performing OAuth. A valid OAuth token will come in the following format: ```text Bearer ACCESS_TOKEN ``` The *ACCESS_TOKEN* segment must be supplied to this property before attempting any other operations. Consult the documentation for the service for more information about supported scope values and more details on performing OAuth. # create_link_options_access_level property The access level for the link. ## Syntax ```text def get_create_link_options_access_level() -> int: ... def set_create_link_options_access_level(value: int) -> None: ... create_link_options_access_level = property(get_create_link_options_access_level, set_create_link_options_access_level) ``` ## Possible Values ```text 0 # Anonymous1 # UserInfo2 # EmployeesAndClients3 # EmployeesOnly ``` ## Default Value 0 ## Remarks The access level for the link. This property reflects the link's access level. Possible values are: - 0 (sflalAnonymous) - 1 (sflalUserInfo)* - 2 (sflalEmployeesAndClients) - 3 (sflalEmployeesOnly) *Requires a user to provide a first name, last name, email, and company. To modify this property see [update_link](#update_link-method). # create_link_options_creation_date property The date the link was created. ## Syntax ```text def get_create_link_options_creation_date() -> str: ... create_link_options_creation_date = property(get_create_link_options_creation_date, None) ``` ## Default Value "" ## Remarks The date the link was created. This property specifies the date when the link was created. Dates are formatted according to ISO 8601 and are always in UTC time. This property is read-only. # create_link_options_expiration_date property The expiration date for the link. ## Syntax ```text def get_create_link_options_expiration_date() -> str: ... def set_create_link_options_expiration_date(value: str) -> None: ... create_link_options_expiration_date = property(get_create_link_options_expiration_date, set_create_link_options_expiration_date) ``` ## Default Value "" ## Remarks The expiration date for the link. This property specifies the expiration date for when the link will no longer be valid. To modify this property see [update_link](#update_link-method). # create_link_options_id property The id of the link. ## Syntax ```text def get_create_link_options_id() -> str: ... create_link_options_id = property(get_create_link_options_id, None) ``` ## Default Value "" ## Remarks The id of the link. This property specifies the id of the link. This property is read-only. # create_link_options_is_view_only property If the share items can only be viewed. ## Syntax ```text def get_create_link_options_is_view_only() -> bool: ... def set_create_link_options_is_view_only(value: bool) -> None: ... create_link_options_is_view_only = property(get_create_link_options_is_view_only, set_create_link_options_is_view_only) ``` ## Default Value FALSE ## Remarks If the share items can only be viewed. If true, the share items can only be viewed but not downloaded. Requires account preference EnableViewOnly to work. This feature can be enabled for Enterprise accounts by request. # create_link_options_max_downloads property The maximum downloads for a link. ## Syntax ```text def get_create_link_options_max_downloads() -> int: ... def set_create_link_options_max_downloads(value: int) -> None: ... create_link_options_max_downloads = property(get_create_link_options_max_downloads, set_create_link_options_max_downloads) ``` ## Default Value -1 ## Remarks The maximum downloads for a link. The property specifies the number of downloads for a link. "-1" indicates an unlimited number of downloads. The field is always "-1" if the type is request. To modify this property see [update_link](#update_link-method). # create_link_options_notify_on_access property If the creator is notified when a user accesses the link. ## Syntax ```text def get_create_link_options_notify_on_access() -> bool: ... def set_create_link_options_notify_on_access(value: bool) -> None: ... create_link_options_notify_on_access = property(get_create_link_options_notify_on_access, set_create_link_options_notify_on_access) ``` ## Default Value FALSE ## Remarks If the creator is notified when a user accesses the link. This property if the creator of the link will be notified when a user accesses the link. Note: When creating the link this property will not be populated until a subsequent call to [get_link_info](#get_link_info-method) or [list_links](#list_links-method). # create_link_options_title property The title of the link. ## Syntax ```text def get_create_link_options_title() -> str: ... def set_create_link_options_title(value: str) -> None: ... create_link_options_title = property(get_create_link_options_title, set_create_link_options_title) ``` ## Default Value "" ## Remarks The title of the link. This property specifies the title of the link. To modify this property see [update_item_info](#update_item_info-method). # create_link_options_total_downloads property Total number of times the link has been downloaded from. ## Syntax ```text def get_create_link_options_total_downloads() -> int: ... create_link_options_total_downloads = property(get_create_link_options_total_downloads, None) ``` ## Default Value 0 ## Remarks Total number of times the link has been downloaded from. This property specifies the number of times an item has been downloaded from it. This property is read-only. # create_link_options_type property The link's type. ## Syntax ```text def get_create_link_options_type() -> int: ... create_link_options_type = property(get_create_link_options_type, None) ``` ## Possible Values ```text 0 # Send1 # Request ``` ## Default Value 0 ## Remarks The link's type. This property reflects the link's type. Possible values are: - 0 (sfltSend) - 1 (sfltRequest) This property is read-only. # create_link_options_url property The url for the link. ## Syntax ```text def get_create_link_options_url() -> str: ... create_link_options_url = property(get_create_link_options_url, None) ``` ## Default Value "" ## Remarks The url for the link. This property specifies the url for the link. This property is read-only. # create_permission_options_can_delete property If the user can delete the item or from the item. ## Syntax ```text def get_create_permission_options_can_delete() -> bool: ... def set_create_permission_options_can_delete(value: bool) -> None: ... create_permission_options_can_delete = property(get_create_permission_options_can_delete, set_create_permission_options_can_delete) ``` ## Default Value FALSE ## Remarks If the user can delete the item or from the item. This property defines whether the user can remove items from the item. To modify this property see [update_permission](#update_permission-method). # create_permission_options_can_download property If the user can read file content or download the item or from the item. ## Syntax ```text def get_create_permission_options_can_download() -> bool: ... def set_create_permission_options_can_download(value: bool) -> None: ... create_permission_options_can_download = property(get_create_permission_options_can_download, set_create_permission_options_can_download) ``` ## Default Value TRUE ## Remarks If the user can read file content or download the item or from the item. This property defines whether the user can download or read from the item. To modify this property see [update_permission](#update_permission-method). # create_permission_options_can_manage_permissions property If the user can configure Access Controls in the item. ## Syntax ```text def get_create_permission_options_can_manage_permissions() -> bool: ... def set_create_permission_options_can_manage_permissions(value: bool) -> None: ... create_permission_options_can_manage_permissions = property(get_create_permission_options_can_manage_permissions, set_create_permission_options_can_manage_permissions) ``` ## Default Value FALSE ## Remarks If the user can configure Access Controls in the item. This property defines whether the user can configure Access Controls for the item. To modify this property see [update_permission](#update_permission-method). # create_permission_options_can_upload property Whether the user can upload files to the item. ## Syntax ```text def get_create_permission_options_can_upload() -> bool: ... def set_create_permission_options_can_upload(value: bool) -> None: ... create_permission_options_can_upload = property(get_create_permission_options_can_upload, set_create_permission_options_can_upload) ``` ## Default Value FALSE ## Remarks Whether the user can upload files to the item. This property defines whether the user can upload files to the item. To modify this property see [update_permission](#update_permission-method). # create_permission_options_can_view property If the user can view items from the item. ## Syntax ```text def get_create_permission_options_can_view() -> bool: ... def set_create_permission_options_can_view(value: bool) -> None: ... create_permission_options_can_view = property(get_create_permission_options_can_view, set_create_permission_options_can_view) ``` ## Default Value TRUE ## Remarks If the user can view items from the item. This property defines whether the user can view items from this item. To modify this property see [update_permission](#update_permission-method). # create_permission_options_folder_id property The item id for the folder whose permissions are being defined. ## Syntax ```text def get_create_permission_options_folder_id() -> str: ... create_permission_options_folder_id = property(get_create_permission_options_folder_id, None) ``` ## Default Value "" ## Remarks The item id for the folder whose permissions are being defined. This property specifies the item id for the folder whose permissions are being defined. It is required for this id to be of a folder type. This property is read-only. # create_permission_options_is_owner property If the user is the owner. ## Syntax ```text def get_create_permission_options_is_owner() -> bool: ... create_permission_options_is_owner = property(get_create_permission_options_is_owner, None) ``` ## Default Value FALSE ## Remarks If the user is the owner. This property specifies if the user specified by the [create_permission_options_user_id](#create_permission_options_user_id-property) property is the owner of the item specified by the [create_permission_options_folder_id](#create_permission_options_folder_id-property) property. This property is read-only. # create_permission_options_notify_on_download property If the user is notified when the an item is downloaded from the folder. ## Syntax ```text def get_create_permission_options_notify_on_download() -> bool: ... def set_create_permission_options_notify_on_download(value: bool) -> None: ... create_permission_options_notify_on_download = property(get_create_permission_options_notify_on_download, set_create_permission_options_notify_on_download) ``` ## Default Value FALSE ## Remarks If the user is notified when the an item is downloaded from the folder. This property specifies if the user will be notified if an item is downloaded from the folder. To modify this property see [update_permission](#update_permission-method). # create_permission_options_notify_on_upload property If the user is notified when the an item is uploaded to the folder. ## Syntax ```text def get_create_permission_options_notify_on_upload() -> bool: ... def set_create_permission_options_notify_on_upload(value: bool) -> None: ... create_permission_options_notify_on_upload = property(get_create_permission_options_notify_on_upload, set_create_permission_options_notify_on_upload) ``` ## Default Value FALSE ## Remarks If the user is notified when the an item is uploaded to the folder. This property specifies if the user will be notified if an item is uploaded to the folder. To modify this property see [update_permission](#update_permission-method). # create_permission_options_user_id property The user's ShareFile id. ## Syntax ```text def get_create_permission_options_user_id() -> str: ... create_permission_options_user_id = property(get_create_permission_options_user_id, None) ``` ## Default Value "" ## Remarks The user's ShareFile id. This property specifies the user's user id that the permission is for. This property is read-only. # encryption_algorithm property The encryption algorithm. ## Syntax ```text def get_encryption_algorithm() -> int: ... def set_encryption_algorithm(value: int) -> None: ... encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm) ``` ## Possible Values ```text 0 # AES1 # Blowfish2 # CAST3 # DES4 # IDEA5 # RC26 # RC47 # TEA8 # TripleDES9 # Twofish10 # Rijndael11 # ChaCha12 # XSalsa20 ``` ## 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 | # encryption_password property The encryption password. ## Syntax ```text def get_encryption_password() -> str: ... def set_encryption_password(value: str) -> None: ... encryption_password = property(get_encryption_password, set_encryption_password) ``` ## Default Value "" ## Remarks If this property is populated when [upload_file](#upload_file-method) or [download_file](#download_file-method) 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](#EncryptionKey) and [EncryptionIV](#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. # firewall_auto_detect property Whether to automatically detect and use firewall system settings, if available. ## Syntax ```text def get_firewall_auto_detect() -> bool: ... def set_firewall_auto_detect(value: bool) -> None: ... firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect) ``` ## Default Value FALSE ## Remarks Whether to automatically detect and use firewall system settings, if available. # firewall_host property The name or IP address of the firewall (optional). ## Syntax ```text def get_firewall_host() -> str: ... def set_firewall_host(value: str) -> None: ... firewall_host = property(get_firewall_host, set_firewall_host) ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property) 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. # firewall_password property A password if authentication is to be used when connecting through the firewall. ## Syntax ```text def get_firewall_password() -> str: ... def set_firewall_password(value: str) -> None: ... firewall_password = property(get_firewall_password, set_firewall_password) ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property) is specified, the [firewall_user](#firewall_user-property) and [firewall_password](#firewall_password-property) properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. # firewall_port property The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax ```text def get_firewall_port() -> int: ... def set_firewall_port(value: int) -> None: ... firewall_port = property(get_firewall_port, set_firewall_port) ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property). See the description of the [firewall_host](#firewall_host-property) property for details. NOTE: This property is set automatically when [firewall_type](#ShareFile_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_type](#ShareFile_p_FirewallFirewallType) property for details. # firewall_type property The type of firewall to connect through. ## Syntax ```text def get_firewall_type() -> int: ... def set_firewall_type(value: int) -> None: ... firewall_type = property(get_firewall_type, set_firewall_type) ``` ## Possible Values ```text 0 # None1 # Tunnel2 # SOCKS43 # SOCKS510 # SOCKS4A ``` ## Default Value 0 ## Remarks 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. [firewall_port](#firewall_port-property) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property) is set to 1080. | # firewall_user property A username if authentication is to be used when connecting through a firewall. ## Syntax ```text def get_firewall_user() -> str: ... def set_firewall_user(value: str) -> None: ... firewall_user = property(get_firewall_user, set_firewall_user) ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property) is specified, this property and the [firewall_password](#firewall_password-property) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the class fails with an error. # idle property The current status of the class. ## Syntax ```text def get_idle() -> bool: ... idle = property(get_idle, None) ``` ## Default Value TRUE ## Remarks This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times. This property is read-only. # item_count property The number of records in the Item arrays. ## Syntax ```text def get_item_count() -> int: ... def set_item_count(value: int) -> None: ... item_count = property(get_item_count, set_item_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [item_creation_date](#item_creation_date-property) - [item_creator_first_name](#item_creator_first_name-property) - [item_creator_last_name](#item_creator_last_name-property) - [item_description](#item_description-property) - [item_expiration_date](#item_expiration_date-property) - [item_id](#item_id-property) - [item_name](#item_name-property) - [item_parent_id](#item_parent_id-property) - [item_path](#item_path-property) - [item_size](#item_size-property) - [item_type](#item_type-property) The array indices start at *0* and end at *item_count - 1*. # item_creation_date property The date when the item was created. ## Syntax ```text def get_item_creation_date(item_index: int) -> str: ... ``` ## Default Value "" ## Remarks The date when the item was created. This property specifies the creation date of the item. Dates are formatted according to ISO 8601 and are always in UTC time. The *item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [item_count](#item_count-property) property. This property is read-only. # item_creator_first_name property The first name of the creator. ## Syntax ```text def get_item_creator_first_name(item_index: int) -> str: ... ``` ## Default Value "" ## Remarks The first name of the creator. This property specifies first name of the creator. The *item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [item_count](#item_count-property) property. This property is read-only. # item_creator_last_name property The last name of the creator. ## Syntax ```text def get_item_creator_last_name(item_index: int) -> str: ... ``` ## Default Value "" ## Remarks The last name of the creator. This property specifies last name of the creator. The *item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [item_count](#item_count-property) property. This property is read-only. # item_description property The description of the item. ## Syntax ```text def get_item_description(item_index: int) -> str: ... def set_item_description(item_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The description of the item. This property specifies the description of the item. To modify this property see [update_item_info](#update_item_info-method). The *item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [item_count](#item_count-property) property. # item_expiration_date property The expiration date for the item. ## Syntax ```text def get_item_expiration_date(item_index: int) -> str: ... def set_item_expiration_date(item_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The expiration date for the item. This property specifies the expiration date for the item. After the date ShareFile will move the item into the recycle bin. To modify this property see [update_item_info](#update_item_info-method). The *item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [item_count](#item_count-property) property. # item_id property The id of the item. ## Syntax ```text def get_item_id(item_index: int) -> str: ... ``` ## Default Value "" ## Remarks The id of the item. This property specifies the id for the item. The *item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [item_count](#item_count-property) property. This property is read-only. # item_name property The name of the item. ## Syntax ```text def get_item_name(item_index: int) -> str: ... def set_item_name(item_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The name of the item. This property specifies the name of the item. For example, a files name might be example.txt while a folder might be exampleFolder. To modify this field see [update_item_info](#update_item_info-method). The *item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [item_count](#item_count-property) property. # item_parent_id property The id of the parent item. ## Syntax ```text def get_item_parent_id(item_index: int) -> str: ... def set_item_parent_id(item_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The id of the parent item. This property specifies the id of the parent item. For example, if the current item is a file in the exampleFolder folder then the ParentId will be the id of the exampleFolder item. To modify this property see [update_item_info](#update_item_info-method). The *item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [item_count](#item_count-property) property. # item_path property The path to the parent folder for an item. ## Syntax ```text def get_item_path(item_index: int) -> str: ... def set_item_path(item_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The path to the parent folder for an item. The property specifies the path from the virtual root to the parent folder for an item. This path is determined by ShareFile. The *item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [item_count](#item_count-property) property. # item_size property The size of the item. ## Syntax ```text def get_item_size(item_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The size of the item. The property specifies the size of the item. If the item is a file then the size will be in KB and contain the size of the file. If the item is a folder then it will be the size of the children items, recursively. The *item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [item_count](#item_count-property) property. This property is read-only. # item_type property The item's type. ## Syntax ```text def get_item_type(item_index: int) -> int: ... ``` ## Possible Values ```text 0 # File1 # Folder2 # Link3 # Note4 # SymbolicLink ``` ## Default Value 0 ## Remarks The item's type. This property reflects the item's type. Possible values are: - 0 (sfitFile) - 1 (sfitFolder) - 2 (sfitLink)* - 3 (sfitNote) - 4 (sfitSymbolicLink)* *In reference to a folder link rather then a link created by one of the class methods or found in the [links](#ShareFile_p_Links) properties. The *item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [item_count](#item_count-property) property. This property is read-only. # item_data property The data that was downloaded, or that should be uploaded by the class. ## Syntax ```text def get_item_data() -> bytes: ... def set_item_data(value: bytes) -> None: ... item_data = property(get_item_data, set_item_data) ``` ## Default Value "" ## Remarks This property is populated with file data after calling [download_file](#download_file-method) if [local_file](#local_file-property) is not set. This property can also be set before calling [upload_file](#upload_file-method); its data will be uploaded if [local_file](#local_file-property) is not set. # link_count property The number of records in the Link arrays. ## Syntax ```text def get_link_count() -> int: ... def set_link_count(value: int) -> None: ... link_count = property(get_link_count, set_link_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [link_access_level](#link_access_level-property) - [link_creation_date](#link_creation_date-property) - [link_expiration_date](#link_expiration_date-property) - [link_id](#link_id-property) - [link_is_view_only](#link_is_view_only-property) - [link_max_downloads](#link_max_downloads-property) - [link_notify_on_access](#link_notify_on_access-property) - [link_title](#link_title-property) - [link_total_downloads](#link_total_downloads-property) - [link_type](#link_type-property) - [link_url](#link_url-property) The array indices start at *0* and end at *link_count - 1*. # link_access_level property The access level for the link. ## Syntax ```text def get_link_access_level(link_index: int) -> int: ... def set_link_access_level(link_index: int, value: int) -> None: ... ``` ## Possible Values ```text 0 # Anonymous1 # UserInfo2 # EmployeesAndClients3 # EmployeesOnly ``` ## Default Value 0 ## Remarks The access level for the link. This property reflects the link's access level. Possible values are: - 0 (sflalAnonymous) - 1 (sflalUserInfo)* - 2 (sflalEmployeesAndClients) - 3 (sflalEmployeesOnly) *Requires a user to provide a first name, last name, email, and company. To modify this property see [update_link](#update_link-method). The *link_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [link_count](#link_count-property) property. # link_creation_date property The date the link was created. ## Syntax ```text def get_link_creation_date(link_index: int) -> str: ... ``` ## Default Value "" ## Remarks The date the link was created. This property specifies the date when the link was created. Dates are formatted according to ISO 8601 and are always in UTC time. The *link_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [link_count](#link_count-property) property. This property is read-only. # link_expiration_date property The expiration date for the link. ## Syntax ```text def get_link_expiration_date(link_index: int) -> str: ... def set_link_expiration_date(link_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The expiration date for the link. This property specifies the expiration date for when the link will no longer be valid. To modify this property see [update_link](#update_link-method). The *link_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [link_count](#link_count-property) property. # link_id property The id of the link. ## Syntax ```text def get_link_id(link_index: int) -> str: ... ``` ## Default Value "" ## Remarks The id of the link. This property specifies the id of the link. The *link_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [link_count](#link_count-property) property. This property is read-only. # link_is_view_only property If the share items can only be viewed. ## Syntax ```text def get_link_is_view_only(link_index: int) -> bool: ... def set_link_is_view_only(link_index: int, value: bool) -> None: ... ``` ## Default Value FALSE ## Remarks If the share items can only be viewed. If true, the share items can only be viewed but not downloaded. Requires account preference EnableViewOnly to work. This feature can be enabled for Enterprise accounts by request. The *link_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [link_count](#link_count-property) property. # link_max_downloads property The maximum downloads for a link. ## Syntax ```text def get_link_max_downloads(link_index: int) -> int: ... def set_link_max_downloads(link_index: int, value: int) -> None: ... ``` ## Default Value -1 ## Remarks The maximum downloads for a link. The property specifies the number of downloads for a link. "-1" indicates an unlimited number of downloads. The field is always "-1" if the type is request. To modify this property see [update_link](#update_link-method). The *link_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [link_count](#link_count-property) property. # link_notify_on_access property If the creator is notified when a user accesses the link. ## Syntax ```text def get_link_notify_on_access(link_index: int) -> bool: ... def set_link_notify_on_access(link_index: int, value: bool) -> None: ... ``` ## Default Value FALSE ## Remarks If the creator is notified when a user accesses the link. This property if the creator of the link will be notified when a user accesses the link. Note: When creating the link this property will not be populated until a subsequent call to [get_link_info](#get_link_info-method) or [list_links](#list_links-method). The *link_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [link_count](#link_count-property) property. # link_title property The title of the link. ## Syntax ```text def get_link_title(link_index: int) -> str: ... def set_link_title(link_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The title of the link. This property specifies the title of the link. To modify this property see [update_item_info](#update_item_info-method). The *link_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [link_count](#link_count-property) property. # link_total_downloads property Total number of times the link has been downloaded from. ## Syntax ```text def get_link_total_downloads(link_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Total number of times the link has been downloaded from. This property specifies the number of times an item has been downloaded from it. The *link_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [link_count](#link_count-property) property. This property is read-only. # link_type property The link's type. ## Syntax ```text def get_link_type(link_index: int) -> int: ... ``` ## Possible Values ```text 0 # Send1 # Request ``` ## Default Value 0 ## Remarks The link's type. This property reflects the link's type. Possible values are: - 0 (sfltSend) - 1 (sfltRequest) The *link_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [link_count](#link_count-property) property. This property is read-only. # link_url property The url for the link. ## Syntax ```text def get_link_url(link_index: int) -> str: ... ``` ## Default Value "" ## Remarks The url for the link. This property specifies the url for the link. The *link_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [link_count](#link_count-property) property. This property is read-only. # local_file property The location of the local file. ## Syntax ```text def get_local_file() -> str: ... def set_local_file(value: str) -> None: ... local_file = property(get_local_file, set_local_file) ``` ## Default Value "" ## Remarks This property specifies the location of a file on disk. This is used as the source file when calling [upload_file](#upload_file-method) and as the destination file when calling [download_file](#download_file-method). # local_host property The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text def get_local_host() -> str: ... def set_local_host(value: str) -> None: ... local_host = property(get_local_host, set_local_host) ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) 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 local_host 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: local_host is not persistent. You must always set it in code, and never in the property window. # o_auth_access_token property The access token returned by the authorization server. ## Syntax ```text def get_o_auth_access_token() -> str: ... def set_o_auth_access_token(value: str) -> None: ... o_auth_access_token = property(get_o_auth_access_token, set_o_auth_access_token) ``` ## Default Value "" ## Remarks The access token returned by the authorization server. This is set when the class makes a request to the token server. # o_auth_authorization_code property The authorization code that is exchanged for an access token. ## Syntax ```text def get_o_auth_authorization_code() -> str: ... def set_o_auth_authorization_code(value: str) -> None: ... o_auth_authorization_code = property(get_o_auth_authorization_code, set_o_auth_authorization_code) ``` ## Default Value "" ## Remarks The authorization code that is exchanged for an access token. This is required to be set when the o_auth_client_profile property is set to the Web profile. Otherwise, this field is for information purposes only. # o_auth_authorization_scope property The scope request or response parameter used during authorization. ## Syntax ```text def get_o_auth_authorization_scope() -> str: ... def set_o_auth_authorization_scope(value: str) -> None: ... o_auth_authorization_scope = property(get_o_auth_authorization_scope, set_o_auth_authorization_scope) ``` ## Default Value "" ## Remarks The scope request or response parameter used during authorization. # o_auth_client_id property The id of the client assigned when registering the application. ## Syntax ```text def get_o_auth_client_id() -> str: ... def set_o_auth_client_id(value: str) -> None: ... o_auth_client_id = property(get_o_auth_client_id, set_o_auth_client_id) ``` ## Default Value "" ## Remarks The id of the client assigned when registering the application. # o_auth_client_profile property The type of client that is requesting authorization. ## Syntax ```text def get_o_auth_client_profile() -> int: ... def set_o_auth_client_profile(value: int) -> None: ... o_auth_client_profile = property(get_o_auth_client_profile, set_o_auth_client_profile) ``` ## Possible Values ```text 0 # Application1 # Web ``` ## Default Value 0 ## Remarks The type of client that is requesting authorization. See the introduction section for more information. Possible values are: | | | | --- | --- | | 0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. | | 1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. | # o_auth_client_secret property The secret value for the client assigned when registering the application. ## Syntax ```text def get_o_auth_client_secret() -> str: ... def set_o_auth_client_secret(value: str) -> None: ... o_auth_client_secret = property(get_o_auth_client_secret, set_o_auth_client_secret) ``` ## Default Value "" ## Remarks The secret value for the client assigned when registering the application. # o_auth_grant_type property The OAuth grant type used to acquire an OAuth access token. ## Syntax ```text def get_o_auth_grant_type() -> int: ... def set_o_auth_grant_type(value: int) -> None: ... o_auth_grant_type = property(get_o_auth_grant_type, set_o_auth_grant_type) ``` ## Possible Values ```text 0 # AuthorizationCode1 # Implicit2 # Password3 # ClientCredentials ``` ## Default Value 0 ## Remarks The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are: | | | | --- | --- | | 0 (cogtAuthorizationCode - Default) | Authorization Code grant type | | 1 (cogtImplicit) | Implicit grant type | | 2 (cogtPassword) | Resource Owner Password Credentials grant type | | 3 (cogtClientCredentials) | Client Credentials grant type | # o_auth_refresh_token property Specifies the refresh token received from or sent to the authorization server. ## Syntax ```text def get_o_auth_refresh_token() -> str: ... def set_o_auth_refresh_token(value: str) -> None: ... o_auth_refresh_token = property(get_o_auth_refresh_token, set_o_auth_refresh_token) ``` ## Default Value "" ## Remarks Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the o_auth_grant_type property is set to a grant that can use refresh tokens. # o_auth_request_refresh_token property Specifies whether the class will request a refresh token during authorization. ## Syntax ```text def get_o_auth_request_refresh_token() -> bool: ... def set_o_auth_request_refresh_token(value: bool) -> None: ... o_auth_request_refresh_token = property(get_o_auth_request_refresh_token, set_o_auth_request_refresh_token) ``` ## Default Value TRUE ## Remarks Specifies whether the class will request a refresh token during authorization. By default, this value is *True*. When *True*, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When *False*, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained. NOTE: This property is only applicable when the o_auth_grant_type property is set to *cogtAuthorizationCode*. # o_auth_return_url property The URL where the user (browser) returns after authenticating. ## Syntax ```text def get_o_auth_return_url() -> str: ... def set_o_auth_return_url(value: str) -> None: ... o_auth_return_url = property(get_o_auth_return_url, set_o_auth_return_url) ``` ## Default Value "" ## Remarks The URL where the user (browser) returns after authenticating. This property is mapped to the *redirect_uri* parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing. # o_auth_server_auth_url property The URL of the authorization server. ## Syntax ```text def get_o_auth_server_auth_url() -> str: ... def set_o_auth_server_auth_url(value: str) -> None: ... o_auth_server_auth_url = property(get_o_auth_server_auth_url, set_o_auth_server_auth_url) ``` ## Default Value "" ## Remarks The URL of the authorization server. # o_auth_server_token_url property The URL of the token server used to obtain the access token. ## Syntax ```text def get_o_auth_server_token_url() -> str: ... def set_o_auth_server_token_url(value: str) -> None: ... o_auth_server_token_url = property(get_o_auth_server_token_url, set_o_auth_server_token_url) ``` ## Default Value "" ## Remarks The URL of the token server used to obtain the access token. # o_auth_timeout property The amount of time (in seconds) the class will wait for a response from the browser in the LaunchBrowser event. ## Syntax ```text def get_o_auth_timeout() -> int: ... def set_o_auth_timeout(value: int) -> None: ... o_auth_timeout = property(get_o_auth_timeout, set_o_auth_timeout) ``` ## Default Value 60 ## Remarks The amount of time (in seconds) the component will wait for a response from the browser in the on_launch_browser event. The default value is 60. # o_auth_web_auth_url property The URL to which the user should be re-directed for authorization. ## Syntax ```text def get_o_auth_web_auth_url() -> str: ... o_auth_web_auth_url = property(get_o_auth_web_auth_url, None) ``` ## Default Value "" ## Remarks The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information. This property is read-only. # other_headers property Other headers as determined by the user (optional). ## Syntax ```text def get_other_headers() -> str: ... def set_other_headers(value: str) -> None: ... other_headers = property(get_other_headers, set_other_headers) ``` ## 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 content_type 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. # overwrite property Whether to overwrite the local or remote file. ## Syntax ```text def get_overwrite() -> bool: ... def set_overwrite(value: bool) -> None: ... overwrite = property(get_overwrite, set_overwrite) ``` ## Default Value FALSE ## Remarks When calling [download_file](#download_file-method), this property determines if [local_file](#local_file-property) should be overwritten if it already exists. When calling [upload_file](#upload_file-method), this property determines if the remote file should be if it already exists. Note: This setting is not currently respected by the ShareFile service for file uploads. If the file has file versioning turned on it will retain the previous version. If the file versioning is turned off, the file will always be overwritten. # parsed_header_count property The number of records in the ParsedHeader arrays. ## Syntax ```text def get_parsed_header_count() -> int: ... parsed_header_count = property(get_parsed_header_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [parsed_header_field](#parsed_header_field-property) - [parsed_header_value](#parsed_header_value-property) The array indices start at *0* and end at *parsed_header_count - 1*. This property is read-only. # parsed_header_field property This property contains the name of the HTTP header (this is the same case as it is delivered). ## Syntax ```text def get_parsed_header_field(parsed_header_index: int) -> str: ... ``` ## Default Value "" ## Remarks This property contains the name of the HTTP [Header](#Type_Header) (this is the same case as it is delivered). The *parsed_header_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [parsed_header_count](#parsed_header_count-property) property. This property is read-only. # parsed_header_value property This property contains the header contents. ## Syntax ```text def get_parsed_header_value(parsed_header_index: int) -> str: ... ``` ## Default Value "" ## Remarks This property contains the [Header](#Type_Header) contents. The *parsed_header_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [parsed_header_count](#parsed_header_count-property) property. This property is read-only. # permission_count property The number of records in the Permission arrays. ## Syntax ```text def get_permission_count() -> int: ... def set_permission_count(value: int) -> None: ... permission_count = property(get_permission_count, set_permission_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [permission_can_delete](#permission_can_delete-property) - [permission_can_download](#permission_can_download-property) - [permission_can_manage_permissions](#permission_can_manage_permissions-property) - [permission_can_upload](#permission_can_upload-property) - [permission_can_view](#permission_can_view-property) - [permission_folder_id](#permission_folder_id-property) - [permission_is_owner](#permission_is_owner-property) - [permission_notify_on_download](#permission_notify_on_download-property) - [permission_notify_on_upload](#permission_notify_on_upload-property) - [permission_user_id](#permission_user_id-property) The array indices start at *0* and end at *permission_count - 1*. # permission_can_delete property If the user can delete the item or from the item. ## Syntax ```text def get_permission_can_delete(permission_index: int) -> bool: ... def set_permission_can_delete(permission_index: int, value: bool) -> None: ... ``` ## Default Value FALSE ## Remarks If the user can delete the item or from the item. This property defines whether the user can remove items from the item. To modify this property see [update_permission](#update_permission-method). The *permission_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [permission_count](#permission_count-property) property. # permission_can_download property If the user can read file content or download the item or from the item. ## Syntax ```text def get_permission_can_download(permission_index: int) -> bool: ... def set_permission_can_download(permission_index: int, value: bool) -> None: ... ``` ## Default Value TRUE ## Remarks If the user can read file content or download the item or from the item. This property defines whether the user can download or read from the item. To modify this property see [update_permission](#update_permission-method). The *permission_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [permission_count](#permission_count-property) property. # permission_can_manage_permissions property If the user can configure Access Controls in the item. ## Syntax ```text def get_permission_can_manage_permissions(permission_index: int) -> bool: ... def set_permission_can_manage_permissions(permission_index: int, value: bool) -> None: ... ``` ## Default Value FALSE ## Remarks If the user can configure Access Controls in the item. This property defines whether the user can configure Access Controls for the item. To modify this property see [update_permission](#update_permission-method). The *permission_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [permission_count](#permission_count-property) property. # permission_can_upload property Whether the user can upload files to the item. ## Syntax ```text def get_permission_can_upload(permission_index: int) -> bool: ... def set_permission_can_upload(permission_index: int, value: bool) -> None: ... ``` ## Default Value FALSE ## Remarks Whether the user can upload files to the item. This property defines whether the user can upload files to the item. To modify this property see [update_permission](#update_permission-method). The *permission_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [permission_count](#permission_count-property) property. # permission_can_view property If the user can view items from the item. ## Syntax ```text def get_permission_can_view(permission_index: int) -> bool: ... def set_permission_can_view(permission_index: int, value: bool) -> None: ... ``` ## Default Value TRUE ## Remarks If the user can view items from the item. This property defines whether the user can view items from this item. To modify this property see [update_permission](#update_permission-method). The *permission_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [permission_count](#permission_count-property) property. # permission_folder_id property The item id for the folder whose permissions are being defined. ## Syntax ```text def get_permission_folder_id(permission_index: int) -> str: ... ``` ## Default Value "" ## Remarks The item id for the folder whose permissions are being defined. This property specifies the item id for the folder whose permissions are being defined. It is required for this id to be of a folder type. The *permission_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [permission_count](#permission_count-property) property. This property is read-only. # permission_is_owner property If the user is the owner. ## Syntax ```text def get_permission_is_owner(permission_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks If the user is the owner. This property specifies if the user specified by the [permission_user_id](#permission_user_id-property) property is the owner of the item specified by the [permission_folder_id](#permission_folder_id-property) property. The *permission_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [permission_count](#permission_count-property) property. This property is read-only. # permission_notify_on_download property If the user is notified when the an item is downloaded from the folder. ## Syntax ```text def get_permission_notify_on_download(permission_index: int) -> bool: ... def set_permission_notify_on_download(permission_index: int, value: bool) -> None: ... ``` ## Default Value FALSE ## Remarks If the user is notified when the an item is downloaded from the folder. This property specifies if the user will be notified if an item is downloaded from the folder. To modify this property see [update_permission](#update_permission-method). The *permission_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [permission_count](#permission_count-property) property. # permission_notify_on_upload property If the user is notified when the an item is uploaded to the folder. ## Syntax ```text def get_permission_notify_on_upload(permission_index: int) -> bool: ... def set_permission_notify_on_upload(permission_index: int, value: bool) -> None: ... ``` ## Default Value FALSE ## Remarks If the user is notified when the an item is uploaded to the folder. This property specifies if the user will be notified if an item is uploaded to the folder. To modify this property see [update_permission](#update_permission-method). The *permission_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [permission_count](#permission_count-property) property. # permission_user_id property The user's ShareFile id. ## Syntax ```text def get_permission_user_id(permission_index: int) -> str: ... ``` ## Default Value "" ## Remarks The user's ShareFile id. This property specifies the user's user id that the permission is for. The *permission_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [permission_count](#permission_count-property) property. This property is read-only. # proxy_auth_scheme property The type of authorization to perform when connecting to the proxy. ## Syntax ```text def get_proxy_auth_scheme() -> int: ... def set_proxy_auth_scheme(value: int) -> None: ... proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme) ``` ## Possible Values ```text 0 # Basic1 # Digest2 # Proprietary3 # None4 # Ntlm5 # Negotiate ``` ## Default Value 0 ## Remarks The type of authorization to perform when connecting to the proxy. This is used only when the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are set. [proxy_auth_scheme](#proxy_auth_scheme-property) should be set to authNone (3) when no authentication is expected. By default, [proxy_auth_scheme](#proxy_auth_scheme-property) is authBasic (0), and if the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are set, the class will attempt basic authentication. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to authDigest (1), digest authentication will be attempted instead. If [proxy_auth_scheme](#proxy_auth_scheme-property) 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 [proxy_auth_scheme](#proxy_auth_scheme-property) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property). # proxy_auto_detect property Whether to automatically detect and use proxy system settings, if available. ## Syntax ```text def get_proxy_auto_detect() -> bool: ... def set_proxy_auto_detect(value: bool) -> None: ... proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect) ``` ## Default Value FALSE ## Remarks Whether to automatically detect and use proxy system settings, if available. The default value is *False*. # proxy_password property A password if authentication is to be used for the proxy. ## Syntax ```text def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ... proxy_password = property(get_proxy_password, set_proxy_password) ``` ## Default Value "" ## Remarks A password if authentication is to be used for the proxy. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Basic Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Digest Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to respond to the Digest Authentication challenge from the server. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to NTLM Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to authenticate through NTLM negotiation. # proxy_port property The Transmission Control Protocol (TCP) port for the proxy Server (default 80). ## Syntax ```text def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ... proxy_port = property(get_proxy_port, set_proxy_port) ``` ## Default Value 80 ## Remarks The Transmission Control Protocol (TCP) port for the proxy [proxy_server](#proxy_server-property) (default 80). See the description of the [proxy_server](#proxy_server-property) property for details. # proxy_server property If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. ## Syntax ```text def get_proxy_server() -> str: ... def set_proxy_server(value: str) -> None: ... proxy_server = property(get_proxy_server, set_proxy_server) ``` ## Default Value "" ## Remarks If a proxy [proxy_server](#proxy_server-property) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [proxy_server](#proxy_server-property) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [proxy_server](#proxy_server-property) property is set to the corresponding address. If the search is not successful, an error is returned. # proxy_ssl property When to use a Secure Sockets Layer (SSL) for the connection to the proxy. ## Syntax ```text def get_proxy_ssl() -> int: ... def set_proxy_ssl(value: int) -> None: ... proxy_ssl = property(get_proxy_ssl, set_proxy_ssl) ``` ## Possible Values ```text 0 # Automatic1 # Always2 # Never3 # Tunnel ``` ## Default Value 0 ## Remarks 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. | # proxy_user property A username if authentication is to be used for the proxy. ## Syntax ```text def get_proxy_user() -> str: ... def set_proxy_user(value: str) -> None: ... proxy_user = property(get_proxy_user, set_proxy_user) ``` ## Default Value "" ## Remarks A username if authentication is to be used for the proxy. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Basic Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Digest Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to respond to the Digest Authentication challenge from the server. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to NTLM Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to authenticate through NTLM negotiation. # query_param_count property The number of records in the QueryParam arrays. ## Syntax ```text def get_query_param_count() -> int: ... def set_query_param_count(value: int) -> None: ... query_param_count = property(get_query_param_count, set_query_param_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [query_param_name](#query_param_name-property) - [query_param_value](#query_param_value-property) The array indices start at *0* and end at *query_param_count - 1*. # query_param_name property The name of the query parameter. ## Syntax ```text def get_query_param_name(query_param_index: int) -> str: ... def set_query_param_name(query_param_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The name of the query parameter. This property specifies the name of the query parameter. The *query_param_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [query_param_count](#query_param_count-property) property. # query_param_value property The value of the query parameter. ## Syntax ```text def get_query_param_value(query_param_index: int) -> str: ... def set_query_param_value(query_param_index: int, value: str) -> None: ... ``` ## 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 *query_param_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [query_param_count](#query_param_count-property) property. # resume_url property The resumable upload URL. ## Syntax ```text def get_resume_url() -> str: ... def set_resume_url(value: str) -> None: ... resume_url = property(get_resume_url, set_resume_url) ``` ## Default Value "" ## Remarks This property holds the URL of the resumable upload session. This is populated by the class automatically when [use_resumable_upload](#use_resumable_upload-property) is set to *True* and [upload_file](#upload_file-method) is called to initiate a new upload. This must be set in order to resume an interrupted upload. See [upload_file](#upload_file-method) for details. # search_marker property A marker indicating the number of search results to skip next. ## Syntax ```text def get_search_marker() -> int: ... def set_search_marker(value: int) -> None: ... search_marker = property(get_search_marker, set_search_marker) ``` ## Default Value 0 ## Remarks This property will be populated when [search](#search-method) is called if the results are paged and there are more pages. To list all search results, continue to call [search](#search-method) until this property returns 0. Refer to [search](#search-method) for more information. Note: Currently, ShareFile does not support the search functionality. # ssl_accept_server_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_accept_server_cert_effective_date() -> str: ... ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. # ssl_accept_server_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_accept_server_cert_encoded() -> bytes: ... def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ... ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) properties also may be used to specify a certificate. When [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) is set, a search is initiated in the current [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) for the private key of the certificate. If the key is found, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) is set to an empty string. # ssl_accept_server_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_accept_server_cert_expiration_date() -> str: ... ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. # ssl_accept_server_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_accept_server_cert_extended_key_usage() -> str: ... ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. # ssl_accept_server_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint() -> str: ... ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. # ssl_accept_server_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ... ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. # ssl_accept_server_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ... ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. # ssl_accept_server_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_issuer() -> str: ... ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. # ssl_accept_server_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_accept_server_cert_private_key() -> str: ... ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) may be available but not exportable. In this case, [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) returns an empty string. This property is read-only. # ssl_accept_server_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_accept_server_cert_private_key_available() -> bool: ... ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) is available for the selected certificate. If [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_accept_server_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_accept_server_cert_private_key_container() -> str: ... ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_accept_server_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_public_key() -> str: ... ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # ssl_accept_server_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_accept_server_cert_public_key_algorithm() -> str: ... ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. # ssl_accept_server_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_accept_server_cert_public_key_length() -> int: ... ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. # ssl_accept_server_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_accept_server_cert_serial_number() -> str: ... ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. # ssl_accept_server_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_accept_server_cert_signature_algorithm() -> str: ... ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. # ssl_accept_server_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_accept_server_cert_store() -> bytes: ... def set_ssl_accept_server_cert_store(value: bytes) -> None: ... ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property). If the store is password-protected, specify the password in [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property). [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) is used in conjunction with the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) property to specify client certificates. If [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) has a value, and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) or [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). # ssl_accept_server_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_ssl_accept_server_cert_store_password() -> str: ... def set_ssl_accept_server_cert_store_password(value: str) -> None: ... ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password) ``` ## 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. # ssl_accept_server_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_accept_server_cert_store_type() -> int: ... def set_ssl_accept_server_cert_store_type(value: int) -> None: ... ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property), and the PIN as the [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) and set [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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. | # ssl_accept_server_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_accept_server_cert_subject() -> str: ... def set_ssl_accept_server_cert_subject(value: str) -> None: ... ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.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. # ssl_accept_server_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_accept_server_cert_subject_alt_names() -> str: ... ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_accept_server_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_md5() -> str: ... ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_accept_server_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ... ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_accept_server_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ... ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_accept_server_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_accept_server_cert_usage() -> str: ... ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. # ssl_accept_server_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_accept_server_cert_usage_flags() -> int: ... ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property) 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 [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property) property for a text representation of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_accept_server_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_accept_server_cert_version() -> str: ... ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # ssl_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_cert_effective_date() -> str: ... ssl_cert_effective_date = property(get_ssl_cert_effective_date, None) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. # ssl_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ... ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_cert_store](#ssl_cert_store-property) and [ssl_cert_subject](#ssl_cert_subject-property) properties also may be used to specify a certificate. When [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property) is set to an empty string. # ssl_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_cert_expiration_date() -> str: ... ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. # ssl_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_cert_extended_key_usage() -> str: ... ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. # ssl_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint() -> str: ... ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. # ssl_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint_sha1() -> str: ... ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. # ssl_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint_sha256() -> str: ... ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. # ssl_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_cert_issuer() -> str: ... ssl_cert_issuer = property(get_ssl_cert_issuer, None) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. # ssl_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_cert_private_key() -> str: ... ssl_cert_private_key = property(get_ssl_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ssl_cert_private_key](#ssl_cert_private_key-property) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property) returns an empty string. This property is read-only. # ssl_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_cert_private_key_available() -> bool: ... ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_cert_private_key](#ssl_cert_private_key-property) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_cert_private_key_container() -> str: ... ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_cert_private_key](#ssl_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_cert_public_key() -> str: ... ssl_cert_public_key = property(get_ssl_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # ssl_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_cert_public_key_algorithm() -> str: ... ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. # ssl_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_cert_public_key_length() -> int: ... ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. # ssl_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_cert_serial_number() -> str: ... ssl_cert_serial_number = property(get_ssl_cert_serial_number, None) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. # ssl_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_cert_signature_algorithm() -> str: ... ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. # ssl_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ... ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_cert_store_type](#ssl_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property). [ssl_cert_store](#ssl_cert_store-property) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property) has a value, and [ssl_cert_subject](#ssl_cert_subject-property) or [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property) 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). # ssl_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ... ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password) ``` ## 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. # ssl_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ... ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_cert_store_type](#ssl_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_cert_store](#ssl_cert_store-property) and set [ssl_cert_store_password](#ssl_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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. | # ssl_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ... ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.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. # ssl_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_cert_subject_alt_names() -> str: ... ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_md5() -> str: ... ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_sha1() -> str: ... ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_sha256() -> str: ... ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_cert_usage() -> str: ... ssl_cert_usage = property(get_ssl_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. # ssl_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_cert_usage_flags() -> int: ... ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property) 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 [ssl_cert_usage](#ssl_cert_usage-property) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_cert_version() -> str: ... ssl_cert_version = property(get_ssl_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # ssl_provider property The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text def get_ssl_provider() -> int: ... def set_ssl_provider(value: int) -> None: ... ssl_provider = property(get_ssl_provider, set_ssl_provider) ``` ## Possible Values ```text 0 # Automatic1 # Platform2 # Internal ``` ## 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. | **Additional Notes** 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](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. # ssl_server_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_server_cert_effective_date() -> str: ... ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. # ssl_server_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_server_cert_encoded() -> bytes: ... ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_server_cert_store](#ssl_server_cert_store-property) and [ssl_server_cert_subject](#ssl_server_cert_subject-property) properties also may be used to specify a certificate. When [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) is set, a search is initiated in the current [ssl_server_cert_store](#ssl_server_cert_store-property) for the private key of the certificate. If the key is found, [ssl_server_cert_subject](#ssl_server_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_server_cert_subject](#ssl_server_cert_subject-property) is set to an empty string. This property is read-only. # ssl_server_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_server_cert_expiration_date() -> str: ... ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. # ssl_server_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_server_cert_extended_key_usage() -> str: ... ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. # ssl_server_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_server_cert_fingerprint() -> str: ... ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. # ssl_server_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_server_cert_fingerprint_sha1() -> str: ... ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. # ssl_server_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_server_cert_fingerprint_sha256() -> str: ... ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. # ssl_server_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_server_cert_issuer() -> str: ... ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. # ssl_server_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_server_cert_private_key() -> str: ... ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) may be available but not exportable. In this case, [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) returns an empty string. This property is read-only. # ssl_server_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_server_cert_private_key_available() -> bool: ... ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) is available for the selected certificate. If [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_server_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_server_cert_private_key_container() -> str: ... ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_server_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_server_cert_public_key() -> str: ... ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # ssl_server_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_server_cert_public_key_algorithm() -> str: ... ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. # ssl_server_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_server_cert_public_key_length() -> int: ... ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. # ssl_server_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_server_cert_serial_number() -> str: ... ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. # ssl_server_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_server_cert_signature_algorithm() -> str: ... ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. # ssl_server_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_server_cert_store() -> bytes: ... ssl_server_cert_store = property(get_ssl_server_cert_store, None) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_server_cert_store_type](#ssl_server_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_server_cert_store](#ssl_server_cert_store-property). If the store is password-protected, specify the password in [ssl_server_cert_store_password](#ssl_server_cert_store_password-property). [ssl_server_cert_store](#ssl_server_cert_store-property) is used in conjunction with the [ssl_server_cert_subject](#ssl_server_cert_subject-property) property to specify client certificates. If [ssl_server_cert_store](#ssl_server_cert_store-property) has a value, and [ssl_server_cert_subject](#ssl_server_cert_subject-property) or [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_server_cert_subject](#ssl_server_cert_subject-property) 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). This property is read-only. # ssl_server_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_ssl_server_cert_store_password() -> str: ... ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None) ``` ## 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. # ssl_server_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_server_cert_store_type() -> int: ... ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_server_cert_store_type](#ssl_server_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_server_cert_store](#ssl_server_cert_store-property), and the PIN as the [ssl_server_cert_store_password](#ssl_server_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_server_cert_store](#ssl_server_cert_store-property) and set [ssl_server_cert_store_password](#ssl_server_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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. # ssl_server_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_server_cert_subject() -> str: ... ssl_server_cert_subject = property(get_ssl_server_cert_subject, None) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.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. # ssl_server_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_server_cert_subject_alt_names() -> str: ... ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_server_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_server_cert_thumbprint_md5() -> str: ... ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_server_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_server_cert_thumbprint_sha1() -> str: ... ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_server_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_server_cert_thumbprint_sha256() -> str: ... ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_server_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_server_cert_usage() -> str: ... ssl_server_cert_usage = property(get_ssl_server_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. # ssl_server_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_server_cert_usage_flags() -> int: ... ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property) 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 [ssl_server_cert_usage](#ssl_server_cert_usage-property) property for a text representation of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_server_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_server_cert_version() -> str: ... ssl_server_cert_version = property(get_ssl_server_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # start_byte property The byte offset from which to start the upload or download. ## Syntax ```text def get_start_byte() -> int: ... def set_start_byte(value: int) -> None: ... start_byte = property(get_start_byte, set_start_byte) ``` ## Default Value 0 ## Remarks This property may be set to resume an upload or download; it specifies the offset in the file from which to resume. See [upload_file](#upload_file-method) and [download_file](#download_file-method) for details about resuming uploads and downloads. # timeout property The timeout for the class. ## Syntax ```text def get_timeout() -> int: ... def set_timeout(value: int) -> None: ... timeout = property(get_timeout, set_timeout) ``` ## 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 do_events 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. # user_count property The number of records in the User arrays. ## Syntax ```text def get_user_count() -> int: ... def set_user_count(value: int) -> None: ... user_count = property(get_user_count, set_user_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [user_company](#user_company-property) - [user_creation_date](#user_creation_date-property) - [user_email](#user_email-property) - [user_first_name](#user_first_name-property) - [user_id](#user_id-property) - [user_last_name](#user_last_name-property) The array indices start at *0* and end at *user_count - 1*. # user_company property The company of the user. ## Syntax ```text def get_user_company(user_index: int) -> str: ... def set_user_company(user_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The company of the user. This property specifies the company of the user. This is an optional field. To modify this property see [update_client](#update_client-method). The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # user_creation_date property The date the user was created. ## Syntax ```text def get_user_creation_date(user_index: int) -> str: ... ``` ## Default Value "" ## Remarks The date the user was created. This property specifies the creation date of the user. Dates are formatted according to ISO 8601 and are always in UTC time. The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. This property is read-only. # user_email property The email address of the user. ## Syntax ```text def get_user_email(user_index: int) -> str: ... def set_user_email(user_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The email address of the user. This property specifies the email address of the user. To modify this property see [update_client](#update_client-method). The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # user_first_name property The first name of the user. ## Syntax ```text def get_user_first_name(user_index: int) -> str: ... def set_user_first_name(user_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The first name of the user. This property specifies the first name of the user. To modify this property see [update_client](#update_client-method). The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # user_id property The id of the user. ## Syntax ```text def get_user_id(user_index: int) -> str: ... ``` ## Default Value "" ## Remarks The id of the user. This property specifies the id of the user. The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. This property is read-only. # user_last_name property The last name of the user. ## Syntax ```text def get_user_last_name(user_index: int) -> str: ... def set_user_last_name(user_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The last name of the user. This property specifies the last name of the user. To modify this property see [update_client](#update_client-method). The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # use_resumable_upload property Whether to use resumable uploads. ## Syntax ```text def get_use_resumable_upload() -> bool: ... def set_use_resumable_upload(value: bool) -> None: ... use_resumable_upload = property(get_use_resumable_upload, set_use_resumable_upload) ``` ## Default Value FALSE ## Remarks This property controls whether simple or resumable uploads are used when [upload_file](#upload_file-method) is called. The default value is *False* (simple uploads are used). Refer to [upload_file](#upload_file-method) for more information. # add_query_param method Adds a query parameter to the QueryParams properties. ## Syntax ```text def add_query_param(name: str, value: str) -> None: ... ``` ## Remarks This method is used to add a query parameter to the query_params properties. *Name* specifies the name of the parameter, and *Value* specifies the value of the parameter. All specified *Value*s will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters. # authorize method Get the authorization string required to access the protected resource. ## Syntax ```text def authorize() -> None: ... ``` ## Remarks This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the [o_auth_client_profile](#o_auth_client_profile-property) property and the [o_auth_grant_type](#o_auth_grant_type-property) property. This method is **not** to be used in conjunction with the [authorization](#authorization-property) property. It should instead be used when setting the o_auth property. For more information, see the introduction section. # config method Sets or retrieves a configuration setting. ## Syntax ```text def config(configuration_string: str) -> str: ... ``` ## Remarks config is a generic method available in every class. It is used to set and retrieve [configuration settings](#sharefile-config-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](#sharefile-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # copy_item method Copies the specified item into the specified directory. ## Syntax ```text def copy_item(item_id: str, parent_id: str) -> str: ... ``` ## Remarks This method copies the file identified by *ItemId* to the directory specified by *ParentId* and returns the Id of the newly created copy. Must call [list_items](#list_items-method) or [get_item_info](#get_item_info-method) before the items properties will be updated with the copied item. Note that the string *root* may be used as a *ParentId* to represent the root folder, and the string *home* may be used as a folder Id to represent the home folder for the current user. Other special id's include: - *favorites* - *allshared* - *connectors* - *box* - *top* ```text // Creates an item in a folder called Parent 1 and copies it to a folder called Parent 2. string ParentId1 = shareFile.CreateFolder("Parent 1", "home"); string ParentId2 = shareFile.CreateFolder("Parent 2", "home"); string ItemId = shareFile.UploadFile("Test.txt", ParentId1); string NewId = ShareFile.CopyItem(ItemId, ParentId2); ``` # create_and_email_link method Creates a link for specified items and emails it. ## Syntax ```text def create_and_email_link(item_ids: str, emails: str, subject: str, note: str) -> str: ... ``` ## Remarks This method will create a new link. The method will then fire the [on_link_list](#on_link_list-event) event, and will populate the links properties (clearing any previously-held items in the process) with the new link. After doing so it will also send the emails with the new link. *ItemIds* should be specified as a comma-separated list of one or more item Ids. *emails* is a comma separated list of emails. *subject* is the subject of the email that is sent out. *note* is added as a note within the body of the email. create_link_options property can be used to specify the different options for the newly created link. Note that the string *root* may be used as a *ItemIds* to represent the root folder, and the string *home* may be used as a folder Id to represent the home folder for the current user. Other special id's include: - *favorites* - *allshared* - *connectors* - *box* - *top* ```text // Creates a folder, places two files into the folder, and creates/emails a link to download the two files. string ParentId = shareFile.CreateFolder(name, "home"); shareFile.LocalFile = "./test.txt"; string id1 = shareFile.UploadFile("test.txt", ParentId); shareFile.LocalFile = "./test_data.zip"; string id2 = shareFile.UploadFile("test_data.zip", ParentId); string link = shareFile.CreateAndEmailLink(id1 + "," + id2, example@example.com, "ShareFile Download Link", ""); ``` # create_and_email_request_link method Creates a new request link and emails it to the specified emails. ## Syntax ```text def create_and_email_request_link(folder_id: str, emails: str, subject: str, note: str) -> str: ... ``` ## Remarks This method will create a new request link. The method will then fire the [on_link_list](#on_link_list-event) event, and will populate the links properties (clearing any previously-held items in the process) with the new request link. After doing so it will also send the emails with the new request link. *FolderId* is the ID of the directory where the files will be uploaded in ShareFile. *emails* is a comma separated list of emails. *subject* is the subject of the email that is sent out. *note* id added as a note within the body of the email. The create_link_options property can be used to specify the different options for the newly created link. Note that the string *root* may be used as a *FolderId* to represent the root folder, and the string *home* may be used as a folder Id to represent the home folder for the current user. Other special id's include: - *favorites* - *allshared* - *connectors* - *box* - *top* ```text string FolderId = shareFile.CreateFolder("Incoming Files", "home"); string Link = shareFile.CreateAndEmailRequestLink(FolderId, example@example.com, "ShareFile Request", ""); ``` # create_client method Creates a new client. ## Syntax ```text def create_client(first_name: str, last_name: str, email: str, company: str) -> str: ... ``` ## Remarks Creates a new client user and returns the new client id as a string. The users properties will not be updated with the new client until the [list_users](#list_users-method) or [get_user_info](#get_user_info-method) methods are called. *FirstName*, *LastName*, and *Email* are required to create a client. *Company* can be left empty. ```text // Creates a client named John Brown, with the email example@example.com with no company. string userId = shareFile.CreateClient("John", "Brown", "example@example.com", ""); ``` # create_folder method Creates a new folder. ## Syntax ```text def create_folder(name: str, parent_id: str) -> str: ... ``` ## Remarks Creates a new folder and returns the new folder's itemId as a string. Must call [list_items](#list_items-method) or [get_item_info](#get_item_info-method) before the items properties will be updated with the new folder. *Name* is the name of the folder. *ParentId* is the id of the parent folder to the newly-created folder. Note that the string *root* may be used as a folder Id to represent the root folder, and the string *home* may be used as a folder Id to represent the home folder for the current user. Other special id's include: - *favorites* - *allshared* - *connectors* - *box* - *top* ```text // Creates a folder named parentFolder in the home directory for the authenticated user string parentId = shareFile.CreateFolder("parentFolder", "home"); // Creates a child folder in the parentFolder. string childId = shareFile.CreateFolder("childFolder", parentId); ``` # create_link method Creates a new link for specified items. ## Syntax ```text def create_link(item_ids: str) -> str: ... ``` ## Remarks This method will create a new link. The method will then fire the [on_link_list](#on_link_list-event) event, and will populate the links properties (clearing any previously-held items in the process) with the new link. *ItemIds* should be specified as a comma-separated list of one or more item Ids. The create_link_options property can be used to specify the different options for the newly created link. Note that the string *root* may be used as a *ItemIds* to represent the root folder, and the string *home* may be used as a folder Id to represent the home folder for the current user. Other special id's include: - *favorites* - *allshared* - *connectors* - *box* - *top* ```text // Creates a folder, places two files into the folder, and creates a link to download the two files. string ParentId = shareFile.CreateFolder(name, "home"); shareFile.LocalFile = "./test.txt"; string id1 = shareFile.UploadFile("test.txt", ParentId); shareFile.LocalFile = "./test_data.zip"; string id2 = shareFile.UploadFile("test_data.zip", ParentId); string link = shareFile.CreateLink(id1 + "," + id2); ``` # create_permission method Create a new Permissions for the specified folder and user. ## Syntax ```text def create_permission(folder_id: str, user_id: str, recursive: bool) -> None: ... ``` ## Remarks Creates a new permission for a specified folder and user. The permissions properties will not be updated with the new permission until the [list_permissions](#list_permissions-method) or [get_permission_info](#get_permission_info-method) methods are called. *FolderId* is the id of the folder to add the permission to. *UserId* is the id of the user who will be getting the new permission. *Recursive* is to true when the user needs permission for all sub-folders within the specified folder. The create_permission_options property can be used to specify the different options for the newly created permission. The [CreatePermissionNotify](#CreatePermissionNotify) and [CreatePermissionNotifyMessage](#CreatePermissionNotifyMessage) configurations can be used to notify the user at the email set in the ShareFilePermission type. ```text string FolderId = shareFile.CreateFolder("test", "home"); string UserId = CreateUser("First", "Last", example@example.com, "company"); shareFile.Config("CreatePermissionNotify=True"); shareFile.Config("CreatePermissionNotifyMessage=CreatePermissionNotifyConfigTest"); shareFile.CreatePermission(FolderId, UserId, true); ``` # create_request_link method Creates a new request link. ## Syntax ```text def create_request_link(folder_id: str) -> str: ... ``` ## Remarks This method will create a new request link. The method will then fire the [on_link_list](#on_link_list-event) event, and will populate the links properties (clearing any previously-held items in the process) with the new request link. It will also return the new request link as a string. *FolderId* is the ID for the directory where the files will be uploaded in ShareFile. The create_link_options property can be used to specify the different options for the newly created link. Note that the string *root* may be used as a *FolderId* to represent the root folder, and the string *home* may be used as a folder Id to represent the home folder for the current user. Other special id's include: - *favorites* - *allshared* - *connectors* - *box* - *top* ```text string FolderId = shareFile.CreateFolder("Incoming Folder", "home"); string Link = shareFile.CreateRequestLink(FolderId); ``` # delete_child_items method Removes multiple items from a parent item. ## Syntax ```text def delete_child_items(parent_id: str, item_ids: str) -> None: ... ``` ## Remarks This method deletes multiple files or folders specified by ItemIds permanently. *ParentId* is the id of the parent item that contains the items that should be deleted. *ItemIds* is a comma separated list of ItemIds that are going to be deleted permanently. The items **must** be a child to the specified parent. Note that the string *root* may be used as a *ParentId* to represent the root folder, and the string *home* may be used as a folder Id to represent the home folder for the current user. Other special id's include: - *favorites* - *allshared* - *connectors* - *box* - *top* ```text string ParentId = shareFile.CreateFolder(test, "home"); shareFile.LocalFile = "./test1.txt"; string fileId1 = shareFile.UploadFile("test1.txt", dirId); shareFile.LocalFile = "./test2.txt"; string fileId2 = shareFile.UploadFile("test2.txt", dirId); shareFile.DeleteChildItems(ParentId, fileId1 + "," + fileId2); ``` # delete_client method Deletes a client from the user list. ## Syntax ```text def delete_client(user_id: str) -> None: ... ``` ## Remarks Deletes a client from the user list. Must call [list_users](#list_users-method) before the users properties will be updated. *UserId* is the id for the user that is going to be deleted. ```text // Deletes the first user. shareFile.ListUsers(); string UserId = shareFile.Users[0].Id; shareFile.DeleteClient(UserId); ``` # delete_item method Deletes an item permanently. ## Syntax ```text def delete_item(item_id: str) -> None: ... ``` ## Remarks This method deletes the item specified by *ItemId* permanently. Must call [list_items](#list_items-method) before the items properties property will be updated. ```text // Deletes the first item. shareFile.ListItems(); string ItemId = shareFile.Items[0].Id; shareFile.DeleteItem(ItemId); ``` # delete_link method Deletes the link specified by the LinkId. ## Syntax ```text def delete_link(link_id: str) -> None: ... ``` ## Remarks Deletes the link specified by the *LinkId* permanently. The links properties will not be updated until the [list_links](#list_links-method) method is called. ```text // Deletes the first link. shareFile.ListLinks(); string LinkId = shareFile.Link[0].Id; shareFile.DeleteLink(LinkId); ``` # delete_permission method Removes a users permissions for a specific folder. ## Syntax ```text def delete_permission(folder_id: str, user_id: str) -> None: ... ``` ## Remarks The method will remove a users permission for a specific folder. *FolderId* is the id of the folder that is having its permissions changed. *UserId* is the ID of the user that is getting permissions removed for the folder. Once the method is complete, the [list_permissions](#list_permissions-method) method must be called to update the permissions properties. ```text // Deletes the first permission. shareFile.ListPermissions(); string FolderId = shareFile.Link[0].FolderId; string UserId = shareFile.Link[0].UserId; shareFile.DeleteLink(FolderId, UserId); ``` # download_file method This method downloads the file or the contents of the folder specified by the ItemId. ## Syntax ```text def download_file(item_id: str) -> None: ... ``` ## Remarks The method will download the item specified by the *ItemId*. If [local_file](#local_file-property) is set, the file or folder will be saved to the specified location. Otherwise, the class will use the data from the [item_data](#item_data-property) property; If the item is a directory, it will download the contents (recursively) of the directory as a ZIP file. Note that the string *root* may be used as a *FolderId* to represent the root folder, and the string *home* may be used as a folder Id to represent the home folder for the current user. Other special id's include: - *favorites* - *allshared* - *connectors* - *box* - *top* ### Name Conflict Resolution If the [overwrite](#overwrite-property) property is set to true, then the class will overwrite a file if one is found at the location specified by the [local_file](#local_file-property) property. If it is set to false, then the class will throw an error if it finds a collision. If [local_file](#local_file-property) is set, the file will be saved to the specified location; otherwise, the file data will be held by [item_data](#item_data-property). To download and decrypt an encrypted file, set [encryption_algorithm](#encryption_algorithm-property) and [encryption_password](#encryption_password-property) before calling this method. ### Download Notes **Simple Download** A simple download is consistent with setting the [local_file](#local_file-property) to the destination of the file when it is downloaded and then calling the method with the item's id. For example: ```text shareFile.LocalFile = "../MyFile.zip"; shareFile.DownloadFile(shareFile.Items[0].Id); ``` # get_item_info method Gets information about a specific item. ## Syntax ```text def get_item_info(item_id: str) -> None: ... ``` ## Remarks Calling this method will fire the [on_item_list](#on_item_list-event) event, and will populate the items properties (clearing any previously-held items in the process) *ItemId* is the id of the items that the class will get the information for. If the method is supplied a path (e.g. "/parentFolder/ChildFolder") then the class will use the path to get the item information. **Passing an ID** ```text string dirId = shareFile.CreateFolder("NewFolder", "home"); shareFile.GetItemInfo(dirId); ``` **Passing a path** ```text string dirId = shareFile.CreateFolder("NewFolder", "allshared"); shareFile.GetItemInfo("/NewFolder"); ``` # get_link_info method Gets information about a specific link. ## Syntax ```text def get_link_info(link_id: str) -> None: ... ``` ## Remarks Calling this method will fire the [on_link_list](#on_link_list-event) event, and will populate the links properties (clearing any previously-held items in the process). *LinkId* is the id for the link that the class will get the information for. ```text string linkId = shareFile.Links[0].Id; shareFile.GetLinkInfo(linkId); ``` # get_permission_info method Gets information about a specific user's permission for a folder. ## Syntax ```text def get_permission_info(folder_id: str, user_id: str) -> None: ... ``` ## Remarks Calling this method will fire the [on_permission_list](#on_permission_list-event) event, and will populate the permissions properties (clearing any previously-held items in the process). *FolderId* is the item Id for the folder and *UserId* is the user Id for the user. ```text string userId = shareFile.Users[0]; string folderId = shareFile.Items[0]; shareFile.GetPermissionInfo(folderId, userId); ``` # get_user_info method Gets information about a specific user. ## Syntax ```text def get_user_info(user_id: str) -> None: ... ``` ## Remarks This method can accept the Id of a user, or the user's email through the *UserId* property. Calling this method will fire the [on_user_list](#on_user_list-event) event once for the user, and will populate the users properties (clearing any previously-held items in the process). ```text string userId = shareFile.Users.Id; shareFile.getUserInfo(userId); ``` # interrupt method This method interrupts the current method. ## Syntax ```text def interrupt() -> None: ... ``` ## Remarks If there is no method in progress, interrupt simply returns, doing nothing. # list_items method Lists the files and folders within a folder. ## Syntax ```text def list_items(folder_id: str) -> None: ... ``` ## Remarks The method takes a string *FolderId* which represents the ID of the folder that the class will list from. Calling this method will fire the [on_item_list](#on_item_list-event) event once for each item, and will also populate the items properties (clearing any previously-held items in the process). Note that the string *root* may be used as a *FolderId* to represent the root folder, and the string *home* may be used as a folder Id to represent the home folder for the current user. Other special id's include: - *favorites* - *allshared* - *connectors* - *box* - *top* ```text string folderId = shareFile.Items[0].Id; shareFile.ListItems(folderId) // or shareFile.ListItems("home"); ``` # list_link_items method Lists the files and folders of a link. ## Syntax ```text def list_link_items(link_id: str) -> None: ... ``` ## Remarks Lists the items contained within the link. Calling this method will fire the [on_item_list](#on_item_list-event) event once for each item, and will also populate the items properties (clearing any previously-held items in the process). The items listed are not listed recursively. To get the items contained within folder items, further calls can be done using the [list_items](#list_items-method) method. ```text string linkId = shareFile.Links[0].Id; shareFile.ListLinkItems(linkId); ``` # list_links method Lists the request/download links for the currently authenticated user. ## Syntax ```text def list_links() -> None: ... ``` ## Remarks The method will list the request/download links for currently authenticated user. Calling this method will fire the [on_link_list](#on_link_list-event) event once for each link, and will also populate the links properties. Calling this method won't return the items of a link, but [list_link_items](#list_link_items-method) can be used to get the items of the link. # list_permissions method Lists the permissions of a folder. ## Syntax ```text def list_permissions(folder_id: str) -> None: ... ``` ## Remarks The method will list the permissions of a folder defined by the *FolderId* parameter. Calling this method will fire the [on_permission_list](#on_permission_list-event) event once for each permission, and will also populate the permissions properties. ```text string FolderId = shareFile.Items[0].Id; shareFile.ListPermissions(FolderId); ``` # list_users method Lists the client users of the authenticated account. ## Syntax ```text def list_users() -> None: ... ``` ## Remarks Calling this method will fire the [on_user_list](#on_user_list-event) event once for each client user, and will also populate the users properties. # move_item method Moves an item to a different folder. ## Syntax ```text def move_item(item_id: str, parent_id: str, new_name: str) -> None: ... ``` ## Remarks This method will move the item, specified by the *ItemId* string, and moves it to a new folder, specified by the *ParentId*. *NewName* specifies the new name of the item; if empty, the item's original name is used. Note that the string *root* may be used as a *ParentId* to represent the root folder, and the string *home* may be used as a folder Id to represent the home folder for the current user. Other special id's include: - *favorites* - *allshared* - *connectors* - *box* - *top* ```text // Creates an item in a folder called Parent 1 and moves it to a folder called Parent 2 with the new name MovedTest.txt. string ParentId1 = shareFile.CreateFolder("Parent 1", "home"); string ParentId2 = shareFile.CreateFolder("Parent 2", "home"); string ItemId = shareFile.UploadFile("Test.txt", ParentId1); ShareFile.MoveItem(ItemId, ParentId2, "MovedTest.txt"); ``` # reset method Resets the class to its initial state. ## Syntax ```text def reset() -> None: ... ``` ## Remarks This method resets the class to its initial state. # search method Searches for items that match the specified query. ## Syntax ```text def search(query: str) -> None: ... ``` ## Remarks This method searches for items that match the given *Query* parameter. Calling this method will fire the [on_item_list](#on_item_list-event) event once for each item, and will also populate the items properties (clearing any previously-held items in the process). As a note, this method makes a request to the simple search endpoint, rather than the advanced search endpoint. ```text shareFile.Search("Test.txt"); ``` # send_custom_request method Sends a custom request to the ShareFile API. ## Syntax ```text def send_custom_request(http_method: str, request_path: str, request_body: str) -> None: ... ``` ## Remarks This method can be used to send arbitrary requests to the ShareFile API. Valid values for *HttpMethod* are: - *GET* (default if empty) - *HEAD* - *POST* - *PUT* - *PATCH* - *DELETE* ### Usage When this method is called, the class does the following: 1. Builds a request URL, including query parameters, as follows: - The specified *RequestPath* is appended to the ShareFile API's stable endpoint, *https://[SUBDOMAIN].sf-api.com/sf/v3*. - All query parameters in the query_params properties are added to the request URL. 2. Sends the request using the specified *HttpMethod*, the request URL build in step 1, the header information held by [Authorization](#Authorization) and [OtherHeaders](#OtherHeaders), and the given *RequestBody* (if non-empty). 3. Stores the response headers in the parsed_headers properties, and the response body in the specified [local_file](#local_file-property) (using the same logic as [download_file](#download_file-method)). If the response body is JSON data, the [XPath](#XPath), [XText](#XText), and other **X*** configuration settings can then be used to navigate and extract information from it. # update_client method Updates a client's information. ## Syntax ```text def update_client(user_id: str, first_name: str, last_name: str, email: str, company: str) -> None: ... ``` ## Remarks Updates a clients first name, last name, email, and/or company. *UserId* represents the string Id for the client that will be updated. *FirstName*, *LastName*, *Email*, and *Company* each represents the update value for their corresponding ShareFileUser field. Passing an empty string for *FirstName*, *LastName*, *Email*, or *Company* will mean that the field will not be updated. ```text // Creates a client named FirstName Brown, with the email example@example.com with no company. string userId = shareFile.CreateClient("FirstName", "Brown", "example@example.com", ""); // Updates the First name of the client to John and sets a company, leave everything else the same. shareFile.UpdateClient(userId, "John", "", "", "company"); ``` # update_item_info method Updates an item with new information. ## Syntax ```text def update_item_info(item_id: str) -> None: ... ``` ## Remarks This method updates the item information for an item identified by *ItemId*. The item should be in the items properties and should be modified from there. The following properties can be updated from the ShareFileItem type: - Description - ExpirationTime - Name - ParentId Note that the string *root* may be used as a *ParentId* to represent the root folder, and the string *home* may be used as a folder Id to represent the home folder for the current user. Other special id's include: - *home* - *favorites* - *allshared* - *connectors* - *box* - *top*. ```text ShareFile.Items[0].Description = "New Description"; ShareFile.Items[0].ExpirationDate = "2099-01-01T00:00:00Z"; ShareFile.Items[0].Name = "New_Name.txt"; ShareFile.Items[0].ParentId = ShareFile.Items[1].Id; ShareFile.UpdateItemInfo(ShareFile.Items[0].Id); ``` # update_link method Updates a request or download link. ## Syntax ```text def update_link(link_id: str) -> None: ... ``` ## Remarks This method updates the link information for a link identified by *LinkId*. The the class requires the link to be in the links properties and be modified from there. The following properties can be updated from the ShareFileLink type: - ExpirationDate - MaxDownloads - Name - RequireLogin - Title ```text // Updates a link to require login. shareFile.Links[1].RequireLogin = true; shareFile.UpdateLink(shareFile.Links[1].Id); ``` # update_permission method Updates the permission from the Permissions properties. ## Syntax ```text def update_permission(index: int, recursive: bool) -> None: ... ``` ## Remarks The permission at *Index* in the permissions properties will be updated. The following properties can be updated from the ShareFilePermission type: - CanDelete - CanDownload - CanManagePermissions - CanUpload - CanView - NotifyOnDownload - NotifyOnUpload ```text // Updates permission so that the user does not have permission to download from the folder. shareFile.Permissions[1].CanDownload = false; shareFile.UpdatePermission(1, true); ``` # upload_file method Will upload a file to a folder. ## Syntax ```text def upload_file(file_name: str, parent_id: str) -> str: ... ``` ## Remarks The method when called will upload a file specified in the [local_file](#local_file-property) property. If [local_file](#local_file-property) has not been set then the class will use the data found in the [item_data](#item_data-property) property; The file will be uploaded to the folder specified by the *ParentId* parameter. The name of the file will be what is passed to the *FileName* parameter. Once it has completed uploading it will return the id of the uploaded file. Note that the string *root* may be used as a *ParentId* to represent the root folder, and the string *home* may be used as a folder Id to represent the home folder for the current user. Other special id's include: - *favorites* - *allshared* - *connectors* - *box* - *top* ### Name Conflict Resolution The class will overwrite a file if a file is uploaded to the same folder with the same name. If [local_file](#local_file-property) is set the file will be uploaded from the specified path. If [local_file](#local_file-property) is not set the data in [item_data](#item_data-property) will be used. To encrypt the file before uploading it, set [encryption_algorithm](#encryption_algorithm-property) and [encryption_password](#encryption_password-property). ### Upload Notes ShareFile offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted. **Simple** By default the class uses the simple upload mechanism. ```text ShareFile.LocalFile = "../MyFile.zip"; ShareFile.UploadFile("/MyFile.zip"); ``` **Resumable** To enable resumable uploads set [use_resumable_upload](#use_resumable_upload-property) to *True*. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually. When [use_resumable_upload](#use_resumable_upload-property) is set to *True* and upload_file is called, a resumable upload session is started by the class. Once called and the class fragments the file, the [resume_url](#resume_url-property) property is populated. This URL needs to be set so that the class can resume the upload if the upload is interrupted. During a resumable upload, the [on_fragment_complete](#on_fragment_complete-event) event fires after each fragment is uploaded to indicate overall progress. The class also updates [start_byte](#start_byte-property) as necessary to indicate the current offset in the file. If the upload is interrupted for any reason, resuming it is easy. First, verify that [resume_url](#resume_url-property) and [start_byte](#start_byte-property) are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). Then call upload_file again to resume the upload at the specified [start_byte](#start_byte-property) offset. Note that if the upload is not resumed after some time the upload session will expire. ```text shareFile.UseResumableUpload = true; shareFile.LocalFile = "../MyFile.zip"; shareFile.UploadFile("MyFile.zip"); // The transfer is interrupted and UploadFile() above fails. Later, resume the download. // Using the same instance StartByte and ResumeURL are already populated from the previous // upload attempt. shareFile.UploadFile("MyFile.zip"); ``` # on_end_transfer event Fired when a document finishes transferring. ## Syntax ```text class ShareFileEndTransferEventParams(object): @property def direction() -> int: ... # In class ShareFile: @property def on_end_transfer() -> Callable[[ShareFileEndTransferEventParams], None]: ... @on_end_transfer.setter def on_end_transfer(event_hook: Callable[[ShareFileEndTransferEventParams], None]) -> None: ... ``` ## Remarks This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then 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. # on_error event Fired when information is available about errors during data delivery. ## Syntax ```text class ShareFileErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class ShareFile: @property def on_error() -> Callable[[ShareFileErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[ShareFileErrorEventParams], None]) -> None: ... ``` ## Remarks The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error. The *error_code* 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](#sharefile-errors) section. # on_fragment_complete event Fires after each fragment of a resumable upload is completed. ## Syntax ```text class ShareFileFragmentCompleteEventParams(object): @property def fragment_number() -> int: ... @property def fragment_count() -> int: ... @property def interrupt() -> bool: ... @interrupt.setter def interrupt(value) -> None: ... # In class ShareFile: @property def on_fragment_complete() -> Callable[[ShareFileFragmentCompleteEventParams], None]: ... @on_fragment_complete.setter def on_fragment_complete(event_hook: Callable[[ShareFileFragmentCompleteEventParams], None]) -> None: ... ``` ## Remarks When [use_resumable_upload](#use_resumable_upload-property) is *True* and [upload_file](#upload_file-method) is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress. *FragmentNumber* is the number of the current fragment that has completed. This value starts at *1*. *FragmentCount* is the total number of fragments that will be uploaded. *Interrupt* can be set to *True* to interrupt the upload. The upload may be resumed later. # on_header event Fired every time a header line comes in. ## Syntax ```text class ShareFileHeaderEventParams(object): @property def field() -> str: ... @property def value() -> str: ... # In class ShareFile: @property def on_header() -> Callable[[ShareFileHeaderEventParams], None]: ... @on_header.setter def on_header(event_hook: Callable[[ShareFileHeaderEventParams], None]) -> None: ... ``` ## 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). # on_item_list event This event fires once for each item returned when either ListItems , ListLinkItems or GetItemInfo is called. ## Syntax ```text class ShareFileItemListEventParams(object): @property def id() -> str: ... @property def name() -> str: ... @property def path() -> str: ... @property def creator_first_name() -> str: ... @property def creator_last_name() -> str: ... @property def item_type() -> int: ... @property def parent_id() -> str: ... @property def description() -> str: ... @property def expiration_date() -> str: ... @property def creation_date() -> str: ... @property def size() -> int: ... # In class ShareFile: @property def on_item_list() -> Callable[[ShareFileItemListEventParams], None]: ... @on_item_list.setter def on_item_list(event_hook: Callable[[ShareFileItemListEventParams], None]) -> None: ... ``` ## Remarks This event fires once for each item returned when either [list_items](#list_items-method), [list_link_items](#list_link_items-method) or [get_item_info](#get_item_info-method) is called. The items cannot be modified from this event. # on_link_list event This event fires once for each link returned when ListLinks or GetLinkInfo is called. ## Syntax ```text class ShareFileLinkListEventParams(object): @property def id() -> str: ... @property def title() -> str: ... @property def url() -> str: ... @property def link_type() -> int: ... @property def access_level() -> int: ... @property def expiration_date() -> str: ... @property def creation_date() -> str: ... @property def is_view_only() -> bool: ... @property def max_downloads() -> int: ... @property def total_downloads() -> int: ... @property def notify_on_access() -> bool: ... # In class ShareFile: @property def on_link_list() -> Callable[[ShareFileLinkListEventParams], None]: ... @on_link_list.setter def on_link_list(event_hook: Callable[[ShareFileLinkListEventParams], None]) -> None: ... ``` ## Remarks This event fires once for each link returned when [list_links](#list_links-method) or [get_link_info](#get_link_info-method) is called. The link cannot be modified from this event. This event will not show the items related to the specific link when calling [list_link_items](#list_link_items-method). Those will be listed using the [on_item_list](#on_item_list-event) event. # on_log event Fired once for each log message. ## Syntax ```text class ShareFileLogEventParams(object): @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class ShareFile: @property def on_log() -> Callable[[ShareFileLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[ShareFileLogEventParams], None]) -> None: ... ``` ## Remarks This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *log_level* 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. *log_type* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" # on_permission_list event This event fires once for each permission returned when ListPermissions or GetPermissionInfo is called. ## Syntax ```text class ShareFilePermissionListEventParams(object): @property def folder_id() -> str: ... @property def user_id() -> str: ... @property def can_delete() -> bool: ... @property def can_download() -> bool: ... @property def can_manage_permissions() -> bool: ... @property def can_upload() -> bool: ... @property def can_view() -> bool: ... @property def is_owner() -> bool: ... @property def notify_on_download() -> bool: ... @property def notify_on_upload() -> bool: ... # In class ShareFile: @property def on_permission_list() -> Callable[[ShareFilePermissionListEventParams], None]: ... @on_permission_list.setter def on_permission_list(event_hook: Callable[[ShareFilePermissionListEventParams], None]) -> None: ... ``` ## Remarks This event fires once for each permission returned when [list_permissions](#list_permissions-method) or [get_permission_info](#get_permission_info-method) is called. The permissions cannot be modified from this event. The *FolderId* represents the item Id for the specific folder the permission is for. The *UserId* represents the Id for the user the permission is for. # on_progress event Fires during an upload or download to indicate transfer progress. ## Syntax ```text class ShareFileProgressEventParams(object): @property def direction() -> int: ... @property def bytes_transferred() -> int: ... @property def total_bytes() -> int: ... @property def percent_done() -> int: ... # In class ShareFile: @property def on_progress() -> Callable[[ShareFileProgressEventParams], None]: ... @on_progress.setter def on_progress(event_hook: Callable[[ShareFileProgressEventParams], None]) -> None: ... ``` ## 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](#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](#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. # on_ssl_server_authentication event Fired after the server presents its certificate to the client. ## Syntax ```text class ShareFileSSLServerAuthenticationEventParams(object): @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def status() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class ShareFile: @property def on_ssl_server_authentication() -> Callable[[ShareFileSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[ShareFileSSLServerAuthenticationEventParams], None]) -> None: ... ``` ## 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. # on_ssl_status event Fired when secure connection progress messages are available. ## Syntax ```text class ShareFileSSLStatusEventParams(object): @property def message() -> str: ... # In class ShareFile: @property def on_ssl_status() -> Callable[[ShareFileSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[ShareFileSSLStatusEventParams], None]) -> None: ... ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # on_start_transfer event Fired when a document starts transferring (after the headers). ## Syntax ```text class ShareFileStartTransferEventParams(object): @property def direction() -> int: ... # In class ShareFile: @property def on_start_transfer() -> Callable[[ShareFileStartTransferEventParams], None]: ... @on_start_transfer.setter def on_start_transfer(event_hook: Callable[[ShareFileStartTransferEventParams], None]) -> None: ... ``` ## Remarks This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then 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. # on_transfer event Fired while a document transfers (delivers document). ## Syntax ```text class ShareFileTransferEventParams(object): @property def direction() -> int: ... @property def bytes_transferred() -> int: ... @property def percent_done() -> int: ... @property def text() -> bytes: ... # In class ShareFile: @property def on_transfer() -> Callable[[ShareFileTransferEventParams], None]: ... @on_transfer.setter def on_transfer(event_hook: Callable[[ShareFileTransferEventParams], None]) -> None: ... ``` ## 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 *bytes_transferred* 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. # on_user_list event This event fires once for each user returned when ListUsers or GetUserInfo is called. ## Syntax ```text class ShareFileUserListEventParams(object): @property def id() -> str: ... @property def first_name() -> str: ... @property def last_name() -> str: ... @property def company() -> str: ... @property def email() -> str: ... @property def creation_date() -> str: ... # In class ShareFile: @property def on_user_list() -> Callable[[ShareFileUserListEventParams], None]: ... @on_user_list.setter def on_user_list(event_hook: Callable[[ShareFileUserListEventParams], None]) -> None: ... ``` ## Remarks This event fires once for each user returned when [list_users](#list_users-method) or [get_user_info](#get_user_info-method) is called. The users cannot be modified from this event. If the user does not have a specified company that parameter will be left as an empty string (""). # ShareFile Config Settings 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](#config-method) method. ### ShareFile Config Settings **AccumulatePages**: Whether the class should accumulate subsequent pages of results when listing them.This setting controls how the class behaves when listing multiple pages of results. If this setting is enabled, each successive page of results will be appended to the appropriate collection properties until the last page of results has been listed (at which point the next list call will cause said collection to be cleared first). If this setting is disabled, the collection will be cleared every time a page of results is returned. By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties. **CreatePermissionNotify**: Whether to notify users of the permission they granted.This setting specifies whether notify users of the permission they granted. If set to True an email will be sent by ShareFile. The default value is False. **CreatePermissionNotifyMessage**: The custom notify message used in permission notification email.This setting only applies when CreatePermissionNotify is set to True. **DeleteChildItemsPermanently**: Whether ChildItems should be deleted permanently.This setting specifies if child items should be deleted permanently by the class. Only available for [delete_child_items](#delete_child_items-method) The default value is False. **DeleteUserCompletely**: Whether to delete user completely.This setting specifies whether delete user completely. The default value is False. **ForceSync**: Whether ShareFile will block the operation from taking place asynchronously.This setting specifies whether ShareFile will execute the operation synchronously. This setting does not affect how this class executes. The default value is True. **IncludeDeletedItems**: Whether deleted items should be include in the results.This setting specifies whether deleted items should be included in the results when calling [get_item_info](#get_item_info-method) or [list_items](#list_items-method). Unavailable when using the path. Note: This setting is not applicable when calling [get_item_info](#get_item_info-method) and a path is specified. The default value is False. **IncludeExpiredLinks**: Whether expired links should be include in the results.This setting specifies whether expired links should be included in the results when calling [get_link_info](#get_link_info-method) or [list_links](#list_links-method). The default value is False. **ListUsersType**: The type used to list users.This setting specifies the type of Users to retrieve. Use 'personal' to retrieve the contact list maintained by the authenticated user; 'shared' to retrieve the account-wide list; and 'group' to retrieve the list of distribution groups in the account. **RawRequest**: Returns the data that was sent to the server.This setting may be queried after calling any method that sends data to the server to obtain the request data that was transmitted. Such data may be useful for troubleshooting purposes. **RawResponse**: Returns the data that was received from the server.This setting may be queried after calling any method that sends data to the server to obtain the response data that was received. Such data may be useful for troubleshooting purposes. **SearchPageSize**: Limits the number of search results.This setting specifies the maximum number of search results to be returned each time [search](#search-method) is called. If there are more items than can be returned, the results will be paged and the [search_marker](#search_marker-property) property populated. Note that in some cases a page of results may have less items than is specified here, even if more pages are available. The default is -1, which causes the server's default (50) to be used. **XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XElement**: The name of the current element.This configuration setting provides the name of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XParent**: The parent of the current element.This configuration setting provides the parent of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response. When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#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](#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. | NOTE: XPath indices are *1-based*. For example, assume the following XML and JSON responses. XML: ```text value first second value three ``` JSON: ```text { "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. **XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XText**: The text of the current element.This configuration setting provides the inner text of the current element. The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only. ### OAuth Config Settings **OAuthAccessTokenExpiration**: The lifetime of the access token.This setting holds the lifetime of the access token in seconds. For instance the value *3600* indicates that the token will expire in one hour from the time it was generated. **OAuthAuthorizationTokenType**: The type of access token returned.The applicable values include the following: | | | | --- | --- | | Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by [authorize](#authorize-method) will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. | **OAuthAutomaticRefresh**: Whether or not to refresh an expired access token automatically.When this setting is set to *True* and the [authorization](#authorization-property) property is not set, the class will automatically get a new access token if it has the necessary properties to do so without user interaction. For example, when using the Authorization Code grant type, the [o_auth_refresh_token](#o_auth_refresh_token-property) property should be set to a valid refresh token. When using the Client Credential grant type however, the class does not need any additional properties set as it can already get a new access token without user interaction. **OAuthBrowserResponseTimeout**: Specifies the amount of time to wait for a response from the browser.This setting specifies the amount of time (in seconds) the class will wait for a response from the browser when requesting user authentication. The default value is *0*, meaning that the class will wait indefinitely. **OAuthIncludeEmptyRedirectURI**: Whether an empty redirect_uri parameter is included in requests.This setting specifies whether *redirect_uri* is included in the request made by [authorize](#authorize-method) if it is empty. If set to *True* (default) the *redirect_uri* will be sent in all cases. If set to *False* the *redirect_uri* will only be sent if it has a value. **OAuthJWTPayload**: The payload of the JWT access token if present.This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the class is able to parse out the payload section. This setting only applies to **access tokens** that are returned from a service provider after successfully authorizing and authenticating with the service. To parse the payload for specific claims, see [OAuthJWTXPath](#OAuthJWTXPath). **OAuthJWTXChildCount**: The number of child elements of the current element.The number of child attributes of the current element. The OAuthJWTXChildCount configuration settings will be indexed from 0 to ([OAuthJWTXChildCount](#OAuthJWTXChildCount) - 1). The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OauthJWTXChildName[i]**: The name of the child element.Provides the name of the i'th child element of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXChildXText[i]**: The inner text of the child element.Provides the inner text of the i'th child element of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXElement**: The name of the current element.Provides the name of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OauthJWTXParent**: The parent of the current element.Provides the parent of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXPath**: Provides a way to point to a specific element in the returned payload of a JWT based access token.The [OAuthJWTXPath](#OAuthJWTXPath) setting allows you to point to specific claims within the payload of a JWT based access token. XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the */* character, for example: */A/B/C/D*. 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. | Here are some examples of valid XPaths and some common claims: | Description | JSON XPath | | --- | --- | | Document root | /json | | Specific element | /json/element_one | | Username Claim (Microsoft Specific) | /json/preferred_username | | Registered Application Name Claim (Microsoft Specific) | /json/app_displayname | This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see [OAuthJWTXText](#OAuthJWTXText). **OAuthJWTXSubTree**: A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements). The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXText**: The text of the current element.Provides the inner text of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthParamCount**: Specifies the number of additional parameters variables to include in the request.This setting can be used to add query string parameters to the outgoing request. One common use for this method would be to add the "state" parameter to the request, which can be used when the [o_auth_client_profile](#o_auth_client_profile-property) is cocpWeb to add user defined data. The authorization server will include the "state" parameter in the response and will be available in the post back to your server which will allow you to maintain state in your application. This is used in conjunction with OAuthParamName[i] and OAuthParamValue[i]. For instance: ```text component.Config("OAuthParamCount=2"); component.Config("OAuthParamName[0]=myvar"); component.Config("OAuthParamValue[0]=myvalue"); component.Config("OAuthParamName[1]=testname"); component.Config("OAuthParamValue[1]=testvalue"); ``` Additionally, this will also be updated to hold the parameters returned in the response. ```text for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++) { string name = component.Config("OAuthParamName[" + i + "]"); string value = component.Config("OAuthParamValue[" + i + "]"); } ``` **OAuthParamName[i]**: Specifies the parameter name at the specified index.This setting can be used to retrieve or specify the parameter variable name at the index specified. See [OAuthParamCount](#OAuthParamCount) for details. **OAuthParamValue[i]**: Specifies the parameter value at the specified index.This setting can be used to retrieve or specify the parameter variable value at the index specified. See [OAuthParamCount](#OAuthParamCount) for details. **OAuthPasswordGrantUsername**: Used in the Resource Owner Password grant type.Used to set the username property when the [o_auth_grant_type](#o_auth_grant_type-property) is set to the password grant type and [authorize](#authorize-method) is called. **OAuthPKCEChallengeEncoding**: The PKCE code challenge method to use.This setting controls the PKCE code challenge method used when [OAuthUsePKCE](#OAuthUsePKCE) is set to *True*. Possible values are: - 1 (Plain) - 2 (S256/SHA256 - default) **OAuthPKCEVerifier**: The PKCE verifier used to generate the challenge.This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the [authorize](#authorize-method) method and the [o_auth_web_auth_url](#o_auth_web_auth_url-property) field when [OAuthUsePKCE](#OAuthUsePKCE) is set to true. When using the cocpWeb [o_auth_client_profile](#o_auth_client_profile-property), the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request. **OAuthResetData**: Determines if the Reset method applies to the OAuth settings.If set to *True* (default), the [reset](#reset-method) method will reset the OAuth settings including any authorization fields like [o_auth_access_token](#o_auth_access_token-property) and [o_auth_refresh_token](#o_auth_refresh_token-property). This means the [authorize](#authorize-method) method must be called again to get new authorization information. When set to *False*, the [reset](#reset-method) method will **not** reset the o_auth property and the OAuth* configuration settings. This allows for the class to be reset without having to get authorization again. **OAuthReUseWebServer**: Determines if the same server instance is used between requests.If set to *True* (default), the same embedded web server instance will be used for multiple requests. If set to *False* the embedded web server will be created and destroyed on each call to [authorize](#authorize-method) **OAuthTransferredRequest**: The full OAuth request last sent by the client.This configuration setting returns the full OAuth request last sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Gmail gmail = new Gmail(); gmail.Config("OAuthTransferredRequest=on"); gmail.Authorize(); Console.WriteLine(gmail.Config("OAuthTransferredRequest")); ``` C++ ```text Gmail gmail; gmail.Config("OAuthTransferredRequest=on"); gmail.Authorize(); printf("%s\r\n", gmail.Config("OAuthTransferredRequest")); ``` **OAuthUsePKCE**: Specifies if PKCE should be used.If set to *True* (default), Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when performing authorization. This setting applies when using the Authorization Code [o_auth_grant_type](#o_auth_grant_type-property). The [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) configuration setting can be used to control the code challenge method that will be used. **OAuthWebServerActive**: Specifies and controls whether the embedded web server is active.The setting when queried will return the current state of the web server. If the webserver is active, it will return *"true"* and if it is inactive it will return *"false"*. This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the class will automatically start and stop the web server when [authorize](#authorize-method) is called. In certain cases, it is required to start the webserver before calling [authorize](#authorize-method). For example, if the [o_auth_return_url](#o_auth_return_url-property) needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the [OAuthReUseWebServer](#OAuthReUseWebServer) is set to true, the server will not be automatically stopped, and this configuration setting must be set to *"false"* to stop the embedded web server. **OAuthWebServerCertStore**: The certificate with private key to use when SSL is enabled.The name of the certificate store used for the embedded web server's SSL. The [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) property specifies the type of the certificate store specified by [OAuthWebServerCertStore](#OAuthWebServerCertStore). If the store is password protected, specify the password in [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword). [OAuthWebServerCertStore](#OAuthWebServerCertStore) is used in conjunction with the [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) property in order to specify the certificate to be used during SSL. 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *True*. **OAuthWebServerCertStorePassword**: The certificate with private key to use when SSL is enabled.If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. Note: This is only applicable when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *True*. **OAuthWebServerCertStoreType**: The certificate with private key to use when SSL is enabled.This specifies the type of certificate store. Possible values are: | | | | --- | --- | | 0 | User - This is the 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 | Machine - For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. | | 3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. | | 4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is available only in Java. | | 5 | JKSBlob - 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 available only in Java. | | 6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. | | 17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. | Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *True*. **OAuthWebServerCertSubject**: The certificate with private key to use when SSL is enabled.The subject of the SSL certificate. 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=example@email.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. Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *True*. **OAuthWebServerFailedResponse**: The custom response that will be displayed to the user if authentication failed.When [authorize](#authorize-method) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser. **OAuthWebServerHost**: The hostname used by the embedded web server displayed in the ReturnURL.This setting specifies the hostname used by the embedded web server when [o_auth_client_profile](#o_auth_client_profile-property) is set to cocpApplication. This specifies the interface on which the embedded web server listens, and also the value displayed in the [o_auth_return_url](#o_auth_return_url-property). This should be set to the hostname only, not the full URL. The default value is *localhost*. **OAuthWebServerPort**: The local port on which the embedded web server listens.This property specifies the port on which the embedded web server listens. Setting this to *0* (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server. **OAuthWebServerResponse**: The custom response that will be displayed to the user.When [authorize](#authorize-method) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser. **OAuthWebServerSSLEnabled**: Whether the web server requires SSL connections.This setting specifies whether the embedded web server will use SSL. If set to *True* OAuthWebServerCert* configs are required and the server will only accept SSL connections. If set to *False* only plaintext connects are supported. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms. When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when http_version is set to "2.0". 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. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to [local_file](#local_file-property). When set to True, downloaded data will be appended to [local_file](#local_file-property). This may be used in conjunction with range to resume a failed download. This is applicable only when [local_file](#local_file-property) is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. 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 auth_scheme 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](#authorization-property) property in the form "Basic [encoded-user-password]". **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [on_transfer](#on_transfer-event) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new url for the object is retrieved automatically every time. 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 on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_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 **GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.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](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#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. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *True*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *False*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *False*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [on_log](#on_log-event) event. 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). **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When follow_redirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When http_version is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. 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. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) are specified, this value is calculated using the algorithm specified by [proxy_auth_scheme](#proxy_auth_scheme-property). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. In the C++ Edition for Windows, the *W version of the class must be used. For instance, *DNSW* or *HTTPW*. **UsePlatformHTTPClient**: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (*URLConnection* in Java, *WebRequest* in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine). NOTE: This setting is applicable only to Mac/iOS editions. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and [proxy_auto_detect](#proxy_auto_detect-property) is set to *True*. 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. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [timeout](#timeout-property) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#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 classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#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](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#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. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [local_host](#local_host-property) setting 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 value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [local_host](#local_host-property) 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). **LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established. local_port 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. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an eol string. If an eol string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the on_data_in event is fired with the *EOL* parameter set to True, and the buffer is reset. If no eol is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the on_data_in event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [ssl_provider](#ssl_provider-property) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [on_ssl_status](#on_ssl_status-event) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [ssl_provider](#ssl_provider-property) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. 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. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. 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. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. 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". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. 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. **ReuseSSLSession**: Determines if the SSL session is reused. 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. **SSLCACertFilePaths**: The paths to CA certificate files on Unix/Linux.This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux. 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* **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [ssl_provider](#ssl_provider-property) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error. 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. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class fails with an error. 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. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. 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 [on_ssl_status](#on_ssl_status-event) 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](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when ssl_authenticate_clients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. 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](#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 [ssl_provider](#ssl_provider-property) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [ssl_provider](#ssl_provider-property) 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 Example values when [ssl_provider](#ssl_provider-property) is set to *Internal*include the following: ```text 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 [ssl_provider](#ssl_provider-property) 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](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. 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 first try to use the platform TLS 1.3 implementation when the [ssl_provider](#ssl_provider-property) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [ssl_provider](#ssl_provider-property) 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](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#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 [ssl_provider](#ssl_provider-property) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [ssl_provider](#ssl_provider-property) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *False* by default, but it can be set to *True* to enable the extension. This configuration setting is applicable only when [ssl_provider](#ssl_provider-property) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. 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 [ssl_provider](#ssl_provider-property) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 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. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [ssl_provider](#ssl_provider-property) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. 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: ```csharp 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. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [ssl_provider](#ssl_provider-property) 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) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. 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" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "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 *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* 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) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [timeout](#timeout-property) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. 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. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. 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 **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). 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 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | 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 | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - 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. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. **SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20. **UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *True*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. 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](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the class will use the system security libraries by default to perform cryptographic functions where applicable. 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](platforms.md) section. # ShareFile Errors ### 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](#RawRequest) or [RawResponse](#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 [local_file](#local_file-property) already exists and [overwrite](#overwrite-property) 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](#DownloadTempFile) configuration setting is not set. | | 611 | An exception occurred while working with the specified [local_file](#local_file-property) (or the current value of [local_file](#local_file-property) 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. The error description contains the 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 url_scheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open attached_file. | The class may also return one of the following error codes, which are inherited from other classes. ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the remote_port at this time. A connection is in progress. | | 101 | You cannot change the remote_host (Server) at this time. A connection is in progress. | | 102 | The remote_host 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 local_port at this time. A connection is in progress. | | 107 | You cannot change the [local_host](#local_host-property) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | remote_port 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). |