4
// $Id: //poco/1.3/Crypto/include/Poco/Crypto/CryptoTransform.h#1 $
8
// Module: CryptoTransform
10
// Definition of the CryptoTransform class.
12
// Copyright (c) 2008, Applied Informatics Software Engineering GmbH.
15
// Permission is hereby granted, free of charge, to any person or organization
16
// obtaining a copy of the software and accompanying documentation covered by
17
// this license (the "Software") to use, reproduce, display, distribute,
18
// execute, and transmit the Software, and to prepare derivative works of the
19
// Software, and to permit third-parties to whom the Software is furnished to
20
// do so, all subject to the following:
22
// The copyright notices in the Software and this entire statement, including
23
// the above license grant, this restriction and the following disclaimer,
24
// must be included in all copies of the Software, in whole or in part, and
25
// all derivative works of the Software, unless such copies or derivative
26
// works are solely in the form of machine-executable object code generated by
27
// a source language processor.
29
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
31
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
32
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
33
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
34
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
35
// DEALINGS IN THE SOFTWARE.
39
#ifndef Crypto_CryptoTransform_INCLUDED
40
#define Crypto_CryptoTransform_INCLUDED
43
#include "Poco/Crypto/Crypto.h"
50
class Crypto_API CryptoTransform
51
/// This interface represents the basic operations for cryptographic
52
/// transformations to be used with a CryptoInputStream or a
53
/// CryptoOutputStream.
55
/// Implementations of this class are returned by the Cipher class to
56
/// perform encryption or decryption of data.
60
/// Creates a new CryptoTransform object.
62
virtual ~CryptoTransform();
63
/// Destroys the CryptoTransform.
65
virtual std::size_t blockSize() const = 0;
66
/// Returns the block size for this CryptoTransform.
68
virtual std::streamsize transform(
69
const unsigned char* input,
70
std::streamsize inputLength,
71
unsigned char* output,
72
std::streamsize outputLength) = 0;
73
/// Transforms a chunk of data. The inputLength is arbitrary and does not
74
/// need to be a multiple of the block size. The output buffer has a maximum
75
/// capacity of the given outputLength that must be at least
76
/// inputLength + bufferSize() - 1
77
/// Returns the number of bytes written to the output buffer.
79
virtual std::streamsize finalize(unsigned char* output, std::streamsize length) = 0;
80
/// Finalizes the transformation. The output buffer must contain enough
81
/// space for at least one block, ie.
82
/// length >= bufferSize()
83
/// must be true. Returns the number of bytes written to the output
88
} } // namespace Poco::Crypto
91
#endif // Crypto_CryptoTransform_INCLUDED