forked from ptcrealitylab/vuforia-spatial-edge-server
-
Notifications
You must be signed in to change notification settings - Fork 0
adds mobileShutdown.js and POST /shutdown/ route #7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
breynolds-dts
wants to merge
1
commit into
main
Choose a base branch
from
shutdown-route
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
const EXPECTED_SECRET_LENGTH = 44; // string length of base-64 encoding a 32-byte secret | ||
const BASE64_32BYTE_REGEX = /^[A-Za-z0-9+/]{43}=$/; | ||
|
||
/** | ||
* To be able to shut down the server with POST /shutdown/ (e.g. in the mobile app), | ||
* the server can be run with a secret generated by `openssl rand -base64 32`. | ||
* This function validates that the given string is a base64-encoded 32-byte secret. | ||
*/ | ||
function isValidShutdownSecret(secret) { | ||
if (typeof secret !== 'string' || secret.length !== EXPECTED_SECRET_LENGTH) { | ||
return false; | ||
} | ||
|
||
if (!BASE64_32BYTE_REGEX.test(secret)) { | ||
return false; | ||
} | ||
|
||
try { | ||
const decoded = Buffer.from(secret, 'base64'); | ||
return decoded.length === 32; | ||
} catch { | ||
return false; | ||
} | ||
} | ||
|
||
/** | ||
* Attempts to load the shutdown secret from process.argv[2]. | ||
* Returns null if invalid or missing. It's ok to omit it, but the /shutdown/ route will be disabled. | ||
*/ | ||
function getShutdownSecretFromArgs() { | ||
const rawSecret = process.argv[2]; | ||
|
||
if (!isValidShutdownSecret(rawSecret)) { | ||
return null; | ||
} | ||
|
||
return rawSecret; | ||
} | ||
|
||
/** | ||
* Compares the incoming request token with the expected shutdown secret. | ||
*/ | ||
function verifyShutdownRequest(req, expectedSecret) { | ||
const token = req.headers['x-shutdown-token']; | ||
return token === expectedSecret; | ||
} | ||
|
||
module.exports = { | ||
getShutdownSecretFromArgs, | ||
verifyShutdownRequest, | ||
}; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It may turn out that you want to use
process.exit(0)
here to circumvent the usual safe shutdown process