{"id":16832141,"url":"https://github.com/ebroder/ebuse","last_synced_at":"2025-10-25T03:35:40.358Z","repository":{"id":57709897,"uuid":"300461147","full_name":"ebroder/ebuse","owner":"ebroder","description":"Access an EBS snapshot directly through NBD","archived":false,"fork":false,"pushed_at":"2024-12-02T02:25:32.000Z","size":28,"stargazers_count":7,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-09T07:04:08.571Z","etag":null,"topics":["aws","ebs","ebs-snapshots","network-block-device"],"latest_commit_sha":null,"homepage":"","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/ebroder.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-10-02T00:35:52.000Z","updated_at":"2025-05-06T05:00:28.000Z","dependencies_parsed_at":"2025-04-11T04:15:34.501Z","dependency_job_id":"b607d8ff-ad45-4a91-acf2-87c94f8345d6","html_url":"https://github.com/ebroder/ebuse","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ebroder/ebuse","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebroder%2Febuse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebroder%2Febuse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebroder%2Febuse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebroder%2Febuse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ebroder","download_url":"https://codeload.github.com/ebroder/ebuse/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebroder%2Febuse/sbom","scorecard":{"id":364804,"data":{"date":"2025-08-11","repo":{"name":"github.com/ebroder/ebuse","commit":"7069d850c8f3925956965ee1a8e3e7b80582c76e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.4,"checks":[{"name":"Code-Review","score":1,"reason":"Found 1/9 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 4 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":4,"reason":"6 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2022-0635","Warn: Project is vulnerable to: GO-2022-0646","Warn: Project is vulnerable to: GO-2024-2687 / GHSA-4v7x-pqxf-cx7m","Warn: Project is vulnerable to: GO-2024-3333","Warn: Project is vulnerable to: GO-2025-3503 / GHSA-qxp5-gwg8-xv66","Warn: Project is vulnerable to: GO-2025-3595 / GHSA-vvgc-356p-c3xw"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T11:37:22.157Z","repository_id":57709897,"created_at":"2025-08-18T11:37:22.157Z","updated_at":"2025-08-18T11:37:22.157Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280901467,"owners_count":26410586,"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-25T02:00:06.499Z","response_time":81,"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":["aws","ebs","ebs-snapshots","network-block-device"],"created_at":"2024-10-13T11:47:49.465Z","updated_at":"2025-10-25T03:35:40.321Z","avatar_url":"https://github.com/ebroder.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ebuse\n\nebuse is an [NBD][] server which uses the new EBS direct APIs to expose an EBS\nsnapshot as a network-accessible block device. You can use this to access data\nin an EBS snapshot without needing to first restore it to an EBS volume.\n\nThis implementation is definitely a bit of a toy, so I probably wouldn't use it\nfor production workloads. There aren't any tests, it's not particularly hardened\nagainst error conditions, and it doesn't try to be particularly efficient in\ndata that it fetches. I also can't promise that it will be particularly well\nmaintained.\n\nAlso, keep in mind that the EBS direct APIs aren't entirely free, although they\nare quite cheap. Assume that you'll spend about 0.6c for every gigabyte you\nread.\n\nWhy \"ebuse\"? Originally I planned to build this using [BUSE][] (well, a Go\nversion of BUSE). \"ebuse\" is what you get when you smash \"EBS\" and \"BUSE\"\ntogether. It also seemed appropriate that it sounded abusive - this is probably\nnot exactly what these APIs are intended for.\n\n## Usage\n\nYou can install ebuse by running\n\n```\n$ go get -u github.com/ebroder/ebuse\n```\n\nebuse only has one required argument - the snapshot ID you want it to serve. It\noptionally accepts as flags the AWS region of that snapshot (although that can\nalso be passed in via the `AWS_REGION` environment variable) and the UNIX socket\npath to bind the NBD server to (which defaults to somewhere reasonable in\n`XDG_RUNTIME_DIR`):\n\n```\nusage: ebuse [flags] snap-12345678\n  -region string\n    \tAWS region of snapshot (default \"us-east-1\")\n  -socket string\n    \tpath to listen on (default \"/run/user/1000/nbd.sock\")\n```\n\nebuse depends on having access to AWS credentials from the environment. It\nsupports everything that the AWS SDK supports [out of the box][AWS credentials].\n\nOnce you've started the ebuse NBD server, you can connect to it using something\nlike `nbd-client`:\n\n```\n$ sudo nbd-client -unix $XDG_RUNTIME_DIR/nbd.sock\nWarning: the oldstyle protocol is no longer supported.\nThis method now uses the newstyle protocol with a default export\nNegotiation: ..size = 8192MB\nConnected /dev/nbd1\n```\n\n...and voila! You now have a block device (`/dev/nbd1` in this case) backed by\nan EBS snapshot. Note that if you want to mount the block device, you'll need to\npass `-o ro` to `mount`; otherwise it will try and fail to update the\nsuperblock. For journaled filesystems, you may also want `-o noload`. And if\nyour EBS volume has a partition table, you should automatically get\npartition-specific block devices (e.g. `/dev/nbd1p1`) - you'll need to mount\nthose instead.\n\nTo disconnect, run\n\n```\nsudo nbd-client -d /dev/nbd1\n```\n\n[NBD]: https://en.wikipedia.org/wiki/Network_block_device\n[BUSE]: https://github.com/acozzette/BUSE\n[AWS credentials]: https://docs.aws.amazon.com/sdk-for-go/api/#hdr-Configuring_Credentials\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febroder%2Febuse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Febroder%2Febuse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febroder%2Febuse/lists"}