Stream Conversions Manual

Table of Contents

• About
• StreamConversionInterface
  • Conversion
  • Streams
  • Properties
• Conversions
  • Hex
  • UTF
  • Base64
  • Cryptography
  • Hashes
  • Compression
• Further Reading

About

The maxon::StreamConversionInterface provides a generic interface for any kind of data conversion. This includes string encoding, compression, encryption, hashing etc.

StreamConversionInterface

Conversion

maxon::StreamConversionInterface is used to convert the given source data. The result of this conversion is typically stored in a given array.

• maxon::StreamConversionInterface::Convert(): Converts (part of) the source data.
• maxon::StreamConversionInterface::ConvertAll(): Converts the complete source data.
• maxon::StreamConversionInterface::SupportInplaceConversion(): Returns true if the conversion supports in-place conversion. Typically only supported by encryption algorithms.
• maxon::StreamConversionInterface::ConvertAllInplace(): Converts the complete source data and overwrites it.

Note

A maxon::StreamConversionInterface object can be used only once.

Streams

A given conversion instance can be converted to an input stream. See InputStream Manual.

• maxon::StreamConversionInterface::ConvertToStream(): Returns an input stream.
• maxon::StreamConversionInterface::ConvertToReader(): Returns a DataFormatBaseReaderRef.
• maxon::StreamConversionInterface::ConvertToWriter(): Returns a DataFormatBaseWriterRef.

Properties

Various properties of the given conversion type can be accessed with:

• maxon::StreamConversionInterface::GetBatchSize(): Returns the recommended working size.
• maxon::StreamConversionInterface::GetBlockSize(): Returns the block size. The encoded/decoded data needs to be a multiple of this value.
• maxon::StreamConversionInterface::GetCounterpart(): Returns the corresponding counter part converter id.
• maxon::StreamConversionInterface::GetSourceType(): Returns the accepted source data type.
• maxon::StreamConversionInterface::GetDestinationType(): Returns the accepted destination data type.

Conversions

Existing conversions are registered at the registry maxon::StreamConversions or presented as published objects. Some conversions can be configured by defining some settings in a maxon::DataDictionary that is used with the Create() function (maxon::StreamConversionFactory).

Hex

Arbitrary data can be converted to a hexadecimal representation:

• maxon::StreamConversions::HexEncoder: Hexadecimal encoder.
• maxon::StreamConversions::HexDecoder: Hexadecimal decoder.

See also maxon::GetHexadecimalValue().

UTF

Text can be converted to different Unicode encodings. See maxon::UTFTEXT_OPTIONS.

• maxon::StreamConversions::UtfTextEncoder: Unicode encoder.
• maxon::StreamConversions::UtfTextDecoder: Unicode decoder.

Additional string conversions are registered at maxon::StringEncodings and maxon::StringDecodings, see stringencoding.h. For string conversions there are also maxon::StringEncodingInterface and maxon::StringDecodingInterface.

Base64

Arbitrary data can be converted to a Base64 representation. See maxon::BASE64_OPTIONS.

• maxon::StreamConversions::Base64Encoder: Base64 encoder.
• maxon::StreamConversions::Base64Decoder: Base64 decoder.
• maxon::StreamConversions::Base64UrlEncoder: Base64 URL encoder.
• maxon::StreamConversions::Base64UrlDecoder: Base64 URL decoder.

Cryptography

Arbitrary data can be encrypted using these algorithms:

• maxon::StreamConversions::AesEncoder: AES encryption.
• maxon::StreamConversions::AesDecoder: AES decryption.
• maxon::StreamConversions::BlowfishEncoder: Blowfish encryption.
• maxon::StreamConversions::BlowfishDecoder: Blowfish decryption.
• maxon::StreamConversions::BlowfishLegacyEncoder: Legacy Blowfish encryption.
• maxon::StreamConversions::BlowfishLegacyDecoder: Legacy Blowfish decryption.
• maxon::StreamConversions::BlowfishLegacyEnDecoder: Legacy Blowfish en/decryption. See maxon::BLOWFISHLEGACYENDECODER_OPTIONS.

The cryptographic key is set as maxon::CryptographyOptions::CRYPTOKEY using maxon::CryptoKeyInterface. To pad a data block with arbitrary data use maxon::SecureRandom.

Encryption algorithms can also be used with the specialized maxon::CryptographyStreamConversionInterface.

Hashes

Hash values for arbitrary data are calculated with these algorithms:

• maxon::StreamConversions::HashMD5: MD5 hash algorithm.
• maxon::StreamConversions::HashSHA1: SHA1 hash algorithm.
• maxon::StreamConversions::HashSHA256: SHA256 hash algorithm.
• maxon::StreamConversions::HashSHA512: SHA512 hash algorithm.
• maxon::StreamConversions::HashCrc32c: Crc32c hash algorithm. For convenience see also maxon::Crc32C.
• maxon::StreamConversions::HashCrc32zip: Crc32zip hash algorithm.
• maxon::StreamConversions::HashHmac: Hash-based message authentication code. See maxon::HASH_HMAC.

For easily handling passwords and hash strings see

• maxon::GetPasswordHash()
• maxon::HashPasswordWithSalt()
• maxon::GetHashString()

Compression

Arbitrary data can be compressed using these algorithms. See datacompression.h:

• maxon::StreamConversions::ZipEncoder: ZIP compression. See maxon::STREAMCONVERSION::ZIP::ENCODER.
• maxon::StreamConversions::ZipDecoder: ZIP decompression.
• maxon::StreamConversions::GZipEncoder: GZIP compression. See maxon::STREAMCONVERSION::GZIP::ENCODER.
• maxon::StreamConversions::GZipDecoder: GZIP decompression.
• maxon::StreamConversions::RleEncoder: RLE compression.
• maxon::StreamConversions::RleDecoder: RLE decompression.
• maxon::StreamConversions::Lz4Encoder: LZ4 compression. See maxon::STREAMCONVERSION::LZ4::ENCODER.
• maxon::StreamConversions::Lz4Decoder: LZ4 decompression. See maxon::STREAMCONVERSION::LZ4::DECODER.
• maxon::StreamConversions::Lc4dEncoder: LC4D compression.
• maxon::StreamConversions::Lc4dDecoder: LC4D decompression.

Note

For creating ZIP archives see Archives Manual.

Further Reading

• Algorithms
• Data & Algorithms
• BaseArray Manual
• String Manual
• InputStream Manual
• AES Manual
• AESFile Manual
• GeCipher256 Manual