├── LICENSE ├── README.md └── screenshot ├── api-token.png ├── plugin-config1.png ├── plugin-config2.png ├── plugin-install2.png ├── plugin-quick-fix.png ├── plugin-restart.png ├── plugin-result.png ├── plugin-sidebar-murphysec.jpeg └── plugin-start.png /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MurphySec Code Scan 2 | 3 | 4 | 5 | [![](https://badgen.net/badge/Github/murphysec-code-scan/21D789?icon=github)](https://github.com/murphysecurity/murphysec-jetbrains-plugin) 6 | ![Version](https://img.shields.io/jetbrains/plugin/v/18274?logo=JetBrains) 7 | ![Downloads](https://img.shields.io/jetbrains/plugin/d/18274?color=FE2857) 8 | ![Rating](https://img.shields.io/jetbrains/plugin/r/rating/18274?color=3EB811) 9 | 10 | [**MurphySec Code Scan**](https://plugins.jetbrains.com/plugin/18274-murphysec-code-scan) 是[墨菲安全](https://www.murphysec.com/)推出的一款 JetBrains IDE 插件。 11 | 12 | 13 | 该插件让开发者在 IDE 中即可检测代码依赖的安全问题，轻松识别代码中使用了哪些存在安全缺陷的开源组件，通过准确的修复方案和一键修复功能，快速解决安全问题。 14 | 15 | ### 支持功能 16 | 17 | 目前 Murphysec Code Scan 支持的功能如下： 18 | - 漏洞检测：检测 `Java(Maven)`、`JavaScript(npm)`、`Go(gomod)`、`Python(pip)` 代码中引入的缺陷组件 19 | - 一键修复：不仅有清晰的修复方案，还可以通过此功能快速修复 20 | - 实时检测：代码的依赖发生变化导致了安全问题，不用担心，插件会及时给您提醒进行处理 21 | 22 | 23 | > 注意 24 | > 此插件不支持2020.1之前版本的JetBrains IDE 25 | 26 | ## 安装插件 27 | - 打开 IDE 并进入插件市场 28 | - 在插件市场中搜索 “Murphysec Code Scan”，查看详情并安装 29 | 30 | 31 | ![plugin-install2](./screenshot/plugin-install2.png) 32 | 33 | 34 | ## 配置插件 35 | 1. 点击下方插件区域左侧的`设置`按钮，或点击引导中的`服务认证` 36 | 2. 在弹窗中输入您的访问令牌，也可以点击`快速认证`按钮按照引导完成认证。 37 | 38 | ![plugin-config1](./screenshot/plugin-config1.png) 39 | ![plugin-config2](./screenshot/plugin-config2.png) 40 | 41 | 42 | 43 | 44 | **配置参数说明：** 45 | 1. token：进入[墨菲安全控制台](https://www.murphysec.com/control/set)，点击“个人设置”，如下图所示： 46 | 47 | ![api-token](./screenshot/api-token.png) 48 | 2. 企业配置 - 服务地址：如果想使用墨菲安全私有化部署的服务，请填写服务地址（如果没有，可以不填写） 49 | ## 如何使用 50 | 51 | ### 开始扫描 52 | - 点击 IDE 下方菜单栏中的“MurphySec Code Scan”，选择`点击开始扫描` 53 | 54 | ![plugin-start](./screenshot/plugin-start.png) 55 | 56 | ### 查看扫描结果 57 | - 扫描完成后会在窗口内显示结果，可以点击左侧漏洞查看详细信息 58 | 59 | ![plugin-result](./screenshot/plugin-result.png) 60 | 61 | ### 修复 62 | 63 | - 点击检测结果中的组件，即可查看该缺陷组件的基本信息 64 | - 点击右侧“一键修复”，即可直接将该组件升级至“最小修复版本 65 | 66 | 点击下方的`一键修复`按钮，即可直接将该组件升级至最小修复版本 67 | 68 | ![plugin-quick-fix](./screenshot/plugin-quick-fix.png) 69 | 70 | ### 重新扫描 71 | - 点击插件左侧选项栏中的`绿色开始图标`，即可重新扫描 72 | 73 | ![plugin-restart](./screenshot/plugin-restart.png) 74 | 75 | 76 | ## 常见问题 77 | 78 | ### 1. 将插件从 sidebar 移除了，我要怎么检测？ 79 | 80 | - 点击菜单栏上的 `View` -> `Tool Windows` -> `MurphySec` ，插件将会重新出现在 sidebar 上 81 | ![plugin-sidebar](./screenshot/plugin-sidebar-murphysec.jpeg) -------------------------------------------------------------------------------- /screenshot/api-token.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/murphysecurity/murphysec-jetbrains-plugin/fb8871999df55f38ff5e793d319db0c73146d822/screenshot/api-token.png -------------------------------------------------------------------------------- /screenshot/plugin-config1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/murphysecurity/murphysec-jetbrains-plugin/fb8871999df55f38ff5e793d319db0c73146d822/screenshot/plugin-config1.png -------------------------------------------------------------------------------- /screenshot/plugin-config2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/murphysecurity/murphysec-jetbrains-plugin/fb8871999df55f38ff5e793d319db0c73146d822/screenshot/plugin-config2.png -------------------------------------------------------------------------------- /screenshot/plugin-install2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/murphysecurity/murphysec-jetbrains-plugin/fb8871999df55f38ff5e793d319db0c73146d822/screenshot/plugin-install2.png -------------------------------------------------------------------------------- /screenshot/plugin-quick-fix.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/murphysecurity/murphysec-jetbrains-plugin/fb8871999df55f38ff5e793d319db0c73146d822/screenshot/plugin-quick-fix.png -------------------------------------------------------------------------------- /screenshot/plugin-restart.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/murphysecurity/murphysec-jetbrains-plugin/fb8871999df55f38ff5e793d319db0c73146d822/screenshot/plugin-restart.png -------------------------------------------------------------------------------- /screenshot/plugin-result.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/murphysecurity/murphysec-jetbrains-plugin/fb8871999df55f38ff5e793d319db0c73146d822/screenshot/plugin-result.png -------------------------------------------------------------------------------- /screenshot/plugin-sidebar-murphysec.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/murphysecurity/murphysec-jetbrains-plugin/fb8871999df55f38ff5e793d319db0c73146d822/screenshot/plugin-sidebar-murphysec.jpeg -------------------------------------------------------------------------------- /screenshot/plugin-start.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/murphysecurity/murphysec-jetbrains-plugin/fb8871999df55f38ff5e793d319db0c73146d822/screenshot/plugin-start.png --------------------------------------------------------------------------------