forked from Silverfish/proton-bridge
5fee2f707b
Ensure the SMTP send recorder properly handles the recording of messages which may have the same body hash but have different recipients. E.g.: send the same message twice to 2 different users via Bcc. The send recorder now maintains a list of send requests and waiting for a message to be sent is done one the oldest of the messages.
435 lines
13 KiB
Go
435 lines
13 KiB
Go
// Copyright (c) 2023 Proton AG
|
|
//
|
|
// This file is part of Proton Mail Bridge.
|
|
//
|
|
// Proton Mail Bridge is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Proton Mail Bridge is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Proton Mail Bridge. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
package user
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestSendHasher_Insert(t *testing.T) {
|
|
h := newSendRecorder(sendEntryExpiry)
|
|
|
|
// Insert a message into the hasher.
|
|
hash1, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash1)
|
|
|
|
// Simulate successfully sending the message.
|
|
h.signalMessageSent(hash1, "abc", nil)
|
|
|
|
// Inserting a message with the same hash should return false.
|
|
_, ok, err = testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.False(t, ok)
|
|
|
|
// Inserting a message with a different hash should return true.
|
|
hash2, ok, err := testTryInsert(h, literal2, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash2)
|
|
}
|
|
|
|
func TestSendHasher_Insert_Expired(t *testing.T) {
|
|
h := newSendRecorder(time.Second)
|
|
|
|
// Insert a message into the hasher.
|
|
hash1, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash1)
|
|
|
|
// Simulate successfully sending the message.
|
|
h.signalMessageSent(hash1, "abc", nil)
|
|
|
|
// Wait for the entry to expire.
|
|
time.Sleep(time.Second)
|
|
|
|
// Inserting a message with the same hash should return true because the previous entry has since expired.
|
|
hash2, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
|
|
// The hashes should be the same.
|
|
require.Equal(t, hash1, hash2)
|
|
}
|
|
|
|
func TestSendHasher_Insert_DifferentToList(t *testing.T) {
|
|
h := newSendRecorder(time.Second)
|
|
|
|
// Insert a message into the hasher.
|
|
hash1, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second), []string{"abc", "def"}...)
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash1)
|
|
|
|
// Insert the same message into the hasher but with a different to list.
|
|
hash2, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second), []string{"abc", "def", "ghi"}...)
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash2)
|
|
|
|
// Insert the same message into the hasher but with the same to list.
|
|
_, ok, err = testTryInsert(h, literal1, time.Now().Add(time.Second), []string{"abc", "def", "ghi"}...)
|
|
require.Error(t, err)
|
|
require.False(t, ok)
|
|
}
|
|
|
|
func TestSendHasher_Wait_SendSuccess(t *testing.T) {
|
|
h := newSendRecorder(sendEntryExpiry)
|
|
|
|
// Insert a message into the hasher.
|
|
hash, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash)
|
|
|
|
// Simulate successfully sending the message after half a second.
|
|
go func() {
|
|
time.Sleep(time.Millisecond * 500)
|
|
h.signalMessageSent(hash, "abc", nil)
|
|
}()
|
|
|
|
// Inserting a message with the same hash should fail.
|
|
_, ok, err = testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.False(t, ok)
|
|
}
|
|
|
|
func TestSendHasher_Wait_SendFail(t *testing.T) {
|
|
h := newSendRecorder(sendEntryExpiry)
|
|
|
|
// Insert a message into the hasher.
|
|
hash, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash)
|
|
|
|
// Simulate failing to send the message after half a second.
|
|
go func() {
|
|
time.Sleep(time.Millisecond * 500)
|
|
h.removeOnFail(hash, nil)
|
|
}()
|
|
|
|
// Inserting a message with the same hash should succeed because the first message failed to send.
|
|
hash2, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
|
|
// The hashes should be the same.
|
|
require.Equal(t, hash, hash2)
|
|
}
|
|
|
|
func TestSendHasher_Wait_Timeout(t *testing.T) {
|
|
h := newSendRecorder(sendEntryExpiry)
|
|
|
|
// Insert a message into the hasher.
|
|
hash, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash)
|
|
|
|
// We should fail to insert because the message is not sent within the timeout period.
|
|
_, _, err = testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.Error(t, err)
|
|
}
|
|
|
|
func TestSendHasher_HasEntry(t *testing.T) {
|
|
h := newSendRecorder(sendEntryExpiry)
|
|
|
|
// Insert a message into the hasher.
|
|
hash, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash)
|
|
|
|
// Simulate successfully sending the message.
|
|
h.signalMessageSent(hash, "abc", nil)
|
|
|
|
// The message was already sent; we should find it in the hasher.
|
|
messageID, ok, err := testHasEntry(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.Equal(t, "abc", messageID)
|
|
}
|
|
|
|
func TestSendHasher_HasEntry_SendSuccess(t *testing.T) {
|
|
h := newSendRecorder(sendEntryExpiry)
|
|
|
|
// Insert a message into the hasher.
|
|
hash, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash)
|
|
|
|
// Simulate successfully sending the message after half a second.
|
|
go func() {
|
|
time.Sleep(time.Millisecond * 500)
|
|
h.signalMessageSent(hash, "abc", nil)
|
|
}()
|
|
|
|
// The message was already sent; we should find it in the hasher.
|
|
messageID, ok, err := testHasEntry(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.Equal(t, "abc", messageID)
|
|
}
|
|
|
|
func TestSendHasher_DualAddDoesNotCauseCrash(t *testing.T) {
|
|
// There may be a rare case where one 2 smtp connections attempt to send the same message, but if the first message
|
|
// is stuck long enough for it to expire, the second connection will remove it from the list and cause it to be
|
|
// inserted as a new entry. The two clients end up sending the message twice and calling the `signalMessageSent` x2,
|
|
// resulting in a crash.
|
|
h := newSendRecorder(sendEntryExpiry)
|
|
|
|
// Insert a message into the hasher.
|
|
hash, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash)
|
|
|
|
// Simulate successfully sending the message. We call this method twice as it possible for multiple SMTP connections
|
|
// to attempt to send the same message.
|
|
h.signalMessageSent(hash, "abc", nil)
|
|
h.signalMessageSent(hash, "abc", nil)
|
|
|
|
// The message was already sent; we should find it in the hasher.
|
|
messageID, ok, err := testHasEntry(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.Equal(t, "abc", messageID)
|
|
}
|
|
|
|
func TestSendHashed_MessageWithSameHasButDifferentRecipientsIsInserted(t *testing.T) {
|
|
h := newSendRecorder(sendEntryExpiry)
|
|
|
|
// Insert a message into the hasher.
|
|
hash, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second), "Receiver <receiver@pm.me>")
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash)
|
|
|
|
hash2, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second), "Receiver <receiver@pm.me>", "Receiver2 <receiver2@pm.me>")
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash2)
|
|
require.Equal(t, hash, hash2)
|
|
}
|
|
|
|
func TestSendHasher_HasEntry_SendFail(t *testing.T) {
|
|
h := newSendRecorder(sendEntryExpiry)
|
|
|
|
// Insert a message into the hasher.
|
|
hash, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash)
|
|
|
|
// Simulate failing to send the message after half a second.
|
|
go func() {
|
|
time.Sleep(time.Millisecond * 500)
|
|
h.removeOnFail(hash, nil)
|
|
}()
|
|
|
|
// The message failed to send; we should not find it in the hasher.
|
|
_, ok, err = testHasEntry(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.False(t, ok)
|
|
}
|
|
|
|
func TestSendHasher_HasEntry_Timeout(t *testing.T) {
|
|
h := newSendRecorder(sendEntryExpiry)
|
|
|
|
// Insert a message into the hasher.
|
|
hash, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash)
|
|
|
|
// The message is never sent; we should not find it in the hasher.
|
|
_, ok, err = testHasEntry(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.False(t, ok)
|
|
}
|
|
|
|
func TestSendHasher_HasEntry_Expired(t *testing.T) {
|
|
h := newSendRecorder(time.Second)
|
|
|
|
// Insert a message into the hasher.
|
|
hash, ok, err := testTryInsert(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.True(t, ok)
|
|
require.NotEmpty(t, hash)
|
|
|
|
// Simulate successfully sending the message.
|
|
h.signalMessageSent(hash, "abc", nil)
|
|
|
|
// Wait for the entry to expire.
|
|
time.Sleep(time.Second)
|
|
|
|
// The entry has expired; we should not find it in the hasher.
|
|
_, ok, err = testHasEntry(h, literal1, time.Now().Add(time.Second))
|
|
require.NoError(t, err)
|
|
require.False(t, ok)
|
|
}
|
|
|
|
const literal1 = `From: Sender <sender@pm.me>
|
|
To: Receiver <receiver@pm.me>
|
|
Content-Type: multipart/mixed; boundary=longrandomstring
|
|
|
|
--longrandomstring
|
|
|
|
body
|
|
--longrandomstring
|
|
Content-Disposition: attachment; filename="attname.txt"
|
|
|
|
attachment
|
|
--longrandomstring--
|
|
`
|
|
const literal2 = `From: Sender <sender@pm.me>
|
|
To: Receiver <receiver@pm.me>
|
|
Content-Type: multipart/mixed; boundary=longrandomstring
|
|
|
|
--longrandomstring
|
|
|
|
body
|
|
--longrandomstring
|
|
Content-Disposition: attachment; filename="attname2.txt"
|
|
|
|
attachment
|
|
--longrandomstring--
|
|
`
|
|
|
|
func TestGetMessageHash(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
lit1, lit2 []byte
|
|
wantEqual bool
|
|
}{
|
|
{
|
|
name: "empty",
|
|
lit1: []byte{},
|
|
lit2: []byte{},
|
|
wantEqual: true,
|
|
},
|
|
{
|
|
name: "same to",
|
|
lit1: []byte("To: someone@pm.me\r\n\r\nHello world!"),
|
|
lit2: []byte("To: someone@pm.me\r\n\r\nHello world!"),
|
|
wantEqual: true,
|
|
},
|
|
{
|
|
name: "different to",
|
|
lit1: []byte("To: someone@pm.me\r\n\r\nHello world!"),
|
|
lit2: []byte("To: another@pm.me\r\n\r\nHello world!"),
|
|
wantEqual: false,
|
|
},
|
|
{
|
|
name: "same from",
|
|
lit1: []byte("From: someone@pm.me\r\n\r\nHello world!"),
|
|
lit2: []byte("From: someone@pm.me\r\n\r\nHello world!"),
|
|
wantEqual: true,
|
|
},
|
|
{
|
|
name: "different from",
|
|
lit1: []byte("From: someone@pm.me\r\n\r\nHello world!"),
|
|
lit2: []byte("From: another@pm.me\r\n\r\nHello world!"),
|
|
wantEqual: false,
|
|
},
|
|
{
|
|
name: "same subject",
|
|
lit1: []byte("Subject: Hello world!\r\n\r\nHello world!"),
|
|
lit2: []byte("Subject: Hello world!\r\n\r\nHello world!"),
|
|
wantEqual: true,
|
|
},
|
|
{
|
|
name: "different subject",
|
|
lit1: []byte("Subject: Hello world!\r\n\r\nHello world!"),
|
|
lit2: []byte("Subject: Goodbye world!\r\n\r\nHello world!"),
|
|
wantEqual: false,
|
|
},
|
|
{
|
|
name: "same plaintext body",
|
|
lit1: []byte("To: someone@pm.me\r\nContent-Type: text/plain\r\n\r\nHello world!"),
|
|
lit2: []byte("To: someone@pm.me\r\nContent-Type: text/plain\r\n\r\nHello world!"),
|
|
wantEqual: true,
|
|
},
|
|
{
|
|
name: "different plaintext body",
|
|
lit1: []byte("To: someone@pm.me\r\nContent-Type: text/plain\r\n\r\nHello world!"),
|
|
lit2: []byte("To: someone@pm.me\r\nContent-Type: text/plain\r\n\r\nGoodbye world!"),
|
|
wantEqual: false,
|
|
},
|
|
{
|
|
name: "different attachment filenames",
|
|
lit1: []byte(literal1),
|
|
lit2: []byte(literal2),
|
|
wantEqual: false,
|
|
},
|
|
{
|
|
name: "different date and message ID should still match",
|
|
lit1: []byte("To: a@b.c\r\nDate: Fri, 13 Aug 1982\r\nMessage-Id: 1@b.c\r\n\r\nHello"),
|
|
lit2: []byte("To: a@b.c\r\nDate: Sat, 14 Aug 1982\r\nMessage-Id: 2@b.c\r\n\r\nHello"),
|
|
wantEqual: true,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
hash1, err := getMessageHash(tt.lit1)
|
|
require.NoError(t, err)
|
|
|
|
hash2, err := getMessageHash(tt.lit2)
|
|
require.NoError(t, err)
|
|
|
|
if tt.wantEqual {
|
|
require.Equal(t, hash1, hash2)
|
|
} else {
|
|
require.NotEqual(t, hash1, hash2)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func testTryInsert(h *sendRecorder, literal string, deadline time.Time, toList ...string) (string, bool, error) { //nolint:unparam
|
|
hash, err := getMessageHash([]byte(literal))
|
|
if err != nil {
|
|
return "", false, err
|
|
}
|
|
|
|
ok, err := h.tryInsertWait(context.Background(), hash, toList, deadline)
|
|
if err != nil {
|
|
return "", false, err
|
|
}
|
|
|
|
return hash, ok, nil
|
|
}
|
|
|
|
func testHasEntry(h *sendRecorder, literal string, deadline time.Time) (string, bool, error) { //nolint:unparam
|
|
hash, err := getMessageHash([]byte(literal))
|
|
if err != nil {
|
|
return "", false, err
|
|
}
|
|
|
|
return h.hasEntryWait(context.Background(), hash, deadline)
|
|
}
|