{"id":37203330,"url":"https://github.com/qnib/doxy","last_synced_at":"2026-01-14T23:27:11.234Z","repository":{"id":57529246,"uuid":"100695984","full_name":"qnib/doxy","owner":"qnib","description":"Docker unix-socket proxy to provide unharmful, read-only API calls","archived":false,"fork":false,"pushed_at":"2018-03-10T18:51:30.000Z","size":1071,"stargazers_count":15,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-06-20T12:40:54.519Z","etag":null,"topics":["docker","docker-engine","golang","security"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qnib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-18T09:26:01.000Z","updated_at":"2023-11-25T16:18:20.000Z","dependencies_parsed_at":"2022-09-26T18:10:39.803Z","dependency_job_id":null,"html_url":"https://github.com/qnib/doxy","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/qnib/doxy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qnib%2Fdoxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qnib%2Fdoxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qnib%2Fdoxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qnib%2Fdoxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qnib","download_url":"https://codeload.github.com/qnib/doxy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qnib%2Fdoxy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28438151,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T22:37:52.437Z","status":"ssl_error","status_checked_at":"2026-01-14T22:37:31.496Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["docker","docker-engine","golang","security"],"created_at":"2026-01-14T23:27:10.548Z","updated_at":"2026-01-14T23:27:11.204Z","avatar_url":"https://github.com/qnib.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# doxy\nDocker unix-socket proxy to provide unharmful, read-only API calls\n\n## Usage\n\n```bash\n$ ./doxy_darwin --help\n*snip*\nGLOBAL OPTIONS:\n   --docker-socket value  Docker host to connect to. (default: \"/var/run/docker.sock\") [$DOXY_DOCKER_SOCKET]\n   --proxy-socket value   Proxy socket to be created (default: \"/tmp/doxy.sock\") [$DOXY_PROXY_SOCKET]\n   --debug                Print proxy requests [$DOXY_DEBUG]\n   --pattern-file value   File holding line-separated regex-patterns to be allowed (comments allowed, use #) (default: \"/etc/doxy.pattern\") [$DOXY_PATTERN_FILE]\n   --help, -h             show help\n   --version, -v          print the version\n$ ./doxy_darwin\n2017/08/18 11:37:43 [II] Start Version: 0.1.0\n2017/08/18 11:37:43 Error reading patterns file (open /etc/doxy.pattern: no such file or directory), using default patterns\n2017/08/18 11:37:43 [doxy] Listening on /tmp/doxy.sock\n```\n\n## Filter mechanism\n\n### Request Method\n\nFor starters the proxy only allows `GET` requests.\n\n```bash\n$ docker -H unix:///tmp/doxy.sock run ubuntu bash\ndocker: Error response from daemon: Only GET requests are allowed, req.Method: POST.\nSee 'docker run --help'.\n```\n\n### Regex\n\nOnce the method is checked, a list of regular expressions are checked. In version 0.1.0 the list reads:\n\n```bash\n# List, inspect, metrics and processes of containers\n^/(v\\d\\.\\d+/)?containers(/\\w+)?/(json|stats|top)$\n# List and inspect services\n^/(v\\d\\.\\d+/)?services(/[0-9a-f]+)?$\n# List and inspect tasks\n^/(v\\d\\.\\d+/)?tasks(/\\w+)?$\n# List and inspect networks\n^/(v\\d\\.\\d+/)?networks(/\\w+)?$\n# List and inspect volumes\n^/(v\\d\\.\\d+/)?volumes(/\\w+)?$\n# List and inspect nodes\n^/(v\\d\\.\\d+/)?nodes(/\\w+)?$\n# Show engine info\n^/(v\\d\\.\\d+/)?info$\n# Show engine version\n^/(v\\d\\.\\d+/)?version$\n# Healthcheck\n^/_ping$\n```\n\nThus, an export of a container filesystem is not allowed.\n\n```bash\n$ docker -H unix:///tmp/doxy.sock export -o test.tar $(docker ps -lq)\nError response from daemon: '/v1.31/containers/a62250e0890a/export' is not allowed.\n```\n\n## Debug output\n\nThe tool uses [negroni](https://github.com/urfave/negroni), a nice web middleware in golang.\nWhen providing the `-debug` flag, the `Logger()` middleware will be added.\n\n```bash\n$ ./doxy_darwin -debug\n2017/08/18 11:44:50 [II] Start Version: 0.1.0\n2017/08/18 11:44:50 Error reading patterns file (open /etc/doxy.pattern: no such file or directory), using default patterns\n2017/08/18 11:44:50 0  : ^/(v\\d\\.\\d+/)?containers(/\\w+)?/json$\n2017/08/18 11:44:50 1  : ^/(v\\d\\.\\d+/)?services(/[0-9a-f]+)?$\n2017/08/18 11:44:50 2  : ^/(v\\d\\.\\d+/)?tasks(/\\w+)?$\n2017/08/18 11:44:50 3  : ^/(v\\d\\.\\d+/)?networks(/\\w+)?$\n2017/08/18 11:44:50 4  : ^/(v\\d\\.\\d+/)?nodes(/\\w+)?$\n2017/08/18 11:44:50 5  : ^/(v\\d\\.\\d+/)?info$\n2017/08/18 11:44:50 6  : ^/_ping$\n2017/08/18 11:44:50 [doxy] Listening on /tmp/doxy.sock\n[negroni] 2017-08-18T11:45:00+02:00 | 200 | \t 3.800713ms | docker | GET /_ping\n[negroni] 2017-08-18T11:45:00+02:00 | 403 | \t 34.067µs | docker | GET /v1.31/containers/a62250e0890a/export\n[negroni] 2017-08-18T11:45:04+02:00 | 200 | \t 1.800044ms | docker | GET /_ping\n[negroni] 2017-08-18T11:45:04+02:00 | 200 | \t 2.055015ms | docker | GET /v1.31/containers/json\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqnib%2Fdoxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqnib%2Fdoxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqnib%2Fdoxy/lists"}