Revision as of 15:50, 8 July 2019 by Greg.hill (talk | contribs) (Recovery)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Cascade Options

Main Options


Enables Guard. If not set, no guard functions will be loaded in the UI. Needed if users should be able to do ANY Guard functions including reading encrypted emails. This level will allow users without "guard-mail" enabled to read emails sent to them, reply to those emails, but not create new emails. Recommended minimum level for all users.


Enables the user(s) ability to send encrypted emails. If False but guard enabled, they can read encrypted emails and reply to the original sender, but they cannot compose new emails


Enables the drive functionality. If false, user(s) will not be able to decode nor upload new encrypted files

Optional Cascade Options



Enables optional PIN function when sending emails to non-ox users. Will provide an additional 4 digit pin that should be sent to the recipient. Extra protection during the time that the temporary password was assigned and sent.


(Guard 2.0) Disable the ability of the user to delete the recovery keys. Makes it impossible to reset password, but also adds level of protection/security


(Guard 2.0) Password recovery is disabled. No way to recover a lost or forgotten password. Increases security, but a lost password means lost data.


(Guard 2.0) Disable the ability of the user to delete their private key. They can revoke it, but not delete the key.


(Guard 2.2) Normally, when a person replies from an encrypted email, the reply is automatically encrypted. Set to false to disable this automatic encryption

com.openexchange.capability.guard-nodeleteonrevoke (Depreciated as of Guard 2.0)

Default when revoking an item is to delete the content key, making the item impossible to decode. If this option is true, then the item is merely expired and can later be retrieved for decoding in case of legal requirements, corporate requirements, etc

com.openexchange.capability.guard-noextra (Depreciated as of Guard 2.0)

Disables the ability to add an extra password to encrypted items. May be required by some industry

Configuration Variables

com.openexchange.guard.fromEmail= name<email>

Email address to use as the From address when sending automated emails (First password, password reset)


When sending an email to a guest, this URL is used for the link to the Guest reader


PGP MIME emails are sent with a help file attached. This is the URL to the main appsuite UI that is included in the help file


Define template customization ID for the Guest reader emails, the Guest reader, and system emails. See Customization for details

Configuration file (



The address of the mysql database that contains the OX Backend configdb. This is used during initial setup and database sharding


The address of the mysql database for OxGuard data. May be the same as the OX mysql database


Optional read-only IP/name for the Guard database.


IP/Name for the location of the next Guest database shard. Additional shards will be created on this database


The username to access the OX Backend and Guard database. This user needs to have select, create, lock, insert, update privileges. Guard database user also should have alter (for updates), drop, index


The password for the databases



The address for the OX REST API. It would be the location of the OX Backend

com.openexchange.guard.OXBackendPort = 8009

The port for the OX Backend. Default is 8009 (which is direct communication with the backend). Could be 80, etc, if going through load balancers

com.openexchange.guard.restApiUsername=open-xchange com.openexchange.guard.restApiPassword=secret

Username and password for the REST API

Support API

If the support API is to be used, a username and password should be configured



When a user is deleted, the Private keys are saved in a temporary deleted Keys table (in case of accidental deletion). If support "exposes" the key, the user can then retrieve it using link generated. For security reasons, this link is only valid for a short period of time.


File Store

When non-ox users get an email with a link to read the message, an external url is required so they can visit the non-ox reader page. This should be the public domain that would prefix /appsuite/api/guard/reader

Local/remote storage is required for temporary caching of non-ox encrypted emails. This can be an attached file store, or Amazon S3 compatible object store. Values are “file” or “s3”

Location of local filestore if type was “file”

S3 configuration options if filestore selected was S3


How many days emails are kept in file store before being deleted. Measured from time of sending, reset when someone reads the email


Time that the filestore is checked for old items


com.openexchange.guard.aesKeyLength=256 (Depreciated)

AES Key length. 256 is preferred, but not supported on all systems. May need to have java unlimeted key strength pack installed


RSA key length. Used when creating PGP keys


Length of time for PGP key validity. Set to 0 if no expiration date



List of PGP Public key servers to query for public keys


A list of IP addresses of TRUSTED Guard servers. When the public PGP key server is queried, it will normally only find Guard keys that have already been created. If on the whitelist, the Guard server will also query the OX backend to see if the email address exists on the OX system, and if so, will create new keys for the user


PGP keys created will only be valid for this number of days. Default is 10 years





SMTP settings for outgoing emails from the guest reader. Emails sent from within the system use the OX Backend. The guest reader, however, sends replies through this SMTP. In addition, password emails (reset, initial) are sent through the SMTP server



When looking up remote PGP keys, if found, the keys will be stored in a temporary cache. Set number of days until the cache item is expired and remote lookup is repeated.


com.openexchange.guard.usestarttls = true

Use TLS when delivering to the SMTP server when available

Bad attempts

com.openexchange.guard.badMinuteLock= 10

Defines how long someone will be locked out after bad attempts. Default 10

com.openexchange.guard.badPasswordCount= 5

Defines how many times a person can attempt to unlock an encrypted item before being locked out. Default 5

com.openexchange.guard.badIpCount: 10

Defines how many times an outside computer can request a public key that doesn't exist before being locked out

RSA Key Generation


RSA keys are pre-generated in the background, encrypted, and stored for future user keys. RSA key generation is the most time consuming function and the RSA cache significantly improves new user creation time


Number of RSA keys to pre-generate

com.openexchange.guard.keycachecheckinterval= 30

Interval in seconds to check the RSA cache and re-populate if less than rsacachecount


Bit certainty for RSA key generation. Higher numbers assure the number is in fact prime but time consuming. Lower is much faster. May need to be lower if not using cache



Length of the randomly generated passwords when a user resets password.


Minimum password length



URL used to communicated directly with the OX backend


HTTP connections to the backend are kept open for faster response. This is the timeout setting that will close idle connections.


Name of the configdb database



Username for the support API


Password for the support API

Guest Accounts


Guest users data are placed in databases oxguard_x. After set number of users, another database shard is created


Full path after domain name for the external reader (if changed from default)

Optional Configuration Settings



Communication between Guard and the OX backend is set to HTTP by default. All items to be encrypted are already encrypted at this point, but other information (sender name, filename, etc) could appear in plaintext here. If SSL is desired, sest to true.

Incoming SSL

Communication between the frontend load balancer (APACHE or otherwise) to Guard is by default HTTP (if protected network). To have Guard listen on an SSL socket, the following needs to be set

com.openexchange.guard.useSSL= true

Enables jetty listener for ssl

com.openexchange.guard.SSLPort= 8443

Jetty will listen on defined port for ssl connections

com.openexchange.guard.SSLKeyStore= xxxx

Location of the keystore with ssl keys

com.openexchange.guard.SSLKeyName= xxxx

Name/alieas of the key to use

com.openexchange.guard.SSLKeyPass= xxxx

Password for the ssl key


If you do not want password recovery available, you can disable by adding

com.openexchange.guard.noRecovery= true

Keep in mind, that a lost password will result in total loss of encrypted data

Users will be able to change their passwords if they remember their current/old password. But they won't be able to create a new password in the event it is forgotten.

Users without recovery would have to create new keys, with a new password, to continue to use Guard. These keys would apply to future encrypted items, not the old ones.

Guests that forget their passwords will need to have their account reset from the command line tool (this will create new keys for them, and send them a new password)



Default language if a language is requested but not available