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的本地搜索/查找/排序方法。因为加密字段的明文不可用给数据库，所以没有数据库搜索或排序方法可以操作这些字段。搜索或排序只能通过检索所有行，解密所有值，然后在这些值上执行搜索/排序来完成。如果您有很多行并且需要在加密字段上搜索/排序，这个过程可能非常慢。

安装

这个库在packagist上发布。要使用Composer安装，将"Athens/Encryption": "0.1.*"行添加到您的"require"依赖中

{
    "require": {
        "Athens/Encryption": ">=0.1"
    }
}

当然，如果您不使用Composer，则可以点击右边的"Download 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](https://github.com/AthensFramework/encryption) 是此项目的官方位置。

以下是代码贡献的一般事件序列

1. 在问题跟踪器中打开一个问题。
2. 任意顺序

• 提交一个包含失败测试的拉取请求，以展示问题/功能。
• 获得认可/一致。

1. 修订您的拉取请求，使其通过（2）中的测试。如果适用，包括文档。