DB Fields Encryption

If you need to save information securely, you can use the transformer function to be able to save the fields you need to encrypt.

You need to add these variables in your .env file:

ENCRYPTION_SECRET_KEY= <yourEncriptionSecretKey>
ENCRYPTION_IV= <yourEncryptionIV>

• The secret key must be a key made with SHA256.

• IV cipher must be 32 characters long. (16 Bytes)

To encrypt information, the typeorm-encrypted library is being used.

The configuration file for this file is located at src/common/transformers/typeorm-encrypted.transformer.ts

import { EncryptionTransformer } from 'typeorm-encrypted';
import * as dotenv from 'dotenv';

dotenv.config({ path: `.env.${process.env.STAGE}` });

export const encryptionTransformer = new EncryptionTransformer({
  key: process.env.ENCRYPTION_SECRET_KEY,
  algorithm: 'aes-256-gcm',
  ivLength: 16,
  iv: process.env.ENCRYPTION_IV,
});

If you want to encrypt data of some entity, you must import the configuration that is made in the file: src/common/transformers/typeorm-encrypted.transformer.ts

import { encryptionTransformer } from 'src/common/transformers/typeorm-encrypted.transformer';

Now you need to add the following configuration to the field you want to encrypt in your .entity file.

import { Entity, Column } from 'typeorm';
import { BaseModel } from 'src/common/database/base-model';
import { encryptionTransformer } from 'src/common/transformers/typeorm-encrypted.transformer';

@Entity()
export class Integration extends BaseModel {
  ....
  @Column({
    transformer: encryptionTransformer,
  })
  public myField: string;
  ....
}