Deployment Topologies
The xorlab Security Platform supports several deployment options. If you’re unsure which to choose, we recommend starting with theDefault Chain.
- Default Chain: xorlab is located between your gateway and the internal mailbox server like Exchange.
- Microsoft 365: xorlab is integrated directly with M365 via connectors.
- Star: A central gateway integrates xorlab in a Star layout.
- Front MTA: xorlab is the gateway (front MTA) and receives emails directly from the internet.
- Full Chain: Same as Default Chain, but inter-tenant emails pass twice through xorlab.
Default Chain Topology
Guarded Tenants
Expand to read the instructions.
Expand to read the instructions.
name: Define the name of the tenant. Also visible in the web interface.domains: Specify the guarded domains of the tenant. Ensure the primary domain is listed first.tenantSelector: Reference the headerName and headerValue of a header that will be used to identify the tenant.Transport Map
Expand to read the instructions.
Expand to read the instructions.
- Define a rule for each guarded domain, specifying the correct next-hop destination.
- Use the
smtpcommand to specify the SMTP endpoint (e.g., the front MTA). - The last line should be a default route to handle outgoing email traffic.
Client Access
Expand to read the instructions.
Expand to read the instructions.
- Specify the IP address of the SMTP client, typically the Front MTA or Exchange Server, responsible for routing emails to xorlab.
- Use the
permitcommand to allow these connections to access xorlab and forward emails.
Client Access Tenant
Expand to read the instructions.
Expand to read the instructions.
- Structure:
<CIDRblock> PREPEND <headerName>: <headerValue> - The
<CIDRblock>specifies the IP range of the SMTP client responsible for routing emails to xorlab - Add
/32to restrict to a single IP address. - The
<headerName>and<headerValue>refer to thetenantSelectoror thetenantSelectors. - The file should always end with an
0.0.0.0/0entry to prevent header spoofing.
M365 Topology
Guarded Tenants
Expand to read the instructions.
Expand to read the instructions.
domains: Specify the guarded domains of the tenant. Ensure the primary domain is listed first.tenantSelectors: Refer to the x-originatororg header of each accepted domain in your Microsoft Exchange environment.Recommendation: List every 'Accepted Domain' as tenantSelector.
Recommendation: List every 'Accepted Domain' as tenantSelector.
- Go to admin.cloud.microsoft/exchange#/accepteddomains
- For each domain listed, define a separate
selectoringuarded_tenants.yml - Use the following format for each selector:
- HeaderName:
"x-originatororg" - Header value: The domain listed in the “Accepted Domain” column, between double quotation marks.
- HeaderName:
Header Checks
Expand to read the instructions.
Expand to read the instructions.
x-originatororgshould correspond to theheaderNameof thetenantSelectorsdefined inguarded_tenants.tenantA.comandtenantB.comshould correspond to theheaderValueof thetenantSelectorsdefined inguarded_tenants.tenanta/b-com.mail.protection.outlook.comshould correspond to the SMTP endpoint (MX server) of theheaderValueof thetenantSelectorsdefined inguarded_tenants.
Star Topology
Guarded Tenants
Expand to read the instructions.
Expand to read the instructions.
name: Define the name of the tenant. Also visible in the web interface.domains: Specify the guarded domains of the tenant. Ensure the primary domain is listed first.tenantSelector: Identifies the header that will be set when the email is coming from the trusted infrastructure.Transport Rules
Expand to read the instructions.
Expand to read the instructions.
- The
*wildcard matches all traffic. <email-next-hop>should contain the domain of the central email gateway.
Client Access
Expand to read the instructions.
Expand to read the instructions.
- Specify the IP address of central gateway that will send emails to xorlab.
- Use the
permitcommand to allow these connections to access xorlab and forward emails.
Front MTA Topology
Guarded Tenants
Expand to read the instructions.
Expand to read the instructions.
name: Define the name of the tenant. Also visible in the web interface.domains: Specify the guarded domains of the tenant. Ensure the primary domain is listed first.tenantSelector: Reference the headerName and headerValue of a header that will be added by xorlab.The headers referenced intenantSelectorneed to match the entries in theclient_access_tenantconfiguration.
Client Access
Expand to read the instructions.
Expand to read the instructions.
- Specify the IP address of the allowed SMTP client, typically the Exchange server.
- Use the
permitcommand to allow these connections to access xorlab and forward emails.
Client Access Tenant
Expand to read the instructions.
Expand to read the instructions.
- Structure:
<CIDRblock> PREPEND <headerName>: <headerValue> - The
<CIDRblock>specifies the IP range of each tenant’s mail server - Add
/32to restrict to a single IP address. - The
<headerName>and<headerValue>refer to thetenantSelectoror thetenantSelectors. - The file should always end with an
0.0.0.0/0entry to prevent header spoofing.
Transport Map
Expand to read the instructions.
Expand to read the instructions.
- Define a rule for each guarded domain, specifying the correct next-hop destination.
- Use the
smtpcommand to specify the SMTP endpoint (e.g., the front MTA).
Full Chain Topology
In the Full Chain Topology xorlab sits between a front MTA and the Exchange server. The difference to the default chain is that inter-tenant emails are routed to the front MTA and back. Important: the front MTA needs to strip away all x-xor-trusted-client headers from all emails to ensure proper routing.Guarded Tenants
Expand to read the instructions.
Expand to read the instructions.
domains: Specify the guarded domains of the tenant. Ensure the primary domain is listed first.tenantSelector: If needed, reference a unique trusted headerName and headerValue for specific tenants.interTenantMessageSplitting: Controls whether xorlab splits emails sent between tenants into separate incoming and outgoing messages. By default, this attribute is set to true but for the Full Chain Topology you are required to set it to false.configSets - tenantSelector: Reference the headerName and headerValue of a header that will be added by xorlab.The headers referenced intenantSelectorandtenantSelectorsneed to match the entries in theclient_access_tenantconfiguration.
Header Checks
Expand to read the instructions.
Expand to read the instructions.
- Structure:
/^<headerName>:<headerValue>/ FILTER smtp:[<SMTP endpoint>] - The
<SMTP endpoint>should include the domain of either the frontMta or the guarded domain’s mail server.
Client Access
Expand to read the instructions.
Expand to read the instructions.
- Specify the IP address of the SMTP client, typically the Front MTA or Exchange Server, responsible for routing emails to xorlab.
- Use the
permitcommand to allow these connections to access xorlab and forward emails.
Client Access Tenant
Expand to read the instructions.
Expand to read the instructions.
- Structure:
<CIDRblock> PREPEND <headerName>: <headerValue> - The
<CIDRblock>specifies the IP range of the Exchange Server. - Add
/32to restrict to a single IP address. - The
<headerName>and<headerValue>refer to thetenantSelectoror thetenantSelectors. - The file should always end with an
0.0.0.0/0entry to prevent header spoofing.
How to define tenant selectors
Tenant selectors are used to assign emails to the correct tenant by evaluating specific mail headers. There are two configuration options:-
tenantSelector: Defines a single set of headers that must all match to assign the message to a tenant (AND logic). -
tenantSelectors: One property that enables you to define more then oneselector. Aselectorcan reference one or more header sets. If multiple header sets are referenced, all need to match (AND-logic). The message matches a tenant if at least oneSelectormatches (OR logic).
configSets.
shared/guarded_tenants.yml, click Publish. The new configuration becomes active within about one minute.
Explanation of tenant selection logic
When processing an email, the system determines which Tenant it belongs to based on the following rules. Step 1: Single Match: If exactly one Tenant Selector matches the email, the email is assigned to that Tenant. Step 2: No Match: If no Tenant Selector matches the email, choose the Tenant based on the recipient addresses. If no Tenant can be identified, assign the email to the specialUNKNOWN Tenant.
Step 3: Multiple Matches: If multiple Tenant Selectors match, the selection is resolved using the logic below in the specified order.
-
Assign Tenant based on sender address.
- Prefer a match on the sender’s envelope-from address.
- If no match, check the header-from address.
- Assign Tenant based on recipient addresses. Choose only from the matched Tenant Selectors.
-
If no Tenant can be identified, assign the email to the special
UNKNOWNTenant.
- For all recipients of the email that do not match any tenants (outgoing email) or match the tenant of the email itself (internal or incoming email), deliver the email.
-
For all recipients of the email that match a different tenant than the one of the email itself (inter-tenant email):
- If
interTenantMessageSplittingis active, re-process the email again with a separateGGRIDand assigned to the recipient tenant. No email delivery at this point. - Else deliver the email. We expect the email to pass again through xorlab.
- If