defectdojo-importer 0.0.3__tar.gz

defectdojo_importer-0.0.3/CHANGELOG.md

@@ -0,0 +1 @@
+# Defectdojo-Importer Changelog

defectdojo_importer-0.0.3/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

defectdojo_importer-0.0.3/PKG-INFO

@@ -0,0 +1,296 @@
+Metadata-Version: 2.4
+Name: defectdojo-importer
+Version: 0.0.3
+Summary: DefectDojo Importer Tool
+License: Apache-2.0
+License-File: LICENSE
+Keywords: DefectDojo
+Author: Azunna Ikonne
+Author-email: ikonnea@gmail.com
+Maintainer: Azunna Ikonne
+Maintainer-email: ikonnea@gmail.com
+Requires-Python: >=3.9,<4
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: python-dotenv (>=1.1.1,<2.0.0)
+Requires-Dist: requests (>=2.32.5,<3.0.0)
+Project-URL: Repository, https://github.com/1azunna/defectdojo-importer
+Description-Content-Type: text/markdown
+
+# Defectdojo-importer
+
+DefectDojo Cli utility for importing scan findings.
+
+## Getting started
+
+### Installation
+
+Using pip
+```bash
+pip install defectdojo-importer
+```
+
+Using docker
+```
+docker build -t defectdojo-importer .
+```
+
+## Usage
+
+Command Usage
+
+```
+usage: defectdojo-importer [-h] [-f FILE] [-t {findings,languages}] [--api-url API_URL] [--api-key API_KEY] [--product-name PRODUCT_NAME]    
+                           [--product-type-name PRODUCT_TYPE_NAME] [--critical-product] [--product-platform PRODUCT_PLATFORM] [--engagement-name ENGAGEMENT_NAME]
+                           [--test-name TEST_NAME] [--test-type-name TEST_TYPE_NAME] [--static-tool] [--dynamic-tool] [--tool-configuration-name TOOL_CONFIGURATION_NAME] [--tool-configuration-params TOOL_CONFIGURATION_PARAMS] [--minimum-severity {Info,Low,Medium,High,Critical}]
+                           [--push-to-jira] [--close-old-findings] [--reimport] [--reimport-condition {default,branch,commit,build,pull_request}] 
+                           [--build-id BUILD_ID] [--commit-hash COMMIT_HASH] [--branch-tag BRANCH_TAG] [--scm-uri SCM_URI] [-v] [-i]
+                            ...
+
+Defect Dojo CI tool for importing scan findings
+
+options:
+  -h, --help            show this help message and exit
+
+Scan Import Configuration:
+  -f, --file FILE       File to import
+  -t, --import-type {findings,languages}
+                        Type of import: findings or languages, default is findings.
+
+DefectDojo Configuration:
+  --api-url API_URL     DefectDojo API URL
+  --api-key API_KEY     DefectDojo API Key
+  --product-name PRODUCT_NAME
+                        Product name
+  --product-type-name PRODUCT_TYPE_NAME
+                        Product type name
+  --critical-product    Is product critical?
+  --product-platform PRODUCT_PLATFORM
+                        Product platform
+
+Test Configuration:
+  --engagement-name ENGAGEMENT_NAME
+                        Engagement name
+  --test-name TEST_NAME
+                        Test name
+  --test-type-name TEST_TYPE_NAME
+                        Test type name
+  --static-tool         Is static tool?
+  --dynamic-tool        Is dynamic tool?
+  --tool-configuration-name TOOL_CONFIGURATION_NAME
+                        Tool configuration name
+  --tool-configuration-params TOOL_CONFIGURATION_PARAMS
+                        Additional tool configuration parameters as comma-separated values. Max of 3 parameters.
+
+Scan Settings:
+  --minimum-severity {Info,Low,Medium,High,Critical}
+                        Minimum severity level
+  --push-to-jira        Push to Jira?
+  --close-old-findings  Close old findings?
+  --reimport            Reimport findings instead of creating a new test
+  --reimport-condition {default,branch,commit,build,pull_request}
+                        Condition for reimporting findings
+
+Build/CI Information:
+  --build-id BUILD_ID   Build ID
+  --commit-hash COMMIT_HASH
+                        Commit hash
+  --branch-tag BRANCH_TAG
+                        Branch or tag
+  --scm-uri SCM_URI     SCM URI
+
+General Options:
+  -v, --verbose         Enable verbose/debug logging.
+  -i, --insecure        Disable ssl verification.
+
+Sub-commands:
+  
+    integration         Import findings from supported external integrations
+```
+
+### Import findings from a file
+```bash
+defectdojo-importer --api-url <defectdojo url> --api-key <apikey> --product-name myapp --product-type-name webapps --test-type-name "ESLint Scan" -f eslint-report.json
+```
+
+### Import findings from existing tool configuration
+```bash
+defectdojo-importer --api-url <defectdojo url> --api-key <apikey> --product-name myapp --product-type-name webapps --test-type-name "SonarQube API Import" --tool-configuration-name "<Sonarqube tool config name>" --tool-configuration-params "Sonar_Project-key,Sonar-org"
+```
+
+### Import lines of code report
+
+See: https://defectdojo.github.io/django-DefectDojo/integrations/languages/
+
+```bash
+defectdojo-importer --api-url <defectdojo url> --api-key <apikey> --product-name myapp --product-type-name webapps -t languages -f cloc.json import-languages
+```
+
+All supported test types can be found here: https://github.com/DefectDojo/django-DefectDojo/tree/master/dojo/tools
+
+
+## Integrations
+
+Defectdojo importer also supports integrating with external tools to push findings into defectdojo. The only available integration at the moment is [OWASP Dependency Track](https://docs.dependencytrack.org/integrations/defectdojo/)
+
+```bash
+defectdojo-importer integration dtrack --api-url <defectdojo url> --api-key <apikey> --product-name myapp --product-type-name webapps --dtrack-api-url <dependency-track url> --dtrack-api-key <dependency-track apikey>
+```
+
+See `defectdojo-importer integration dtrack --help` for additional options. 
+If you would like to support a tool you are using, please open an issue.
+
+
+## Pipeline Usage
+
+Defectdojo-importer tries to detect the following attributes when running in a CI environment:
+  - branch or tag name
+  - commit hash
+  - pull request id
+  - pipeline job/build id
+  - repository url
+
+See: [src/common/utils.py](./src/common/utils.py#L44)
+
+### Environment variables
+
+You can configure the importer using environment variables and dotenv files (.env, .env.defectdojo). 
+The variable pattern is as follows: `DD_<cli argument with underscores>`. For example `DD_API_URL`, `DD_API_KEY`. 
+For Debug mode, use `DD_DEBUG` or the `-v/--verbose` cli argument.
+
+### Gitlab CI Usage
+
+Set the following parameters as protected variables.
+```
+DD_API_URL
+DD_API_KEY
+```
+
+Example usage with Gitlab SAST report
+```yaml
+include:
+  - template: Security/SAST.gitlab-ci.yml
+
+# some variables that can be generic
+variables:
+    DD_CLOSE_OLD_FINDINGS: "True"
+    DD_BUILD_ID: $CI_PIPELINE_ID
+    DD_COMMIT_HASH: $CI_COMMIT_SHA
+    DD_BRANCH_TAG: $CI_COMMIT_REF_NAME
+
+stages:
+    - test
+    - upload
+
+semgrep-sast:
+  stage: test
+  script:
+    - /analyzer run
+  rules:
+    - if: $SAST_DISABLED
+      when: never
+    - if: $SAST_EXCLUDED_ANALYZERS =~ /semgrep/
+      when: never
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH'
+      exists:
+        - '**/*.py'
+        - '**/*.js'
+        - '**/*.jsx'
+        - '**/*.ts'
+        - '**/*.tsx'
+        - '**/*.c'
+        - '**/*.go'
+
+upload_semgrep:
+  stage: upload
+  image: zunni/defectdojo-importer:0.0.1-dev
+  needs:
+    - job: semgrep-sast
+      artifacts: true  
+  variables:
+    GIT_STRATEGY: none
+    DD_PRODUCT_TYPE_NAME: $CI_PROJECT_ROOT_NAMESPACE
+    DD_PRODUCT_NAME: $CI_PROJECT_NAME 
+    DD_TEST_NAME: "Semgrep Scan"
+    DD_TEST_TYPE_NAME: "GitLab SAST Report"
+    DD_ENGAGEMENT_NAME: "SAST Engagement"
+    DD_PUSH_TO_JIRA: "False"
+    DD_STATIC_TOOL: "True"
+    DD_DYNAMIC_TOOL: "False"
+    DD_MINIMUM_SEVERITY: "Info"
+    DD_CLOSE_OLD_FINDINGS: "True"
+    DD_REIMPORT: "True"
+    DD_REIMPORT_CONDITION: "branch"
+
+  script:
+    - defectdojo-importer -f gl-sast-report.json -t findings
+
+```
+
+## Authors and acknowledgment
+- Azunna Ikonne <ikonnea@gmail.com>
+
+## Contributing
+
+Open a pull request.
+
+### Development Guide
+
+#### Prerequisites
+
+1. Install poetry
+
+```bash
+pip install poetry
+```
+
+2. Setup a python virtual environment using poetry
+
+```bash
+poetry config virtualenvs.in-project true
+poetry install
+```
+
+#### Step 1: Setup Githooks
+
+```bash
+poetry add --dev autohooks autohooks-plugin-black autohooks-plugin-pylint autohooks.plugins.pytest
+poetry run autohooks activate --mode poetry
+poetry run autohooks plugins add autohooks.plugins.black autohooks.plugins.pylint autohooks.plugins.pytest
+```
+
+#### Step 2: Checkout to a Gitflow Branch
+
+```bash
+git checkout -b ^(feature|bugfix|hotfix|chore|support|release).*
+```
+
+#### Step 3: Commit Messages
+
+Commit your changes using conventional commits syntax
+```bash
+git add .
+git commit  -s -a -m "(feat:|fix:|build:|chore:|ci:|docs:|style:|refactor:|perf:|test:) <message>"
+git push
+```
+
+#### Step 4: Test the cli locally
+
+Test your changes locally
+```bash
+poetry install
+poetry run defectdojo-importer <commands>
+```
+
+#### Step 5: Open a Merge Request
+
+Open a merge request targeting the main branch.
+