AppSuite:OX Guard - Revision history

Khgras at 10:04, 12 May 2026

2026-05-12T10:04:15Z

@@ Line 261: / Line 261: @@
   deb <https://LDBUSER:LDBPASSWORD@software.open-xchange.com/products/guard/stable/guard/updates/DebianStretch />
   deb <https://LDBUSER:LDBPASSWORD@software.open-xchange.com/products/appsuite/stable/backend/DebianStretch /</source>>
 Then run:

Khgras: /* Debian Linux 11.0 (Bullseye) */

2024-09-12T12:41:53Z

Debian Linux 11.0 (Bullseye)

@@ Line 293: / Line 293: @@
   deb <https://LDBUSER:LDBPASSWORD@software.open-xchange.com/products/guard/stable/guard/updates/DebianBullseye />
   deb <https://LDBUSER:LDBPASSWORD@software.open-xchange.com/products/appsuite/stable/backend/DebianBullseye /</source>>
 Then run:

Khgras: /* Download and Installation */

2024-09-12T12:38:59Z

Download and Installation

← Older revision		Revision as of 12:38, 12 September 2024
Line 96:		Line 96:
	The components required for the Guard server <code>open-xchange-guard</code> and either <code>open-xchange-guard-file-storage</code> or <code>open-xchange-guard-s3-storage</code> depending on what storage you want to use. The examples below make use of the <code>open-xchange-guard-file-storage</code>. Adjust the commands accordingly to fit your needs. In addition <code>open-xchange</code> and <code>open-xchange-core</code> are required to run OX Guard.		The components required for the Guard server <code>open-xchange-guard</code> and either <code>open-xchange-guard-file-storage</code> or <code>open-xchange-guard-s3-storage</code> depending on what storage you want to use. The examples below make use of the <code>open-xchange-guard-file-storage</code>. Adjust the commands accordingly to fit your needs. In addition <code>open-xchange</code> and <code>open-xchange-core</code> are required to run OX Guard.

	~~<!--~~ === Debian Linux 9.0 (~~Stretch~~) ===		=== Debian Linux 11.0 (Bullseye) ===

	If not already done, add the following repositories to your Open-Xchange apt configuration:		If not already done, add the following repositories to your Open-Xchange apt configuration:

	deb https://software.open-xchange.com/products/guard/stable/guard/~~DebianStretch~~ /		deb https://software.open-xchange.com/products/guard/stable/guard/DebianBullseye /
	deb https://software.open-xchange.com/products/appsuite/stable/backend/~~DebianStretch /~~		deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBullseye /

	~~and then run for a single node installation:~~

	~~$ apt-get update~~
	~~$ apt-get install open-xchange-rest open-xchange-guard open-xchange-guard-file-storage open-xchange-guard-ui open-xchange-guard-ui-static open-xchange-guard-backend-plugin~~

	~~or the following for a distributed installation:~~

	~~$ apt-get update~~
	~~$ apt-get install open-xchange-guard open-xchange-guard-file-storage~~
	The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node). -->

	~~<!-- === Debian Linux 10.0 (Buster) Version 2.10.3+ only ===~~

	~~If not already done, add the following repositories to your Open-Xchange apt configuration:~~

	~~deb https://software.open-xchange.com/products/guard/stable/guard/DebianBuster /~~
	~~deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBuster~~ /

	and then run for a single node installation:		and then run for a single node installation:
Line 130:		Line 112:
	$ apt-get update		$ apt-get update
	$ apt-get install open-xchange-guard open-xchange-guard-file-storage		$ apt-get install open-xchange-guard open-xchange-guard-file-storage
	The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node). ~~-->~~		The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node).

	~~<!--~~ === Debian Linux 11.0 (~~Bullseye~~) ~~Version 2.10.6+ only~~ ===		=== Debian Linux 12.0 (Bookworm) ===

	If not already done, add the following repositories to your Open-Xchange apt configuration:		If not already done, add the following repositories to your Open-Xchange apt configuration:

	deb https://software.open-xchange.com/products/guard/stable/guard/~~DebianBullseye~~ /		deb https://software.open-xchange.com/products/guard/stable/guard/DebianBookworm /
	deb https://software.open-xchange.com/products/appsuite/stable/backend/~~DebianBullseye~~ /		deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBookworm /

	and then run for a single node installation:		and then run for a single node installation:
