{"id":28417778,"url":"https://github.com/donedeal0/deepvault","last_synced_at":"2025-10-07T20:46:12.230Z","repository":{"id":116720361,"uuid":"381323633","full_name":"DoneDeal0/DeepVault","owner":"DoneDeal0","description":"DeepVault allows you to store data in the browser with AES encryption.","archived":false,"fork":false,"pushed_at":"2021-12-02T18:54:42.000Z","size":19,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-04T02:57:15.385Z","etag":null,"topics":["aes","aes-256","aes-gcm","cryptography","encryption","encryption-decryption","gcm","local-storage","localstorage","security"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/deepvault","language":"TypeScript","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/DoneDeal0.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2021-06-29T10:20:08.000Z","updated_at":"2025-07-03T11:17:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"9534932f-f084-410b-bee2-f64904761b43","html_url":"https://github.com/DoneDeal0/DeepVault","commit_stats":{"total_commits":3,"total_committers":2,"mean_commits":1.5,"dds":"0.33333333333333337","last_synced_commit":"79539eae93c1eaa13652105847aacc721cd8e00b"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/DoneDeal0/DeepVault","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DoneDeal0%2FDeepVault","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DoneDeal0%2FDeepVault/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DoneDeal0%2FDeepVault/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DoneDeal0%2FDeepVault/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DoneDeal0","download_url":"https://codeload.github.com/DoneDeal0/DeepVault/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DoneDeal0%2FDeepVault/sbom","scorecard":{"id":41750,"data":{"date":"2025-08-11","repo":{"name":"github.com/DoneDeal0/DeepVault","commit":"79539eae93c1eaa13652105847aacc721cd8e00b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2,"checks":[{"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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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":"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":"Code-Review","score":0,"reason":"Found 0/3 approved changesets -- score normalized to 0","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":"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":"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":"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":"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":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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":"Vulnerabilities","score":5,"reason":"5 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc"],"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-14T21:44:01.421Z","repository_id":116720361,"created_at":"2025-08-14T21:44:01.421Z","updated_at":"2025-08-14T21:44:01.421Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278845034,"owners_count":26056080,"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":["aes","aes-256","aes-gcm","cryptography","encryption","encryption-decryption","gcm","local-storage","localstorage","security"],"created_at":"2025-06-04T07:42:30.354Z","updated_at":"2025-10-07T20:46:12.171Z","avatar_url":"https://github.com/DoneDeal0.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg width=\"904\" alt=\"deepvault-logo\" src=\"https://user-images.githubusercontent.com/43271780/123779944-f7f9b100-d8d2-11eb-9e9c-4f4a79b0e9b2.png\"\u003e\n\n# DEEPVAULT - DOCUMENTATION\n\n## WHAT IS IT?\n\n**DeepVault** allows you to store data in the browser with AES encryption.\n\n## MOTIVATION\nStoring data in the browser is very convenient, but not secure. Thanks to **DeepVault**, you can now directly encrypt sensitive data (geolocation, email, etc.), in your browser and access it with a cryptographic key as if you were using good old local storage.  \n\n## SECURITY\nBy nature, **DeepVault** is not completely secure since it only provide security through obfuscation. But albeit it won't stop a determined hacker, it will mitigate the vast majority of automated attacks. Please weight up the pros and cons and design your app carefully. \n\nYou can learn more about Advanced Encryption Standard and Galois Counter Mode here:\n - https://en.wikipedia.org/wiki/Galois/Counter_Mode\n - https://fr.wikipedia.org/wiki/Advanced_Encryption_Standard\n\n\n### features:\n- Save, read, update and delete encrypted data in the browser.\n- Supports Typescript.\n- No dependencies.\n- Extra-light package.\n\n## HOW DOES IT WORK?\n\n#### Vaults file\n\n- Create a `vaults.js` file (the name and the extension doesn't matter).\n- Create as many instances of DeepVault as you want and export them.\n- Each instance is dedicated to a single dataset.\n\n```javascript\nimport DeepVault from \"deepvault\";\n\nexport const userVault = new DeepVault(\"user\");\nexport const cashVault = new DeepVault(\"cash\");\n```\n\n#### Save data\n\n```javascript\nimport { userVault } from \"./vaults\";\n \n   const onLogin = async (form) =\u003e {  \n     try {\n        const user = await login(form)\n        await userVault.encryptAndSaveData(user)    \n        return saveUserInGlobalState(user)\n      }\n     catch(err){\n        throw new Error(err)\n     }\n```\n#### Read data\n\n```javascript\nimport { userVault } from \"./vaults\";\n \n   const getUser = async () =\u003e {  \n     try {\n        const user = await userVault.getDecryptedData()\n        if (user) return saveUserInGlobalState(user)\n        return null\n      }\n     catch(err){\n        throw new Error(err)\n     }\n```\n#### Update data\n\n```javascript\nimport { userVault } from \"./vaults\";\n \n   const updateUser = async (user) =\u003e {  \n     try {\n        await userVault.updateData(user)  \n        return saveUserInGlobalState(user)\n      }\n     catch(err){\n        throw new Error(err)\n     }\n```\n#### Delete data\n\n```javascript\nimport { userVault } from \"./vaults\";\n \n   const logout = async () =\u003e {  \n     try {\n        await userVault.deleteData()  \n        return clearGlobalState()\n      }\n     catch(err){\n        throw new Error(err)\n     }\n```\n\u003e The dummy functions `saveUserInGlobalState()` and `clearGlobalState()` are not part of DeepVault. You should implement them yourself. If you use React, Redux or Zustand will work fine.\n\n## Methods\n\n**DeepVault** offers you 6 methods:\n\n| |Type |Role |\n|----------------|-------------------------------|-----------------------------|\n|decryptData |`(data: string) =\u003e Promise\u003cany\u003e` |Decrypt data. |\n|deleteData |`() =\u003e void` |Delete data.  |\n|encryptAndSaveData |`(data: any) =\u003e void`|Encrypt and save data|\n|getEncryptedData |`() =\u003e string`|Get data without decrypting it. Useful to check the existence of an item without any need to access its information.|\n|getDecryptedData |`() =\u003e Promise\u003cany\u003e`|Get decrypted data.|\n|updateData |`(data: any) =\u003e Promise\u003cstring\u003e`|Update an item already encrypted and saved. This method will replace the former data with the new one.|\n\n## CONTRIBUTING\nFeel free to send your pull requests or to raise issues on the github repository.\n\n## CREDITS\nDoneDeal0\n\nLogo made by throwaway icons from the Noun Project","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdonedeal0%2Fdeepvault","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdonedeal0%2Fdeepvault","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdonedeal0%2Fdeepvault/lists"}