@toa.io/extensions.exposition 1.0.0-alpha.18 → 1.0.0-alpha.180

package/components/identity.tokens/source/decrypt.test.ts

@@ -1,59 +1,74 @@
 import { generate } from 'randomstring'
 import { Effect as Encrypt } from './encrypt'
-import { computation as decrypt } from './decrypt'
-import { type Configuration, type Context, type Identity } from './types'
+import { Computation as Decrypt } from './decrypt'
+import { type Configuration, type Context, type Identity } from './lib'
 
 let configuration: Configuration
 let context: Context
 let encrypt: Encrypt
+let decrypt: Decrypt
+
+const remote = { identity: { keys: null } }
+const authority = generate()
 
 beforeEach(() => {
   configuration = {
-    key0: 'k3.local.m28p8SrbS467t-2IUjQuSOqmjvi24TbXhyjAW_dOrog',
-    key1: 'k3.local.-498jfWenrZH-Dqw3-zQJih_hKzDgBgUMfe37OCqSOA',
+    keys: {
+      key0: 'k3.local.m28p8SrbS467t-2IUjQuSOqmjvi24TbXhyjAW_dOrog',
+      key1: 'k3.local.-498jfWenrZH-Dqw3-zQJih_hKzDgBgUMfe37OCqSOA'
+    },
     lifetime: 1000,
-    refresh: 500
+    refresh: 500,
+    cache: {
+      max: 1024,
+      ttl: 600
+    }
   }
 
-  context = { configuration } as unknown as Context
+  context = { configuration, remote, logs: { debug: () => undefined } } as unknown as Context
 
   encrypt = new Encrypt()
   encrypt.mount(context)
+
+  decrypt = new Decrypt()
+  decrypt.mount(context)
 })
 
 it('should decrypt', async () => {
-  const identity: Identity = { id: generate() }
+  const identity: Identity = { id: generate(), roles: [] }
   const lifetime = 100
 
-  const reply = await encrypt.execute({ identity, lifetime })
+  const reply = await encrypt.execute({ authority, identity, lifetime })
 
-  if (reply === undefined)
-    throw new Error('?')
+  if (reply instanceof Error)
+    throw reply
 
-  const decrypted = await decrypt(reply, context)
+  const decrypted = await decrypt.execute(reply)
 
-  expect(decrypted).toMatchObject({ identity, refresh: false })
+  expect(decrypted).toMatchObject({ iss: authority, identity, refresh: false })
 })
 
 it('should decrypt with key1', async () => {
   const k1context = {
     configuration: {
-      key0: configuration.key1
+      keys: {
+        key1: configuration.keys.key1
+      }
     }
   } as unknown as Context
 
   encrypt = new Encrypt()
   encrypt.mount(k1context)
 
-  const identity: Identity = { id: generate() }
+  const identity: Identity = { id: generate(), roles: [] }
   const lifetime = 100
 
-  const encrypted = await encrypt.execute({ identity, lifetime })
+  const encrypted = await encrypt.execute({ authority, identity, lifetime })
 
-  if (encrypted === undefined)
-    throw new Error('?')
+  if (encrypted instanceof Error)
+    throw encrypted
 
-  const decrypted = await decrypt(encrypted, context)
+  const decrypted = await decrypt.execute(encrypted)
 
   expect(decrypted).toMatchObject({ identity, refresh: true })
 })

package/components/identity.tokens/source/decrypt.ts

@@ -1,33 +1,108 @@
 import { V3 } from 'paseto'
-import { type Maybe } from '@toa.io/types'
-import { type Context, type Claim, type DecryptOutput } from './types'
+import { Err } from 'error-value'
+import { LRUCache } from 'lru-cache'
+import type { Maybe, Operation } from '@toa.io/types'
+import type { Context, Claims, DecryptOutput } from './lib'
 
