Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ehsandeep committed Jul 14, 2023
0 parents commit f73190e
Show file tree
Hide file tree
Showing 7 changed files with 7,368 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
commit-message:
prefix: "chore"
include: "scope"
labels:
- "Type: Maintenance"
36 changes: 36 additions & 0 deletions .github/workflows/yaml2json.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: 📝 Convert YAML to JSON

on:
push:
paths:
- 'QUERIES.yaml'
workflow_dispatch:

jobs:
convert:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@master
with:
fetch-depth: 0

- name: Convert YAML to JSON
run: |
sudo apt-get install -y python3-pip
pip3 install pyyaml
python3 -c "import sys, yaml, json; json.dump(yaml.safe_load(sys.stdin), sys.stdout, indent=2)" < QUERIES.yaml > QUERIES.json
- name: Check if there are changes
id: change
run: |
git add QUERIES.json
git status -s | wc -l | xargs -I {} echo CHANGES={} >> $GITHUB_OUTPUT
- name: Commit and push if it changed
if: steps.change.outputs.CHANGES > 0
run: |
git config --global user.email "[email protected]"
git config --global user.name "GitHub Action"
git commit -am "Auto YAML to JSON update [$(date)] :robot:" --allow-empty
git push
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## How to Contribute

Contributions to this project are welcome and appreciated. You can contribute by adding new search queries for existing products or by adding new products altogether. Here's how you can do it:

1. **Fork the Repository**: The first step to contributing is to fork the repository to your own GitHub account. This creates your own copy of the entire project, which you can edit as you see fit.

2. **Clone the Repository**: After forking, you'll want to clone the repository to your local machine. This allows you to make changes to the files on your computer.

3. **Find the Relevant YAML File**: Inside this file, you'll find a list of products and associated search queries for each supported search engine.

4. **Make Your Changes**: Add your new search query to the appropriate place in the YAML file. If you're adding a new product, you'll need to create a new entry in the file. Here's an example structure:

```yaml
- name: product_name
type: product #product, honeypot, service etc.
engines:
- platform: search_engine_name # shodan, censys, fofa, hunter, quake, zoomeye, netlas, criminalip, publicwww, hunterhow, google
queries:
- 'your_search_query'
- 'your_search_query_2'
```

5. **Commit and Push Your Changes**: Once you've made your changes, you'll need to commit them to your local repository and then push them to your forked repository on GitHub.

6. **Create a Pull Request**: Finally, you'll need to create a pull request to have your changes merged into the main project. This is essentially a request to the project maintainer to pull your changes into the main repository.

---

This guide assumes a basic familiarity with Git and GitHub. If you're new to these tools, there are many great resources available online to help you get started.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 ProjectDiscovery

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit f73190e

Please sign in to comment.