tonghuaroot · pull · Feb 26, 2025 · Feb 26, 2025 · Feb 26, 2025 · Feb 26, 2025
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this
+
+---
+
+**What's the problem this feature will solve?**
+<!-- What are you trying to do, that you are unable to achieve with faraday as it currently stands? -->
+
+**Describe the solution you'd like**
+<!-- Clear and concise description of what you want to happen. -->
+
+<!-- Provide examples of real world use cases that this would enable and how it solves the problem described above. -->
+
+**Alternative Solutions**
+<!-- different approach to solving this issue? Please elaborate here. -->
+
+**Additional context**
+<!-- Add any other context, links, etc. about the feature here. -->
diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md
@@ -0,0 +1,66 @@
+---
+name: Bug report
+about: Create a report an issue
+
+---
+
+Please search the [Wiki](https://github.com/infobyte/faraday/wiki) for a solution before posting a ticket. Use the <strong>“New Support Request”</strong> button to the right of the screen to submit a ticket for technical support.
+
+## Issue Type
+ - Bug Re port
+ - Feature Idea
+ - Documentation Report
+
+
+## Faraday version
+
+Paste the output of the *./faraday.py --version* command
+
+## Component Name
+
+If you know where the problem lays indicate it:
+WebGui/GTKGui/Plugin/Console/Continuous Scanning/Etc.
+
+## Steps to reproduce
+
+Provide detailed steps on how the issue happened so we can try to reproduce it. If the issue is random, please provide as much information as possible.
+
+## Expected results
+
+What did you expect to happen when following the steps above?
+
+### Debugging tracebacks (current results)
+
+Try to reproduce the bug with the server and/or gtk client in debug mode and check the logs for the ERROR string.
+Add here any errors you find while running in debug mode or, if possible, Faraday’s log files (located at *$HOME/.faraday/logs/*).
+
+If you need help on how to execute in debug mode [click here for more information](https://github.com/infobyte/faraday/wiki/troubleshooting).
+
+Please attach the result of:
+
+pip freeze > requirements_freeze.txt
+
+### Screenshots
+
+If you don't find anything on the logs, please provide screenshots of the error.
+
+## Environment information
+
+### Configuration files
+
+Mention any settings you have changed/added/removed.
+
+### Reports/Extra data
+
+If you are having issues with plugins, please attach relevant files if possible.
+(strip your reports of all sensitive information beforehand).
+
+### OS
+
+Provide information on your operating system. Example:
+
+$ cat /etc/lsb-release
+DISTRIB_ID=Ubuntu
+DISTRIB_RELEASE=16.10
+DISTRIB_CODENAME=yakkety
+DISTRIB_DESCRIPTION="Ubuntu 16.10"
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,7 @@
 *.egg-info
 dist
 build
+.eggs
 eggs
 parts
 var
@@ -25,6 +26,8 @@ pip-log.txt
 .coverage
 .tox
 nosetests.xml
+tests/.cache/
+tests/htmlcov/
 
 # Translations
 *.mo
@@ -59,4 +62,28 @@ jsconfig.json
 .idea
 
 # vFeed DB
-data/vfeed.db
+data/vfeed.db
+
+# Images based on DB Schema
+entity_dbschema.png
+uml_schema.png
+
+# Documentation builds
+doc/_build/
+scripts/searcher/log/searcher.log
+stream.svg
+scripts/searcher/output/searcher.db
+.pytest_cache
+reports/executive/outputs/scope.docx
+
+# Editable install hoook
+_install
+faraday_plugins/
+faraday/frontend/
+.cache
+
+## OSX files
+.DS_Store
+
+# nix build
+result
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -0,0 +1,69 @@
+variables:
+  TZ: "America/New_York"
+  # Configure postgres service (https://hub.docker.com/_/postgres/)
+  POSTGRES_DB: custom_db
+  POSTGRES_USER: custom_user
+  POSTGRES_PASSWORD: custom_pass
+  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+  APT_CACHE_DIR: "$CI_PROJECT_DIR/apt-cache"
+  DEBIAN_FRONTEND: noninteractive
+  IMAGE_TAG: 'egrep -o "[0-9]\.([0-9]|[0-9][0-9])(\.[0-9])?" faraday/__init__.py'
+  AWS_FRONT_BRANCH: 'community/dev'
+  VAULT_SERVER_URL: https://tluav-lb.faradaysec.com
+  VAULT_AUTH_ROLE: faraday-env-readonly
+  VAULT_AUTH_PATH: jwt
+  FOLDER: master
+
+workflow:
+  rules:
+    - if: $CI_MERGE_REQUEST_ID
+      when: never
+    - when: always
+
+cache:
+  paths:
+    - "$CI_PROJECT_DIR/.cache/pip"
+    - "$CI_PROJECT_DIR/apt-cache"
+
+before_script:
+    - mkdir -pv $APT_CACHE_DIR
+
+include:
+  - local: .gitlab/ci/get-secrets.yml
+  - local: .gitlab/ci/.rules-conditions.yml
+
+  - local: .gitlab/ci/testing/.pretesting-gitlab-ci.yml
+  - local: .gitlab/ci/testing/.nix-testing-gitlab-ci.yml
+  - local: .gitlab/ci/testing/.venv-testing-gitlab-ci.yml
+  - local: .gitlab/ci/testing/.hypothesis-nix-gitlab-ci.yml
+  # - local: .gitlab/ci/testing/.posttesting-gitlab-ci.yml
+
+  - local: .gitlab/ci/build-ci/.prebuild-gitlab-ci.yml
+  - local: .gitlab/ci/build-ci/.build-gitlab-ci.yml
+  - local: .gitlab/ci/build-ci/.testing-gitlab-ci.yml
+
+  - local: .gitlab/ci/upload/.storage-gitlab-ci.yml
+
+  - local: .gitlab/ci/deploy/deploy-gitlab-ci.yml
+
+  - local: .gitlab/ci/publish/.set-tag-gitlab-ci.yml
+  - local: .gitlab/ci/publish/.mirror-to-github-gitlab-ci.yml
+  - local: .gitlab/ci/publish/.docker-publish-gitlab-ci.yml
+
+  - template: Security/Secret-Detection.gitlab-ci.yml
+
+stages:
+    - pre_testing
+    - test
+    # - post_testing
+    - pre_build
+    - build
+    - build_testing
+    - upload
+    - upload_testing
+    - deploy
+    - publish
+
+services:
+    - postgres:latest
+    - redis:latest
diff --git a/.gitlab/ci/.rules-conditions.yml b/.gitlab/ci/.rules-conditions.yml
@@ -0,0 +1,67 @@
+# When should run
+.dev-staging-master:
+  rules:
+    - if: '$CI_COMMIT_REF_NAME =~ /^.*\/(master|staging|dev)$/'
+      when: on_success
+
+.on-master-staging:
+  rules:
+    - if: '$CI_COMMIT_REF_NAME =~ /^.*\/(master|staging)$/'
+      when: on_success
+
+.on-staging:
+  rules:
+    - if: '$CI_COMMIT_REF_NAME =~ /^.*\/(staging)$/'
+      when: on_success
+
+.on-master:
+  rules:
+    - if: '$CI_COMMIT_REF_NAME =~ /^.*\/(master)$/'
+      when: on_success
+
+.on-community-tag:
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^white-v[0-9.]+$/'
+      when: on_success
+
+.pipeline-control-test:
+  rules:
+    - if: $FULL_TEST || $DAILY_TEST
+      when: on_success
+
+.be-built:
+  rules:
+    - if: '$CI_COMMIT_TAG || $BUILD_TEST || $FULL_TEST || $DAILY_TEST'
+      when: on_success
+
+.be-uploaded:
+  rules:
+    - if: '$BUILD_TEST || $FULL_TEST || $DAILY_TEST'
+      when: on_success
+
+
+# Ignore
+.ignore-on-tag:
+  rules:
+    - if: '$CI_COMMIT_TAG'
+      when: never
+
+.ignore-on-master:
+  rules:
+    - if: '$CI_COMMIT_REF_NAME =~ /^.*\/(master)$/'
+      when: never
+
+.ignore-on-staging:
+  rules:
+    - if: '$CI_COMMIT_REF_NAME =~ /^.*\/(staging)$/'
+      when: never
+
+.ignore-on-build:
+  rules:
+    - if: $BUILD_TEST
+      when: never
+
+.update_docker:
+  rules:
+    - if: $UPDATE_DOCKER_TEST
+      when: on_success