-export async function computation (token: string, context: Context):
-Promise<Maybe<DecryptOutput>> {
-  let refresh = false
-  let claim = await decrypt(token, context.configuration.key0)
+export class Computation implements Operation {
+  private keys: Record<string, Key> = {}
+  private cache!: LRUCache<string, KeyEntry>
+  private latest!: string
+  private remote!: Context['remote']['identity']['keys']
+  private logs!: Context['logs']
 
-  if (claim === null && context.configuration.key1 !== undefined) {
-    refresh = true
-    claim = await decrypt(token, context.configuration.key1)
+  public mount (context: Context): void {
+    this.latest = Object.keys(context.configuration.keys)[0]
+    this.remote = context.remote.identity.keys
+    this.cache = new LRUCache<string, KeyEntry>(context.configuration.cache)
+    this.logs = context.logs
+
+    for (const [kid, key] of Object.entries(context.configuration.keys))
+      this.keys[kid] = { key }
   }
 
-  if (claim === null)
-    return ERR_INVALID_TOKEN
-  else return {
-    identity: claim.identity,
-    iat: claim.iat,
-    exp: claim.exp,
-    refresh
+  public async execute (token: string): Promise<Maybe<DecryptOutput>> {
+    const kid = this.kid(token)
+
+    if (kid instanceof Error)
+      return kid
+
+    const key = await this.key(kid)
+
+    if (key instanceof Error)
+      return key
+
+    const claims = await decrypt(token, key.key)
+
+    if (claims instanceof Error)
+      return claims
+
+    this.logs.debug('Token claims', claims)
+
+    if (key.identity !== undefined && claims.identity.id !== key.identity)
+      return ERR_FORGED_KEY
+
+    return {
+      iss: claims.iss,
+      iat: claims.iat,
+      exp: claims.exp,
+      identity: claims.identity,
+      refresh: kid !== this.latest && key.identity === undefined
+    }
+  }
+
+  private kid (token: string): Maybe<string> {
+    const [, , , footer] = token.split('.')
+
+    if (footer === undefined)
+      return ERR_INVALID_TOKEN
+
+    try {
+      const json = Buffer.from(footer, 'base64url').toString('utf-8')
+      const { kid } = JSON.parse(json)
+
+      if (typeof kid !== 'string')
+        return ERR_INVALID_TOKEN
+
+      return kid
+    } catch {
+      return ERR_INVALID_TOKEN
+    }
+  }
+
+  private async key (kid: string): Promise<Maybe<Key>> {
+    if (kid in this.keys)
+      return this.keys[kid]
+
+    if (!this.cache.has(kid)) {
+      const value = await this.remote.observe({ query: { id: kid } })
+
+      this.cache.set(kid, { value })
+    }
+
+    const entry = this.cache.get(kid)
+
+    return entry?.value ?? ERR_INVALID_KEY
   }
 }
 
-async function decrypt (token: string, key: string): Promise<Claim | null> {
+async function decrypt (token: string, key: string): Promise<Maybe<Claims>> {
   try {
-    return await V3.decrypt<Claim>(token, key)
+    return await V3.decrypt<Claims>(token, key)
   } catch {
-    return null
+    return ERR_INVALID_TOKEN
   }
 }
 
-const ERR_INVALID_TOKEN = new Error('INVALID_TOKEN')
+interface Key {
+  key: string
+  identity?: string
+}
+
+interface KeyEntry {
+  value: Key | null
+}
+
+const ERR_INVALID_TOKEN = new Err('INVALID_TOKEN')
+const ERR_INVALID_KEY = new Err('INVALID_KEY')
+const ERR_FORGED_KEY = new Err('FORGED_KEY')

package/components/identity.tokens/source/encrypt.test.ts

@@ -2,53 +2,91 @@ import assert from 'node:assert'
 import { generate } from 'randomstring'
 import { timeout } from '@toa.io/generic'
 import { Effect as Encrypt } from './encrypt'
-import { computation as decrypt } from './decrypt'
-import { type Context, type Identity } from './types'
+import { Computation as Decrypt } from './decrypt'
+import { type Context, type Identity } from './lib'
 
 let encrypt: Encrypt
+let decrypt: Decrypt
 
-const context: Context = {} as unknown as Context
+const context: Context = {
+  remote: { identity: { keys: null } },
+  logs: { debug: () => undefined }
+} as unknown as Context
+
+const authority = generate()
 
 beforeEach(() => {
   context.configuration = {
-    key0: 'k3.local.m28p8SrbS467t-2IUjQuSOqmjvi24TbXhyjAW_dOrog',
-    lifetime: 1000,
-    refresh: 2
+    keys: {
+      key0: 'k3.local.m28p8SrbS467t-2IUjQuSOqmjvi24TbXhyjAW_dOrog'
+    },
+    lifetime: 1,
+    refresh: 2,
+    cache: {
+      max: 1024,
+      ttl: 3
+    }
   }
 
   encrypt = new Encrypt()
   encrypt.mount(context)
+
+  decrypt = new Decrypt()
+  decrypt.mount(context)
+})
+
+it('should encrypt with configured lifetime by default', async () => {
+  const identity: Identity = { id: generate(), roles: [] }
+
+  const encrypted = await encrypt.execute({
+    authority,
+    identity
+  })
+
+  if (encrypted instanceof Error)
+    throw encrypted
+
+  await expect(decrypt.execute(encrypted)).resolves.toMatchObject({ iss: authority, identity })
+
+  await timeout(context.configuration.lifetime * 1000)
+
+  await expect(decrypt.execute(encrypted)).resolves.toMatchObject({ code: 'INVALID_TOKEN' })
 })
 
 it('should encrypt with given lifetime', async () => {
-  const identity: Identity = { id: generate() }
+  const identity: Identity = { id: generate(), roles: [] }
   const lifetime = 0.1
 
   const encrypted = await encrypt.execute({
+    authority,
     identity,
     lifetime
   })
 
-  if (encrypted === undefined)
-    throw new Error('?')
+  if (encrypted instanceof Error)
+    throw encrypted
 
-  await expect(decrypt(encrypted, context)).resolves.toMatchObject({ identity })
+  await expect(decrypt.execute(encrypted)).resolves.toMatchObject({ iss: authority, identity })
 
   await timeout(lifetime * 1000)
 
-  await expect(decrypt(encrypted, context)).resolves.toMatchObject({ message: 'INVALID_TOKEN' })
+  await expect(decrypt.execute(encrypted)).resolves.toMatchObject({ code: 'INVALID_TOKEN' })
 })
 
 it('should encrypt without lifetime INSECURE', async () => {
-  const identity: Identity = { id: generate() }
+  const identity: Identity = { id: generate(), roles: [] }
   const lifetime = 0
 
   const encrypted = await encrypt.execute({
+    authority,
     identity,
     lifetime
   })
 
-  const decrypted = await decrypt(encrypted, context)
+  if (encrypted instanceof Error)
+    throw encrypted
+
+  const decrypted = await decrypt.execute(encrypted)
 
   assert.ok(!(decrypted instanceof Error))
 

package/components/identity.tokens/source/encrypt.ts

@@ -1,28 +1,53 @@
 import { V3 } from 'paseto'
-import { type Operation } from '@toa.io/types'
-import { type Claim, type Context, type EncryptInput } from './types'
+import { Err } from 'error-value'
+import type { Operation, Maybe } from '@toa.io/types'
+import type { Identity, Claims, Context, EncryptInput, Key } from './lib'
 
 export class Effect implements Operation {
-  private key: string = ''
-  private lifetime: number = 0
+  private key!: Pick<Key, 'id' | 'key'>
+  private lifetime!: number
 
   public mount (context: Context): void {
-    this.key = context.configuration.key0
+    const [id, secret] = Object.entries(context.configuration.keys)[0]
+
+    this.key = { id, key: secret }
     this.lifetime = context.configuration.lifetime * 1000
   }
 
-  public async execute (input: EncryptInput): Promise<string> {
-    const lifetime = input.lifetime === undefined ? this.lifetime : input.lifetime * 1000
+  public async execute (input: EncryptInput): Promise<Maybe<string>> {
+    if (input.scopes?.some((scope) => !within(scope, input.identity.roles)) === true)
+      return ERR_INACCESSIBLE_SCOPE
+
+    const lifetime = input.lifetime === undefined ? this.lifetime : (input.lifetime * 1000)
 
     const exp = lifetime === 0
       ? undefined
       : new Date(Date.now() + lifetime).toISOString()
 
-    const payload: Partial<Claim> = {
-      identity: input.identity,
-      exp
+    const identity: Identity = {
+      id: input.identity.id,
+      roles: input.scopes ?? input.identity.roles
+    }
+
+    if (input.permissions !== undefined)
+      identity.permissions = input.permissions
+
+    const payload: Partial<Claims> = {
+      identity,
+      iss: input.authority
     }
 
-    return await V3.encrypt(payload, this.key)
+    if (exp !== undefined)
+      payload.exp = exp
+
+    const key = input.key ?? this.key
+
+    return await V3.encrypt(payload, key.key, { footer: { kid: key.id } })
   }
 }
+
+function within (scope: string, roles: string[]): boolean {
+  return roles.some((role) => role === scope || scope.startsWith(role + ':'))
+}
+
+const ERR_INACCESSIBLE_SCOPE = new Err('INACCESSIBLE_SCOPE')

package/components/identity.tokens/source/issue.ts

@@ -0,0 +1,82 @@
+import type { Maybe, Operation } from '@toa.io/types'
+import type { Context, Identity } from './lib'
+
+export class Effect implements Operation {
+  private keys!: Context['remote']['identity']['keys']
+  private roles!: Context['remote']['identity']['roles']
+  private encrypt!: Context['local']['encrypt']
+  private lifetime!: number
+
+  public mount (context: Context): void {
+    this.keys = context.remote.identity.keys
+    this.roles = context.remote.identity.roles
+    this.encrypt = context.local.encrypt
+    this.lifetime = context.configuration.lifetime * 1000
+  }
+
+  public async execute (input: Input): Promise<Maybe<Output>> {
+    const lifetime = input.lifetime ?? this.lifetime
+
+    const expires = lifetime === 0
+      ? undefined
+      : new Date(Date.now() + lifetime * 1000).getTime()
+
+    const key = await this.keys.create({
+      input: {
+        identity: input.identity,
+        label: input.label,
+        expires
+      }
+    })
+
+    const roles = await this.roles.list({
+      query: {
+        criteria: `identity==${input.identity}`,
+        limit: 1024
+      }
+    })
+
+    const identity: Identity = {
+      id: input.identity,
+      roles
+    }
+
+    const { authority, scopes, permissions } = input
+
+    const token = await this.encrypt({
+      input: {
+        authority,
+        identity,
+        lifetime,
+        scopes,
+        permissions,
+        key
+      }
+    })
+
+    if (token instanceof Error)
+      return token
+
+    return {
+      kid: key.id,
+      // technically, the token expires some time later
+      ...(expires !== undefined && { exp: expires }),
+      token
+    }
+  }
+}
+
+interface Input {
+  authority: string
+  identity: string
+  label: string
+  lifetime?: number
+  scopes?: string[]
+  permissions?: Record<string, string[]>
+}
+
+interface Output {
+  kid: string
+  exp?: number
+  token: string
+}

package/components/identity.tokens/source/lib/index.ts

@@ -0,0 +1,2 @@
+export * from './pad'
+export * from './types'

package/components/identity.tokens/source/lib/pad.ts

@@ -0,0 +1 @@
+export const PAD = 'v3.local.'

package/components/identity.tokens/source/lib/paseto.test.ts

@@ -0,0 +1,16 @@
+import { V3 } from 'paseto'
+
+it('should be ok', async () => {
+  const payload = { iss: 'test', sub: 'me' }
+  const key = await V3.generateKey('local', { format: 'paserk' })
+  const token = await V3.encrypt(payload, key, { footer: 'key0' })
+  const [, , , footer] = token.split('.')
+  const kid = Buffer.from(footer, 'base64url').toString('utf-8')
+
+  console.log(footer, kid)
+  console.log(key)
+
+  const decrypted = await V3.decrypt(token, key)
+
+  console.log(decrypted)
+})

package/components/identity.tokens/source/lib/types.ts

@@ -0,0 +1,86 @@
+import type { Call, Maybe, Observation, telemetry } from '@toa.io/types'
+
+export interface Context {
+  local: {
+    observe: Observation<Entity>
+    encrypt: Call<Maybe<string>, EncryptInput>
+    decrypt: Call<Maybe<DecryptOutput>, string>
+  }
+  remote: {
+    identity: {
+      keys: {
+        observe: Observation<CustomKey>
+        create: Call<Key>
+      }
+      roles: {
+        list: Call<string[]>
+      }
+    }
+  }
+  configuration: Configuration
+  logs: telemetry.Logs
+}
+
+export interface Configuration {
+  readonly keys: Record<string, string>
+  readonly lifetime: number
+  readonly refresh: number
+  readonly cache: {
+    max: number
+    ttl: number
+  }
+}
+
+export interface Entity {
+  revokedAt?: number
+}
+
+export interface Identity extends Record<string, any> {
+  id: string
+  roles: string[]
+  permissions?: Record<string, string[]>
+}
+
+export interface AuthenticateInput {
+  authority: string
+  credentials: string
+}
+
+export interface AuthenticateOutput {
+  identity: Identity
+  refresh: boolean
+}
+
+export interface EncryptInput {
+  authority: string
+  identity: Identity
+  lifetime?: number
+  scopes?: string[]
+  permissions?: Record<string, string[]>
+  key?: Key
+}
+
+export interface DecryptOutput {
+  iss: string
+  iat: string
+  exp?: string
+  identity: Identity
+  refresh: boolean
+}
+
+export interface Claims {
+  identity: Identity
+  iss: string
+  iat: string
+  exp?: string
+}
+
+export interface Key {
+  id: string
+  key: string
+  label: string
+}
+
+export interface CustomKey extends Key {
+  identity: string
+}

package/components/identity.tokens/source/revoke.ts

@@ -1,5 +1,5 @@
-import { type Entity } from './types'
+import type { Entity } from './lib'
 
-export function transition (_: never, object: Entity): void {
+export function transition (_: unknown, object: Entity): void {
   object.revokedAt = Date.now()
 }

package/components/octets.storage/manifest.toa.yaml

@@ -4,24 +4,26 @@ name: storage
 storages: ~
 
 operations:
-  store:
+  put:
     bindings: ~
     input:
       storage*: string
       request*: ~
+      location: string
       accept: string
-      meta: <string>
-  fetch: &simple
+      limit: number
+      trust: ~ # array of strings or regular expressions
+    errors:
+      - LOCATION_UNTRUSTED
+      - LOCATION_LENGTH
+      - LOCATION_UNAVAILABLE
+      - INVALID_ID
+  get: &simple
     bindings: ~
     input:
       storage*: string
       path*: string
-  get: *simple
-  list: *simple
+      range: string
+      agent: string
+  head: *simple
   delete: *simple
-  permute:
-    bindings: ~
-    input:
-      storage*: string
-      path*: string
-      list*: [string]

package/components/octets.storage/operations/get.js

@@ -1,7 +1,7 @@
 'use strict'
 
-function get (input, context) {
-  return context.storages[input.storage].get(input.path)
+async function get (input, context) {
+  return await context.storages[input.storage].get(input.path, { range: input.range, agent: input.agent })
 }
 
-exports.computation = get
+exports.effect = get

package/components/octets.storage/operations/head.js

@@ -0,0 +1,7 @@
+'use strict'
+
+async function head (input, context) {
+  return await context.storages[input.storage].head(input.path)
+}
+
+exports.computation = head