{"id":31920216,"url":"https://github.com/aegisjsproject/secret-store","last_synced_at":"2026-04-02T20:26:09.500Z","repository":{"id":313237766,"uuid":"1046576713","full_name":"AegisJSProject/secret-store","owner":"AegisJSProject","description":"Proxy-based wrapper for encrypting and decrypting data over any storage object","archived":false,"fork":false,"pushed_at":"2025-10-04T15:03:04.000Z","size":384,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-04T17:20:17.261Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@aegisjsproject/secret-store","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/AegisJSProject.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"shgysk8zer0","liberapay":"shgysk8zer0"}},"created_at":"2025-08-28T22:32:12.000Z","updated_at":"2025-10-04T15:03:06.000Z","dependencies_parsed_at":"2025-10-04T17:14:48.289Z","dependency_job_id":null,"html_url":"https://github.com/AegisJSProject/secret-store","commit_stats":null,"previous_names":["aegisjsproject/secret-store"],"tags_count":2,"template":false,"template_full_name":"AegisJSProject/template","purl":"pkg:github/AegisJSProject/secret-store","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AegisJSProject%2Fsecret-store","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AegisJSProject%2Fsecret-store/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AegisJSProject%2Fsecret-store/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AegisJSProject%2Fsecret-store/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AegisJSProject","download_url":"https://codeload.github.com/AegisJSProject/secret-store/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AegisJSProject%2Fsecret-store/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017013,"owners_count":26085951,"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-13T02:00:06.723Z","response_time":61,"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":"2025-10-13T21:56:21.211Z","updated_at":"2025-10-13T21:56:26.253Z","avatar_url":"https://github.com/AegisJSProject.png","language":"JavaScript","funding_links":["https://github.com/sponsors/shgysk8zer0","https://liberapay.com/shgysk8zer0","https://liberapay.com/shgysk8zer0/donate"],"categories":[],"sub_categories":[],"readme":"# `@aegisjsproject/secret-store`\n\nProxy-based wrapper for encrypting and decrypting data over any storage object\n\n[![CodeQL](https://@github.com/AegisJSProject/secret-store/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/shgysk8zer0/npm-template/actions/workflows/codeql-analysis.yml)\n![Node CI](https://@github.com/AegisJSProject/secret-store/workflows/Node%20CI/badge.svg)\n![Lint Code Base](https://@github.com/AegisJSProject/secret-store/workflows/Lint%20Code%20Base/badge.svg)\n\n[![GitHub license](https://img.shields.io/github/license/AegisJSProject/secret-store.svg)](https://@github.com/AegisJSProject/secret-store/blob/master/LICENSE)\n[![GitHub last commit](https://img.shields.io/github/last-commit/AegisJSProject/secret-store.svg)](https://@github.com/AegisJSProject/secret-store/commits/master)\n[![GitHub release](https://img.shields.io/github/release/AegisJSProject/secret-store?logo=github)](https://@github.com/AegisJSProject/secret-store/releases)\n[![GitHub Sponsors](https://img.shields.io/github/sponsors/shgysk8zer0?logo=github)](https://github.com/sponsors/shgysk8zer0)\n\n[![npm](https://img.shields.io/npm/v/@aegisjsproject/secret-store)](https://www.npmjs.com/package/@aegisjsproject/secret-store)\n![node-current](https://img.shields.io/node/v/@aegisjsproject/secret-store)\n![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/%40aegisjsproject%secret-store)\n[![npm](https://img.shields.io/npm/dw/@aegisjsproject/secret-store?logo=npm)](https://www.npmjs.com/package/@aegisjsproject/secret-store)\n\n[![GitHub followers](https://img.shields.io/github/followers/AegisJSProject.svg?style=social)](https://github.com/AegisJSProject)\n![GitHub forks](https://img.shields.io/github/forks/AegisJSProject/secret-store.svg?style=social)\n![GitHub stars](https://img.shields.io/github/stars/AegisJSProject/secret-store.svg?style=social)\n[![Twitter Follow](https://img.shields.io/twitter/follow/shgysk8zer0.svg?style=social)](https://twitter.com/shgysk8zer0)\n\n[![Donate using Liberapay](https://img.shields.io/liberapay/receives/shgysk8zer0.svg?logo=liberapay)](https://liberapay.com/shgysk8zer0/donate \"Donate using Liberapay\")\n- - -\n\n- [Code of Conduct](./.github/CODE_OF_CONDUCT.md)\n- [Contributing](./.github/CONTRIBUTING.md)\n\u003c!-- - [Security Policy](./.github/SECURITY.md) --\u003e\n\n## Installation\n\n### npm\n```bash\nnpm install @aegisjsproject/secret-store\n```\n\n### `\u003cscript type=\"importmap\"\u003e`\n\n```html\n\u003cscript type=\"importmap\"\u003e\n{\n  \"imports\": {\n    \"@aegisjsproject/secret-store\": \"https://unpkg.com/@aegisjsproject/secret-store/secret-store.min.js\",\n    \"@shgysk8zer0/aes-gcm\": \"https://unpkg.com/@shgysk8zer0/aes-gcm/aes-gcm.min.js\"\n  }\n}\n\u003c/script\u003e\n```\n\n## API\n\n### `useSecretStore(key, targetObject, handler)`\n\nCreates an encrypted proxy around an object where values are automatically encrypted on set and decrypted on get.\n\n**Parameters:**\n- `key` - CryptoKey with decrypt usage (encrypt usage required for setter)\n- `targetObject` - Object to wrap (defaults to `process.env`)\n- `handler` - ProxyHandler (defaults to `Reflect`)\n\n**Returns:** `[proxy, setter]` - Frozen array containing the proxy and async setter function\n\n**Throws:** TypeError if key lacks decrypt usage\n\n### `openSecretStoreFile(key, path, config)`\n\nNode.js only. Loads and wraps a JSON file as an encrypted store.\n\n**Parameters:**\n- `key` - CryptoKey \n- `path` - File path string\n- `config.encoding` - File encoding (default: \"utf8\")\n- `config.handler` - ProxyHandler (default: `Reflect`)\n- `config.signal` - AbortSignal for cancellation\n\n**Returns:** Promise resolving to `[proxy, setter]`\n\n## Usage\n\n```js\nimport { useSecretStore, openSecretStoreFile } from '@aegisjsproject/secret-store';\n\n// Generate key\nconst key = await crypto.subtle.generateKey(\n  { name: 'AES-GCM', length: 256 },\n  false,\n  ['encrypt', 'decrypt']\n);\n\n// Create store\nconst [store, set] = useSecretStore(key, {});\n\n// Values are encrypted when set, decrypted when accessed\nawait set('password', 'secret123');\nconst password = await store.password; // 'secret123'\n\n// Load from file (Node.js)\nconst [fileStore] = await openSecretStoreFile(key, './secrets.json');\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faegisjsproject%2Fsecret-store","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faegisjsproject%2Fsecret-store","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faegisjsproject%2Fsecret-store/lists"}