Skip to content
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.

Sign up for GitHub

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

Validate hostname in uri #2846

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open

Validate hostname in uri #2846

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
4234132
Add hostname option to domain obj
trizotti Sep 23, 2022
b23ce51
Add hostname validation + tests
trizotti Sep 23, 2022
f1f0322
Remove unnecessary import
trizotti Sep 23, 2022
25777d5
Fix lint issues
trizotti Oct 3, 2022
3cb8376
Add support for array of hostnames + tests
trizotti Oct 3, 2022
9c83bd5
Merge branch 'master' into validate-hostname-in-uri
trizotti Oct 3, 2022
a90120b
Add support to mixed arrays rx and strings
trizotti Oct 13, 2022
4d29bab
Remove unecessary operator
trizotti Oct 13, 2022
2e754a3
Add docs for string.uri.hostname
trizotti Oct 13, 2022
06483be
Refactorarray check
trizotti Oct 14, 2022
4053a1b
Merge branch 'hapijs:master' into validate-hostname-in-uri
trizotti Oct 14, 2022
5c2a000
Add test and clean up the code
trizotti Oct 17, 2022
45c32ee
Fix typo
trizotti Oct 17, 2022
1a9f9a5
Remove unnecessary test
trizotti Oct 17, 2022
53de422
Refactoring
trizotti Oct 24, 2022
d74362c
Remove unnecessary type conversion
trizotti Oct 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion lib/types/string.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,7 @@ module.exports = Any.extend({
Common.assertOptions(options, ['allowRelative', 'allowQuerySquareBrackets', 'domain', 'relativeOnly', 'scheme']);

if (options.domain) {
Common.assertOptions(options.domain, ['allowFullyQualified', 'allowUnicode', 'maxDomainSegments', 'minDomainSegments', 'tlds']);
Common.assertOptions(options.domain, ['allowFullyQualified', 'allowUnicode', 'maxDomainSegments', 'minDomainSegments', 'tlds', 'hostname']);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is going to be part of domain, you should probably exclude it from the call to isValid to avoid any possible side-effect from an evolution of that module.

}

const { regex, scheme } = Uri.regex(options);
Expand All @@ -662,6 +662,13 @@ module.exports = Any.extend({
return helpers.error('string.domain', { value: matched });
}

if(options?.domain?.hostname){
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

domain is already checked a few lines above, you can probably refactor that if to handle your case.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you talking about the domain variable few lines above (line 659)?
I think it's not the same as options.domain...

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, it kind of is. Look at the $_addRule just above.

options (the 3rd argument of validate) is basically the raw argument you provided.

domain (the 4th argument) is the post-processed version of that raw argument through the call to addressOptions, which I think should be augmented to validate that hostname satisfies expectations.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added info to the docs and also support for regex and arrays.

const { hostname } = options.domain;
if(hostname !== matched){
return helpers.error('string.uri.hostname', { value: matched });
}
}

return value;
}

Expand Down Expand Up @@ -721,6 +728,7 @@ module.exports = Any.extend({
'string.pattern.invert.name': '{{#label}} with value {:[.]} matches the inverted {{#name}} pattern',
'string.trim': '{{#label}} must not have leading or trailing whitespace',
'string.uri': '{{#label}} must be a valid uri',
'string.uri.hostname': '{{#label}} is not from given hostname',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The error might be more useful if it detailed what it expected, like so:

Suggested change
'string.uri.hostname': '{{#label}} is not from given hostname',
'string.uri.hostname': '{{#label}} does not match {{#expected}} hostname'

Copy link
Contributor Author

@trizotti trizotti Oct 13, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some changes to make the error more useful, following the example.

'string.uriCustomScheme': '{{#label}} must be a valid uri with a scheme matching the {{#scheme}} pattern',
'string.uriRelativeOnly': '{{#label}} must be a valid relative uri',
'string.uppercase': '{{#label}} must only contain uppercase characters'
Expand Down
10 changes: 10 additions & 0 deletions test/types/string.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8582,6 +8582,16 @@ describe('string', () => {

expect(() => Joi.string().uri({ foo: 'bar', baz: 'qux' })).to.throw('Options contain unknown keys: foo,baz');
});

it('validates if uri is from a given hostname', () => {
const schema = Joi.string().uri({ scheme: 'https', domain: { hostname: 'example.com'}});
Helper.validate(schema, [
['https://example.com', true],
['https://example.com/test', true],
['https://test.com', false, '"value" is not from given hostname'],
['https://test.com/example', false, '"value" is not from given hostname']
]);
});
});

describe('valid()', () => {
Expand Down