Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noglitchyo/dealdoh
DNS-over-HTTPS proxy & client written in PHP to send DoH, DNSCrypt and GoogleDns queries
https://github.com/noglitchyo/dealdoh
dns dns-client dns-messaging dns-over-https dns-over-tls dns-protocols dns-proxy dns-proxy-server dns-queries dns-resolver dnscrypt dnscurve doh google-dns ietf-doh library php rfc-1035 rfc-8484
Last synced: 3 months ago
JSON representation
DNS-over-HTTPS proxy & client written in PHP to send DoH, DNSCrypt and GoogleDns queries
- Host: GitHub
- URL: https://github.com/noglitchyo/dealdoh
- Owner: noglitchyo
- License: mit
- Created: 2019-05-30T18:47:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-02T17:40:06.000Z (over 4 years ago)
- Last Synced: 2024-11-11T17:27:54.782Z (3 months ago)
- Topics: dns, dns-client, dns-messaging, dns-over-https, dns-over-tls, dns-protocols, dns-proxy, dns-proxy-server, dns-queries, dns-resolver, dnscrypt, dnscurve, doh, google-dns, ietf-doh, library, php, rfc-1035, rfc-8484
- Language: PHP
- Homepage:
- Size: 277 KB
- Stars: 16
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-psr15-middlewares - noglitchyo/dealdoh - Handle [DoH](https://tools.ietf.org/html/rfc8484) (DNS-over-HTTPS) messages. (Packages / Miscellaneous)
README
# Dealdoh
> Play with DNS over HTTPS and much more!
Dealdoh is a DNS-over-HTTPS (DoH) proxy and a library around DNS messaging written in PHP.
[](https://travis-ci.org/noglitchyo/dealdoh)
[](https://codecov.io/gh/noglitchyo/dealdoh)
## Overview
This library gives ability to proxy DoH requests and/or to send DNS queries with standard UDP/TCP and various modern and secure DNS protocols like DNSCrypt, DNS-over-HTTPS (DoH), GoogleDNS.
It attempts to achieve the following goals:
- provide high-compatibility with a large variety of DNS protocols.
- provide a well-designed abstraction layer for development around DNS in PHP.
## Features
- [x] DoH proxy middleware PSR-15/PSR-7 compliant.
- [x] Create and forward DNS messages to different type of DNS upstream resolvers.
- [x] Forward DNS query through multiple DNS upstream resolvers.
- [x] Compatible with DNS protocols: RFC-1035 (Plain DNS over TCP/UDP), RFC-8484 (DoH), Google DoH API, DNSCrypt
- [x] Abstraction layer around DNS development.
- [x] Parse [DNS stamps](https://dnscrypt.info/stamps-specifications)
## Client
[dealdoh-client](https://github.com/noglitchyo/dealdoh-client/) is a CLI utility which offers a ready-to-use implementation
of this library to send and forward DNS queries.
## Library
#### Requirements
- PHP 7.3
- Web server
- Optional: HTTPS enabled with valid certificates (self-signed certificates can work but it depends of the DOH client making the queries)
#### Installation
- Run `composer require noglitchyo/dealdoh`
- `DohResolverMiddleware::forward()` method consumes PSR-7 ServerRequest.
Some compatible implementations which can be used:
* https://github.com/Nyholm/psr7 - `composer require nyholm/psr7`
* https://github.com/guzzle/psr7 - `composer require guzzle/psr7`
* https://github.com/zendframework/zend-diactoros - `composer require zendframework/zend-diactoros`
- Configure your application to call `DohResolverMiddleware::forward()`
- Testing the installation
As recommended in RFC-8484, usually, DoH client/server will send/receive DNS requests on the path: `/dns-query`.
Your application should be configured to listen on this route.
A large variety of DoH client exists than can be used to test the installation.
* [dealdoh-client](https://github.com/noglitchyo/dealdoh-client/)
* [Facebook Experimental](https://github.com/facebookexperimental/doh-proxy)
* Using client from Web Browser
Mozilla Firefox provides a [Trusted Recursive Resolver](https://wiki.mozilla.org/Trusted_Recursive_Resolver) who can be configured to query DoH servers.
[This article from Daniel Stenberg](https://daniel.haxx.se/blog/2018/06/03/inside-firefoxs-doh-engine/)
provides a lot of details about TRR and how to configure it.
Please check also [the browser implementations list](https://github.com/curl/curl/wiki/DNS-over-HTTPS#supported-in-browsers-and-clients).
#### Example
```php
forward(/* Expect a \Psr\Http\Message\RequestInterface object */);
```
#### More examples
Checkout some really simple integration examples to get a glimpse on how it can be done:
- [Slim Framework integration](examples/slim-integration/README.md)
- [DoH + Docker + DNS + Hostname Discovery](examples/docker-firefox/README.md)
- [dealdoh-client](https://github.com/noglitchyo/dealdoh-client/)
## Testing
If you wish to run the test, checkout the project and run the test with:
`composer test`
## Contributing
Get started here [CONTRIBUTING.md](CONTRIBUTING.md).
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* https://github.com/reactphp/dns
* https://github.com/mageddo/dns-proxy-server
* https://github.com/facebookexperimental/doh-proxy
* https://github.com/DNSCrypt/dnscrypt-proxy
## References
- [RFC-8484](https://tools.ietf.org/html/rfc8484)
- [RFC-1035](https://tools.ietf.org/html/rfc1035)
- [RFC-4501](https://tools.ietf.org/html/rfc4501)
- [RFC-7719](https://tools.ietf.org/html/rfc7719)
- [PSR-7](https://www.php-fig.org/psr/psr-7/)
- [PSR-15](https://www.php-fig.org/psr/psr-15/)
- [PSR-18](https://www.php-fig.org/psr/psr-18/)
- [DNSCrypt](https://dnscrypt.info/protocol)
- [DNS Stamps](https://dnscrypt.info/stamps-specifications)
- [Wiki page DNS-over-HTTPS from Curl](https://github.com/curl/curl/wiki/DNS-over-HTTPS)