Line 148:		Line 130:
	$ apt-get update		$ apt-get update
	$ apt-get install open-xchange-guard open-xchange-guard-file-storage		$ apt-get install open-xchange-guard open-xchange-guard-file-storage
	The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node). ~~-->~~		The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node).

	<!-- === RedHat Enterprise Linux 6 or CentOS 6 (valid until v2.10.3) ===		<!-- === RedHat Enterprise Linux 6 or CentOS 6 (valid until v2.10.3) ===

Khgras: /* Debian Linux 11.0 (Bullseye) Version 2.10.6+ only */

2024-09-12T12:33:29Z

Debian Linux 11.0 (Bullseye) *Version 2.10.6+ only*

← Older revision		Revision as of 12:33, 12 September 2024
Line 132:		Line 132:
	The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node). -->		The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node). -->

	=== Debian Linux 11.0 (Bullseye) Version 2.10.6+ only ===		<!-- === Debian Linux 11.0 (Bullseye) Version 2.10.6+ only ===

	If not already done, add the following repositories to your Open-Xchange apt configuration:		If not already done, add the following repositories to your Open-Xchange apt configuration:
Line 148:		Line 148:
	$ apt-get update		$ apt-get update
	$ apt-get install open-xchange-guard open-xchange-guard-file-storage		$ apt-get install open-xchange-guard open-xchange-guard-file-storage
	The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node).		The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node). -->

	<!-- === RedHat Enterprise Linux 6 or CentOS 6 (valid until v2.10.3) ===		<!-- === RedHat Enterprise Linux 6 or CentOS 6 (valid until v2.10.3) ===

Khgras at 07:49, 8 July 2024

2024-07-08T07:49:45Z

Khgras: /* Redhat Enterprise Linux 7 or CentOS 7 */

2023-10-09T12:12:14Z

Redhat Enterprise Linux 7 or CentOS 7

← Older revision		Revision as of 12:12, 9 October 2023
Line 372:		Line 372:
	$ yum update		$ yum update
	$ yum upgrade</source>		$ yum upgrade</source>


			=== Redhat Enterprise Linux 8===

			If not already done, add the following repositories to your Open-Xchange yum configuration:

			[open-xchange-guard-stable-guard-updates]
			name=Open-Xchange-guard-stable-guard-updates
			baseurl=https://LDBUSER:LDBPASSWORD@software.open-xchange.com/products/guard/stable/guard/updates/RHEL7/
			gpgkey=https://software.open-xchange.com/oxbuildkey.pub
			enabled=1
			gpgcheck=1
			metadata_expire=0m

			[ox-backend]
			name=Open-Xchange-backend
			baseurl=https://LDBUSER:LDBPASSWORD@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL7/
			gpgkey=https://software.open-xchange.com/oxbuildkey.pub
			enabled=1
			gpgcheck=1
			metadata_expire=0m</source>

			and then run:

			$ dnf update
			$ dnf upgrade</source>

Khgras: /* Redhat Enterprise Linux 8 */

2023-10-09T12:11:22Z

Redhat Enterprise Linux 8

← Older revision		Revision as of 12:11, 9 October 2023
Line 233:		Line 233:
	and then run for a single node installation:		and then run for a single node installation:

	$ ~~yum~~ update		$ dnf update
	$ ~~yum~~ install open-xchange-rest open-xchange-guard open-xchange-guard-file-storage open-xchange-guard-ui open-xchange-guard-ui-static open-xchange-guard-backend-plugin		$ dnf install open-xchange-rest open-xchange-guard open-xchange-guard-file-storage open-xchange-guard-ui open-xchange-guard-ui-static open-xchange-guard-backend-plugin
	or the following for a distributed installation:		or the following for a distributed installation:

	$ ~~yum~~ update		$ dnf update
	$ ~~yum~~ install open-xchange-guard open-xchange-guard-file-storage		$ dnf install open-xchange-guard open-xchange-guard-file-storage

	The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node).		The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node).

