mirror of
https://github.com/postalserver/postal.git
synced 2026-10-18 18:26:06 +00:00
Compare commits
17
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
030e450a30 | ||
|
|
d96eddbade | ||
|
|
ced77a3860 | ||
|
|
3be663dc89 | ||
|
|
d038eaa8c7 | ||
|
|
3b3defe271 | ||
|
|
029bfe098d | ||
|
|
0445e5c509 | ||
|
|
11c9814474 | ||
|
|
4314a6ec1e | ||
|
|
8be1e27fec | ||
|
|
8ef89606bc | ||
|
|
84f4e20f05 | ||
|
|
9243524035 | ||
|
|
dca7f90b90 | ||
|
|
cad2aa6808 | ||
|
|
b611d577af |
@@ -34,3 +34,6 @@ BRANCH
|
||||
.rubocop-https*
|
||||
.env*
|
||||
|
||||
node_modules
|
||||
yarn.lock
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{
|
||||
".": "3.3.5"
|
||||
".": "3.4.0"
|
||||
}
|
||||
|
||||
@@ -2,6 +2,53 @@
|
||||
|
||||
This file contains all the latest changes and updates to Postal.
|
||||
|
||||
## [3.4.0](https://github.com/postalserver/postal/compare/3.3.7...3.4.0) (2026-10-01)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add configurable Postal logger level defaulting to INFO ([#3626](https://github.com/postalserver/postal/issues/3626)) ([ced77a3](https://github.com/postalserver/postal/commit/ced77a3860c23779889aec8dacd2642f20d10cea))
|
||||
* **dkim:** make key size configurable and allow keys to be rotated ([d96eddb](https://github.com/postalserver/postal/commit/d96eddbadeda600595d6247486f9ceb8e99cbc15))
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* give each worker process a unique locker identity ([#3628](https://github.com/postalserver/postal/issues/3628)) ([3be663d](https://github.com/postalserver/postal/commit/3be663dc8931bd731516bafd6edff6b0fbd03df2))
|
||||
|
||||
## [3.3.7](https://github.com/postalserver/postal/compare/3.3.6...3.3.7) (2026-06-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **http:** prevent SSRF in outbound webhook and HTTP endpoint requests ([11c9814](https://github.com/postalserver/postal/commit/11c9814474f956619da35e8385ef7fab9f304de0))
|
||||
* **message-db:** prevent SQL injection via condition keys (GHSA-x2hq-rfpg-3xr5) ([4314a6e](https://github.com/postalserver/postal/commit/4314a6ec1e2812daa67dd20effd1db1769c1f8e8))
|
||||
* **specs:** stub IPv6 support in address guard IPv6 literal spec ([029bfe0](https://github.com/postalserver/postal/commit/029bfe098d9b8c0b5cafc49eac33e767f5748cd3))
|
||||
|
||||
|
||||
### Miscellaneous Chores
|
||||
|
||||
* **deps:** upgrade rack & rails ([0445e5c](https://github.com/postalserver/postal/commit/0445e5c509870dfe9c16366c53dee3fc02ad3904))
|
||||
* update security vulnerability reporting instructions ([8be1e27](https://github.com/postalserver/postal/commit/8be1e27fec489ab659ef5e909f705932028b1694))
|
||||
|
||||
## [3.3.6](https://github.com/postalserver/postal/compare/3.3.5...3.3.6) (2026-04-28)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **messages:** sandbox rendered email HTML as extra XSS defence ([cad2aa6](https://github.com/postalserver/postal/commit/cad2aa6808519a3ff25215f09f4966d9fa3bb372))
|
||||
|
||||
|
||||
### Miscellaneous Chores
|
||||
|
||||
* ignore node modules and yarn.lock ([b611d57](https://github.com/postalserver/postal/commit/b611d577af79b8e1e75b6d47fa04d1ba03e34eec))
|
||||
|
||||
|
||||
### Code Refactoring
|
||||
|
||||
* **auth:** tighten return_to validation ([84f4e20](https://github.com/postalserver/postal/commit/84f4e20f05db2d11b0144f95960c956f8221e657))
|
||||
* **helpers:** escape interpolated values in select options ([9243524](https://github.com/postalserver/postal/commit/924352403553dcfcc569876ca76c219493fac9d6))
|
||||
* **tracking:** remove unused src image proxy ([dca7f90](https://github.com/postalserver/postal/commit/dca7f90b9046247c0d953567be35921167e79d87))
|
||||
|
||||
## [3.3.5](https://github.com/postalserver/postal/compare/3.3.4...3.3.5) (2026-02-01)
|
||||
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ gem "ostruct"
|
||||
gem "prometheus-client"
|
||||
gem "puma"
|
||||
gem "rackup"
|
||||
gem "rails", "= 7.1.5.2"
|
||||
gem "rails", "= 7.1.6"
|
||||
gem "resolv"
|
||||
gem "secure_headers"
|
||||
gem "sentry-rails"
|
||||
|
||||
+104
-92
@@ -2,35 +2,36 @@ GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
abbrev (0.1.2)
|
||||
actioncable (7.1.5.2)
|
||||
actionpack (= 7.1.5.2)
|
||||
activesupport (= 7.1.5.2)
|
||||
actioncable (7.1.6)
|
||||
actionpack (= 7.1.6)
|
||||
activesupport (= 7.1.6)
|
||||
nio4r (~> 2.0)
|
||||
websocket-driver (>= 0.6.1)
|
||||
zeitwerk (~> 2.6)
|
||||
actionmailbox (7.1.5.2)
|
||||
actionpack (= 7.1.5.2)
|
||||
activejob (= 7.1.5.2)
|
||||
activerecord (= 7.1.5.2)
|
||||
activestorage (= 7.1.5.2)
|
||||
activesupport (= 7.1.5.2)
|
||||
actionmailbox (7.1.6)
|
||||
actionpack (= 7.1.6)
|
||||
activejob (= 7.1.6)
|
||||
activerecord (= 7.1.6)
|
||||
activestorage (= 7.1.6)
|
||||
activesupport (= 7.1.6)
|
||||
mail (>= 2.7.1)
|
||||
net-imap
|
||||
net-pop
|
||||
net-smtp
|
||||
actionmailer (7.1.5.2)
|
||||
actionpack (= 7.1.5.2)
|
||||
actionview (= 7.1.5.2)
|
||||
activejob (= 7.1.5.2)
|
||||
activesupport (= 7.1.5.2)
|
||||
actionmailer (7.1.6)
|
||||
actionpack (= 7.1.6)
|
||||
actionview (= 7.1.6)
|
||||
activejob (= 7.1.6)
|
||||
activesupport (= 7.1.6)
|
||||
mail (~> 2.5, >= 2.5.4)
|
||||
net-imap
|
||||
net-pop
|
||||
net-smtp
|
||||
rails-dom-testing (~> 2.2)
|
||||
actionpack (7.1.5.2)
|
||||
actionview (= 7.1.5.2)
|
||||
activesupport (= 7.1.5.2)
|
||||
actionpack (7.1.6)
|
||||
actionview (= 7.1.6)
|
||||
activesupport (= 7.1.6)
|
||||
cgi
|
||||
nokogiri (>= 1.8.5)
|
||||
racc
|
||||
rack (>= 2.2.4)
|
||||
@@ -38,35 +39,36 @@ GEM
|
||||
rack-test (>= 0.6.3)
|
||||
rails-dom-testing (~> 2.2)
|
||||
rails-html-sanitizer (~> 1.6)
|
||||
actiontext (7.1.5.2)
|
||||
actionpack (= 7.1.5.2)
|
||||
activerecord (= 7.1.5.2)
|
||||
activestorage (= 7.1.5.2)
|
||||
activesupport (= 7.1.5.2)
|
||||
actiontext (7.1.6)
|
||||
actionpack (= 7.1.6)
|
||||
activerecord (= 7.1.6)
|
||||
activestorage (= 7.1.6)
|
||||
activesupport (= 7.1.6)
|
||||
globalid (>= 0.6.0)
|
||||
nokogiri (>= 1.8.5)
|
||||
actionview (7.1.5.2)
|
||||
activesupport (= 7.1.5.2)
|
||||
actionview (7.1.6)
|
||||
activesupport (= 7.1.6)
|
||||
builder (~> 3.1)
|
||||
cgi
|
||||
erubi (~> 1.11)
|
||||
rails-dom-testing (~> 2.2)
|
||||
rails-html-sanitizer (~> 1.6)
|
||||
activejob (7.1.5.2)
|
||||
activesupport (= 7.1.5.2)
|
||||
activejob (7.1.6)
|
||||
activesupport (= 7.1.6)
|
||||
globalid (>= 0.3.6)
|
||||
activemodel (7.1.5.2)
|
||||
activesupport (= 7.1.5.2)
|
||||
activerecord (7.1.5.2)
|
||||
activemodel (= 7.1.5.2)
|
||||
activesupport (= 7.1.5.2)
|
||||
activemodel (7.1.6)
|
||||
activesupport (= 7.1.6)
|
||||
activerecord (7.1.6)
|
||||
activemodel (= 7.1.6)
|
||||
activesupport (= 7.1.6)
|
||||
timeout (>= 0.4.0)
|
||||
activestorage (7.1.5.2)
|
||||
actionpack (= 7.1.5.2)
|
||||
activejob (= 7.1.5.2)
|
||||
activerecord (= 7.1.5.2)
|
||||
activesupport (= 7.1.5.2)
|
||||
activestorage (7.1.6)
|
||||
actionpack (= 7.1.6)
|
||||
activejob (= 7.1.6)
|
||||
activerecord (= 7.1.6)
|
||||
activesupport (= 7.1.6)
|
||||
marcel (~> 1.0)
|
||||
activesupport (7.1.5.2)
|
||||
activesupport (7.1.6)
|
||||
base64
|
||||
benchmark (>= 0.3)
|
||||
bigdecimal
|
||||
@@ -93,10 +95,11 @@ GEM
|
||||
execjs (~> 2)
|
||||
base64 (0.3.0)
|
||||
bcrypt (3.1.20)
|
||||
benchmark (0.4.1)
|
||||
bigdecimal (3.2.3)
|
||||
benchmark (0.5.0)
|
||||
bigdecimal (4.1.2)
|
||||
bindata (2.5.0)
|
||||
builder (3.2.4)
|
||||
builder (3.3.0)
|
||||
cgi (0.5.1)
|
||||
chronic (0.10.2)
|
||||
coffee-rails (5.0.0)
|
||||
coffee-script (>= 2.2.0)
|
||||
@@ -105,8 +108,8 @@ GEM
|
||||
coffee-script-source
|
||||
execjs
|
||||
coffee-script-source (1.12.2)
|
||||
concurrent-ruby (1.3.5)
|
||||
connection_pool (2.5.4)
|
||||
concurrent-ruby (1.3.6)
|
||||
connection_pool (3.0.2)
|
||||
crack (1.0.0)
|
||||
bigdecimal
|
||||
rexml
|
||||
@@ -115,7 +118,7 @@ GEM
|
||||
activerecord (>= 5.a)
|
||||
database_cleaner-core (~> 2.0)
|
||||
database_cleaner-core (2.0.1)
|
||||
date (3.4.1)
|
||||
date (3.5.1)
|
||||
diff-lcs (1.6.2)
|
||||
domain_name (0.6.20240107)
|
||||
dotenv (3.0.2)
|
||||
@@ -123,8 +126,8 @@ GEM
|
||||
dynamic_form (1.2.0)
|
||||
email_validator (2.2.4)
|
||||
activemodel
|
||||
erb (5.0.2)
|
||||
erubi (1.12.0)
|
||||
erb (6.0.4)
|
||||
erubi (1.13.1)
|
||||
execjs (2.7.0)
|
||||
factory_bot (6.4.6)
|
||||
activesupport (>= 5.0.0)
|
||||
@@ -149,11 +152,12 @@ GEM
|
||||
hashdiff (1.1.0)
|
||||
hashie (5.0.0)
|
||||
highline (2.1.0)
|
||||
i18n (1.14.7)
|
||||
i18n (1.14.8)
|
||||
concurrent-ruby (~> 1.0)
|
||||
io-console (0.8.1)
|
||||
irb (1.15.2)
|
||||
io-console (0.8.2)
|
||||
irb (1.18.0)
|
||||
pp (>= 0.6.0)
|
||||
prism (>= 1.3.0)
|
||||
rdoc (>= 4.0.0)
|
||||
reline (>= 0.4.2)
|
||||
jquery-rails (4.5.1)
|
||||
@@ -189,42 +193,45 @@ GEM
|
||||
konfig-config (3.0.0)
|
||||
hashie
|
||||
logger (1.7.0)
|
||||
loofah (2.24.1)
|
||||
loofah (2.25.1)
|
||||
crass (~> 1.0.2)
|
||||
nokogiri (>= 1.12.0)
|
||||
mail (2.8.1)
|
||||
mail (2.9.0)
|
||||
logger
|
||||
mini_mime (>= 0.1.1)
|
||||
net-imap
|
||||
net-pop
|
||||
net-smtp
|
||||
marcel (1.1.0)
|
||||
marcel (1.2.1)
|
||||
mini_mime (1.1.5)
|
||||
minitest (5.25.5)
|
||||
minitest (6.0.6)
|
||||
drb (~> 2.0)
|
||||
prism (~> 1.5)
|
||||
mutex_m (0.3.0)
|
||||
mysql2 (0.5.6)
|
||||
net-http (0.4.1)
|
||||
uri
|
||||
net-imap (0.5.11)
|
||||
net-imap (0.6.4)
|
||||
date
|
||||
net-protocol
|
||||
net-pop (0.1.2)
|
||||
net-protocol
|
||||
net-protocol (0.2.2)
|
||||
timeout
|
||||
net-smtp (0.4.0.1)
|
||||
net-smtp (0.5.1)
|
||||
net-protocol
|
||||
nifty-utils (1.1.7)
|
||||
nilify_blanks (1.4.0)
|
||||
activerecord (>= 4.0.0)
|
||||
activesupport (>= 4.0.0)
|
||||
nio4r (2.7.4)
|
||||
nokogiri (1.18.10-aarch64-linux-gnu)
|
||||
nio4r (2.7.5)
|
||||
nokogiri (1.19.3-aarch64-linux-gnu)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.18.10-arm64-darwin)
|
||||
nokogiri (1.19.3-arm64-darwin)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.18.10-x86_64-darwin)
|
||||
nokogiri (1.19.3-x86_64-darwin)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.18.10-x86_64-linux-gnu)
|
||||
nokogiri (1.19.3-x86_64-linux-gnu)
|
||||
racc (~> 1.4)
|
||||
omniauth (2.1.2)
|
||||
hashie (>= 3.4.6)
|
||||
@@ -253,18 +260,19 @@ GEM
|
||||
parallel (1.22.1)
|
||||
parser (3.2.1.1)
|
||||
ast (~> 2.4.1)
|
||||
pp (0.6.2)
|
||||
pp (0.6.3)
|
||||
prettyprint
|
||||
prettyprint (0.2.0)
|
||||
prism (1.9.0)
|
||||
prometheus-client (4.2.2)
|
||||
psych (5.2.6)
|
||||
psych (5.4.0)
|
||||
date
|
||||
stringio
|
||||
public_suffix (5.0.4)
|
||||
puma (7.0.4)
|
||||
nio4r (~> 2.0)
|
||||
racc (1.8.1)
|
||||
rack (3.2.1)
|
||||
rack (3.2.6)
|
||||
rack-oauth2 (2.2.1)
|
||||
activesupport
|
||||
attr_required
|
||||
@@ -276,49 +284,52 @@ GEM
|
||||
base64 (>= 0.1.0)
|
||||
logger (>= 1.6.0)
|
||||
rack (>= 3.0.0, < 4)
|
||||
rack-session (2.1.1)
|
||||
rack-session (2.1.2)
|
||||
base64 (>= 0.1.0)
|
||||
rack (>= 3.0.0)
|
||||
rack-test (2.1.0)
|
||||
rack-test (2.2.0)
|
||||
rack (>= 1.3)
|
||||
rackup (2.2.1)
|
||||
rackup (2.3.1)
|
||||
rack (>= 3)
|
||||
rails (7.1.5.2)
|
||||
actioncable (= 7.1.5.2)
|
||||
actionmailbox (= 7.1.5.2)
|
||||
actionmailer (= 7.1.5.2)
|
||||
actionpack (= 7.1.5.2)
|
||||
actiontext (= 7.1.5.2)
|
||||
actionview (= 7.1.5.2)
|
||||
activejob (= 7.1.5.2)
|
||||
activemodel (= 7.1.5.2)
|
||||
activerecord (= 7.1.5.2)
|
||||
activestorage (= 7.1.5.2)
|
||||
activesupport (= 7.1.5.2)
|
||||
rails (7.1.6)
|
||||
actioncable (= 7.1.6)
|
||||
actionmailbox (= 7.1.6)
|
||||
actionmailer (= 7.1.6)
|
||||
actionpack (= 7.1.6)
|
||||
actiontext (= 7.1.6)
|
||||
actionview (= 7.1.6)
|
||||
activejob (= 7.1.6)
|
||||
activemodel (= 7.1.6)
|
||||
activerecord (= 7.1.6)
|
||||
activestorage (= 7.1.6)
|
||||
activesupport (= 7.1.6)
|
||||
bundler (>= 1.15.0)
|
||||
railties (= 7.1.5.2)
|
||||
rails-dom-testing (2.2.0)
|
||||
railties (= 7.1.6)
|
||||
rails-dom-testing (2.3.0)
|
||||
activesupport (>= 5.0.0)
|
||||
minitest
|
||||
nokogiri (>= 1.6)
|
||||
rails-html-sanitizer (1.6.2)
|
||||
loofah (~> 2.21)
|
||||
rails-html-sanitizer (1.7.0)
|
||||
loofah (~> 2.25)
|
||||
nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
|
||||
railties (7.1.5.2)
|
||||
actionpack (= 7.1.5.2)
|
||||
activesupport (= 7.1.5.2)
|
||||
railties (7.1.6)
|
||||
actionpack (= 7.1.6)
|
||||
activesupport (= 7.1.6)
|
||||
cgi
|
||||
irb
|
||||
rackup (>= 1.0.0)
|
||||
rake (>= 12.2)
|
||||
thor (~> 1.0, >= 1.2.2)
|
||||
tsort (>= 0.2)
|
||||
zeitwerk (~> 2.6)
|
||||
rainbow (3.1.1)
|
||||
rake (13.1.0)
|
||||
rdoc (6.14.2)
|
||||
rake (13.4.2)
|
||||
rdoc (7.2.0)
|
||||
erb
|
||||
psych (>= 4.0.0)
|
||||
tsort
|
||||
regexp_parser (2.7.0)
|
||||
reline (0.6.2)
|
||||
reline (0.6.3)
|
||||
io-console (~> 0.5)
|
||||
resolv (0.6.2)
|
||||
rexml (3.4.4)
|
||||
@@ -387,17 +398,18 @@ GEM
|
||||
actionpack (>= 5.2)
|
||||
activesupport (>= 5.2)
|
||||
sprockets (>= 3.0.0)
|
||||
stringio (3.1.7)
|
||||
stringio (3.2.0)
|
||||
swd (2.0.3)
|
||||
activesupport (>= 3)
|
||||
attr_required (>= 0.0.5)
|
||||
faraday (~> 2.0)
|
||||
faraday-follow_redirects
|
||||
temple (0.10.3)
|
||||
thor (1.3.0)
|
||||
thor (1.5.0)
|
||||
tilt (2.3.0)
|
||||
timecop (0.9.8)
|
||||
timeout (0.4.3)
|
||||
timeout (0.6.1)
|
||||
tsort (0.2.0)
|
||||
turbolinks (5.2.1)
|
||||
turbolinks-source (~> 5.2)
|
||||
turbolinks-source (5.2.0)
|
||||
@@ -423,7 +435,7 @@ GEM
|
||||
base64
|
||||
websocket-extensions (>= 0.1.0)
|
||||
websocket-extensions (0.1.5)
|
||||
zeitwerk (2.6.13)
|
||||
zeitwerk (2.8.2)
|
||||
|
||||
PLATFORMS
|
||||
aarch64-linux
|
||||
@@ -467,7 +479,7 @@ DEPENDENCIES
|
||||
prometheus-client
|
||||
puma
|
||||
rackup
|
||||
rails (= 7.1.5.2)
|
||||
rails (= 7.1.6)
|
||||
resolv
|
||||
rspec
|
||||
rspec-rails
|
||||
|
||||
+2
-2
@@ -11,5 +11,5 @@ We only support updates to the 3.x versions of Postal.
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
If you discover a vulnerability in Postal, please do not post an issue on GitHub. Instead you should send an
|
||||
e-mail to security@postalserver.io with details. We will get back to you directly.
|
||||
If you discover a vulnerability in Postal, please do not post an issue on GitHub. Please,
|
||||
instead, [create a new security advisory through GitHub](https://github.com/postalserver/postal/security/advisories/new).
|
||||
|
||||
@@ -62,10 +62,13 @@ class ApplicationController < ActionController::Base
|
||||
end
|
||||
|
||||
def url_with_return_to(url)
|
||||
if params[:return_to].blank? || !params[:return_to].starts_with?("/")
|
||||
return_to = params[:return_to]
|
||||
if return_to.blank? ||
|
||||
!return_to.start_with?("/") ||
|
||||
return_to.start_with?("//", "/\\")
|
||||
url_for(url)
|
||||
else
|
||||
params[:return_to]
|
||||
return_to
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -98,9 +98,48 @@ class DomainsController < ApplicationController
|
||||
redirect_to [:verify, organization, @server, @domain], alert: "You can't set up DNS for this domain until it has been verified."
|
||||
end
|
||||
|
||||
def regenerate_dkim
|
||||
if @domain.pending_dkim_key?
|
||||
redirect_to_with_json [:setup, organization, @server, @domain],
|
||||
alert: "A DKIM key change is already in progress for #{@domain.name}. Publish the new " \
|
||||
"record shown below, or cancel the change, before generating another key."
|
||||
return
|
||||
end
|
||||
|
||||
was_verified = @domain.dkim_status == "OK"
|
||||
@domain.regenerate_dkim_key!
|
||||
if was_verified
|
||||
redirect_to_with_json [:setup, organization, @server, @domain],
|
||||
notice: "A new DKIM key has been generated for #{@domain.name}. Add the new DNS record below — " \
|
||||
"your existing key will remain active until the new record has been verified. Keep the " \
|
||||
"old DNS record published afterward while messages signed with it may still be queued, " \
|
||||
"held, or available for redelivery."
|
||||
else
|
||||
redirect_to_with_json [:setup, organization, @server, @domain], notice: "A new DKIM key has been generated for #{@domain.name}. Update your DKIM DNS record with the new value below."
|
||||
end
|
||||
end
|
||||
|
||||
def cancel_dkim_regeneration
|
||||
@domain.cancel_pending_dkim_key!
|
||||
redirect_to_with_json [:setup, organization, @server, @domain], notice: "The pending DKIM key for #{@domain.name} has been discarded. Your existing key remains active."
|
||||
end
|
||||
|
||||
def check
|
||||
had_pending_dkim_key = @domain.pending_dkim_key?
|
||||
previous_dkim_record_name = @domain.dkim_record_name
|
||||
if @domain.check_dns(:manual)
|
||||
if had_pending_dkim_key && !@domain.pending_dkim_key?
|
||||
redirect_to_with_json [:setup, organization, @server, @domain],
|
||||
notice: "Your DNS records for #{@domain.name} look good! Your new DKIM key is now active. " \
|
||||
"Keep the old record at #{previous_dkim_record_name} published while messages " \
|
||||
"signed with the old key may still be queued, held, or available for redelivery."
|
||||
elsif @domain.pending_dkim_key?
|
||||
redirect_to_with_json [:setup, organization, @server, @domain],
|
||||
alert: "We couldn't verify the record for your new DKIM key yet. Your existing key remains " \
|
||||
"active. Check below for the expected record details."
|
||||
else
|
||||
redirect_to_with_json [organization, @server, :domains], notice: "Your DNS records for #{@domain.name} look good!"
|
||||
end
|
||||
else
|
||||
redirect_to_with_json [:setup, organization, @server, @domain], alert: "There seems to be something wrong with your DNS records. Check below for information."
|
||||
end
|
||||
|
||||
@@ -15,12 +15,9 @@ module LegacyAPI
|
||||
# OR an error if the message does not exist.
|
||||
#
|
||||
def message
|
||||
if api_params["id"].blank?
|
||||
render_parameter_error "`id` parameter is required but is missing"
|
||||
return
|
||||
end
|
||||
message = find_message
|
||||
return if performed?
|
||||
|
||||
message = @current_credential.server.message(api_params["id"])
|
||||
message_hash = { id: message.id, token: message.token }
|
||||
expansions = api_params["_expansions"]
|
||||
|
||||
@@ -111,12 +108,9 @@ module LegacyAPI
|
||||
# OR an error if the message does not exist.
|
||||
#
|
||||
def deliveries
|
||||
if api_params["id"].blank?
|
||||
render_parameter_error "`id` parameter is required but is missing"
|
||||
return
|
||||
end
|
||||
message = find_message
|
||||
return if performed?
|
||||
|
||||
message = @current_credential.server.message(api_params["id"])
|
||||
deliveries = message.deliveries.map do |d|
|
||||
{
|
||||
id: d.id,
|
||||
@@ -136,5 +130,37 @@ module LegacyAPI
|
||||
id: api_params["id"]
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Look up the message referenced by the request's `id` parameter.
|
||||
#
|
||||
# The legacy API only ever identifies a message by its integer ID. The
|
||||
# request body is parsed as JSON, so without validation a JSON object or
|
||||
# array supplied for `id` would arrive as a Ruby Hash/Array and be passed
|
||||
# straight through to the message database as a raw set of SQL conditions.
|
||||
# We therefore reject anything that is not a simple scalar before it can
|
||||
# reach the database and coerce the value to an integer ID.
|
||||
#
|
||||
# Renders an error and returns nil when the parameter is missing or is not
|
||||
# a scalar; otherwise returns the matched message (raising NotFound when no
|
||||
# message matches, which the actions rescue).
|
||||
#
|
||||
# @return [Postal::MessageDB::Message, nil]
|
||||
def find_message
|
||||
id = api_params["id"]
|
||||
|
||||
if id.blank?
|
||||
render_parameter_error "`id` parameter is required but is missing"
|
||||
return
|
||||
end
|
||||
|
||||
unless id.is_a?(String) || id.is_a?(Integer)
|
||||
render_parameter_error "`id` parameter must be a string or integer"
|
||||
return
|
||||
end
|
||||
|
||||
@current_credential.server.message(id.to_i)
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
@@ -89,6 +89,18 @@ class MessagesController < ApplicationController
|
||||
end
|
||||
|
||||
def html_raw
|
||||
override_content_security_policy_directives(
|
||||
default_src: %w('none'),
|
||||
script_src: %w('none'),
|
||||
style_src: %w('unsafe-inline'),
|
||||
img_src: %w(* data:),
|
||||
font_src: %w(*),
|
||||
frame_ancestors: %w('self'),
|
||||
form_action: %w('none'),
|
||||
base_uri: %w('none')
|
||||
)
|
||||
response.headers["X-Content-Type-Options"] = "nosniff"
|
||||
response.headers["Referrer-Policy"] = "no-referrer"
|
||||
render html: @message.html_body_without_tracking_image.html_safe
|
||||
end
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ module ApplicationHelper
|
||||
s << "<optgroup label='Server Domains'>"
|
||||
server_domains.each do |domain|
|
||||
selected = domain == selected_domain ? "selected='selected'" : ""
|
||||
s << "<option value='#{domain.id}' #{selected}>#{domain.name}</option>"
|
||||
s << "<option value='#{h(domain.id)}' #{selected}>#{h(domain.name)}</option>"
|
||||
end
|
||||
s << "</optgroup>"
|
||||
end
|
||||
@@ -43,7 +43,7 @@ module ApplicationHelper
|
||||
s << "<optgroup label='Organization Domains'>"
|
||||
organization_domains.each do |domain|
|
||||
selected = domain == selected_domain ? "selected='selected'" : ""
|
||||
s << "<option value='#{domain.id}' #{selected}>#{domain.name}</option>"
|
||||
s << "<option value='#{h(domain.id)}' #{selected}>#{h(domain.name)}</option>"
|
||||
end
|
||||
s << "</optgroup>"
|
||||
end
|
||||
@@ -60,7 +60,7 @@ module ApplicationHelper
|
||||
http_endpoints.each do |endpoint|
|
||||
value = "#{endpoint.class}##{endpoint.uuid}"
|
||||
selected = value == selected_value ? "selected='selected'" : ""
|
||||
s << "<option value='#{value}' #{selected}>#{endpoint.description}</option>"
|
||||
s << "<option value='#{h(value)}' #{selected}>#{h(endpoint.description)}</option>"
|
||||
end
|
||||
s << "</optgroup>"
|
||||
end
|
||||
@@ -71,7 +71,7 @@ module ApplicationHelper
|
||||
smtp_endpoints.each do |endpoint|
|
||||
value = "#{endpoint.class}##{endpoint.uuid}"
|
||||
selected = value == selected_value ? "selected='selected'" : ""
|
||||
s << "<option value='#{value}' #{selected}>#{endpoint.description}</option>"
|
||||
s << "<option value='#{h(value)}' #{selected}>#{h(endpoint.description)}</option>"
|
||||
end
|
||||
s << "</optgroup>"
|
||||
end
|
||||
@@ -82,7 +82,7 @@ module ApplicationHelper
|
||||
address_endpoints.each do |endpoint|
|
||||
value = "#{endpoint.class}##{endpoint.uuid}"
|
||||
selected = value == selected_value ? "selected='selected'" : ""
|
||||
s << "<option value='#{value}' #{selected}>#{endpoint.address}</option>"
|
||||
s << "<option value='#{h(value)}' #{selected}>#{h(endpoint.address)}</option>"
|
||||
end
|
||||
s << "</optgroup>"
|
||||
end
|
||||
@@ -94,7 +94,7 @@ module ApplicationHelper
|
||||
|
||||
selected = (selected_value == mode ? "selected='selected'" : "")
|
||||
text = t("route_modes.#{mode.underscore}")
|
||||
s << "<option value='#{mode}' #{selected}>#{text}</option>"
|
||||
s << "<option value='#{h(mode)}' #{selected}>#{h(text)}</option>"
|
||||
end
|
||||
s << "</optgroup>"
|
||||
end
|
||||
|
||||
@@ -72,6 +72,17 @@ module HasDNSChecks
|
||||
#
|
||||
|
||||
def check_dkim_record
|
||||
# If a new DKIM key is waiting to be activated, promote it to be the active
|
||||
# key as soon as its DNS record is in place. The matching DNS response has
|
||||
# already verified the key, so avoid a second lookup which could return a
|
||||
# different answer while DNS changes are propagating.
|
||||
if pending_dkim_key? && pending_dkim_record_live?
|
||||
activate_pending_dkim_key
|
||||
self.dkim_status = "OK"
|
||||
self.dkim_error = nil
|
||||
return true
|
||||
end
|
||||
|
||||
domain = "#{dkim_record_name}.#{name}"
|
||||
records = resolver.txt(domain)
|
||||
if records.empty?
|
||||
@@ -98,6 +109,16 @@ module HasDNSChecks
|
||||
save!
|
||||
end
|
||||
|
||||
# Returns true if the DNS record for the pending DKIM key has been published
|
||||
# correctly.
|
||||
def pending_dkim_record_live?
|
||||
records = resolver.txt("#{pending_dkim_record_name}.#{name}")
|
||||
return false unless records.size == 1
|
||||
|
||||
sanitised_record = records.first.strip.ends_with?(";") ? records.first.strip : "#{records.first.strip};"
|
||||
sanitised_record == pending_dkim_record
|
||||
end
|
||||
|
||||
#
|
||||
# MX
|
||||
#
|
||||
|
||||
+118
-31
@@ -5,30 +5,32 @@
|
||||
# Table name: domains
|
||||
#
|
||||
# id :integer not null, primary key
|
||||
# server_id :integer
|
||||
# uuid :string(255)
|
||||
# name :string(255)
|
||||
# verification_token :string(255)
|
||||
# verification_method :string(255)
|
||||
# verified_at :datetime
|
||||
# dkim_error :string(255)
|
||||
# dkim_identifier_string :string(255)
|
||||
# dkim_private_key :text(65535)
|
||||
# dkim_status :string(255)
|
||||
# dns_checked_at :datetime
|
||||
# incoming :boolean default(TRUE)
|
||||
# mx_error :string(255)
|
||||
# mx_status :string(255)
|
||||
# name :string(255)
|
||||
# outgoing :boolean default(TRUE)
|
||||
# owner_type :string(255)
|
||||
# pending_dkim_identifier_string :string(255)
|
||||
# pending_dkim_private_key :text(65535)
|
||||
# return_path_error :string(255)
|
||||
# return_path_status :string(255)
|
||||
# spf_error :string(255)
|
||||
# spf_status :string(255)
|
||||
# use_for_any :boolean
|
||||
# uuid :string(255)
|
||||
# verification_method :string(255)
|
||||
# verification_token :string(255)
|
||||
# verified_at :datetime
|
||||
# created_at :datetime
|
||||
# updated_at :datetime
|
||||
# dns_checked_at :datetime
|
||||
# spf_status :string(255)
|
||||
# spf_error :string(255)
|
||||
# dkim_status :string(255)
|
||||
# dkim_error :string(255)
|
||||
# mx_status :string(255)
|
||||
# mx_error :string(255)
|
||||
# return_path_status :string(255)
|
||||
# return_path_error :string(255)
|
||||
# outgoing :boolean default(TRUE)
|
||||
# incoming :boolean default(TRUE)
|
||||
# owner_type :string(255)
|
||||
# owner_id :integer
|
||||
# dkim_identifier_string :string(255)
|
||||
# use_for_any :boolean
|
||||
# server_id :integer
|
||||
#
|
||||
# Indexes
|
||||
#
|
||||
@@ -82,7 +84,7 @@ class Domain < ApplicationRecord
|
||||
end
|
||||
|
||||
def generate_dkim_key
|
||||
self.dkim_private_key = OpenSSL::PKey::RSA.new(1024).to_s
|
||||
self.dkim_private_key = OpenSSL::PKey::RSA.new(Postal::Config.dns.dkim_key_size).to_s
|
||||
end
|
||||
|
||||
def dkim_key
|
||||
@@ -91,6 +93,57 @@ class Domain < ApplicationRecord
|
||||
@dkim_key ||= OpenSSL::PKey::RSA.new(dkim_private_key)
|
||||
end
|
||||
|
||||
def pending_dkim_key
|
||||
return nil unless pending_dkim_private_key
|
||||
|
||||
@pending_dkim_key ||= OpenSSL::PKey::RSA.new(pending_dkim_private_key)
|
||||
end
|
||||
|
||||
def pending_dkim_key?
|
||||
pending_dkim_private_key.present?
|
||||
end
|
||||
|
||||
# Generate a new DKIM key for this domain. If the current key is verified and
|
||||
# in use for signing, the new key is stored as a pending key under a new
|
||||
# identifier so that signing continues with the current key until the new
|
||||
# key's DNS record has been published and verified. Otherwise, the key is
|
||||
# replaced immediately and any in-flight key change is abandoned, since the
|
||||
# new key supersedes it.
|
||||
def regenerate_dkim_key!
|
||||
if dkim_status == "OK"
|
||||
self.pending_dkim_private_key = OpenSSL::PKey::RSA.new(Postal::Config.dns.dkim_key_size).to_s
|
||||
self.pending_dkim_identifier_string = generate_unique_dkim_identifier_string
|
||||
else
|
||||
generate_dkim_key
|
||||
self.dkim_status = nil
|
||||
self.dkim_error = nil
|
||||
self.pending_dkim_private_key = nil
|
||||
self.pending_dkim_identifier_string = nil
|
||||
@dkim_key = nil
|
||||
end
|
||||
@pending_dkim_key = nil
|
||||
save!
|
||||
end
|
||||
|
||||
# Promote the pending DKIM key to be the active key. Does not save the record.
|
||||
def activate_pending_dkim_key
|
||||
return unless pending_dkim_key?
|
||||
|
||||
self.dkim_private_key = pending_dkim_private_key
|
||||
self.dkim_identifier_string = pending_dkim_identifier_string
|
||||
self.pending_dkim_private_key = nil
|
||||
self.pending_dkim_identifier_string = nil
|
||||
@dkim_key = nil
|
||||
@pending_dkim_key = nil
|
||||
end
|
||||
|
||||
def cancel_pending_dkim_key!
|
||||
self.pending_dkim_private_key = nil
|
||||
self.pending_dkim_identifier_string = nil
|
||||
@pending_dkim_key = nil
|
||||
save!
|
||||
end
|
||||
|
||||
def to_param
|
||||
uuid
|
||||
end
|
||||
@@ -108,23 +161,27 @@ class Domain < ApplicationRecord
|
||||
end
|
||||
|
||||
def dkim_record
|
||||
return if dkim_key.nil?
|
||||
|
||||
public_key = dkim_key.public_key.to_s.gsub(/-+[A-Z ]+-+\n/, "").gsub(/\n/, "")
|
||||
"v=DKIM1; t=s; h=sha256; p=#{public_key};"
|
||||
build_dkim_record(dkim_key)
|
||||
end
|
||||
|
||||
def dkim_identifier
|
||||
return nil unless dkim_identifier_string
|
||||
|
||||
Postal::Config.dns.dkim_identifier + "-#{dkim_identifier_string}"
|
||||
build_dkim_identifier(dkim_identifier_string)
|
||||
end
|
||||
|
||||
def dkim_record_name
|
||||
identifier = dkim_identifier
|
||||
return if identifier.nil?
|
||||
build_dkim_record_name(dkim_identifier)
|
||||
end
|
||||
|
||||
"#{identifier}._domainkey"
|
||||
def pending_dkim_record
|
||||
build_dkim_record(pending_dkim_key)
|
||||
end
|
||||
|
||||
def pending_dkim_identifier
|
||||
build_dkim_identifier(pending_dkim_identifier_string)
|
||||
end
|
||||
|
||||
def pending_dkim_record_name
|
||||
build_dkim_record_name(pending_dkim_identifier)
|
||||
end
|
||||
|
||||
def return_path_domain
|
||||
@@ -160,6 +217,36 @@ class Domain < ApplicationRecord
|
||||
|
||||
private
|
||||
|
||||
def build_dkim_record(key)
|
||||
return if key.nil?
|
||||
|
||||
public_key = key.public_key.to_s.gsub(/-+[A-Z ]+-+\n/, "").gsub(/\n/, "")
|
||||
"v=DKIM1; t=s; h=sha256; p=#{public_key};"
|
||||
end
|
||||
|
||||
def build_dkim_identifier(identifier_string)
|
||||
return nil unless identifier_string
|
||||
|
||||
Postal::Config.dns.dkim_identifier + "-#{identifier_string}"
|
||||
end
|
||||
|
||||
def build_dkim_record_name(identifier)
|
||||
return if identifier.nil?
|
||||
|
||||
"#{identifier}._domainkey"
|
||||
end
|
||||
|
||||
# Generates a random identifier string in the same format as the
|
||||
# `random_string :dkim_identifier_string` declaration, unique across both the
|
||||
# active and pending identifier columns.
|
||||
def generate_unique_dkim_identifier_string
|
||||
loop do
|
||||
string = Nifty::Utils::RandomString.generate(length: 6, upper_letters_only: true)
|
||||
scope = self.class.where(dkim_identifier_string: string).or(self.class.where(pending_dkim_identifier_string: string))
|
||||
return string unless scope.exists?
|
||||
end
|
||||
end
|
||||
|
||||
def update_verification_token_on_method_change
|
||||
return unless verification_method_changed?
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "uri"
|
||||
|
||||
# == Schema Information
|
||||
#
|
||||
# Table name: http_endpoints
|
||||
@@ -38,6 +40,7 @@ class HTTPEndpoint < ApplicationRecord
|
||||
|
||||
validates :name, presence: true
|
||||
validates :url, presence: true
|
||||
validate :url_must_be_http_or_https
|
||||
validates :encoding, inclusion: { in: ENCODINGS }
|
||||
validates :format, inclusion: { in: FORMATS }
|
||||
validates :timeout, numericality: { greater_than_or_equal_to: 5, less_than_or_equal_to: 60 }
|
||||
@@ -56,4 +59,17 @@ class HTTPEndpoint < ApplicationRecord
|
||||
routes.each { |r| r.update(endpoint: nil, mode: "Reject") }
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def url_must_be_http_or_https
|
||||
return if url.blank?
|
||||
|
||||
uri = URI.parse(url)
|
||||
return if uri.is_a?(URI::HTTP) && uri.host.present?
|
||||
|
||||
errors.add(:url, "must be an HTTP or HTTPS URL")
|
||||
rescue URI::InvalidURIError
|
||||
errors.add(:url, "must be a valid HTTP or HTTPS URL")
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
@@ -34,6 +34,8 @@
|
||||
= link_to domain.name, [:setup, organization, @server, domain]
|
||||
- if domain.use_for_any?
|
||||
%span.label.label--blue Any
|
||||
- if domain.pending_dkim_key?
|
||||
= link_to "New DKIM key pending", [:setup, organization, @server, domain], :class => "label label--orange", :title => "A new DKIM key is waiting for its DNS record to be published."
|
||||
%ul.domainList__checks
|
||||
- if domain.spf_status == 'OK'
|
||||
%li.domainList__check.domainList__check--ok SPF
|
||||
|
||||
@@ -47,7 +47,11 @@
|
||||
%pre.codeBlock.u-margin= @domain.spf_record
|
||||
|
||||
%h3.pageContent__subTitle DKIM Record
|
||||
- if @domain.dkim_status == 'OK'
|
||||
- if @domain.pending_dkim_key?
|
||||
%p.pageContent__text.u-orange.u-bold
|
||||
%span.label.label--orange Key change in progress
|
||||
You've generated a new DKIM key which isn't active yet. Both records are shown below.
|
||||
- elsif @domain.dkim_status == 'OK'
|
||||
%p.pageContent__text.u-green.u-bold
|
||||
%span.label.label--green Good
|
||||
Your DKIM record looks good!
|
||||
@@ -56,10 +60,34 @@
|
||||
%span.label.label--orange Warning
|
||||
= @domain.dkim_error
|
||||
|
||||
- if @domain.pending_dkim_key?
|
||||
%p.pageContent__text.u-bold
|
||||
%span.label.label--green Current
|
||||
Keep this record exactly as it is
|
||||
%p.pageContent__text
|
||||
This is the record you already have published at <b>#{@domain.dkim_record_name}</b>.
|
||||
It's signing your mail right now, so leave it in place.
|
||||
%pre.codeBlock.u-margin= @domain.dkim_record
|
||||
|
||||
%p.pageContent__text.u-bold
|
||||
%span.label.label--orange New
|
||||
Add this record as well
|
||||
%p.pageContent__text
|
||||
Add a <b>second</b> TXT record with the name <b>#{@domain.pending_dkim_record_name}</b>
|
||||
and the content below, alongside the record above rather than replacing it. Once we detect
|
||||
it (checked hourly, or when you use the button above) we'll switch to signing with the new
|
||||
key automatically. After the switch, keep the old record published while messages signed
|
||||
with it may still be queued, held, or available for redelivery.
|
||||
%pre.codeBlock.u-margin= @domain.pending_dkim_record
|
||||
%p.pageContent__text
|
||||
= link_to "Cancel new DKIM key", [:cancel_dkim_regeneration, organization, @server, @domain], :remote => true, :method => :post, :data => { :confirm => "Are you sure? The new key will be discarded and your existing key will remain active." }, :class => 'button button--neutral'
|
||||
- else
|
||||
%p.pageContent__text
|
||||
You need to add a new TXT record with the name <b>#{@domain.dkim_record_name}</b>
|
||||
with the following content.
|
||||
%pre.codeBlock.u-margin= @domain.dkim_record
|
||||
%p.pageContent__text
|
||||
= link_to "Regenerate DKIM key", [:regenerate_dkim, organization, @server, @domain], :remote => true, :method => :post, :data => { :confirm => "Are you sure you wish to generate a new DKIM key? You'll need to add a new DNS record before the new key can be used." }, :class => 'button button--neutral'
|
||||
|
||||
%h3.pageContent__subTitle Return Path
|
||||
- if @domain.return_path_status == 'OK'
|
||||
|
||||
@@ -14,4 +14,4 @@
|
||||
This means that we no longer store the raw data for this e-mail
|
||||
or the e-mail didn't include a HTML part.
|
||||
- else
|
||||
%iframe{:width => "100%", :height => "100%", :src => html_raw_organization_server_message_path(organization, @server, @message.id)}
|
||||
%iframe{:width => "100%", :height => "100%", :sandbox => "allow-popups allow-popups-to-escape-sandbox", :referrerpolicy => "no-referrer", :src => html_raw_organization_server_message_path(organization, @server, @message.id)}
|
||||
|
||||
@@ -12,12 +12,16 @@ Rails.application.routes.draw do
|
||||
match :verify, on: :member, via: [:get, :post]
|
||||
get :setup, on: :member
|
||||
post :check, on: :member
|
||||
post :regenerate_dkim, on: :member
|
||||
post :cancel_dkim_regeneration, on: :member
|
||||
end
|
||||
resources :servers, except: [:index] do
|
||||
resources :domains, only: [:index, :new, :create, :destroy] do
|
||||
match :verify, on: :member, via: [:get, :post]
|
||||
get :setup, on: :member
|
||||
post :check, on: :member
|
||||
post :regenerate_dkim, on: :member
|
||||
post :cancel_dkim_regeneration, on: :member
|
||||
end
|
||||
resources :track_domains do
|
||||
post :toggle_ssl, on: :member
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
class AddPendingDKIMFieldsToDomains < ActiveRecord::Migration[7.0]
|
||||
|
||||
def change
|
||||
add_column :domains, :pending_dkim_private_key, :text
|
||||
add_column :domains, :pending_dkim_identifier_string, :string
|
||||
end
|
||||
|
||||
end
|
||||
+3
-1
@@ -10,7 +10,7 @@
|
||||
#
|
||||
# It's strongly recommended that you check this file into your version control system.
|
||||
|
||||
ActiveRecord::Schema[7.0].define(version: 2024_03_11_205229) do
|
||||
ActiveRecord::Schema[7.1].define(version: 2026_09_03_100000) do
|
||||
create_table "additional_route_endpoints", id: :integer, charset: "utf8mb4", collation: "utf8mb4_general_ci", force: :cascade do |t|
|
||||
t.integer "route_id"
|
||||
t.string "endpoint_type"
|
||||
@@ -99,6 +99,8 @@ ActiveRecord::Schema[7.0].define(version: 2024_03_11_205229) do
|
||||
t.integer "owner_id"
|
||||
t.string "dkim_identifier_string"
|
||||
t.boolean "use_for_any"
|
||||
t.text "pending_dkim_private_key"
|
||||
t.string "pending_dkim_identifier_string"
|
||||
t.index ["server_id"], name: "index_domains_on_server_id"
|
||||
t.index ["uuid"], name: "index_domains_on_uuid", length: 8
|
||||
end
|
||||
|
||||
@@ -18,6 +18,7 @@ This document contains all the environment variables which are available for thi
|
||||
| `POSTAL_SIGNING_KEY_PATH` | String | Path to the private key used for signing | $config-file-root/signing.key |
|
||||
| `POSTAL_SMTP_RELAYS` | Array of strings | An array of SMTP relays in the format of smtp://host:port | [] |
|
||||
| `POSTAL_TRUSTED_PROXIES` | Array of strings | An array of IP addresses to trust for proxying requests to Postal (in addition to localhost addresses) | [] |
|
||||
| `POSTAL_ALLOWED_REQUEST_DESTINATIONS` | Array of strings | Hostnames or IP/CIDR ranges that outbound webhook and HTTP endpoint requests are permitted to reach even when they resolve to a private, loopback, link-local or otherwise reserved address. All other such destinations are blocked to prevent SSRF. | [] |
|
||||
| `POSTAL_QUEUED_MESSAGE_LOCK_STALE_DAYS` | Integer | The number of days after which to consider a lock as stale. Messages with stale locks will be removed and not retried. | 1 |
|
||||
| `POSTAL_BATCH_QUEUED_MESSAGES` | Boolean | When enabled queued messages will be de-queued in batches based on their destination | true |
|
||||
| `WEB_SERVER_DEFAULT_PORT` | Integer | The default port the web server should listen on unless overriden by the PORT environment variable | 5000 |
|
||||
@@ -42,6 +43,7 @@ This document contains all the environment variables which are available for thi
|
||||
| `LOGGING_RAILS_LOG_ENABLED` | Boolean | Enable the default Rails logger | false |
|
||||
| `LOGGING_SENTRY_DSN` | String | A DSN which should be used to report exceptions to Sentry | |
|
||||
| `LOGGING_ENABLED` | Boolean | Enable the Postal logger to log to STDOUT | true |
|
||||
| `LOGGING_LEVEL` | String | The minimum log level for the Postal logger (debug, info, warn, error, fatal) | INFO |
|
||||
| `LOGGING_HIGHLIGHTING_ENABLED` | Boolean | Enable highlighting of log lines | false |
|
||||
| `GELF_HOST` | String | GELF-capable host to send logs to | |
|
||||
| `GELF_PORT` | Integer | GELF port to send logs to | 12201 |
|
||||
@@ -66,6 +68,7 @@ This document contains all the environment variables which are available for thi
|
||||
| `DNS_TRACK_DOMAIN` | String | The CNAME which tracking domains should be pointed to | track.postal.example.com |
|
||||
| `DNS_HELO_HOSTNAME` | String | The hostname to use in HELO/EHLO when connecting to external SMTP servers | |
|
||||
| `DNS_DKIM_IDENTIFIER` | String | The identifier to use for DKIM keys in DNS records | postal |
|
||||
| `DNS_DKIM_KEY_SIZE` | Integer | The size (in bits) of RSA key to generate for DKIM signing (one of 1024, 2048, 3072 or 4096). Note that records for 2048-bit and larger keys exceed 255 characters and must be published as a split (multi-string) TXT record. | 2048 |
|
||||
| `DNS_DOMAIN_VERIFY_PREFIX` | String | The prefix to add before TXT record verification string | postal-verification |
|
||||
| `DNS_CUSTOM_RETURN_PATH_PREFIX` | String | The domain to use on external domains which points to the Postal return path domain | psrp |
|
||||
| `DNS_TIMEOUT` | Integer | The timeout to wait for DNS resolution | 5 |
|
||||
|
||||
@@ -29,6 +29,8 @@ postal:
|
||||
smtp_relays: []
|
||||
# An array of IP addresses to trust for proxying requests to Postal (in addition to localhost addresses)
|
||||
trusted_proxies: []
|
||||
# Hostnames or IP/CIDR ranges that outbound webhook and HTTP endpoint requests are permitted to reach even when they resolve to a private, loopback, link-local or otherwise reserved address. All other such destinations are blocked to prevent SSRF.
|
||||
allowed_request_destinations: []
|
||||
# The number of days after which to consider a lock as stale. Messages with stale locks will be removed and not retried.
|
||||
queued_message_lock_stale_days: 1
|
||||
# When enabled queued messages will be de-queued in batches based on their destination
|
||||
@@ -87,6 +89,8 @@ logging:
|
||||
sentry_dsn:
|
||||
# Enable the Postal logger to log to STDOUT
|
||||
enabled: true
|
||||
# The minimum log level for the Postal logger (debug, info, warn, error, fatal)
|
||||
level: INFO
|
||||
# Enable highlighting of log lines
|
||||
highlighting_enabled: false
|
||||
|
||||
@@ -143,6 +147,8 @@ dns:
|
||||
helo_hostname:
|
||||
# The identifier to use for DKIM keys in DNS records
|
||||
dkim_identifier: postal
|
||||
# The size (in bits) of RSA key to generate for DKIM signing (one of 1024, 2048, 3072 or 4096). Note that records for 2048-bit and larger keys exceed 255 characters and must be published as a split (multi-string) TXT record.
|
||||
dkim_key_size: 2048
|
||||
# The prefix to add before TXT record verification string
|
||||
domain_verify_prefix: postal-verification
|
||||
# The domain to use on external domains which points to the Postal return path domain
|
||||
|
||||
@@ -11,6 +11,7 @@ require "konfig/sources/environment"
|
||||
require "konfig/sources/yaml"
|
||||
require "dotenv"
|
||||
require "klogger"
|
||||
require "securerandom"
|
||||
|
||||
require_relative "error"
|
||||
require_relative "config_schema"
|
||||
@@ -82,16 +83,21 @@ module Postal
|
||||
def logger
|
||||
@logger ||= begin
|
||||
k = Klogger.new(nil, destination: Config.logging.enabled? ? $stdout : "/dev/null", highlight: Config.logging.highlighting_enabled?)
|
||||
k.level = Config.logging.level
|
||||
k.add_destination(graylog_logging_destination) if Config.gelf.host.present?
|
||||
k
|
||||
end
|
||||
end
|
||||
|
||||
def process_identity
|
||||
@process_identity ||= SecureRandom.hex(8)
|
||||
end
|
||||
|
||||
def process_name
|
||||
@process_name ||= begin
|
||||
"host:#{Socket.gethostname} pid:#{Process.pid}"
|
||||
"host:#{Socket.gethostname} pid:#{Process.pid} id:#{process_identity}"
|
||||
rescue StandardError
|
||||
"pid:#{Process.pid}"
|
||||
"pid:#{Process.pid} id:#{process_identity}"
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -92,6 +92,14 @@ module Postal
|
||||
transform { |ip| IPAddr.new(ip) }
|
||||
end
|
||||
|
||||
string :allowed_request_destinations do
|
||||
array
|
||||
description "Hostnames or IP/CIDR ranges that outbound webhook and HTTP " \
|
||||
"endpoint requests are permitted to reach even when they resolve " \
|
||||
"to a private, loopback, link-local or otherwise reserved address. " \
|
||||
"All other such destinations are blocked to prevent SSRF."
|
||||
end
|
||||
|
||||
integer :queued_message_lock_stale_days do
|
||||
description "The number of days after which to consider a lock as stale. Messages with stale locks will be removed and not retried."
|
||||
default 1
|
||||
@@ -219,6 +227,19 @@ module Postal
|
||||
default true
|
||||
end
|
||||
|
||||
string :level do
|
||||
description "The minimum log level for the Postal logger (debug, info, warn, error, fatal)"
|
||||
default "INFO"
|
||||
transform do |value|
|
||||
normalized = value.to_s.strip.downcase
|
||||
normalized = "info" if normalized.empty?
|
||||
unless %w[debug info warn error fatal].include?(normalized)
|
||||
raise ArgumentError, "logging.level must be one of: debug, info, warn, error, fatal (got #{value.inspect})"
|
||||
end
|
||||
normalized
|
||||
end
|
||||
end
|
||||
|
||||
boolean :highlighting_enabled do
|
||||
description "Enable highlighting of log lines"
|
||||
default false
|
||||
@@ -344,6 +365,20 @@ module Postal
|
||||
default "postal"
|
||||
end
|
||||
|
||||
integer :dkim_key_size do
|
||||
description "The size (in bits) of RSA key to generate for DKIM signing (one of 1024, 2048, 3072 or 4096). " \
|
||||
"Note that records for 2048-bit and larger keys exceed 255 characters and must be " \
|
||||
"published as a split (multi-string) TXT record."
|
||||
default 2048
|
||||
transform do |value|
|
||||
unless value.nil? || [1024, 2048, 3072, 4096].include?(value)
|
||||
raise Konfig::Error, "dns.dkim_key_size must be one of 1024, 2048, 3072 or 4096 (got #{value})"
|
||||
end
|
||||
|
||||
value
|
||||
end
|
||||
end
|
||||
|
||||
string :domain_verify_prefix do
|
||||
description "The prefix to add before TXT record verification string"
|
||||
default "postal-verification"
|
||||
|
||||
+20
-7
@@ -1,6 +1,7 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "net/https"
|
||||
require "resolv"
|
||||
require "uri"
|
||||
|
||||
module Postal
|
||||
@@ -47,19 +48,24 @@ module Postal
|
||||
|
||||
request["User-Agent"] = options[:user_agent] || "Postal/#{Postal.version}"
|
||||
|
||||
timeout = options[:timeout] || 60
|
||||
ssl = uri.scheme == "https"
|
||||
|
||||
begin
|
||||
Timeout.timeout(timeout) do
|
||||
connect_address = AddressGuard.safe_connect_address(uri.host)
|
||||
|
||||
connection = Net::HTTP.new(uri.host, uri.port)
|
||||
# Pin the connection to the address we validated above so that the socket
|
||||
# cannot be redirected to a different (e.g. internal) address via a DNS
|
||||
# rebinding race between the check and the connection.
|
||||
connection.ipaddr = connect_address
|
||||
|
||||
if uri.scheme == "https"
|
||||
connection.use_ssl = true
|
||||
connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
|
||||
ssl = true
|
||||
else
|
||||
ssl = false
|
||||
end
|
||||
|
||||
begin
|
||||
timeout = options[:timeout] || 60
|
||||
Timeout.timeout(timeout) do
|
||||
result = connection.request(request)
|
||||
{
|
||||
code: result.code.to_i,
|
||||
@@ -68,6 +74,13 @@ module Postal
|
||||
secure: ssl
|
||||
}
|
||||
end
|
||||
rescue BlockedDestinationError => e
|
||||
{
|
||||
code: -4,
|
||||
body: e.message,
|
||||
headers: {},
|
||||
secure: ssl
|
||||
}
|
||||
rescue OpenSSL::SSL::SSLError
|
||||
{
|
||||
code: -3,
|
||||
@@ -75,7 +88,7 @@ module Postal
|
||||
headers: {},
|
||||
secure: ssl
|
||||
}
|
||||
rescue SocketError, Errno::ECONNRESET, EOFError, Errno::EINVAL, Errno::ENETUNREACH, Errno::EHOSTUNREACH, Errno::ECONNREFUSED => e
|
||||
rescue Resolv::ResolvError, SocketError, SystemCallError, EOFError => e
|
||||
{
|
||||
code: -2,
|
||||
body: e.message,
|
||||
|
||||
@@ -0,0 +1,202 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "ipaddr"
|
||||
require "resolv"
|
||||
require "socket"
|
||||
|
||||
module Postal
|
||||
module HTTP
|
||||
# Guards outbound HTTP requests against SSRF by resolving the destination
|
||||
# host and refusing to connect to private, loopback, link-local, multicast
|
||||
# or otherwise reserved addresses (for example cloud metadata endpoints).
|
||||
#
|
||||
# Administrators can permit specific destinations by adding hostnames or
|
||||
# IP/CIDR ranges to the `postal.allowed_request_destinations` config option.
|
||||
class AddressGuard
|
||||
|
||||
# IP ranges that outbound requests are never allowed to reach unless the
|
||||
# destination has been explicitly allowlisted.
|
||||
BLOCKED_RANGES = [
|
||||
# IPv4
|
||||
"0.0.0.0/8", # "this host on this network"
|
||||
"10.0.0.0/8", # RFC1918 private
|
||||
"100.64.0.0/10", # RFC6598 carrier-grade NAT
|
||||
"127.0.0.0/8", # loopback
|
||||
"169.254.0.0/16", # link-local (incl. 169.254.169.254 metadata)
|
||||
"172.16.0.0/12", # RFC1918 private
|
||||
"192.0.0.0/24", # IETF protocol assignments
|
||||
"192.168.0.0/16", # RFC1918 private
|
||||
"198.18.0.0/15", # benchmarking
|
||||
"224.0.0.0/4", # multicast
|
||||
"240.0.0.0/4", # reserved
|
||||
# IPv6
|
||||
"::/128", # unspecified
|
||||
"::1/128", # loopback
|
||||
"::ffff:0:0/96", # IPv4-mapped (also re-checked against the v4 list)
|
||||
"fc00::/7", # unique-local
|
||||
"fe80::/10", # link-local
|
||||
"ff00::/8", # multicast
|
||||
].map { |range| IPAddr.new(range) }.freeze
|
||||
|
||||
class << self
|
||||
|
||||
# Resolve and validate the given host, returning the IP address the
|
||||
# connection should be pinned to (as a string). Pinning the connection
|
||||
# to the validated address prevents a DNS-rebinding race between the
|
||||
# check here and the actual connection.
|
||||
#
|
||||
# @param [String] host the hostname or IP literal from the request URL
|
||||
# @raise [Postal::HTTP::BlockedDestinationError] if the host cannot be
|
||||
# resolved or any resolved address is not permitted
|
||||
# @raise [SocketError] if the host only resolves to addresses whose
|
||||
# family this server cannot reach (e.g. IPv6 with no IPv6 support)
|
||||
# @return [String] the validated IP address to connect to
|
||||
def safe_connect_address(host)
|
||||
new(host).safe_connect_address
|
||||
end
|
||||
|
||||
# Whether this server has IPv6 connectivity (a global IPv6 address on
|
||||
# one of its interfaces). Memoized as it does not change at runtime.
|
||||
def ipv6_supported?
|
||||
return @ipv6_supported unless @ipv6_supported.nil?
|
||||
|
||||
@ipv6_supported = local_families.include?(:ipv6)
|
||||
end
|
||||
|
||||
# Whether this server has IPv4 connectivity. Defaults to true unless the
|
||||
# host clearly only has IPv6, so that a host reporting no global
|
||||
# addresses at all (e.g. inside a minimal container) still attempts IPv4
|
||||
# as it did before this guard existed.
|
||||
def ipv4_supported?
|
||||
return @ipv4_supported unless @ipv4_supported.nil?
|
||||
|
||||
families = local_families
|
||||
@ipv4_supported = families.include?(:ipv4) || !families.include?(:ipv6)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def local_families
|
||||
families = []
|
||||
Socket.ip_address_list.each do |address|
|
||||
families << :ipv4 if address.ipv4? && !address.ipv4_loopback?
|
||||
families << :ipv6 if address.ipv6? && !address.ipv6_loopback? && !address.ipv6_linklocal?
|
||||
end
|
||||
families.uniq
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# @param [String] host
|
||||
def initialize(host)
|
||||
@host = host.to_s
|
||||
end
|
||||
|
||||
def safe_connect_address
|
||||
if @host.empty?
|
||||
raise BlockedDestinationError, "No host was given for the request"
|
||||
end
|
||||
|
||||
addresses = resolve
|
||||
if addresses.empty?
|
||||
raise BlockedDestinationError, "Could not resolve '#{@host}' to any IP address"
|
||||
end
|
||||
|
||||
# Reject the whole request if *any* resolved address is blocked. This is
|
||||
# checked before the reachability filtering below so that a blocked
|
||||
# destination is always reported as such, regardless of which address
|
||||
# families this particular server can reach. It also defeats DNS
|
||||
# responses that mix a public and a private address to slip past.
|
||||
addresses.each do |address|
|
||||
next unless blocked?(address)
|
||||
|
||||
raise BlockedDestinationError,
|
||||
"Destination '#{@host}' (#{address}) is not permitted"
|
||||
end
|
||||
|
||||
# Only connect to an address whose family this server can actually
|
||||
# reach. Otherwise we might pin the connection to an IPv6 address on a
|
||||
# host without IPv6 connectivity and fail to connect even when a usable
|
||||
# IPv4 address was available.
|
||||
usable = addresses.select { |address| family_reachable?(address) }
|
||||
if usable.empty?
|
||||
raise SocketError,
|
||||
"'#{@host}' only resolves to addresses this server cannot reach " \
|
||||
"(#{addresses.join(', ')})"
|
||||
end
|
||||
|
||||
# Prefer IPv4 for predictability; only use IPv6 when it is the only
|
||||
# reachable option.
|
||||
(usable.find(&:ipv4?) || usable.first).to_s
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# @return [Array<IPAddr>]
|
||||
def resolve
|
||||
return [IPAddr.new(@host)] if ip_literal?
|
||||
|
||||
Resolv.getaddresses(@host).filter_map do |address|
|
||||
IPAddr.new(address)
|
||||
rescue IPAddr::InvalidAddressError
|
||||
nil
|
||||
end
|
||||
end
|
||||
|
||||
def ip_literal?
|
||||
IPAddr.new(@host)
|
||||
true
|
||||
rescue IPAddr::InvalidAddressError
|
||||
false
|
||||
end
|
||||
|
||||
# @param [IPAddr] address
|
||||
def family_reachable?(address)
|
||||
if address.ipv6? && !address.ipv4_mapped?
|
||||
self.class.ipv6_supported?
|
||||
else
|
||||
self.class.ipv4_supported?
|
||||
end
|
||||
end
|
||||
|
||||
# @param [IPAddr] address
|
||||
def blocked?(address)
|
||||
return false if allowlisted?(address)
|
||||
|
||||
# IPv4-mapped IPv6 addresses (::ffff:a.b.c.d) must be checked against the
|
||||
# IPv4 rules using the embedded address, otherwise they bypass the list.
|
||||
if address.ipv6? && address.ipv4_mapped?
|
||||
mapped = address.native
|
||||
return true if mapped.ipv4? && BLOCKED_RANGES.any? { |range| range.include?(mapped) }
|
||||
end
|
||||
|
||||
BLOCKED_RANGES.any? { |range| range.include?(address) }
|
||||
end
|
||||
|
||||
# @param [IPAddr] address
|
||||
def allowlisted?(address)
|
||||
allowlist.any? do |entry|
|
||||
if entry.is_a?(IPAddr)
|
||||
entry.include?(address)
|
||||
else
|
||||
entry.casecmp?(@host)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Allowlist entries are kept as strings in config. An entry that parses as
|
||||
# an IP/CIDR is matched against the resolved address; anything else is
|
||||
# matched against the request hostname (case-insensitively).
|
||||
#
|
||||
# @return [Array<IPAddr, String>]
|
||||
def allowlist
|
||||
@allowlist ||= Array(Postal::Config.postal.allowed_request_destinations).map do |entry|
|
||||
IPAddr.new(entry.to_s)
|
||||
rescue IPAddr::InvalidAddressError
|
||||
entry.to_s
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,11 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Postal
|
||||
module HTTP
|
||||
# Raised when an outbound request would be sent to an address that is not
|
||||
# permitted (a private, loopback, link-local or otherwise reserved address
|
||||
# that has not been explicitly allowlisted). Used as an SSRF guard.
|
||||
class BlockedDestinationError < StandardError
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -70,7 +70,7 @@ module Postal
|
||||
# Return the total size of all stored messages
|
||||
#
|
||||
def total_size
|
||||
query("SELECT SUM(size) AS size FROM `#{database_name}`.`raw_message_sizes`").first["size"] || 0
|
||||
query("SELECT SUM(size) AS size FROM #{escape_identifier(database_name)}.`raw_message_sizes`").first["size"] || 0
|
||||
end
|
||||
|
||||
#
|
||||
@@ -151,11 +151,11 @@ module Postal
|
||||
if options[:count]
|
||||
sql_query << " COUNT(id) AS count"
|
||||
elsif options[:fields]
|
||||
sql_query << (" " + options[:fields].map { |f| "`#{f}`" }.join(", "))
|
||||
sql_query << (" " + options[:fields].map { |f| escape_identifier(f) }.join(", "))
|
||||
else
|
||||
sql_query << " *"
|
||||
end
|
||||
sql_query << " FROM `#{database_name}`.`#{table}`"
|
||||
sql_query << " FROM #{escape_identifier(database_name)}.#{escape_identifier(table)}"
|
||||
if options[:where].present?
|
||||
sql_query << (" " + build_where_string(options[:where], " AND "))
|
||||
end
|
||||
@@ -163,7 +163,7 @@ module Postal
|
||||
direction = (options[:direction] || "ASC").upcase
|
||||
raise Postal::Error, "Invalid direction #{options[:direction]}" unless %w[ASC DESC].include?(direction)
|
||||
|
||||
sql_query << " ORDER BY `#{options[:order]}` #{direction}"
|
||||
sql_query << " ORDER BY #{escape_identifier(options[:order])} #{direction}"
|
||||
end
|
||||
|
||||
if options[:limit]
|
||||
@@ -211,7 +211,7 @@ module Postal
|
||||
# Will return the total number of affected rows.
|
||||
#
|
||||
def update(table, attributes, options = {})
|
||||
sql_query = "UPDATE `#{database_name}`.`#{table}` SET"
|
||||
sql_query = "UPDATE #{escape_identifier(database_name)}.#{escape_identifier(table)} SET"
|
||||
sql_query << " #{hash_to_sql(attributes)}"
|
||||
if options[:where]
|
||||
sql_query << (" " + build_where_string(options[:where]))
|
||||
@@ -227,8 +227,8 @@ module Postal
|
||||
# Will return the ID of the new item.
|
||||
#
|
||||
def insert(table, attributes)
|
||||
sql_query = "INSERT INTO `#{database_name}`.`#{table}`"
|
||||
sql_query << (" (" + attributes.keys.map { |k| "`#{k}`" }.join(", ") + ")")
|
||||
sql_query = "INSERT INTO #{escape_identifier(database_name)}.#{escape_identifier(table)}"
|
||||
sql_query << (" (" + attributes.keys.map { |k| escape_identifier(k) }.join(", ") + ")")
|
||||
sql_query << (" VALUES (" + attributes.values.map { |v| escape(v) }.join(", ") + ")")
|
||||
with_mysql do |mysql|
|
||||
query_on_connection(mysql, sql_query)
|
||||
@@ -243,8 +243,8 @@ module Postal
|
||||
if values.empty?
|
||||
nil
|
||||
else
|
||||
sql_query = "INSERT INTO `#{database_name}`.`#{table}`"
|
||||
sql_query << (" (" + keys.map { |k| "`#{k}`" }.join(", ") + ")")
|
||||
sql_query = "INSERT INTO #{escape_identifier(database_name)}.#{escape_identifier(table)}"
|
||||
sql_query << (" (" + keys.map { |k| escape_identifier(k) }.join(", ") + ")")
|
||||
sql_query << " VALUES "
|
||||
sql_query << values.map { |v| "(" + v.map { |r| escape(r) }.join(", ") + ")" }.join(", ")
|
||||
query(sql_query)
|
||||
@@ -260,7 +260,7 @@ module Postal
|
||||
# Will return the total number of affected rows.
|
||||
#
|
||||
def delete(table, options = {})
|
||||
sql_query = "DELETE FROM `#{database_name}`.`#{table}`"
|
||||
sql_query = "DELETE FROM #{escape_identifier(database_name)}.#{escape_identifier(table)}"
|
||||
sql_query << (" " + build_where_string(options[:where], " AND "))
|
||||
with_mysql do |mysql|
|
||||
query_on_connection(mysql, sql_query)
|
||||
@@ -351,32 +351,41 @@ module Postal
|
||||
|
||||
def hash_to_sql(hash, joiner = ", ")
|
||||
hash.map do |key, value|
|
||||
column = escape_identifier(key)
|
||||
if value.is_a?(Array) && value.all? { |v| v.is_a?(Integer) }
|
||||
"`#{key}` IN (#{value.join(', ')})"
|
||||
"#{column} IN (#{value.join(', ')})"
|
||||
elsif value.is_a?(Array)
|
||||
escaped_values = value.map { |v| escape(v) }.join(", ")
|
||||
"`#{key}` IN (#{escaped_values})"
|
||||
"#{column} IN (#{escaped_values})"
|
||||
elsif value.is_a?(Hash)
|
||||
sql = []
|
||||
value.each do |operator, inner_value|
|
||||
case operator
|
||||
when :less_than
|
||||
sql << "`#{key}` < #{escape(inner_value)}"
|
||||
sql << "#{column} < #{escape(inner_value)}"
|
||||
when :greater_than
|
||||
sql << "`#{key}` > #{escape(inner_value)}"
|
||||
sql << "#{column} > #{escape(inner_value)}"
|
||||
when :less_than_or_equal_to
|
||||
sql << "`#{key}` <= #{escape(inner_value)}"
|
||||
sql << "#{column} <= #{escape(inner_value)}"
|
||||
when :greater_than_or_equal_to
|
||||
sql << "`#{key}` >= #{escape(inner_value)}"
|
||||
sql << "#{column} >= #{escape(inner_value)}"
|
||||
end
|
||||
end
|
||||
sql.empty? ? "1=1" : sql.join(joiner)
|
||||
else
|
||||
"`#{key}` = #{escape(value)}"
|
||||
"#{column} = #{escape(value)}"
|
||||
end
|
||||
end.join(joiner)
|
||||
end
|
||||
|
||||
# Escape a value for safe use as a MySQL identifier (e.g. a column or
|
||||
# table name). Identifiers are wrapped in backticks and any backtick
|
||||
# within the identifier is doubled so it cannot break out of the quoting
|
||||
# and inject arbitrary SQL.
|
||||
def escape_identifier(identifier)
|
||||
"`" + identifier.to_s.gsub("`", "``") + "`"
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -48,25 +48,11 @@ class TrackingMiddleware
|
||||
Sentry.capture_exception(e) if defined?(Sentry)
|
||||
end
|
||||
|
||||
source_image = request.params["src"]
|
||||
case source_image
|
||||
when nil
|
||||
if request.params["src"].nil?
|
||||
headers = {}
|
||||
headers["Content-Type"] = "image/png"
|
||||
headers["Content-Length"] = TRACKING_PIXEL.bytesize.to_s
|
||||
[200, headers, [TRACKING_PIXEL]]
|
||||
when /\Ahttps?:\/\//
|
||||
response = Postal::HTTP.get(source_image, timeout: 3)
|
||||
return [404, {}, ["Not found"]] unless response[:code] == 200
|
||||
|
||||
headers = {}
|
||||
headers["Content-Type"] = response[:headers]["content-type"]&.first
|
||||
headers["Last-Modified"] = response[:headers]["last-modified"]&.first
|
||||
headers["Cache-Control"] = response[:headers]["cache-control"]&.first
|
||||
headers["Etag"] = response[:headers]["etag"]&.first
|
||||
headers["Content-Length"] = response[:body].bytesize.to_s
|
||||
[200, headers, [response[:body]]]
|
||||
|
||||
else
|
||||
[400, {}, ["Invalid/missing source image"]]
|
||||
end
|
||||
|
||||
@@ -64,6 +64,23 @@ RSpec.describe "Legacy Messages API", type: :request do
|
||||
end
|
||||
end
|
||||
|
||||
# Regression test for GHSA-x2hq-rfpg-3xr5 (see message_spec.rb). A JSON
|
||||
# object supplied for `id` must be rejected before reaching the database
|
||||
# rather than being interpreted as a raw set of SQL conditions.
|
||||
context "when the message ID is a JSON object (SQL injection attempt)" do
|
||||
it "rejects it with a parameter error and never reaches the database" do
|
||||
expect_any_instance_of(Server).not_to receive(:message)
|
||||
post "/api/v1/messages/deliveries",
|
||||
headers: { "x-server-api-key" => credential.key,
|
||||
"content-type" => "application/json" },
|
||||
params: { id: { "id`=0 OR SLEEP(5)#" => "x" } }.to_json
|
||||
expect(response.status).to eq 200
|
||||
parsed_body = JSON.parse(response.body)
|
||||
expect(parsed_body["status"]).to eq "parameter-error"
|
||||
expect(parsed_body["data"]["message"]).to match(/must be a string or integer/)
|
||||
end
|
||||
end
|
||||
|
||||
context "when the message ID exists" do
|
||||
let(:server) { create(:server) }
|
||||
let(:credential) { create(:credential, server: server) }
|
||||
|
||||
@@ -63,6 +63,56 @@ RSpec.describe "Legacy Messages API", type: :request do
|
||||
end
|
||||
end
|
||||
|
||||
# Regression tests for GHSA-x2hq-rfpg-3xr5. The request body is parsed as
|
||||
# JSON, so a JSON object/array supplied for `id` would otherwise arrive as
|
||||
# a Ruby Hash/Array and be passed straight through to the message database
|
||||
# as a raw set of SQL conditions (blind SQL injection). These must be
|
||||
# rejected before reaching the database.
|
||||
context "when the message ID is a JSON object (SQL injection attempt)" do
|
||||
it "rejects it with a parameter error and never reaches the database" do
|
||||
expect_any_instance_of(Server).not_to receive(:message)
|
||||
post "/api/v1/messages/message",
|
||||
headers: { "x-server-api-key" => credential.key,
|
||||
"content-type" => "application/json" },
|
||||
params: { id: { "id`=0 OR SLEEP(5)#" => "x" } }.to_json
|
||||
expect(response.status).to eq 200
|
||||
parsed_body = JSON.parse(response.body)
|
||||
expect(parsed_body["status"]).to eq "parameter-error"
|
||||
expect(parsed_body["data"]["message"]).to match(/must be a string or integer/)
|
||||
end
|
||||
end
|
||||
|
||||
context "when the message ID is a JSON array" do
|
||||
it "rejects it with a parameter error" do
|
||||
post "/api/v1/messages/message",
|
||||
headers: { "x-server-api-key" => credential.key,
|
||||
"content-type" => "application/json" },
|
||||
params: { id: [1, 2, 3] }.to_json
|
||||
expect(response.status).to eq 200
|
||||
parsed_body = JSON.parse(response.body)
|
||||
expect(parsed_body["status"]).to eq "parameter-error"
|
||||
expect(parsed_body["data"]["message"]).to match(/must be a string or integer/)
|
||||
end
|
||||
end
|
||||
|
||||
context "when the message ID is provided as a numeric string" do
|
||||
let(:message) { MessageFactory.outgoing(server) }
|
||||
|
||||
it "is coerced to an integer and looks the message up" do
|
||||
post "/api/v1/messages/message",
|
||||
headers: { "x-server-api-key" => credential.key,
|
||||
"content-type" => "application/json" },
|
||||
params: { id: message.id.to_s }.to_json
|
||||
expect(response.status).to eq 200
|
||||
parsed_body = JSON.parse(response.body)
|
||||
expect(parsed_body["status"]).to eq "success"
|
||||
expect(parsed_body["data"]).to match({
|
||||
"id" => message.id,
|
||||
"token" => message.token
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
context "when the message ID exists" do
|
||||
let(:server) { create(:server) }
|
||||
let(:credential) { create(:credential, server: server) }
|
||||
|
||||
@@ -5,30 +5,32 @@
|
||||
# Table name: domains
|
||||
#
|
||||
# id :integer not null, primary key
|
||||
# server_id :integer
|
||||
# uuid :string(255)
|
||||
# name :string(255)
|
||||
# verification_token :string(255)
|
||||
# verification_method :string(255)
|
||||
# verified_at :datetime
|
||||
# dkim_error :string(255)
|
||||
# dkim_identifier_string :string(255)
|
||||
# dkim_private_key :text(65535)
|
||||
# dkim_status :string(255)
|
||||
# dns_checked_at :datetime
|
||||
# incoming :boolean default(TRUE)
|
||||
# mx_error :string(255)
|
||||
# mx_status :string(255)
|
||||
# name :string(255)
|
||||
# outgoing :boolean default(TRUE)
|
||||
# owner_type :string(255)
|
||||
# pending_dkim_identifier_string :string(255)
|
||||
# pending_dkim_private_key :text(65535)
|
||||
# return_path_error :string(255)
|
||||
# return_path_status :string(255)
|
||||
# spf_error :string(255)
|
||||
# spf_status :string(255)
|
||||
# use_for_any :boolean
|
||||
# uuid :string(255)
|
||||
# verification_method :string(255)
|
||||
# verification_token :string(255)
|
||||
# verified_at :datetime
|
||||
# created_at :datetime
|
||||
# updated_at :datetime
|
||||
# dns_checked_at :datetime
|
||||
# spf_status :string(255)
|
||||
# spf_error :string(255)
|
||||
# dkim_status :string(255)
|
||||
# dkim_error :string(255)
|
||||
# mx_status :string(255)
|
||||
# mx_error :string(255)
|
||||
# return_path_status :string(255)
|
||||
# return_path_error :string(255)
|
||||
# outgoing :boolean default(TRUE)
|
||||
# incoming :boolean default(TRUE)
|
||||
# owner_type :string(255)
|
||||
# owner_id :integer
|
||||
# dkim_identifier_string :string(255)
|
||||
# use_for_any :boolean
|
||||
# server_id :integer
|
||||
#
|
||||
# Indexes
|
||||
#
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "rails_helper"
|
||||
|
||||
RSpec.describe ApplicationHelper, type: :helper do
|
||||
describe "#endpoint_options_for_select" do
|
||||
let(:server) { create(:server) }
|
||||
|
||||
context "when an endpoint has HTML characters in its description" do
|
||||
let(:payload) { %q(x'"><script>alert(1)</script>) }
|
||||
|
||||
before do
|
||||
create(:http_endpoint, server: server, name: payload)
|
||||
end
|
||||
|
||||
it "HTML-escapes the endpoint description in the option text" do
|
||||
html = helper.endpoint_options_for_select(server)
|
||||
|
||||
# The raw payload must not appear verbatim — if it does, the browser
|
||||
# will execute the <script> tag.
|
||||
expect(html).not_to include("<script>alert(1)</script>")
|
||||
|
||||
# Escaped form should appear instead.
|
||||
expect(html).to include("<script>alert(1)</script>")
|
||||
end
|
||||
|
||||
it "does not allow the payload to break out of the option tag" do
|
||||
html = helper.endpoint_options_for_select(server)
|
||||
|
||||
# The ' and > characters in the payload must be escaped so they
|
||||
# cannot close the opening <option value='...'> or terminate the
|
||||
# element early.
|
||||
expect(html).not_to match(/<option[^>]*>[^<]*<script/)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,192 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "rails_helper"
|
||||
|
||||
RSpec.describe Postal::HTTP::AddressGuard do
|
||||
describe ".safe_connect_address" do
|
||||
subject(:call) { described_class.safe_connect_address(host) }
|
||||
|
||||
before do
|
||||
allow(Postal::Config.postal).to receive(:allowed_request_destinations).and_return(allowlist)
|
||||
end
|
||||
|
||||
let(:allowlist) { [] }
|
||||
|
||||
context "when given a public IP literal" do
|
||||
let(:host) { "93.184.216.34" }
|
||||
|
||||
it "returns the address to connect to" do
|
||||
expect(call).to eq "93.184.216.34"
|
||||
end
|
||||
end
|
||||
|
||||
context "when given a public IPv6 literal" do
|
||||
let(:host) { "2606:2800:220:1:248:1893:25c8:1946" }
|
||||
|
||||
before { allow(described_class).to receive(:ipv6_supported?).and_return(true) }
|
||||
|
||||
it "returns the address to connect to" do
|
||||
expect(call).to eq "2606:2800:220:1:248:1893:25c8:1946"
|
||||
end
|
||||
end
|
||||
|
||||
[
|
||||
"127.0.0.1",
|
||||
"10.0.0.1",
|
||||
"172.16.5.4",
|
||||
"192.168.1.1",
|
||||
"169.254.169.254", # cloud metadata
|
||||
"100.64.0.1", # carrier-grade NAT
|
||||
"0.0.0.0",
|
||||
"::1",
|
||||
"fd00::1", # unique-local IPv6
|
||||
"fe80::1", # link-local IPv6
|
||||
"::ffff:127.0.0.1", # IPv4-mapped loopback
|
||||
].each do |blocked|
|
||||
context "when given the blocked address #{blocked}" do
|
||||
let(:host) { blocked }
|
||||
|
||||
it "raises BlockedDestinationError" do
|
||||
expect { call }.to raise_error(Postal::HTTP::BlockedDestinationError)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context "when given a hostname that resolves to a public address" do
|
||||
let(:host) { "example.com" }
|
||||
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with(host).and_return(["93.184.216.34"])
|
||||
end
|
||||
|
||||
it "returns the resolved address" do
|
||||
expect(call).to eq "93.184.216.34"
|
||||
end
|
||||
end
|
||||
|
||||
context "when given a hostname that resolves to a private address" do
|
||||
let(:host) { "internal.example.com" }
|
||||
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with(host).and_return(["10.1.2.3"])
|
||||
end
|
||||
|
||||
it "raises BlockedDestinationError" do
|
||||
expect { call }.to raise_error(Postal::HTTP::BlockedDestinationError)
|
||||
end
|
||||
end
|
||||
|
||||
context "when a hostname resolves to both a public and a private address" do
|
||||
let(:host) { "rebind.example.com" }
|
||||
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with(host).and_return(["93.184.216.34", "127.0.0.1"])
|
||||
end
|
||||
|
||||
it "raises BlockedDestinationError because one address is blocked" do
|
||||
expect { call }.to raise_error(Postal::HTTP::BlockedDestinationError)
|
||||
end
|
||||
end
|
||||
|
||||
context "when a hostname resolves to both IPv4 and IPv6 addresses" do
|
||||
let(:host) { "dualstack.example.com" }
|
||||
let(:ipv6) { "2606:2800:220:1:248:1893:25c8:1946" }
|
||||
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with(host).and_return([ipv6, "93.184.216.34"])
|
||||
end
|
||||
|
||||
context "and the server does not support IPv6" do
|
||||
before { allow(described_class).to receive(:ipv6_supported?).and_return(false) }
|
||||
|
||||
it "connects over IPv4" do
|
||||
expect(call).to eq "93.184.216.34"
|
||||
end
|
||||
end
|
||||
|
||||
context "and the server supports IPv6" do
|
||||
before { allow(described_class).to receive(:ipv6_supported?).and_return(true) }
|
||||
|
||||
it "still prefers IPv4 for predictability" do
|
||||
expect(call).to eq "93.184.216.34"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context "when a hostname resolves only to an IPv6 address" do
|
||||
let(:host) { "v6only.example.com" }
|
||||
let(:ipv6) { "2606:2800:220:1:248:1893:25c8:1946" }
|
||||
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with(host).and_return([ipv6])
|
||||
end
|
||||
|
||||
context "and the server does not support IPv6" do
|
||||
before { allow(described_class).to receive(:ipv6_supported?).and_return(false) }
|
||||
|
||||
it "raises a SocketError because the address is unreachable" do
|
||||
expect { call }.to raise_error(SocketError)
|
||||
end
|
||||
end
|
||||
|
||||
context "and the server supports IPv6" do
|
||||
before { allow(described_class).to receive(:ipv6_supported?).and_return(true) }
|
||||
|
||||
it "connects over IPv6" do
|
||||
expect(call).to eq ipv6
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context "when a hostname cannot be resolved" do
|
||||
let(:host) { "nope.example.com" }
|
||||
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with(host).and_return([])
|
||||
end
|
||||
|
||||
it "raises BlockedDestinationError" do
|
||||
expect { call }.to raise_error(Postal::HTTP::BlockedDestinationError, /resolve/)
|
||||
end
|
||||
end
|
||||
|
||||
context "when the host is blank" do
|
||||
let(:host) { "" }
|
||||
|
||||
it "raises BlockedDestinationError" do
|
||||
expect { call }.to raise_error(Postal::HTTP::BlockedDestinationError)
|
||||
end
|
||||
end
|
||||
|
||||
context "when a blocked address is allowlisted by CIDR" do
|
||||
let(:host) { "10.0.0.5" }
|
||||
let(:allowlist) { ["10.0.0.0/8"] }
|
||||
|
||||
it "returns the address" do
|
||||
expect(call).to eq "10.0.0.5"
|
||||
end
|
||||
end
|
||||
|
||||
context "when a blocked address is allowlisted by exact IP" do
|
||||
let(:host) { "127.0.0.1" }
|
||||
let(:allowlist) { ["127.0.0.1"] }
|
||||
|
||||
it "returns the address" do
|
||||
expect(call).to eq "127.0.0.1"
|
||||
end
|
||||
end
|
||||
|
||||
context "when a hostname resolving to a private address is allowlisted by name" do
|
||||
let(:host) { "internal.example.com" }
|
||||
let(:allowlist) { ["internal.example.com"] }
|
||||
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with(host).and_return(["10.1.2.3"])
|
||||
end
|
||||
|
||||
it "returns the resolved address" do
|
||||
expect(call).to eq "10.1.2.3"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,80 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "rails_helper"
|
||||
|
||||
RSpec.describe Postal::HTTP do
|
||||
before do
|
||||
allow(Postal::Config.postal).to receive(:allowed_request_destinations).and_return([])
|
||||
end
|
||||
|
||||
describe ".post" do
|
||||
context "when the host resolves to a blocked address" do
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with("internal.example.com").and_return(["127.0.0.1"])
|
||||
end
|
||||
|
||||
it "does not make a request and returns a blocked-destination result" do
|
||||
result = described_class.post("http://internal.example.com/hook", json: "{}")
|
||||
expect(result[:code]).to eq(-4)
|
||||
expect(result[:body]).to match(/not permitted/)
|
||||
expect(WebMock).not_to have_requested(:post, "http://internal.example.com/hook")
|
||||
end
|
||||
end
|
||||
|
||||
context "when resolving the host raises an error" do
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with("example.com").and_raise(Resolv::ResolvError, "resolver failed")
|
||||
end
|
||||
|
||||
it "returns a connection error result" do
|
||||
result = described_class.post("http://example.com/hook", json: "{}")
|
||||
expect(result[:code]).to eq(-2)
|
||||
expect(result[:body]).to match(/resolver failed/)
|
||||
expect(WebMock).not_to have_requested(:post, "http://example.com/hook")
|
||||
end
|
||||
end
|
||||
|
||||
context "when resolving the host exceeds the request timeout" do
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with("example.com") do
|
||||
sleep 0.2
|
||||
["93.184.216.34"]
|
||||
end
|
||||
end
|
||||
|
||||
it "returns a timeout result before making a request" do
|
||||
result = described_class.post("http://example.com/hook", json: "{}", timeout: 0.05)
|
||||
expect(result[:code]).to eq(-1)
|
||||
expect(WebMock).not_to have_requested(:post, "http://example.com/hook")
|
||||
end
|
||||
end
|
||||
|
||||
context "when the host resolves to a public address" do
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with("example.com").and_return(["93.184.216.34"])
|
||||
stub_request(:post, "http://example.com/hook").to_return(status: 200, body: "OK")
|
||||
end
|
||||
|
||||
it "pins the connection to the validated address and performs the request" do
|
||||
expect_any_instance_of(Net::HTTP).to receive(:ipaddr=).with("93.184.216.34").and_call_original
|
||||
result = described_class.post("http://example.com/hook", json: "{}")
|
||||
expect(result[:code]).to eq(200)
|
||||
expect(WebMock).to have_requested(:post, "http://example.com/hook")
|
||||
end
|
||||
end
|
||||
|
||||
context "when the blocked host is allowlisted" do
|
||||
before do
|
||||
allow(Postal::Config.postal).to receive(:allowed_request_destinations).and_return(["internal.example.com"])
|
||||
allow(Resolv).to receive(:getaddresses).with("internal.example.com").and_return(["10.0.0.5"])
|
||||
stub_request(:post, "http://internal.example.com/hook").to_return(status: 200, body: "OK")
|
||||
end
|
||||
|
||||
it "performs the request" do
|
||||
result = described_class.post("http://internal.example.com/hook", json: "{}")
|
||||
expect(result[:code]).to eq(200)
|
||||
expect(WebMock).to have_requested(:post, "http://internal.example.com/hook")
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -14,5 +14,64 @@ describe Postal::MessageDB::Database do
|
||||
it "should return the current schema version" do
|
||||
expect(database.schema_version).to be_a Integer
|
||||
end
|
||||
|
||||
describe "#escape_identifier" do
|
||||
it "wraps a plain identifier in backticks" do
|
||||
expect(database.send(:escape_identifier, "id")).to eq "`id`"
|
||||
end
|
||||
|
||||
it "doubles embedded backticks so the value cannot break out of the quoting" do
|
||||
expect(database.send(:escape_identifier, "id`=0 OR SLEEP(5)#"))
|
||||
.to eq "`id``=0 OR SLEEP(5)#`"
|
||||
end
|
||||
|
||||
it "coerces non-string identifiers to a string" do
|
||||
expect(database.send(:escape_identifier, :token)).to eq "`token`"
|
||||
end
|
||||
end
|
||||
|
||||
describe "#hash_to_sql" do
|
||||
it "builds a simple equality condition" do
|
||||
expect(database.send(:hash_to_sql, { "id" => 5 })).to eq "`id` = '5'"
|
||||
end
|
||||
|
||||
it "builds an IN condition for an array of integers" do
|
||||
expect(database.send(:hash_to_sql, { "id" => [1, 2] })).to eq "`id` IN (1, 2)"
|
||||
end
|
||||
|
||||
it "builds operator conditions for a hash value" do
|
||||
expect(database.send(:hash_to_sql, { "id" => { greater_than: 1 } }))
|
||||
.to eq "`id` > '1'"
|
||||
end
|
||||
|
||||
# Regression tests for GHSA-x2hq-rfpg-3xr5: a backtick in the condition
|
||||
# key must be neutralised so it cannot close the identifier quoting and
|
||||
# inject arbitrary SQL.
|
||||
it "neutralises a backtick injection in an equality key" do
|
||||
sql = database.send(:hash_to_sql, { "id`=0 OR SLEEP(5)#" => "x" })
|
||||
expect(sql).to eq "`id``=0 OR SLEEP(5)#` = 'x'"
|
||||
end
|
||||
|
||||
it "neutralises a backtick injection in an IN key" do
|
||||
sql = database.send(:hash_to_sql, { "id`)#" => %w[a b] })
|
||||
expect(sql).to eq "`id``)#` IN ('a', 'b')"
|
||||
end
|
||||
|
||||
it "neutralises a backtick injection in an operator key" do
|
||||
sql = database.send(:hash_to_sql, { "id`#" => { greater_than: 1 } })
|
||||
expect(sql).to eq "`id``#` > '1'"
|
||||
end
|
||||
end
|
||||
|
||||
describe "#select with a hostile condition key" do
|
||||
# End-to-end proof against the live test database: the injected key is
|
||||
# treated as a single (non-existent) column identifier, so MySQL rejects
|
||||
# the query instead of executing the injected SQL.
|
||||
it "does not allow SQL injection via the condition key" do
|
||||
expect do
|
||||
database.select("messages", where: { "id`=0 OR 1=1#" => "x" }, limit: 1)
|
||||
end.to raise_error(Mysql2::Error)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "rails_helper"
|
||||
require "rack/test"
|
||||
|
||||
RSpec.describe TrackingMiddleware do
|
||||
include Rack::Test::Methods
|
||||
|
||||
let(:inner_app) { ->(_env) { [200, {}, ["inner"]] } }
|
||||
let(:app) { described_class.new(inner_app) }
|
||||
|
||||
let(:server) { create(:server) }
|
||||
let(:message) do
|
||||
MessageFactory.incoming(server) do |_msg, mail|
|
||||
mail.html_part = Mail::Part.new do
|
||||
content_type "text/html; charset=UTF-8"
|
||||
body "<html><body>hi</body></html>"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def track_headers
|
||||
{ "HTTP_X_POSTAL_TRACK_HOST" => "1" }
|
||||
end
|
||||
|
||||
describe "GET /img/:server_token/:message_token (open tracking pixel)" do
|
||||
before do
|
||||
get "/img/#{server.token}/#{message.token}", {}, track_headers
|
||||
end
|
||||
|
||||
it "returns the tracking pixel PNG" do
|
||||
expect(last_response.status).to eq 200
|
||||
expect(last_response.headers["Content-Type"]).to eq "image/png"
|
||||
expect(last_response.body.bytesize).to be > 0
|
||||
end
|
||||
|
||||
it "records a load for the message" do
|
||||
# Re-fetch the message so loads are read fresh from the DB.
|
||||
reloaded = server.message_db.message(message.id)
|
||||
expect(reloaded.loads.size).to eq 1
|
||||
end
|
||||
end
|
||||
|
||||
describe "GET /img/:server_token/:message_token?src=<url> (image proxy)" do
|
||||
let(:attacker_url) { "http://internal.example.com/secret" }
|
||||
|
||||
before do
|
||||
stub_request(:get, attacker_url).to_return(status: 200, body: "internal-secret")
|
||||
end
|
||||
|
||||
it "does not fetch the URL and returns 400" do
|
||||
get "/img/#{server.token}/#{message.token}", { src: attacker_url }, track_headers
|
||||
|
||||
expect(last_response.status).to eq 400
|
||||
expect(WebMock).not_to have_requested(:get, attacker_url)
|
||||
end
|
||||
|
||||
it "does not fetch the URL even when the message token is invalid" do
|
||||
get "/img/#{server.token}/nonexistent", { src: attacker_url }, track_headers
|
||||
|
||||
expect(WebMock).not_to have_requested(:get, attacker_url)
|
||||
end
|
||||
end
|
||||
|
||||
describe "when the track-host header is missing" do
|
||||
it "passes the request through to the inner app untouched" do
|
||||
get "/img/#{server.token}/#{message.token}"
|
||||
expect(last_response.body).to eq "inner"
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -16,6 +16,8 @@
|
||||
# name :string(255)
|
||||
# outgoing :boolean default(TRUE)
|
||||
# owner_type :string(255)
|
||||
# pending_dkim_identifier_string :string(255)
|
||||
# pending_dkim_private_key :text(65535)
|
||||
# return_path_error :string(255)
|
||||
# return_path_status :string(255)
|
||||
# spf_error :string(255)
|
||||
@@ -162,6 +164,22 @@ describe Domain do
|
||||
it "generates a new dkim key" do
|
||||
expect { domain.generate_dkim_key }.to change { domain.dkim_private_key }.from(nil).to(match(/\A-+BEGIN RSA PRIVATE KEY-+/))
|
||||
end
|
||||
|
||||
it "generates a key of the configured size" do
|
||||
domain.generate_dkim_key
|
||||
expect(OpenSSL::PKey::RSA.new(domain.dkim_private_key).n.num_bits).to eq Postal::Config.dns.dkim_key_size
|
||||
end
|
||||
|
||||
context "when a different key size is configured" do
|
||||
before do
|
||||
allow(Postal::Config.dns).to receive(:dkim_key_size).and_return(1024)
|
||||
end
|
||||
|
||||
it "generates a key of that size" do
|
||||
domain.generate_dkim_key
|
||||
expect(OpenSSL::PKey::RSA.new(domain.dkim_private_key).n.num_bits).to eq 1024
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#dkim_key" do
|
||||
@@ -183,6 +201,138 @@ describe Domain do
|
||||
end
|
||||
end
|
||||
|
||||
describe "#pending_dkim_key" do
|
||||
context "when the domain has a pending DKIM key" do
|
||||
let(:domain) { create(:domain, dkim_status: "OK") }
|
||||
|
||||
before do
|
||||
domain.regenerate_dkim_key!
|
||||
end
|
||||
|
||||
it "returns the pending dkim key as a OpenSSL::PKey::RSA" do
|
||||
expect(domain.pending_dkim_key).to be_a OpenSSL::PKey::RSA
|
||||
expect(domain.pending_dkim_key.to_s).to eq domain.pending_dkim_private_key
|
||||
end
|
||||
end
|
||||
|
||||
context "when the domain has no pending DKIM key" do
|
||||
let(:domain) { create(:domain) }
|
||||
|
||||
it "returns nil" do
|
||||
expect(domain.pending_dkim_key).to be_nil
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#regenerate_dkim_key!" do
|
||||
context "when the current DKIM record is verified" do
|
||||
let(:domain) { create(:domain, dkim_status: "OK") }
|
||||
|
||||
it "stores the new key as a pending key with a new identifier" do
|
||||
domain.regenerate_dkim_key!
|
||||
expect(domain.pending_dkim_private_key).to match(/\A-+BEGIN RSA PRIVATE KEY-+/)
|
||||
expect(domain.pending_dkim_identifier_string).to be_present
|
||||
expect(domain.pending_dkim_identifier_string).to_not eq domain.dkim_identifier_string
|
||||
end
|
||||
|
||||
it "does not change the active key or status" do
|
||||
expect { domain.regenerate_dkim_key! }.to_not(change { domain.reload.dkim_private_key })
|
||||
expect(domain.dkim_status).to eq "OK"
|
||||
end
|
||||
end
|
||||
|
||||
context "when the current DKIM record is not verified" do
|
||||
let(:domain) { create(:domain, dkim_status: "Missing", dkim_error: "No TXT records") }
|
||||
|
||||
it "replaces the active key immediately without creating a pending key" do
|
||||
original_key = domain.dkim_key.to_s
|
||||
domain.regenerate_dkim_key!
|
||||
expect(domain.reload.dkim_private_key).to_not eq original_key
|
||||
expect(domain.pending_dkim_private_key).to be_nil
|
||||
expect(domain.dkim_key.to_s).to eq domain.dkim_private_key
|
||||
end
|
||||
|
||||
it "resets the DKIM status" do
|
||||
domain.regenerate_dkim_key!
|
||||
expect(domain.dkim_status).to be_nil
|
||||
expect(domain.dkim_error).to be_nil
|
||||
end
|
||||
|
||||
context "when a key change was already in progress" do
|
||||
# This happens when the active record breaks (so the status is no longer
|
||||
# "OK") while a pending key is waiting to be activated. The immediate
|
||||
# replacement supersedes the in-flight change, so the stale pending key
|
||||
# must not be left behind to be activated later.
|
||||
let(:domain) { create(:domain, dkim_status: "OK") }
|
||||
|
||||
before do
|
||||
domain.regenerate_dkim_key!
|
||||
domain.update!(dkim_status: "Missing", dkim_error: "No TXT records")
|
||||
end
|
||||
|
||||
it "abandons the pending key" do
|
||||
expect(domain.pending_dkim_private_key).to_not be_nil
|
||||
domain.regenerate_dkim_key!
|
||||
expect(domain.reload.pending_dkim_private_key).to be_nil
|
||||
expect(domain.pending_dkim_identifier_string).to be_nil
|
||||
expect(domain.pending_dkim_key).to be_nil
|
||||
end
|
||||
|
||||
it "replaces the active key rather than promoting the pending one" do
|
||||
stale_pending_key = domain.pending_dkim_private_key
|
||||
original_key = domain.dkim_private_key
|
||||
domain.regenerate_dkim_key!
|
||||
expect(domain.reload.dkim_private_key).to_not eq original_key
|
||||
expect(domain.dkim_private_key).to_not eq stale_pending_key
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#activate_pending_dkim_key" do
|
||||
context "when there is no pending key" do
|
||||
let(:domain) { create(:domain) }
|
||||
|
||||
it "does nothing" do
|
||||
expect { domain.activate_pending_dkim_key }.to_not(change { domain.dkim_private_key })
|
||||
end
|
||||
end
|
||||
|
||||
context "when there is a pending key" do
|
||||
let(:domain) { create(:domain, dkim_status: "OK") }
|
||||
|
||||
before do
|
||||
domain.regenerate_dkim_key!
|
||||
end
|
||||
|
||||
it "promotes the pending key and identifier and clears the pending values" do
|
||||
pending_key = domain.pending_dkim_private_key
|
||||
pending_identifier = domain.pending_dkim_identifier_string
|
||||
domain.activate_pending_dkim_key
|
||||
expect(domain.dkim_private_key).to eq pending_key
|
||||
expect(domain.dkim_identifier_string).to eq pending_identifier
|
||||
expect(domain.pending_dkim_private_key).to be_nil
|
||||
expect(domain.pending_dkim_identifier_string).to be_nil
|
||||
expect(domain.dkim_key.to_s).to eq pending_key
|
||||
expect(domain.pending_dkim_key).to be_nil
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#cancel_pending_dkim_key!" do
|
||||
let(:domain) { create(:domain, dkim_status: "OK") }
|
||||
|
||||
before do
|
||||
domain.regenerate_dkim_key!
|
||||
end
|
||||
|
||||
it "discards the pending key without changing the active key" do
|
||||
expect { domain.cancel_pending_dkim_key! }.to_not(change { domain.reload.dkim_private_key })
|
||||
expect(domain.pending_dkim_private_key).to be_nil
|
||||
expect(domain.pending_dkim_identifier_string).to be_nil
|
||||
end
|
||||
end
|
||||
|
||||
describe "#to_param" do
|
||||
context "when the domain has not been saved" do
|
||||
it "returns nil" do
|
||||
@@ -274,6 +424,131 @@ describe Domain do
|
||||
end
|
||||
end
|
||||
|
||||
describe "#pending_dkim_record" do
|
||||
context "when the domain has no pending DKIM key" do
|
||||
it "returns nil" do
|
||||
expect(domain.pending_dkim_record).to be_nil
|
||||
end
|
||||
end
|
||||
|
||||
context "when the domain has a pending DKIM key" do
|
||||
let(:domain) { create(:domain, dkim_status: "OK") }
|
||||
|
||||
before do
|
||||
domain.regenerate_dkim_key!
|
||||
end
|
||||
|
||||
it "returns the DKIM record for the pending key" do
|
||||
expect(domain.pending_dkim_record).to match(/\Av=DKIM1; t=s; h=sha256; p=.*;\z/)
|
||||
expect(domain.pending_dkim_record).to_not eq domain.dkim_record
|
||||
end
|
||||
|
||||
it "returns a record name using the pending identifier" do
|
||||
expect(domain.pending_dkim_record_name).to eq "#{Postal::Config.dns.dkim_identifier}-#{domain.pending_dkim_identifier_string}._domainkey"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#check_dkim_record" do
|
||||
let(:domain) { create(:domain, dkim_status: "OK") }
|
||||
let(:resolver) { instance_double(DNSResolver) }
|
||||
|
||||
before do
|
||||
allow(domain).to receive(:resolver).and_return(resolver)
|
||||
end
|
||||
|
||||
context "when there is a pending DKIM key" do
|
||||
before do
|
||||
domain.regenerate_dkim_key!
|
||||
end
|
||||
|
||||
context "when the pending record has been published" do
|
||||
it "activates and verifies the pending key from a single DNS response" do
|
||||
responses = [[domain.pending_dkim_record], []]
|
||||
allow(resolver).to receive(:txt).with("#{domain.pending_dkim_record_name}.#{domain.name}") { responses.shift }
|
||||
|
||||
pending_key = domain.pending_dkim_private_key
|
||||
domain.check_dkim_record
|
||||
expect(domain.dkim_private_key).to eq pending_key
|
||||
expect(domain.pending_dkim_private_key).to be_nil
|
||||
expect(domain.dkim_status).to eq "OK"
|
||||
expect(domain.dkim_error).to be_nil
|
||||
expect(responses).to eq([[]])
|
||||
end
|
||||
end
|
||||
|
||||
context "when multiple pending records have been published" do
|
||||
before do
|
||||
allow(resolver).to receive(:txt).with("#{domain.pending_dkim_record_name}.#{domain.name}").and_return([domain.pending_dkim_record, domain.pending_dkim_record])
|
||||
allow(resolver).to receive(:txt).with("#{domain.dkim_record_name}.#{domain.name}").and_return([domain.dkim_record])
|
||||
end
|
||||
|
||||
it "keeps the current key active and retains the pending key" do
|
||||
original_key = domain.dkim_private_key
|
||||
domain.check_dkim_record
|
||||
expect(domain.dkim_private_key).to eq original_key
|
||||
expect(domain.pending_dkim_private_key).to_not be_nil
|
||||
expect(domain.dkim_status).to eq "OK"
|
||||
end
|
||||
end
|
||||
|
||||
context "when the pending record has not been published" do
|
||||
before do
|
||||
allow(resolver).to receive(:txt).with("#{domain.pending_dkim_record_name}.#{domain.name}").and_return([])
|
||||
allow(resolver).to receive(:txt).with("#{domain.dkim_record_name}.#{domain.name}").and_return([domain.dkim_record])
|
||||
end
|
||||
|
||||
it "keeps the current key active and retains the pending key" do
|
||||
original_key = domain.dkim_private_key
|
||||
domain.check_dkim_record
|
||||
expect(domain.dkim_private_key).to eq original_key
|
||||
expect(domain.pending_dkim_private_key).to_not be_nil
|
||||
expect(domain.dkim_status).to eq "OK"
|
||||
end
|
||||
end
|
||||
|
||||
context "when the pending record does not match" do
|
||||
before do
|
||||
allow(resolver).to receive(:txt).with("#{domain.pending_dkim_record_name}.#{domain.name}").and_return(["v=DKIM1; t=s; h=sha256; p=something;"])
|
||||
allow(resolver).to receive(:txt).with("#{domain.dkim_record_name}.#{domain.name}").and_return([domain.dkim_record])
|
||||
end
|
||||
|
||||
it "keeps the current key active and retains the pending key" do
|
||||
original_key = domain.dkim_private_key
|
||||
domain.check_dkim_record
|
||||
expect(domain.dkim_private_key).to eq original_key
|
||||
expect(domain.pending_dkim_private_key).to_not be_nil
|
||||
expect(domain.dkim_status).to eq "OK"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context "when there is no pending DKIM key" do
|
||||
context "when the record is published" do
|
||||
before do
|
||||
allow(resolver).to receive(:txt).with("#{domain.dkim_record_name}.#{domain.name}").and_return([domain.dkim_record])
|
||||
end
|
||||
|
||||
it "marks the record as OK" do
|
||||
domain.check_dkim_record
|
||||
expect(domain.dkim_status).to eq "OK"
|
||||
expect(domain.dkim_error).to be_nil
|
||||
end
|
||||
end
|
||||
|
||||
context "when the record is missing" do
|
||||
before do
|
||||
allow(resolver).to receive(:txt).with("#{domain.dkim_record_name}.#{domain.name}").and_return([])
|
||||
end
|
||||
|
||||
it "marks the record as missing" do
|
||||
domain.check_dkim_record
|
||||
expect(domain.dkim_status).to eq "Missing"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#return_path_domain" do
|
||||
it "returns the return path domain" do
|
||||
expect(domain.return_path_domain).to eq "#{Postal::Config.dns.custom_return_path_prefix}.#{domain.name}"
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "rails_helper"
|
||||
|
||||
RSpec.describe HTTPEndpoint do
|
||||
describe "validations" do
|
||||
subject(:endpoint) { build(:http_endpoint, url: url) }
|
||||
|
||||
[
|
||||
"https://example.com/messages/~user;v=1?token=a+b#section",
|
||||
"http://example.com:8080/path?x=1&y=2",
|
||||
"https://[2606:2800:220:1:248:1893:25c8:1946]/hook",
|
||||
].each do |valid_url|
|
||||
context "with #{valid_url}" do
|
||||
let(:url) { valid_url }
|
||||
|
||||
it "is valid" do
|
||||
expect(endpoint).to be_valid
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
[
|
||||
"ftp://example.com/hook",
|
||||
"https:///missing-host",
|
||||
"not a url",
|
||||
].each do |invalid_url|
|
||||
context "with #{invalid_url}" do
|
||||
let(:url) { invalid_url }
|
||||
|
||||
it "is invalid" do
|
||||
expect(endpoint).not_to be_valid
|
||||
expect(endpoint.errors[:url]).to be_present
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -16,7 +16,7 @@ require "shoulda-matchers"
|
||||
DatabaseCleaner.allow_remote_database_url = true
|
||||
ActiveRecord::Base.logger = Logger.new("/dev/null")
|
||||
|
||||
Dir[File.expand_path("helpers/**/*.rb", __dir__)].each { |f| require f }
|
||||
Dir[File.expand_path("helpers/**/*.rb", __dir__)].reject { |f| f.end_with?("_spec.rb") }.each { |f| require f }
|
||||
|
||||
ActionMailer::Base.delivery_method = :test
|
||||
|
||||
|
||||
@@ -0,0 +1,144 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "rails_helper"
|
||||
|
||||
RSpec.describe "DomainsController", type: :request do
|
||||
let(:user) { create(:user, admin: true) }
|
||||
let(:organization) { create(:organization, owner: user) }
|
||||
let(:server) { create(:server, organization: organization) }
|
||||
|
||||
before do
|
||||
post "/login", params: { email_address: user.email_address, password: "passw0rd" }
|
||||
end
|
||||
|
||||
describe "POST /org/:org/servers/:server/domains/:domain/regenerate_dkim" do
|
||||
context "when the domain's DKIM record is verified" do
|
||||
let(:domain) { create(:domain, owner: server, dkim_status: "OK") }
|
||||
|
||||
it "generates a pending DKIM key without changing the active key" do
|
||||
original_key = domain.dkim_private_key
|
||||
post "/org/#{organization.permalink}/servers/#{server.permalink}/domains/#{domain.uuid}/regenerate_dkim"
|
||||
expect(response).to redirect_to(setup_organization_server_domain_path(organization, server, domain))
|
||||
expect(flash[:notice]).to include("Keep the old DNS record published afterward")
|
||||
expect(flash[:notice]).to include("queued, held, or available for redelivery")
|
||||
expect(flash[:notice]).to_not include("you can remove the old record")
|
||||
domain.reload
|
||||
expect(domain.dkim_private_key).to eq original_key
|
||||
expect(domain.pending_dkim_private_key).to_not be_nil
|
||||
end
|
||||
end
|
||||
|
||||
context "when the domain's DKIM record is not verified" do
|
||||
let(:domain) { create(:domain, owner: server, dkim_status: "Missing") }
|
||||
|
||||
it "replaces the active key immediately" do
|
||||
original_key = domain.dkim_private_key
|
||||
post "/org/#{organization.permalink}/servers/#{server.permalink}/domains/#{domain.uuid}/regenerate_dkim"
|
||||
expect(response).to redirect_to(setup_organization_server_domain_path(organization, server, domain))
|
||||
domain.reload
|
||||
expect(domain.dkim_private_key).to_not eq original_key
|
||||
expect(domain.pending_dkim_private_key).to be_nil
|
||||
expect(domain.dkim_status).to be_nil
|
||||
end
|
||||
end
|
||||
|
||||
context "when a key change is already in progress" do
|
||||
let(:domain) { create(:domain, owner: server, dkim_status: "OK") }
|
||||
|
||||
before do
|
||||
domain.regenerate_dkim_key!
|
||||
end
|
||||
|
||||
it "refuses and leaves the pending key untouched" do
|
||||
existing_pending_key = domain.pending_dkim_private_key
|
||||
existing_pending_identifier = domain.pending_dkim_identifier_string
|
||||
post "/org/#{organization.permalink}/servers/#{server.permalink}/domains/#{domain.uuid}/regenerate_dkim"
|
||||
expect(response).to redirect_to(setup_organization_server_domain_path(organization, server, domain))
|
||||
expect(flash[:alert]).to include("already in progress")
|
||||
domain.reload
|
||||
expect(domain.pending_dkim_private_key).to eq existing_pending_key
|
||||
expect(domain.pending_dkim_identifier_string).to eq existing_pending_identifier
|
||||
end
|
||||
|
||||
it "does not change the active key" do
|
||||
expect do
|
||||
post "/org/#{organization.permalink}/servers/#{server.permalink}/domains/#{domain.uuid}/regenerate_dkim"
|
||||
end.to_not(change { domain.reload.dkim_private_key })
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "POST /org/:org/domains/:domain/regenerate_dkim" do
|
||||
let(:domain) { create(:domain, owner: organization, dkim_status: "OK") }
|
||||
|
||||
it "generates a pending DKIM key for an organization-owned domain" do
|
||||
post "/org/#{organization.permalink}/domains/#{domain.uuid}/regenerate_dkim"
|
||||
expect(response).to redirect_to(setup_organization_domain_path(organization, domain))
|
||||
expect(domain.reload.pending_dkim_private_key).to_not be_nil
|
||||
end
|
||||
end
|
||||
|
||||
describe "POST /org/:org/servers/:server/domains/:domain/check with a pending DKIM key" do
|
||||
let(:domain) { create(:domain, owner: server, dkim_status: "OK") }
|
||||
let(:resolver) { instance_double(DNSResolver) }
|
||||
|
||||
before do
|
||||
domain.regenerate_dkim_key!
|
||||
allow(DNSResolver).to receive(:for_domain).and_return(resolver)
|
||||
allow(resolver).to receive(:txt).with(domain.name).and_return([domain.spf_record])
|
||||
allow(resolver).to receive(:mx).with(domain.name).and_return([])
|
||||
allow(resolver).to receive(:cname).and_return([])
|
||||
end
|
||||
|
||||
context "when the pending DKIM record has been published" do
|
||||
before do
|
||||
allow(resolver).to receive(:txt).with("#{domain.pending_dkim_record_name}.#{domain.name}").and_return([domain.pending_dkim_record])
|
||||
end
|
||||
|
||||
it "activates the pending key and tells the user to retain the old record" do
|
||||
old_record_name = domain.dkim_record_name
|
||||
new_key = domain.pending_dkim_private_key
|
||||
post "/org/#{organization.permalink}/servers/#{server.permalink}/domains/#{domain.uuid}/check"
|
||||
expect(response).to redirect_to(setup_organization_server_domain_path(organization, server, domain))
|
||||
expect(flash[:notice]).to include("new DKIM key is now active")
|
||||
expect(flash[:notice]).to include(old_record_name)
|
||||
expect(flash[:notice]).to include("queued, held, or available for redelivery")
|
||||
expect(flash[:notice]).to_not include("can remove")
|
||||
domain.reload
|
||||
expect(domain.dkim_private_key).to eq new_key
|
||||
expect(domain.pending_dkim_private_key).to be_nil
|
||||
expect(domain.dkim_status).to eq "OK"
|
||||
end
|
||||
end
|
||||
|
||||
context "when the pending DKIM record has not been published" do
|
||||
before do
|
||||
allow(resolver).to receive(:txt).with("#{domain.pending_dkim_record_name}.#{domain.name}").and_return([])
|
||||
allow(resolver).to receive(:txt).with("#{domain.dkim_record_name}.#{domain.name}").and_return([domain.dkim_record])
|
||||
end
|
||||
|
||||
it "keeps the current key active and tells the user the new record wasn't verified" do
|
||||
post "/org/#{organization.permalink}/servers/#{server.permalink}/domains/#{domain.uuid}/check"
|
||||
expect(response).to redirect_to(setup_organization_server_domain_path(organization, server, domain))
|
||||
expect(flash[:alert]).to include("couldn't verify the record for your new DKIM key")
|
||||
domain.reload
|
||||
expect(domain.pending_dkim_private_key).to_not be_nil
|
||||
expect(domain.dkim_status).to eq "OK"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "POST /org/:org/servers/:server/domains/:domain/cancel_dkim_regeneration" do
|
||||
let(:domain) { create(:domain, owner: server, dkim_status: "OK") }
|
||||
|
||||
before do
|
||||
domain.regenerate_dkim_key!
|
||||
end
|
||||
|
||||
it "discards the pending DKIM key" do
|
||||
post "/org/#{organization.permalink}/servers/#{server.permalink}/domains/#{domain.uuid}/cancel_dkim_regeneration"
|
||||
expect(response).to redirect_to(setup_organization_server_domain_path(organization, server, domain))
|
||||
expect(domain.reload.pending_dkim_private_key).to be_nil
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,58 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "rails_helper"
|
||||
|
||||
RSpec.describe "MessagesController", type: :request do
|
||||
let(:user) { create(:user, admin: true) }
|
||||
let(:organization) { create(:organization, owner: user) }
|
||||
let(:server) { create(:server, organization: organization) }
|
||||
|
||||
before do
|
||||
post "/login", params: { email_address: user.email_address, password: "passw0rd" }
|
||||
end
|
||||
|
||||
describe "GET /org/:org/servers/:server/messages/:id/html_raw" do
|
||||
let(:xss_payload) { %(<script>alert("XSS")</script>) }
|
||||
let(:message) do
|
||||
payload = xss_payload
|
||||
MessageFactory.incoming(server) do |_msg, mail|
|
||||
mail.html_part = Mail::Part.new do
|
||||
content_type "text/html; charset=UTF-8"
|
||||
body %(<html><body><p>hello</p>#{payload}</body></html>)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
before do
|
||||
get "/org/#{organization.permalink}/servers/#{server.permalink}/messages/#{message.id}/html_raw"
|
||||
end
|
||||
|
||||
it "returns the stored email HTML" do
|
||||
expect(response).to have_http_status(:ok)
|
||||
expect(response.body).to include("hello")
|
||||
end
|
||||
|
||||
it "serves a restrictive Content-Security-Policy that blocks scripts" do
|
||||
csp = response.headers["Content-Security-Policy"]
|
||||
expect(csp).to include("script-src 'none'")
|
||||
expect(csp).to include("default-src 'none'")
|
||||
expect(csp).to include("form-action 'none'")
|
||||
expect(csp).to include("base-uri 'none'")
|
||||
end
|
||||
|
||||
it "sets X-Content-Type-Options and Referrer-Policy on the response" do
|
||||
expect(response.headers["X-Content-Type-Options"]).to eq "nosniff"
|
||||
expect(response.headers["Referrer-Policy"]).to eq "no-referrer"
|
||||
end
|
||||
end
|
||||
|
||||
describe "messages/html view template" do
|
||||
# We assert against the template source rather than rendering it in a
|
||||
# request spec because the full application layout depends on the asset
|
||||
# pipeline which is not configured in this test environment.
|
||||
it "embeds the html_raw view inside a sandboxed iframe" do
|
||||
template = Rails.root.join("app/views/messages/html.html.haml").read
|
||||
expect(template).to match(/%iframe\{[^}]*:sandbox\s*=>/)
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,71 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "rails_helper"
|
||||
|
||||
RSpec.describe "SessionsController", type: :request do
|
||||
let(:user) { create(:user) }
|
||||
|
||||
describe "POST /login with return_to" do
|
||||
def login_with(return_to:)
|
||||
post "/login", params: {
|
||||
email_address: user.email_address,
|
||||
password: "passw0rd",
|
||||
return_to: return_to
|
||||
}
|
||||
end
|
||||
|
||||
shared_examples "rejects unsafe return_to" do
|
||||
it "does not redirect to the attacker-controlled location" do
|
||||
login_with(return_to: unsafe_path)
|
||||
|
||||
expect(response).to have_http_status(:found)
|
||||
# Whatever the fallback is, it must be same-origin: a Location that
|
||||
# either omits a host or points at our own host. A browser must not
|
||||
# end up at attacker.example.
|
||||
location = response.location
|
||||
expect(location).not_to include("attacker.example")
|
||||
# Reject protocol-relative and absolute redirects entirely.
|
||||
expect(location).not_to match(%r{\A//})
|
||||
expect(location).not_to match(%r{\Ahttps?://attacker})
|
||||
end
|
||||
end
|
||||
|
||||
context "with a protocol-relative URL (//host)" do
|
||||
let(:unsafe_path) { "//attacker.example/phish" }
|
||||
include_examples "rejects unsafe return_to"
|
||||
end
|
||||
|
||||
context "with a backslash-prefixed URL (/\\host)" do
|
||||
let(:unsafe_path) { "/\\attacker.example/phish" }
|
||||
include_examples "rejects unsafe return_to"
|
||||
end
|
||||
|
||||
context "with an absolute http(s) URL" do
|
||||
let(:unsafe_path) { "https://attacker.example/phish" }
|
||||
include_examples "rejects unsafe return_to"
|
||||
end
|
||||
|
||||
context "with a javascript: URL" do
|
||||
let(:unsafe_path) { "javascript:alert(1)" }
|
||||
include_examples "rejects unsafe return_to"
|
||||
end
|
||||
|
||||
context "with a safe relative path" do
|
||||
it "honours the return_to" do
|
||||
login_with(return_to: "/org/acme/settings")
|
||||
expect(response).to redirect_to("/org/acme/settings")
|
||||
end
|
||||
end
|
||||
|
||||
context "with no return_to" do
|
||||
it "redirects to the default root" do
|
||||
post "/login", params: {
|
||||
email_address: user.email_address,
|
||||
password: "passw0rd"
|
||||
}
|
||||
expect(response).to have_http_status(:found)
|
||||
expect(response.location).not_to match(%r{\A//})
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -13,6 +13,7 @@ RSpec.describe WebhookDeliveryService do
|
||||
let(:response_body) { "OK" }
|
||||
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with("example.com").and_return(["93.184.216.34"])
|
||||
stub_request(:post, webhook.url).to_return(status: response_status, body: response_body)
|
||||
end
|
||||
|
||||
@@ -116,5 +117,26 @@ RSpec.describe WebhookDeliveryService do
|
||||
expect { webhook_request.reload }.to raise_error(ActiveRecord::RecordNotFound)
|
||||
end
|
||||
end
|
||||
|
||||
context "when the webhook URL resolves to a blocked (private) address" do
|
||||
let(:webhook_request) do
|
||||
create(:webhook_request, :locked, webhook: webhook, url: "http://internal.example.com/hook")
|
||||
end
|
||||
|
||||
before do
|
||||
allow(Resolv).to receive(:getaddresses).with("internal.example.com").and_return(["127.0.0.1"])
|
||||
end
|
||||
|
||||
it "does not make a request to the destination" do
|
||||
service.call
|
||||
expect(WebMock).not_to have_requested(:post, "http://internal.example.com/hook")
|
||||
end
|
||||
|
||||
it "records the failure and schedules a retry" do
|
||||
service.call
|
||||
expect(webhook_request.reload.attempts).to eq(1)
|
||||
expect(webhook_request.retry_after).to be_present
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "rails_helper"
|
||||
|
||||
RSpec.describe "domains/index", type: :view do
|
||||
let(:user) { create(:user, admin: true) }
|
||||
let(:organization) { create(:organization, owner: user) }
|
||||
let(:domain) { create(:domain, owner: organization, dkim_status: "OK") }
|
||||
|
||||
before do
|
||||
assign(:organization, organization)
|
||||
assign(:domains, [domain])
|
||||
assign(:server, nil)
|
||||
without_partial_double_verification do
|
||||
allow(view).to receive(:organization).and_return(organization)
|
||||
allow(view).to receive(:current_user).and_return(user)
|
||||
allow(view).to receive(:page_title).and_return(["Postal"])
|
||||
end
|
||||
end
|
||||
|
||||
context "when no key change is in progress" do
|
||||
it "does not flag a pending DKIM key" do
|
||||
render
|
||||
expect(rendered).to_not include("New DKIM key pending")
|
||||
end
|
||||
end
|
||||
|
||||
context "when a key change is in progress" do
|
||||
before do
|
||||
domain.regenerate_dkim_key!
|
||||
end
|
||||
|
||||
it "flags the domain as having a pending DKIM key" do
|
||||
render
|
||||
expect(rendered).to include("New DKIM key pending")
|
||||
end
|
||||
|
||||
it "links the flag to the DNS setup page" do
|
||||
render
|
||||
expect(rendered).to include(setup_organization_domain_path(organization, domain))
|
||||
end
|
||||
|
||||
it "still shows DKIM as OK because the active key is unaffected" do
|
||||
render
|
||||
expect(rendered).to include("domainList__check--ok")
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,73 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "rails_helper"
|
||||
|
||||
RSpec.describe "domains/setup", type: :view do
|
||||
let(:user) { create(:user, admin: true) }
|
||||
let(:organization) { create(:organization, owner: user) }
|
||||
let(:domain) { create(:domain, owner: organization, dkim_status: "OK") }
|
||||
|
||||
before do
|
||||
assign(:organization, organization)
|
||||
assign(:domain, domain)
|
||||
assign(:server, nil)
|
||||
without_partial_double_verification do
|
||||
allow(view).to receive(:organization).and_return(organization)
|
||||
allow(view).to receive(:current_user).and_return(user)
|
||||
allow(view).to receive(:page_title).and_return(["Postal"])
|
||||
end
|
||||
end
|
||||
|
||||
context "when no key change is in progress" do
|
||||
it "shows the active record and offers regeneration" do
|
||||
render
|
||||
expect(rendered).to include(domain.dkim_record_name)
|
||||
expect(rendered).to include(domain.dkim_record)
|
||||
expect(rendered).to include("Regenerate DKIM key")
|
||||
expect(rendered).to_not include("Key change in progress")
|
||||
expect(rendered).to_not include("Cancel new DKIM key")
|
||||
end
|
||||
end
|
||||
|
||||
context "when a key change is in progress" do
|
||||
before do
|
||||
domain.regenerate_dkim_key!
|
||||
end
|
||||
|
||||
it "shows both the current and the new record" do
|
||||
render
|
||||
expect(rendered).to include(domain.dkim_record_name)
|
||||
expect(rendered).to include(domain.dkim_record)
|
||||
expect(rendered).to include(domain.pending_dkim_record_name)
|
||||
expect(rendered).to include(domain.pending_dkim_record)
|
||||
end
|
||||
|
||||
it "labels which record is active and which must be added" do
|
||||
render
|
||||
expect(rendered).to include("Key change in progress")
|
||||
expect(rendered).to include("Keep this record exactly as it is")
|
||||
expect(rendered).to include("Add this record as well")
|
||||
end
|
||||
|
||||
it "tells the user to add the new record rather than replace the old one" do
|
||||
render
|
||||
expect(rendered).to include("alongside the record above rather than replacing it")
|
||||
end
|
||||
|
||||
it "does not describe the active record as one which needs adding" do
|
||||
render
|
||||
expect(rendered).to_not include("You need to add a new TXT record")
|
||||
end
|
||||
|
||||
it "offers cancellation instead of another regeneration" do
|
||||
render
|
||||
expect(rendered).to include("Cancel new DKIM key")
|
||||
expect(rendered).to_not include("Regenerate DKIM key")
|
||||
end
|
||||
|
||||
it "does not claim the DKIM record is fully good" do
|
||||
render
|
||||
expect(rendered).to_not include("Your DKIM record looks good!")
|
||||
end
|
||||
end
|
||||
end
|
||||
Reference in New Issue
Block a user