Giter VIP home page Giter VIP logo

nrd-db's Introduction

Contributors Forks Stargazers Issues


Logo

NRD-db

Welcome to the NRD-db (Newly Registered Domains with Redis) GitHub repository! NRD-db is a Docker image designed to automatically fetch and store newly registered domains in a Redis database. It simplifies the process of populating a Redis database with up-to-date domain information, making it a great fit for use with Arkime's WISE tagging.

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Variables
  4. Usage
  5. Roadmap
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgments

About The Project

The primary objective of NRD-db is to provide an automated solution for keeping your Redis database up-to-date with newly registered domains. Searching through local text files for specific domains can be inefficient, and that's where NRD-db comes in. It fetches domain data from the WhoisDS service and stores it in a Redis database, allowing you to access this information efficiently. Product Name Screen Shot

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Before you begin, ensure that you have the following dependencies installed:

  • Docker
    sudo apt install docker-ce -g
    NOTE: To avoid using sudo for docker activities, add your username to the Docker Group
    sudo usermod -aG docker ${USER}

Installation

You can build and run the NRD-db Docker container using the following commands:

  1. Clone the repo
    git clone https://github.com/StrackVibes/NRD-db.git
  2. Build the Docker image
    cd NRD-db
    docker build -t nrd-db .

(back to top)

Variables

You can customize the NRD fetching and storage process by setting environment variables with the docker '--env' argument or permanently in the NRD.sh script. Here are the available variables:

NAME DEFAULT VALUE NOTES
DIR /opt/nrd The directory where NRD-db stores files and data.
DAY_RANGE 1 The number of days you want to fetch newly registered domains for.
DAILY_DIR /tmp/daily The directory where NRD-db stores temporary daily domain data files.
TEMP_FILE /tmp/nrd The path to the temporary file used during domain data retrieval.
PAID_WHOISDS_USERNAME Your WhoisDS username for accessing paid data (if applicable)
PAID_WHOISDS_PASSWORD Your WhoisDS password for accessing paid data (if applicable)
BASE_URL_FREE Free The base URL for fetching newly registered domain data for free.
BASE_URL_PAID Paid The base URL for fetching newly registered domain data with your WhoisDS paid credentials.

(back to top)

Usage

Note: By default, The docker container will pull the NRDs at 0800 UTC according to the cronjob.

After configuring the environment variables, simply run the NRD-db Docker container, and it will start fetching newly registered domains based on the default variables in nrd.sh.

docker run -d nrd-db

By default, NRD-db is set to fetch NRD data for the last 1 day. You can adjust the DAY_RANGE variable to specify a different day range.

docker run -d nrd-db --env DAY_RANGE=10

You can use the PAID_WHOISDS_USERNAME and PAID_WHOISDS_PASSWORD variables if you have a paid WhoisDS subscription. If not, the tool will use the free data source by default.

docker run -d nrd-db --env PAID_WHOISDS_USERNAME=ThreatHunter --env PAID_WHOISDS_PASSWORD=NeRD

With this docker-compose.yml example, you can easily launch the NRD-db service with following:

version: '3'

services:
nrd:
  image: nrd
  build: ./Dockerfile
  container_name: nrd
  restart: always
  ports:
    - "6379:6379"
  volumes:
    - ./nrd/:/root/redis
    - ./nrd/redis.conf:/usr/local/etc/redis/redis.conf
    - ./nrd/collection/:/opt/nrd/
  environment:
    - REDIS_PASSWORD=my-password
    - REDIS_PORT=6379
    - REDIS_DATABASES=1

(back to top)

Roadmap

  • Scheduled Updates
  • Improved Logging
  • Retireve ...
    • DNS Record(s) Information
    • IP2ASN Information
    • WHOIS Information
    • Reverse WHOIS (by Name) Information
    • Certficates
    • VirusTotal Information

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the Chicken Dance License. See LICENSE.md for more information.

(back to top)

Contact

Shane Strack - @inshane09

Project Link: https://github.com/StrackVibes/NRD-db

(back to top)

Acknowledgments

(back to top)

nrd-db's People

Contributors

strackvibes avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.