Skip to content

Commit a4bf326

Browse files
committed
Use the Mac service for Slack signature verification
1 parent f8da888 commit a4bf326

7 files changed

Lines changed: 90 additions & 32 deletions

File tree

‎.changeset/effect-chat.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@
55
---
66

77
Add unstable `effect/chat` APIs and Slack/Discord adapters for chat bots, with grapheme-safe Markdown streaming, buttons, selects, modals, slash commands, private/deferred command replies, and adapter conformance testing.
8+
9+
Slack webhook and interactivity layers require a `Mac` service. Provide a runtime layer such as `NodeCrypto.layerMac`, or `Mac.layerWebCrypto` with `SecureRandom.layerWebCrypto`.

‎packages/chat/slack/README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,23 @@ A [Slack](https://slack.com) adapter for `effect/chat`. Includes the Events API
88
npm install effect @effect/chat-slack
99
```
1010

11+
## Signature verification
12+
13+
`SlackChat.layerWebhook` and `SlackChat.layerInteractivity` require the
14+
`Mac` service; the adapter does not provide a default. Supply
15+
`NodeCrypto.layerMac` from `@effect/platform-node/NodeCrypto`,
16+
`BunCrypto.layerMac`, `DenoCrypto.layerMac`, or `BrowserCrypto.layerMac`
17+
from the corresponding platform package.
18+
19+
For other runtimes such as Workers, provide
20+
`Mac.layerWebCrypto.pipe(Layer.provide(SecureRandom.layerWebCrypto))`,
21+
using `effect/crypto/Mac`, `effect/Layer`, and `effect/crypto/SecureRandom`.
22+
Pass the chosen layer to each route layer with `Layer.provide`.
23+
24+
An invalid signing secret fails layer construction as a defect. A verification
25+
error or malformed signature fails closed with HTTP 401. Requests must still
26+
have a digits-only timestamp within five minutes of the current clock.
27+
1128
## Known limits
1229

1330
- A post with files has not been tested in a Slack Connect channel.

‎packages/chat/slack/src/SlackChat.ts‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ import * as ChatInteraction from "effect/chat/ChatInteraction"
5151
import type { ParseMention } from "effect/chat/ChatTest"
5252
import { ChatThread } from "effect/chat/ChatThread"
5353
import * as Context from "effect/Context"
54+
import type * as Mac from "effect/crypto/Mac"
5455
import * as Duration from "effect/Duration"
5556
import * as Effect from "effect/Effect"
5657
import { dual } from "effect/Function"
@@ -387,6 +388,13 @@ export const parts: (thread: ChatThread) => Option.Option<{
387388
* - Slack redelivers on a timeout or an error, so an event can arrive twice.
388389
* `ChatEvent.dedupeKey` gives the two deliveries equal keys.
389390
*
391+
* Signature checks use the required `Mac` service. Provide
392+
* `NodeCrypto.layerMac`, `BunCrypto.layerMac`, `DenoCrypto.layerMac`,
393+
* `BrowserCrypto.layerMac`, or `Mac.layerWebCrypto` with
394+
* `SecureRandom.layerWebCrypto` for other runtimes such as Workers.
395+
* Key construction failures are configuration defects; verification errors
396+
* fail the signature check (401).
397+
*
390398
* @stability unstable
391399
* @category layers
392400
* @since 4.1.5
@@ -397,7 +405,7 @@ export const layerWebhook = (options: {
397405
readonly appId: string
398406
readonly deadline?: Duration.Duration | undefined
399407
readonly maxBodyBytes?: number | undefined
400-
}): Layer.Layer<never, never, HttpRouter.HttpRouter | SlackChat | ChatHandler> =>
408+
}): Layer.Layer<never, never, HttpRouter.HttpRouter | SlackChat | ChatHandler | Mac.Mac> =>
401409
HttpRouter.use(Effect.fnUntraced(function*(router) {
402410
const slack = yield* SlackChat
403411
const handler = yield* ChatHandler
@@ -433,6 +441,13 @@ export const layerWebhook = (options: {
433441
* - Slack never redelivers an interaction, so a click or submit that is not
434442
* answered in time is lost. A user can submit again, as a new request.
435443
*
444+
* Signature checks use the required `Mac` service. Provide
445+
* `NodeCrypto.layerMac`, `BunCrypto.layerMac`, `DenoCrypto.layerMac`,
446+
* `BrowserCrypto.layerMac`, or `Mac.layerWebCrypto` with
447+
* `SecureRandom.layerWebCrypto` for other runtimes such as Workers.
448+
* Key construction failures are configuration defects; verification errors
449+
* fail the signature check (401).
450+
*
436451
* @stability unstable
437452
* @category layers
438453
* @since 4.1.5
@@ -443,7 +458,7 @@ export const layerInteractivity = (options: {
443458
readonly appId: string
444459
readonly deadline?: Duration.Duration | undefined
445460
readonly maxBodyBytes?: number | undefined
446-
}): Layer.Layer<never, never, HttpRouter.HttpRouter | SlackChat | ChatInteraction.Handler> =>
461+
}): Layer.Layer<never, never, HttpRouter.HttpRouter | SlackChat | ChatInteraction.Handler | Mac.Mac> =>
447462
HttpRouter.use(Effect.fnUntraced(function*(router) {
448463
const slack = yield* SlackChat
449464
const handler = yield* ChatInteraction.Handler

‎packages/chat/slack/src/internal/webhook.ts‎

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type * as ChatEvent from "effect/chat/ChatEvent"
33
import type { NotAccepted } from "effect/chat/ChatHandler"
44
import * as ChatInteraction from "effect/chat/ChatInteraction"
55
import * as Clock from "effect/Clock"
6-
import { WebCrypto } from "effect/crypto/WebCrypto"
6+
import * as Mac from "effect/crypto/Mac"
77
import type * as Duration from "effect/Duration"
88
import * as Effect from "effect/Effect"
99
import type * as HttpServerRequest from "effect/http/HttpServerRequest"
@@ -19,19 +19,6 @@ const maxSkewSeconds = 60 * 5
1919

2020
const encoder = new TextEncoder()
2121

22-
const toHex = (bytes: Uint8Array): string => {
23-
let out = ""
24-
for (const byte of bytes) out += byte.toString(16).padStart(2, "0")
25-
return out
26-
}
27-
28-
const timingSafeEqual = (a: string, b: string): boolean => {
29-
if (a.length !== b.length) return false
30-
let diff = 0
31-
for (let i = 0; i < a.length; i++) diff |= a.charCodeAt(i) ^ b.charCodeAt(i)
32-
return diff === 0
33-
}
34-
3522
/**
3623
* Checks Slack's `v0` request signature: an HMAC-SHA256 of
3724
* `v0:{timestamp}:{body}` with the signing secret, and a timestamp within
@@ -40,29 +27,26 @@ const timingSafeEqual = (a: string, b: string): boolean => {
4027
* @internal
4128
*/
4229
export const makeVerifier = Effect.fnUntraced(function*(signingSecret: Redacted.Redacted) {
43-
const crypto = yield* WebCrypto
44-
const key = yield* Effect.promise(() =>
45-
crypto.subtle.importKey(
46-
"raw",
47-
encoder.encode(Redacted.value(signingSecret)),
48-
{ name: "HMAC", hash: "SHA-256" },
49-
false,
50-
["sign"]
51-
)
52-
)
30+
const mac = yield* Mac.Mac
31+
// Invalid signing secrets are configuration defects, not route errors.
32+
const key = yield* Mac.key(Mac.hmacSha256, encoder.encode(Redacted.value(signingSecret))).pipe(Effect.orDie)
5333
return (headers: { readonly [key: string]: string | undefined }, body: Uint8Array): Effect.Effect<boolean> =>
5434
Effect.gen(function*() {
5535
const timestamp = headers["x-slack-request-timestamp"]
5636
const signature = headers["x-slack-signature"]
5737
if (timestamp === undefined || signature === undefined || !/^\d+$/.test(timestamp)) return false
38+
if (!/^v0=(?:[0-9a-fA-F]{2})+$/.test(signature)) return false
39+
const hex = signature.slice(3)
40+
const tag = new Uint8Array(hex.length / 2)
41+
for (let i = 0; i < tag.length; i++) tag[i] = Number.parseInt(hex.slice(i * 2, i * 2 + 2), 16)
5842
const now = yield* Clock.currentTimeMillis
5943
if (Math.abs(now / 1000 - Number(timestamp)) > maxSkewSeconds) return false
6044
const prefix = encoder.encode(`v0:${timestamp}:`)
6145
const message = new Uint8Array(prefix.length + body.length)
6246
message.set(prefix)
6347
message.set(body, prefix.length)
64-
const mac = yield* Effect.promise(() => crypto.subtle.sign("HMAC", key, message))
65-
return timingSafeEqual(`v0=${toHex(new Uint8Array(mac))}`, signature)
48+
// Crypto failures fail closed, like a mismatched signature.
49+
return yield* mac.verify(key, tag, message).pipe(Effect.catch(() => Effect.succeed(false)))
6650
})
6751
})
6852

‎packages/chat/slack/test/events.test.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
*/
55
import { handleRequest, makeVerifier } from "@effect/chat-slack/internal/webhook"
66
import * as SlackChat from "@effect/chat-slack/SlackChat"
7+
import * as NodeCrypto from "@effect/platform-node/NodeCrypto"
78
import { assert, describe, it } from "@effect/vitest"
89
import type * as ChatEvent from "effect/chat/ChatEvent"
910
import { dedupeKey } from "effect/chat/ChatEvent"
@@ -57,7 +58,7 @@ const deliver = Effect.fnUntraced(function*(delivery: Delivery) {
5758
})
5859
const events: Array<ChatEvent.ChatEvent> = []
5960
const response = yield* handleRequest(HttpServerRequest.fromWeb(web), {
60-
verify: yield* makeVerifier(Redacted.make(secret)),
61+
verify: yield* makeVerifier(Redacted.make(secret)).pipe(Effect.provide(NodeCrypto.layerMac)),
6162
appId,
6263
teamId: team,
6364
botUserId: Effect.succeed(botUserId),

‎packages/chat/slack/test/interactions.test.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
* ones are in `commands.test.ts`.
66
*/
77
import * as SlackChat from "@effect/chat-slack/SlackChat"
8+
import * as NodeCrypto from "@effect/platform-node/NodeCrypto"
89
import { assert, describe, it } from "@effect/vitest"
910
import * as Chat from "effect/chat/Chat"
1011
import type { ChatError } from "effect/chat/ChatError"
@@ -281,6 +282,7 @@ describe("layerInteractivity", () => {
281282
}).pipe(
282283
Layer.provide(SlackChat.layer({ botToken: Redacted.make("xoxb-test"), teamId: team })),
283284
Layer.provide(Chat.layer),
285+
Layer.provide(NodeCrypto.layerMac),
284286
Layer.provide(handler.layer),
285287
Layer.provide(makeFake({ "auth.test": authTest }).layer)
286288
)

‎packages/chat/slack/test/webhook.test.ts‎

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
import { handleRequest, makeVerifier, type Options, unavailable as logged } from "@effect/chat-slack/internal/webhook"
22
import * as SlackChat from "@effect/chat-slack/SlackChat"
3+
import * as NodeCrypto from "@effect/platform-node/NodeCrypto"
34
import { assert, describe, it } from "@effect/vitest"
45
import * as Chat from "effect/chat/Chat"
56
import { ChatError, PlatformUnavailable } from "effect/chat/ChatError"
67
import type * as ChatEvent from "effect/chat/ChatEvent"
78
import { ChatHandler, NotAccepted } from "effect/chat/ChatHandler"
9+
import * as CryptoError from "effect/crypto/CryptoError"
10+
import * as Mac from "effect/crypto/Mac"
811
import * as Duration from "effect/Duration"
912
import * as Effect from "effect/Effect"
1013
import * as Fiber from "effect/Fiber"
@@ -56,7 +59,7 @@ const request = async (body: string, options?: { readonly timestamp?: string; re
5659
const message = messageEnvelope({ ts: "1794509003.000001", user: "U080YLYB277", text: "hi <@U0CCLMD4S1L>" })
5760

5861
const handle = Effect.fnUntraced(function*(options: Partial<Options>, web: Request) {
59-
const verify = yield* makeVerifier(Redacted.make(secret))
62+
const verify = yield* makeVerifier(Redacted.make(secret)).pipe(Effect.provide(NodeCrypto.layerMac))
6063
const events: Array<ChatEvent.ChatEvent> = []
6164
const response = yield* handleRequest(HttpServerRequest.fromWeb(web), {
6265
verify,
@@ -94,6 +97,11 @@ describe("webhook", () => {
9497
assert.strictEqual(old.status, 401)
9598
const unsigned = yield* handle({}, new Request("http://localhost/", { method: "POST", body }))
9699
assert.strictEqual(unsigned.status, 401)
100+
for (const signature of ["00", "v0=0", "v0=gg", "v0=00"]) {
101+
const web = yield* Effect.promise(() => request(body))
102+
web.headers.set("x-slack-signature", signature)
103+
assert.strictEqual((yield* handle({}, web)).status, 401)
104+
}
97105
assert.strictEqual(wrongKey.events.length + old.events.length + unsigned.events.length, 0)
98106
}))
99107

@@ -170,6 +178,7 @@ describe("webhook", () => {
170178
}).pipe(
171179
Layer.provide(SlackChat.layer({ botToken: Redacted.make("xoxb-test"), teamId: team })),
172180
Layer.provide(Chat.layer),
181+
Layer.provide(NodeCrypto.layerMac),
173182
Layer.provide(Layer.succeed(ChatHandler, { handle: (event) => Effect.sync(() => void events.push(event)) })),
174183
Layer.provide(fake.layer)
175184
)
@@ -196,18 +205,46 @@ describe("webhook", () => {
196205
assert.isTrue(cancelled)
197206
}))
198207

199-
it.live("layerWebhook serves the path", () =>
208+
it.live("layerWebhook uses the supplied Mac and fails closed on crypto errors", () =>
200209
Effect.gen(function*() {
201210
const fake = makeFake({ "auth.test": authTest })
202211
const events: Array<ChatEvent.ChatEvent> = []
212+
let fail = false
213+
const mac = Layer.succeed(Mac.Mac, {
214+
generateKey: () => Effect.die("unused"),
215+
sign: () => Effect.die("unused"),
216+
verify: Effect.fnUntraced(function*(key, tag, data) {
217+
assert.strictEqual(key.algorithm, Mac.hmacSha256)
218+
assert.deepStrictEqual(tag, new Uint8Array([0xab, 0xcd]))
219+
assert.strictEqual(new TextDecoder().decode(yield* Mac.toBytes(key)), secret)
220+
assert.strictEqual(new TextDecoder().decode(data).split(":").slice(2).join(":"), JSON.stringify(message))
221+
return yield* fail
222+
? Effect.fail(
223+
new CryptoError.CryptoError({
224+
module: "Mac",
225+
method: "verify",
226+
reason: new CryptoError.InvalidKey({ description: "test failure" })
227+
})
228+
)
229+
: Effect.succeed(true)
230+
})
231+
})
203232
const app = SlackChat.layerWebhook({ path: "/slack/events", signingSecret: Redacted.make(secret), appId }).pipe(
204233
Layer.provide(SlackChat.layer({ botToken: Redacted.make("xoxb-test"), teamId: team })),
205234
Layer.provide(Chat.layer),
235+
Layer.provide(mac),
206236
Layer.provide(Layer.succeed(ChatHandler, { handle: (event) => Effect.sync(() => void events.push(event)) })),
207237
Layer.provide(fake.layer)
208238
)
209239
const { dispose, handler } = HttpRouter.toWebHandler(app, { disableLogger: true })
210-
const response = yield* Effect.promise(() => request(JSON.stringify(message)).then((web) => handler(web)))
240+
const send = Effect.promise(async () => {
241+
const web = await request(JSON.stringify(message))
242+
web.headers.set("x-slack-signature", "v0=abcd")
243+
return handler(web)
244+
})
245+
const response = yield* send
246+
fail = true
247+
assert.strictEqual((yield* send).status, 401)
211248
yield* Effect.promise(() => dispose())
212249
assert.strictEqual(response.status, 200)
213250
assert.strictEqual(events.length, 1)

0 commit comments

Comments
 (0)