FBB::OSymCryptStreambuf(3bobcat) | Symmetric en- and decryption | FBB::OSymCryptStreambuf(3bobcat) |
FBB::OSymCryptStreambuf - std::streambuf performing symmetric en/decryption
#include <bobcat/osymcryptstreambuf>
Linking option: -lbobcat -lcrypto
FBB::OSymCryptStreambuf objects can be used as std::streambuf objects of std::ostream objects, and encrypt or decrypt information, that is made available via separate std::istream streams.
The class OSymCryptStreambuf is a class template, using a FBB::CryptType template non-type parameter. Objects of the class FBB::OSymCryptStreambuf<FBB::ENCRYPT> encrypt the information they receive, objects of the class FBB::OSymCryptStreambuf<FBB::DECRYPT> decrypt the information they receive.
All symmetric encryption methods defined by the OpenSSL library that can be selected by name may be used to en/decrypt information. To select a particular encryption method an identifier is passed to the constructor. E.g., "aes-256-gcm". For an overview of the currently supported cipher algorithms issue the command
openssl list -cipher-algorithms
OSymCryptStreambuf objects read the information to en/decrypt from an external source (e.g., from std::istream objects). The characters that are encrypted or decrypted by OSymCryptStreambuf objects are written to std::ostream objects which are at construction-time specified as ostream references or by filename.
FBB
All constructors, members, operators and manipulators, mentioned in this
man-page, are defined in the namespace FBB.
FBB::OSymCryptBase (public)
The class FBB::OSymCryptBase is an `internal use only’ class, derived from std::streambuf, and therefore OSymCryptStreambuf is a std::streambuf class.
If the construction fails an exception is thrown, mentioning the openssl function that failed to complete (see also errorMsg below).
The move constructor is available, the copy constructor and assignment operators are not available,
Since the class is publicly derived from std::ostream, all std::streambuf members can be used.
The latter two functions throw exceptions if cipherName does not contain the name of a supported cipher algorithm.
See the example in the osymcryptstream(3bobcat) man-page. Instead of defining an OSymCryptStream an OSymCryptStreamBuf can be defined, passing its address to a std::ostream which can then be used as the OSymCryptStream used in the example.
bobcat/osymcryptstreambuf - defines the class interface
bobcat(7), isymcryptstream(3bobcat), isymcryptstreambuf(3bobcat), osymcryptstream(3bobcat)
None Reported.
Bobcat is an acronym of `Brokken’s Own Base Classes And Templates’.
This is free software, distributed under the terms of the GNU General Public License (GPL).
Frank B. Brokken (f.b.brokken@rug.nl).
2005-2022 | libbobcat-dev_6.02.02 |