README

Warning

This project is a work in progress. The code is not yet fully functional.

Overview

Resilient Data is a library that provides classes to work with data in a resilient way. Tipically, a data is splitted into multiple parts, and each part can be stored in different locations. This library provides classes to work with this kind of data and recover the inital data even if some parts are missing.

Example

You have 4 associates, and you want to split a secret into 4 parts, so that each associate has one part. You want the secret to be recoverable if at least 3 associates are present. This means that if you lose one associate, you can still recover the secret. To do so, this library will split the secret into multiple parts (chunks) and distribute them to the associates. To ensure redundancy, each chunk will be duplicated and distributed to two associates.

Usage

Installation

Composer

composer require qroques/resilient-data

Note

This library requires PHP 8.3 or later but does not require any other dependency.

Splitting data

$resilientData = new Qroques\ResilientData\ResilientData(file_get_contents(__DIR__.'/data/lorem.txt'));
// We want to split the data into 5 parts, and we want to be able to recover the data even with 2 parts missing
$splittingConfiguration = new Qroques\ResilientData\SplittingConfiguration(5, 2);
$splitter = new Qroques\ResilientData\Splitter();

$fragments = $splitter->split($resilientData, $splittingConfiguration);

Warning

Chunk of data are not encrypted. This mean that parts of the data can still be readable from the fragments.

Recovering data

$assembler = new Qroques\ResilientData\Assembler();
$resilientData = $splitter->assemble($fragments);