-
Notifications
You must be signed in to change notification settings - Fork 2
/
ulist.go
496 lines (403 loc) · 14.1 KB
/
ulist.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
package ulist
import (
"bytes"
"errors"
"fmt"
"io"
"log"
"net"
"net/http"
"net/mail"
"os"
"os/signal"
"path/filepath"
"strconv"
"strings"
"sync"
"syscall"
"github.com/wansing/ulist/mailutil"
"github.com/wansing/ulist/sockmap"
"github.com/wansing/ulist/txt"
"golang.org/x/sys/unix"
)
const BounceAddressSuffix = "+bounces"
const WebBatchLimit = 1000
type ListRepo interface {
AddKnowns(list *List, addrs []*Addr) ([]*Addr, error)
AddMembers(list *List, addrs []*Addr, receive, moderate, notify, admin, bounces bool) ([]*Addr, error)
Admins(list *List) ([]string, error)
AllLists() ([]ListInfo, error)
BounceNotifieds(list *List) ([]string, error)
Create(address, name string) (*List, error)
Delete(list *List) error
GetList(list *Addr) (*List, error)
Members(list *List) ([]Membership, error)
GetMembership(list *List, user *Addr) (Membership, error)
IsList(addr Addr) (bool, error)
IsMember(list *List, addr *Addr) (bool, error)
IsKnown(list *List, rawAddress string) (bool, error)
Knowns(list *List) ([]string, error)
Memberships(member *Addr) ([]Membership, error)
Notifieds(list *List) ([]string, error)
PublicLists() ([]ListInfo, error)
Receivers(list *List) ([]string, error)
RemoveKnowns(list *List, addrs []*Addr) ([]*mailutil.Addr, error)
RemoveMembers(list *List, addrs []*Addr) ([]*Addr, error)
Update(list *List, display string, publicSignup, hideFrom bool, actionMod, actionMember, actionKnown, actionUnknown Action) error
UpdateMember(list *List, rawAddress string, receive, moderate, notify, admin, bounces bool) error
}
type Logger interface {
Printf(format string, v ...interface{}) error
}
type WebInterface interface {
AskLeaveUrl(list *List) string
AuthenticationAvailable() bool
CheckbackJoinUrl(list *List, timestamp int64, hmac string, recipient *Addr) string
CheckbackLeaveUrl(list *List, timestamp int64, hmac string, recipient *Addr) string
FooterHTML(list *List) string
FooterPlain(list *List) string
ListenAndServe() error
ModUrl(list *List) string
}
type Ulist struct {
DummyMode bool
GDPRLogger Logger
Lists ListRepo
LMTPSock string
MTA mailutil.MTA
SocketmapSock string
SpoolDir string
Superadmin string // RFC5322 AddrSpec, can create new mailing lists and modify all mailing lists
Web WebInterface // if nil, users won't be able to checkback join and leave, and moderators won't be able to moderate
LastLogID uint32
Waiting sync.WaitGroup
}
func (u *Ulist) isListOrBounce(addr mailutil.Addr) (bool, error) {
addr.Local = strings.TrimSuffix(addr.Local, BounceAddressSuffix)
return u.Lists.IsList(addr)
}
func (u *Ulist) ListenAndServe() error {
if u.MTA == nil {
u.MTA = mailutil.Sendmail{}
}
// check spool dir
if err := os.MkdirAll(u.SpoolDir, 0700); err != nil {
return fmt.Errorf("recursively creating spool directory: %v", err)
}
if unix.Access(u.SpoolDir, unix.W_OK) != nil {
return fmt.Errorf("spool directory %s is not writeable", u.SpoolDir)
}
log.Printf("spool directory: %s", u.SpoolDir)
// graceful shutdown
shutdownChan := make(chan os.Signal, 1)
signal.Notify(shutdownChan, syscall.SIGINT, syscall.SIGTERM)
// socketmap server
if u.SocketmapSock != "" {
sockmapSrv := sockmap.NewServer(u.isListOrBounce, u.LMTPSock)
defer sockmapSrv.Close()
sockmapListener, err := net.Listen("unix", u.SocketmapSock)
if err != nil {
return fmt.Errorf("creating socketmap socket: %v", err)
}
if err := os.Chmod(u.SocketmapSock, 0777); err != nil {
return fmt.Errorf("setting socketmap socket permissions: %v", err)
}
go func() {
if err := sockmapSrv.Serve(sockmapListener); err != nil {
log.Printf("socketmap server error: %v", err)
shutdownChan <- syscall.SIGINT
}
}()
log.Printf("socketmap listener: %s", u.SocketmapSock)
}
// web server
if u.Web != nil {
go func() {
if err := u.Web.ListenAndServe(); err != nil && err != http.ErrServerClosed {
log.Printf("web server error: %v", err)
shutdownChan <- syscall.SIGINT
}
}()
if !u.Web.AuthenticationAvailable() && !u.DummyMode {
const warnFormat = "\033[1;31m%s\033[0m"
log.Printf(warnFormat, "There are no authenticators available. Users won't be able to log into the web interface.")
}
}
// LMTP server
lmtpSrv := NewLMTPServer(u)
defer lmtpSrv.Close()
lmtpListener, err := net.Listen("unix", u.LMTPSock)
if err != nil {
return fmt.Errorf("creating LMTP socket: %v", err)
}
if err := os.Chmod(u.LMTPSock, 0777); err != nil {
return fmt.Errorf("setting LMTP socket permissions: %v", err)
}
go func() {
if err := lmtpSrv.Serve(lmtpListener); err != nil {
log.Printf("lmtp server error: %v", err)
shutdownChan <- syscall.SIGINT
}
}()
log.Printf("LMTP listener: %s", u.LMTPSock)
// wait for shutdown signal
log.Printf("running")
<-shutdownChan
log.Println("received shutdown signal")
return nil
}
func (u *Ulist) GetRoles(list *List, addr *Addr) ([]Status, error) {
var s = []Status{}
membership, err := u.Lists.GetMembership(list, addr)
if err != nil {
return nil, err
}
if membership.Member {
if membership.Moderate {
s = append(s, Moderator)
} else {
s = append(s, Member)
}
}
isKnown, err := u.Lists.IsKnown(list, addr.RFC5322AddrSpec())
if err != nil {
return nil, err
}
if isKnown {
s = append(s, Known)
}
return s, nil
}
// Forwards a message over the given mailing list. This is the main job of this software.
func (u *Ulist) Forward(list *List, m *mailutil.Message) error {
// don't modify the original header, create a copy instead
var header = make(mail.Header) // mail.Header has no Set method
for key, vals := range m.Header {
if mailutil.IsSpamKey(key) {
continue // An email with a spam header is always moderated. Now that it is forwarded, we can be sure that it is not spam.
}
header[key] = vals
}
// rewrite message
// Header keys use this notation: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
header["List-Id"] = []string{list.RFC5322NameAddr()}
header["List-Post"] = []string{list.RFC6068URI("")} // required for "Reply to list" button in Thunderbird
header["List-Unsubscribe"] = []string{list.RFC6068URI("subject=leave")} // GMail and Outlook show the unsubscribe button for senders with high reputation only
header["Message-Id"] = []string{list.NewMessageId()} // old Message-Id is not unique any more if the email is sent over more than one list
header["Subject"] = []string{list.PrefixSubject(header.Get("Subject"))}
// DKIM signatures usually sign at least "h=from:to:subject:date", so the signature becomes invalid when we change the "From" field and we should drop it. See RFC 6376 B.2.3.
header["Dkim-Signature"] = []string{}
// rewrite "From" because the original value would not pass the DKIM check
if list.HideFrom {
header["From"] = []string{list.RFC5322NameAddr()}
header["Reply-To"] = []string{} // defaults to From
} else {
oldFroms, err := mailutil.ParseAddressesFromHeader(header, "From", 10)
if err != nil {
return err
}
// From
froms := []string{}
for _, oldFrom := range oldFroms {
a := &Addr{}
a.Display = oldFrom.DisplayOrLocal() + " via " + list.DisplayOrLocal()
a.Local = list.Local
a.Domain = list.Domain
froms = append(froms, a.RFC5322NameAddr())
}
header["From"] = []string{strings.Join(froms, ",")}
// Reply-To
// Without rewriting "From", "Reply-To" would default to the from addresses, so let's mimic that.
// If you use rspamd to filter outgoing mail, you should disable the Symbol "SPOOF_REPLYTO" in the "Symbols" menu, see https://github.com/rspamd/rspamd/issues/1891
replyTo := []string{}
for _, oldFrom := range oldFroms {
replyTo = append(replyTo, oldFrom.RFC5322NameAddr())
}
header["Reply-To"] = []string{mailutil.AddressList(replyTo)}
}
// No "Sender" field required because there is exactly one "From" address. https://tools.ietf.org/html/rfc5322#section-3.6.2 "If the from field contains more than one mailbox specification in the mailbox-list, then the sender field, containing the field name "Sender" and a single mailbox specification, MUST appear in the message."
header["Sender"] = []string{}
// add footer
var bodyWithFooter = m.BodyReader()
if u.Web != nil {
// add footer
var err error
bodyWithFooter, err = mailutil.InsertFooter(header, bodyWithFooter, u.Web.FooterPlain(list), u.Web.FooterHTML(list))
if err != nil {
return err
}
}
// send emails
if recipients, err := u.Lists.Receivers(list); err == nil {
// Envelope-From is the list's bounce address. That's technically correct, plus else SPF would fail.
return u.MTA.Send(list.BounceAddress(), recipients, header, bodyWithFooter)
} else {
return err
}
}
func (u *Ulist) StorageFolder(li ListInfo) string {
return filepath.Join(u.SpoolDir, strconv.Itoa(li.ID))
}
func (u *Ulist) CheckbackJoinUrl(list *List, recipient *Addr) (string, error) {
if u.Web != nil {
timestamp, hmac, err := list.CreateHMAC(recipient)
if err != nil {
return "", err
}
return u.Web.CheckbackJoinUrl(list, timestamp, hmac, recipient), nil
}
return "", nil
}
func (u *Ulist) CheckbackLeaveUrl(list *List, recipient *Addr) (string, error) {
if u.Web != nil {
timestamp, hmac, err := list.CreateHMAC(recipient)
if err != nil {
return "", err
}
return u.Web.CheckbackLeaveUrl(list, timestamp, hmac, recipient), nil
}
return "", nil
}
// Notify notifies recipients about something related to the list.
func (u *Ulist) Notify(list *List, recipient string, subject string, body io.Reader) error {
header := make(mail.Header)
header["Content-Type"] = []string{"text/plain; charset=utf-8"}
header["From"] = []string{list.RFC5322NameAddr()}
header["Message-Id"] = []string{list.NewMessageId()}
header["Subject"] = []string{"[" + list.DisplayOrLocal() + "] " + subject}
header["To"] = []string{recipient}
return u.MTA.Send(list.BounceAddress(), []string{recipient}, header, body)
}
// appends a footer
func (u *Ulist) NotifyMods(list *List, mods []string) error {
// render template
var footer string
var modUrl string
if u.Web != nil {
footer = u.Web.FooterPlain(list)
modUrl = u.Web.ModUrl(list)
}
body := &bytes.Buffer{}
data := txt.NotifyModsData{
Footer: footer,
ListNameAddr: list.RFC5322NameAddr(),
ModHref: modUrl,
}
if err := txt.NotifyMods.Execute(body, data); err != nil {
return err
}
// send emails
var lastErr error
for _, mod := range mods {
if err := u.Notify(list, mod, "A message needs moderation", bytes.NewReader(body.Bytes())); err != nil { // NewReader is important, else the Buffer would be consumed
lastErr = err
}
}
return lastErr
}
func (u *Ulist) SignoffJoinMessage(list *List, member *Addr) (*bytes.Buffer, error) {
var footer string
if u.Web != nil {
footer = u.Web.FooterPlain(list)
}
var buf = &bytes.Buffer{}
var err = txt.SignoffJoin.Execute(buf, txt.SignoffJoinData{
Footer: footer,
ListAddress: list.RFC5322AddrSpec(),
MailAddress: member.RFC5322AddrSpec(),
})
return buf, err
}
func (u *Ulist) AddMembers(list *List, sendWelcome bool, addrs []*Addr, receive, moderate, notify, admin, bounces bool, reason string) (int, []error) {
added, err := u.Lists.AddMembers(list, addrs, receive, moderate, notify, admin, bounces)
if err != nil {
return 0, []error{err}
}
var gdprEvent = &strings.Builder{}
var messageFailed = 0
var notifyFailed = 0
for _, addr := range added {
if gdprEvent.Len() > 0 {
gdprEvent.WriteString("\t") // indent line
}
fmt.Fprintf(gdprEvent, "%s joined the list %s, reason: %s\n", addr, list, reason)
if sendWelcome {
welcomeBody, err := u.SignoffJoinMessage(list, addr)
if err != nil {
log.Printf("error creating signoff join message: %v", err)
messageFailed++
continue
}
if err := u.Notify(list, addr.RFC5322AddrSpec(), "Welcome", welcomeBody); err != nil { // reading welcomeBody consumes the buffer
log.Printf("error sending signoff join notification: %v", err)
notifyFailed++
}
}
}
var errs []error
if messageFailed > 0 {
errs = append(errs, fmt.Errorf("creating %d messages", messageFailed))
}
if notifyFailed > 0 {
errs = append(errs, fmt.Errorf("sending %d notifications", notifyFailed))
}
if gdprEvent.Len() > 0 {
if err := u.GDPRLogger.Printf("%s", gdprEvent); err != nil {
log.Printf("error writing to GDPR log: %v", err)
errs = append(errs, errors.New("writing to GDPR log"))
}
}
return len(added), errs
}
func (u *Ulist) CreateList(address, name, rawAdminMods string, reason string) (*List, int, []error) {
adminMods, errs := mailutil.ParseAddresses(rawAdminMods, WebBatchLimit)
if len(errs) > 0 {
return nil, 0, []error{fmt.Errorf("parsing %d email addresses", len(errs))}
}
list, err := u.Lists.Create(address, name)
if err != nil {
return nil, 0, []error{err}
}
added, errs := u.AddMembers(list, true, adminMods, true, true, true, true, true, reason)
return list, added, errs
}
func (u *Ulist) RemoveMembers(list *List, sendGoodbye bool, addrs []*Addr, reason string) (int, []error) {
// goodbye message is the same for all users, so we can create it now
var goodbyeBody []byte
var err error
if sendGoodbye {
goodbyeBody, err = list.SignoffLeaveMessage()
if err != nil {
return 0, []error{fmt.Errorf("executing email template: %w", err)}
}
}
removed, err := u.Lists.RemoveMembers(list, addrs)
if err != nil {
return 0, []error{err}
}
var gdprEvent = &strings.Builder{}
var notifyFailed = 0
for _, addr := range removed {
if gdprEvent.Len() > 0 {
gdprEvent.WriteString("\t") // indent line
}
fmt.Fprintf(gdprEvent, "%s left the list %s, reason: %s\n", addr, list, reason)
if sendGoodbye {
if err := u.Notify(list, addr.RFC5322AddrSpec(), "Goodbye", bytes.NewReader(goodbyeBody)); err != nil {
log.Printf("error sending goodbye notification: %v", err)
notifyFailed++
}
}
}
var errs []error
if notifyFailed > 0 {
errs = append(errs, fmt.Errorf("sending %d notifications", notifyFailed))
}
if gdprEvent.Len() > 0 {
if err := u.GDPRLogger.Printf("%s", gdprEvent); err != nil {
log.Printf("error writing to GDPR log: %v", err)
errs = append(errs, errors.New("writing to GDPR log"))
}
}
return len(removed), errs
}