This Helm chart will deploy Virtru’s email gateway. This chart can support deploying multiple different gateway modes and functions. You can read this documentation on Virtru’s support site here:
virtru
These are the requirements before getting started with this chart:
kubectl
The first step will be to determine which gateway modes and functions you wish to utilize. The options are as follows:
There are a number of ways that Kubernetes secrets can be managed. If you do not have an existing external secret manager for your Kubernetes clusters, you can create secrets by using the appSecrets
section of the values.yaml
file.
Please note we strongly advise you consider using an external secrets manager. Creating secrets via the values.yaml
is a default option to help get your gateway up and running more quickly.
values.yaml
fileThis section will detail potential changes that you will need to make to your values.yaml
file.
gatewayModes
For each gateway use case identified above, ensure that the specific mode’s enabled
key is toggled to true. The default ports are non-standard custom ports, but any port can be used as they all translate to port 25 internally on the pod.
standardConfig
gatewayHostname
- FQDN of the gatewayprimaryMailingDomain
- Your primary email domaingatewayTransportMaps
- Next hop for your gateway, defaults to Google SMTP Relay serviceinboundRelayAddresses
- Determine IPs you wish to allow traffic into the gateway container from (default is open at the container level and to build firewall rules to only allow specific source IPs into the pod)
headers.xHeaderAuthEnabled
- Defaults to true. If enabled, you must also set xHeaderAuthSecret and add the secret value to messages prior to hitting the gatewayappSecrets
Set the values based on the information below:
gateway-amplitude-api-key
- Provided by Virtrugateway-api-token-name
- Provided by Virtrugateway-api-token-secret
- Provided by Virtrutrue
)
gateway-xheader-auth-secret
- The secret value to be added in your headers before sending mail to the gateway (example: 123456789
would mean you have to have a header on every email sent to the gateway of X-Header-Virtru-Auth:123456789
)gateway-sasl-auth-upstream
- The auth path for your SMTP authentication to the next hop (example: smtp-relay.gmail.com=>gateway-service-account@example.com=>appSpecificPassword
)gateway-sasl-auth-downstream
- The auth path for your SMTP authentication from the previous hop to the Virtru gateway (example: smtp-relay.gmail.com=>gateway-service-account@example.com=>appSpecificPassword
)publicKey
- The public key from your DKIM record in your DNSprivateKey
- The private key matching your DKIM record’s public keyadditionalConfig
You may, depending on your email needs, wish to update a few values in this section. Below are a few of the primary variables you may wish to adjust:
saslAuth.smtpDownstream.enabled
- This will enable SASL auth for your next hop. If you choose to enable this, you will need to create the gateway-sasl-auth-upstream
file in your secret detailed abovedecryptThenEncrypt
- If you are using a multi gateway approach (ex: decrypt email => Scan content => re-encrypt email), this should be set to 1 (true)dkimSigning
- If you wish to have the gateway DKIM sign your emails, set enabled to true
. You must have a public DKIM record for the selector you choose with a public key that matches the keys inputted into appSecrets.dkimSigning
Use a standard helm install command to deploy your gateway(s). An example command is listed below:
helm install -n virtru -f ./values.yaml gateway ./ --create-namespace
Refer to standard documentation for Gateway configuration. You can get your endpoints to set as smart hosts by running the following command:
kubectl -n virtru get services
And there should be public endpoints you can use when relaying mail to your new gateways.
values.yaml
A full list of Virtru-specific variables in values.yaml
can be found below:
values.yaml |
Virtru Documentation value |
---|---|
gatewayHostname |
GATEWAY_HOSTNAME |
primaryMailingDomain |
GATEWAY_ORGANIZATION_DOMAIN |
gatewayTransportMaps |
GATEWAY_TRANSPORT_MAPS |
inboundRelayAddresses |
GATEWAY_RELAY_ADDRESSES |
headers.xHeaderAuthEnabled |
GATEWAY_XHEADER_AUTH_ENABLED |
saslAuth.smtpDownstream.enabled |
GATEWAY_SMTP_SASL_ENABLED_DOWNSTREAM |
saslAuth.smtpDownstream.securityOptions |
GATEWAY_SMTP_SASL_SECURITY_OPTIONS |
saslAuth.smtpdUpwnstream.enabled |
GATEWAY_SMTPD_SASL_ENABLED_UPSTREAM |
saslAuth.smtpdUpwnstream.mechanisms |
GATEWAY_SMTPD_SASL_MECHANISMS |
maxQueueLifetime |
MAX_QUEUE_LIFETIME |
maxBackoffTime |
MAX_BACKOFF_TIME |
minBackoffTime |
MIN_BACKOFF_TIME |
queueRunDelay |
QUEUE_RUN_DELAY |
smtpdUseTls |
GATEWAY_SMTPD_USE_TLS |
smtpdSecurityLevel |
GATEWAY_SMTPD_SECURITY_LEVEL |
smtpdTlsComplianceUpstream.enabled |
N/A, toggles on GATEWAY_SMTPD_TLS_COMPLIANCE_UPSTREAM |
smtpdTlsComplianceUpstream.compliance |
GATEWAY_SMTPD_TLS_COMPLIANCE_UPSTREAM |
smtpUseTls |
GATEWAY_SMTP_USE_TLS |
smtpSecurityLevel |
GATEWAY_SMTP_SECURITY_LEVEL |
smtpTlsComplianceDownstream.enabled |
N/A, toggles on GATEWAY_SMTP_TLS_COMPLIANCE_DOWNSTREAM |
smtpTlsComplianceDownstream.compliance |
GATEWAY_SMTP_TLS_COMPLIANCE_DOWNSTREAM |
cks.keyProvider |
GATEWAY_ENCRYPTION_KEY_PROVIDER |
cks.sessionKeyExpiry |
GATEWAY_CKS_SESSION_KEY_EXPIRY_IN_MINS |
dlpRuleCache |
GATEWAY_DLP_CACHE_DURATION |
tlsPolicyMaps.enabled |
N/A, toggles on GATEWAY_SMTP_TLS_POLICY_MAPS |
tlsPolicyMaps.policyMaps |
GATEWAY_SMTP_TLS_POLICY_MAPS |
replaceFromEnabled |
GATEWAY_REPLACEMENT_FROM_ENABLED |
decryptPfpFiles |
GATEWAY_DECRYPT_PERSISTENT_PROTECTED_ATTACHMENTS |
decryptThenEncrypt |
GATEWAY_DECRYPT_THEN_ENCRYPT |
proxyProtocol |
GATEWAY_PROXY_PROTOCOL |
verboseLogging |
GATEWAY_VERBOSE_LOGGING |
cacheSmtpConnections.enabled |
GATEWAY_SMTP_CACHE_CONNECTIONS |
cacheSmtpConnections.connectionCacheTimeLimit |
GATEWAY_SMTP_CONNECTION_CACHE_TIME_LIMIT |
dkimSigning.enabled |
N/A, toggles on GATEWAY_DKIM_DOMAINS |
dkimSigning.selector |
Generates the subdomain for GATEWAY_DKIM_DOMAINS (<dkimSigning.selector>._domainkey.primaryMailingDomain ) |
abac.oidcClientId |
The client id that gateway should use to communicate with the DSP platform. |
abac.platformEndpoint |
The endpoint where the DSP platform is deployed. |
abac.taggingPdpEndpoint |
The endpoint where the tagging PDP is deployed. |
abac.taggingPdpAssertionType |
The assertion type to use with the tagging pdp; either urn:us:gov:ic:ed or urn:nato:stanag:5636:A:1:elements:json . |
abac.trimBlockedRecipients |
Whether we should remove header recipients that are not entitled to receive an email. |
abac.plaintextConnection |
Whether we should communicate with the platform and the tagging PDP over a plaintext connection. |
abac.encryptEmail |
Whether we should encrypt all email sent through this mode. |
abac.extraCas |
A list of extra CAs to trust. Usually the cert for the DSP platform. |
inboundRelayAddresses
values for Gmail and Office 365Mail Provider | CIDR Blocks |
---|---|
Gmail | 35.190.247.0/24,64.233.160.0/19,66.102.0.0/20,66.249.80.0/20,72.14.192.0/18,74.125.0.0/16,108.177.8.0/21,173.194.0.0/16,209.85.128.0/17,216.58.192.0/19,216.239.32.0/19,172.217.0.0/19,172.217.32.0/20,172.217.128.0/19,172.217.160.0/20,172.217.192.0/19,108.177.96.0/19,35.191.0.0/16,130.211.0.0/22 |
Office 365 | 23.103.132.0/22,23.103.136.0/21,23.103.144.0/20,23.103.198.0/23,23.103.200.0/22,23.103.212.0/22,40.92.0.0/14,40.107.0.0/17,40.107.128.0/18,52.100.0.0/14,65.55.88.0/24,65.55.169.0/24,94.245.120.64/26,104.47.0.0/17,104.212.58.0/23,134.170.132.0/24,134.170.140.0/24,157.55.234.0/24,157.56.110.0/23,157.56.112.0/24,207.46.51.64/26,207.46.100.0/24,207.46.163.0/24,213.199.154.0/24,213.199.180.128/26,216.32.180.0/23 |