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

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

@@ -1,61 +1,135 @@
 import { generate } from 'randomstring'
+import { V3 } from 'paseto'
 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: { observe: jest.fn(async () => null) } } }
 const authority = generate()
 
 beforeEach(() => {
   configuration = {
-    key0: 'k3.local.m28p8SrbS467t-2IUjQuSOqmjvi24TbXhyjAW_dOrog',
-    key1: 'k3.local.-498jfWenrZH-Dqw3-zQJih_hKzDgBgUMfe37OCqSOA',
+    keys: [
+      { id: 'key0', key: 'sTxL6qVOadKkUJwh3FveU53XgTEo3Sdfg7k2FfiIKfs' },
+      { id: 'key1', key: '5I0iSKw3yfBkQ4AXfA8eR-tWR0Q1dpn4x3bPrPzHkP0' },
+      { id: 'legacy0', key: 'k3.local.m28p8SrbS467t-2IUjQuSOqmjvi24TbXhyjAW_dOrog', format: 'paseto' },
+      { id: 'legacy1', key: 'k3.local.-498jfWenrZH-Dqw3-zQJih_hKzDgBgUMfe37OCqSOA', format: 'paseto' }
+    ],
     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({ 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({ authority, identity, refresh: false })
+  expect(decrypted).toMatchObject({ iss: authority, identity, refresh: false })
 })
 
 it('should decrypt with key1', async () => {
   const k1context = {
     configuration: {
-      key0: configuration.key1
+      keys: [configuration.keys[1]]
     }
   } 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({ 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 })
 })
+
+it('should decrypt legacy PASETO and require refresh', async () => {
+  const identity: Identity = { id: generate(), roles: [] }
+
+  const token = await V3.encrypt({ iss: authority, identity }, configuration.keys[2].key, {
+    footer: { kid: 'legacy0' }
+  })
+
+  await expect(decrypt.execute(token)).resolves.toMatchObject({
+    iss: authority,
+    identity,
+    refresh: true
+  })
+})
+
+it('should separate JWE and PASETO keys with the same id by format', async () => {
+  configuration.keys[2].id = 'key0'
+
+  decrypt = new Decrypt()
+  decrypt.mount(context)
+
+  const identity: Identity = { id: generate(), roles: [] }
+
+  const token = await V3.encrypt({ iss: authority, identity }, configuration.keys[2].key, {
+    footer: { kid: 'key0' }
+  })
+
+  await expect(decrypt.execute(token)).resolves.toMatchObject({ identity, refresh: true })
+})
+
+it('should reject a tampered JWE', async () => {
+  const token = await encrypt.execute({
+    authority,
+    identity: { id: generate(), roles: [] }
+  })
+
+  if (token instanceof Error)
+    throw token
+
+  const parts = token.split('.')
+
+  parts[3] = (parts[3].startsWith('A') ? 'B' : 'A') + parts[3].slice(1)
+
+  const tampered = parts.join('.')
+
+  await expect(decrypt.execute(tampered)).resolves.toMatchObject({ code: 'INVALID_TOKEN' })
+})
+
+it('should reject JWE with an unknown key', async () => {
+  const token = await encrypt.execute({
+    authority,
+    identity: { id: generate(), roles: [] },
+    key: { id: 'missing', key: configuration.keys[0].key, label: 'missing' }
+  })
+
+  if (token instanceof Error)
+    throw token
+
+  await expect(decrypt.execute(token)).resolves.toMatchObject({ code: 'INVALID_KEY' })
+})

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

@@ -1,34 +1,166 @@
 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 { jweKey } from './lib'
+import { load } from './lib/jose'
+import type { Maybe, Operation } from '@toa.io/types'
+import type { Context, Claims, DecryptOutput, JWEClaims } 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 readonly keys: Record<string, Key> = {}
+  private readonly legacy: 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 {
+    const latest = context.configuration.keys.find(({ format }) => format !== 'paseto')
+
+    if (latest === undefined)
+      throw new TypeError('At least one JWE key must be configured')
+
+    this.latest = latest.id
+    this.remote = context.remote.identity.keys
+    this.cache = new LRUCache<string, KeyEntry>(context.configuration.cache)
+    this.logs = context.logs
+
+    for (const { id, key, format } of context.configuration.keys) {
+      const branch = format === 'paseto' ? this.legacy : this.keys
+
+      branch[id] = { key }
+    }
   }
 
-  if (claim === null)
-    return ERR_INVALID_TOKEN
-  else
+  public async execute (token: string): Promise<Maybe<DecryptOutput>> {
+    const legacy = token.startsWith('v3.local.')
+    const kid = legacy ? this.pasetoKid(token) : await this.jweKid(token)
+
+    if (kid instanceof Error)
+      return kid
+
+    const key = await this.key(kid, legacy)
+
+    if (key instanceof Error)
+      return key
+
+    const claims = legacy
+      ? await decryptPaseto(token, key.key)
+      : await decryptJWE(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 {
-      authority: claim.aud,
-      identity: claim.identity,
-      iat: claim.iat,
-      exp: claim.exp,
-      refresh
+      iss: claims.iss,
+      iat: claims.iat,
+      exp: claims.exp,
+      identity: claims.identity,
+      refresh: legacy || (kid !== this.latest && key.identity === undefined)
+    }
+  }
+
+  private pasetoKid (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 jweKid (token: string): Promise<Maybe<string>> {
+    try {
+      const { decodeProtectedHeader } = await load()
+      const header = decodeProtectedHeader(token)
+
+      if (header.alg !== 'dir' || header.enc !== 'A256GCM' || header.typ !== 'JWT' ||
+        typeof header.kid !== 'string')
+        return ERR_INVALID_TOKEN
+
+      return header.kid
+    } catch {
+      return ERR_INVALID_TOKEN
     }
+  }
+
+  private async key (kid: string, legacy: boolean): Promise<Maybe<Key>> {
+    const configured = legacy ? this.legacy : this.keys
+
+    if (kid in configured)
+      return configured[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 decryptPaseto (token: string, key: string): Promise<Maybe<Claims>> {
+  try {
+    return await V3.decrypt<Claims>(token, key)
+  } catch {
+    return ERR_INVALID_TOKEN
+  }
 }
 
-async function decrypt (token: string, key: string): Promise<Claim | null> {
+async function decryptJWE (token: string, key: string): Promise<Maybe<Claims>> {
   try {
-    return await V3.decrypt<Claim>(token, key)
+    const { jwtDecrypt } = await load()
+
+    const { payload } = await jwtDecrypt<JWEClaims>(token, jweKey(key), {
+      keyManagementAlgorithms: ['dir'],
+      contentEncryptionAlgorithms: ['A256GCM']
+    })
+
+    if (typeof payload.iss !== 'string' || typeof payload.iat !== 'number' ||
+      typeof payload.identity !== 'object' || payload.identity === null)
+      return ERR_INVALID_TOKEN
+
+    if (payload.exp !== undefined && payload.exp * 1000 <= Date.now())
+      return ERR_INVALID_TOKEN
+
+    return {
+      iss: payload.iss,
+      iat: new Date(payload.iat * 1000).toISOString(),
+      ...(payload.exp === undefined ? {} : { exp: new Date(payload.exp * 1000).toISOString() }),
+      identity: payload.identity
+    }
   } 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,27 +2,86 @@ 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 = {
+  remote: { identity: { keys: null } },
+  logs: { debug: () => undefined }
+} as unknown as Context
 
-const context: Context = {} as unknown as Context
 const authority = generate()
 
 beforeEach(() => {
   context.configuration = {
-    key0: 'k3.local.m28p8SrbS467t-2IUjQuSOqmjvi24TbXhyjAW_dOrog',
-    lifetime: 1000,
-    refresh: 2
+    keys: [
+      { id: 'key0', key: 'sTxL6qVOadKkUJwh3FveU53XgTEo3Sdfg7k2FfiIKfs' },
+      { id: 'legacy0', key: 'k3.local.m28p8SrbS467t-2IUjQuSOqmjvi24TbXhyjAW_dOrog', format: 'paseto' }
+    ],
+    lifetime: 1,
+    refresh: 2,
+    cache: {
+      max: 1024,
+      ttl: 3
+    }
   }
 
   encrypt = new Encrypt()
   encrypt.mount(context)
+
+  decrypt = new Decrypt()
+  decrypt.mount(context)
+})
+
+it('should use the first encryption key as active and expose its id as kid', async () => {
+  context.configuration.keys.unshift({
+    id: 'legacy-first',
+    key: 'k3.local.m28p8SrbS467t-2IUjQuSOqmjvi24TbXhyjAW_dOrog',
+    format: 'paseto'
+  })
+  context.configuration.keys.push({
+    id: 'key1',
+    key: '5I0iSKw3yfBkQ4AXfA8eR-tWR0Q1dpn4x3bPrPzHkP0'
+  })
+
+  encrypt.mount(context)
+
+  const encrypted = await encrypt.execute({
+    authority,
+    identity: { id: generate(), roles: [] }
+  })
+
+  if (encrypted instanceof Error)
+    throw encrypted
+
+  const header = JSON.parse(Buffer.from(encrypted.split('.')[0], 'base64url').toString())
+
+  expect(header).toMatchObject({ kid: 'key0', alg: 'dir', enc: 'A256GCM' })
+})
+
+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({
@@ -31,18 +90,18 @@ it('should encrypt with given lifetime', async () => {
     lifetime
   })
 
-  if (encrypted === undefined)
-    throw new Error('?')
+  if (encrypted instanceof Error)
+    throw encrypted
 
-  await expect(decrypt(encrypted, context)).resolves.toMatchObject({ authority, 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({
@@ -51,7 +110,10 @@ it('should encrypt without lifetime INSECURE', async () => {
     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,29 +1,55 @@
-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 { jweKey } from './lib'
+import { load } from './lib/jose'
+import type { Operation, Maybe } from '@toa.io/types'
+import type { Identity, 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 key = context.configuration.keys.find(({ format }) => format !== 'paseto')
+
+    if (key === undefined)
+      throw new TypeError('At least one JWE key must be configured')
+
+    this.key = key
     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>> {
+    const { EncryptJWT } = await load()
+
+    if (input.scopes?.some((scope) => !within(scope, input.identity.roles)) === true)
+      return ERR_INACCESSIBLE_SCOPE
 
-    const exp = lifetime === 0
-      ? undefined
-      : new Date(Date.now() + lifetime).toISOString()
+    const lifetime = input.lifetime === undefined ? this.lifetime : (input.lifetime * 1000)
 
-    const payload: Partial<Claim> = {
-      identity: input.identity,
-      aud: input.authority,
-      exp
+    const identity: Identity = {
+      id: input.identity.id,
+      roles: input.scopes ?? input.identity.roles
     }
 
-    return await V3.encrypt(payload, this.key)
+    if (input.permissions !== undefined)
+      identity.permissions = input.permissions
+
+    const key = input.key ?? this.key
+
+    let token = new EncryptJWT({ identity })
+      .setProtectedHeader({ alg: 'dir', enc: 'A256GCM', typ: 'JWT', kid: key.id })
+      .setIssuer(input.authority)
+      .setIssuedAt(Date.now() / 1000)
+
+    if (lifetime !== 0)
+      token = token.setExpirationTime((Date.now() + lifetime) / 1000)
+
+    return await token.encrypt(jweKey(key.key))
   }
 }
+
+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,3 @@
+export * from './pad'
+export * from './types'
+export { jweKey } from './key'

package/components/identity.tokens/source/lib/jose.d.ts

@@ -0,0 +1 @@
+export function load (): Promise<typeof import('jose')>

package/components/identity.tokens/source/lib/jose.js

@@ -0,0 +1,5 @@
+'use strict'
+
+const load = async () => await import('jose')
+
+exports.load = load

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

@@ -0,0 +1,8 @@
+export function jweKey (value: string): Uint8Array {
+  const key = Buffer.from(value, 'base64url')
+
+  if (key.length !== 32 || key.toString('base64url') !== value)
+    throw new TypeError('JWE key must be a base64url-encoded 256-bit secret')
+
+  return new Uint8Array(key)
+}

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)
+})