Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/microsoft/devskim
DevSkim is a set of IDE plugins, language analyzers, and rules that provide security "linting" capabilities.
https://github.com/microsoft/devskim
linter sdl security visual-studio-code-extension visual-studio-extension
Last synced: 7 days ago
JSON representation
DevSkim is a set of IDE plugins, language analyzers, and rules that provide security "linting" capabilities.
- Host: GitHub
- URL: https://github.com/microsoft/devskim
- Owner: microsoft
- License: mit
- Created: 2016-08-03T15:30:25.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-03-27T20:02:38.000Z (7 months ago)
- Last Synced: 2024-04-08T00:51:29.604Z (7 months ago)
- Topics: linter, sdl, security, visual-studio-code-extension, visual-studio-extension
- Language: C#
- Homepage:
- Size: 28.6 MB
- Stars: 882
- Watchers: 36
- Forks: 115
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
- static-analysis - DevSkim - based static analysis tool for Visual Studio, VS Code, and Sublime Text - C/C++, C#, PHP, ASP, Python, Ruby, Java, and others. (Multiple languages)
README
# DevSkim
[](https://www.nuget.org/packages/Microsoft.CST.DevSkim.CLI)
[](https://marketplace.visualstudio.com/items?itemName=MS-CST-E.vscode-devskim)
[](https://marketplace.visualstudio.com/items?itemName=MS-CST-E.vscode-devskim)
[](https://www.nuget.org/packages/Microsoft.CST.DevSkim.CLI)
[](https://marketplace.visualstudio.com/items?itemName=MS-CST-E.MicrosoftDevSkim)
[](https://marketplace.visualstudio.com/items?itemName=MS-CST-E.vscode-devskim)
DevSkim is a framework of IDE extensions and language analyzers that provide inline security analysis
in the dev environment as the developer writes code. It has a flexible rule model that supports multiple programming
languages. The goal is to notify the developer as they are introducing a security
vulnerability in order to fix the issue at the point of introduction, and to help build awareness
for the developer.
### Features
* Built-in rules, and support for writing custom rules
* Cross-platform CLI built on .NET for file analysis
* IDE plugins for Visual Studio and Visual Studio Code built on Language Server Protocol
* IntelliSense error "squiggly lines" for identified security issues
* Information and guidance provided for identified security issues
* Optional suppression of unwanted findings
* Support for JSONPath, XPATH and YmlPath based rules
* Broad language support including: C, C++, C#, Cobol, Go, Java, Javascript/Typescript, Python, and [more](https://github.com/Microsoft/DevSkim/wiki/Supported-Languages).
### Repository Structure
This repository contains DevSkim and its official supported plugins. Issues and contributions are accepted here for:
* DevSkim Library
* Location: `./DevSkim-DotNet/`
* DevSkim CLI
* Location: `./DevSkim-DotNet/Microsoft.DevSkim.CLI/`
* DevSkim Visual Studio Extension
* Location: `./DevSkim-DotNet/Microsoft.DevSkim.VisualStudio/`
* DevSkim Visual Studio Code Plugin
* Location: `./DevSkim-VSCode-Plugin/`
* Default Rules and Guidance
* Location: `./rules/default/`
## Official Releases
The C# library is available on NuGet as [Microsoft.CST.DevSkim](https://www.nuget.org/packages/Microsoft.CST.DevSkim/).
The .NET Global Tool is available on NuGet as [Microsoft.CST.DevSkim.CLI](https://www.nuget.org/packages/Microsoft.CST.DevSkim.CLI/).
The Visual Studio extension is available in the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=MS-CST-E.MicrosoftDevSkim).
The Visual Studio Code plugin is available in the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=MS-CST-E.vscode-devskim).
DevSkim is also available as a [GitHub Action](https://github.com/microsoft/DevSkim-Action) to integrate with the GitHub Security Issues pane.
Platform specific binaries of the DevSkim CLI are also available on our GitHub [releases page](https://github.com/microsoft/DevSkim/releases).
## Installation
### Visual Studio Extension
The DevSkim Visual Studio extension can be downloaded and installed from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=MS-CST-E.MicrosoftDevSkim).
Alternatively, in Visual Studio, open the Extension Manager (Menu: Extensions -> Manage Extensions), search for "Microsoft DevSkim", select the entry, and click on the Download button.
### Visual Studio Code Plugin
The DevSkim Visual Studio Code plugin can be downloaded and installed from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=MS-CST-E.vscode-devskim).
Alternatively, In VS Code, launch the Quick Open bar (Ctrl + P), and run the following command:
ext install ms-cst-e.vscode-devskim
### Command Line Interface
#### .NET Core Global Tool (Recommended)
If you already have the .NET SDK installed, you can install the DevSkim CLI as a dotnet global tool by running the following from a command line:
`dotnet tool install --global Microsoft.CST.DevSkim.CLI`
This will add DevSkim to your PATH. You can then invoke `devskim` from a command line.
#### .NET Core App (Self Contained)
Download the platform specific binary archive for your system (Windows, Mac OS, Linux) from the [releases page](https://github.com/microsoft/DevSkim/releases). Extract the archive, navigate to the DevSkim folder from a command line, and invoke `devskim` or `devskim.exe`.
#### .NET Core Runtime Dependent App
First download and install the [Latest .NET runtime](https://dotnet.microsoft.com/).
Then download the DevSkim netcoreapp archive from the [releases page](https://github.com/microsoft/DevSkim/releases). Extract the archive, navigate to the DevSkim folder from a command line, and invoke `dotnet devskim.dll`.
## Build from Source
For more information, see the wiki page about how to [Build from Source](https://github.com/microsoft/DevSkim/wiki/Build-from-Source).
## Basic Usage
### DevSkim CLI
`devskim analyze --source-code c:\path\to\FilesToAnalyze`
For more information, see the wiki page about the [Command Line Interface](https://github.com/microsoft/DevSkim/wiki/Command-Line-Interface).
### Visual Studio Extension / Visual Studio Code Plugin
Once the DevSkim plugin is installed and enabled, simply write some code, and feedback will be provided inline if issues are detected.
## Writing Rules
Please see [Writing Rules](https://github.com/Microsoft/DevSkim/wiki/Writing-Rules) for
instructions on how to author rules.
## 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](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
For more information, please see [How to Contribute](https://github.com/Microsoft/DevSkim/wiki/How-to-Contribute).
## Reporting Issues
For more information, please see [How to Contribute](https://github.com/Microsoft/DevSkim/wiki/How-to-Contribute).
### Reporting Security Vulnerabilities
To report a security vulnerability, please see [SECURITY.md](https://github.com/microsoft/DevSkim/blob/master/SECURITY.md).
## License
DevSkim and its official plugins are licensed under the [MIT license](https://github.com/microsoft/DevSkim/blob/master/LICENSE.txt).