Skip to content

chore: Remove timestamps from default signature template #588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alexbouchardd wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: Remove timestamps from default signature template #588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@ DELIVERYMQ_MAX_CONCURRENCY=1
# DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_SIGNATURE_HEADER=false
# DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_TIMESTAMP_HEADER=false
# DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_TOPIC_HEADER=false
# DESTINATIONS_WEBHOOK_SIGNATURE_CONTENT_TEMPLATE={{.Timestamp.Unix}}.{{.Body}}
# DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_TEMPLATE=t={{.Timestamp.Unix}},v0={{.Signatures | join ","}}
# DESTINATIONS_WEBHOOK_SIGNATURE_CONTENT_TEMPLATE={{.Body}}
# DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_TEMPLATE=v0={{.Signatures | join ","}}
# DESTINATIONS_WEBHOOK_SIGNATURE_ENCODING="hex"
# DESTINATIONS_WEBHOOK_SIGNATURE_ALGORITHM="hmac-sha256"

Expand Down
22 changes: 11 additions & 11 deletions docs/pages/guides/migrate-to-outpost.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,17 +85,17 @@ You can customize the following webhook features and behaviors. The full path to

Templates use the [Go template syntax](https://pkg.go.dev/text/template).

| YAML | Environment Variable | Default Value |
| ---------------------------------- | ------------------------------------------------------- | ------------------------------------------------------ |
| `header_prefix` | `DESTINATIONS_WEBHOOK_HEADER_PREFIX` | `x-outpost` |
| `disable_default_event_id_header` | `DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_EVENT_ID_HEADER` | `false` |
| `disable_default_signature_header` | `DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_SIGNATURE_HEADER` | `false` |
| `disable_default_timestamp_header` | `DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_TIMESTAMP_HEADER` | `false` |
| `disable_default_topic_header` | `DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_TOPIC_HEADER` | `false` |
| `signature_content_template` | `DESTINATIONS_WEBHOOK_SIGNATURE_CONTENT_TEMPLATE` | `{{.Timestamp.Unix}}.{{.Body}}` |
| `signature_header_template` | `DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_TEMPLATE` | `t={{.Timestamp.Unix}},v0={{.Signatures \| join ","}}` |
| `signature_encoding` | `DESTINATIONS_WEBHOOK_SIGNATURE_ENCODING` | `hex` |
| `signature_algorithm` | `DESTINATIONS_WEBHOOK_SIGNATURE_ALGORITHM` | `hmac-sha256` |
| YAML | Environment Variable | Default Value |
| ---------------------------------- | ------------------------------------------------------- | -------------------------------- |
| `header_prefix` | `DESTINATIONS_WEBHOOK_HEADER_PREFIX` | `x-outpost` |
| `disable_default_event_id_header` | `DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_EVENT_ID_HEADER` | `false` |
| `disable_default_signature_header` | `DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_SIGNATURE_HEADER` | `false` |
| `disable_default_timestamp_header` | `DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_TIMESTAMP_HEADER` | `false` |
| `disable_default_topic_header` | `DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_TOPIC_HEADER` | `false` |
| `signature_content_template` | `DESTINATIONS_WEBHOOK_SIGNATURE_CONTENT_TEMPLATE` | `{{.Body}}` |
| `signature_header_template` | `DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_TEMPLATE` | `v0={{.Signatures \| join ","}}` |
| `signature_encoding` | `DESTINATIONS_WEBHOOK_SIGNATURE_ENCODING` | `hex` |
| `signature_algorithm` | `DESTINATIONS_WEBHOOK_SIGNATURE_ALGORITHM` | `hmac-sha256` |

### Migration Process

Expand Down
4 changes: 2 additions & 2 deletions internal/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,8 @@ func (c *Config) InitDefaults() {
MetadataPath: "config/outpost/destinations",
Webhook: DestinationWebhookConfig{
HeaderPrefix: "x-outpost-",
SignatureContentTemplate: "{{.Timestamp.Unix}}.{{.Body}}",
SignatureHeaderTemplate: "t={{.Timestamp.Unix}},v0={{.Signatures | join \",\"}}",
SignatureContentTemplate: "{{.Body}}",
SignatureHeaderTemplate: "v0={{.Signatures | join \",\"}}",
SignatureEncoding: "hex",
SignatureAlgorithm: "hmac-sha256",
},
Expand Down
Loading