雅典 / 加密
Propel 行为,用于无缝加密/解密数据列
Requires
- propel/propel: ~2.0@dev
Requires (Dev)
- athens/standard: *
- codeclimate/php-test-reporter: dev-master
- phpdocumentor/phpdocumentor: 2.7.*
- phpunit/phpunit: 4.5.*
README
Athens\Encryption
无缝加密/解密 Propel2 数据字段。这个库是 插件,用于 Propel2 ORM 框架。
例如
// schema.xml
<table name="my_class">
<column name="id" type="integer" required="true" primaryKey="true" autoIncrement="true"/>
<column name="my_data" type="varchar" size="255" />
<column name="my_secret_data" type="varbinary" size="255" />
<behavior name="encryption">
<parameter name="column_name_1" value="my_secret_data" />
</behavior>
</table>
// Before any database queries:
use Athens\Encryption\Cipher;
Cipher::createInstance("mysecretpassphrase");
// In your program:
$o = new MyClass();
$o->setMyData("Some data that will remain as plain text.");
$o->setMySecretData("Some data that will be encrypted.");
$o->save();
// Later:
$o = MyClassQuery::create()->findOneByMyData("Some data that will remain as plain text.");
echo $o->getMySecretData();
// "Some data that will be encrypted."
给定上面的表定义,字符串 "Some data that will be encrypted."
在发送到数据库之前在内存中加密。当我们稍后检索 MySecretData
时,密文在返回之前被解密。
注意/权衡
Athens/Encryption 破坏了 Propel 的原生搜索/查找/排序方法 在加密字段(s)上。因为加密字段的明文对数据库不可用,所以没有数据库搜索或排序方法可以操作这些字段。搜索或排序只能通过 检索所有行,解密所有值,然后在这些值上执行搜索/排序来完成。如果您有大量行并且需要在加密字段上搜索/排序,此过程可能非常慢。
安装
此库已发布在 packagist 上。要使用 Composer 安装,请将 "Athens/Encryption": "0.1.*"
行添加到您的 "require" 依赖项中
{
"require": {
"Athens/Encryption": ">=0.1"
}
}
当然,如果您不使用 Composer,则可以通过右侧的 下载 ZIP 按钮下载存储库。
使用
此客户端库提供了一个 Cipher
类和一个 Propel2 行为类。
要在您的 Propel 架构中将字段指定为加密,请将其类型设置为 varbinary
并包含 encryption
行为。您可以在 encryption
行为中包含多个列
<table name="my_class">
<column name="id" type="integer" required="true" primaryKey="true" autoIncrement="true"/>
<column name="my_data" type="varchar" size="255" />
<column name="my_secret_data" type="varbinary" size="255" />
<column name="my_secret_data2" type="varbinary" size="255" />
<behavior name="encryption">
<parameter name="column_name_1" value="my_secret_data" />
<parameter name="column_name_2" value="my_secret_data2" />
</behavior>
</table>
然后像平常一样构建您的模型和数据库。
在查询数据库之前,您必须使用您的口令短语初始化 Cipher 类
// Intialize the cipher
Cipher::createInstance($my_passphrase);
参数 $my_passphrase
应该是一串随机字符。32-64 个字符的长度适合您的口令短语。因为密文在每次页面加载时都会初始化,所以口令短语必须存储在您的服务器上的一个可由 PHP 访问的位置。然而,口令短语不应在任何可供网站访问者查看的文件中,并且几乎肯定不应包含在您的源/版本控制(git、scm 等)中。
就这样!现在 MySecretData
和 MySecretData2
的类设置器在将数据发送到数据库之前无缝加密它们的数据。现在 MySecretData
和 MySecretData2
的类获取器在从数据库检索数据后无缝解密数据。
请记住,由于上述原因,现在搜索/查找和排序对 MySecretData
和 MySecretData2
已破坏。
兼容性
- PHP 5.5、5.6、7.0
- Propel2
待办事项
请参阅 GitHub 问题跟踪器。
参与
请随意打开拉取请求或问题。 GitHub 是此项目的规范位置。
以下是代码贡献的一般事件顺序
- 在 问题跟踪器 中打开一个问题。
- 任何顺序
- 提交一个带有 失败的 测试的拉取请求,以展示问题/功能。
- 获得认可/一致。
- 修改您的拉取请求,以通过(2)中的测试。如有适当,请包含文档。