Skip to content

Commit 62284d6

Browse files
test: use a custom helper for path traversal tests (#377)
1 parent 7c1457e commit 62284d6

3 files changed

Lines changed: 95 additions & 5 deletions

File tree

‎src/request.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export class Request extends GlobalRequest {
4343
}
4444
}
4545

46-
const newHeadersFromIncoming = (incoming: IncomingMessage | Http2ServerRequest) => {
46+
export const newHeadersFromIncoming = (incoming: IncomingMessage | Http2ServerRequest) => {
4747
const headerRecord: [string, string][] = []
4848
const rawHeaders = incoming.rawHeaders
4949
for (let i = 0, len = rawHeaders.length; i < len; i += 2) {

‎test/helpers/request.ts‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
import { once } from 'node:events'
2+
import { request as requestHTTP } from 'node:http'
3+
import type { IncomingMessage, RequestOptions } from 'node:http'
4+
import type { AddressInfo } from 'node:net'
5+
import { Readable } from 'node:stream'
6+
import { newHeadersFromIncoming } from '../../src/request'
7+
import { GlobalResponse } from '../../src/response'
8+
import type { ServerType } from '../../src/types'
9+
10+
export type ServerRequestInit = Omit<
11+
RequestOptions,
12+
'agent' | 'host' | 'hostname' | 'path' | 'port' | 'protocol'
13+
> & {
14+
body?: string | Uint8Array
15+
path: string
16+
}
17+
18+
export const requestServer = async (
19+
server: ServerType,
20+
init: ServerRequestInit
21+
): Promise<Response> => {
22+
const address = server.address() as AddressInfo | null
23+
if (!address) {
24+
throw new Error('Server is not listening on a TCP address')
25+
}
26+
27+
const { body, path, ...options } = init
28+
const request = requestHTTP({
29+
...options,
30+
agent: false,
31+
hostname: address.address,
32+
path,
33+
port: address.port,
34+
})
35+
request.end(body)
36+
37+
const [incoming] = (await once(request, 'response')) as [IncomingMessage]
38+
const status = incoming.statusCode
39+
if (!status) {
40+
throw new Error('Server response did not include a status code')
41+
}
42+
43+
const responseBody =
44+
options.method?.toUpperCase() === 'HEAD' || [101, 204, 205, 304].includes(status)
45+
? null
46+
: (Readable.toWeb(incoming) as ReadableStream<Uint8Array>)
47+
48+
return new GlobalResponse(responseBody, {
49+
headers: newHeadersFromIncoming(incoming),
50+
status,
51+
statusText: incoming.statusMessage,
52+
})
53+
}

‎test/serve-static.test.ts‎

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { chmodSync, rmSync, statSync, symlinkSync } from 'node:fs'
44
import path from 'node:path'
55
import { serveStatic } from './../src/serve-static'
66
import { createAdaptorServer } from './../src/server'
7+
import { requestServer } from './helpers/request'
78

89
describe('Serve Static Middleware', () => {
910
const app = new Hono<{
@@ -67,6 +68,21 @@ describe('Serve Static Middleware', () => {
6768

6869
const server = createAdaptorServer(app)
6970

71+
beforeAll(
72+
() =>
73+
new Promise<void>((resolve, reject) => {
74+
server.once('error', reject)
75+
server.listen(0, '127.0.0.1', resolve)
76+
})
77+
)
78+
79+
afterAll(
80+
() =>
81+
new Promise<void>((resolve, reject) => {
82+
server.close((error) => (error ? reject(error) : resolve()))
83+
})
84+
)
85+
7086
it('Should return index.html', async () => {
7187
const res = await request(server).get('/static/')
7288
expect(res.status).toBe(200)
@@ -271,7 +287,7 @@ describe('Serve Static Middleware', () => {
271287
})
272288

273289
it('Should handle double dots in URL', async () => {
274-
const res = await request(server).get('/static/../secret.txt')
290+
const res = await requestServer(server, { method: 'GET', path: '/static/../secret.txt' })
275291
expect(res.status).toBe(404)
276292
})
277293

@@ -428,18 +444,39 @@ describe('Serve Static Middleware', () => {
428444
const server = createAdaptorServer(app)
429445
app.use('/static/*', serveStatic({ root: './test/assets' }))
430446

447+
beforeAll(
448+
() =>
449+
new Promise<void>((resolve, reject) => {
450+
server.once('error', reject)
451+
server.listen(0, '127.0.0.1', resolve)
452+
})
453+
)
454+
455+
afterAll(
456+
() =>
457+
new Promise<void>((resolve, reject) => {
458+
server.close((error) => (error ? reject(error) : resolve()))
459+
})
460+
)
461+
431462
it('Should prevent path traversal attacks with double dots', async () => {
432-
const res = await request(server).get('/static/../secret.txt')
463+
const res = await requestServer(server, { method: 'GET', path: '/static/../secret.txt' })
433464
expect(res.status).toBe(404)
434465
})
435466

436467
it('Should prevent path traversal attacks with multiple levels', async () => {
437-
const res = await request(server).get('/static/../../package.json')
468+
const res = await requestServer(server, {
469+
method: 'GET',
470+
path: '/static/../../package.json',
471+
})
438472
expect(res.status).toBe(404)
439473
})
440474

441475
it('Should prevent path traversal attacks with mixed separators', async () => {
442-
const res = await request(server).get('/static/..\\..\\package.json')
476+
const res = await requestServer(server, {
477+
method: 'GET',
478+
path: '/static/..\\..\\package.json',
479+
})
443480
expect(res.status).toBe(404)
444481
})
445482

0 commit comments

Comments
 (0)