effect 4.0.0-beta.6 → 4.0.0-beta.62

package/src/unstable/eventlog/EventLogSessionAuth.ts

@@ -0,0 +1,437 @@
+/**
+ * @since 4.0.0
+ */
+import * as Data from "../../Data.ts"
+import * as Effect from "../../Effect.ts"
+
+const textEncoder = new TextEncoder()
+const textDecoder = new TextDecoder("utf-8", { fatal: true })
+
+const constLengthPrefixBytes = 4
+
+/**
+ * @since 4.0.0
+ * @category constants
+ */
+export const AuthPayloadContext = "eventlog-auth-v1"
+
+/**
+ * @since 4.0.0
+ * @category constants
+ */
+export const Ed25519PublicKeyLength = 32
+
+/**
+ * @since 4.0.0
+ * @category constants
+ */
+export const Ed25519SignatureLength = 64
+
+/**
+ * @since 4.0.0
+ * @category constants
+ */
+export const SessionAuthChallengeLength = 32
+
+/**
+ * @since 4.0.0
+ * @category constants
+ */
+export const SessionAuthChallengeTimeToLiveMillis = 30_000
+
+/**
+ * @since 4.0.0
+ * @category model
+ */
+export interface SessionAuthPayload {
+  readonly remoteId: string | Uint8Array
+  readonly challenge: Uint8Array
+  readonly publicKey: string
+  readonly signingPublicKey: Uint8Array
+}
+
+/**
+ * @since 4.0.0
+ * @category errors
+ */
+export class EventLogSessionAuthError extends Data.TaggedError("EventLogSessionAuthError")<{
+  readonly reason:
+    | "InvalidPayload"
+    | "InvalidContext"
+    | "InvalidAlgorithm"
+    | "InvalidSigningPublicKeyLength"
+    | "InvalidSignatureLength"
+    | "InvalidSigningPrivateKey"
+    | "CryptoUnavailable"
+    | "CryptoFailure"
+  readonly message: string
+  readonly cause?: unknown
+}> {}
+
+const toArrayBuffer = (data: Uint8Array): ArrayBuffer => {
+  const copy = new Uint8Array(data.byteLength)
+  copy.set(data)
+  return copy.buffer
+}
+
+const decodeUtf8 = (bytes: Uint8Array) =>
+  Effect.try({
+    try: () => textDecoder.decode(bytes),
+    catch: (cause) =>
+      new EventLogSessionAuthError({
+        reason: "InvalidPayload",
+        message: "Session auth payload contains invalid UTF-8 bytes",
+        cause
+      })
+  })
+
+const assertSigningPublicKeyLength = (signingPublicKey: Uint8Array): Effect.Effect<void, EventLogSessionAuthError> => {
+  if (signingPublicKey.byteLength === Ed25519PublicKeyLength) return Effect.void
+  return Effect.fail(
+    new EventLogSessionAuthError({
+      reason: "InvalidSigningPublicKeyLength",
+      message:
+        `Expected signingPublicKey length to be ${Ed25519PublicKeyLength} bytes, received ${signingPublicKey.byteLength}`
+    })
+  )
+}
+
+const assertSignatureLength = (signature: Uint8Array): Effect.Effect<void, EventLogSessionAuthError> => {
+  if (signature.byteLength === Ed25519SignatureLength) return Effect.void
+  return Effect.fail(
+    new EventLogSessionAuthError({
+      reason: "InvalidSignatureLength",
+      message: `Expected signature length to be ${Ed25519SignatureLength} bytes, received ${signature.byteLength}`
+    })
+  )
+}
+
+const getSubtle = Effect.suspend(() => {
+  const subtle = globalThis.crypto?.subtle
+  if (subtle === undefined) {
+    return Effect.fail(
+      new EventLogSessionAuthError({
+        reason: "CryptoUnavailable",
+        message: "globalThis.crypto.subtle is not available"
+      })
+    )
+  }
+  return Effect.succeed(subtle)
+})
+
+const getCrypto = Effect.suspend(() => {
+  const crypto = globalThis.crypto
+  if (crypto === undefined) {
+    return Effect.fail(
+      new EventLogSessionAuthError({
+        reason: "CryptoUnavailable",
+        message: "globalThis.crypto is not available"
+      })
+    )
+  }
+  return Effect.succeed(crypto)
+})
+
+const writeLength = (
+  target: Uint8Array,
+  offset: number,
+  length: number
+): Effect.Effect<number, EventLogSessionAuthError> => {
+  if (length < 0 || length > 0xffff_ffff) {
+    return Effect.fail(
+      new EventLogSessionAuthError({
+        reason: "InvalidPayload",
+        message: `Invalid canonical field length: ${length}`
+      })
+    )
+  }
+
+  target[offset] = (length >>> 24) & 0xff
+  target[offset + 1] = (length >>> 16) & 0xff
+  target[offset + 2] = (length >>> 8) & 0xff
+  target[offset + 3] = length & 0xff
+
+  return Effect.succeed(offset + constLengthPrefixBytes)
+}
+
+const readLength = (source: Uint8Array, offset: number): number =>
+  (
+    (source[offset]! << 24) |
+    (source[offset + 1]! << 16) |
+    (source[offset + 2]! << 8) |
+    source[offset + 3]!
+  ) >>> 0
+
+const readField = (
+  payload: Uint8Array,
+  state: { offset: number }
+): Effect.Effect<Uint8Array, EventLogSessionAuthError> => {
+  if (state.offset + constLengthPrefixBytes > payload.byteLength) {
+    return Effect.fail(
+      new EventLogSessionAuthError({
+        reason: "InvalidPayload",
+        message: "Session auth payload is truncated before field length"
+      })
+    )
+  }
+
+  const length = readLength(payload, state.offset)
+  state.offset += constLengthPrefixBytes
+
+  if (state.offset + length > payload.byteLength) {
+    return Effect.fail(
+      new EventLogSessionAuthError({
+        reason: "InvalidPayload",
+        message: "Session auth payload is truncated inside a field"
+      })
+    )
+  }
+
+  const field = payload.slice(state.offset, state.offset + length)
+  state.offset += length
+  return Effect.succeed(field)
+}
+
+const bytesToHex = (bytes: Uint8Array): string => {
+  let hex = ""
+  for (const byte of bytes) {
+    hex += byte.toString(16).padStart(2, "0")
+  }
+  return hex
+}
+
+const encodeRemoteIdField = (remoteId: string | Uint8Array): Uint8Array =>
+  typeof remoteId === "string"
+    ? textEncoder.encode(remoteId)
+    : textEncoder.encode(bytesToHex(remoteId))
+
+/**
+ * Canonical payload format uses ordered big-endian length-prefixed fields:
+ *
+ * 1. context (fixed: eventlog-auth-v1)
+ * 2. remoteId
+ * 3. challenge bytes
+ * 4. publicKey
+ * 5. signingPublicKey bytes
+ *
+ * @since 4.0.0
+ * @category encoding
+ */
+export const encodeSessionAuthPayload = Effect.fnUntraced(function*(payload: SessionAuthPayload) {
+  yield* assertSigningPublicKeyLength(payload.signingPublicKey)
+
+  const fields = [
+    textEncoder.encode(AuthPayloadContext),
+    encodeRemoteIdField(payload.remoteId),
+    payload.challenge,
+    textEncoder.encode(payload.publicKey),
+    payload.signingPublicKey
+  ]
+
+  const totalLength = fields.reduce(
+    (total, field) => total + constLengthPrefixBytes + field.byteLength,
+    0
+  )
+  const encoded = new Uint8Array(totalLength)
+
+  let offset = 0
+  for (const field of fields) {
+    offset = yield* writeLength(encoded, offset, field.byteLength)
+    encoded.set(field, offset)
+    offset += field.byteLength
+  }
+
+  return encoded
+})
+
+/**
+ * @since 4.0.0
+ * @category encoding
+ */
+export const decodeSessionAuthPayload = Effect.fnUntraced(
+  function*(payload: Uint8Array): Effect.fn.Return<SessionAuthPayload, EventLogSessionAuthError> {
+    const state = { offset: 0 }
+    const context = yield* decodeUtf8(yield* readField(payload, state))
+
+    if (context !== AuthPayloadContext) {
+      return yield* new EventLogSessionAuthError({
+        reason: "InvalidContext",
+        message: `Invalid session auth payload context: ${context}`
+      })
+    }
+
+    const remoteId = yield* decodeUtf8(yield* readField(payload, state))
+    const challenge = yield* readField(payload, state)
+    const publicKey = yield* decodeUtf8(yield* readField(payload, state))
+    const signingPublicKey = yield* readField(payload, state)
+    yield* assertSigningPublicKeyLength(signingPublicKey)
+
+    if (state.offset !== payload.byteLength) {
+      return yield* new EventLogSessionAuthError({
+        reason: "InvalidPayload",
+        message: "Session auth payload contains trailing bytes"
+      })
+    }
+
+    return {
+      remoteId,
+      challenge,
+      publicKey,
+      signingPublicKey
+    }
+  }
+)
+
+/**
+ * @since 4.0.0
+ * @category signing
+ */
+export const signSessionAuthPayloadBytes = Effect.fnUntraced(function*(options: {
+  readonly payload: Uint8Array
+  readonly signingPrivateKey: Uint8Array
+}): Effect.fn.Return<Uint8Array<ArrayBuffer>, EventLogSessionAuthError> {
+  yield* decodeSessionAuthPayload(options.payload)
+
+  const subtle = yield* getSubtle
+  let privateKey = yield* Effect.tryPromise({
+    try: () =>
+      subtle.importKey(
+        "pkcs8",
+        toArrayBuffer(options.signingPrivateKey),
+        "Ed25519",
+        false,
+        ["sign"]
+      ),
+    catch: (cause) =>
+      new EventLogSessionAuthError({
+        reason: "InvalidSigningPrivateKey",
+        message: "Failed to import Ed25519 signing private key (expected PKCS#8 bytes)",
+        cause
+      })
+  })
+
+  const signature = yield* Effect.tryPromise({
+    try: () => subtle.sign("Ed25519", privateKey, toArrayBuffer(options.payload)),
+    catch: (cause) =>
+      new EventLogSessionAuthError({
+        reason: "CryptoFailure",
+        message: "Failed to sign canonical session auth payload",
+        cause
+      })
+  })
+  return new Uint8Array(signature)
+})
+
+/**
+ * @since 4.0.0
+ * @category verification
+ */
+export const verifySessionAuthPayloadBytes = Effect.fnUntraced(function*(options: {
+  readonly payload: Uint8Array
+  readonly signingPublicKey: Uint8Array
+  readonly signature: Uint8Array
+}) {
+  yield* decodeSessionAuthPayload(options.payload)
+  yield* assertSigningPublicKeyLength(options.signingPublicKey)
+  yield* assertSignatureLength(options.signature)
+
+  const subtle = yield* getSubtle
+  const publicKey = yield* Effect.tryPromise({
+    try: () => subtle.importKey("raw", toArrayBuffer(options.signingPublicKey), "Ed25519", false, ["verify"]),
+    catch: (cause) =>
+      new EventLogSessionAuthError({
+        reason: "InvalidSigningPublicKeyLength",
+        message: "Failed to import Ed25519 signing public key",
+        cause
+      })
+  })
+
+  return yield* Effect.tryPromise({
+    try: () => subtle.verify("Ed25519", publicKey, toArrayBuffer(options.signature), toArrayBuffer(options.payload)),
+    catch: (cause) =>
+      new EventLogSessionAuthError({
+        reason: "CryptoFailure",
+        message: "Failed to verify canonical session auth payload signature",
+        cause
+      })
+  })
+})
+
+/**
+ * @since 4.0.0
+ * @category signing
+ */
+export const signSessionAuthPayload = (
+  options: SessionAuthPayload & {
+    readonly signingPrivateKey: Uint8Array
+  }
+) =>
+  encodeSessionAuthPayload(options).pipe(
+    Effect.flatMap((payload) =>
+      signSessionAuthPayloadBytes({
+        payload,
+        signingPrivateKey: options.signingPrivateKey
+      })
+    )
+  )
+
+/**
+ * @since 4.0.0
+ * @category verification
+ */
+export const verifySessionAuthPayload = (
+  options: SessionAuthPayload & {
+    readonly signature: Uint8Array
+  }
+) =>
+  encodeSessionAuthPayload(options).pipe(
+    Effect.flatMap((payload) =>
+      verifySessionAuthPayloadBytes({
+        payload,
+        signingPublicKey: options.signingPublicKey,
+        signature: options.signature
+      })
+    )
+  )
+
+/**
+ * @since 4.0.0
+ * @category challenge
+ */
+export const makeSessionAuthChallenge: Effect.Effect<
+  Uint8Array<ArrayBuffer>,
+  EventLogSessionAuthError
+> = Effect.gen(function*() {
+  const crypto = yield* getCrypto
+  const challenge = new Uint8Array(SessionAuthChallengeLength)
+  crypto.getRandomValues(challenge)
+  return challenge
+})
+
+/**
+ * @since 4.0.0
+ * @category verification
+ */
+export const verifySessionAuthenticateRequest = Effect.fnUntraced(function*(options: {
+  readonly remoteId: string | Uint8Array
+  readonly challenge: Uint8Array
+  readonly publicKey: string
+  readonly signingPublicKey: Uint8Array
+  readonly signature: Uint8Array
+  readonly algorithm: string
+}) {
+  if (options.algorithm !== "Ed25519") {
+    return yield* new EventLogSessionAuthError({
+      reason: "InvalidAlgorithm",
+      message: `Unsupported session auth algorithm: ${options.algorithm}`
+    })
+  }
+
+  return yield* verifySessionAuthPayload({
+    remoteId: options.remoteId,
+    challenge: options.challenge,
+    publicKey: options.publicKey,
+    signingPublicKey: options.signingPublicKey,
+    signature: options.signature
+  })
+})

