CSRCurrent en:Options
Aus Cryptshare Documentation
Using the Options
The options can be used in either their short or standard form. In short form, the parameter consists of one or two letters only. The standard form uses one or more words without spaces to make it easier to understand what the option does. To use several options in one command, separate them with spaces. If the value of an option contains spaces, put it in double quotes.
Example: Short and Standard Option Form -n "John Doe" --senderName "John Doe"
Common Parameters
Help
| Parameter |
-h, --help |
| Description | Returns a list of available options. |
Base URL
| Parameter |
-u, --baseUrl |
| Value | URL of the Cryptshare Server |
| Description | Required in every request sent to the server. Specify the address of the Cryptshare Server with a complete URL starting with 'http' or 'https'. Example: |
Sender Address
| Parameter |
-a, --senderAddress |
| Value | The email address of the sender |
| Description | This parameter is required for every request sent to the server. |
Password encryption
| Parameter |
-C, --createEncryptedPW |
| Value | The password that is to be encrypted |
| Description | Encrypts the given password, so that it can be later used as a value for the parameter '-pc'.
If a proxy server with authentication information is also specified with the option '-P', then its password will be encrypted as well. Afterwards, the proxy URL containing the encrypted proxy server password can be used as a value for the parameter '-PC'. |
| Additional functions |
|
Proxy Server
| Parameter |
-P, --proxy |
| Value | Proxy Server URL |
| Description | If the Cryptshare Server is only accessible via a proxy server, the proxy server's url can be set with this parameter.
If the proxy server requires authentication or uses a different port than port 80, this can be specified in the url as well. For instance: http://user:password@proxy:8080 |
Proxy Server with encrypted password
| Parameter |
-PC, --proxycrypted |
| Value | Proxy Server URL containing an encrypted password |
| Description | Behaves the same as parameter '-P', with the difference, that the password for authentication has to be expressed in its encrypted form.
Please use parameter '-C' together with parameter '-P' for encryption of the proxy password. |
Verification store
| Parameter |
-f, --storeFile |
| Value | File path |
| Description | Defines the path to the verification store file. If this option is not specified, the file client.store in the current working directory will be used and if the file is not found, a new client.store file will be created. |
Parameters for querying server settings
Query general server data
| Parameter |
-qs, --queryServerData |
| Additional Parameters |
-u, -a |
| Description | Returns the general server data, such as the official base url of the Cryptshare Server, the server's time zone, as well as the available disk spaces in the folders that are used for file transfers (retention folder and the temporary upload folder). |
Query licence information
| Parameter |
-li, --queryLicenceInfo |
| Additional Parameters |
-u, -a |
| Description | Returns the status and expiration dates of the Cryptshare Server licence and the Robot licence. |
Query supported languages
| Parameter |
-g, --queryLanguages |
| Additional Parameters |
-u, -a |
| Description | Prints a list of supported languages. These ISO language codes can be used to specify the recipient language (parameter '-l'). |
Query the maximum upload size
| Parameter |
-x, --queryMaxSize |
| Additional Parameters |
-u, -a, -r |
| Description | Returns the maximum total size of data in MB per transfer for a given sender-recipient combination. |
Query the minimum password length
| Parameter |
-k, --queryMinKeyLength |
| Additional Parameters |
-u, -a |
| Description | Returns the minimum key length for a password which can be used in a Cryptshare transfer. |
Parameters for verification
Check whether a verification exists
| Parameter |
-q, --queryVerification |
| Additional Parameters |
-u, -a |
| Description | Checks if the current copy of the Robot instance or the specified sender (depending on which verification mode is configured on the server) has been verified and returns the result. |
Request a new verification
| Parameter |
-v, --requestVerification |
| Additional Parameters |
-u, -a |
| Description | Starts the verification process for either the sender or the Robot instance, depending on the verification mode configured on the Cryptshare Server (see Verification). |
Parameters for file transfer
Transfer files
| Parameter |
-s, --sendMode |
| Additional Parameters |
-u,-a,-n,-t,-r |
| Description | Activates the file transfer mode. If this option is used, specify the files to be sent at the end of the command line, separated by spaces. |
Name of the sender
| Parameter |
-n, --senderName |
| Value | Name of the sender |
| Description | The sender's name to be used in the notification sent to the recipients. |
Phone number of the sender
| Parameter |
-t, --senderPhone |
| Value | Phone number of the sender |
| Description | The sender's phone number that will be included in the notification email sent to the recipients, so that they can contact the sender to find out the password for downloading the files. |
Email addresses of the recipients
| Parameter |
-r, --recipientAddress |
| Value | Email addresses of the recipients |
| Description | The list of addresses of the recipients of the transferred data, separated by commas (no spaces!). |
Show file names in email notifications
| Parameter |
-e, --exposeFilename |
| Description | If this parameter is used, then the names of the transferred files will be shown in the email notification. |
Sender notification on file download
| Parameter |
-i, --inform |
| Description | If this parameter is used, the sender will be notified when a transferred file is downloaded. |
Expiration Date
| Parameter |
-exp, --expirationDate |
| Value | The expiration date of the transferred files in the format 'YYYY-MM-DD' |
| Description | Sets the expiration date of the transferred files. The transferred files can only be downloaded by the recipients up to the specified expiration date. The expiration date should be written in the format 'YYYY-MM-DD'. If no expiration date is specified, the files will be available for the maximum storage duration, as configured in the policy rules on the Cryptshare server. |
Custom Recipient Email Message
| Parameter |
-m, --message |
| Value | Custom message for the recipients either as text in double quotes or as file reference. |
| Description | Specifies the custom message text to the recipient(s) that will be included in the notification email. To specify a file reference to a file containing your message text, use the following syntax: "file://path_to_file". The file containing the message text needs to be UTF-8 encoded, to ensure correct display of the characters in the text of the notification email. |
Custom Recipient Email Subject
| Parameter |
-z, --subject |
| Value | Custom subject of the recipient notification email either as text in double quotes or as file reference. |
| Description | Specifies the email subject of the message sent to the recipient(s). To specify a file reference to a file containing your subject text, use the following syntax: "file://path_to_file". The file containing the subject text needs to be UTF-8 encoded, to ensure correct display of the characters in the notification email subject line. |
Confidential Message
| Parameter |
-cm, --confidentialMessage |
| Value | A confidential message that is to be included in the transfer, either as text in double quotes or as file reference. |
| Description | If allowed by the policy, a confidential message to the recipients can be included in the transfer. This confidential message can be supplied using this option, by either directly writing the message in double quotes after the option, or by specifying a file reference to a file containing the message text. To specify a file reference, use the following syntax: "file://path_to_file". The file containing the message text needs to be UTF-8 encoded. |
Confidential Message Subject
| Parameter |
-cz, --confidentialSubject |
| Value | The subject of the confidential message that is to be included in the transfer, either as text in double quotes or as file reference. |
| Description | Specifies the subject of the confidential message that is to be included in the transfer. To specify a file reference to a file containing the subject text, use the following syntax: "file://path_to_file". The file containing the subject text needs to be UTF-8 encoded, to ensure correct display of the characters. |
Notification Message Language
Recipient Language
| Parameter |
-l,--recipientLanguage |
| Value | Language Code (ISO-639-1) for the recipient notification language. |
| Description | Specifies the language in which the recipients shall be notified about the transfer, when using the default recipient notification message. You can only specify a language for which a respective language pack has been installed on the server. |
Transfer Password
Password Mode
| Parameter |
-pm, --passwordmode |
| Value | Password mode to be used. Can be either "none", "generated" or "manual" |
| Description | Sets the password mode to use. You can only specify a password mode that has been configured on the server. Possible values are "none", "manual", and "generated", with the password mode "generated" offering the highest level of security. When the password mode is set to "generated", a password will be generated by the server and printed to the console. This password will then be required when downloading the transferred files from the Cryptshare Server.
When password mode is set to "manual", a password has to be specified using either the parameters '-p' or 'pc'. This password will then be required when downloading the transferred files from the Cryptshare Server. If password mode "none" is used, no password needs to be specified. In this case, the server automatically generates a password and already includes it as a parameter in the download link of the transferred files, so that the recipient will not need to enter a password when accessing the files. The mode "none" is the least secure password mode. (If this option is omitted, the most secure password mode that has been configured on the server will be used.) |
Plain text password
| Parameter |
-p, --password |
| Value | Password for transfer encryption |
| Description | Specifies the password to be used by the recipient in order to access the files. The password will be ignored if the password mode is set to "generated" or "none". |
Encrypted password
| Parameter |
-pc, --cryptedpassword |
| Value | Encrypted password for transfer encryption. |
| Description | Behaves like parameter 'p' with the difference, that the password must be specified in its encrypted form.
Please use option '-C' to encrypt the password. |
Transfer Files
| Parameter | none (when using an options file, the parameter name to use is 'transfer_files') |
| Description | List all files that should be included in the transfer. The files have to be written at the end of the command line, separated by spaces. The transfer parameters have to include the option '-s', as described above, in order to initiate the transfer and send the named files. |
Strict Mode
| Parameter | -st, --strict |
| Description | Activates the "strict" mode. When this mode is enabled, partially successful transfers cause the robot to exit with a separate exit code (exit code 440 instead of 0). The transfer has been performed and can be retrieved. |