server/helpers/custom-validators/activitypub/actor.ts

   1 import validator from 'validator'
   2 import { CONSTRAINTS_FIELDS } from '../../../initializers/constants'
   3 import { exists, isArray, isDateValid } from '../misc'
   4 import { isActivityPubUrlValid, isBaseActivityValid, setValidAttributedTo } from './misc'
   5 import { isHostValid } from '../servers'
   6 import { peertubeTruncate } from '@server/helpers/core-utils'
   7
   8 function isActorEndpointsObjectValid (endpointObject: any) {
   9   if (endpointObject?.sharedInbox) {
  10     return isActivityPubUrlValid(endpointObject.sharedInbox)
  11   }
  12
  13   // Shared inbox is optional
  14   return true
  15 }
  16
  17 function isActorPublicKeyObjectValid (publicKeyObject: any) {
  18   return isActivityPubUrlValid(publicKeyObject.id) &&
  19     isActivityPubUrlValid(publicKeyObject.owner) &&
  20     isActorPublicKeyValid(publicKeyObject.publicKeyPem)
  21 }
  22
  23 function isActorTypeValid (type: string) {
  24   return type === 'Person' || type === 'Application' || type === 'Group' || type === 'Service' || type === 'Organization'
  25 }
  26
  27 function isActorPublicKeyValid (publicKey: string) {
  28   return exists(publicKey) &&
  29     typeof publicKey === 'string' &&
  30     publicKey.startsWith('-----BEGIN PUBLIC KEY-----') &&
  31     publicKey.includes('-----END PUBLIC KEY-----') &&
  32     validator.isLength(publicKey, CONSTRAINTS_FIELDS.ACTORS.PUBLIC_KEY)
  33 }
  34
  35 const actorNameAlphabet = '[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]'
  36 const actorNameRegExp = new RegExp(`^${actorNameAlphabet}+$`)
  37 function isActorPreferredUsernameValid (preferredUsername: string) {
  38   return exists(preferredUsername) && validator.matches(preferredUsername, actorNameRegExp)
  39 }
  40
  41 function isActorPrivateKeyValid (privateKey: string) {
  42   return exists(privateKey) &&
  43     typeof privateKey === 'string' &&
  44     privateKey.startsWith('-----BEGIN RSA PRIVATE KEY-----') &&
  45     // Sometimes there is a \n at the end, so just assert the string contains the end mark
  46     privateKey.includes('-----END RSA PRIVATE KEY-----') &&
  47     validator.isLength(privateKey, CONSTRAINTS_FIELDS.ACTORS.PRIVATE_KEY)
  48 }
  49
  50 function isActorFollowingCountValid (value: string) {
  51   return exists(value) && validator.isInt('' + value, { min: 0 })
  52 }
  53
  54 function isActorFollowersCountValid (value: string) {
  55   return exists(value) && validator.isInt('' + value, { min: 0 })
  56 }
  57
  58 function isActorDeleteActivityValid (activity: any) {
  59   return isBaseActivityValid(activity, 'Delete')
  60 }
  61
  62 function sanitizeAndCheckActorObject (actor: any) {
  63   normalizeActor(actor)
  64
  65   return exists(actor) &&
  66     isActivityPubUrlValid(actor.id) &&
  67     isActorTypeValid(actor.type) &&
  68     isActivityPubUrlValid(actor.inbox) &&
  69     isActorPreferredUsernameValid(actor.preferredUsername) &&
  70     isActivityPubUrlValid(actor.url) &&
  71     isActorPublicKeyObjectValid(actor.publicKey) &&
  72     isActorEndpointsObjectValid(actor.endpoints) &&
  73
  74     (!actor.outbox || isActivityPubUrlValid(actor.outbox)) &&
  75     (!actor.following || isActivityPubUrlValid(actor.following)) &&
  76     (!actor.followers || isActivityPubUrlValid(actor.followers)) &&
  77
  78     setValidAttributedTo(actor) &&
  79     setValidDescription(actor) &&
  80     // If this is a group (a channel), it should be attributed to an account
  81     // In PeerTube we use this to attach a video channel to a specific account
  82     (actor.type !== 'Group' || actor.attributedTo.length !== 0)
  83 }
  84
  85 function normalizeActor (actor: any) {
  86   if (!actor) return
  87
  88   if (!actor.url) {
  89     actor.url = actor.id
  90   } else if (typeof actor.url !== 'string') {
  91     actor.url = actor.url.href || actor.url.url
  92   }
  93
  94   if (!isDateValid(actor.published)) actor.published = undefined
  95
  96   if (actor.summary && typeof actor.summary === 'string') {
  97     actor.summary = peertubeTruncate(actor.summary, { length: CONSTRAINTS_FIELDS.USERS.DESCRIPTION.max })
  98
  99     if (actor.summary.length < CONSTRAINTS_FIELDS.USERS.DESCRIPTION.min) {
 100       actor.summary = null
 101     }
 102   }
 103 }
 104
 105 function isValidActorHandle (handle: string) {
 106   if (!exists(handle)) return false
 107
 108   const parts = handle.split('@')
 109   if (parts.length !== 2) return false
 110
 111   return isHostValid(parts[1])
 112 }
 113
 114 function areValidActorHandles (handles: string[]) {
 115   return isArray(handles) && handles.every(h => isValidActorHandle(h))
 116 }
 117
 118 function setValidDescription (obj: any) {
 119   if (!obj.summary) obj.summary = null
 120
 121   return true
 122 }
 123
 124 // ---------------------------------------------------------------------------
 125
 126 export {
 127   normalizeActor,
 128   actorNameAlphabet,
 129   areValidActorHandles,
 130   isActorEndpointsObjectValid,
 131   isActorPublicKeyObjectValid,
 132   isActorTypeValid,
 133   isActorPublicKeyValid,
 134   isActorPreferredUsernameValid,
 135   isActorPrivateKeyValid,
 136   isActorFollowingCountValid,
 137   isActorFollowersCountValid,
 138   isActorDeleteActivityValid,
 139   sanitizeAndCheckActorObject,
 140   isValidActorHandle
 141 }