|
5 | 5 | Dependency-Track only connects to publisher destinations that |
6 | 6 | [`dt.outbound.allowed-destinations`](../configuration/properties.md#dtoutboundallowed-destinations) allows. |
7 | 7 |
|
8 | | -!!! note "Changed in v5.2.0" |
| 8 | +!!! note "Changed in 5.2.0" |
9 | 9 | Before v5.2.0, the email and Kafka publishers used their own properties. |
10 | 10 | To allow local connections, set: |
11 | 11 |
|
@@ -195,9 +195,29 @@ Publishes notifications as Webhooks. |
195 | 195 |
|
196 | 196 | ### Alert Config {: #webhook-alert-config } |
197 | 197 |
|
| 198 | +The alert config defines the destination of webhook requests, and optionally how to authenticate and sign them. |
| 199 | + |
| 200 | + |
| 201 | + |
198 | 202 | !!! note |
199 | 203 | Selecting teams as recipients has no effect for this publisher. |
200 | 204 |
|
| 205 | +### Signature |
| 206 | + |
| 207 | +!!! note "Available in 5.2.0 and later" |
| 208 | + |
| 209 | + Earlier versions send webhook requests unsigned. |
| 210 | + |
| 211 | +When the alert config names a signing secret, each request carries an `X-Webhook-Signature` header. |
| 212 | +The signing secret **must** be a [managed secret](../../guides/user/managing-secrets.md). |
| 213 | + |
| 214 | +The header value is `sha256=` followed by the lowercase hex-encoded HMAC-SHA256 of the request body, |
| 215 | +keyed with the UTF-8 bytes of the secret. The publisher computes it over the exact bytes it sends, |
| 216 | +whether it renders a template or publishes Protobuf. |
| 217 | + |
| 218 | +To verify a request, compute the same HMAC over the raw request body, before parsing it, |
| 219 | +and compare it to the header value in constant time. |
| 220 | + |
201 | 221 | [PEM]: https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail |
202 | 222 | [SMTP]: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol |
203 | 223 | [SMTPS]: https://en.wikipedia.org/wiki/SMTPS |
|
0 commit comments