@toa.io/extensions.exposition 1.0.0-alpha.27 → 1.0.0-alpha.271

package/source/Tenant.ts

@@ -1,30 +1,49 @@
-import { Connector, type Locator, type bindings } from '@toa.io/core'
-import { type Label } from './discovery'
-import { type Branch } from './Branch'
-import type * as RTD from './RTD/syntax'
+import { setTimeout } from 'node:timers/promises'
+import { Connector } from '@toa.io/core'
+import { BRANCH_TTL } from './const'
+import type { bindings } from '@toa.io/core'
+import type { Label } from './discovery'
+import type { Branch } from './Branch'
 
 export class Tenant extends Connector {
   private readonly broadcast: Broadcast
   private readonly branch: Branch
+  private started = 0
+  private stopped = false
 
-  public constructor (broadcast: Broadcast, locator: Locator, node: RTD.Node) {
+  public constructor (broadcast: Broadcast, branch: Branch) {
     super()
 
     this.broadcast = broadcast
-
-    this.branch = {
-      namespace: locator.namespace,
-      component: locator.name,
-      isolated: locator.namespace === 'identity',
-      node
-    }
+    this.branch = branch
 
     this.depends(broadcast)
   }
 
   public override async open (): Promise<void> {
+    this.started = Date.now()
+
     await this.expose()
     await this.broadcast.receive('ping', this.expose.bind(this))
+
+    void this.announce()
+  }
+
+  protected override dispose (): void {
+    this.stopped = true
+  }
+
+  private async announce (): Promise<void> {
+    while (!this.stopped) {
+      const delay = exposeInterval(Date.now() - this.started)
+
+      await setTimeout(delay, undefined, { ref: false })
+
+      if (this.stopped)
+        break
+
+      await this.expose()
+    }
   }
 
   private async expose (): Promise<void> {
@@ -32,4 +51,12 @@ export class Tenant extends Connector {
   }
 }
 
+function exposeInterval (uptime: number): number {
+  return Math.round(EXPOSE_MAX - (EXPOSE_MAX - EXPOSE_MIN) * Math.exp(-uptime / EXPOSE_TAU))
+}
+
+const EXPOSE_MIN = 5_000
+const EXPOSE_MAX = Math.round(BRANCH_TTL / 2.1)
+const EXPOSE_TAU = 900_000
+
 type Broadcast = bindings.Broadcast<Label>

package/source/const.ts

@@ -0,0 +1 @@
+export const BRANCH_TTL = 1_800_000

package/source/deployment.ts

@@ -6,7 +6,7 @@ import * as schemas from './schemas'
 import { shortcuts } from './Directive'
 import { components } from './Composition'
 import { parse } from './RTD/syntax'
-import { DELAY, PORT } from './HTTP/Server'
+import { DELAY, PORT } from './HTTP'
 
 export function deployment (_: unknown, annotation?: Annotation): Dependency {
   assert.ok(annotation !== undefined, 'Exposition context annotation is required')
@@ -18,11 +18,11 @@ export function deployment (_: unknown, annotation?: Annotation): Dependency {
     group: 'exposition',
     name: 'gateway',
     port: PORT,
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     version: require('../package.json').version,
     variables: [],
     components: labels,
-    ingress: { hosts: [] },
+    resources: annotation.resources,
+    ingress: { path: '/', hosts: [] },
     probe: {
       path: '/.ready',
       port: PORT,
@@ -33,32 +33,40 @@ export function deployment (_: unknown, annotation?: Annotation): Dependency {
   if (annotation?.['/'] !== undefined) {
     const tree = parse(annotation['/'], shortcuts)
 
-    service.variables.push({
+    service.variables!.push({
       name: 'TOA_EXPOSITION',
       value: encode(tree)
     })
   }
 
-  const { debug, trace, authorities } = annotation
+  const { debug, authorities } = annotation
 
-  service.ingress.hosts = Object.values(authorities)
-  service.ingress.class = annotation.class
-  service.ingress.annotations = annotation.annotations
+  service.ingress!.hosts = Object.values(authorities)
+
+  // leaving these undefined lets the context's own ingress section supply them
+  if (annotation.class !== undefined)
+    service.ingress!.class = annotation.class
+
+  if (annotation.annotations !== undefined)
+    service.ingress!.annotations = annotation.annotations
 
   const properties: Properties = { authorities }
 
   if (debug === true)
     properties.debug = true
 
-  if (trace === true)
-    properties.trace = true
-
-  service.variables.push({
+  service.variables!.push({
     name: 'TOA_EXPOSITION_PROPERTIES',
     value: encode(properties)
   })
 
+  // Nested identity composition shares this process; gateway already exposes /.ready.
+  service.variables!.push({
+    name: 'TOA_TELEMETRY_READY',
+    value: encode(false)
+  })
+
   return { services: [service] }
 }
 
-type Properties = Pick<Annotation, 'authorities' | 'debug' | 'trace'>
+type Properties = Pick<Annotation, 'authorities' | 'debug'>

package/source/directives/auth/Anonymous.ts

@@ -1,4 +1,4 @@
-import { type Directive, type Input } from './types'
+import { type Directive, type Context } from './types'
 
 export class Anonymous implements Directive {
   private readonly allow: boolean
@@ -7,8 +7,8 @@ export class Anonymous implements Directive {
     this.allow = allow
   }
 
-  public authorize (_: any, input: Input): boolean {
-    return 'authorization' in input.request.headers
+  public authorize (_: any, context: Context): boolean {
+    return 'authorization' in context.request.headers
       ? false
       : this.allow
   }

package/source/directives/auth/Anyone.ts

@@ -0,0 +1,13 @@
+import { type Directive, type Context } from './types'
+
+export class Anyone implements Directive {
+  private readonly allow: boolean
+
+  public constructor (allow: boolean) {
+    this.allow = allow
+  }
+
+  public authorize (_: any, context: Context): boolean {
+    return context.identity !== null && this.allow
+  }
+}

package/source/directives/auth/Assert.ts

@@ -0,0 +1,35 @@
+import assert from 'node:assert'
+import { newid } from '@toa.io/generic'
+import * as http from '../../HTTP'
+import { Incept } from './Incept'
+import type { Context, Directive, Identity } from './types'
+
+export class Assert implements Directive {
+  private readonly disabled: boolean
+
+  public constructor (enabled: boolean) {
+    assert.ok(typeof enabled === 'boolean', '`auth:assert` directive value must be a boolean')
+
+    this.disabled = !enabled
+  }
+
+  public async authorize (identity: Identity | null, context: Context): Promise<boolean> {
+    if (!this.disabled)
+      await this.incept(context, identity)
+
+    return false
+  }
+
+  private async incept (context: Context, identity: Identity | null): Promise<void> {
+    if (context.request.headers.authorization === undefined)
+      throw new http.Unauthorized()
+
+    if (identity === null) {
+      context.identity = await Incept.incept(context, newid())
+
+      context.pipelines.response.push((response) => {
+        response.status = 201
+      })
+    }
+  }
+}

package/source/directives/auth/Authorization.ts

@@ -1,14 +1,20 @@
 import assert from 'node:assert'
 import { match } from 'matchacho'
+import { console } from 'openspan'
+import { Minimatch } from 'minimatch'
 import * as http from '../../HTTP'
 import { Anonymous } from './Anonymous'
 import { Id } from './Id'
 import { Role } from './Role'
 import { Rule } from './Rule'
 import { Incept } from './Incept'
+import { Assert } from './Assert'
 import { Echo } from './Echo'
 import { Scheme } from './Scheme'
 import { Delegate } from './Delegate'
+import { Federation } from './Federation'
+import { Anyone } from './Anyone'
+import { Input, type Declaration } from './Input'
 import { split } from './split'
 import { PRIMARY, PROVIDERS } from './schemes'
 import type { Output } from '../../io'
@@ -22,7 +28,7 @@ import type {
   Discovery,
   Extension,
   Identity,
-  Input,
+  Context,
   Remote,
   Schemes
 } from './types'
@@ -39,7 +45,7 @@ export class Authorization implements DirectiveFamily<Directive, Extension> {
 
   public create (name: string, value: any, remotes: Remotes): Directive {
     assert.ok(name in constructors,
-      `Directive 'auth:${name}' is not implemented.`)
+      `Directive 'auth:${name}' is not implemented`)
 
     const Class = constructors[name]
 
@@ -49,36 +55,44 @@ export class Authorization implements DirectiveFamily<Directive, Extension> {
     return match(Class,
       Role, () => new Role(value as string | string[], this.discovery.roles),
       Rule, () => new Rule(value as Record<string, string>, this.create.bind(this)),
+      Input, () => new Input(value as Declaration[], this.create.bind(this)),
       Incept, () => new Incept(value as string, this.discovery),
+      Delegate, () => new Delegate(value as string, this.discovery.roles),
       () => new Class(value))
   }
 
+  public arrange (directives: Directive[]): void {
+    directives.sort((a, b) => (a.priority ?? 1) - (b.priority ?? 1))
+  }
+
   public async preflight (directives: Directive[],
-    input: Input,
+    context: Context,
     parameters: Parameter[]): Promise<Output> {
-    const identity = await this.resolve(input.authority, input.request.headers.authorization)
-
-    input.identity = identity
+    context.identity = await this.resolve(context.authority, context.request.headers.authorization)
 
     for (const directive of directives) {
-      const allow = await directive.authorize(identity, input, parameters)
+      const allow = await directive.authorize(context.identity, context, parameters)
 
       if (allow)
-        return directive.reply?.(identity) ?? null
+        if (this.permitted(context))
+          return directive.reply?.(context) ?? null
+        else
+          throw new http.Forbidden()
     }
 
-    if (identity === null)
+    if (context.identity === null)
       throw new http.Unauthorized()
     else
       throw new http.Forbidden()
   }
 
   public async settle (directives: Directive[],
-    request: Input,
+    context: Context,
     response: http.OutgoingMessage): Promise<void> {
-    for (const directive of directives) await directive.settle?.(request, response)
+    await Promise.all(directives.map(async (directive) =>
+      directive.settle?.(context, response)))
 
-    const identity = request.identity
+    const identity = context.identity
 
     if (identity === null)
       return
@@ -86,21 +100,22 @@ export class Authorization implements DirectiveFamily<Directive, Extension> {
     if (identity.scheme === PRIMARY && !identity.refresh)
       return
 
-    // Role directive may have already set the value
-    if (identity.roles === undefined)
-      await Role.set(identity, this.discovery.roles)
+    if (await this.banned(identity))
+      throw new http.Unauthorized()
 
+    // Role directive may have already set the value
+    identity.roles ??= await Role.get(identity, this.discovery.roles)
     this.tokens ??= await this.discovery.tokens
 
     const token = await this.tokens.invoke<string>('encrypt', {
-      input: { authority: request.authority, identity }
+      input: { authority: context.authority, identity }
     })
 
     const authorization = `Token ${token}`
 
     response.headers ??= new Headers()
     response.headers.set('authorization', authorization)
-    response.headers.append('cache-control', 'no-store')
+    response.headers.set('cache-control', 'no-store')
   }
 
   private async resolve (authority: string, authorization: string | undefined): Promise<Identity | null> {
@@ -110,19 +125,27 @@ export class Authorization implements DirectiveFamily<Directive, Extension> {
     const [scheme, credentials] = split(authorization)
     const provider = PROVIDERS[scheme]
 
-    if (!(provider in this.discovery))
-      throw new http.Unauthorized(`Unknown authentication scheme '${scheme}'.`)
+    if (provider === undefined)
+      throw new http.Unauthorized(`Unknown authentication scheme '${scheme}'`)
 
     this.schemes[scheme] ??= await this.discovery[provider]
 
     const result = await this.schemes[scheme].invoke<AuthenticationResult>('authenticate', {
       input: {
+        scheme,
         authority,
         credentials
       }
     })
 
-    if (result instanceof Error) return null
+    if (result instanceof Error) {
+      const code: string | unknown = (result as unknown as { code: string }).code
+
+      if (typeof code === 'string')
+        console.info('Authentication failed', { code })
+
+      return null
+    }
 
     const identity = result.identity
 
@@ -134,6 +157,18 @@ export class Authorization implements DirectiveFamily<Directive, Extension> {
     return identity
   }
 
+  private permitted (context: Context): boolean {
+    const permissions = context.identity?.permissions
+
+    if (permissions === undefined)
+      return true
+
+    return Object.entries(permissions).some(([pattern, methods]) => {
+      return methods.some((method) => method === '*' || method === context.request.method) &&
+        glob(pattern).match(context.request.url)
+    })
+  }
+
   private async banned (identity: Identity): Promise<boolean> {
     this.bans ??= await this.discovery.bans
 
@@ -143,15 +178,42 @@ export class Authorization implements DirectiveFamily<Directive, Extension> {
   }
 }
 
+/**
+ * `minimatch(str, pattern)` compiles the pattern on every call, and a permission is
+ * matched on every request the identity makes. Patterns arrive with an identity, hence
+ * the bound.
+ */
+function glob (pattern: string): Minimatch {
+  let compiled = GLOBS.get(pattern)
+
+  if (compiled === undefined) {
+    if (GLOBS.size >= GLOBS_LIMIT)
+      GLOBS.clear()
+
+    compiled = new Minimatch(pattern)
+
+    GLOBS.set(pattern, compiled)
+  }
+
+  return compiled
+}
+
+const GLOBS = new Map<string, Minimatch>()
+const GLOBS_LIMIT = 1024
+
 const constructors: Record<string, new (value: any, argument?: any) => Directive> = {
   anonymous: Anonymous,
+  anyone: Anyone,
   id: Id,
   role: Role,
   rule: Rule,
   incept: Incept,
+  assert: Assert,
   scheme: Scheme,
   echo: Echo,
-  delegate: Delegate
+  delegate: Delegate,
+  claims: Federation,
+  input: Input
 }
 
-const REMOTES: Remote[] = ['basic', 'federation', 'tokens', 'roles', 'bans']
+const REMOTES: Remote[] = ['basic', 'federation', 'tokens', 'roles', 'bans', 'otp']

package/source/directives/auth/Delegate.ts

@@ -1,18 +1,22 @@
 import { BadRequest } from '../../HTTP'
-import { type Directive, type Identity } from './types'
-import type { Input } from '../../io'
+import { Role } from './Role'
+import type { Context, Directive, Identity } from './types'
+import type { Component } from '@toa.io/core'
 
 export class Delegate implements Directive {
   private readonly property: string
+  private readonly discovery: Promise<Component>
 
-  public constructor (property: string) {
+  public constructor (property: string, discovery: Promise<Component>) {
     this.property = property
+    this.discovery = discovery
   }
 
-  public authorize (identity: Identity | null, context: Input): boolean {
+  public async authorize (identity: Identity | null, context: Context): Promise<boolean> {
     if (identity === null)
       return false
 
+    identity.roles ??= await Role.get(identity, this.discovery)
     context.pipelines.body.push((body) => this.embed(body, identity))
 
     return true
@@ -23,7 +27,7 @@ export class Delegate implements Directive {
       body = {}
 
     check(body)
-    body[this.property] = identity
+    body[this.property] = structuredClone(identity)
 
     return body
   }

package/source/directives/auth/Echo.ts

@@ -1,12 +1,22 @@
-import { type OutgoingMessage } from '../../HTTP'
-import { type Directive, type Identity } from './types'
+import { create } from './create'
+import type { OutgoingMessage } from '../../HTTP'
+import type { Directive, Identity, Context } from './types'
 
 export class Echo implements Directive {
-  public authorize (identity: Identity | null): boolean {
-    return identity !== null
+  public authorize (identity: Identity | null, context: Context): boolean {
+    if (identity === null && 'authorization' in context.request.headers)
+      return false
+
+    context.identity ??= create()
+
+    return true
   }
 
-  public reply (identity: Identity | null): OutgoingMessage {
-    return { body: identity }
+  public reply (context: Context): OutgoingMessage {
+    const body = context.identity!
+
+    return body.scheme === null
+      ? { status: 201, body }
+      : { body }
   }
 }

package/source/directives/auth/Federation.ts

@@ -0,0 +1,84 @@
+import assert from 'node:assert'
+import type { Directive, Identity, Context } from './types'
+import type { Parameter } from '../../RTD'
+
+export class Federation implements Directive {
+  private readonly matchers: Array<[keyof Claims, Matcher]>
+
+  public constructor (options: Options) {
+    this.matchers = (Object.entries(options) as Array<[keyof Claims, string]>)
+      .map(([key, value]) => [key, toMatcher(value)])
+
+    assert.ok(this.matchers.length > 0, '`auth:claims` requires at least one property defined')
+  }
+
+  public authorize (identity: Identity | null, context: Context, parameters: Parameter[]): boolean {
+    if (identity === null || !('claims' in identity))
+      return false
+
+    const claims = (identity as FederatedIdentity).claims
+
+    for (const [key, match] of this.matchers)
+      if (!match(claims[key], context, parameters))
+        return false
+
+    return true
+  }
+}
+
+function toMatcher (expression: string): Matcher {
+  if (expression.startsWith(':')) {
+    const key = expression.slice(1) as 'authority'
+
+    if (key === 'authority')
+      return (value, context) => matches(value, context[key])
+
+    if (key === 'domain')
+      return (value, context) => {
+        return Array.isArray(value)
+          ? value.some((iss) => codomain(iss, context))
+          : codomain(value, context)
+      }
+
+    throw new Error('Unknown `auth:claims` syntax: ' + expression)
+  }
+
+  if (expression.startsWith('/:')) {
+    const name = expression.slice(2)
+
+    return (value, _, parameters) => parameters
+      .some((parameter) => parameter.name === name && matches(value, parameter.value))
+  }
+
+  return (value) => matches(value, expression)
+}
+
+function matches (value: string | string[], reference: string): boolean {
+  return Array.isArray(value)
+    ? value.includes(reference)
+    : value === reference
+}
+
+function codomain (iss: string, context: Context): boolean {
+  const hostname = new URL(iss).hostname
+  const dot = hostname.indexOf('.')
+  const basename = dot === -1 ? hostname : hostname.slice(dot)
+
+  return context.authority.slice(-basename.length) === basename
+}
+
+type Matcher = (value: string | string[], context: Context, parameters: Parameter[]) => boolean
+
+interface Claims {
+  iss: string
+  sub: string
+  aud: string | string[]
+}
+
+interface Options extends Partial<Claims> {
+  iss: string
+}
+
+interface FederatedIdentity extends Identity {
+  claims: Claims
+}

package/source/directives/auth/Id.ts

@@ -8,7 +8,7 @@ export class Id implements Directive {
     this.parameter = parameter
   }
 
-  public authorize (identity: Identity | null, _: any, parameters: Parameter[]): boolean {
+  public authorize (identity: Identity | null, _: unknown, parameters: Parameter[]): boolean {
     if (identity === null)
       return false