Provides encryption interface. More...

#include <CDocWriter.h>

Public Member Functions
virtual	~CDocWriter () noexcept
virtual result_t	addRecipient (const Recipient &rcpt)=0
	Add recipient to container.
virtual result_t	beginEncryption ()=0
	Prepares the stream for encryption.
virtual result_t	addFile (const std::string &name, size_t size)=0
	Add a new file to the container.
virtual result_t	writeData (const uint8_t *src, size_t size)=0
	Write data to the encrypted stream.
virtual result_t	finishEncryption ()=0
	Finalizes the encryption stream.
virtual result_t	encrypt (MultiDataSource &src, const std::vector< libcdoc::Recipient > &recipients)
	Encrypt data and send to the output stream.
std::string	getLastErrorStr ()
	Get the error text of the last failed operation.

Static Public Member Functions
static CDocWriter *	createWriter (int version, DataConsumer dst, bool take_ownership, Configuration conf, CryptoBackend crypto, NetworkBackend network)
	Create CDoc document writer.
static CDocWriter *	createWriter (int version, std::ostream &ofs, Configuration conf, CryptoBackend crypto, NetworkBackend *network)
	Create CDoc document writer.
static CDocWriter *	createWriter (int version, const std::string &path, Configuration conf, CryptoBackend crypto, NetworkBackend *network)
	Create CDoc document writer.

Public Attributes
const int	version
	The container version (1 or 2).

Protected Member Functions
	CDocWriter (int _version, DataConsumer *dst, bool take_ownership)
	CDOC_DISABLE_MOVE_COPY (CDocWriter)
void	setLastError (const std::string &message)

Protected Attributes
std::string	last_error
DataConsumer *	dst
bool	owned
Configuration *	conf = nullptr
CryptoBackend *	crypto = nullptr
NetworkBackend *	network = nullptr

Detailed Description

Provides encryption interface.

An abstract base class of CDoc1 and CDoc2 writers. Provides an unified interface for file creation and encryption.

Constructor & Destructor Documentation

◆ ~CDocWriter()

virtual libcdoc::CDocWriter::~CDocWriter ( )

virtualnoexcept

◆ CDocWriter()

libcdoc::CDocWriter::CDocWriter	(	int	_version,
		DataConsumer *	dst,
		bool	take_ownership )

explicitprotected

References dst.

Referenced by CDOC_DISABLE_MOVE_COPY(), createWriter(), createWriter(), and createWriter().

Member Function Documentation

◆ addFile()

virtual result_t libcdoc::CDocWriter::addFile	(	const std::string &	name,
		size_t	size )

pure virtual

Add a new file to the container.

Start streaming a new file into the container output stream. The name will be written to stream exactly as is. If size is >= 0 the number of bytes subsequently written has to match exactly. Otherwise the final size is determined by the actual number of bytes written.

Parameters

name	the name to be used in container
size	the size of the file

Returns: error code or OK

References addFile().

Referenced by addFile().

◆ addRecipient()

virtual result_t libcdoc::CDocWriter::addRecipient ( const Recipient & rcpt )

pure virtual

Add recipient to container.

This adds new recipient to the list of container recipients. FMK (File Master Key) is encrypted separately for each recipient, using corresponding methods. All recipients should be added before the encryption starts.

Parameters

rcpt	a Recipient object

Returns: error code or OK

References addRecipient().

Referenced by addRecipient().

◆ beginEncryption()

virtual result_t libcdoc::CDocWriter::beginEncryption ( )

pure virtual

Prepares the stream for encryption.

This may involve creating cryptographic ciphers, building headers and writing the initial part of the stream. All recipients should be added before a call to beginEncryption.

Returns: error code or OK

References beginEncryption().

Referenced by beginEncryption().

◆ CDOC_DISABLE_MOVE_COPY()

libcdoc::CDocWriter::CDOC_DISABLE_MOVE_COPY ( CDocWriter )

protected

References CDocWriter().

◆ createWriter() [1/3]

CDocWriter * libcdoc::CDocWriter::createWriter	(	int	version,
		const std::string &	path,
		Configuration *	conf,
		CryptoBackend *	crypto,
		NetworkBackend *	network )

static

Create CDoc document writer.

Creates a new CDoc document writer for file. Configuration and NetworkBackend may be null if keyservers are not used.

Parameters

version	(1 or 2)
path	output file path
conf	a configuration object
crypto	a cryptographic backend implementation
network	a network backend implementation

Returns: a new CDocWriter or null

References CDocWriter(), conf, crypto, network, and version.

◆ createWriter() [2/3]

