Add basic authentication endpoint #92
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
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
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,58 @@ | ||
| import { Router } from 'express'; | ||
| import { HttpStatusCodes } from '../utils/http.js'; | ||
|
|
||
| const basicAuthRouter = Router(); | ||
|
|
||
| basicAuthRouter.all('/', (req, res) => { | ||
| const { user, password } = req.query; | ||
|
|
||
| // Validate that both user and password are provided and non-empty | ||
| if ( | ||
| !user || | ||
| !password || | ||
| typeof user !== 'string' || | ||
| typeof password !== 'string' || | ||
| user.trim() === '' || | ||
| password.trim() === '' | ||
| ) { | ||
| res.status(HttpStatusCodes.BAD_REQUEST).json({ | ||
| error: { | ||
| message: 'Missing user or password query parameter', | ||
| }, | ||
| }); | ||
| return; | ||
| } | ||
|
|
||
| const authHeader = req.headers.authorization; | ||
| if (!authHeader || !authHeader.startsWith('Basic ')) { | ||
| res.setHeader('WWW-Authenticate', 'Basic realm="Access to /basic-auth"'); | ||
| res.status(HttpStatusCodes.UNAUTHORIZED).json({ | ||
| authenticated: false, | ||
| message: 'Authentication required', | ||
| }); | ||
| return; | ||
| } | ||
|
Comment on lines
+26
to
+34
There was a problem hiding this comment.
This block of code is repeated again in lines 48-50. To follow the DRY principle (Don't Repeat Yourself), you could extract this into a separate function. + const sendUnauthorizedResponse = (res) => {
+ res.setHeader('WWW-Authenticate', 'Basic realm="Access to /basic-auth"');
+ res.status(HttpStatusCodes.UNAUTHORIZED).json({
+ authenticated: false,
+ message: 'Authentication required',
+ });
+ }
- if (!authHeader || !authHeader.startsWith('Basic ')) {
- res.setHeader('WWW-Authenticate', 'Basic realm="Access to /basic-auth"');
- res.status(HttpStatusCodes.UNAUTHORIZED).json({
- authenticated: false,
- message: 'Authentication required',
- });
- return;
- }
+ if (!authHeader || !authHeader.startsWith('Basic ')) {
+ sendUnauthorizedResponse(res);
+ return;
+ } |
||
|
|
||
| const base64Credentials = authHeader.split(' ')[1]; | ||
| const credentials = Buffer.from(base64Credentials as string, 'base64').toString('utf-8'); | ||
| const [providedUser, providedPassword] = credentials.split(':'); | ||
|
|
||
| if (providedUser === user && providedPassword === password) { | ||
| res.status(HttpStatusCodes.OK).json({ | ||
| authenticated: true, | ||
| message: 'Authentication successful', | ||
| user, | ||
| password, | ||
|
Comment on lines
+44
to
+45
There was a problem hiding this comment.
Returning the user's password in the response is a security risk, even if it's successful authentication. Passwords should never be returned in responses. Remove the password from the response. - user,
- password, |
||
| }); | ||
| } else { | ||
| res.setHeader('WWW-Authenticate', 'Basic realm="Access to /basic-auth"'); | ||
| res.status(HttpStatusCodes.UNAUTHORIZED).json({ | ||
| authenticated: false, | ||
|
Comment on lines
+48
to
+50
There was a problem hiding this comment.
Use the - } else {
- res.setHeader('WWW-Authenticate', 'Basic realm="Access to /basic-auth"');
- res.status(HttpStatusCodes.UNAUTHORIZED).json({
- authenticated: false,
- message: 'Authentication failed',
- user: providedUser,
- password: providedPassword,
- });
- }
+ } else {
+ sendUnauthorizedResponse(res);
+ } |
||
| message: 'Authentication failed', | ||
| user: providedUser, | ||
| password: providedPassword, | ||
|
Comment on lines
+52
to
+53
There was a problem hiding this comment.
Similarly, do not return the provided password when authentication fails. - user: providedUser,
- password: providedPassword, |
||
| }); | ||
| } | ||
| }); | ||
|
|
||
| export { basicAuthRouter }; | ||
|
Comment on lines
+1
to
+58
There was a problem hiding this comment.
The code is generally well-written, but there are a few areas that could be improved for better security and maintainability. |
||
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
Oops, something went wrong.
Oops, something went wrong.
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.
The user and password are being extracted directly from the query parameters. This is not secure as it exposes sensitive information in the URL. It's recommended to use HTTP Basic Authentication which sends credentials in the
Authorizationheader encoded with Base64. The existing code already handles this case starting from line 26, so the extraction of credentials from query parameters can be removed.