@evanp/activitypub-bot 0.28.7 → 0.29.0

package/lib/activitystreams.js

@@ -69,4 +69,15 @@ as2.registerContext('https://purl.archive.org/socialweb/thread/1.0', {
   }
 })
 
+as2.registerContext('https://purl.archive.org/socialweb/webfinger', {
+  '@context': {
+    wf: 'https://purl.archive.org/socialweb/webfinger#',
+    xsd: 'http://www.w3.org/2001/XMLSchema#',
+    webfinger: {
+      '@id': 'wf:webfinger',
+      '@type': 'xsd:string'
+    }
+  }
+})
+
 export default as2

package/lib/routes/server.js

@@ -13,14 +13,19 @@ router.get('/actor', async (req, res) => {
   const homepage = `${req.protocol}://${req.get('host')}/`
   const { formatter, keyStorage } = req.app.locals
   const publicKeyPem = await keyStorage.getPublicKey(null)
+  const acct = formatter.acct()
+  const webfinger = acct.slice(5)
   const server = await as2.import({
     '@context': [
       'https://www.w3.org/ns/activitystreams',
-      'https://w3id.org/security/v1'
+      'https://w3id.org/security/v1',
+      'https://purl.archive.org/socialweb/webfinger'
     ],
     id: formatter.format({ server: true }),
     type: 'Service',
     to: 'as:Public',
+    alsoKnownAs: acct,
+    webfinger,
     publicKey: {
       publicKeyPem,
       id: formatter.format({ server: true, type: 'publickey' }),

package/lib/routes/user.js

@@ -13,13 +13,18 @@ router.get('/user/:username', async (req, res, next) => {
     return next(createHttpError(404, `User ${username} not found`))
   }
   const publicKeyPem = await keyStorage.getPublicKey(username)
+  const acct = formatter.acct(username)
+  const wf = acct.slice(5)
   const actor = await actorStorage.getActor(username, {
     '@context': [
       'https://www.w3.org/ns/activitystreams',
-      'https://w3id.org/security/v1'
+      'https://w3id.org/security/v1',
+      'https://purl.archive.org/socialweb/webfinger'
     ],
     name: bot.fullname,
     summary: bot.description,
+    webfinger: wf,
+    alsoKnownAs: acct,
     publicKey: {
       publicKeyPem,
       id: formatter.format({ username, type: 'publickey' }),
@@ -34,7 +39,7 @@ router.get('/user/:username', async (req, res, next) => {
   res.status(200)
   res.type(as2.mediaType)
   const body = await actor.prettyWrite(
-    { additional_context: 'https://w3id.org/security/v1' }
+    { useOriginalContext: true }
   )
   res.end(body)
 })

package/lib/routes/webfinger.js

@@ -1,45 +1,103 @@
+import assert from 'node:assert'
+
 import { Router } from 'express'
 import createHttpError from 'http-errors'
 
+import BotMaker from '../botmaker.js'
+
 const router = Router()
 
-router.get('/.well-known/webfinger', async (req, res, next) => {
-  const { resource } = req.query
-  if (!resource) {
-    return next(createHttpError(400, 'resource parameter is required'))
-  }
-  if (resource.substring(0, 5) !== 'acct:') {
-    return next(createHttpError(400, 'only acct: protocol supported'))
-  }
-  const [username, domain] = resource.substring(5).split('@')
-  if (!username || !domain) {
-    return next(createHttpError(400, 'Invalid resource parameter'))
-  }
-  const { host } = new URL(req.app.locals.origin)
-  if (domain !== host) {
-    return next(createHttpError(400, 'Invalid domain in resource parameter'))
+async function botWebfinger (username, req, res, next) {
+  const { formatter, bots } = req.app.locals
+  const bot = await BotMaker.makeBot(bots, username)
+  if (!bot) {
+    return next(createHttpError(404, `No such bot '${username}'`))
   }
-  if (!(username in req.app.locals.bots)) {
-    if ('*' in req.app.locals.bots) {
-      if (!await req.app.locals.bots['*'].canCreate(username)) {
-        return next(createHttpError(404, 'Bot not found'))
+  res.status(200)
+  res.type('application/jrd+json')
+  res.json({
+    subject: formatter.acct(username),
+    aliases: [formatter.format({ username })],
+    links: [
+      {
+        rel: 'self',
+        type: 'application/activity+json',
+        href: formatter.format({ username })
       }
-    } else {
-      return next(createHttpError(404, 'Bot not found'))
-    }
-  }
+    ]
+  })
+}
+
+async function serverWebfinger (req, res, next) {
+  const { formatter } = req.app.locals
+  const webfinger = formatter.acct()
+  const id = formatter.format({ server: true })
   res.status(200)
   res.type('application/jrd+json')
   res.json({
-    subject: resource,
+    subject: webfinger,
     links: [
       {
         rel: 'self',
         type: 'application/activity+json',
-        href: req.app.locals.formatter.format({ username })
+        href: id
       }
     ]
   })
+}
+
+async function httpsWebfinger (resource, req, res, next) {
+  const { formatter } = req.app.locals
+  assert.ok(formatter)
+  if (!formatter.isLocal(resource)) {
+    return next(createHttpError(400, 'Only local URLs'))
+  }
+  const parts = formatter.unformat(resource)
+  if (parts.server && !parts.type) {
+    return await serverWebfinger(req, res, next)
+  } else if (
+    !parts.server && parts.username && !parts.type && !parts.collection
+  ) {
+    return await botWebfinger(parts.username, req, res, next)
+  } else {
+    return next(createHttpError(400, `No webfinger lookup for url ${resource}`))
+  }
+}
+
+async function acctWebfinger (resource, req, res, next) {
+  const [username, domain] = resource.substring(5).split('@')
+  if (!username || !domain) {
+    return next(createHttpError(400, `Invalid resource parameter ${resource}`))
+  }
+  const { host } = new URL(req.app.locals.origin)
+  if (domain !== host) {
+    return next(createHttpError(400, `Invalid domain ${domain} in resource parameter`))
+  }
+  if (username === domain) {
+    return await serverWebfinger(req, res, next)
+  } else {
+    return await botWebfinger(username, req, res, next)
+  }
+}
+
+router.get('/.well-known/webfinger', async (req, res, next) => {
+  const { resource } = req.query
+  if (!resource) {
+    return next(createHttpError(400, 'resource parameter is required'))
+  }
+  const colon = resource.indexOf(':')
+  const protocol = resource.slice(0, colon)
+
+  switch (protocol) {
+    case 'acct':
+      return await acctWebfinger(resource, req, res, next)
+    case 'https':
+      return await httpsWebfinger(resource, req, res, next)
+    default:
+      return next(
+        createHttpError(400, `Unsupported resource protocol '${protocol}'`)
+      )
+  }
 })
 
 export default router

package/lib/urlformatter.js

@@ -4,8 +4,11 @@ const USER_COLLECTIONS = ['inbox', 'outbox', 'liked', 'followers', 'following']
 
 export class UrlFormatter {
   #origin = null
+  #hostname
+
   constructor (origin) {
     this.#origin = origin
+    this.#hostname = (new URL(origin)).hostname
   }
 
   format ({ username, type, nanoid, collection, page, server }) {
@@ -75,7 +78,7 @@ export class UrlFormatter {
     if (pathParts.length > 0) {
       if (USER_COLLECTIONS.includes(pathParts[0])) {
         parts.collection = pathParts[0]
-      } else {
+      } else if (pathParts[0] !== 'actor') {
         parts.type = pathParts[0]
       }
     }
@@ -102,4 +105,10 @@ export class UrlFormatter {
     const parts = this.unformat(url)
     return (parts.username && !parts.type && !parts.collection)
   }
+
+  acct (username = null) {
+    return (username)
+      ? `acct:${username}@${this.#hostname}`
+      : `acct:${this.#hostname}@${this.#hostname}`
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evanp/activitypub-bot",
-  "version": "0.28.7",
+  "version": "0.29.0",
   "description": "server-side ActivityPub bot framework",
   "type": "module",
   "main": "lib/index.js",