aboutsummaryrefslogtreecommitdiffhomepage
path: root/server
diff options
context:
space:
mode:
Diffstat (limited to 'server')
-rw-r--r--server/helpers/proxy.ts14
-rw-r--r--server/helpers/requests.ts32
-rw-r--r--server/tests/api/server/index.ts1
-rw-r--r--server/tests/api/server/proxy.ts72
4 files changed, 117 insertions, 2 deletions
diff --git a/server/helpers/proxy.ts b/server/helpers/proxy.ts
new file mode 100644
index 000000000..8b82ccae0
--- /dev/null
+++ b/server/helpers/proxy.ts
@@ -0,0 +1,14 @@
1function getProxy () {
2 return process.env.HTTPS_PROXY ||
3 process.env.HTTP_PROXY ||
4 undefined
5}
6
7function isProxyEnabled () {
8 return !!getProxy()
9}
10
11export {
12 getProxy,
13 isProxyEnabled
14}
diff --git a/server/helpers/requests.ts b/server/helpers/requests.ts
index 36e69458e..e09e23086 100644
--- a/server/helpers/requests.ts
+++ b/server/helpers/requests.ts
@@ -1,19 +1,21 @@
1import { createWriteStream, remove } from 'fs-extra' 1import { createWriteStream, remove } from 'fs-extra'
2import got, { CancelableRequest, Options as GotOptions, RequestError } from 'got' 2import got, { CancelableRequest, Options as GotOptions, RequestError } from 'got'
3import { HttpProxyAgent, HttpsProxyAgent } from 'hpagent'
3import { join } from 'path' 4import { join } from 'path'
4import { CONFIG } from '../initializers/config' 5import { CONFIG } from '../initializers/config'
5import { ACTIVITY_PUB, PEERTUBE_VERSION, REQUEST_TIMEOUT, WEBSERVER } from '../initializers/constants' 6import { ACTIVITY_PUB, PEERTUBE_VERSION, REQUEST_TIMEOUT, WEBSERVER } from '../initializers/constants'
6import { pipelinePromise } from './core-utils' 7import { pipelinePromise } from './core-utils'
7import { processImage } from './image-utils' 8import { processImage } from './image-utils'
8import { logger } from './logger' 9import { logger } from './logger'
10import { getProxy, isProxyEnabled } from './proxy'
11
12const httpSignature = require('http-signature')
9 13
10export interface PeerTubeRequestError extends Error { 14export interface PeerTubeRequestError extends Error {
11 statusCode?: number 15 statusCode?: number
12 responseBody?: any 16 responseBody?: any
13} 17}
14 18
15const httpSignature = require('http-signature')
16
17type PeerTubeRequestOptions = { 19type PeerTubeRequestOptions = {
18 activityPub?: boolean 20 activityPub?: boolean
19 bodyKBLimit?: number // 1MB 21 bodyKBLimit?: number // 1MB
@@ -29,6 +31,8 @@ type PeerTubeRequestOptions = {
29} & Pick<GotOptions, 'headers' | 'json' | 'method' | 'searchParams'> 31} & Pick<GotOptions, 'headers' | 'json' | 'method' | 'searchParams'>
30 32
31const peertubeGot = got.extend({ 33const peertubeGot = got.extend({
34 ...getAgent(),
35
32 headers: { 36 headers: {
33 'user-agent': getUserAgent() 37 'user-agent': getUserAgent()
34 }, 38 },
@@ -153,6 +157,30 @@ async function downloadImage (url: string, destDir: string, destName: string, si
153 } 157 }
154} 158}
155 159
160function getAgent () {
161 if (!isProxyEnabled()) return {}
162
163 const proxy = getProxy()
164
165 logger.info('Using proxy %s.', proxy)
166
167 const proxyAgentOptions = {
168 keepAlive: true,
169 keepAliveMsecs: 1000,
170 maxSockets: 256,
171 maxFreeSockets: 256,
172 scheduling: 'lifo' as 'lifo',
173 proxy
174 }
175
176 return {
177 agent: {
178 http: new HttpProxyAgent(proxyAgentOptions),
179 https: new HttpsProxyAgent(proxyAgentOptions)
180 }
181 }
182}
183
156function getUserAgent () { 184function getUserAgent () {
157 return `PeerTube/${PEERTUBE_VERSION} (+${WEBSERVER.URL})` 185 return `PeerTube/${PEERTUBE_VERSION} (+${WEBSERVER.URL})`
158} 186}
diff --git a/server/tests/api/server/index.ts b/server/tests/api/server/index.ts
index 56e6eb5da..b16a22ee7 100644
--- a/server/tests/api/server/index.ts
+++ b/server/tests/api/server/index.ts
@@ -15,3 +15,4 @@ import './stats'
15import './tracker' 15import './tracker'
16import './no-client' 16import './no-client'
17import './plugins' 17import './plugins'
18import './proxy'
diff --git a/server/tests/api/server/proxy.ts b/server/tests/api/server/proxy.ts
new file mode 100644
index 000000000..d5042ef27
--- /dev/null
+++ b/server/tests/api/server/proxy.ts
@@ -0,0 +1,72 @@
1/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
2
3import 'mocha'
4import * as chai from 'chai'
5import { cleanupTests, createMultipleServers, doubleFollow, PeerTubeServer, setAccessTokensToServers, waitJobs } from '@shared/extra-utils'
6import { MockProxy } from '@shared/extra-utils/mock-servers/mock-proxy'
7
8const expect = chai.expect
9
10describe('Test proxy', function () {
11 let servers: PeerTubeServer[] = []
12 let proxy: MockProxy
13
14 const goodEnv = { HTTP_PROXY: '' }
15 const badEnv = { HTTP_PROXY: 'http://localhost:9000' }
16
17 before(async function () {
18 this.timeout(120000)
19
20 proxy = new MockProxy()
21
22 const proxyPort = await proxy.initialize()
23 servers = await createMultipleServers(2)
24
25 goodEnv.HTTP_PROXY = 'http://localhost:' + proxyPort
26
27 await setAccessTokensToServers(servers)
28 await doubleFollow(servers[0], servers[1])
29 })
30
31 it('Should succeed federation with the appropriate proxy config', async function () {
32 await servers[0].kill()
33 await servers[0].run({}, { env: goodEnv })
34
35 await servers[0].videos.quickUpload({ name: 'video 1' })
36
37 await waitJobs(servers)
38
39 for (const server of servers) {
40 const { total, data } = await server.videos.list()
41 expect(total).to.equal(1)
42 expect(data).to.have.lengthOf(1)
43 }
44 })
45
46 it('Should fail federation with a wrong proxy config', async function () {
47 await servers[0].kill()
48 await servers[0].run({}, { env: badEnv })
49
50 await servers[0].videos.quickUpload({ name: 'video 2' })
51
52 await waitJobs(servers)
53
54 {
55 const { total, data } = await servers[0].videos.list()
56 expect(total).to.equal(2)
57 expect(data).to.have.lengthOf(2)
58 }
59
60 {
61 const { total, data } = await servers[1].videos.list()
62 expect(total).to.equal(1)
63 expect(data).to.have.lengthOf(1)
64 }
65 })
66
67 after(async function () {
68 proxy.terminate()
69
70 await cleanupTests(servers)
71 })
72})