sneak
88e283f728
Some checks failed
check / check (push) Failing after 2m31s
A receiver URL was a bare v4 UUID and nothing else: anyone who learned it could store events and, because inbound headers are forwarded to targets almost verbatim, choose what the downstream service received. Entrypoints gain an optional scheme/secret pair. GitHub's X-Hub-Signature-256 (HMAC-SHA256 hex over the raw body) and GitLab's X-Gitlab-Token (plain shared token) are supported; both compare with hmac.Equal. With nothing configured an entrypoint behaves exactly as before, which is also where every pre-existing row lands after AutoMigrate adds the columns. Verification runs after the capped body read and before the first write, so a rejected request leaves no event row, no delivery row and no delivery task. A configuration the receiver cannot apply — unknown scheme, or one half of the pair missing — is refused with a 500 rather than falling back to unverified. The secret is credential-bearing and is stored in the clear because HMAC needs the key itself. It is excluded from JSON, kept out of templates by a new handlers.EntrypointView projection, and absent from every log line including the rejection path. The UI sets and rotates it through one form that never renders the stored value. Under the GitLab scheme the signature header is the secret rather than a digest over the request, so an accepted request's headers are cloned and the configured scheme's credential header dropped before they are serialized onto the event. Stored headers are persisted verbatim in the per-webhook database and replayed onto every outbound delivery, so keeping the token would put it in every backup and hand every target operator the means to forge signed requests to the entrypoint it authenticates. Stripping sits once above the first write rather than at each egress, and is driven by the scheme's own description with stripping as the default: a scheme added later is covered unless it declares its header a digest, as GitHub's HMAC over the body does. An entrypoint holding one half of the pair now renders as misconfigured rather than as unverified, and the scheme selector follows the stored scheme so such a row no longer marks two options selected.
86 lines
2.3 KiB
Go
86 lines
2.3 KiB
Go
package database_test
|
|
|
|
import (
|
|
"net/http"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"sneak.berlin/go/webhooker/internal/database"
|
|
"sneak.berlin/go/webhooker/internal/signature"
|
|
)
|
|
|
|
// TestEntrypointSignatureColumnsMigrateToUnconfigured pins the
|
|
// upgrade path for a deployment that already has entrypoints.
|
|
//
|
|
// The signature columns arrive through GORM's AutoMigrate, so every
|
|
// row written before they existed acquires them with no value. That
|
|
// has to land on "not configured", because the alternative is an
|
|
// upgrade that rejects the traffic the operator was already
|
|
// receiving — a self-inflicted outage on a receiver whose senders
|
|
// cannot be told to start signing.
|
|
//
|
|
// The legacy schema is reproduced by dropping the columns from a
|
|
// migrated database and writing a row through the old shape, so the
|
|
// row really predates them rather than merely being blank.
|
|
func TestEntrypointSignatureColumnsMigrateToUnconfigured(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
db, lc := setupTestDB(t)
|
|
lc.RequireStart()
|
|
|
|
t.Cleanup(lc.RequireStop)
|
|
|
|
for _, column := range []string{
|
|
"signature_scheme", "signature_secret",
|
|
} {
|
|
require.NoError(
|
|
t,
|
|
db.DB().Exec(
|
|
"ALTER TABLE entrypoints DROP COLUMN "+column,
|
|
).Error,
|
|
"dropping %s to reproduce the pre-upgrade schema",
|
|
column,
|
|
)
|
|
}
|
|
|
|
const legacyID = "legacy-entrypoint"
|
|
|
|
require.NoError(
|
|
t,
|
|
db.DB().Exec(
|
|
`INSERT INTO entrypoints
|
|
(id, created_at, updated_at, webhook_id, path,
|
|
description, active)
|
|
VALUES (?, ?, ?, ?, ?, ?, ?)`,
|
|
legacyID, "2026-01-01 00:00:00", "2026-01-01 00:00:00",
|
|
"legacy-webhook", "legacy-path", "predates signatures",
|
|
true,
|
|
).Error,
|
|
)
|
|
|
|
// The upgrade.
|
|
require.NoError(t, db.Migrate())
|
|
|
|
var ep database.Entrypoint
|
|
|
|
require.NoError(
|
|
t,
|
|
db.DB().Where("id = ?", legacyID).First(&ep).Error,
|
|
"the migrated row must still load; a NULL landing in a "+
|
|
"string column would fail here",
|
|
)
|
|
|
|
assert.Equal(t, database.SignatureSchemeNone, ep.SignatureScheme)
|
|
assert.Empty(t, ep.SignatureSecret)
|
|
assert.False(t, ep.SignatureConfigured())
|
|
assert.True(t, ep.Active, "the row's other columns survive")
|
|
|
|
// The behaviour that actually matters: an unsigned request to
|
|
// this entrypoint is still accepted.
|
|
assert.NoError(
|
|
t,
|
|
signature.Verify(&ep, http.Header{}, []byte(`{"a":1}`)),
|
|
)
|
|
}
|