@24hr/seqcryptor 中文文档教程

Question

seqCryptor

这是一个使用 seqeuelize 加密特定列的小模块。 它有点像 https://www.npmjs.com/package/sequelize-encrypted 但是因为 seqeuelize-encrypted 还没有更新 五年了，我们需要一个打字稿版本，我们决定创建一个新模块。

它只有 80 多行代码，所以没什么特别的，但我们的目标是创建一个可以在项目中使用的模块 在项目增长很多之后需要加密数据。 所以这是为了尽可能少地改变目标而设计的 sequelize 中的正常模型定义。

目前仅支持DataType.STRING、DataType.JSONB和DataType.JSON。

How to use it

这是最基本的示例：

// Create the encryptor with your secret key
const encryptor = seqEncryptor('YOUR_SUPER_SECRET_32_BYTES_KEY__');

const sequelize = new Sequelize({
    dialect: 'sqlite',
    storage: ':memory:',
    define: {
        timestamps: true,
    },
    logging: false,
});

class User extends Model {
    public name!: string;
    public guid!: string;
}

User.init({
    guid: {
        allowNull: false,
        unique: true,
        type: DataTypes.UUID,
        defaultValue: DataTypes.UUIDV4,
    },
    name: encryptor({               // THIS IS THE ONLY DIFFERENCE. Together with the field below.
        type: DataTypes.STRING,
        field: 'name',              // THIS IS REQUIRED. The initiation functions doens't have access to the name in the json,
                                    // so we need to explicitly write it.
    }),
}, {
    sequelize,
    paranoid: false,
});

await User.sync();

const user = await User.create({ name: 'bar' });

const rawUser = await User.findOne({ where: { guid: user.guid }, raw: true });
console.log(rawUser.name); // Will print an encrypted string

const loadedUser = await User.findOne({ where: { guid: user.guid } });
console.log(loadedUser.name); // Will print "bar"

How to test it

要运行测试，请运行：

npm ci
npm run test-ci