loopbackio / loopbackio/loopback-next
Best practice for encrypting model properties
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 5.1k
- Forks
- 1.1k
- Ø Merge
- 2 T. 21 Std.
- Gemergte PRs (30 T.)
- 27
Beschreibung
## Description / Steps to reproduce / Feature proposal
In my application, I have models with properties that need to be encrypted before saved in the database.
I'm trying to decide what's the best practice to implement that use-case.
## Current implementation
What I'm currently doing is set an attribute in the property itself:
`encrypted: true`
In my repository, I override the relevant methods. e.g. create:
```
async create(entity: DataObject, options?: AnyObject): Promise {
for (let propertyName in this.entityClass.definition.properties) {
if (this.entityClass.definition.properties[propertyName]['encrypted']) {
entity[propertyName] = encrypted(entity, propertyName)
}
}
return (await super.create(entity, options));
}
```
There are a couple of problems with this implementation.
- This method is not generic, as if tomorrow I would like to implement another logic?
- It requires to override a lot of methods in the repository.
- It requires editing per repository meaning that the CLI only covers a small part of the creation process.
Is there any better implementation for this issue?
## Acceptance criteria
- [ ] A mechanism allowing Repository classes to execute custom code whenever the repository is trying to convert model instance into raw data to be stored and also from the raw data to model instance. This is basically an Operation Hook, and it should be implemented by DefaultCrudRepository. See #2095 (comment) for more details, the code snippet is cross-posted below.
- [ ] A section in our documentation (e.g. in [Key Concepts >> Repositories](https://loopback.io/doc/en/lb4/Repositories.html)) explaining how to use these new mechanism.
- [ ] A guide in our documentation showing how can applications implement property encryption/decryption.
Proposed implementation:
```ts
class DefaultCrudRepository /*...*/{
protected async entityToData(entity: DataObject, options?: Options): DataObject {
// "persist hook" - no-op by default
return entity;
}
protected async dataToEntity(data: DataObject, options?: Options): DataObject {
// "load hook" - no-op by default
return this.toEntity(data);
}
async create(entity: DataObject, options?: Options): Promise {
const data = await this.entityToData(entity, options);
const model = await ensurePromise(this.modelClass.create(data, options));
const result = await this.dataToEntity(model);
return result;
}
// etc.
}
```
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit DefaultCrudRepository und verfolge den create path sowie die entsprechenden conversion paths, die im Vorschlag beschrieben sind. Definiere das Verhalten der entityToData- und dataToEntity-Hooks und aktualisiere anschließend die Dokumentation Key Concepts > Repositories um einen Leitfaden zur Verschlüsselung/Entschlüsselung von Properties; abgeschlossen bedeutet, dass die Akzeptanzkriterien abgedeckt sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- backend-api-design, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100