server/tests/api/activitypub/security.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import 'mocha'
   4
   5 import { cleanupTests, closeAllSequelize, flushAndRunMultipleServers, ServerInfo, setActorField } from '../../../../shared/extra-utils'
   6 import { HTTP_SIGNATURE } from '../../../initializers/constants'
   7 import { buildGlobalHeaders } from '../../../lib/job-queue/handlers/utils/activitypub-http-utils'
   8 import * as chai from 'chai'
   9 import { activityPubContextify, buildSignedActivity } from '../../../helpers/activitypub'
  10 import { makeFollowRequest, makePOSTAPRequest } from '../../../../shared/extra-utils/requests/activitypub'
  11 import { buildDigest } from '@server/helpers/peertube-crypto'
  12
  13 const expect = chai.expect
  14
  15 function setKeysOfServer (onServer: ServerInfo, ofServer: ServerInfo, publicKey: string, privateKey: string) {
  16   return Promise.all([
  17     setActorField(onServer.internalServerNumber, 'http://localhost:' + ofServer.port + '/accounts/peertube', 'publicKey', publicKey),
  18     setActorField(onServer.internalServerNumber, 'http://localhost:' + ofServer.port + '/accounts/peertube', 'privateKey', privateKey)
  19   ])
  20 }
  21
  22 function getAnnounceWithoutContext (server2: ServerInfo) {
  23   const json = require('./json/peertube/announce-without-context.json')
  24   const result: typeof json = {}
  25
  26   for (const key of Object.keys(json)) {
  27     if (Array.isArray(json[key])) {
  28       result[key] = json[key].map(v => v.replace(':9002', `:${server2.port}`))
  29     } else {
  30       result[key] = json[key].replace(':9002', `:${server2.port}`)
  31     }
  32   }
  33
  34   return result
  35 }
  36
  37 describe('Test ActivityPub security', function () {
  38   let servers: ServerInfo[]
  39   let url: string
  40
  41   const keys = require('./json/peertube/keys.json')
  42   const invalidKeys = require('./json/peertube/invalid-keys.json')
  43   const baseHttpSignature = () => ({
  44     algorithm: HTTP_SIGNATURE.ALGORITHM,
  45     authorizationHeaderName: HTTP_SIGNATURE.HEADER_NAME,
  46     keyId: 'acct:peertube@localhost:' + servers[1].port,
  47     key: keys.privateKey,
  48     headers: HTTP_SIGNATURE.HEADERS_TO_SIGN
  49   })
  50
  51   // ---------------------------------------------------------------
  52
  53   before(async function () {
  54     this.timeout(60000)
  55
  56     servers = await flushAndRunMultipleServers(3)
  57
  58     url = servers[0].url + '/inbox'
  59
  60     await setKeysOfServer(servers[0], servers[1], keys.publicKey, keys.privateKey)
  61
  62     const to = { url: 'http://localhost:' + servers[0].port + '/accounts/peertube' }
  63     const by = { url: 'http://localhost:' + servers[1].port + '/accounts/peertube', privateKey: keys.privateKey }
  64     await makeFollowRequest(to, by)
  65   })
  66
  67   describe('When checking HTTP signature', function () {
  68
  69     it('Should fail with an invalid digest', async function () {
  70       const body = activityPubContextify(getAnnounceWithoutContext(servers[1]))
  71       const headers = {
  72         Digest: buildDigest({ hello: 'coucou' })
  73       }
  74
  75       const { response } = await makePOSTAPRequest(url, body, baseHttpSignature(), headers)
  76
  77       expect(response.statusCode).to.equal(403)
  78     })
  79
  80     it('Should fail with an invalid date', async function () {
  81       const body = activityPubContextify(getAnnounceWithoutContext(servers[1]))
  82       const headers = buildGlobalHeaders(body)
  83       headers['date'] = 'Wed, 21 Oct 2015 07:28:00 GMT'
  84
  85       const { response } = await makePOSTAPRequest(url, body, baseHttpSignature(), headers)
  86
  87       expect(response.statusCode).to.equal(403)
  88     })
  89
  90     it('Should fail with bad keys', async function () {
  91       await setKeysOfServer(servers[0], servers[1], invalidKeys.publicKey, invalidKeys.privateKey)
  92       await setKeysOfServer(servers[1], servers[1], invalidKeys.publicKey, invalidKeys.privateKey)
  93
  94       const body = activityPubContextify(getAnnounceWithoutContext(servers[1]))
  95       const headers = buildGlobalHeaders(body)
  96
  97       const { response } = await makePOSTAPRequest(url, body, baseHttpSignature(), headers)
  98
  99       expect(response.statusCode).to.equal(403)
 100     })
 101
 102     it('Should reject requests without appropriate signed headers', async function () {
 103       await setKeysOfServer(servers[0], servers[1], keys.publicKey, keys.privateKey)
 104       await setKeysOfServer(servers[1], servers[1], keys.publicKey, keys.privateKey)
 105
 106       const body = activityPubContextify(getAnnounceWithoutContext(servers[1]))
 107       const headers = buildGlobalHeaders(body)
 108
 109       const signatureOptions = baseHttpSignature()
 110       const badHeadersMatrix = [
 111         [ '(request-target)', 'date', 'digest' ],
 112         [ 'host', 'date', 'digest' ],
 113         [ '(request-target)', 'host', 'digest' ]
 114       ]
 115
 116       for (const badHeaders of badHeadersMatrix) {
 117         signatureOptions.headers = badHeaders
 118
 119         const { response } = await makePOSTAPRequest(url, body, signatureOptions, headers)
 120         expect(response.statusCode).to.equal(403)
 121       }
 122     })
 123
 124     it('Should succeed with a valid HTTP signature', async function () {
 125       const body = activityPubContextify(getAnnounceWithoutContext(servers[1]))
 126       const headers = buildGlobalHeaders(body)
 127
 128       const { response } = await makePOSTAPRequest(url, body, baseHttpSignature(), headers)
 129
 130       expect(response.statusCode).to.equal(204)
 131     })
 132   })
 133
 134   describe('When checking Linked Data Signature', function () {
 135     before(async () => {
 136       await setKeysOfServer(servers[2], servers[2], keys.publicKey, keys.privateKey)
 137
 138       const to = { url: 'http://localhost:' + servers[0].port + '/accounts/peertube' }
 139       const by = { url: 'http://localhost:' + servers[2].port + '/accounts/peertube', privateKey: keys.privateKey }
 140       await makeFollowRequest(to, by)
 141     })
 142
 143     it('Should fail with bad keys', async function () {
 144       this.timeout(10000)
 145
 146       await setKeysOfServer(servers[0], servers[2], invalidKeys.publicKey, invalidKeys.privateKey)
 147       await setKeysOfServer(servers[2], servers[2], invalidKeys.publicKey, invalidKeys.privateKey)
 148
 149       const body = getAnnounceWithoutContext(servers[1])
 150       body.actor = 'http://localhost:' + servers[2].port + '/accounts/peertube'
 151
 152       const signer: any = { privateKey: invalidKeys.privateKey, url: 'http://localhost:' + servers[2].port + '/accounts/peertube' }
 153       const signedBody = await buildSignedActivity(signer, body)
 154
 155       const headers = buildGlobalHeaders(signedBody)
 156
 157       const { response } = await makePOSTAPRequest(url, signedBody, baseHttpSignature(), headers)
 158
 159       expect(response.statusCode).to.equal(403)
 160     })
 161
 162     it('Should fail with an altered body', async function () {
 163       this.timeout(10000)
 164
 165       await setKeysOfServer(servers[0], servers[2], keys.publicKey, keys.privateKey)
 166       await setKeysOfServer(servers[0], servers[2], keys.publicKey, keys.privateKey)
 167
 168       const body = getAnnounceWithoutContext(servers[1])
 169       body.actor = 'http://localhost:' + servers[2].port + '/accounts/peertube'
 170
 171       const signer: any = { privateKey: keys.privateKey, url: 'http://localhost:' + servers[2].port + '/accounts/peertube' }
 172       const signedBody = await buildSignedActivity(signer, body)
 173
 174       signedBody.actor = 'http://localhost:' + servers[2].port + '/account/peertube'
 175
 176       const headers = buildGlobalHeaders(signedBody)
 177
 178       const { response } = await makePOSTAPRequest(url, signedBody, baseHttpSignature(), headers)
 179
 180       expect(response.statusCode).to.equal(403)
 181     })
 182
 183     it('Should succeed with a valid signature', async function () {
 184       this.timeout(10000)
 185
 186       const body = getAnnounceWithoutContext(servers[1])
 187       body.actor = 'http://localhost:' + servers[2].port + '/accounts/peertube'
 188
 189       const signer: any = { privateKey: keys.privateKey, url: 'http://localhost:' + servers[2].port + '/accounts/peertube' }
 190       const signedBody = await buildSignedActivity(signer, body)
 191
 192       const headers = buildGlobalHeaders(signedBody)
 193
 194       const { response } = await makePOSTAPRequest(url, signedBody, baseHttpSignature(), headers)
 195
 196       expect(response.statusCode).to.equal(204)
 197     })
 198   })
 199
 200   after(async function () {
 201     this.timeout(10000)
 202
 203     await cleanupTests(servers)
 204
 205     await closeAllSequelize(servers)
 206   })
 207 })