{"id":15400409,"url":"https://github.com/tniessen/node-pqclean","last_synced_at":"2025-06-30T16:36:53.323Z","repository":{"id":41221544,"uuid":"508046809","full_name":"tniessen/node-pqclean","owner":"tniessen","description":"PQClean for Node.js, Deno, and browsers 🔏🔑 Node.js native addon and WebAssembly implementation","archived":false,"fork":false,"pushed_at":"2024-04-27T07:46:35.000Z","size":126,"stargazers_count":65,"open_issues_count":1,"forks_count":20,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-01T21:22:00.916Z","etag":null,"topics":["cryptography","deno","javascript","nodejs","npm-package","post-quantum","post-quantum-cryptography","post-quantum-kem","post-quantum-signature","webassembly"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/tniessen.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}},"created_at":"2022-06-27T20:05:20.000Z","updated_at":"2024-05-13T21:25:43.922Z","dependencies_parsed_at":"2022-07-08T01:45:12.599Z","dependency_job_id":"f3bb49c2-6a3e-4397-9296-f207a7603321","html_url":"https://github.com/tniessen/node-pqclean","commit_stats":{"total_commits":34,"total_committers":1,"mean_commits":34.0,"dds":0.0,"last_synced_commit":"0ab465f45c4103799597f8d9a050a81b8b75f637"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tniessen%2Fnode-pqclean","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tniessen%2Fnode-pqclean/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tniessen%2Fnode-pqclean/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tniessen%2Fnode-pqclean/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tniessen","download_url":"https://codeload.github.com/tniessen/node-pqclean/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232302272,"owners_count":18502114,"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":["cryptography","deno","javascript","nodejs","npm-package","post-quantum","post-quantum-cryptography","post-quantum-kem","post-quantum-signature","webassembly"],"created_at":"2024-10-01T15:53:50.740Z","updated_at":"2025-01-03T06:47:12.962Z","avatar_url":"https://github.com/tniessen.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PQClean for Node.js, Deno, and more\n\nThis package provides Node.js bindings for [PQClean][], a collection of\n[post-quantum cryptography][] algorithm implementations, including 16\n[key encapsulation mechanisms][] and 19 [digital signature algorithms][].\n\nIn addition to the native addon for Node.js, this package also provides an\nimplementation for Deno and other JavaScript runtimes, such as browsers, based\non WebAssembly.\n\n## Installation\n\nTo use this package in Node.js, install it as usual.\n\n```sh\nnpm i pqclean\n```\n\nBy default, node-pqclean will attempt to compile PQClean as a native addon for\nNode.js. Only if that fails, for example, because necessary tools are not\ninstalled or because the operating system is unsupported, the package will\ncontinue with the installation, but only the WebAssembly backend will be\navailable at runtime.\n\nIt is possible to customize the installation procedure through the use of an npm\nconfig variable `pqclean-backend`.\n\n* `pqclean-backend=prefer-native` (default) attempts to build the native addon\n  and only uses the WebAssembly backend if building the native addon fails.\n* `pqclean-backend=native` builds and uses the native addon only. If building\n  the native addon fails, the package installation fails as well.\n* `pqclean-backend=wasm` does not build the native addon. Only the WebAssembly\n  backend will be available at runtime. This option may be useful when loading\n  native addons poses a security risk.\n\nYou can read more about npm config variables\n[here](https://docs.npmjs.com/cli/v8/using-npm/config).\n\n### Building for the web (Deno, browsers, etc.)\n\n[Emscripten](https://emscripten.org/) and a recent version of Node.js are\nrequired to build the web distribution, which is based on WebAssembly. If you\nencounter any problems despite having installed `emcc`, please open an issue.\n\nClone the repository and run `npm run build-wasm \u0026\u0026 npm run build-web`. This\nwill produce the web distribution in `web/dist`.\n\n## API\n\nSee [API.md](API.md).\n\n## Security\n\nSee [SECURITY.md](SECURITY.md).\n\n## License\n\nThis project is distributed under the MIT license. Please check\n[deps/PQClean](deps) for licenses that apply to individual algorithm\nimplementations.\n\n[PQClean]: https://github.com/PQClean/PQClean\n[digital signature algorithms]: https://en.wikipedia.org/wiki/Digital_signature\n[key encapsulation mechanisms]: https://en.wikipedia.org/wiki/Key_encapsulation_mechanism\n[post-quantum cryptography]: https://en.wikipedia.org/wiki/Post-quantum_cryptography\n[nodejs/node#43630]: https://github.com/nodejs/node/issues/43630\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftniessen%2Fnode-pqclean","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftniessen%2Fnode-pqclean","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftniessen%2Fnode-pqclean/lists"}