package/src/unstable/eventlog/{SqlEventLogJournal.ts → SqlEventJournal.ts}

@@ -7,14 +7,12 @@ import * as Layer from "../../Layer.ts"
 import * as PubSub from "../../PubSub.ts"
 import * as Schema from "../../Schema.ts"
 import * as SqlClient from "../sql/SqlClient.ts"
-import type * as SqlError from "../sql/SqlError.ts"
+import * as SqlError from "../sql/SqlError.ts"
 import * as SqlSchema from "../sql/SqlSchema.ts"
 import * as EventJournal from "./EventJournal.ts"
 
 type WriteFromRemoteOptions = Parameters<EventJournal.EventJournal["Service"]["writeFromRemote"]>[0]
 
-type RemoteBracket = readonly [ReadonlyArray<EventJournal.Entry>, ReadonlyArray<EventJournal.RemoteEntry>]
-
 /**
  * @since 4.0.0
  * @category constructors
@@ -73,7 +71,7 @@ export const make = (options?: {
             payload BLOB NOT NULL,
             timestamp INTEGER NOT NULL
           )`
-    })
+    }).pipe(withTracerDisabled)
 
     yield* sql.onDialectOrElse({
       pg: () =>
@@ -108,7 +106,7 @@ export const make = (options?: {
             sequence INT NOT NULL,
             PRIMARY KEY (remote_id, entry_id)
           )`
-    })
+    }).pipe(withTracerDisabled)
 
     const decodeEntryRows = Schema.decodeUnknownEffect(EntryRowArray)
     const toEntries = (rows: ReadonlyArray<EntryRow>): ReadonlyArray<EventJournal.Entry> => rows.map(toEntry)
@@ -129,7 +127,9 @@ export const make = (options?: {
     const pubsub = yield* PubSub.unbounded<EventJournal.Entry>()
 
     const writeFromRemote = Effect.fnUntraced(function*(options: WriteFromRemoteOptions): Effect.fn.Return<
-      void,
+      {
+        readonly duplicateEntries: ReadonlyArray<EventJournal.Entry>
+      },
       EventJournal.EventJournalError | Schema.SchemaError | SqlError.SqlError
     > {
       const entries = options.entries.map((remoteEntry) => remoteEntry.entry)
@@ -164,13 +164,15 @@ export const make = (options?: {
       }
 
       const uncommitted = options.entries.filter((entry) => !existingIds.has(entry.entry.idString))
-      const brackets: ReadonlyArray<RemoteBracket> = options.compact
+      const duplicateEntries = options.entries
+        .filter((entry) => existingIds.has(entry.entry.idString))
+        .map((entry) => entry.entry)
+      const compacted = options.compact
         ? yield* options.compact(uncommitted)
-        : [[uncommitted.map((remoteEntry) => remoteEntry.entry), uncommitted] as const]
+        : uncommitted.map((remoteEntry) => remoteEntry.entry)
 
-      for (const [compacted] of brackets) {
-        for (const entry of compacted) {
-          const conflicts = yield* sql`
+      for (const entry of compacted) {
+        const conflicts = yield* sql`
             SELECT *
             FROM ${entryTableSql}
             WHERE event = ${entry.event} AND
@@ -178,16 +180,20 @@ export const make = (options?: {
                   timestamp >= ${entry.createdAtMillis}
             ORDER BY timestamp ASC
           `.pipe(
-            Effect.flatMap(decodeEntryRows),
-            Effect.map(toEntries)
-          )
-          yield* options.effect({ entry, conflicts })
-        }
+          Effect.flatMap(decodeEntryRows),
+          Effect.map(toEntries)
+        )
+        yield* options.effect({ entry, conflicts })
+      }
+
+      return {
+        duplicateEntries
       }
     })
 
     return EventJournal.EventJournal.of({
       entries: sql`SELECT * FROM ${entryTableSql} ORDER BY timestamp ASC`.pipe(
+        withTracerDisabled,
         Effect.flatMap(decodeEntryRows),
         Effect.map(toEntries),
         Effect.mapError((cause) => new EventJournal.EventJournalError({ cause, method: "entries" }))
@@ -199,18 +205,18 @@ export const make = (options?: {
             event,
             primaryKey,
             payload
-          }, { disableValidation: true })
+          }, { disableChecks: true })
           yield* insertEntry(toEntryRow(entry))
           const value = yield* effect(entry)
           yield* PubSub.publish(pubsub, entry)
           return value
         },
-        sql.withTransaction,
+        withTracerDisabled,
         Effect.mapError((cause) => new EventJournal.EventJournalError({ cause, method: "write" }))
       ),
       writeFromRemote: (options) =>
         writeFromRemote(options).pipe(
-          sql.withTransaction,
+          withTracerDisabled,
           Effect.catchIf(
             (e) => e._tag !== "EventJournalError",
             (cause) => Effect.fail(new EventJournal.EventJournalError({ cause, method: "writeFromRemote" }))
@@ -229,7 +235,7 @@ export const make = (options?: {
           )
           return yield* f(entries)
         },
-        sql.withTransaction,
+        withTracerDisabled,
         Effect.mapError((cause) => new EventJournal.EventJournalError({ cause, method: "withRemoteUncommited" }))
       ),
       nextRemoteSequence: (remoteId) =>
@@ -240,6 +246,7 @@ export const make = (options?: {
               if (value === null || value === undefined) return 0
               return Number(value) + 1
             }),
+            withTracerDisabled,
             Effect.mapError((cause) => new EventJournal.EventJournalError({ cause, method: "nextRemoteSequence" }))
           ),
       changes: PubSub.subscribe(pubsub),
@@ -247,8 +254,15 @@ export const make = (options?: {
         yield* sql`DROP TABLE ${entryTableSql}`
         yield* sql`DROP TABLE ${remotesTableSql}`
       }).pipe(
+        withTracerDisabled,
         Effect.mapError((cause) => new EventJournal.EventJournalError({ cause, method: "destroy" }))
-      )
+      ),
+      withLock(_storeId) {
+        return (effect) =>
+          sql.withTransaction(effect).pipe(
+            Effect.catchIf(SqlError.isSqlError, Effect.die)
+          )
+      }
     })
   })
 
@@ -280,7 +294,7 @@ const toEntry = (row: EntryRow): EventJournal.Entry =>
     event: row.event,
     primaryKey: row.primary_key,
     payload: row.payload
-  }, { disableValidation: true })
+  }, { disableChecks: true })
 
 const toEntryRow = (entry: EventJournal.Entry): EntryRow => ({
   id: entry.id,
@@ -297,3 +311,5 @@ const RemoteRow = Schema.Struct({
 })
 
 const RemoteRowArray = Schema.Array(RemoteRow)
+
+const withTracerDisabled = Effect.withTracerEnabled(false)