ctxis / snitchdns

Database Driven DNS Server with a Web UI

Caution

This repo is unmaintained, visit https://github.com/sadreck/SnitchDNS for the latest version.

SnitchDNS

SnitchDNS is a database driven DNS Server with a Web UI, written in Python and Twisted, that makes DNS administration easier with all configuration changed applied instantly without restarting any system services.

One of its main features is the logging of all DNS queries allowing the discovery of network traffic endpoints, and it can also be used to implement canary tokens as it supports notifications via e-mail, web push, Slack, and Teams. Red teamers can also use SnitchDNS to monitor phishing domains for sandboxes, integrate with SIEM solutions, restrict responses to specific IP ranges, egress data via a DNS tunnel and catch-all domains, and more.

• Installation
  • Update to Latest Version
  • The Manual Way
  • The Ansible Way
  • The Docker Way
• Documentation
  • Screenshots
• Basic Features
• Use Cases
• Limitations
• Contributing
• Security
• Credits

Dependencies

• Python 3.6+

Installation

Please make sure you install using git rather than by downloading the repo manually.

• Update to Latest Version
• The Manual Way
• The Ansible Way
• The Docker Way

Documentation

For general documentation see here

Screenshots

For screenshots see here

Basic Features

• Database Driven.
  • Changes are reflected immediately on each DNS request.
  • Supported DBMS:
    • SQLite
    • MySQL / MariaDB
    • Postgres
• DNS Server
  • Support for common DNS Records.
    • A, AAAA, AFSDB, CNAME, DNAME, HINFO, MX, NAPTR, NS, PTR, RP, SOA, SPF, SRV, SSHFP, TSIG, TXT.
  • Catch-All Domains.
    • Ability to match any subdomain (no matter the depth) to a specific parent domain, for instance *.hello.example.com.
  • Unmatched Record Forwarding.
    • Functionality to intercept specific queries (ie only A and CNAME) and forward all other records to a third-party DNS server (ie Google).
  • Regular Expression matching.
• Tags and Aliases.
• IP Rules
  • Configure Allow/Block rules per domain.
• Notifications. Receive a notification when a domain is resolved, via:
  • E-mail
  • Web Push
  • Slack
  • Microsoft Teams
• User Management
  • Multi-User support
    • Each user is given their own subdomain to use.
  • LDAP/RADIUS Support
  • Two Factor Authentication
  • Password Complexity Management
• Logging
  • All DNS queries are logged, whether they have been matched or not.
  • CSV Logging for SIEM integration.
• Swagger 2.0 API
• Deployment
  • Ansible scripts for Ubuntu 18.04 / 20.04
  • Docker
  • CLI support for zone, record, user, and settings management.
  • CSV Export/Import

Use Cases

SnitchDNS can be used for:

• A DNS Forwarding Server - Allowing you to monitor all requests via a Web GUI.
• Red Teams - Implement IP restrictions to block sandboxes, monitor phishing domain resolutions and e-mails, and restrict access to known IP ranges.
• DNS Tunnel - Log all DNS requests and egress data.
• Let's Encrypt DNS Challenge, using the API or the CLI interface.
• Ad-blocking.
• Canary Tokens.
• Integrate with SIEM solutions.

For more details on scenarios please see the Use Cases Document

Limitations

• SnitchDNS currently runs in a single-thread, therefore may not be suitable for environments with hundreds of DNS requests per minute.

Contributing

If you wish to contribute pull requests, feature requests, and bug reports - feel free to raise an issue (especially before you start writing code).

Security

If you identify any security vulnerabilities within SnitchDNS, for the time being please contact me on twitter - @sadreck

Credits

UI

• Theme from Bootswatch
• Images from Freepik

Development

• Lambros Zannettos | @_C960_ - For his help with writing the Dockerfile.