{"id":19534631,"url":"https://github.com/buttercup/signing","last_synced_at":"2025-07-04T07:02:55.591Z","repository":{"id":143736486,"uuid":"125641133","full_name":"buttercup/signing","owner":"buttercup","description":"Signing and verification tools for Buttercup archives","archived":false,"fork":false,"pushed_at":"2023-03-01T18:13:49.000Z","size":323,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-12T08:23:19.484Z","etag":null,"topics":["authentication","buttercup","signing","verification"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/buttercup.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2018-03-17T15:09:37.000Z","updated_at":"2023-01-15T09:29:15.000Z","dependencies_parsed_at":"2023-09-26T07:46:57.132Z","dependency_job_id":null,"html_url":"https://github.com/buttercup/signing","commit_stats":{"total_commits":18,"total_committers":3,"mean_commits":6.0,"dds":"0.33333333333333337","last_synced_commit":"5187c95ef24c6ec3cc8e20c94e04da8d0eb4a524"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/buttercup/signing","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buttercup%2Fsigning","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buttercup%2Fsigning/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buttercup%2Fsigning/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buttercup%2Fsigning/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/buttercup","download_url":"https://codeload.github.com/buttercup/signing/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buttercup%2Fsigning/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260213654,"owners_count":22975602,"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":["authentication","buttercup","signing","verification"],"created_at":"2024-11-11T02:14:55.393Z","updated_at":"2025-07-04T07:02:55.547Z","avatar_url":"https://github.com/buttercup.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Buttercup Signing Tools\n\u003e Signing and verification tools for Buttercup archives\n\n[![Build Status](https://travis-ci.org/buttercup/signing.svg?branch=master)](https://travis-ci.org/buttercup/signing)\n\n## :warning: Deprecated\n\nThis repository is deprecated since [Buttercup core](https://github.com/buttercup/buttercup-core) version 4, as it is now included in the core library. It is no longer required to include this library as its functionality can be found in the [`buttercup`](https://www.npmjs.com/package/buttercup) dependency.\n\n## About\nThis library provides tools for archive and resource signing and validation. It is responsible for the authoritative definition of the format of the **encrypted** vault structure.\n\n### Encrypted Vault Strings\nVault strings form the following structure:\n\n`{{BUTTERCUP_SIGNATURE}}{{ENCRYPTED_STRING}}`\n\nThe **signature** is made up of two parts: the signature prefix and the format. They currently look like `b~\u003ebuttercup/a` where `b~\u003e` is the signature prefix and `buttercup/a` is the format. These must prepend the encrypted contents.\n\nThe **encrypted string** is encrypted output from [`iocane`](https://github.com/perry-mitchell/iocane). It contains encrypted contents and values concatenated using the `$` character.\n\nDue to the complex nature of the string, the following characters are reserved and may not be implemented in any other feature within the encrypted structure:\n\n| Char(s)   | Use                           | Description                               |\n|-----------|-------------------------------|-------------------------------------------|\n| `~`       | Signature prefix              | Used in the signature prefix at the beginning of the encrypted string. |\n| `\u003e`       | Signature prefix              | Used in the signature prefix.             |\n| `$`       | Encryption separator          | Used to separate encryption portions.     |\n| `=`       | Base64 encryption component   | Used in encrypted payloads.               |\n| `+`       | Base64 encryption component   | Used in encrypted payloads.               |\n| `/`       | Base64 encryption component   | Used in encrypted payloads.               |\n| `[a-zA-Z0-9]`| Payload data               | Used in data payloads (generic)           |\n\n#### Example\nAn encrypted vault string may look like the following:\n\n`b~\u003ebuttercup/aEXitErfO7Re0Hzi2egKAJLjxbC0GdoOY8y+OvUfsVFyc+Kbxr3a9gcWc8fTdlv6oflML9h3sFWYAphpeJSHzDv0MLJTGbZZ90a2CRdjjv8vRBsY/SF0lIKCqKenwZicWgNO9eyvAzvRV3JmLjY6x7JA7gO6Z8v+cwpfwWtx/nbRdLMvWUB2tY7XHpi7VEcDw+H53gyj0qPmkFN2wXMOdctTJINbfwJ7PFqJ5fpZewx55YwzZG1YQJj9wGB9DbI4ht9owIwiB8BQUIbZF0DNO0TSA/CXSPc4fYbaseE66b2Ec8C7rrm9y2vaai1WsouPGGLj7PF5SeLXFowbtU/3ZpCWIKQRYEym7Cg6hwXEmAz0urObsQgRo5kjrGe7QAnptreY+KjtCr/52Smv+Sy3JpENlYupvKvrdqNSyA0hCnJaIWaxW4MwJQkCws6qSDF6amz6Tvoy2VxggooZEWhXf7Nj/oHTYMrOWxo2kRYB3GwFBdtrv4lHvlZ2VmYkM48AmEh71s4wveI9EEJ8pjQtKi7LYx+OP4ie0y5HjflzMofi33Ohy0pXchPHFkREkFxml+f983GAzuWwbjE1mF+QiXP4h+HRApRV7VJFzATQ1CNydU4tF/dyJ53mvt3DeufpQ2EHRpy6X0wpV2WeqfbaNgohaYByyqPDW2HLpwtPsozrc7pifqa6oopFgevz+MaUx67DHwFUqXXrWZrQTnPj1jQ==$0b4a4be1e42e7bdbb48300caf54ffe1e$54a9f1d1988a$4f42ad72c76894c62d59814e7e6a28eb03c67a24dd9e80167dd02a0a77f33426$6007`\n\n## Installation\nRun `npm install --save` to get started.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuttercup%2Fsigning","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbuttercup%2Fsigning","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuttercup%2Fsigning/lists"}