Home Reference Source
import {EnvelopeEncryptionProfile} from 'neo4j-driver-core/lib/encryption/encryption-profile.js'
public class | since 6.3.0 | source

EnvelopeEncryptionProfile

this class is experimental. Part of the Client-Side Encrytion preview feature

An encryption profile that enables Envelope Encryption for Neo4j Property Encryption.

Constructor Summary

Public Constructor
public

constructor(config: Object)

Member Summary

Public Members
public
public
public
public
public

Public Constructors

public constructor(config: Object) source

Params:

NameTypeAttributeDescription
config Object

Configurations

config.name string

Name of the profile, must be the same on all drivers used to access the encrypted data.

config.encapsulationService KeyEncapsulationService

Encapsulation service used to encapsulate and dencapsulate keys. The driver ships with LocalKeyEncapsulationService, other implementations can be found as separate packages.

config.keyRepository EncapsulatedKeyRecordRepository

Implementation of the EncapsulatedKeyRecordRepository interface, must be implemented so that the driver can access your key repository.

config.keyCacheTTL number

How How long in milliseconds to keep a retrieved encapsulated keys cached by Id - defaults to 15 minutes

config.keyCacheMaxSize number

How many items to keep in the key cache before pruning the oldest, setting to 0 will disable the cache - defaults to 100

config.keyAliasIndexTTL number

How How long in milliseconds to keep the mapping of alias to key cached - defaults to 15 seconds

config.keyAliasIndexMaxSize number

How many items to keep in the alias cache before pruning the oldest, setting to 0 will disable the index - defaults to 100

Public Members

public encapsulationService source

public keyRepository source

public name source

public type source

public version source