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

package/source/directives/auth/Incept.ts

@@ -1,39 +1,52 @@
-import { type Maybe } from '@toa.io/types'
+import assert from 'node:assert'
+import { console } from 'openspan'
 import * as http from '../../HTTP'
-import { type Directive, type Discovery, type Identity, type Input, type Schemes } from './types'
 import { split } from './split'
-import { PROVIDERS } from './schemes'
+import { create } from './create'
+import { PROVIDERS, INCEPTION } from './schemes'
+import { Role } from './Role'
+import type { Component } from '@toa.io/core'
+import type { Maybe } from '@toa.io/types'
+import type { Directive, Discovery, Identity, Context, Schemes, Ban } from './types'
 
 export class Incept implements Directive {
-  private readonly property: string
-  private readonly discovery: Discovery
-  private readonly schemes: Schemes = {} as unknown as Schemes
+  private static readonly schemes: Schemes = {} as unknown as Schemes
+  private static discovery: Discovery
+  private static bans: Component | null = null
+
+  private readonly property: string | null
 
   public constructor (property: string, discovery: Discovery) {
+    assert.ok(property === null || typeof property === 'string',
+      '`auth:incept` value must be a string or null')
+
     this.property = property
-    this.discovery = discovery
+    Incept.discovery ??= discovery
   }
 
-  public authorize (identity: Identity | null, input: Input): boolean {
-    return identity === null && 'authorization' in input.request.headers
-  }
+  public static async incept (context: Context, id: string): Promise<Identity> {
+    const [scheme, credentials] = split(context.request.headers.authorization!)
+    const provider = PROVIDERS[scheme]
 
-  public async settle (input: Input, response: http.OutgoingMessage): Promise<void> {
-    const id = response.body?.[this.property]
+    if (provider === undefined)
+      throw new http.BadRequest('Authentication scheme is not supported')
 
-    if (id === undefined)
-      throw new http.Conflict('Identity inception has failed as the response body ' +
-        ` does not contain the '${this.property}' property.`)
+    if (!INCEPTION.includes(provider))
+      throw new http.Unauthorized()
 
-    const [scheme, credentials] = split(input.request.headers.authorization!)
-    const provider = PROVIDERS[scheme]
+    Incept.bans ??= await Incept.discovery.bans
+
+    const ban = await Incept.bans.invoke<Ban>('observe', { query: { id } })
 
-    this.schemes[scheme] ??= await this.discovery[provider]
+    if (ban.banned)
+      throw new http.Unauthorized()
 
-    const identity = await this.schemes[scheme]
-      .invoke<Maybe<Identity>>('incept', {
+    Incept.schemes[scheme] ??= await Incept.discovery[provider]
+
+    const identity = await Incept.schemes[scheme].invoke<Maybe<Identity>>('incept', {
       input: {
-        authority: input.authority,
+        scheme,
+        authority: context.authority,
         id,
         credentials
       }
@@ -42,7 +55,46 @@ export class Incept implements Directive {
     if (identity instanceof Error)
       throw new http.UnprocessableEntity(identity)
 
-    input.identity = identity
-    input.identity.scheme = scheme
+    identity.scheme = scheme
+    identity.roles = []
+
+    return identity
+  }
+
+  public authorize (identity: Identity | null): boolean {
+    return identity === null
+  }
+
+  public reply (context: Context): http.OutgoingMessage | null {
+    if (this.property !== null)
+      return null
+
+    const body = create(context.request.headers.authorization)
+
+    return { body }
+  }
+
+  public async settle (context: Context, response: http.OutgoingMessage): Promise<void> {
+    const id = response.body?.[this.property ?? 'id']
+
+    if (id === undefined) {
+      console.debug('Inception skipped: response does not contain expected property', {
+        property: this.property,
+        response
+      })
+
+      return
+    }
+
+    assert(typeof id === 'string', `Response body property "${this.property}" expected to be a string`)
+
+    if (context.request.headers.authorization !== undefined)
+      context.identity = await Incept.incept(context, id)
+    else {
+      const identity = { id, scheme: null, refresh: true }
+      const roles = await Role.get(identity, Incept.discovery.roles)
+
+      context.identity = { ...identity, roles }
+    }
   }
 }

package/source/directives/auth/Input.ts

@@ -0,0 +1,71 @@
+import { Forbidden } from '../../HTTP'
+import type { Parameter } from '../../RTD'
+import type { Context, Directive, Identity, Create } from './types'
+
+export class Input implements Directive {
+  public priority = 0
+  private readonly statements: Statement[] = []
+
+  public constructor (declarations: Declaration[], create: Create) {
+    this.statements = declarations.map((declaration) => new Statement(declaration, create))
+  }
+
+  public async authorize (identity: Identity | null, context: Context, parameters: Parameter[]): Promise<boolean> {
+    context.pipelines.body.push(async (body) => this.check(identity, context, parameters, body))
+
+    return false
+  }
+
+  // eslint-disable-next-line max-params
+  private async check (identity: Identity | null, context: Context, parameters: Parameter[], body: unknown): Promise<unknown> {
+    if (body === undefined || body === null || body.constructor !== Object)
+      return body
+
+    const settled = await Promise.allSettled(this.statements.map(async (statement) =>
+      statement.check(identity, context, parameters, body as Body)))
+
+    for (const result of settled)
+      if (result.status === 'rejected')
+        throw result.reason
+
+    return body
+  }
+}
+
+class Statement {
+  private readonly properties: string[]
+  private readonly directives: Directive[] = []
+
+  public constructor ({ prop, ...directives }: Declaration, create: Create) {
+    this.properties = typeof prop === 'string' ? [prop] : prop
+
+    for (const [name, value] of Object.entries(directives)) {
+      const directive = create(name, value)
+
+      this.directives.push(directive)
+    }
+  }
+
+  // eslint-disable-next-line max-params
+  public async check (identity: Identity | null, context: Context, parameters: Parameter[], body: Body): Promise<void> {
+    const match = this.properties.some((property) => property in body)
+
+    if (!match)
+      return
+
+    for (const directive of this.directives) {
+      const authorized = await directive.authorize(identity, context, parameters)
+
+      if (!authorized)
+        throw new Forbidden('Input property is not authorized')
+    }
+  }
+}
+
+export interface Declaration {
+  [key: Exclude<string, 'prop'>]: unknown
+
+  prop: string | string[]
+}
+
+type Body = Record<string, unknown>

package/source/directives/auth/Role.test.ts

@@ -31,7 +31,7 @@ it('should return false if not matched', async () => {
   expect(result).toBe(false)
 
   expect(remote.invoke)
-    .toBeCalledWith('list', {
+    .toHaveBeenCalledWith('list', {
       query: {
         criteria: `identity==${identity.id}`,
         limit: 1024
@@ -93,8 +93,7 @@ it('should return false on mismatch with parameters', async () => {
   expect(result).toBe(false)
 })
 
-async function match
-(expected: string[], actual: string[], parameters: Parameter[] = []): Promise<boolean> {
+async function match (expected: string[], actual: string[], parameters: Parameter[] = []): Promise<boolean> {
   const directive = new Role(expected, discovery)
 
   const identity: Identity = {

package/source/directives/auth/Role.ts

@@ -15,7 +15,7 @@ export class Role implements Directive {
     this.dynamic = this.roles.some((role) => role.includes('{'))
   }
 
-  public static async set (identity: Identity, discovery: Promise<Component>): Promise<void> {
+  public static async get (identity: Identity, discovery: Promise<Component>): Promise<string[]> {
     this.remote ??= await discovery
 
     const query: Query = {
@@ -23,21 +23,16 @@ export class Role implements Directive {
       limit: 1024
     }
 
-    identity.roles = await this.remote.invoke('list', { query })
+    return await this.remote.invoke('list', { query })
   }
 
-  public async authorize
-  (identity: Identity | null, _: unknown, parameters: Parameter[]): Promise<boolean> {
+  public async authorize (identity: Identity | null, _: unknown, parameters: Parameter[]): Promise<boolean> {
     if (identity === null)
       return false
 
-    await Role.set(identity, this.discovery)
+    identity.roles ??= await Role.get(identity, this.discovery)
 
-    if (identity.roles!.length === 0) // Role.set()
-
-      return false
-
-    return this.match(identity.roles!, parameters)
+    return this.match(identity.roles, parameters)
   }
 
   private match (roles: string[], parameters: Parameter[]): boolean {
@@ -58,7 +53,7 @@ export class Role implements Directive {
       const value = parameters.find((parameter) => parameter.name === key)?.value
 
       assert.ok(value !== undefined,
-        `Role '${role}' requires '${key}' route parameter.`)
+        `Role '${role}' requires '${key}' route parameter`)
 
       return value
     }))

package/source/directives/auth/Rule.ts

@@ -1,5 +1,5 @@
 import { type Parameter } from '../../RTD'
-import type { Input, Directive, Identity } from './types'
+import type { Context, Directive, Identity, Create } from './types'
 
 export class Rule implements Directive {
   private readonly directives: Directive[] = []
@@ -12,10 +12,9 @@ export class Rule implements Directive {
     }
   }
 
-  public async authorize
-  (identity: Identity | null, input: Input, parameters: Parameter[]): Promise<boolean> {
+  public async authorize (identity: Identity | null, context: Context, parameters: Parameter[]): Promise<boolean> {
     for (const directive of this.directives) {
-      const authorized = await directive.authorize(identity, input, parameters)
+      const authorized = await directive.authorize(identity, context, parameters)
 
       if (!authorized)
         return false
@@ -24,5 +23,3 @@ export class Rule implements Directive {
     return true
   }
 }
-
-type Create = (name: string, value: any, ...args: any[]) => Directive

package/source/directives/auth/Scheme.ts

@@ -1,5 +1,5 @@
 import * as http from '../../HTTP'
-import { type Directive, type Identity, type Input } from './types'
+import { type Directive, type Identity, type Context } from './types'
 import { split } from './split'
 
 export class Scheme implements Directive {
@@ -11,15 +11,15 @@ export class Scheme implements Directive {
     this.Scheme = scheme[0].toUpperCase() + scheme.substring(1)
   }
 
-  public authorize (_: Identity | null, input: Input): boolean {
-    if (input.request.headers.authorization === undefined)
+  public authorize (_: Identity | null, context: Context): boolean {
+    if (context.request.headers.authorization === undefined)
       return false
 
-    const [scheme] = split(input.request.headers.authorization)
+    const [scheme] = split(context.request.headers.authorization)
 
     if (scheme !== this.scheme)
       throw new http.Forbidden(this.Scheme +
-        ' authentication scheme is required to access this resource.')
+        ' authentication scheme is required to access this resource')
 
     return false
   }

package/source/directives/auth/create.ts

@@ -0,0 +1,11 @@
+import { newid } from '@toa.io/generic'
+import type { Identity } from './types'
+
+export function create (credentials?: string): Identity {
+  return {
+    id: newid(),
+    scheme: credentials?.split(' ')[0] ?? null,
+    refresh: false,
+    roles: []
+  }
+}

package/source/directives/auth/schemes.ts

@@ -1,9 +1,12 @@
-import { type Remote, type Scheme } from './types'
+import type { Remote, Scheme } from './types'
 
 export const PROVIDERS: Record<Scheme, Remote> = {
   basic: 'basic',
   token: 'tokens',
-  bearer: 'federation'
+  bearer: 'federation',
+  code: 'federation',
+  otp: 'otp'
 }
 
+export const INCEPTION: Remote[] = ['basic', 'federation']
 export const PRIMARY: Scheme = 'token'

package/source/directives/auth/split.ts

@@ -5,7 +5,7 @@ export function split (authorization: string): [Scheme, string] {
   const space = authorization.indexOf(' ')
 
   if (space === -1)
-    throw new http.Unauthorized('Malformed authorization header.')
+    throw new http.Unauthorized('Malformed authorization header')
 
   const Scheme = authorization.slice(0, space)
   const scheme = Scheme.toLowerCase() as Scheme

package/source/directives/auth/types.ts

@@ -5,21 +5,24 @@ import type * as http from '../../HTTP'
 import type * as io from '../../io'
 
 export interface Directive {
+  priority?: number
+
   authorize: (
     identity: Identity | null,
-    input: Input,
+    context: Context,
     parameters: Parameter[]
   ) => boolean | Promise<boolean>
 
-  reply?: (identity: Identity | null) => http.OutgoingMessage
+  reply?: (context: Context) => http.OutgoingMessage | null
 
-  settle?: (request: Input, response: http.OutgoingMessage) => Promise<void>
+  settle?: (context: Context, response: http.OutgoingMessage) => Promise<void>
 }
 
 export interface Identity {
   readonly id: string
-  scheme: string
   roles?: string[]
+  permissions?: Record<string, string[]>
+  scheme: string | null // null for transient identities
   refresh: boolean
 }
 
@@ -31,10 +34,12 @@ export interface Ban {
   banned: boolean
 }
 
-export type Input = io.Input & Extension
+export type Context = io.Input & Extension
 export type AuthenticationResult = Maybe<{ identity: Identity, refresh: boolean }>
 
-export type Scheme = 'basic' | 'token' | 'bearer'
-export type Remote = 'basic' | 'federation' | 'tokens' | 'roles' | 'bans'
+export type Scheme = 'basic' | 'token' | 'bearer' | 'code' | 'otp'
+export type Remote = 'basic' | 'federation' | 'tokens' | 'roles' | 'bans' | 'otp'
 export type Discovery = Record<Remote, Promise<Component>>
 export type Schemes = Record<Scheme, Component>
+
+export type Create = (name: string, value: any, ...args: any[]) => Directive

package/source/directives/cache/Cache.ts

@@ -1,19 +1,19 @@
 import { Control } from './Control'
 import { Exact } from './Exact'
-import type { Input, Output } from '../../io'
-import type { Directive } from './types'
+import type { Output } from '../../io'
+import type { AuthenticatedContext, Directive } from './types'
 import type { DirectiveFamily } from '../../RTD'
 import type * as http from '../../HTTP'
 
 export class Cache implements DirectiveFamily<Directive> {
   public readonly name: string = 'cache'
-  public readonly mandatory: boolean = false
+  public readonly mandatory: boolean = true
 
   public create (name: string, value: any): Directive {
     const Class = constructors[name]
 
     if (Class === undefined)
-      throw new Error(`Directive 'cache:${name}' is not implemented.`)
+      throw new Error(`Directive 'cache:${name}' is not implemented`)
 
     return new Class(value)
   }
@@ -22,10 +22,23 @@ export class Cache implements DirectiveFamily<Directive> {
     return null
   }
 
-  public async settle
-  (directives: Directive[], input: Input, response: http.OutgoingMessage): Promise<void> {
+  public async settle (directives: Directive[], context: AuthenticatedContext, response: http.OutgoingMessage): Promise<void> {
+    const method = context.request.method
+
+    if (method !== 'GET' && method !== 'HEAD')
+      return
+
+    const directive = directives[0]
+
     response.headers ??= new Headers()
-    directives[0]?.set(input, response.headers)
+
+    if (directive === undefined) {
+      if (context.identity !== null && !Control.disabled(response.headers)) {
+        response.headers.set('cache-control', 'private')
+        response.headers.append('vary', 'authorization')
+      }
+    } else
+      directive.set(context, response.headers)
   }
 }
 

package/source/directives/cache/Control.ts

@@ -3,25 +3,36 @@ import type { AuthenticatedContext, Directive } from './types'
 
 export class Control implements Directive {
   protected readonly value: string
-  private cache: string | null = null
+  private control: string | null = null
   private vary: boolean = false
 
   public constructor (value: string) {
     this.value = value
   }
 
+  public static disabled (headers: Headers): boolean {
+    const value = headers.get('cache-control')
+
+    if (value === null)
+      return false
+
+    const directives = mask(value)
+
+    return (directives & NO_STORE) === NO_STORE
+  }
+
   public set (context: AuthenticatedContext, headers: Headers): void {
     if (!['GET', 'HEAD', 'OPTIONS'].includes(context.request.method))
       return
 
-    this.cache ??= this.resolve(context)
+    this.control ??= this.resolve(context)
 
-    if (this.disabled(headers))
+    if (Control.disabled(headers))
       return
 
-    headers.append('cache-control', this.cache)
+    headers.set('cache-control', this.control)
 
-    if (this.vary !== null)
+    if (this.vary)
       headers.append('vary', 'authorization')
   }
 
@@ -45,17 +56,6 @@ export class Control implements Directive {
 
     return this.value
   }
-
-  private disabled (headers: Headers): boolean {
-    const value = headers.get('cache-control')
-
-    if (value === null)
-      return false
-
-    const directives = mask(value)
-
-    return (directives & NO_STORE) === NO_STORE
-  }
 }
 
 function mask (value: string): number {

package/source/directives/cors/CORS.ts

@@ -1,22 +1,24 @@
 import type { Input, Output } from '../../io'
 import type { Interceptor } from '../../Interception'
 
+/** What is allowed before any directive asks for more. */
+const REQUEST_HEADERS = [
+  'accept',
+  'authorization',
+  'content-type',
+  'if-match',
+  'if-none-match'
+]
+
 export class CORS implements Interceptor {
   public readonly name = 'cors'
 
-  private readonly requestHeaders = new Set<string>([
-    'accept',
-    'authorization',
-    'content-type',
-    'etag',
-    'if-match',
-    'if-none-match'
-  ])
+  private requestHeaders = new Set<string>(REQUEST_HEADERS)
 
   private readonly headers = new Headers({
-    'access-control-allow-methods': 'GET, POST, PUT, PATCH, DELETE',
+    'access-control-allow-methods': 'GET, POST, PUT, PATCH, DELETE, LOCK, UNLOCK',
     'access-control-allow-credentials': 'true',
-    'access-control-allow-headers': Array.from(this.requestHeaders).join(', '),
+    'access-control-allow-headers': this.allowedHeaders(),
     'access-control-max-age': '3600',
     'cache-control': 'max-age=3600',
     vary: 'origin'
@@ -25,17 +27,18 @@ export class CORS implements Interceptor {
   public intercept (input: Input): Output {
     const origin = input.request.headers.origin
 
-    if (origin === undefined)
-      return null
-
-    if (input.request.method === 'OPTIONS')
+    if (origin !== undefined && input.request.method === 'OPTIONS')
       return this.preflightResponse(origin)
 
     input.pipelines.response.push((output) => {
       output.headers ??= new Headers()
-      output.headers.set('access-control-allow-origin', origin)
-      output.headers.set('access-control-expose-headers',
-        'authorization, content-type, content-length, etag')
+
+      if (origin !== undefined) {
+        output.headers.set('access-control-allow-origin', origin)
+        output.headers.set('access-control-allow-credentials', 'true')
+        output.headers.set('access-control-expose-headers',
+          'authorization, content-type, content-length, date, etag, last-modified')
+      }
 
       const method = input.request.method
 
@@ -46,9 +49,23 @@ export class CORS implements Interceptor {
     return null
   }
 
+  public reset (): void {
+    this.requestHeaders = new Set(REQUEST_HEADERS)
+    this.headers.set('access-control-allow-headers', this.allowedHeaders())
+  }
+
   public allow (header: string): void {
     this.requestHeaders.add(header.toLowerCase())
-    this.headers.set('access-control-allow-headers', Array.from(this.requestHeaders).join(', '))
+    this.headers.set('access-control-allow-headers', this.allowedHeaders())
+  }
+
+  /**
+   * Sorted, because the set is filled as branches merge and their order is not
+   * fixed — an unsorted value would differ between otherwise identical processes,
+   * and between one restart and the next.
+   */
+  private allowedHeaders (): string {
+    return Array.from(this.requestHeaders).sort().join(', ')
   }
 
   private preflightResponse (origin: string): Output {

package/source/directives/dev/Development.ts

@@ -1,5 +1,7 @@
 import { Stub } from './Stub'
 import { Throw } from './Throw'
+import { Sleep } from './Sleep'
+import { Faulty } from './Faulty'
 import { type Directive } from './types'
 import type { Input, Output } from '../../io'
 import type { DirectiveFamily } from '../../RTD'
@@ -12,24 +14,29 @@ export class Development implements DirectiveFamily<Directive> {
     const Class = constructors[name]
 
     if (Class === undefined)
-      throw new Error(`Directive 'dev:${name}' is not implemented.`)
+      throw new Error(`Directive 'dev:${name}' is not implemented`)
 
     return new Class(value)
   }
 
-  public preflight (directives: Directive[], input: Input): Output {
+  public async preflight (directives: Directive[], input: Input): Promise<Output> {
+    let output = null
+
     for (const directive of directives) {
-      const output = directive.apply(input)
+      const out = await directive.apply(input)
 
-      if (output !== null)
-        return output
+      if (out !== null)
+        if (output !== null) throw new Error('`dev` directives ambiguous output')
+        else output = out
     }
 
-    return null
+    return output
   }
 }
 
 const constructors: Record<string, new (value: any) => Directive> = {
   stub: Stub,
-  throw: Throw
+  throw: Throw,
+  sleep: Sleep,
+  faulty: Faulty
 }

package/source/directives/dev/Faulty.ts

@@ -0,0 +1,26 @@
+import assert from 'node:assert'
+import { ServiceUnavailable } from '../../HTTP'
+import { cors } from '../cors'
+import type { Output } from '../../io'
+import type { Directive } from './types'
+
+export class Faulty implements Directive {
+  private static readonly warned = false
+  private readonly probability: number
+
+  public constructor (probability: number) {
+    assert.ok(typeof probability === 'number', '`dev:faulty` directive value must be a number')
+    assert.ok(probability > 0 && probability <= 1, '`dev:faulty` directive value must be in the range (0, 1]')
+
+    this.probability = probability
+
+    cors.allow('faulty')
+  }
+
+  public async apply (): Promise<Output> {
+    if (Math.random() > this.probability)
+      return null
+
+    throw new ServiceUnavailable()
+  }
+}