{"id":15395440,"url":"https://github.com/stef/zphinx-zerver","last_synced_at":"2025-10-07T09:54:06.601Z","repository":{"id":66440217,"uuid":"312431331","full_name":"stef/zphinx-zerver","owner":"stef","description":"a sphinx server in zig","archived":false,"fork":false,"pushed_at":"2025-03-15T22:06:46.000Z","size":343,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-16T00:44:42.513Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Zig","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stef.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-11-13T00:34:58.000Z","updated_at":"2025-03-17T10:47:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"13b71a43-9b9b-4969-899b-e0aa2f384bae","html_url":"https://github.com/stef/zphinx-zerver","commit_stats":{"total_commits":90,"total_committers":1,"mean_commits":90.0,"dds":0.0,"last_synced_commit":"9826987d074d33f4bdf77e470ab7b84cf8feda97"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/stef/zphinx-zerver","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stef%2Fzphinx-zerver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stef%2Fzphinx-zerver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stef%2Fzphinx-zerver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stef%2Fzphinx-zerver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stef","download_url":"https://codeload.github.com/stef/zphinx-zerver/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stef%2Fzphinx-zerver/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278755164,"owners_count":26040034,"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","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-10-01T15:28:22.241Z","updated_at":"2025-10-07T09:54:06.586Z","avatar_url":"https://github.com/stef.png","language":"Zig","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zphinx Zerver!\n\nThis is an implementation of a sphinx server that you should run in production.\n\nfor more info see:\nhttps://github.com/stef/libsphinx and for a reference implementation see:\nhttps://github.com/stef/pwdsphinx/blob/main/pwdsphinx/oracle.py\nfor testing use the cli client `sphinx.py` from\nhttps://github.com/stef/pwdsphinx/blob/main/pwdsphinx/sphinx.py\n\nLicensed under AGPLv3+\n\nalso shouts to https://github.com/MasterQ32/zig-bearssl for the original bearssl bindings\n\n## Building\n\nThe git repo's submodules need to be checked out recursively.\n\nYou need at least zig 0.7.1 do build this.\n\nYou will also need libequihash from: https://github.com/stef/equihash/\n\nMake sure that `libequihash.pc` and `sodium.pc` are available in\n`/usr/share/pkgconfig/` since zig seems to not be able to find other\ndistro-specific directories like `/usr/lib/x86_64-linux-gnu/pkgconfig/`\n\n\nClone the repo:\n\n`git clone --recursive https://github.com/stef/zphinx-zerver`\n\nJust run `zig build install --prefix . --release=safe` and be happy.\n\nYou might want to give permission to bind to ports below 1024 (if you run this\nas recommended on port 433):\n```\nsudo setcap 'cap_net_bind_service=+ep' ./bin/oracle\n```\n\n## Running\n\nYou could use a docker image provided by\nhttps://github.com/D3vl0per/zphinx-zerver-docker\n\nto create x509 cert/server key run this - **ONLY** for testing/demo, in production use real certs/keys!!!!\n```\nopenssl ecparam -genkey -out ssl_key.pem -name secp384r1\nopenssl req -new -nodes -x509 -sha256 -key ssl_key.pem -out ssl_cert.pem -days 365 -subj '/CN=localhost'\n```\n\nYou must publish the file `ssl_cert.pem` if you use a self-signed certificate, so\nthat your clients can include it in their configuration.\n\nNote currently zphinx only supports ECDSA key material. If other types of keys\nare required, uncomment the line containing `c.br_ssl_server_init_full_ec` in\n`oracle.zig` - and comment out the following line containing\n`...br_ssl_server_init_minf2c(...`.\n\nset your config in one of these files (later files over-ride earlier locations\nin this list):\n\n - `/etc/sphinx/config`\n - `~/.config/sphinx/config`\n - `~/.sphinxrc`\n - `./sphinx.cfg`\n\nIf this is the first time running your oracle, you might want to initialize it\nby running:\n\n```\n./bin/oracle init\n```\n\nThis will generate your long-term signing key for the threshold setup. You\n**SHOULD** publish either the file containing the public key, or the base64\nencoded string representing the public key so that other clients can use your\nserver in a threshold setup.\n\nIn case you want some logging to stdout to feed your favorite daemontools-like\nlogger run oracle like this:\n\n```\n./bin/oracle 2\u003e\u00261 | /usr/bin/ts\n```\n\n## Funding\n\nThis project is funded through [NGI0 PET](https://nlnet.nl/PET), a fund\nestablished by [NLnet](https://nlnet.nl) with financial support from the\nEuropean Commission's [Next Generation Internet](https://ngi.eu) program. Learn\nmore at the [NLnet project page](https://nlnet.nl/project/OpaqueSphinxServer).\n\n[\u003cimg src=\"https://nlnet.nl/logo/banner.png\" alt=\"NLnet foundation logo\" width=\"20%\" /\u003e](https://nlnet.nl)\n[\u003cimg src=\"https://nlnet.nl/image/logos/NGI0_tag.svg\" alt=\"NGI Zero Logo\" width=\"20%\" /\u003e](https://nlnet.nl/PET)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstef%2Fzphinx-zerver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstef%2Fzphinx-zerver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstef%2Fzphinx-zerver/lists"}