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

Jump to bottom

[misc] Use an allowlist for all JS includes #7210

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

[misc] Use an allowlist for all JS includes #7210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4858341
Use BASIC_SUPPORTED_FILE_EXTENSIONS for all JS includes
Mar 24, 2022
65e217e
Add some sample files that should be ignored to the sample app
Mar 24, 2022
4ab8748
Add line to changelog
Mar 24, 2022
9253abc
Add ejs to supported extensions
Mar 9, 2023
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Sails Changelog

## master

- Switch from an exclude list to an allow list for file extensions when loading services and the like

## 1.2.0

- Added `sails migrate` for quickly running auto-migrations by hand
Expand Down
19 changes: 10 additions & 9 deletions lib/hooks/moduleloader/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ module.exports = function(sails) {
// > For full list, see:
// > https://github.com/luislobo/common-js-file-extensions/blob/210fd15d89690c7aaa35dba35478cb91c693dfa8/README.md#code-file-extensions
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
var BASIC_SUPPORTED_FILE_EXTENSIONS = COMMON_JS_FILE_EXTENSIONS.code;
var SUPPORTED_FILE_EXTENSIONS_FOR_CODE = COMMON_JS_FILE_EXTENSIONS.code.concat(['ejs']);
var SUPPORTED_FILE_EXTENSIONS_FOR_CODE_REGEX = new RegExp('^(.+)\\.(' + SUPPORTED_FILE_EXTENSIONS_FOR_CODE.join('|') + ')$');

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Supported file extensions, ONLY for configuration files:
Expand All @@ -39,7 +40,7 @@ module.exports = function(sails) {
// > For full list, see:
// > https://github.com/luislobo/common-js-file-extensions/blob/210fd15d89690c7aaa35dba35478cb91c693dfa8/README.md#configobject-file-extensions
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
var SUPPORTED_FILE_EXTENSIONS_FOR_CONFIG = COMMON_JS_FILE_EXTENSIONS.config.concat(BASIC_SUPPORTED_FILE_EXTENSIONS);
var SUPPORTED_FILE_EXTENSIONS_FOR_CONFIG = COMMON_JS_FILE_EXTENSIONS.config.concat(SUPPORTED_FILE_EXTENSIONS_FOR_CODE);


/**
Expand Down Expand Up @@ -303,7 +304,7 @@ module.exports = function(sails) {
// Get the main model files
includeAll.optional({
dirname : sails.config.paths.models,
filter : /^(.+)\.(?:(?!md|txt).)+$/,
filter : SUPPORTED_FILE_EXTENSIONS_FOR_CODE_REGEX,
replaceExpr : /^.*\//,
flatten: true
}, function(err, models) {
Expand Down Expand Up @@ -338,7 +339,7 @@ module.exports = function(sails) {
loadServices: function (cb) {
includeAll.optional({
dirname : sails.config.paths.services,
filter : /^(.+)\.(?:(?!md|txt).)+$/,
filter : SUPPORTED_FILE_EXTENSIONS_FOR_CODE_REGEX,
depth : 1,
caseSensitive : true
}, bindToSails(cb));
Expand All @@ -353,7 +354,7 @@ module.exports = function(sails) {
statViews: function (cb) {
includeAll.optional({
dirname: sails.config.paths.views,
filter: /^(.+)\.(?:(?!md|txt).)+$/,
filter: SUPPORTED_FILE_EXTENSIONS_FOR_CODE_REGEX,
replaceExpr: null,
dontLoad: true
}, cb);
Expand All @@ -368,7 +369,7 @@ module.exports = function(sails) {
loadPolicies: function (cb) {
includeAll.optional({
dirname: sails.config.paths.policies,
filter: /^(.+)\.(?:(?!md|txt).)+$/,
filter: SUPPORTED_FILE_EXTENSIONS_FOR_CODE_REGEX,
replaceExpr: null,
flatten: true,
keepDirectoryPath: true
Expand Down Expand Up @@ -403,7 +404,7 @@ module.exports = function(sails) {
hooksFolder: function(cb) {
includeAll.optional({
dirname: sails.config.paths.hooks,
filter: new RegExp('^(.+)\\.(' + BASIC_SUPPORTED_FILE_EXTENSIONS.join('|') + ')$'),
filter: SUPPORTED_FILE_EXTENSIONS_FOR_CODE_REGEX,

// Hooks should be defined as either single files as a function
// OR (better yet) a subfolder with an index.js file
Expand Down Expand Up @@ -579,7 +580,7 @@ module.exports = function(sails) {
loadBlueprints: function (cb) {
includeAll.optional({
dirname: sails.config.paths.blueprints,
filter: /^(.+)\.(?:(?!md|txt).)+$/,
filter: SUPPORTED_FILE_EXTENSIONS_FOR_CODE_REGEX,
useGlobalIdForKeyName: true
}, cb);
},
Expand All @@ -593,7 +594,7 @@ module.exports = function(sails) {
loadResponses: function (cb) {
includeAll.optional({
dirname: sails.config.paths.responses,
filter: /^(.+)\.(?:(?!md|txt).)+$/,
filter: SUPPORTED_FILE_EXTENSIONS_FOR_CODE_REGEX,
useGlobalIdForKeyName: true
}, bindToSails(cb));
},
Expand Down
2 changes: 2 additions & 0 deletions test/integration/fixtures/sampleapp/api/controllers/.DoNotLoad.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
This is just a file that we shouldn't try to load as a source file when loading
this directory
5 changes: 5 additions & 0 deletions test/integration/fixtures/sampleapp/api/models/DoNotLoad.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<html>
<body>
Just a sample file that we shouldn't load
</body>
</html>
1 change: 1 addition & 0 deletions test/integration/fixtures/sampleapp/api/policies/DoNotLoad.rtd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Another file we shouldn't try to load as source