{"id":21905885,"url":"https://github.com/cosmian/cloudproof_js","last_synced_at":"2025-07-09T04:06:01.291Z","repository":{"id":59667198,"uuid":"485880185","full_name":"Cosmian/cloudproof_js","owner":"Cosmian","description":"The JavaScript/Typescript API library to Cosmian Cloudproof Encryption","archived":false,"fork":false,"pushed_at":"2025-03-06T11:03:38.000Z","size":10372,"stargazers_count":4,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T23:56:08.296Z","etag":null,"topics":["cloud","cloudproof","cryptography","java"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cosmian.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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":"2022-04-26T17:15:19.000Z","updated_at":"2025-03-06T11:01:56.000Z","dependencies_parsed_at":"2023-09-23T08:27:44.339Z","dependency_job_id":"7dc26b14-7c4e-44aa-a907-39035a2ce864","html_url":"https://github.com/Cosmian/cloudproof_js","commit_stats":null,"previous_names":[],"tags_count":47,"template":false,"template_full_name":null,"purl":"pkg:github/Cosmian/cloudproof_js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cosmian%2Fcloudproof_js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cosmian%2Fcloudproof_js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cosmian%2Fcloudproof_js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cosmian%2Fcloudproof_js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cosmian","download_url":"https://codeload.github.com/Cosmian/cloudproof_js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cosmian%2Fcloudproof_js/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264390706,"owners_count":23600562,"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":["cloud","cloudproof","cryptography","java"],"created_at":"2024-11-28T16:38:59.093Z","updated_at":"2025-07-09T04:06:01.274Z","avatar_url":"https://github.com/Cosmian.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cloudproof Javascript Library\n\n![Build status](https://github.com/Cosmian/cloudproof_js/actions/workflows/ci.yml/badge.svg?branch=main)\n\nThe library provides a Typescript-friendly API to the **Cloudproof Encryption** product of the [Cosmian Ubiquitous Encryption platform](https://cosmian.com).\n\n\u003c!-- toc --\u003e\n\n- [Licensing](#licensing)\n- [Cryptographic primitives](#cryptographic-primitives)\n- [Getting started](#getting-started)\n- [Using in Javascript projects](#using-in-javascript-projects)\n- [Versions Correspondence](#versions-correspondence)\n- [Renew Auth0 access token](#renew-auth0-access-token)\n\n\u003c!-- tocstop --\u003e\n\n## Licensing\n\nThe library is available under a dual licensing scheme Affero GPL/v3 and commercial. See [LICENSE.md](LICENSE.md) for details.\n\n## Cryptographic primitives\n\nThe library is based on:\n\n- [CoverCrypt](https://github.com/Cosmian/cover_crypt) algorithm which allows\n  creating ciphertexts for a set of attributes and issuing user keys with access\n  policies over these attributes. `CoverCrypt` offers Post-Quantum resistance.\n\n- [Findex](https://github.com/Cosmian/findex) which is a cryptographic protocol designed to securely make search queries on\n  an untrusted cloud server. Thanks to its encrypted indexes, large databases can\n  securely be outsourced without compromising usability.\n\n- [FPE](https://github.com/Cosmian/cloudproof_rust/tree/main/crates/fpe) provides `Format Preserving Encryption` (FPE) techniques for use in a zero-trust environment. These techniques are based on FPE-FF1 which is described in [NIST:800-38G](https://nvlpubs.nist.gov/nistpubs/specialpublications/nist.sp.800-38g.pdf).\n\n- [Anonymization](https://github.com/Cosmian/cloudproof_rust/tree/main/crates/anonymization): `Data anonymization` is the process of transforming data in such a way that it can no longer be used to identify individuals without the use of additional information. This is often done to protect the privacy of individuals whose data is being collected or processed.\n\n## Getting started\n\nPlease [check the online documentation](https://docs.cosmian.com/) for details on using the CloudProof APIs.\n\nYou can also look the [`examples` directory](./examples) for examples with multiple JS frameworks/technologies (the [`README`](./examples/README.md) of the [`examples`](./examples) folder can guide you to the best example for you use case).\n\n## Using in Javascript projects\n\nThis library is free software and is available on NPM public repository.\n\nAs a pre-requisite, the WASM binaries required for Findex, CoverCrypt or FPE must be fetched \nusing the the following python script\n\n```bash\npython3 scripts/download_wasm.py\n```\n\nor be manually copied from \u003c[https://package.cosmian.com/cloudproof_rust/v3.0.2/darwin.zip]\u003e into the `src/pkg` directory:\n\nThen, `the clouproof_js` library should be installed in `node_modules`\n\n```bash\nnpm i cloudproof_js\n```\n\nAfter these steps, the project directory should have the following structure\n```\n-\u003e src\n  -\u003e pkg\n     -\u003e cover_crypt\n     -\u003e findex\n     -\u003e fpe\n-\u003e node_modules\n  -\u003e cloudproof_js\n```\n\n\n(version before 3.1.0 were called cosmian_js_lib)\n\n## Versions Correspondence\n\n[CoverCrypt](https://github.com/Cosmian/cover_crypt) and SSE [Findex](https://github.com/Cosmian/findex) scheme are wrapped in WebAssembly libraries (WASM) in [cloudproof_rust](https://github.com/Cosmian/cloudproof_rust).\n\n| `cloudproof_js` | Cloudproof Rust lib | KMS Server |\n| --------------- | ------------------- | ---------- |\n| 8.0.0           | 1.0.0               | 4.2.0      |\n| 8.1.0           | 1.1.0               | 4.3.0      |\n| 9.0.0           | 2.0.1               | 4.3.0      |\n| 9.1.0,9.1.1     | 2.1.0               | 4.3.0      |\n| 9.2.0           | 2.2.1               | 4.5.0      |\n| 9.3.0           | 2.2.3               | 4.6.0      |\n| 9.4.0,9.4.1     | 2.2.4               | 4.7.0      |\n| 9.5.0           | 2.3.0               | 4.9.0      |\n| 9.5.1           | 2.3.0               | 4.9.1      |\n| 9.6.0           | 2.4.0               | 4.10.0     |\n| 9.7.0           | 2.4.0               | 4.11.3     |\n| 10.0.0          | 3.0.0               | 4.13.0     |\n| 10.0.1          | 3.0.0               | 4.19.3     |\n\n## Renew Auth0 access token\n\nRefer to repository \u003chttps://github.com/Cosmian/kms-ci-token\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcosmian%2Fcloudproof_js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcosmian%2Fcloudproof_js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcosmian%2Fcloudproof_js/lists"}