Crypto++  5.6.5
Free C++ class library of cryptographic schemes
filters.cpp
1 // filters.cpp - originally written and placed in the public domain by Wei Dai
2 
3 #include "pch.h"
4 #include "config.h"
5 
6 #if CRYPTOPP_MSC_VERSION
7 # pragma warning(disable: 4100 4189 4355)
8 #endif
9 
10 #if CRYPTOPP_GCC_DIAGNOSTIC_AVAILABLE
11 # pragma GCC diagnostic ignored "-Wunused-value"
12 #endif
13 
14 #ifndef CRYPTOPP_IMPORTS
15 
16 #include "filters.h"
17 #include "mqueue.h"
18 #include "fltrimpl.h"
19 #include "argnames.h"
20 #include "smartptr.h"
21 #include "stdcpp.h"
22 #include "misc.h"
23 
24 NAMESPACE_BEGIN(CryptoPP)
25 
27  : m_attachment(attachment), m_inputPosition(0), m_continueAt(0)
28 {
29 }
30 
31 BufferedTransformation * Filter::NewDefaultAttachment() const
32 {
33  return new MessageQueue;
34 }
35 
37 {
38  if (m_attachment.get() == NULLPTR)
39  m_attachment.reset(NewDefaultAttachment());
40  return m_attachment.get();
41 }
42 
44 {
45  if (m_attachment.get() == NULLPTR)
46  const_cast<Filter *>(this)->m_attachment.reset(NewDefaultAttachment());
47  return m_attachment.get();
48 }
49 
51 {
52  m_attachment.reset(newOut);
53 }
54 
55 void Filter::Insert(Filter *filter)
56 {
57  filter->m_attachment.reset(m_attachment.release());
58  m_attachment.reset(filter);
59 }
60 
61 size_t Filter::CopyRangeTo2(BufferedTransformation &target, lword &begin, lword end, const std::string &channel, bool blocking) const
62 {
63  return AttachedTransformation()->CopyRangeTo2(target, begin, end, channel, blocking);
64 }
65 
66 size_t Filter::TransferTo2(BufferedTransformation &target, lword &transferBytes, const std::string &channel, bool blocking)
67 {
68  return AttachedTransformation()->TransferTo2(target, transferBytes, channel, blocking);
69 }
70 
71 void Filter::Initialize(const NameValuePairs &parameters, int propagation)
72 {
73  m_inputPosition = m_continueAt = 0;
74  IsolatedInitialize(parameters);
75  PropagateInitialize(parameters, propagation);
76 }
77 
78 bool Filter::Flush(bool hardFlush, int propagation, bool blocking)
79 {
80  switch (m_continueAt)
81  {
82  case 0:
83  if (IsolatedFlush(hardFlush, blocking))
84  return true;
85  // fall through
86  case 1:
87  if (OutputFlush(1, hardFlush, propagation, blocking))
88  return true;
89  // fall through
90  default: ;;
91  }
92  return false;
93 }
94 
95 bool Filter::MessageSeriesEnd(int propagation, bool blocking)
96 {
97  switch (m_continueAt)
98  {
99  case 0:
100  if (IsolatedMessageSeriesEnd(blocking))
101  return true;
102  // fall through
103  case 1:
104  if (ShouldPropagateMessageSeriesEnd() && OutputMessageSeriesEnd(1, propagation, blocking))
105  return true;
106  // fall through
107  default: ;;
108  }
109  return false;
110 }
111 
112 void Filter::PropagateInitialize(const NameValuePairs &parameters, int propagation)
113 {
114  if (propagation)
115  AttachedTransformation()->Initialize(parameters, propagation-1);
116 }
117 
118 size_t Filter::OutputModifiable(int outputSite, byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel)
119 {
120  if (messageEnd)
121  messageEnd--;
122  size_t result = AttachedTransformation()->ChannelPutModifiable2(channel, inString, length, messageEnd, blocking);
123  m_continueAt = result ? outputSite : 0;
124  return result;
125 }
126 
127 size_t Filter::Output(int outputSite, const byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel)
128 {
129  if (messageEnd)
130  messageEnd--;
131  size_t result = AttachedTransformation()->ChannelPut2(channel, inString, length, messageEnd, blocking);
132  m_continueAt = result ? outputSite : 0;
133  return result;
134 }
135 
136 bool Filter::OutputFlush(int outputSite, bool hardFlush, int propagation, bool blocking, const std::string &channel)
137 {
138  if (propagation && AttachedTransformation()->ChannelFlush(channel, hardFlush, propagation-1, blocking))
139  {
140  m_continueAt = outputSite;
141  return true;
142  }
143  m_continueAt = 0;
144  return false;
145 }
146 
147 bool Filter::OutputMessageSeriesEnd(int outputSite, int propagation, bool blocking, const std::string &channel)
148 {
149  if (propagation && AttachedTransformation()->ChannelMessageSeriesEnd(channel, propagation-1, blocking))
150  {
151  m_continueAt = outputSite;
152  return true;
153  }
154  m_continueAt = 0;
155  return false;
156 }
157 
158 // *************************************************************
159 
161 {
162  m_currentMessageBytes = m_totalBytes = m_currentSeriesMessages = m_totalMessages = m_totalMessageSeries = 0;
163  m_rangesToSkip.clear();
164 }
165 
166 void MeterFilter::AddRangeToSkip(unsigned int message, lword position, lword size, bool sortNow)
167 {
168  MessageRange r = {message, position, size};
169  m_rangesToSkip.push_back(r);
170  if (sortNow)
171  std::sort(m_rangesToSkip.begin(), m_rangesToSkip.end());
172 }
173 
174 size_t MeterFilter::PutMaybeModifiable(byte *begin, size_t length, int messageEnd, bool blocking, bool modifiable)
175 {
176  if (!m_transparent)
177  return 0;
178 
179  size_t t;
180  FILTER_BEGIN;
181 
182  m_begin = begin;
183  m_length = length;
184 
185  while (m_length > 0 || messageEnd)
186  {
187  if (m_length > 0 && !m_rangesToSkip.empty() && m_rangesToSkip.front().message == m_totalMessages && m_currentMessageBytes + m_length > m_rangesToSkip.front().position)
188  {
189  FILTER_OUTPUT_MAYBE_MODIFIABLE(1, m_begin, t = (size_t)SaturatingSubtract(m_rangesToSkip.front().position, m_currentMessageBytes), false, modifiable);
190 
191  CRYPTOPP_ASSERT(t < m_length);
192  m_begin += t;
193  m_length -= t;
194  m_currentMessageBytes += t;
195  m_totalBytes += t;
196 
197  if (m_currentMessageBytes + m_length < m_rangesToSkip.front().position + m_rangesToSkip.front().size)
198  t = m_length;
199  else
200  {
201  t = (size_t)SaturatingSubtract(m_rangesToSkip.front().position + m_rangesToSkip.front().size, m_currentMessageBytes);
202  CRYPTOPP_ASSERT(t <= m_length);
203  m_rangesToSkip.pop_front();
204  }
205 
206  m_begin += t;
207  m_length -= t;
208  m_currentMessageBytes += t;
209  m_totalBytes += t;
210  }
211  else
212  {
213  FILTER_OUTPUT_MAYBE_MODIFIABLE(2, m_begin, m_length, messageEnd, modifiable);
214 
215  m_currentMessageBytes += m_length;
216  m_totalBytes += m_length;
217  m_length = 0;
218 
219  if (messageEnd)
220  {
221  m_currentMessageBytes = 0;
222  m_currentSeriesMessages++;
223  m_totalMessages++;
224  messageEnd = false;
225  }
226  }
227  }
228 
229  FILTER_END_NO_MESSAGE_END;
230 }
231 
232 size_t MeterFilter::Put2(const byte *begin, size_t length, int messageEnd, bool blocking)
233 {
234  return PutMaybeModifiable(const_cast<byte *>(begin), length, messageEnd, blocking, false);
235 }
236 
237 size_t MeterFilter::PutModifiable2(byte *begin, size_t length, int messageEnd, bool blocking)
238 {
239  return PutMaybeModifiable(begin, length, messageEnd, blocking, true);
240 }
241 
243 {
244  CRYPTOPP_UNUSED(blocking);
245  m_currentMessageBytes = 0;
246  m_currentSeriesMessages = 0;
247  m_totalMessageSeries++;
248  return false;
249 }
250 
251 // *************************************************************
252 
253 void FilterWithBufferedInput::BlockQueue::ResetQueue(size_t blockSize, size_t maxBlocks)
254 {
255  m_buffer.New(blockSize * maxBlocks);
256  m_blockSize = blockSize;
257  m_maxBlocks = maxBlocks;
258  m_size = 0;
259  m_begin = m_buffer;
260 }
261 
262 byte *FilterWithBufferedInput::BlockQueue::GetBlock()
263 {
264  if (m_size >= m_blockSize)
265  {
266  byte *ptr = m_begin;
267  if ((m_begin+=m_blockSize) == m_buffer.end())
268  m_begin = m_buffer;
269  m_size -= m_blockSize;
270  return ptr;
271  }
272  else
273  return NULLPTR;
274 }
275 
276 byte *FilterWithBufferedInput::BlockQueue::GetContigousBlocks(size_t &numberOfBytes)
277 {
278  numberOfBytes = STDMIN(numberOfBytes, STDMIN(size_t(m_buffer.end()-m_begin), m_size));
279  byte *ptr = m_begin;
280  m_begin += numberOfBytes;
281  m_size -= numberOfBytes;
282  if (m_size == 0 || m_begin == m_buffer.end())
283  m_begin = m_buffer;
284  return ptr;
285 }
286 
287 size_t FilterWithBufferedInput::BlockQueue::GetAll(byte *outString)
288 {
289  // Avoid passing NULL pointer to memcpy
290  if (!outString) return 0;
291 
292  size_t size = m_size;
293  size_t numberOfBytes = m_maxBlocks*m_blockSize;
294  const byte *ptr = GetContigousBlocks(numberOfBytes);
295  memcpy(outString, ptr, numberOfBytes);
296  memcpy(outString+numberOfBytes, m_begin, m_size);
297  m_size = 0;
298  return size;
299 }
300 
301 void FilterWithBufferedInput::BlockQueue::Put(const byte *inString, size_t length)
302 {
303  // Avoid passing NULL pointer to memcpy
304  if (!inString || !length) return;
305 
306  CRYPTOPP_ASSERT(m_size + length <= m_buffer.size());
307  byte *end = (m_size < size_t(m_buffer.end()-m_begin)) ? m_begin + m_size : m_begin + m_size - m_buffer.size();
308  size_t len = STDMIN(length, size_t(m_buffer.end()-end));
309  memcpy(end, inString, len);
310  if (len < length)
311  memcpy(m_buffer, inString+len, length-len);
312  m_size += length;
313 }
314 
316  : Filter(attachment), m_firstSize(SIZE_MAX), m_blockSize(0), m_lastSize(SIZE_MAX), m_firstInputDone(false)
317 {
318 }
319 
320 FilterWithBufferedInput::FilterWithBufferedInput(size_t firstSize, size_t blockSize, size_t lastSize, BufferedTransformation *attachment)
321  : Filter(attachment), m_firstSize(firstSize), m_blockSize(blockSize), m_lastSize(lastSize), m_firstInputDone(false)
322 {
323  if (m_firstSize == SIZE_MAX || m_blockSize < 1 || m_lastSize == SIZE_MAX)
324  throw InvalidArgument("FilterWithBufferedInput: invalid buffer size");
325 
326  m_queue.ResetQueue(1, m_firstSize);
327 }
328 
330 {
331  InitializeDerivedAndReturnNewSizes(parameters, m_firstSize, m_blockSize, m_lastSize);
332  if (m_firstSize == SIZE_MAX || m_blockSize < 1 || m_lastSize == SIZE_MAX)
333  throw InvalidArgument("FilterWithBufferedInput: invalid buffer size");
334  m_queue.ResetQueue(1, m_firstSize);
335  m_firstInputDone = false;
336 }
337 
338 bool FilterWithBufferedInput::IsolatedFlush(bool hardFlush, bool blocking)
339 {
340  if (!blocking)
341  throw BlockingInputOnly("FilterWithBufferedInput");
342 
343  if (hardFlush)
344  ForceNextPut();
345  FlushDerived();
346 
347  return false;
348 }
349 
350 size_t FilterWithBufferedInput::PutMaybeModifiable(byte *inString, size_t length, int messageEnd, bool blocking, bool modifiable)
351 {
352  if (!blocking)
353  throw BlockingInputOnly("FilterWithBufferedInput");
354 
355  if (length != 0)
356  {
357  size_t newLength = m_queue.CurrentSize() + length;
358 
359  if (!m_firstInputDone && newLength >= m_firstSize)
360  {
361  size_t len = m_firstSize - m_queue.CurrentSize();
362  m_queue.Put(inString, len);
363  FirstPut(m_queue.GetContigousBlocks(m_firstSize));
364  CRYPTOPP_ASSERT(m_queue.CurrentSize() == 0);
365  m_queue.ResetQueue(m_blockSize, (2*m_blockSize+m_lastSize-2)/m_blockSize);
366 
367  inString += len;
368  newLength -= m_firstSize;
369  m_firstInputDone = true;
370  }
371 
372  if (m_firstInputDone)
373  {
374  if (m_blockSize == 1)
375  {
376  while (newLength > m_lastSize && m_queue.CurrentSize() > 0)
377  {
378  size_t len = newLength - m_lastSize;
379  byte *ptr = m_queue.GetContigousBlocks(len);
380  NextPutModifiable(ptr, len);
381  newLength -= len;
382  }
383 
384  if (newLength > m_lastSize)
385  {
386  size_t len = newLength - m_lastSize;
387  NextPutMaybeModifiable(inString, len, modifiable);
388  inString += len;
389  newLength -= len;
390  }
391  }
392  else
393  {
394  while (newLength >= m_blockSize + m_lastSize && m_queue.CurrentSize() >= m_blockSize)
395  {
396  NextPutModifiable(m_queue.GetBlock(), m_blockSize);
397  newLength -= m_blockSize;
398  }
399 
400  if (newLength >= m_blockSize + m_lastSize && m_queue.CurrentSize() > 0)
401  {
402  CRYPTOPP_ASSERT(m_queue.CurrentSize() < m_blockSize);
403  size_t len = m_blockSize - m_queue.CurrentSize();
404  m_queue.Put(inString, len);
405  inString += len;
406  NextPutModifiable(m_queue.GetBlock(), m_blockSize);
407  newLength -= m_blockSize;
408  }
409 
410  if (newLength >= m_blockSize + m_lastSize)
411  {
412  size_t len = RoundDownToMultipleOf(newLength - m_lastSize, m_blockSize);
413  NextPutMaybeModifiable(inString, len, modifiable);
414  inString += len;
415  newLength -= len;
416  }
417  }
418  }
419 
420  m_queue.Put(inString, newLength - m_queue.CurrentSize());
421  }
422 
423  if (messageEnd)
424  {
425  if (!m_firstInputDone && m_firstSize==0)
426  FirstPut(NULLPTR);
427 
428  SecByteBlock temp(m_queue.CurrentSize());
429  m_queue.GetAll(temp);
430  LastPut(temp, temp.size());
431 
432  m_firstInputDone = false;
433  m_queue.ResetQueue(1, m_firstSize);
434 
435  // Cast to void to suppress Coverity finding
436  (void)Output(1, NULLPTR, 0, messageEnd, blocking);
437  }
438  return 0;
439 }
440 
442 {
443  if (!m_firstInputDone)
444  return;
445 
446  if (m_blockSize > 1)
447  {
448  while (m_queue.CurrentSize() >= m_blockSize)
449  NextPutModifiable(m_queue.GetBlock(), m_blockSize);
450  }
451  else
452  {
453  size_t len;
454  while ((len = m_queue.CurrentSize()) > 0)
455  NextPutModifiable(m_queue.GetContigousBlocks(len), len);
456  }
457 }
458 
459 void FilterWithBufferedInput::NextPutMultiple(const byte *inString, size_t length)
460 {
461  CRYPTOPP_ASSERT(m_blockSize > 1); // m_blockSize = 1 should always override this function
462  while (length > 0)
463  {
464  CRYPTOPP_ASSERT(length >= m_blockSize);
465  NextPutSingle(inString);
466  inString += m_blockSize;
467  length -= m_blockSize;
468  }
469 }
470 
471 // *************************************************************
472 
473 void Redirector::Initialize(const NameValuePairs &parameters, int propagation)
474 {
475  m_target = parameters.GetValueWithDefault("RedirectionTargetPointer", (BufferedTransformation*)NULLPTR);
476  m_behavior = parameters.GetIntValueWithDefault("RedirectionBehavior", PASS_EVERYTHING);
477 
478  if (m_target && GetPassSignals())
479  m_target->Initialize(parameters, propagation);
480 }
481 
482 // *************************************************************
483 
484 ProxyFilter::ProxyFilter(BufferedTransformation *filter, size_t firstSize, size_t lastSize, BufferedTransformation *attachment)
485  : FilterWithBufferedInput(firstSize, 1, lastSize, attachment), m_filter(filter)
486 {
487  if (m_filter.get())
488  m_filter->Attach(new OutputProxy(*this, false));
489 }
490 
491 bool ProxyFilter::IsolatedFlush(bool hardFlush, bool blocking)
492 {
493  return m_filter.get() ? m_filter->Flush(hardFlush, -1, blocking) : false;
494 }
495 
497 {
498  m_filter.reset(filter);
499  if (filter)
500  {
501  OutputProxy *proxy;
502  member_ptr<OutputProxy> temp(proxy = new OutputProxy(*this, false));
503  m_filter->TransferAllTo(*proxy);
504  m_filter->Attach(temp.release());
505  }
506 }
507 
508 void ProxyFilter::NextPutMultiple(const byte *s, size_t len)
509 {
510  if (m_filter.get())
511  m_filter->Put(s, len);
512 }
513 
514 void ProxyFilter::NextPutModifiable(byte *s, size_t len)
515 {
516  if (m_filter.get())
517  m_filter->PutModifiable(s, len);
518 }
519 
520 // *************************************************************
521 
523 {
524  parameters.GetRequiredParameter("RandomNumberSink", "RandomNumberGeneratorPointer", m_rng);
525 }
526 
527 size_t RandomNumberSink::Put2(const byte *begin, size_t length, int messageEnd, bool blocking)
528 {
529  CRYPTOPP_UNUSED(messageEnd); CRYPTOPP_UNUSED(blocking);
530  m_rng->IncorporateEntropy(begin, length);
531  return 0;
532 }
533 
534 size_t ArraySink::Put2(const byte *begin, size_t length, int messageEnd, bool blocking)
535 {
536  CRYPTOPP_UNUSED(messageEnd); CRYPTOPP_UNUSED(blocking);
537 
538  // Avoid passing NULL pointer to memcpy. Using memmove due to
539  // Valgrind finding on overlapping buffers.
540  size_t copied = 0;
541  if (m_buf && begin)
542  {
543  copied = STDMIN(length, SaturatingSubtract(m_size, m_total));
544  memmove(m_buf+m_total, begin, copied);
545  }
546  m_total += copied;
547  return length - copied;
548 }
549 
550 byte * ArraySink::CreatePutSpace(size_t &size)
551 {
552  size = SaturatingSubtract(m_size, m_total);
553  return m_buf + m_total;
554 }
555 
557 {
558  ByteArrayParameter array;
559  if (!parameters.GetValue(Name::OutputBuffer(), array))
560  throw InvalidArgument("ArraySink: missing OutputBuffer argument");
561  m_buf = array.begin();
562  m_size = array.size();
563 }
564 
565 size_t ArrayXorSink::Put2(const byte *begin, size_t length, int messageEnd, bool blocking)
566 {
567  CRYPTOPP_UNUSED(messageEnd); CRYPTOPP_UNUSED(blocking);
568 
569  // Avoid passing NULL pointer to xorbuf
570  size_t copied = 0;
571  if (m_buf && begin)
572  {
573  copied = STDMIN(length, SaturatingSubtract(m_size, m_total));
574  xorbuf(m_buf+m_total, begin, copied);
575  }
576  m_total += copied;
577  return length - copied;
578 }
579 
580 // *************************************************************
581 
583  : FilterWithBufferedInput(attachment), m_cipher(c), m_padding(DEFAULT_PADDING)
584 {
586 
587  const bool authenticatedFilter = dynamic_cast<AuthenticatedSymmetricCipher *>(&c) != NULLPTR;
588  if (authenticatedFilter)
589  throw InvalidArgument("StreamTransformationFilter: please use AuthenticatedEncryptionFilter and AuthenticatedDecryptionFilter for AuthenticatedSymmetricCipher");
590 
591  // InitializeDerivedAndReturnNewSizes may override some of these
592  m_mandatoryBlockSize = m_cipher.MandatoryBlockSize();
593  m_optimalBufferSize = m_cipher.OptimalBlockSize();
594  m_isSpecial = m_cipher.IsLastBlockSpecial() && m_mandatoryBlockSize > 1;
595  m_reservedBufferSize = STDMAX(2*m_mandatoryBlockSize, m_optimalBufferSize);
596 
598 }
599 
601  : FilterWithBufferedInput(attachment), m_cipher(c), m_padding(DEFAULT_PADDING)
602 {
603  const bool authenticatedFilter = dynamic_cast<AuthenticatedSymmetricCipher *>(&c) != NULLPTR;
604  if (!authenticatedFilter)
605  {
607  }
608 
609  if (authenticatedFilter && !authenticated)
610  throw InvalidArgument("StreamTransformationFilter: please use AuthenticatedEncryptionFilter and AuthenticatedDecryptionFilter for AuthenticatedSymmetricCipher");
611 
612  // InitializeDerivedAndReturnNewSizes may override some of these
613  m_mandatoryBlockSize = m_cipher.MandatoryBlockSize();
614  m_optimalBufferSize = m_cipher.OptimalBlockSize();
615  m_isSpecial = m_cipher.IsLastBlockSpecial() && m_mandatoryBlockSize > 1;
616  m_reservedBufferSize = STDMAX(2*m_mandatoryBlockSize, m_optimalBufferSize);
617 
619 }
620 
621 size_t StreamTransformationFilter::LastBlockSize(StreamTransformation &c, BlockPaddingScheme padding)
622 {
623  if (c.MinLastBlockSize() > 0)
624  return c.MinLastBlockSize();
625  else if (c.MandatoryBlockSize() > 1 && !c.IsForwardTransformation() && padding != NO_PADDING && padding != ZEROS_PADDING)
626  return c.MandatoryBlockSize();
627 
628  return 0;
629 }
630 
631 void StreamTransformationFilter::InitializeDerivedAndReturnNewSizes(const NameValuePairs &parameters, size_t &firstSize, size_t &blockSize, size_t &lastSize)
632 {
634  bool isBlockCipher = (m_mandatoryBlockSize > 1 && m_cipher.MinLastBlockSize() == 0);
635 
636  if (padding == DEFAULT_PADDING)
637  m_padding = isBlockCipher ? PKCS_PADDING : NO_PADDING;
638  else
639  m_padding = padding;
640 
641  if (!isBlockCipher)
642  {
643  if (m_padding == PKCS_PADDING)
644  throw InvalidArgument("StreamTransformationFilter: PKCS_PADDING cannot be used with " + m_cipher.AlgorithmName());
645  else if (m_padding == W3C_PADDING)
646  throw InvalidArgument("StreamTransformationFilter: W3C_PADDING cannot be used with " + m_cipher.AlgorithmName());
647  else if (m_padding == ONE_AND_ZEROS_PADDING)
648  throw InvalidArgument("StreamTransformationFilter: ONE_AND_ZEROS_PADDING cannot be used with " + m_cipher.AlgorithmName());
649  }
650 
651  firstSize = 0;
652  blockSize = m_mandatoryBlockSize;
653  lastSize = LastBlockSize(m_cipher, m_padding);
654 }
655 
656 void StreamTransformationFilter::FirstPut(const byte* inString)
657 {
658  CRYPTOPP_UNUSED(inString);
659  m_optimalBufferSize = STDMAX<unsigned int>(m_optimalBufferSize, RoundDownToMultipleOf(4096U, m_optimalBufferSize));
660 }
661 
662 void StreamTransformationFilter::NextPutMultiple(const byte *inString, size_t length)
663 {
664  if (!length)
665  {return;}
666 
667  const size_t s = m_cipher.MandatoryBlockSize();
668  do
669  {
670  size_t len = m_optimalBufferSize;
671  byte *space = HelpCreatePutSpace(*AttachedTransformation(), DEFAULT_CHANNEL, s, length, len);
672  if (len < length)
673  {
674  if (len == m_optimalBufferSize)
675  len -= m_cipher.GetOptimalBlockSizeUsed();
676  len = RoundDownToMultipleOf(len, s);
677  }
678  else
679  len = length;
680  m_cipher.ProcessString(space, inString, len);
681  AttachedTransformation()->PutModifiable(space, len);
682  inString += len;
683  length -= len;
684  }
685  while (length > 0);
686 }
687 
688 void StreamTransformationFilter::NextPutModifiable(byte *inString, size_t length)
689 {
690  m_cipher.ProcessString(inString, length);
691  AttachedTransformation()->PutModifiable(inString, length);
692 }
693 
694 void StreamTransformationFilter::LastPut(const byte *inString, size_t length)
695 {
696  byte *space = NULLPTR;
697 
698 #if 1
699  // This block is new to StreamTransformationFilter. It somewhat of a hack and was added
700  // for OCB mode; see GitHub Issue 515. The rub with OCB is, its a block cipher and the
701  // last block size can be 0. However, "last block = 0" is not the 0 predacted in the
702  // original code. In the orginal code 0 means "nothing special" so DEFAULT_PADDING is
703  // applied. OCB's 0 literally means a final block size can be 0 or non-0; and no padding
704  // is needed in either case because OCB has its own scheme (see handling of P_* and A_*).
705  // Stream ciphers have policy objects to convey how to operate the cipher. The Crypto++
706  // framework operates well when MinLastBlockSize() is 1. However, it did not appear to
707  // cover the OCB case either because we can't stream OCB. It needs full block sizes. In
708  // response we hacked a IsLastBlockSpecial(). When true StreamTransformationFilter
709  // defers to the mode for processing of the last block.
710  // The behavior supplied when IsLastBlockSpecial() will likely have to evolve to capture
711  // more complex cases from different authenc modes. I suspect it will have to change
712  // from a simple bool to something that conveys more information, like "last block
713  // no padding" or "custom padding applied by cipher".
714  // In some respect we have already hit the need for more information. For example, OCB
715  // calculates the checksum on the cipher text at the same time, so we don't need the
716  // disjoint behavior of calling "EncryptBlock" followed by a separate "AuthenticateBlock".
717  // Additional information may allow us to avoid the two spearate calls.
718  if (m_isSpecial)
719  {
720  const size_t leftOver = length % m_mandatoryBlockSize;
721  space = HelpCreatePutSpace(*AttachedTransformation(), DEFAULT_CHANNEL, m_reservedBufferSize);
722 
723  length -= leftOver;
724  if (length)
725  {
726  // Process full blocks
727  m_cipher.ProcessData(space, inString, length);
728  AttachedTransformation()->Put(space, length);
729  inString += length;
730  }
731 
732  if (leftOver)
733  {
734  // Process final partial block
735  length = m_cipher.ProcessLastBlock(space, m_reservedBufferSize, inString, leftOver);
736  AttachedTransformation()->Put(space, length);
737  }
738  else
739  {
740  // Process final empty block
741  length = m_cipher.ProcessLastBlock(space, m_reservedBufferSize, NULLPTR, 0);
742  AttachedTransformation()->Put(space, length);
743  }
744 
745  return;
746  }
747 #endif
748 
749  switch (m_padding)
750  {
751  case NO_PADDING:
752  case ZEROS_PADDING:
753  if (length > 0)
754  {
755  const size_t minLastBlockSize = m_cipher.MinLastBlockSize();
756  const bool isForwardTransformation = m_cipher.IsForwardTransformation();
757 
758  if (isForwardTransformation && m_padding == ZEROS_PADDING && (minLastBlockSize == 0 || length < minLastBlockSize))
759  {
760  // do padding
761  size_t blockSize = STDMAX(minLastBlockSize, (size_t)m_mandatoryBlockSize);
763  if (inString) {memcpy(space, inString, length);}
764  memset(space + length, 0, blockSize - length);
765  size_t used = m_cipher.ProcessLastBlock(space, blockSize, space, blockSize);
766  AttachedTransformation()->Put(space, used);
767  }
768  else
769  {
770  if (minLastBlockSize == 0)
771  {
772  if (isForwardTransformation)
773  throw InvalidDataFormat("StreamTransformationFilter: plaintext length is not a multiple of block size and NO_PADDING is specified");
774  else
775  throw InvalidCiphertext("StreamTransformationFilter: ciphertext length is not a multiple of block size");
776  }
777 
778  space = HelpCreatePutSpace(*AttachedTransformation(), DEFAULT_CHANNEL, length, m_optimalBufferSize);
779  size_t used = m_cipher.ProcessLastBlock(space, length, inString, length);
780  AttachedTransformation()->Put(space, used);
781  }
782  }
783  break;
784 
785  case PKCS_PADDING:
786  case W3C_PADDING:
788  unsigned int s;
789  s = m_mandatoryBlockSize;
790  CRYPTOPP_ASSERT(s > 1);
791  space = HelpCreatePutSpace(*AttachedTransformation(), DEFAULT_CHANNEL, s, m_optimalBufferSize);
792  if (m_cipher.IsForwardTransformation())
793  {
794  CRYPTOPP_ASSERT(length < s);
795  if (inString) {memcpy(space, inString, length);}
796  if (m_padding == PKCS_PADDING)
797  {
798  CRYPTOPP_ASSERT(s < 256);
799  byte pad = static_cast<byte>(s-length);
800  memset(space+length, pad, s-length);
801  }
802  else if (m_padding == W3C_PADDING)
803  {
804  CRYPTOPP_ASSERT(s < 256);
805  memset(space+length, 0, s-length-1);
806  space[s-1] = static_cast<byte>(s-length);
807  }
808  else
809  {
810  space[length] = 0x80;
811  memset(space+length+1, 0, s-length-1);
812  }
813  m_cipher.ProcessData(space, space, s);
814  AttachedTransformation()->Put(space, s);
815  }
816  else
817  {
818  if (length != s)
819  throw InvalidCiphertext("StreamTransformationFilter: ciphertext length is not a multiple of block size");
820  m_cipher.ProcessData(space, inString, s);
821  if (m_padding == PKCS_PADDING)
822  {
823  byte pad = space[s-1];
824  if (pad < 1 || pad > s || FindIfNot(space+s-pad, space+s, pad) != space+s)
825  throw InvalidCiphertext("StreamTransformationFilter: invalid PKCS #7 block padding found");
826  length = s-pad;
827  }
828  else if (m_padding == W3C_PADDING)
829  {
830  byte pad = space[s - 1];
831  if (pad < 1 || pad > s)
832  throw InvalidCiphertext("StreamTransformationFilter: invalid W3C block padding found");
833  length = s - pad;
834  }
835  else
836  {
837  while (length > 1 && space[length-1] == 0)
838  --length;
839  if (space[--length] != 0x80)
840  throw InvalidCiphertext("StreamTransformationFilter: invalid ones-and-zeros padding found");
841  }
842  AttachedTransformation()->Put(space, length);
843  }
844  break;
845 
846  default:
847  CRYPTOPP_ASSERT(false);
848  }
849 }
850 
851 // *************************************************************
852 
853 HashFilter::HashFilter(HashTransformation &hm, BufferedTransformation *attachment, bool putMessage, int truncatedDigestSize, const std::string &messagePutChannel, const std::string &hashPutChannel)
854  : m_hashModule(hm), m_putMessage(putMessage), m_digestSize(0), m_space(NULLPTR)
855  , m_messagePutChannel(messagePutChannel), m_hashPutChannel(hashPutChannel)
856 {
857  m_digestSize = truncatedDigestSize < 0 ? m_hashModule.DigestSize() : truncatedDigestSize;
858  Detach(attachment);
859 }
860 
862 {
863  m_putMessage = parameters.GetValueWithDefault(Name::PutMessage(), false);
864  int s = parameters.GetIntValueWithDefault(Name::TruncatedDigestSize(), -1);
865  m_digestSize = s < 0 ? m_hashModule.DigestSize() : s;
866 }
867 
868 size_t HashFilter::Put2(const byte *inString, size_t length, int messageEnd, bool blocking)
869 {
870  FILTER_BEGIN;
871  if (m_putMessage)
872  FILTER_OUTPUT3(1, 0, inString, length, 0, m_messagePutChannel);
873  if (inString && length)
874  m_hashModule.Update(inString, length);
875  if (messageEnd)
876  {
877  {
878  size_t size;
879  m_space = HelpCreatePutSpace(*AttachedTransformation(), m_hashPutChannel, m_digestSize, m_digestSize, size = m_digestSize);
880  m_hashModule.TruncatedFinal(m_space, m_digestSize);
881  }
882  FILTER_OUTPUT3(2, 0, m_space, m_digestSize, messageEnd, m_hashPutChannel);
883  }
884  FILTER_END_NO_MESSAGE_END;
885 }
886 
887 // *************************************************************
888 
889 HashVerificationFilter::HashVerificationFilter(HashTransformation &hm, BufferedTransformation *attachment, word32 flags, int truncatedDigestSize)
890  : FilterWithBufferedInput(attachment)
891  , m_hashModule(hm), m_flags(0), m_digestSize(0), m_verified(false)
892 {
894 }
895 
896 void HashVerificationFilter::InitializeDerivedAndReturnNewSizes(const NameValuePairs &parameters, size_t &firstSize, size_t &blockSize, size_t &lastSize)
897 {
899  int s = parameters.GetIntValueWithDefault(Name::TruncatedDigestSize(), -1);
900  m_digestSize = s < 0 ? m_hashModule.DigestSize() : s;
901  m_verified = false;
902  firstSize = m_flags & HASH_AT_BEGIN ? m_digestSize : 0;
903  blockSize = 1;
904  lastSize = m_flags & HASH_AT_BEGIN ? 0 : m_digestSize;
905 }
906 
907 void HashVerificationFilter::FirstPut(const byte *inString)
908 {
909  if (m_flags & HASH_AT_BEGIN)
910  {
911  m_expectedHash.New(m_digestSize);
912  if (inString) {memcpy(m_expectedHash, inString, m_expectedHash.size());}
913  if (m_flags & PUT_HASH)
914  AttachedTransformation()->Put(inString, m_expectedHash.size());
915  }
916 }
917 
918 void HashVerificationFilter::NextPutMultiple(const byte *inString, size_t length)
919 {
920  m_hashModule.Update(inString, length);
921  if (m_flags & PUT_MESSAGE)
922  AttachedTransformation()->Put(inString, length);
923 }
924 
925 void HashVerificationFilter::LastPut(const byte *inString, size_t length)
926 {
927  if (m_flags & HASH_AT_BEGIN)
928  {
929  CRYPTOPP_ASSERT(length == 0);
930  m_verified = m_hashModule.TruncatedVerify(m_expectedHash, m_digestSize);
931  }
932  else
933  {
934  m_verified = (length==m_digestSize && m_hashModule.TruncatedVerify(inString, length));
935  if (m_flags & PUT_HASH)
936  AttachedTransformation()->Put(inString, length);
937  }
938 
939  if (m_flags & PUT_RESULT)
940  AttachedTransformation()->Put(m_verified);
941 
942  if ((m_flags & THROW_EXCEPTION) && !m_verified)
943  throw HashVerificationFailed();
944 }
945 
946 // *************************************************************
947 
949  bool putAAD, int truncatedDigestSize, const std::string &macChannel, BlockPaddingScheme padding)
950  : StreamTransformationFilter(c, attachment, padding, true)
951  , m_hf(c, new OutputProxy(*this, false), putAAD, truncatedDigestSize, AAD_CHANNEL, macChannel)
952 {
954 }
955 
957 {
958  m_hf.IsolatedInitialize(parameters);
960 }
961 
962 byte * AuthenticatedEncryptionFilter::ChannelCreatePutSpace(const std::string &channel, size_t &size)
963 {
964  if (channel.empty())
966 
967  if (channel == AAD_CHANNEL)
968  return m_hf.CreatePutSpace(size);
969 
970  throw InvalidChannelName("AuthenticatedEncryptionFilter", channel);
971 }
972 
973 size_t AuthenticatedEncryptionFilter::ChannelPut2(const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)
974 {
975  if (channel.empty())
976  return StreamTransformationFilter::Put2(begin, length, messageEnd, blocking);
977 
978  if (channel == AAD_CHANNEL)
979  return m_hf.Put2(begin, length, 0, blocking);
980 
981  throw InvalidChannelName("AuthenticatedEncryptionFilter", channel);
982 }
983 
984 void AuthenticatedEncryptionFilter::LastPut(const byte *inString, size_t length)
985 {
986  StreamTransformationFilter::LastPut(inString, length);
987  m_hf.MessageEnd();
988 }
989 
990 // *************************************************************
991 
993  : FilterWithBufferedInput(attachment)
994  , m_hashVerifier(c, new OutputProxy(*this, false))
995  , m_streamFilter(c, new OutputProxy(*this, false), padding, true)
996 {
999 }
1000 
1001 void AuthenticatedDecryptionFilter::InitializeDerivedAndReturnNewSizes(const NameValuePairs &parameters, size_t &firstSize, size_t &blockSize, size_t &lastSize)
1002 {
1003  word32 flags = parameters.GetValueWithDefault(Name::AuthenticatedDecryptionFilterFlags(), (word32)DEFAULT_FLAGS);
1004 
1006  m_streamFilter.Initialize(parameters);
1007 
1008  firstSize = m_hashVerifier.m_firstSize;
1009  blockSize = 1;
1010  lastSize = m_hashVerifier.m_lastSize;
1011 }
1012 
1013 byte * AuthenticatedDecryptionFilter::ChannelCreatePutSpace(const std::string &channel, size_t &size)
1014 {
1015  if (channel.empty())
1016  return m_streamFilter.CreatePutSpace(size);
1017 
1018  if (channel == AAD_CHANNEL)
1019  return m_hashVerifier.CreatePutSpace(size);
1020 
1021  throw InvalidChannelName("AuthenticatedDecryptionFilter", channel);
1022 }
1023 
1024 size_t AuthenticatedDecryptionFilter::ChannelPut2(const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)
1025 {
1026  if (channel.empty())
1027  {
1028  if (m_lastSize > 0)
1029  m_hashVerifier.ForceNextPut();
1030  return FilterWithBufferedInput::Put2(begin, length, messageEnd, blocking);
1031  }
1032 
1033  if (channel == AAD_CHANNEL)
1034  return m_hashVerifier.Put2(begin, length, 0, blocking);
1035 
1036  throw InvalidChannelName("AuthenticatedDecryptionFilter", channel);
1037 }
1038 
1039 void AuthenticatedDecryptionFilter::FirstPut(const byte *inString)
1040 {
1041  m_hashVerifier.Put(inString, m_firstSize);
1042 }
1043 
1044 void AuthenticatedDecryptionFilter::NextPutMultiple(const byte *inString, size_t length)
1045 {
1046  m_streamFilter.Put(inString, length);
1047 }
1048 
1049 void AuthenticatedDecryptionFilter::LastPut(const byte *inString, size_t length)
1050 {
1051  m_streamFilter.MessageEnd();
1052  m_hashVerifier.PutMessageEnd(inString, length);
1053 }
1054 
1055 // *************************************************************
1056 
1058 {
1059  m_putMessage = parameters.GetValueWithDefault(Name::PutMessage(), false);
1060  m_messageAccumulator.reset(m_signer.NewSignatureAccumulator(m_rng));
1061 }
1062 
1063 size_t SignerFilter::Put2(const byte *inString, size_t length, int messageEnd, bool blocking)
1064 {
1065  FILTER_BEGIN;
1066  m_messageAccumulator->Update(inString, length);
1067  if (m_putMessage)
1068  FILTER_OUTPUT(1, inString, length, 0);
1069  if (messageEnd)
1070  {
1071  m_buf.New(m_signer.SignatureLength());
1072  m_signer.Sign(m_rng, m_messageAccumulator.release(), m_buf);
1073  FILTER_OUTPUT(2, m_buf, m_buf.size(), messageEnd);
1074  m_messageAccumulator.reset(m_signer.NewSignatureAccumulator(m_rng));
1075  }
1076  FILTER_END_NO_MESSAGE_END;
1077 }
1078 
1080  : FilterWithBufferedInput(attachment)
1081  , m_verifier(verifier), m_flags(0), m_verified(0)
1082 {
1084 }
1085 
1086 void SignatureVerificationFilter::InitializeDerivedAndReturnNewSizes(const NameValuePairs &parameters, size_t &firstSize, size_t &blockSize, size_t &lastSize)
1087 {
1089  m_messageAccumulator.reset(m_verifier.NewVerificationAccumulator());
1090  size_t size = m_verifier.SignatureLength();
1091  CRYPTOPP_ASSERT(size != 0); // TODO: handle recoverable signature scheme
1092  m_verified = false;
1093  firstSize = m_flags & SIGNATURE_AT_BEGIN ? size : 0;
1094  blockSize = 1;
1095  lastSize = m_flags & SIGNATURE_AT_BEGIN ? 0 : size;
1096 }
1097 
1098 void SignatureVerificationFilter::FirstPut(const byte *inString)
1099 {
1100  if (m_flags & SIGNATURE_AT_BEGIN)
1101  {
1102  if (m_verifier.SignatureUpfront())
1103  m_verifier.InputSignature(*m_messageAccumulator, inString, m_verifier.SignatureLength());
1104  else
1105  {
1106  m_signature.New(m_verifier.SignatureLength());
1107  if (inString) {memcpy(m_signature, inString, m_signature.size());}
1108  }
1109 
1110  if (m_flags & PUT_SIGNATURE)
1111  AttachedTransformation()->Put(inString, m_signature.size());
1112  }
1113  else
1114  {
1115  CRYPTOPP_ASSERT(!m_verifier.SignatureUpfront());
1116  }
1117 }
1118 
1119 void SignatureVerificationFilter::NextPutMultiple(const byte *inString, size_t length)
1120 {
1121  m_messageAccumulator->Update(inString, length);
1122  if (m_flags & PUT_MESSAGE)
1123  AttachedTransformation()->Put(inString, length);
1124 }
1125 
1126 void SignatureVerificationFilter::LastPut(const byte *inString, size_t length)
1127 {
1128  if (m_flags & SIGNATURE_AT_BEGIN)
1129  {
1130  CRYPTOPP_ASSERT(length == 0);
1131  m_verifier.InputSignature(*m_messageAccumulator, m_signature, m_signature.size());
1132  m_verified = m_verifier.VerifyAndRestart(*m_messageAccumulator);
1133  }
1134  else
1135  {
1136  m_verifier.InputSignature(*m_messageAccumulator, inString, length);
1137  m_verified = m_verifier.VerifyAndRestart(*m_messageAccumulator);
1138  if (m_flags & PUT_SIGNATURE)
1139  AttachedTransformation()->Put(inString, length);
1140  }
1141 
1142  if (m_flags & PUT_RESULT)
1143  AttachedTransformation()->Put(m_verified);
1144 
1145  if ((m_flags & THROW_EXCEPTION) && !m_verified)
1147 }
1148 
1149 // *************************************************************
1150 
1151 size_t Source::PumpAll2(bool blocking)
1152 {
1153  unsigned int messageCount = UINT_MAX;
1154  do {
1155  RETURN_IF_NONZERO(PumpMessages2(messageCount, blocking));
1156  } while(messageCount == UINT_MAX);
1157 
1158  return 0;
1159 }
1160 
1162 {
1163  if (!m_messageEnd && !AnyRetrievable())
1164  {
1165  m_messageEnd=true;
1166  return true;
1167  }
1168  else
1169  return false;
1170 }
1171 
1172 unsigned int Store::CopyMessagesTo(BufferedTransformation &target, unsigned int count, const std::string &channel) const
1173 {
1174  if (m_messageEnd || count == 0)
1175  return 0;
1176  else
1177  {
1178  CopyTo(target, ULONG_MAX, channel);
1180  target.ChannelMessageEnd(channel, GetAutoSignalPropagation()-1);
1181  return 1;
1182  }
1183 }
1184 
1185 void StringStore::StoreInitialize(const NameValuePairs &parameters)
1186 {
1188  if (!parameters.GetValue(Name::InputBuffer(), array))
1189  throw InvalidArgument("StringStore: missing InputBuffer argument");
1190  m_store = array.begin();
1191  m_length = array.size();
1192  m_count = 0;
1193 }
1194 
1195 size_t StringStore::TransferTo2(BufferedTransformation &target, lword &transferBytes, const std::string &channel, bool blocking)
1196 {
1197  lword position = 0;
1198  size_t blockedBytes = CopyRangeTo2(target, position, transferBytes, channel, blocking);
1199  m_count += (size_t)position;
1200  transferBytes = position;
1201  return blockedBytes;
1202 }
1203 
1204 size_t StringStore::CopyRangeTo2(BufferedTransformation &target, lword &begin, lword end, const std::string &channel, bool blocking) const
1205 {
1206  size_t i = UnsignedMin(m_length, m_count+begin);
1207  size_t len = UnsignedMin(m_length-i, end-begin);
1208  size_t blockedBytes = target.ChannelPut2(channel, m_store+i, len, 0, blocking);
1209  if (!blockedBytes)
1210  begin += len;
1211  return blockedBytes;
1212 }
1213 
1214 void RandomNumberStore::StoreInitialize(const NameValuePairs &parameters)
1215 {
1216  parameters.GetRequiredParameter("RandomNumberStore", "RandomNumberGeneratorPointer", m_rng);
1217  int length;
1218  parameters.GetRequiredIntParameter("RandomNumberStore", "RandomNumberStoreSize", length);
1219  m_length = length;
1220 }
1221 
1222 size_t RandomNumberStore::TransferTo2(BufferedTransformation &target, lword &transferBytes, const std::string &channel, bool blocking)
1223 {
1224  if (!blocking)
1225  throw NotImplemented("RandomNumberStore: nonblocking transfer is not implemented by this object");
1226 
1227  transferBytes = UnsignedMin(transferBytes, m_length - m_count);
1228  m_rng->GenerateIntoBufferedTransformation(target, channel, transferBytes);
1229  m_count += transferBytes;
1230 
1231  return 0;
1232 }
1233 
1234 size_t NullStore::CopyRangeTo2(BufferedTransformation &target, lword &begin, lword end, const std::string &channel, bool blocking) const
1235 {
1236  static const byte nullBytes[128] = {0};
1237  while (begin < end)
1238  {
1239  size_t len = (size_t)STDMIN(end-begin, lword(128));
1240  size_t blockedBytes = target.ChannelPut2(channel, nullBytes, len, 0, blocking);
1241  if (blockedBytes)
1242  return blockedBytes;
1243  begin += len;
1244  }
1245  return 0;
1246 }
1247 
1248 size_t NullStore::TransferTo2(BufferedTransformation &target, lword &transferBytes, const std::string &channel, bool blocking)
1249 {
1250  lword begin = 0;
1251  size_t blockedBytes = NullStore::CopyRangeTo2(target, begin, transferBytes, channel, blocking);
1252  transferBytes = begin;
1253  m_size -= begin;
1254  return blockedBytes;
1255 }
1256 
1257 NAMESPACE_END
1258 
1259 #endif
Used to pass byte array input as part of a NameValuePairs object.
Definition: algparam.h:31
size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)
Input multiple bytes for processing.
Definition: filters.cpp:232
int GetIntValueWithDefault(const char *name, int defaultValue) const
Get a named value with type int, with default.
Definition: cryptlib.h:397
Standard names for retrieving values by name when working with NameValuePairs.
InputIt FindIfNot(InputIt first, InputIt last, const T &value)
Finds first element not in a range.
Definition: misc.h:2544
An invalid argument was detected.
Definition: cryptlib.h:201
virtual size_t ChannelPutModifiable2(const std::string &channel, byte *inString, size_t length, int messageEnd, bool blocking)
Input multiple bytes that may be modified by callee on a channel.
Definition: cryptlib.cpp:449
Indicates the hash is at the beginning of the message (i.e., concatenation of hash+message) ...
Definition: filters.h:610
HashFilter(HashTransformation &hm, BufferedTransformation *attachment=NULL, bool putMessage=false, int truncatedDigestSize=-1, const std::string &messagePutChannel=DEFAULT_CHANNEL, const std::string &hashPutChannel=DEFAULT_CHANNEL)
Construct a HashFilter.
Definition: filters.cpp:853
void IsolatedInitialize(const NameValuePairs &parameters)
Initialize or reinitialize this object, without signal propagation.
Definition: filters.cpp:522
void AddRangeToSkip(unsigned int message, lword position, lword size, bool sortNow=true)
Adds a range to skip during processing.
Definition: filters.cpp:166
size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)
Input multiple bytes for processing.
Definition: filters.cpp:868
StreamTransformationFilter(StreamTransformation &c, BufferedTransformation *attachment=NULL, BlockPaddingScheme padding=DEFAULT_PADDING)
Construct a StreamTransformationFilter.
Definition: filters.cpp:582
virtual void ProcessData(byte *outString, const byte *inString, size_t length)=0
Encrypt or decrypt an array of bytes.
Utility functions for the Crypto++ library.
size_t ChannelPut2(const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)
Input multiple bytes for processing on a channel.
Definition: filters.cpp:1024
virtual size_t PumpAll2(bool blocking=true)
Pump all data to attached transformation.
Definition: filters.cpp:1151
BlockPaddingScheme
Padding schemes used for block ciphers.
Definition: filters.h:477
Interface for authenticated encryption modes of operation.
Definition: cryptlib.h:1277
T GetValueWithDefault(const char *name, T defaultValue) const
Get a named value.
Definition: cryptlib.h:365
size_t size() const
Length of the memory block.
Definition: algparam.h:125
Indicates the filter should throw a HashVerificationFailed if a failure is encountered.
Definition: filters.h:618
size_t size() const
Length of the memory block.
Definition: algparam.h:95
Message Queue.
Definition: mqueue.h:14
Indicates the result of the verification should be passed to an attached transformation.
Definition: filters.h:616
const char * HashVerificationFilterFlags()
word32
Definition: argnames.h:53
virtual void TruncatedFinal(byte *digest, size_t digestSize)=0
Computes the hash of the current message.
virtual void IsolatedInitialize(const NameValuePairs &parameters)
Initialize or reinitialize this object, without signal propagation.
Definition: cryptlib.h:1644
void IsolatedInitialize(const NameValuePairs &parameters)
Initialize or reinitialize this object, without signal propagation.
Definition: filters.cpp:329
virtual size_t ProcessLastBlock(byte *outString, size_t outLength, const byte *inString, size_t inLength)
Encrypt or decrypt the last block of data.
Definition: cryptlib.cpp:221
Filter class that is a proxy for a sink.
Definition: filters.h:945
const char * AuthenticatedDecryptionFilterFlags()
word32
Definition: argnames.h:54
const char * SignatureVerificationFilterFlags()
word32
Definition: argnames.h:55
const char * BlockPaddingScheme()
StreamTransformationFilter::BlockPaddingScheme.
Definition: argnames.h:52
Default padding scheme.
Definition: filters.h:497
bool MessageSeriesEnd(int propagation=-1, bool blocking=true)
Marks the end of a series of messages, with signal propagation.
Definition: filters.cpp:95
AuthenticatedDecryptionFilter(AuthenticatedSymmetricCipher &c, BufferedTransformation *attachment=NULL, word32 flags=DEFAULT_FLAGS, int truncatedDigestSize=-1, BlockPaddingScheme padding=DEFAULT_PADDING)
Construct a AuthenticatedDecryptionFilter.
Definition: filters.cpp:992
void ResetMeter()
Resets the meter.
Definition: filters.cpp:160
Indicates the filter should throw a HashVerificationFailed if a failure is encountered.
Definition: filters.h:813
Classes for automatic resource management.
virtual size_t TransferTo2(BufferedTransformation &target, lword &byteCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)=0
Transfer bytes from this object to another BufferedTransformation.
Indicates the message should be passed to an attached transformation.
Definition: filters.h:807
Library configuration file.
byte * ChannelCreatePutSpace(const std::string &channel, size_t &size)
Request space which can be written into by the caller.
Definition: filters.cpp:962
size_t CopyRangeTo2(BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const
Copy bytes from this object to another BufferedTransformation.
Definition: filters.cpp:1234
void ProcessString(byte *inoutString, size_t length)
Encrypt or decrypt a string of bytes.
Definition: cryptlib.h:1022
bool GetNextMessage()
Start retrieving the next message.
Definition: filters.cpp:1161
void New(size_type newSize)
Change size without preserving contents.
Definition: secblock.h:734
Combines two sets of NameValuePairs.
Definition: algparam.h:137
virtual int GetAutoSignalPropagation() const
Retrieve automatic signal propagation value.
Definition: cryptlib.h:1707
virtual bool VerifyAndRestart(PK_MessageAccumulator &messageAccumulator) const =0
Check whether messageAccumulator contains a valid signature and message, and restart messageAccumulat...
virtual bool ChannelFlush(const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true)
Flush buffered input and/or output on a channel.
Definition: cryptlib.cpp:457
virtual bool TruncatedVerify(const byte *digest, size_t digestLength)
Verifies the hash of the current message.
Definition: cryptlib.cpp:385
virtual size_t SignatureLength() const =0
Provides the signature length if it only depends on the key.
SecBlock<byte> typedef.
Definition: secblock.h:828
Used to pass byte array input as part of a NameValuePairs object.
Definition: algparam.h:106
Interface for buffered transformations.
Definition: cryptlib.h:1486
Exception thrown when an invalid signature is encountered.
Definition: filters.h:791
SignatureVerificationFilter(const PK_Verifier &verifier, BufferedTransformation *attachment=NULL, word32 flags=DEFAULT_FLAGS)
Construct a SignatureVerificationFilter.
Definition: filters.cpp:1079
void IsolatedInitialize(const NameValuePairs &parameters)
Initialize or reinitialize this object, without signal propagation.
Definition: filters.cpp:1057
Pointer that overloads operator ->
Definition: smartptr.h:39
Default flags using THROW_EXCEPTION.
Definition: filters.h:712
void LastPut(const byte *inString, size_t length)
Input the last block of data.
Definition: filters.cpp:984
size_t PutModifiable(byte *inString, size_t length, bool blocking=true)
Input multiple bytes that may be modified by callee.
Definition: cryptlib.h:1562
Exception thrown when a data integrity check failure is encountered.
Definition: filters.h:596
void IsolatedInitialize(const NameValuePairs &parameters)
Initialize or reinitialize this object, without signal propagation.
Definition: filters.cpp:956
1 and 0&#39;s padding added to a block
Definition: filters.h:489
HashVerificationFilter(HashTransformation &hm, BufferedTransformation *attachment=NULL, word32 flags=DEFAULT_FLAGS, int truncatedDigestSize=-1)
Construct a HashVerificationFilter.
Definition: filters.cpp:889
virtual bool IsLastBlockSpecial() const
Determines if the last block receives special processing.
Definition: cryptlib.h:1016
bool MessageEnd(int propagation=-1, bool blocking=true)
Signals the end of messages to the object.
Definition: cryptlib.h:1570
virtual void Attach(BufferedTransformation *newAttachment)
Add newAttachment to the end of attachment chain.
Definition: cryptlib.cpp:749
A method was called which was not implemented.
Definition: cryptlib.h:222
const byte * begin() const
Pointer to the first byte in the memory block.
Definition: algparam.h:91
size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)
Input multiple bytes for processing.
Definition: filters.cpp:534
size_t Put(byte inByte, bool blocking=true)
Input a byte for processing.
Definition: cryptlib.h:1508
virtual bool IsForwardTransformation() const =0
Determines if the cipher is being operated in its forward direction.
size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)
Input multiple bytes for processing.
Definition: filters.cpp:1063
void Detach(BufferedTransformation *newAttachment=NULL)
Replace an attached transformation.
Definition: filters.cpp:50
const std::string DEFAULT_CHANNEL
Default channel for BufferedTransformation.
Definition: cryptlib.h:488
AlgorithmParameters MakeParameters(const char *name, const T &value, bool throwIfNotUsed=true)
Create an object that implements NameValuePairs.
Definition: algparam.h:516
virtual bool IsSelfInverting() const =0
Determines whether the cipher is self-inverting.
virtual bool ChannelMessageSeriesEnd(const std::string &channel, int propagation=-1, bool blocking=true)
Marks the end of a series of messages on a channel.
Definition: cryptlib.cpp:465
virtual unsigned int MandatoryBlockSize() const
Provides the mandatory block size of the cipher.
Definition: cryptlib.h:928
virtual bool Flush(bool hardFlush, int propagation=-1, bool blocking=true)
Flush buffered input and/or output, with signal propagation.
Definition: cryptlib.cpp:419
BufferedTransformation * AttachedTransformation()
Retrieve attached transformation.
Definition: filters.cpp:36
virtual unsigned int GetOptimalBlockSizeUsed() const
Provides the number of bytes used in the current block when processing at optimal block size...
Definition: cryptlib.h:939
const char * PutMessage()
bool
Definition: argnames.h:50
size_t PutModifiable2(byte *inString, size_t length, int messageEnd, bool blocking)
Input multiple bytes that may be modified by callee.
Definition: filters.cpp:237
Indicates the message should be passed to an attached transformation.
Definition: filters.h:612
size_t ChannelPut2(const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)
Input multiple bytes for processing on a channel.
Definition: filters.cpp:973
byte * ChannelCreatePutSpace(const std::string &channel, size_t &size)
Request space which can be written into by the caller.
Definition: filters.cpp:1013
Exception thrown when a filter does not recognize a named channel.
Definition: cryptlib.h:1986
size_t CopyRangeTo2(BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const
Copy bytes from this object to another BufferedTransformation.
Definition: filters.cpp:61
byte * CreatePutSpace(size_t &size)
Request space which can be written into by the caller.
Definition: filters.cpp:550
const char * InputBuffer()
ConstByteArrayParameter.
Definition: argnames.h:56
T1 SaturatingSubtract(const T1 &a, const T2 &b)
Performs a saturating subtract clamped at 0.
Definition: misc.h:888
const T1 UnsignedMin(const T1 &a, const T2 &b)
Safe comparison of values that could be neagtive and incorrectly promoted.
Definition: misc.h:544
virtual size_t ChannelPut2(const std::string &channel, const byte *inString, size_t length, int messageEnd, bool blocking)
Input multiple bytes for processing on a channel.
Definition: cryptlib.cpp:441
Indicates the hash should be passed to an attached transformation.
Definition: filters.h:614
bool IsolatedMessageSeriesEnd(bool blocking)
Marks the end of a series of messages, without signal propagation.
Definition: filters.cpp:242
size_t CopyRangeTo2(BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const
Copy bytes from this object to another BufferedTransformation.
Definition: filters.cpp:1204
size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)
Input multiple bytes for processing.
Definition: filters.cpp:565
void IsolatedInitialize(const NameValuePairs &parameters)
Initialize or reinitialize this object, without signal propagation.
Definition: filters.cpp:556
size_t TransferTo2(BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
Transfer bytes from this object to another BufferedTransformation.
Definition: filters.cpp:1248
Interface for the data processing portion of stream ciphers.
Definition: cryptlib.h:908
virtual size_t CopyRangeTo2(BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const =0
Copy bytes from this object to another BufferedTransformation.
Divides an input stream into discrete blocks.
Definition: filters.h:317
virtual std::string AlgorithmName() const
Provides the name of this algorithm.
Definition: cryptlib.h:603
const T & STDMIN(const T &a, const T &b)
Replacement function for std::min.
Definition: misc.h:506
#define CRYPTOPP_ASSERT(exp)
Debugging and diagnostic assertion.
Definition: trap.h:60
virtual bool IsolatedMessageSeriesEnd(bool blocking)
Marks the end of a series of messages, without signal propagation.
Definition: cryptlib.h:1658
virtual bool AnyRetrievable() const
Determines whether bytes are ready for retrieval.
Definition: cryptlib.cpp:481
virtual PK_MessageAccumulator * NewVerificationAccumulator() const =0
Create a new HashTransformation to accumulate the message to be verified.
void GetRequiredParameter(const char *className, const char *name, T &value) const
Retrieves a required name/value pair.
Definition: cryptlib.h:423
virtual bool IsolatedFlush(bool hardFlush, bool blocking)=0
Flushes data buffered by this object, without signal propagation.
Implementation of BufferedTransformation&#39;s attachment interface.
size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)
Input multiple bytes for processing.
Definition: filters.cpp:527
A decryption filter encountered invalid ciphertext.
Definition: cryptlib.h:215
const char * OutputBuffer()
ByteArrayParameter.
Definition: argnames.h:57
Exception thrown by objects that have not implemented nonblocking input processing.
Definition: cryptlib.h:1611
Filter wrapper for StreamTransformation.
Definition: filters.h:508
W3C padding added to a block.
Definition: filters.h:494
size_t TransferTo2(BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
Transfer bytes from this object to another BufferedTransformation.
Definition: filters.cpp:66
byte * CreatePutSpace(size_t &size)
Request space which can be written into by the caller.
Definition: filters.h:576
FilterWithBufferedInput(BufferedTransformation *attachment)
Construct a FilterWithBufferedInput with an attached transformation.
Definition: filters.cpp:315
void TransferAllTo(BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL)
Transfer all bytes from this object to another BufferedTransformation.
Definition: cryptlib.h:1894
Interface for public-key signature verifiers.
Definition: cryptlib.h:2712
virtual unsigned int DigestSize() const =0
Provides the digest size of the hash.
Indicates the result of the verification should be passed to an attached transformation.
Definition: filters.h:811
byte * begin() const
Pointer to the first byte in the memory block.
Definition: algparam.h:121
ProxyFilter(BufferedTransformation *filter, size_t firstSize, size_t lastSize, BufferedTransformation *attachment)
Construct a ProxyFilter.
Definition: filters.cpp:484
void xorbuf(byte *buf, const byte *mask, size_t count)
Performs an XOR of a buffer with a mask.
Definition: misc.cpp:28
size_t TransferTo2(BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
Transfer bytes from this object to another BufferedTransformation.
Definition: filters.cpp:1222
lword CopyTo(BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
copy copyMax bytes of the buffered output to target as input
Definition: cryptlib.h:1815
void ForceNextPut()
Flushes data buffered by this object.
Definition: filters.cpp:441
Interface for hash functions and data processing part of MACs.
Definition: cryptlib.h:1075
virtual byte * CreatePutSpace(size_t &size)
Request space which can be written into by the caller.
Definition: cryptlib.h:1547
bool IsolatedFlush(bool hardFlush, bool blocking)
Flushes data buffered by this object, without signal propagation.
Definition: filters.cpp:491
0&#39;s padding added to a block
Definition: filters.h:483
const char * TruncatedDigestSize()
int
Definition: argnames.h:51
Implementation of BufferedTransformation&#39;s attachment interface.
Definition: filters.h:36
const T & STDMAX(const T &a, const T &b)
Replacement function for std::max.
Definition: misc.h:517
size_t PutMessageEnd(const byte *inString, size_t length, int propagation=-1, bool blocking=true)
Input multiple bytes for processing and signal the end of a message.
Definition: cryptlib.h:1584
No padding added to a block.
Definition: filters.h:480
void Initialize(const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
Initialize or reinitialize this object, with signal propagation.
Definition: filters.cpp:71
Crypto++ library namespace.
void Initialize(const NameValuePairs &parameters, int propagation)
Initialize or reinitialize this object, with signal propagation.
Definition: filters.cpp:473
size_t TransferTo2(BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
Transfer bytes from this object to another BufferedTransformation.
Definition: filters.cpp:1195
PKCS #5 padding added to a block.
Definition: filters.h:486
Indicates the signature is at the beginning of the message (i.e., concatenation of signature+message)...
Definition: filters.h:805
bool GetValue(const char *name, T &value) const
Get a named value.
Definition: cryptlib.h:352
Indicates the signature should be passed to an attached transformation.
Definition: filters.h:809
AuthenticatedEncryptionFilter(AuthenticatedSymmetricCipher &c, BufferedTransformation *attachment=NULL, bool putAAD=false, int truncatedDigestSize=-1, const std::string &macChannel=DEFAULT_CHANNEL, BlockPaddingScheme padding=DEFAULT_PADDING)
Construct a AuthenticatedEncryptionFilter.
Definition: filters.cpp:948
virtual void InputSignature(PK_MessageAccumulator &messageAccumulator, const byte *signature, size_t signatureLength) const =0
Input signature into a message accumulator.
Default flags using SIGNATURE_AT_BEGIN and PUT_RESULT.
Definition: filters.h:815
const std::string AAD_CHANNEL
Channel for additional authenticated data.
Definition: cryptlib.h:495
bool IsolatedFlush(bool hardFlush, bool blocking)
Flushes data buffered by this object, without signal propagation.
Definition: filters.cpp:338
byte * HelpCreatePutSpace(BufferedTransformation &target, const std::string &channel, size_t minSize, size_t desiredSize, size_t &bufferSize)
Create a working space in a BufferedTransformation.
Definition: filters.h:177
virtual void Initialize(const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
Initialize or reinitialize this object, with signal propagation.
Definition: cryptlib.cpp:412
Input data was received that did not conform to expected format.
Definition: cryptlib.h:208
size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)
Input multiple bytes for processing.
Definition: filters.h:335
virtual unsigned int OptimalBlockSize() const
Provides the input block size most efficient for this cipher.
Definition: cryptlib.h:935
void SetFilter(Filter *filter)
Sets the OutputProxy filter.
Definition: filters.cpp:496
bool Flush(bool hardFlush, int propagation=-1, bool blocking=true)
Flush buffered input and/or output, with signal propagation.
Definition: filters.cpp:78
virtual void Update(const byte *input, size_t length)=0
Updates a hash with additional input.
size_type size() const
Provides the count of elements in the SecBlock.
Definition: secblock.h:566
void GetRequiredIntParameter(const char *className, const char *name, int &value) const
Retrieves a required name/value pair.
Definition: cryptlib.h:438
T1 RoundDownToMultipleOf(const T1 &n, const T2 &m)
Rounds a value down to a multiple of a second value.
Definition: misc.h:939
Default flags using HASH_AT_BEGIN and PUT_RESULT.
Definition: filters.h:620
virtual bool SignatureUpfront() const
Determines whether the signature must be input before the message.
Definition: cryptlib.h:2617
bool ChannelMessageEnd(const std::string &channel, int propagation=-1, bool blocking=true)
Signal the end of a message.
Definition: cryptlib.h:2044
#define SIZE_MAX
The maximum value of a machine word.
Definition: misc.h:85
virtual unsigned int MinLastBlockSize() const
Provides the size of the last block.
Definition: cryptlib.h:983
void IsolatedInitialize(const NameValuePairs &parameters)
Initialize or reinitialize this object, without signal propagation.
Definition: filters.cpp:861
Interface for retrieving values given their names.
Definition: cryptlib.h:294