{"id":26138417,"url":"https://github.com/darvaza-proxy/penne","last_synced_at":"2025-03-11T01:58:16.642Z","repository":{"id":213748062,"uuid":"734831947","full_name":"darvaza-proxy/penne","owner":"darvaza-proxy","description":"Penne is a pipeline driven DNS resolver","archived":false,"fork":false,"pushed_at":"2025-02-17T02:46:41.000Z","size":237,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-17T03:29:08.107Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://pkg.go.dev/darvaza.org/penne","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/darvaza-proxy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-22T18:45:09.000Z","updated_at":"2025-01-27T08:23:51.000Z","dependencies_parsed_at":"2024-02-02T20:30:56.291Z","dependency_job_id":"2cfa6e95-32f7-4431-9165-8319bbd75a3e","html_url":"https://github.com/darvaza-proxy/penne","commit_stats":null,"previous_names":["darvaza-proxy/penne"],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darvaza-proxy%2Fpenne","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darvaza-proxy%2Fpenne/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darvaza-proxy%2Fpenne/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darvaza-proxy%2Fpenne/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/darvaza-proxy","download_url":"https://codeload.github.com/darvaza-proxy/penne/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242956540,"owners_count":20212455,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-11T01:58:16.059Z","updated_at":"2025-03-11T01:58:16.632Z","avatar_url":"https://github.com/darvaza-proxy.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Penne, darvaza's DNS Resolver\n\n[![Go Reference][godoc-badge]][godoc]\n[![Go Report Card][goreport-badge]][goreport]\n\n[godoc]: https://pkg.go.dev/darvaza.org/penne\n[godoc-badge]: https://pkg.go.dev/badge/darvaza.org/penne.svg\n[goreport]: https://goreportcard.com/report/darvaza.org/penne\n[goreport-badge]: https://goreportcard.com/badge/darvaza.org/penne\n\n_Penne_ is a config-driven pipeline oriented DNS resolver that allows complex\nworkflows to be defined in a simple way.\n_Penne_ is built using the [darvaza sidecar engine][sidecar] and\nthe [darvaza resolver interface][resolver].\n\n[core]: https://pkg.go.dev/darvaza.org/core\n[resolver]: https://pkg.go.dev/darvaza.org/resolver\n[sidecar]: https://pkg.go.dev/darvaza.org/sidecar\n[slog]: https://pkg.go.dev/darvaza.org/slog\n\n[split-horizon]: https://en.wikipedia.org/wiki/Split-horizon_DNS\n\n[ohmyglob]: https://pkg.go.dev/github.com/pachyderm/ohmyglob\n[gobwasglob]: https://pkg.go.dev/github.com/gobwas/glob\n\n## Horizons\n\n_Penne_ is designed upon the idea of [_split horizons_][split-horizon],\nwhere DNS answers depend on the IP address of the client.\n\nA _Horizon_ is a named set of network patterns (aka `CIDR`) that can optionally\nchoose a custom `Resolver`,\nand can annotate or filter requests before passing them to the next _Horizon_ on\na chain.\n\n## Resolvers\n\nOn the config file you define a series of _resolvers_ in charge of\nhandling DNS requests.\nEach _Resolver_ has a unique _name_. Names are not case sensitive and allow unicode text.\n\n_Resolvers_ have three operation modes:\n\n* _Iterative_ goes to the root servers and iterates through authoritative\n  servers until the answer is found.\n* _Forwarder_  connects to a specific server to get the answer, optionally\n  allowing recursion to be performed remotely.\n* and _Chained_, where requests are passed to the _Next_ resolver, optionally modified.\n\n_Resolvers_ act as middlewares, optionally restricted to specific domains (suffixes).\n\n_Resolvers_ can also be configured to discard various entries (like `AAAA` for example)\nand execute request rewrites.\n\n## Globing\n\nWe use _globing_ instead of regular expressions for the name rewrites and suffix matching on _Resolvers_.\n\nFor this purpose we worked with [pachyderm's Oh my glob!][ohmyglob] library, which\nin turn was derived from the excellent [github.com/gobwas/glob][gobwasglob] with\nthe following syntax.\n\n```\npattern:\n    { term }\n\nterm:\n    `*`         matches any sequence of non-separator characters\n    `**`        matches any sequence of characters\n    `?`         matches any single non-separator character\n    `[` [ `!` ] { character-range } `]`\n                character class (must be non-empty)\n    `{` pattern-list `}`\n                pattern alternatives\n    c           matches character c (c != `*`, `**`, `?`, `\\`, `[`, `{`, `}`)\n    `\\` c       matches character c\n\ncharacter-range:\n    c           matches character c (c != `\\\\`, `-`, `]`)\n    `\\` c       matches character c\n    lo `-` hi   matches character c for lo \u003c= c \u003c= hi\n\npattern-list:\n    pattern { `,` pattern }\n                comma-separated (without spaces) patterns\n\ncapture:\n    `(` { `|` pattern } `)`\n    `@(` { `|` pattern } `)`\n                match and capture one of pipe-separated sub-patterns\n    `*(` { `|` pattern } `)`\n                match and capture any number of the pipe-separated sub-patterns\n    `+(` { `|` pattern } `)`\n                match and capture one or more of the pipe-separated sub-patterns\n    `?(` { `|` pattern } `)`\n                match and capture zero or one of the pipe-separated sub-patterns\n    `!(` { `|` pattern } `)`\n                match and capture anything except one of the pipe-separated sub-patterns\n```\n\nAnd for replacements `${n}` and `$n` to indicate the index on the capture slice inside a literal string.\n\n## Server\n\n_TBD ..._\n\n### Installation\n\n_TBD ..._\n\n### Configuration\n\n_TBD ..._\n\n### Run as service\n\n_TBD ..._\n\n## Web Interface\n\n_TBD ..._\n\n### Frontend\n\n_TBD ..._\n\n## See also\n\n* [JPI Technologies' Open Source Software](https://oss.jpi.io/)\n* [Split-horizon DNS (wikipedia)][split-horizon]\n* [darvaza.org/core][core]\n* [darvaza.org/resolver][resolver]\n* [darvaza.org/sidecar][sidecar]\n* [darvaza.org/slog][slog]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarvaza-proxy%2Fpenne","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarvaza-proxy%2Fpenne","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarvaza-proxy%2Fpenne/lists"}