CDocWriter * libcdoc::CDocWriter::createWriter	(	int	version,
		DataConsumer *	dst,
		bool	take_ownership,
		Configuration *	conf,
		CryptoBackend *	crypto,
		NetworkBackend *	network )

static

Create CDoc document writer.

Creates a new CDoc document writer for DataConsumer. Configuration and NetworkBackend may be null if keyservers are not used.

Parameters

version	(1 or 2)
dst	output DataConsumer
take_ownership	whether to close dst at the end of encryption and delete with CDocWiter
conf	a configuration object
crypto	a cryptographic backend implementation
network	a network backend implementation

Returns: a new CDocWriter or null

References CDocWriter(), conf, crypto, dst, network, and version.

◆ createWriter() [3/3]

CDocWriter * libcdoc::CDocWriter::createWriter	(	int	version,
		std::ostream &	ofs,
		Configuration *	conf,
		CryptoBackend *	crypto,
		NetworkBackend *	network )

static

Create CDoc document writer.

Creates a new CDoc document writer for outputstream. Configuration and NetworkBackend may be null if keyservers are not used.

Parameters

version	(1 or 2)
ofs	output stream
conf	a configuration object
crypto	a cryptographic backend implementation
network	a network backend implementation

Returns: a new CDocWriter or null

References CDocWriter(), conf, crypto, network, and version.

◆ encrypt()

virtual result_t libcdoc::CDocWriter::encrypt	(	MultiDataSource &	src,
		const std::vector< libcdoc::Recipient > &	recipients )

inlinevirtual

Encrypt data and send to the output stream.

Encrypts the data, provided by MultiDataSource, in one go.

Parameters

src	MultiDataSource providing input files (named chunks)
recipients	a list of recipients for whom locks will be encoded into file

Returns: error code or OK

References encrypt(), and libcdoc::NOT_IMPLEMENTED.

Referenced by encrypt().

◆ finishEncryption()

virtual result_t libcdoc::CDocWriter::finishEncryption ( )

pure virtual

Finalizes the encryption stream.

This may involve flushing file, calculating checksum and closing the stream (if owned by CDocWriter)

Returns: error code or OK

References finishEncryption().

Referenced by finishEncryption().

◆ getLastErrorStr()

std::string libcdoc::CDocWriter::getLastErrorStr ( )

inline

Get the error text of the last failed operation.

Get the error message of the last failed operation. It should be called immediately after getting error code as certain methods may reset the error.

Returns: error description, empty string if no errors

References last_error.

◆ setLastError()

void libcdoc::CDocWriter::setLastError ( const std::string & message )

inlineprotected

References last_error.

◆ writeData()

virtual result_t libcdoc::CDocWriter::writeData	(	const uint8_t *	src,
		size_t	size )

pure virtual

Write data to the encrypted stream.

Writes data to the current file (created with addFile) in container. A single file may safely be written in multiple parts as long as the total size matches the one provided in addFile (or the total size was left indeterminate).

Parameters

src	the source buffer
size	the size of data in buffer

Returns: size or error code

References writeData().

Referenced by writeData().

Member Data Documentation

◆ conf

Configuration* libcdoc::CDocWriter::conf = nullptr

protected

Referenced by createWriter(), createWriter(), and createWriter().

◆ crypto

CryptoBackend* libcdoc::CDocWriter::crypto = nullptr

protected

Referenced by createWriter(), createWriter(), and createWriter().

◆ dst

DataConsumer* libcdoc::CDocWriter::dst

protected

Referenced by CDocWriter(), and createWriter().

◆ last_error

std::string libcdoc::CDocWriter::last_error

protected

Referenced by getLastErrorStr(), and setLastError().

◆ network

NetworkBackend* libcdoc::CDocWriter::network = nullptr

protected

Referenced by createWriter(), createWriter(), and createWriter().

◆ owned

bool libcdoc::CDocWriter::owned

protected

◆ version

const int libcdoc::CDocWriter::version

The container version (1 or 2).

Referenced by createWriter(), createWriter(), and createWriter().

The documentation for this class was generated from the following file:

CDocWriter.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~CDocWriter()

◆ CDocWriter()

Member Function Documentation

◆ addFile()

◆ addRecipient()

◆ beginEncryption()

◆ CDOC_DISABLE_MOVE_COPY()

◆ createWriter() [1/3]

◆ createWriter() [2/3]

◆ createWriter() [3/3]

◆ encrypt()

◆ finishEncryption()

◆ getLastErrorStr()

◆ setLastError()

◆ writeData()

Member Data Documentation

◆ conf

◆ crypto

◆ dst

◆ last_error

◆ network

◆ owned

◆ version