Crypto++  8.8
Free C++ class library of cryptographic schemes
zlib.h
Go to the documentation of this file.
1 // zlib.h - originally written and placed in the public domain by Wei Dai
2 
3 /// \file zlib.h
4 /// \brief ZLIB compression and decompression (RFC 1950)
5 
6 #ifndef CRYPTOPP_ZLIB_H
7 #define CRYPTOPP_ZLIB_H
8 
9 #include "cryptlib.h"
10 #include "adler32.h"
11 #include "zdeflate.h"
12 #include "zinflate.h"
13 
14 NAMESPACE_BEGIN(CryptoPP)
15 
16 /// ZLIB Compressor (RFC 1950)
17 class ZlibCompressor : public Deflator
18 {
19 public:
20  ZlibCompressor(BufferedTransformation *attachment=NULLPTR, unsigned int deflateLevel=DEFAULT_DEFLATE_LEVEL, unsigned int log2WindowSize=DEFAULT_LOG2_WINDOW_SIZE, bool detectUncompressible=true)
21  : Deflator(attachment, deflateLevel, log2WindowSize, detectUncompressible) {}
22  ZlibCompressor(const NameValuePairs &parameters, BufferedTransformation *attachment=NULLPTR)
23  : Deflator(parameters, attachment) {}
24 
25  unsigned int GetCompressionLevel() const;
26 
27 protected:
28  void WritePrestreamHeader();
29  void ProcessUncompressedData(const byte *string, size_t length);
30  void WritePoststreamTail();
31 
32  Adler32 m_adler32;
33 };
34 
35 /// ZLIB Decompressor (RFC 1950)
36 class ZlibDecompressor : public Inflator
37 {
38 public:
39  typedef Inflator::Err Err;
40  class HeaderErr : public Err {public: HeaderErr() : Err(INVALID_DATA_FORMAT, "ZlibDecompressor: header decoding error") {}};
41  class Adler32Err : public Err {public: Adler32Err() : Err(DATA_INTEGRITY_CHECK_FAILED, "ZlibDecompressor: ADLER32 check error") {}};
42  class UnsupportedAlgorithm : public Err {public: UnsupportedAlgorithm() : Err(INVALID_DATA_FORMAT, "ZlibDecompressor: unsupported algorithm") {}};
43  class UnsupportedPresetDictionary : public Err {public: UnsupportedPresetDictionary() : Err(INVALID_DATA_FORMAT, "ZlibDecompressor: unsupported preset dictionary") {}};
44 
45  /// \brief Construct a ZlibDecompressor
46  /// \param attachment a \ BufferedTransformation to attach to this object
47  /// \param repeat decompress multiple compressed streams in series
48  /// \param autoSignalPropagation 0 to turn off MessageEnd signal
49  ZlibDecompressor(BufferedTransformation *attachment = NULLPTR, bool repeat = false, int autoSignalPropagation = -1);
50  unsigned int GetLog2WindowSize() const {return m_log2WindowSize;}
51 
52 private:
53  unsigned int MaxPrestreamHeaderSize() const {return 2;}
54  void ProcessPrestreamHeader();
55  void ProcessDecompressedData(const byte *string, size_t length);
56  unsigned int MaxPoststreamTailSize() const {return 4;}
57  void ProcessPoststreamTail();
58 
59  unsigned int m_log2WindowSize;
60  Adler32 m_adler32;
61 };
62 
63 NAMESPACE_END
64 
65 #endif
Class file for ADLER-32 checksum calculations.
ADLER-32 checksum calculations.
Definition: adler32.h:15
Interface for buffered transformations.
Definition: cryptlib.h:1657
DEFLATE compressor (RFC 1951)
Definition: zdeflate.h:76
@ INVALID_DATA_FORMAT
Input data was received that did not conform to expected format.
Definition: cryptlib.h:178
@ DATA_INTEGRITY_CHECK_FAILED
Data integerity check, such as CRC or MAC, failed.
Definition: cryptlib.h:176
DEFLATE decompressor (RFC 1951)
Definition: zinflate.h:95
Interface for retrieving values given their names.
Definition: cryptlib.h:327
ZLIB Compressor (RFC 1950)
Definition: zlib.h:18
ZLIB Decompressor (RFC 1950)
Definition: zlib.h:37
ZlibDecompressor(BufferedTransformation *attachment=NULL, bool repeat=false, int autoSignalPropagation=-1)
Construct a ZlibDecompressor.
Definition: zlib.cpp:51
Abstract base classes that provide a uniform interface to this library.
Crypto++ library namespace.
DEFLATE compression and decompression (RFC 1951)
DEFLATE compression and decompression (RFC 1951)