Package Exports
- @microsoft/eslint-plugin-sdl
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@microsoft/eslint-plugin-sdl) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
eslint-plugin-sdl
ESLint Plugin focused on common security issues and misconfigurations.
Plugin is intended as a baseline for projects that follow Microsoft Security Development Lifecycle (SDL) and use ESLint to perform Static Analysis Security Testing (SAST).
Configs
Plugin is shipped with following Shareable Configs:
- angular - Set of rules for Angular applications
- angularjs - Set of rules for AngularJS applications
- common - Set of rules for common JavaScript applications
- electron - Set of rules for Electron applications
- react - Set of rules for ReactJS applications
- required - SDL Required rules for all applications
- typescript - Set of rules for TypeScript applications
Rules
Where possible, we leverage existing rules from ESLint and community plugins such as react, typescript-eslint or security.
We also implemented several custom rules where we did not find sufficient alternative in the community.
| Name | Description |
|---|---|
| no-caller | Bans usage of deprecated functions arguments.caller() and arguments.callee that could potentially allow access to call stack. |
| no-delete-var | Bans usage of operator delete on variables as it can lead to unexpected behavior. |
| no-eval | Bans usage of eval() that allows code execution from string argument. |
| no-implied-eval | Bans usage of setTimeout(), setInterval() and execScript(). These functions are similar to eval() and prone to code execution. |
| no-new-func | Bans calling new Function() as it's similar to eval() and prone to code execution. |
| @microsoft/sdl/no-angular-bypass-sanitizer | Calls to bypassSecurityTrustHtml, bypassSecurityTrustScript and similar methods bypass DomSanitizer in Angular and need to be reviewed. |
| @microsoft/sdl/no-angularjs-bypass-sce | Calls to $sceProvider.enabled(false), $sceDelegate.trustAs(), $sce.trustAs() and relevant shorthand methods (e.g. trustAsHtml or trustAsJs) bypass Strict Contextual Escaping (SCE) in AngularJS and need to be reviewed. |
| @microsoft/sdl/no-angularjs-enable-svg | Calls to $sanitizeProvider.enableSvg(true) increase attack surface of the application by enabling SVG support in AngularJS sanitizer and need to be reviewed. |
| @microsoft/sdl/no-angularjs-sanitization-whitelist | Calls to $compileProvider.aHrefSanitizationWhitelist or $compileProvider.imgSrcSanitizationWhitelist configure whitelists in AngularJS sanitizer and need to be reviewed. |
| @microsoft/sdl/no-cookies | HTTP cookies are an old client-side storage mechanism with inherent risks and limitations. Use Web Storage, IndexedDB or other modern methods instead. |
| @microsoft/sdl/no-document-domain | Writes to document.domain property must be reviewed to avoid bypass of same-origin checks. Usage of top level domains such as azurewebsites.net is strictly prohibited. |
| @microsoft/sdl/no-document-write | Calls to document.write or document.writeln manipulate DOM directly without any sanitization and should be avoided. Use document.createElement() or similar methods instead. |
| @microsoft/sdl/no-electron-node-integration | Node.js Integration must not be enabled in any renderer that loads remote content to avoid remote code execution attacks. |
| @microsoft/sdl/no-html-method | Direct calls to method html() often (e.g. in jQuery framework) manipulate DOM without any sanitization and should be avoided. Use document.createElement() or similar methods instead. |
| @microsoft/sdl/no-inner-html | Assignments to innerHTML or outerHTML properties manipulate DOM directly without any sanitization and should be avoided. Use document.createElement() or similar methods instead. |
| @microsoft/sdl/no-msapp-exec-unsafe | Calls to MSApp.execUnsafeLocalFunction() bypass script injection validation and should be avoided. |
| @microsoft/sdl/no-postmessage-star-origin | Always provide specific target origin, not * when sending data to other windows using postMessage to avoid data leakage outside of trust boundary. |
| @microsoft/sdl/no-winjs-html-unsafe | Calls to WinJS.Utilities.setInnerHTMLUnsafe() and similar methods do not perform any input validation and should be avoided. Use WinJS.Utilities.setInnerHTML() instead. |
| react/no-danger | Bans usage of dangerouslySetInnerHTML property in React as it allows passing unsanitized HTML in DOM. |
| @typescript-eslint/no-implied-eval | Similar to built-in ESLint rule no-implied-eval. Bans usage of setTimeout(), setInterval(), setImmediate(), execScript() or new Function() as they are similar to eval() and allow code execution from string arguments. |
Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.