{"id":13828540,"url":"https://github.com/paragonie/ciphersweet","last_synced_at":"2026-03-05T02:12:25.416Z","repository":{"id":32057452,"uuid":"130633100","full_name":"paragonie/ciphersweet","owner":"paragonie","description":"Fast, searchable field-level encryption for PHP projects","archived":false,"fork":false,"pushed_at":"2025-02-07T02:06:06.000Z","size":1028,"stargazers_count":448,"open_issues_count":14,"forks_count":34,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-04-14T22:06:11.560Z","etag":null,"topics":["encryption","php","searchable-encryption"],"latest_commit_sha":null,"homepage":"https://ciphersweet.paragonie.com","language":"PHP","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/paragonie.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":"2018-04-23T03:07:36.000Z","updated_at":"2025-04-05T12:02:06.000Z","dependencies_parsed_at":"2023-02-15T22:00:26.381Z","dependency_job_id":"0865160e-1e29-47c1-86d4-c065f2d4bc46","html_url":"https://github.com/paragonie/ciphersweet","commit_stats":{"total_commits":247,"total_committers":11,"mean_commits":"22.454545454545453","dds":0.09311740890688258,"last_synced_commit":"ccb2e1d36652bb0a2471c80a747626b9502f376f"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paragonie%2Fciphersweet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paragonie%2Fciphersweet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paragonie%2Fciphersweet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paragonie%2Fciphersweet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paragonie","download_url":"https://codeload.github.com/paragonie/ciphersweet/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254120179,"owners_count":22017953,"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":["encryption","php","searchable-encryption"],"created_at":"2024-08-04T09:02:51.315Z","updated_at":"2026-03-05T02:12:25.406Z","avatar_url":"https://github.com/paragonie.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"readme":"# CipherSweet\n\n[![Build Status](https://github.com/paragonie/ciphersweet/actions/workflows/ci.yml/badge.svg)](https://github.com/paragonie/ciphersweet/actions)\n[![Static Analysis](https://github.com/paragonie/ciphersweet/actions/workflows/psalm.yml/badge.svg)](https://github.com/paragonie/ciphersweet/actions)\n[![Latest Stable Version](https://poser.pugx.org/paragonie/ciphersweet/v/stable)](https://packagist.org/packages/paragonie/ciphersweet)\n[![Latest Unstable Version](https://poser.pugx.org/paragonie/ciphersweet/v/unstable)](https://packagist.org/packages/paragonie/ciphersweet)\n[![License](https://poser.pugx.org/paragonie/ciphersweet/license)](https://packagist.org/packages/paragonie/ciphersweet)\n[![Downloads](https://img.shields.io/packagist/dt/paragonie/ciphersweet.svg)](https://packagist.org/packages/paragonie/ciphersweet)\n\n**CipherSweet** is a backend library developed by [Paragon Initiative Enterprises](https://paragonie.com)\nfor implementing [searchable field-level encryption](https://paragonie.com/blog/2017/05/building-searchable-encrypted-databases-with-php-and-sql).\n\n**Requires PHP 8.1 or newer**.\n\nIf you want to use CipherSweet on an older version of PHP (5.5+), use \n[CipherSweet v3](https://github.com/paragonie/ciphersweet/tree/v3.x).\n\nBefore adding searchable encryption support to your project, make sure you understand\nthe [appropriate threat model](https://adamcaudill.com/2016/07/20/threat-modeling-for-applications/)\nfor your use case. At a minimum, you will want your application and database\nserver to be running on separate cloud instances / virtual machines.\n(Even better: Separate bare-metal hardware.)\n\nCipherSweet is available under the very permissive [ISC License](https://github.com/paragonie/ciphersweet/blob/master/LICENSE)\nwhich allows you to use CipherSweet in any of your PHP projects, commercial\nor noncommercial, open source or proprietary, at no cost to you.\n\n## CipherSweet Features at a Glance\n\n* Encryption that targets the 256-bit security level\n  (using [AEAD](https://tonyarcieri.com/all-the-crypto-code-youve-ever-written-is-probably-broken) modes\n  with extended nonces to minimize users' rekeying burden).\n* **Compliance-Specific Protocol Support.** Multiple backends to satisfy a\n  diverse range of compliance requirements. More can be added as needed:\n  * `BoringCrypto` uses [libsodium](https://download.libsodium.org/doc/), the de\n    facto standard encryption library for software developers.\n    [Algorithm details](https://ciphersweet.paragonie.com/security#boringcrypto).\n  * `FIPSCrypto` only uses the cryptographic algorithms covered by the\n    FIPS 140-3 recommendations to avoid auditing complexity.\n    [Algorithm details](https://ciphersweet.paragonie.com/security#fipscrypto).\n* **Key separation.** Each column is encrypted with a different key, all of which are derived from\n  your master encryption key using secure key-splitting algorithms.\n* **Key management integration.** CipherSweet supports integration with Key\n  Management solutions for storing and retrieving the master encryption key.\n* **Searchable Encryption.** CipherSweet uses\n  [blind indexing](https://paragonie.com/blog/2017/05/building-searchable-encrypted-databases-with-php-and-sql#solution-literal-search)\n  with the fuzzier and Bloom filter strategies to allow fast ciphertext search\n  with [minimal data leakage](https://ciphersweet.paragonie.com/php/blind-index-planning). \n  * Each blind index on each column uses a distinct key from your encryption key\n    and each other blind index key.\n  * This doesn't allow for `LIKE` operators or regular expression searching, but\n    it does allow you to index transformations (e.g. substrings) of the plaintext,\n    hashed under a distinct key.\n* **Adaptability.** CipherSweet has a database- and product-agnostic design, so\n  it should be easy to write an adapter to use CipherSweet in any PHP-based\n  software.\n* **File/stream encryption.** CipherSweet has an API for encrypting files (or\n  other PHP streams) that provides authenticated encryption that defeats TOCTOU\n  attacks with minimal overhead. [Learn more](https://ciphersweet.paragonie.com/internals/file-encryption).\n\n## Installing CipherSweet\n\nUse Composer.\n\n```bash\ncomposer require paragonie/ciphersweet:^4\n```\n\nIf you're intending to use CipherSweet on an older version of PHP, use the v3 branch:\n\n```bash\ncomposer require paragonie/ciphersweet:^3\n```\n\n## Using CipherSweet\n\nPlease refer to **[the documentation](https://ciphersweet.paragonie.com)**\nto learn how to use CipherSweet.\n\nSecurity experts may be interested in [the security properties of our design](https://ciphersweet.paragonie.com/security).\n\n### Integration Support\n\nPlease feel free to [create an issue](https://github.com/paragonie/ciphersweet/issues/new)\nif you'd like to integrate CipherSweet with your software.\n\n* [AWS KMS provider for CipherSweet](https://github.com/paragonie/ciphersweet-provider-aws-kms)\n\n### CipherSweet Adapters for PHP Frameworks\n\n* [Eloquent ORM Adapter](https://github.com/paragonie/eloquent-ciphersweet) for **Laravel** developers\n* [Doctrine ORM Adapter](https://github.com/paragonie/doctrine-ciphersweet) for **Symfony** developers\n\n## CipherSweet in Other Languages\n\n* [JavaScript (Node.js)](https://github.com/paragonie/ciphersweet-js)\n\n## Why \"CipherSweet\"?\n\nCipherSweet was originally intended for use in [SuiteCRM](https://github.com/salesagility/SuiteCRM)\n(a fork of the SugarCRM Community Edition) and related products, although\nthere is nothing preventing its use in other products.\n\nTherefore, we opted for a pun on \"ciphersuite\" that pays homage to the\nopen source heritage of the project we designed this library for.\n\nIf the wordplay is too heavy, feel free to just call it \"Sweet\", or juxtapose\nthe two component nouns and call it \"SweetCipher\" in spoken conversation.\n\n## Support Contracts\n\nIf your company uses this library in their products or services, you may be\ninterested in [purchasing a support contract from Paragon Initiative Enterprises](https://paragonie.com/enterprise).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparagonie%2Fciphersweet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fparagonie%2Fciphersweet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparagonie%2Fciphersweet/lists"}