AppSuite:GuardConfiguration - Revision history

Greg.hill: /* Recovery */

2019-07-08T15:50:40Z

Recovery

← Older revision		Revision as of 15:50, 8 July 2019
Line 336:		Line 336:
	Keep in mind, that a lost password will result in total loss of encrypted data		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)

	=== Misc ===		=== Misc ===

Greg.hill: /* Capabilities */

2015-10-22T19:26:55Z

Capabilities

← Older revision		Revision as of 19:26, 22 October 2015
Line 35:		Line 35:

	(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.0) Disable the ability of the user to delete their private key. They can revoke it, but not delete the key.

			'''com.openexchange.guard.secureReply'''

			(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)		'''com.openexchange.capability.guard-nodeleteonrevoke''' (Depreciated as of Guard 2.0)

Greg.hill: /* Backend */

2015-06-18T18:44:56Z

Backend

← Older revision		Revision as of 18:44, 18 June 2015
Line 268:		Line 268:
	Name of the configdb database		Name of the configdb database

			=== Support ===

			'''com.openexchange.guard.supportApiUsername'''

			Username for the support API

			'''com.openexchange.guard.supportApiPassword'''

			Password for the support API

	=== Guest Accounts ===		=== Guest Accounts ===

Greg.hill: /* PGP */

2015-06-18T18:43:33Z

PGP

← Older revision		Revision as of 18:43, 18 June 2015
Line 180:		Line 180:

	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		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

			'''com.openexchange.guard.keyValidDays'''

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

	=== Email ===		=== Email ===

Greg.hill: /* Crypto */

2015-06-10T18:28:12Z

Crypto

← Older revision		Revision as of 18:28, 10 June 2015
Line 170:		Line 170:

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

			=== PGP ===

			'''com.openexchange.guard.publicPGPDirectory'''

			List of PGP Public key servers to query for public keys

			'''com.openexchange.guard.publicKeyWhitelist'''

			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

	=== Email ===		=== Email ===

Greg.hill: /* Database */

2015-06-10T18:25:32Z

Database

← Older revision		Revision as of 18:25, 10 June 2015
Line 77:		Line 77:

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

			'''com.openexchange.guard.oxguardDatabaseRead'''

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

			'''com.openexchange.guard.oxguardShardDatabase'''

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

	'''com.openexchange.guard.databaseUsername=username'''		'''com.openexchange.guard.databaseUsername=username'''
Line 85:		Line 93:

	The password for the databases		The password for the databases


	=== OX API ===		=== OX API ===

Greg.hill: /* Configuration Variables */

2015-06-08T14:16:41Z

Configuration Variables

← Older revision		Revision as of 14:16, 8 June 2015
Line 55:		Line 55:
	When sending an email to a guest, this URL is used for the link to the Guest reader		When sending an email to a guest, this URL is used for the link to the Guest reader

	'''com.openexchange.guard.~~oxternalOxUI~~'''		'''com.openexchange.guard.externalOxUI'''

	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		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

Greg.hill: /* Optional Cascade Options */

2015-06-08T14:15:50Z

Optional Cascade Options

← Older revision		Revision as of 14:15, 8 June 2015
Line 17:		Line 17:

	== Optional Cascade Options ==		== Optional Cascade Options ==

			=== Capabilities ===

	'''com.openexchange.capability.guard-pin'''		'''com.openexchange.capability.guard-pin'''
Line 33:		Line 35:

	(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.0) Disable the ability of the user to delete their private key. They can revoke it, but not delete the key.

			'''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>'''		'''com.openexchange.guard.fromEmail= name<email>'''
Line 38:		Line 50:
	Email address to use as the From address when sending automated emails (First password, password reset)		Email address to use as the From address when sending automated emails (First password, password reset)

	~~'''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.guard.externalReaderURL'''

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

			'''com.openexchange.guard.oxternalOxUI'''

			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


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

	~~Disables~~ the ~~ability to add an extra password to encrypted items~~. ~~May be required by some industry~~		Define template customization ID for the Guest reader emails, the Guest reader, and system emails. See [[AppSuite:GuardCustomization\|Customization]] for details

	== Configuration file (guard.properties) ==		== Configuration file (guard.properties) ==

Greg.hill: /* Support API */

2015-06-05T18:01:03Z

Support API

← Older revision		Revision as of 18:01, 5 June 2015
Line 93:		Line 93:

	'''com.openexchange.guard.supportapipassword=yyyyy'''		'''com.openexchange.guard.supportapipassword=yyyyy'''


			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.

			'''com.openexchange.guard.exposedKeyDurationInHours=168'''

	=== File Store ===		=== File Store ===

Greg.hill: /* Remote */

2015-06-05T17:57:51Z

Remote

← Older revision		Revision as of 17:57, 5 June 2015
Line 155:		Line 155:
	=== Remote ===		=== Remote ===

	'''com.openexchange.guard.~~maxremote~~ = ~~100'''~~		'''com.openexchange.guard.pgpCacheDays=7

	~~Maximum number of~~ remote ~~emails that can~~ be ~~recieved~~ in ~~lockout period (com~~.~~openexchange.com~~.~~badMinuteLock)~~		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.

	Optional		Optional
Line 164:		Line 164:

	Use TLS when delivering to the SMTP server when available		Use TLS when delivering to the SMTP server when available




	=== Bad attempts ===		=== Bad attempts ===