blob: 7e9d99d24ded417bd692523768a1ac676d4e1f3a [file] [log] [blame]
Yingdi Yu38317e52015-07-22 13:58:02 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
3 * Copyright (c) 2013-2016 Regents of the University of California.
4 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6 *
7 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License as published by the Free Software
9 * Foundation, either version 3 of the License, or (at your option) any later version.
10 *
11 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14 *
15 * You should have received copies of the GNU General Public License and GNU Lesser
16 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17 * <http://www.gnu.org/licenses/>.
18 *
19 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20 */
21
22#ifndef NDN_CXX_SECURITY_TRANSFORM_BASE64_ENCODE_HPP
23#define NDN_CXX_SECURITY_TRANSFORM_BASE64_ENCODE_HPP
24
25#include "transform-base.hpp"
26
27namespace ndn {
28namespace security {
29namespace transform {
30
31/**
32 * @brief The module to perform Base64 encoding transformation.
33 */
34class Base64Encode : public Transform
35{
36public:
37 /**
38 * @brief Create a base64 encoding module
39 *
40 * @p needBreak if true, insert newline after every 64 bytes, otherwise no newline is inserted
41 */
42 explicit
43 Base64Encode(bool needBreak = true);
44
45private:
46 /**
47 * @brief Read partial transformation result (if exists) from BIO
48 */
Davide Pesavento57c07df2016-12-11 18:41:45 -050049 void
Yingdi Yu38317e52015-07-22 13:58:02 -070050 preTransform() final;
51
52 /**
Davide Pesavento57c07df2016-12-11 18:41:45 -050053 * @brief Encode @p data into base64 format.
Yingdi Yu38317e52015-07-22 13:58:02 -070054 * @return The number of input bytes that have been accepted by the converter.
55 */
Davide Pesavento57c07df2016-12-11 18:41:45 -050056 size_t
Yingdi Yu38317e52015-07-22 13:58:02 -070057 convert(const uint8_t* data, size_t dataLen) final;
58
59 /**
60 * @brief Finalize base64 encoding
61 *
62 * This method with read all encoding results from the converter and write them into next module.
63 */
Davide Pesavento57c07df2016-12-11 18:41:45 -050064 void
Yingdi Yu38317e52015-07-22 13:58:02 -070065 finalize() final;
66
67 /**
68 * @brief Fill output buffer with the transformation result from BIO.
69 */
70 void
71 fillOutputBuffer();
72
73 /**
74 * @return true if converter does not have partial result.
75 */
76 bool
77 isConverterEmpty();
78
79private:
80 class Impl;
81 unique_ptr<Impl> m_impl;
82};
83
84unique_ptr<Transform>
85base64Encode(bool needBreak = true);
86
87} // namespace transform
88} // namespace security
89} // namespace ndn
90
91#endif // NDN_CXX_SECURITY_TRANSFORM_BASE64_ENCODE_HPP