Compare commits

...

3 commits

Author SHA1 Message Date
ImSavsis
115091ae2b chore: update profile links to devsavsis 2026-08-18 05:09:08 +05:00
ce2aadb67e chore: badges + point profile links at devsavsis 2026-08-18 02:30:56 +05:00
ImSavsis
8f78c8aaac docs: quickstart, api reference, faq 2026-07-19 23:23:04 +05:00
6 changed files with 140 additions and 8 deletions

View file

@ -1,11 +1,11 @@
# pydoh
[![CI](https://github.com/ImSavsis/pydoh/actions/workflows/ci.yml/badge.svg)](https://github.com/ImSavsis/pydoh/actions/workflows/ci.yml)
[![CI](https://github.com/devsavsis/pydoh/actions/workflows/ci.yml/badge.svg)](https://github.com/devsavsis/pydoh/actions/workflows/ci.yml)
[![Coverage](https://codecov.io/gh/ImSavsis/pydoh/branch/master/graph/badge.svg)](https://codecov.io/gh/ImSavsis/pydoh)
[![pypi](https://img.shields.io/pypi/v/pydoh.svg)](https://pypi.org/project/pydoh/)
[![downloads](https://img.shields.io/pypi/dm/pydoh.svg)](https://pypi.org/project/pydoh/)
[![versions](https://img.shields.io/pypi/pyversions/pydoh.svg)](https://pypi.org/project/pydoh/)
[![license](https://img.shields.io/github/license/ImSavsis/pydoh.svg)](https://github.com/ImSavsis/pydoh/blob/master/LICENSE)
[![license](https://img.shields.io/github/license/ImSavsis/pydoh.svg)](https://github.com/devsavsis/pydoh/blob/master/LICENSE)
DNS-over-HTTPS резолвер для питона. ноль зависимостей — весь HTTPS через стандартный `http.client`+`ssl`. провайдер/DPI видит только твой HTTPS к cloudflare, а не голые DNS-запросы.
@ -38,6 +38,12 @@ import pydoh
pydoh.patch_socket()
```
## документация
- [quickstart](docs/quickstart.md) — установка, базовое использование, свой провайдер
- [api](docs/api.md) — все функции с параметрами
- [faq](docs/faq.md) — зачем это надо, что делать если cloudflare забанят, законно ли
## фичи
- zero deps, только stdlib

38
docs/api.md Normal file
View file

@ -0,0 +1,38 @@
# api
## `resolve(hostname, record_type=1, providers=None, timeout=3.0, use_cache=True) -> list[str]`
резолвит хост, возвращает список IP строками. кидает `ResolveError` если все провайдеры упали.
- `record_type` — `1` для A (по умолчанию), `28` для AAAA
- `providers` — список `Provider`, по умолчанию `pydoh.providers.DEFAULT_PROVIDERS` (cloudflare, google, quad9 по порядку)
- `timeout` — секунды на один HTTPS-запрос к одному провайдеру
- `use_cache` — читать/писать во внутренний кэш по TTL из ответа
## `resolve4(hostname, **kwargs) -> list[str]`
то же самое что `resolve(hostname, record_type=1, **kwargs)`.
## `resolve6(hostname, **kwargs) -> list[str]`
то же самое что `resolve(hostname, record_type=28, **kwargs)`.
## `patch_socket() -> None`
подменяет `socket.getaddrinfo` на версию через `resolve()`. IP-литералы (`127.0.0.1` и т.п.) пропускает мимо DoH напрямую. идемпотентно — повторный вызов ничего не ломает.
## `unpatch_socket() -> None`
возвращает оригинальный `socket.getaddrinfo`.
## `ResolveError`
исключение, вылетает из `resolve()`/`resolve4()`/`resolve6()` если ни один провайдер не ответил валидно.
## `pydoh.providers.Provider`
```python
Provider(name: str, host: str, path: str)
```
именованный tuple, описывает DoH-эндпоинт. готовые: `pydoh.CLOUDFLARE`, `pydoh.GOOGLE`, `pydoh.QUAD9`.

25
docs/faq.md Normal file
View file

@ -0,0 +1,25 @@
# faq
## зачем это вообще
обычный DNS — незашифрованный UDP-пакет к резолверу провайдера, кто угодно на пути видит какой домен ты спрашиваешь. в РФ это самый дешёвый способ блокировки — провайдер просто не отвечает на запрос про заблокированный домен. DoH заворачивает тот же запрос в HTTPS, провайдер видит только "коннект к 1.1.1.1", а не имя домена.
## cloudflare тоже забанен, что делать
сам cloudflare (его IP-диапазоны) массово не блокируют — через него живёт куча обычных сайтов, задеть его целиком означает положить половину интернета. а вот конкретно `cloudflare-dns.com` как известный анти-цензурный эндпоинт — уже могут таргетить точечно по SNI.
если это произошло — `pydoh` сам едет на `dns.google`, потом на `dns.quad9.net` (см. `DEFAULT_PROVIDERS`), без твоего участия.
если и туда достанут — тогда нужен свой DoH-эндпоинт на домене, которого нет в блок-листах, см. [quickstart.md](quickstart.md#свой-doh-провайдер).
## а это законно
`pydoh` просто шлёт DNS-запросы другим транспортом (HTTPS вместо UDP). это тот же протокол, который сейчас включён по умолчанию в Firefox/Chrome для миллионов пользователей.
## почему не requests/httpx
zero deps — библиотека не тянет вообще ничего кроме stdlib. весь HTTPS через `http.client`+`ssl`, которые уже есть в питоне из коробки.
## поддерживает DNSSEC?
нет. и не планируется — это резолвер для обхода блокировок и приватности, а не для валидации подписей.

63
docs/quickstart.md Normal file
View file

@ -0,0 +1,63 @@
# quickstart
## установка
```
pip install pydoh
```
## разовый резолвинг
```python
import pydoh
ips = pydoh.resolve("example.com")
print(ips) # ['93.184.216.34']
```
`resolve()` возвращает список строк-адресов, первый обычно и есть тот, что нужен.
## ipv6
```python
ips = pydoh.resolve6("example.com")
```
или через параметр:
```python
pydoh.resolve("example.com", record_type=28)
```
## подменить резолвинг во всём приложении
самый частый кейс — не переписывать код, а просто подменить как питон резолвит домены:
```python
import pydoh
pydoh.patch_socket()
import requests
requests.get("https://example.com") # уже через DoH, без изменений в коде requests
```
ставь `patch_socket()` в самом начале скрипта, до импорта/использования сетевых библиотек.
вернуть как было:
```python
pydoh.unpatch_socket()
```
## свой DoH-провайдер
если хочешь резолвить через свой сервер, а не через cloudflare/google/quad9:
```python
from pydoh.providers import Provider
my_provider = Provider(name="mine", host="doh.example.com", path="/dns-query")
ips = pydoh.resolve("example.com", providers=[my_provider])
```
сервер должен поддерживать [RFC 8484](https://www.rfc-editor.org/rfc/rfc8484) (`POST` с телом `application/dns-message`).

View file

@ -6,10 +6,10 @@ Pure standard library, uses http.client and ssl for the HTTPS leg. Falls back ac
## Docs
- [README](https://github.com/ImSavsis/pydoh/blob/master/README.md): install, usage, feature list
- [src/pydoh/resolver.py](https://github.com/ImSavsis/pydoh/blob/master/src/pydoh/resolver.py): core resolve logic with provider fallback and caching
- [src/pydoh/patch.py](https://github.com/ImSavsis/pydoh/blob/master/src/pydoh/patch.py): socket.getaddrinfo monkeypatch
- [src/pydoh/wire.py](https://github.com/ImSavsis/pydoh/blob/master/src/pydoh/wire.py): minimal DNS wire format encode/decode
- [README](https://github.com/devsavsis/pydoh/blob/master/README.md): install, usage, feature list
- [src/pydoh/resolver.py](https://github.com/devsavsis/pydoh/blob/master/src/pydoh/resolver.py): core resolve logic with provider fallback and caching
- [src/pydoh/patch.py](https://github.com/devsavsis/pydoh/blob/master/src/pydoh/patch.py): socket.getaddrinfo monkeypatch
- [src/pydoh/wire.py](https://github.com/devsavsis/pydoh/blob/master/src/pydoh/wire.py): minimal DNS wire format encode/decode
## Notes

View file

@ -23,8 +23,8 @@ classifiers = [
]
[project.urls]
Homepage = "https://github.com/ImSavsis/pydoh"
Issues = "https://github.com/ImSavsis/pydoh/issues"
Homepage = "https://github.com/devsavsis/pydoh"
Issues = "https://github.com/devsavsis/pydoh/issues"
[project.optional-dependencies]
dev = ["pytest", "pytest-cov", "build", "twine"]