Skip to content

Commit

Permalink
add support for trustProxy option (#769)
Browse files Browse the repository at this point in the history
  • Loading branch information
@twalling
twalling authored Dec 14, 2024
1 parent 381e810 commit a8f531a
Show file tree
Hide file tree
Showing 4 changed files with 125 additions and 10 deletions.
3 changes: 3 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,9 @@ You can pass the following options via CLI arguments. You can also use `--config
| Set the plugin timeout | `-T` | `--plugin-timeout` | `FASTIFY_PLUGIN_TIMEOUT` |
| Defines the maximum payload, in bytes,<br>that the server is allowed to accept | | `--body-limit` | `FASTIFY_BODY_LIMIT` |
| Set the maximum ms delay before forcefully closing pending requests after receiving SIGTERM or SIGINT signals; and uncaughtException or unhandledRejection errors (default: 500) | `-g` | `--close-grace-delay` | `FASTIFY_CLOSE_GRACE_DELAY` |
| Set the boolean value for `trustProxy` (1st precedence) | | `--trust-proxy-enabled` | `FASTIFY_TRUST_PROXY_ENABLED` |
| Set the IP/CIDR value for `trustProxy` (2nd precedence) | | `--trust-proxy-ips` | `FASTIFY_TRUST_PROXY_IPS` |
| Set the nth hop value for `trustProxy` (3rd precedence) | | `--trust-proxy-hop` | `FASTIFY_TRUST_PROXY_HOP` |

By default `fastify-cli` runs [`dotenv`](https://www.npmjs.com/package/dotenv), so it will load all the env variables stored in `.env` in your current working directory.

Expand Down
15 changes: 11 additions & 4 deletions args.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ module.exports = function parseArgs (args) {
configuration: {
'populate--': true
},
number: ['port', 'inspect-port', 'body-limit', 'plugin-timeout', 'close-grace-delay'],
string: ['log-level', 'address', 'socket', 'prefix', 'ignore-watch', 'logging-module', 'debug-host', 'lang', 'require', 'import', 'config', 'method'],
boolean: ['pretty-logs', 'options', 'watch', 'verbose-watch', 'debug', 'standardlint', 'common-prefix', 'include-hooks'],
number: ['port', 'inspect-port', 'body-limit', 'plugin-timeout', 'close-grace-delay', 'trust-proxy-hop'],
string: ['log-level', 'address', 'socket', 'prefix', 'ignore-watch', 'logging-module', 'debug-host', 'lang', 'require', 'import', 'config', 'method', 'trust-proxy-ips'],
boolean: ['pretty-logs', 'options', 'watch', 'verbose-watch', 'debug', 'standardlint', 'common-prefix', 'include-hooks', 'trust-proxy-enabled'],
envPrefix: 'FASTIFY_',
alias: {
port: ['p'],
Expand Down Expand Up @@ -67,6 +67,12 @@ module.exports = function parseArgs (args) {
// Merge objects from lower to higher priority
const parsedArgs = { ...DEFAULT_ARGUMENTS, ...configFileOptions, ...commandLineArguments }

// Set `trustProxy` with enabled taking precedence, followed by IPs and finally hop count
const trustProxyEnabled = parsedArgs.trustProxyEnabled === undefined
? undefined
: parsedArgs.trustProxyEnabled === true || parsedArgs.trustProxyEnabled === 'true'
const trustProxy = trustProxyEnabled || parsedArgs.trustProxyIps || parsedArgs.trustProxyHop

return {
_: parsedArgs._,
'--': additionalArgs,
Expand All @@ -93,6 +99,7 @@ module.exports = function parseArgs (args) {
lang: parsedArgs.lang,
method: parsedArgs.method,
commonPrefix: parsedArgs.commonPrefix,
includeHooks: parsedArgs.includeHooks
includeHooks: parsedArgs.includeHooks,
trustProxy
}
}
4 changes: 4 additions & 0 deletions start.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,10 @@ async function runFastify (args, additionalOptions, serverOptions) {
options = deepmerge(options, file.options)
}

if (opts.trustProxy) {
options.trustProxy = opts.trustProxy
}

const fastify = Fastify(options)

if (opts.prefix) {
Expand Down
113 changes: 107 additions & 6 deletions test/args.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ test('should parse args correctly', t => {
'--debug-port', 1111,
'--debug-host', '1.1.1.1',
'--logging-module', './custom-logger.js',
'--trust-proxy-enabled', 'true',
'app.js'
]
const parsedArgs = parseArgs(argv)
Expand Down Expand Up @@ -56,7 +57,8 @@ test('should parse args correctly', t => {
lang: 'js',
method: undefined,
commonPrefix: false,
includeHooks: undefined
includeHooks: undefined,
trustProxy: true
})
})

Expand All @@ -83,6 +85,7 @@ test('should parse args with = assignment correctly', t => {
'--debug-port', 1111,
'--debug-host', '1.1.1.1',
'--logging-module', './custom-logger.js',
'--trust-proxy-hop', '2',
'app.js'
]
const parsedArgs = parseArgs(argv)
Expand Down Expand Up @@ -113,7 +116,8 @@ test('should parse args with = assignment correctly', t => {
lang: 'js',
method: undefined,
commonPrefix: false,
includeHooks: undefined
includeHooks: undefined,
trustProxy: 2
})
})

Expand All @@ -139,6 +143,7 @@ test('should parse env vars correctly', t => {
process.env.FASTIFY_DEBUG_PORT = '1111'
process.env.FASTIFY_DEBUG_HOST = '1.1.1.1'
process.env.FASTIFY_LOGGING_MODULE = './custom-logger.js'
process.env.FASTIFY_TRUST_PROXY_ENABLED = 'true'

t.after(() => {
delete process.env.FASTIFY_PORT
Expand All @@ -159,6 +164,7 @@ test('should parse env vars correctly', t => {
delete process.env.FASTIFY_DEBUG
delete process.env.FASTIFY_DEBUG_PORT
delete process.env.FASTIFY_LOGGING_MODULE
delete process.env.FASTIFY_TRUST_PROXY_ENABLED
})

const parsedArgs = parseArgs([])
Expand Down Expand Up @@ -189,7 +195,8 @@ test('should parse env vars correctly', t => {
lang: 'js',
method: undefined,
commonPrefix: false,
includeHooks: undefined
includeHooks: undefined,
trustProxy: true
})
})

Expand Down Expand Up @@ -283,7 +290,8 @@ test('should parse custom plugin options', t => {
lang: 'js',
method: undefined,
commonPrefix: false,
includeHooks: undefined
includeHooks: undefined,
trustProxy: undefined
})
})

Expand Down Expand Up @@ -322,7 +330,8 @@ test('should parse config file correctly and prefer config values over default o
lang: 'js',
method: undefined,
commonPrefix: false,
includeHooks: undefined
includeHooks: undefined,
trustProxy: undefined
})
})

Expand Down Expand Up @@ -365,6 +374,98 @@ test('should prefer command line args over config file options', t => {
lang: 'js',
method: undefined,
commonPrefix: false,
includeHooks: undefined
includeHooks: undefined,
trustProxy: undefined
})
})

test('should favor trust proxy enabled over trust proxy ips and trust proxy hop', t => {
t.plan(1)

const argv = [
'--port', '4000',
'--close-grace-delay', '30000',
'--debug-port', '1111',
'--debug-host', '1.1.1.1',
'--trust-proxy-enabled', 'true',
'--trust-proxy-ips', '127.0.0.1',
'--trust-proxy-hop', '2',
'app.js'
]
const parsedArgs = parseArgs(argv)

t.assert.deepStrictEqual(parsedArgs, {
_: ['app.js'],
'--': [],
port: 4000,
bodyLimit: undefined,
pluginTimeout: 10000,
closeGraceDelay: 30000,
pluginOptions: {},
prettyLogs: false,
options: false,
watch: false,
debug: false,
debugPort: 1111,
debugHost: '1.1.1.1',
ignoreWatch: 'node_modules build dist .git bower_components logs .swp .nyc_output',
verboseWatch: false,
logLevel: 'fatal',
address: undefined,
socket: undefined,
require: undefined,
import: undefined,
prefix: undefined,
loggingModule: undefined,
lang: 'js',
method: undefined,
commonPrefix: false,
includeHooks: undefined,
trustProxy: true
})
})

test('should favor trust proxy ips over trust proxy hop', t => {
t.plan(1)

const argv = [
'--port', '4000',
'--close-grace-delay', '30000',
'--debug-port', '1111',
'--debug-host', '1.1.1.1',
'--trust-proxy-ips', '127.0.0.1',
'--trust-proxy-hop', '2',
'app.js'
]
const parsedArgs = parseArgs(argv)

t.assert.deepStrictEqual(parsedArgs, {
_: ['app.js'],
'--': [],
port: 4000,
bodyLimit: undefined,
pluginTimeout: 10000,
closeGraceDelay: 30000,
pluginOptions: {},
prettyLogs: false,
options: false,
watch: false,
debug: false,
debugPort: 1111,
debugHost: '1.1.1.1',
ignoreWatch: 'node_modules build dist .git bower_components logs .swp .nyc_output',
verboseWatch: false,
logLevel: 'fatal',
address: undefined,
socket: undefined,
require: undefined,
import: undefined,
prefix: undefined,
loggingModule: undefined,
lang: 'js',
method: undefined,
commonPrefix: false,
includeHooks: undefined,
trustProxy: '127.0.0.1'
})
})

0 comments on commit a8f531a

Please sign in to comment.