3f5b3cdd98
* feat: add configurable SMTP HELO hostname Allow the SMTP HELO/EHLO hostname to be configured separately from the SMTP server hostname. This is useful when the SMTP server requires clients to identify themselves with a fully qualified hostname different from the server address. * chore: remove vendored dependency changes * Bump go-pkgz/notify to v1.4.0 and document SMTP_HELO_HOST The HELOHost field lands in go-pkgz/notify v1.4.0, so the branch needs the bump to compile; v1.3.0 in master has no such field. The example module is tidied alongside, as any change to backend/go.mod requires. Documents the parameter in the parameters table and, separately, in the email setup page: what it does, that leaving it unset keeps the previous `localhost` greeting, and the case it exists for, a relay refusing the greeting under Postfix `reject_non_fqdn_helo_hostname`. Also records the current limit: verification emails for email authentication go through go-pkgz/auth's own sender, which has no equivalent setting, so the greeting there is unchanged. * Bump go-pkgz/auth to v2.2.0 and apply SMTP_HELO_HOST to verification email The verification email sender had no way to set the greeting, so a relay that refuses the HELO would accept notifications and still reject sign-in emails. EmailParams gains HELOHost in go-pkgz/auth v2.2.0, so the same SMTP_HELO_HOST now drives both paths. The example module is tidied alongside, as any change to backend/go.mod requires. --------- Co-authored-by: oli <someone@somewhere.tld> Co-authored-by: Dmitry Verkhoturov <paskal.07@gmail.com>
112 lines
2.9 KiB
Go
112 lines
2.9 KiB
Go
package notify
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"strings"
|
|
"time"
|
|
)
|
|
|
|
const webhookTimeOut = 5000 * time.Millisecond
|
|
|
|
// limits for the response body of the webhook request: how much of it is quoted in the error
|
|
// for non-OK responses, and how much is drained to make the connection reusable
|
|
const (
|
|
webhookErrBodyLimit = 16 * 1024
|
|
webhookDrainBodyLimit = 64 * 1024
|
|
)
|
|
|
|
// WebhookParams contain settings for webhook notifications
|
|
type WebhookParams struct {
|
|
Timeout time.Duration
|
|
Headers []string // headers in format "header:value"
|
|
}
|
|
|
|
// Webhook notifications client
|
|
type Webhook struct {
|
|
WebhookParams
|
|
webhookClient webhookClient
|
|
}
|
|
|
|
// webhookClient defines an interface of client for webhook
|
|
type webhookClient interface {
|
|
Do(*http.Request) (*http.Response, error)
|
|
}
|
|
|
|
// NewWebhook makes Webhook
|
|
func NewWebhook(params WebhookParams) *Webhook {
|
|
res := &Webhook{WebhookParams: params}
|
|
|
|
if res.Timeout == 0 {
|
|
res.Timeout = webhookTimeOut
|
|
}
|
|
|
|
res.webhookClient = &http.Client{Timeout: res.Timeout}
|
|
|
|
return res
|
|
}
|
|
|
|
// Send sends Webhook notification. Destination field is expected to have http:// or https:// schema.
|
|
//
|
|
// Example:
|
|
//
|
|
// - https://example.com/webhook
|
|
func (wh *Webhook) Send(ctx context.Context, destination, text string) error {
|
|
payload := bytes.NewBufferString(text)
|
|
httpReq, err := http.NewRequestWithContext(ctx, "POST", destination, payload)
|
|
if err != nil {
|
|
return fmt.Errorf("unable to create webhook request: %w", err)
|
|
}
|
|
|
|
for _, h := range wh.Headers {
|
|
elems := strings.SplitN(h, ":", 2)
|
|
if len(elems) != 2 {
|
|
continue
|
|
}
|
|
httpReq.Header.Set(strings.TrimSpace(elems[0]), strings.TrimSpace(elems[1]))
|
|
}
|
|
|
|
resp, err := wh.webhookClient.Do(httpReq)
|
|
if err != nil {
|
|
return fmt.Errorf("webhook request failed: %w", err)
|
|
}
|
|
defer func() {
|
|
// drain the remaining body to let the underlying connection be reused
|
|
_, _ = io.Copy(io.Discard, io.LimitReader(resp.Body, webhookDrainBodyLimit))
|
|
_ = resp.Body.Close()
|
|
}()
|
|
|
|
if resp.StatusCode < http.StatusOK || resp.StatusCode >= http.StatusMultipleChoices {
|
|
errMsg := fmt.Sprintf("webhook request failed with non-OK status code: %d", resp.StatusCode)
|
|
respBody, e := io.ReadAll(io.LimitReader(resp.Body, webhookErrBodyLimit+1))
|
|
if e != nil {
|
|
return errors.New(errMsg)
|
|
}
|
|
if len(respBody) > webhookErrBodyLimit {
|
|
return fmt.Errorf("%s, body: %s... (truncated)", errMsg, respBody[:webhookErrBodyLimit])
|
|
}
|
|
return fmt.Errorf("%s, body: %s", errMsg, respBody)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Schema returns schema prefix supported by this client
|
|
func (wh *Webhook) Schema() string {
|
|
return "http"
|
|
}
|
|
|
|
// String describes the webhook instance
|
|
func (wh *Webhook) String() string {
|
|
str := fmt.Sprintf("webhook notification with timeout %s", wh.Timeout)
|
|
if len(wh.Headers) != 0 {
|
|
// header values are not printed as they might contain secrets, like authorization tokens
|
|
str += fmt.Sprintf(" and %d headers", len(wh.Headers))
|
|
}
|
|
return str
|
|
}
|