Khgras: /* Redhat Enterprise Linux 7 or CentOS 7 */

2023-10-09T09:04:48Z

Redhat Enterprise Linux 7 or CentOS 7

@@ Line 195: / Line 195: @@
   name=Open-Xchange-backend
   baseurl=https://software.open-xchange.com/products/appsuite/stable/backend/RHEL7/
   gpgkey=https://software.open-xchange.com/oxbuildkey.pub
   enabled=1

Greg.hill: /* External */

2023-01-25T15:06:37Z

External

← Older revision		Revision as of 15:06, 25 January 2023
Line 556:		Line 556:
	==== External ====		==== External ====

	Starting with Guard 2.0, Guard will use public PGP Key servers if configured to find PGP Public keys. ~~In addition, Guard will also look up SRV records for PGP Key servers for a recipients domain. This follows the standards [http://tools.ietf.org/html/draft-shaw-openpgp-hkp-00#page-9 OpenPGP Draft].~~		Starting with Guard 2.0, Guard will use public PGP Key servers if configured to find PGP Public keys.

	External PGP servers to use can be configured in the guard.properties file on the Guard servers.		External PGP servers to use can be configured in the guard.properties file on the Guard servers. These can be "trusted" or "untrusted" servers. Trusted servers might be internal servers containing known, trusted keys. Untrusted servers may be public servers that are not necessarily to be trusted (users will have keys marked as trusted or untrusted).

	<source lang="bash">com.openexchange.guard.~~publicPGPDirectory~~ = hkp://keys.gnupg.net:11371, hkp://pgp.mit.edu:11371</source>		<source lang="bash">com.openexchange.guard.trustedPGPDirectory = hkp://localservice.somewhere:113711</source>
			<source lang="bash">com.openexchange.guard.untrustedPGPDirectory = hkp://keys.gnupg.net:11371, hkp://pgp.mit.edu:11371</source>

	~~If you would like this Guard installation discoverable as HKP service by other Guard servers, then create an SRV record for each domain ("example.com" in this illustration):~~		'''Please Note''' PGP key servers by default append the path /pks when the record is obtained from an SRV record. The proxy (also included in Apache config above) routes anything under /pks to the OX Guard PGP server.

	~~<source lang="bash">_hkp._tcp.example.com. 28800 IN SRV 10 1 80 appsuite.example.com.</source>~~

	'''Please Note''' PGP ~~Public~~ key servers by default append the path /pks when the record is obtained from an SRV record. The proxy (also included in Apache config above) routes anything under /pks to the OX Guard PGP server.
	<source lang="bash">ProxyPass /pks balancer://oxguard/pgp</source>		<source lang="bash">ProxyPass /pks balancer://oxguard/pgp</source>

Greg.hill at 14:59, 25 January 2023

2023-01-25T14:59:53Z

← Older revision		Revision as of 14:59, 25 January 2023
Line 12:		Line 12:
	OX Guard is a fully integrated security add-on to OX App Suite that provides end users with a flexible email and file encryption solution. OX Guard is a highly scalable, multi server, feature rich solution that is so simple-to-use that end users will actually use it. With a single click a user can take control of their security and send secure emails and share encrypted files. This can be done from any device to both OX App Suite and non-OX App Suite users.		OX Guard is a fully integrated security add-on to OX App Suite that provides end users with a flexible email and file encryption solution. OX Guard is a highly scalable, multi server, feature rich solution that is so simple-to-use that end users will actually use it. With a single click a user can take control of their security and send secure emails and share encrypted files. This can be done from any device to both OX App Suite and non-OX App Suite users.

	OX Guard uses standard PGP encryption for the encryption of email and files. PGP has been around for a long time, yet has not really caught on with the masses. This is generally blamed on the confusion and complications of managing the keys, understanding trust, PGP format types, and lack of trusted central key repositories. Guard simplifies all of this, making PGP encryption as easy as a one click process, with no keys to keep track of, yet the options of advanced PGP management for those that know how.		OX Guard uses standard PGP encryption for the encryption of email and files. S/Mime is also supported since version 2.10.7. PGP has been around for a long time, yet has not really caught on with the masses. This is generally blamed on the confusion and complications of managing the keys, understanding trust, PGP format types, and lack of trusted central key repositories. Guard simplifies all of this, making PGP encryption as easy as a one click process, with no keys to keep track of, yet the options of advanced PGP management for those that know how.

	This article will guide you through the installation of Guard and describes the basic configuration and software requirements. As it is intended as a quick walk-through it assumes an existing installation of the operating system including a single server App Suite setup as well as average system administration skills. This guide will also show you how to setup a basic installation with none of the typically used distributed environment settings. The objective of this guide is:		This article will guide you through the installation of Guard and describes the basic configuration and software requirements. As it is intended as a quick walk-through it assumes an existing installation of the operating system including a single server App Suite setup as well as average system administration skills. This guide will also show you how to setup a basic installation with none of the typically used distributed environment settings. The objective of this guide is:
Line 63:		Line 63:
	=== Important Notes ===		=== Important Notes ===

	==== ~~Customisation~~ ====		==== Customization ====

	OX Guard version supports branding / theming using the configuration cascade, defining a templateID for a user or context. Check the [https://oxpedia.org/wiki/index.php?title=AppSuite:GuardCustomization OX Guard ~~Customisation~~] article for more details.		OX Guard version supports branding / theming using the configuration cascade, defining a templateID for a user or context. Check the [https://oxpedia.org/wiki/index.php?title=AppSuite:GuardCustomization OX Guard Customization] article for more details.

	==== Mail Resolver ====		==== Mail Resolver ====
Line 499:		Line 499:

	Guard provides three capabilities for users in the environment as well as a basic "core" level:		Guard provides three capabilities for users in the environment as well as a basic "core" level:

			'''PGP'''

	* Guard: <code>com.openexchange.capability.guard</code>		* Guard: <code>com.openexchange.capability.guard</code>
Line 505:		Line 507:
	* Guard Docs: <code>com.openexchange.capability.guard-docs</code>		* Guard Docs: <code>com.openexchange.capability.guard-docs</code>

	The "core" Guard enabled a basic read functionality for Guard encrypted emails. We recommend enabling this for all users, as this allows all recipients to read Guard emails sent to them. Great opportunity for upsell. Recipients with only Guard enabled can then do a secure reply to the sender, but they can't start a new email or add recipients.		'''S/Mime'''

			* S/Mime: <code>com.openexchange.capability.smime</code>

			The "core" Guard enabled a basic read functionality for Guard PGP encrypted emails. We recommend enabling this for all users, as this allows all recipients to read Guard emails sent to them. Great opportunity for upsell. Recipients with only Guard enabled can then do a secure reply to the sender, but they can't start a new email or add recipients.

	'''Guard Mail''', '''Guard Drive''' and '''Guard Docs''' are additional options for users. "Guard Mail" allows users the full functionality of Guard emails. "Guard Drive" allows for encryption and decryption of Drive files and "Guard Docs" allows direct integration of Guard into Documents.		'''Guard Mail''', '''Guard Drive''' and '''Guard Docs''' are additional options for users. "Guard Mail" allows users the full functionality of Guard emails. "Guard Drive" allows for encryption and decryption of Drive files and "Guard Docs" allows direct integration of Guard into Documents.

	Each of those ~~three~~ Guard components is enabled for all users that have the according capability configured. Please note that users need to have the Drive permission set to use Guard Drive. So the users that have Guard Drive enabled must be a subset of those users with OX Drive permission. Since v7.6.0 we enforce this via the default configuration. Those capabilities can be activated for specific user by using the Open-Xchange provisioning scripts:		'''S/Mime''' enables S/Mime functionality for users (as of 2.10.7). May be used alone or with the above Guard capabilities.

			Each of those Guard components is enabled for all users that have the according capability configured. Please note that users need to have the Drive permission set to use Guard Drive. So the users that have Guard Drive enabled must be a subset of those users with OX Drive permission. Since v7.6.0 we enforce this via the default configuration. Those capabilities can be activated for specific user by using the Open-Xchange provisioning scripts:

	==== Guard Mail: ====		==== Guard PGP Mail: ====

	<source lang="bash">$ /opt/open-xchange/sbin/changeuser -c 1 -A oxadmin -P admin_password -u testuser --config/com.openexchange.capability.guard-mail=true</source>		<source lang="bash">$ /opt/open-xchange/sbin/changeuser -c 1 -A oxadmin -P admin_password -u testuser --config/com.openexchange.capability.guard-mail=true</source>
Line 518:		Line 526:
	<source lang="bash">$ /opt/open-xchange/sbin/changeuser -c 1 -A oxadmin -P admin_password -u testuser --config/com.openexchange.capability.guard-drive=true</source>		<source lang="bash">$ /opt/open-xchange/sbin/changeuser -c 1 -A oxadmin -P admin_password -u testuser --config/com.openexchange.capability.guard-drive=true</source>
	'''Please Note''': Guard Drive requires Guard Mail to be configured for the user as well. In addition, these capabilities may be configured globally by editing the <code>guard-api.properties</code> file on the OX backend.		'''Please Note''': Guard Drive requires Guard Mail to be configured for the user as well. In addition, these capabilities may be configured globally by editing the <code>guard-api.properties</code> file on the OX backend.

			=== S/Mime (as of 2.10.7) ===

			See [[AppSuite:OX_Guard_Smime \| OX Guard S/Mime]] for more details on S/Mime

	=== External Guest recipients ===		=== External Guest recipients ===

← Older revision		Revision as of 07:49, 8 July 2024
Line 114:		Line 114:
	The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node). -->		The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node). -->

	=== Debian Linux 10.0 (Buster) Version 2.10.3+ only ===		<!-- === Debian Linux 10.0 (Buster) Version 2.10.3+ only ===

	If not already done, add the following repositories to your Open-Xchange apt configuration:		If not already done, add the following repositories to your Open-Xchange apt configuration:
Line 130:		Line 130:
	$ apt-get update		$ apt-get update
	$ apt-get install open-xchange-guard open-xchange-guard-file-storage		$ apt-get install open-xchange-guard open-xchange-guard-file-storage
	The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node).		The packages <code>open-xchange-guard-ui</code> <code>open-xchange-rest</code> and <code>open-xchange-guard-backend-plugin</code> missing in the distributed installation have to be installed on the node running the middleware. The package <code>open-xchange-guard-ui-static</code> must be installed in the frontend (apache node). -->

	=== Debian Linux 11.0 (Bullseye) Version 2.10.6+ only ===		=== Debian Linux 11.0 (Bullseye) Version 2.10.6+ only ===
Line 289:		Line 289:
	$ apt-get dist-upgrade -s</source> -->		$ apt-get dist-upgrade -s</source> -->

	=== Debian Linux 10.0 (Buster) ===		<!-- === Debian Linux 10.0 (Buster) ===

	If not already done, add the following repositories to your Open-Xchange apt configuration:		If not already done, add the following repositories to your Open-Xchange apt configuration:
Line 303:		Line 303:
	If you want to see, what apt-get is going to do without actually doing it, you can run:		If you want to see, what apt-get is going to do without actually doing it, you can run:

	$ apt-get dist-upgrade -s</source>		$ apt-get dist-upgrade -s</source> -->

	=== Debian Linux 11.0 (Bullseye) ===		=== Debian Linux 11.0 (Bullseye) ===

AppSuite:OX Guard - Revision history

Khgras at 10:04, 12 May 2026

Khgras: /* Debian Linux 11.0 (Bullseye) */

Khgras: /* Download and Installation */

Khgras: /* Debian Linux 11.0 (Bullseye) *Version 2.10.6+ only* */

Khgras at 07:49, 8 July 2024

Khgras: /* Redhat Enterprise Linux 7 or CentOS 7 */

Khgras: /* Redhat Enterprise Linux 8 */

Khgras: /* Redhat Enterprise Linux 7 or CentOS 7 */

Greg.hill: /* External */

Greg.hill at 14:59, 25 January 2023

Khgras: /* Debian Linux 11.0 (Bullseye) Version 2.10.6+ only */