Download .zip |
Info | Example | View files (63) | Download .zip | Reputation | Support forum | Blog | Links |
Last Updated | Ratings | Unique User Downloads | Download Rankings | |||||
2018-09-15 (Yesterday) | Not yet rated by the users | Total: 2 This week: 2 | All time: 9,360 This week: 235 |
Version | License | PHP version | Categories | |||
ciphersweet 1.0 | MIT/X Consortium ... | 5 | PHP 5, Databases, Cryptography, Security |
Description | Author | |
This package can encrypt data in away that can be searched. |
CipherSweet is a backend library developed by Paragon Initiative Enterprises for implementing searchable field-level encryption.
Requires PHP 5.5+, although 7.2 is recommended for better performance.
Before adding searchable encryption support to your project, make sure you understand the appropriate threat model for your use case. At a minimum, you will want your application and database server to be running on separate cloud instances / virtual machines. (Even better: Separate bare-metal hardware.)
CipherSweet is available under the very permissive ISC License which allows you to use CipherSweet in any of your PHP projects, commercial or noncommercial, open source or proprietary, at no cost to you.
ModernCrypto
uses libsodium, the de
facto standard encryption library for software developers.
* FIPSCrypto
only uses the cryptographic algorithms covered by the
FIPS 140-2 recommendations to avoid auditing complexity.Use Composer.
composer require paragonie/ciphersweet
Please refer to the documentation to learn how to use CipherSweet.
Please feel free to create an issue if you'd like to integrate CipherSweet with your software.
CipherSweet was originally intend for use in in SuiteCRM (a fork of the SugarCRM Community Edition) and related products, although there is nothing preventing its use in other products.
Therefore, we opted for a pun on "ciphersuite" that pays homage to the open source heritage of the project we designed this library for.
If the wordplay is too heavy, feel free to juxtapose the two component nouns and call it "SweetCipher" in spoken conversation.
Files |
File | Role | Description | ||
---|---|---|---|---|
docs (1 file, 3 directories) | ||||
src (6 files, 5 directories) | ||||
tests (6 files, 3 directories) | ||||
.travis.yml | Data | Auxiliary data | ||
composer.json | Data | Auxiliary data | ||
LICENSE | Lic. | License text | ||
phpunit.xml.dist | Data | Auxiliary data | ||
psalm.xml | Data | Auxiliary data | ||
README.md | Doc. | Documentation |
Files | / | docs |
Files | / | docs | / | examples |
File | Role | Description |
---|---|---|
01-easydb-latitude.md | Example | Example script |
02-pdo-mysql.md | Example | Example script |
03-doctrine-mysql.md | Class | Class source |
04-key-generation.md | Data | Auxiliary data |
README.md | Doc. | Documentation |
Files | / | docs | / | internals |
File | Role | Description |
---|---|---|
01-key-heirarchy.svg | Data | Auxiliary data |
01-key-hierarchy.md | Data | Auxiliary data |
02-packing.md | Data | Auxiliary data |
03-encryption.md | Data | Auxiliary data |
04-blind-index.md | Data | Auxiliary data |
README.md | Doc. | Documentation |
Files | / | docs | / | solutions |
File | Role | Description |
---|---|---|
01-boolean.md | Example | Example script |
README.md | Doc. | Documentation |
Files | / | src |
File | Role | Description | ||
---|---|---|---|---|
Backend (2 files, 1 directory) | ||||
Contract (3 files) | ||||
Exception (7 files) | ||||
KeyProvider (4 files) | ||||
Transformation (4 files) | ||||
BlindIndex.php | Class | Class source | ||
CipherSweet.php | Class | Class source | ||
CompoundIndex.php | Class | Class source | ||
EncryptedField.php | Class | Class source | ||
EncryptedRow.php | Class | Class source | ||
Util.php | Class | Class source |
Files | / | src | / | Backend |
File | Role | Description | ||
---|---|---|---|---|
Key (1 file) | ||||
FIPSCrypto.php | Class | Class source | ||
ModernCrypto.php | Class | Class source |
Files | / | src | / | Contract |
File | Role | Description |
---|---|---|
BackendInterface.php | Class | Class source |
KeyProviderInterface.php | Class | Class source |
TransformationInterface.php | Class | Class source |
Files | / | src | / | Exception |
File | Role | Description |
---|---|---|
ArrayKeyException.php | Class | Class source |
BlindIndexNameCollisionException.php | Class | Class source |
BlindIndexNotFoundException.php | Class | Class source |
CipherSweetException.php | Class | Class source |
CryptoOperationException.php | Class | Class source |
InvalidCiphertextException.php | Class | Class source |
KeyProviderException.php | Class | Class source |
Files | / | src | / | KeyProvider |
File | Role | Description |
---|---|---|
ArrayProvider.php | Class | Class source |
FileProvider.php | Class | Class source |
RandomProvider.php | Class | Class source |
StringProvider.php | Class | Class source |
Files | / | src | / | Transformation |
File | Role | Description |
---|---|---|
Compound.php | Class | Class source |
DigitsOnly.php | Class | Class source |
LastFourDigits.php | Class | Class source |
Lowercase.php | Class | Class source |
Files | / | tests |
File | Role | Description | ||
---|---|---|---|---|
Backend (2 files) | ||||
KeyProvider (3 files) | ||||
Transformation (5 files) | ||||
BlindIndexTest.php | Class | Class source | ||
CipherSweetTest.php | Class | Class source | ||
CompoundIndexTest.php | Class | Class source | ||
EncryptedFieldTest.php | Class | Class source | ||
EncryptedRowTest.php | Class | Class source | ||
UtilTest.php | Class | Class source |
Files | / | tests | / | Backend |
File | Role | Description |
---|---|---|
FIPSCryptoTest.php | Class | Class source |
ModernCryptoTest.php | Class | Class source |
Files | / | tests | / | KeyProvider |
File | Role | Description |
---|---|---|
ArrayProviderTest.php | Class | Class source |
FileProviderTest.php | Class | Class source |
StringProviderTest.php | Class | Class source |
Files | / | tests | / | Transformation |
File | Role | Description |
---|---|---|
CompoundTest.php | Class | Class source |
DigitsOnlyTest.php | Class | Class source |
GenericTransfomationCase.php | Class | Class source |
LastFourDigitsTest.php | Class | Class source |
LowercaseTest.php | Class | Class source |
Version Control | Unique User Downloads | Download Rankings | |||||||||||||||
100% |
|
|
Applications that use this package |
If you know an application of this package, send a message to the author to add a link here.