libDwmAuth-0.3.6
DwmXChaCha20Poly1305Ostream.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $Name:$
3 // @(#) $Id: DwmXChaCha20Poly1305Ostream.hh 10927 2020-08-16 22:58:53Z dwm $
4 //===========================================================================
5 // Copyright (c) Daniel W. McRobb 2020
6 // All rights reserved.
7 //
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions
10 // are met:
11 //
12 // 1. Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // 2. Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // 3. The names of the authors and copyright holders may not be used to
18 // endorse or promote products derived from this software without
19 // specific prior written permission.
20 //
21 // IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
22 // DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
23 // INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
24 // EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
25 // DAMAGE.
26 //
27 // THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
28 // DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
29 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
30 // REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
31 // IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
32 // WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
33 // OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
34 // TRADEMARK OR OTHER RIGHTS.
35 //===========================================================================
36 
37 //---------------------------------------------------------------------------
40 //---------------------------------------------------------------------------
41 
42 #ifndef _DWMXCHACHA20POLY1305OSTREAM_HH_
43 #define _DWMXCHACHA20POLY1305OSTREAM_HH_
44 
46 
47 namespace Dwm {
48 
49  namespace XChaCha20Poly1305 {
50 
51  //------------------------------------------------------------------------
86  //------------------------------------------------------------------------
87  class Ostream
88  : public std::ostream
89  {
90  public:
91  //----------------------------------------------------------------------
95  //----------------------------------------------------------------------
96  Ostream(std::ostream & os, const std::string & key)
97  : std::ostream(new OutBuffer(os, key))
98  {}
99 
100  //----------------------------------------------------------------------
102  //----------------------------------------------------------------------
103  virtual ~Ostream()
104  {
105  delete rdbuf();
106  }
107 
108  };
109 
110  } // namespace XChaCha20Poly1305
111 
112 } // namespace Dwm
113 
114 #endif // _DWMXCHACHA20POLY1305OSTREAM_HH_
This class is a helper for encrypted stream output.
Definition: DwmXChaCha20Poly1305OutBuffer.hh:69
virtual ~Ostream()
Destructor.
Definition: DwmXChaCha20Poly1305Ostream.hh:103
Ostream(std::ostream &os, const std::string &key)
Construct with a reference to the destination ostream os and the 32-byte encryption key.
Definition: DwmXChaCha20Poly1305Ostream.hh:96
Dwm::XChaCha20Poly1305::OutBuffer class declaration.
This class is essentially a filter for an existing ostream, allowing the user to encrypt data to that...
Definition: DwmXChaCha20Poly1305Ostream.hh:87