util: io::load accepts base64 encoding without newlines
This commit also renames io::BASE_64 to io::BASE64.
refs #3741
Change-Id: I46286c72d12e685902a72ce8dab4a1385dc0fceb
diff --git a/src/security/transform.hpp b/src/security/transform.hpp
index 3f83de0..8ecfed5 100644
--- a/src/security/transform.hpp
+++ b/src/security/transform.hpp
@@ -29,6 +29,7 @@
#include "transform/bool-sink.hpp"
#include "transform/stream-sink.hpp"
+#include "transform/strip-space.hpp"
#include "transform/hex-encode.hpp"
#include "transform/hex-decode.hpp"
#include "transform/base64-encode.hpp"
diff --git a/src/security/transform/strip-space.cpp b/src/security/transform/strip-space.cpp
new file mode 100644
index 0000000..dad2cc3
--- /dev/null
+++ b/src/security/transform/strip-space.cpp
@@ -0,0 +1,62 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/**
+ * Copyright (c) 2013-2016 Regents of the University of California.
+ *
+ * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
+ *
+ * ndn-cxx library is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received copies of the GNU General Public License and GNU Lesser
+ * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
+ * <http://www.gnu.org/licenses/>.
+ *
+ * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
+ */
+
+#include "strip-space.hpp"
+
+namespace ndn {
+namespace security {
+namespace transform {
+
+const char* const StripSpace::DEFAULT_WHITESPACES = " \f\n\r\t\v";
+
+StripSpace::StripSpace(const char* whitespaces)
+{
+ for (const char* i = whitespaces; *i != '\0'; ++i) {
+ m_isWhitespace.set(*i);
+ }
+}
+
+size_t
+StripSpace::convert(const uint8_t* buf, size_t buflen)
+{
+ auto buffer = make_unique<OBuffer>();
+ buffer->reserve(buflen);
+
+ for (size_t i = 0; i < buflen; ++i) {
+ uint8_t ch = buf[i];
+ if (!m_isWhitespace[ch]) {
+ buffer->push_back(ch);
+ }
+ }
+
+ setOutputBuffer(std::move(buffer));
+ return buflen;
+}
+
+unique_ptr<Transform>
+stripSpace(const char* whitespaces)
+{
+ return make_unique<StripSpace>(whitespaces);
+}
+
+} // namespace transform
+} // namespace security
+} // namespace ndn
diff --git a/src/security/transform/strip-space.hpp b/src/security/transform/strip-space.hpp
new file mode 100644
index 0000000..7cc4dc8
--- /dev/null
+++ b/src/security/transform/strip-space.hpp
@@ -0,0 +1,65 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/**
+ * Copyright (c) 2013-2016 Regents of the University of California.
+ *
+ * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
+ *
+ * ndn-cxx library is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received copies of the GNU General Public License and GNU Lesser
+ * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
+ * <http://www.gnu.org/licenses/>.
+ *
+ * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
+ */
+
+#ifndef NDN_CXX_SECURITY_TRANSFORM_STRIP_SPACE_HPP
+#define NDN_CXX_SECURITY_TRANSFORM_STRIP_SPACE_HPP
+
+#include "transform-base.hpp"
+#include <bitset>
+#include <climits>
+
+namespace ndn {
+namespace security {
+namespace transform {
+
+/** \brief strip whitespace characters from a stream
+ *
+ * This transform interprets the input as a byte string, and puts all bytes except
+ * whitespace characters on the output.
+ */
+class StripSpace : public Transform
+{
+public:
+ static const char* const DEFAULT_WHITESPACES;
+
+ explicit
+ StripSpace(const char* whitespaces = DEFAULT_WHITESPACES);
+
+private:
+ virtual size_t
+ convert(const uint8_t* buf, size_t buflen) final;
+
+private:
+ static constexpr size_t CHARMAP_SIZE = 1 << CHAR_BIT;
+ std::bitset<CHARMAP_SIZE> m_isWhitespace; // char => whether char is whitespace
+};
+
+/** \brief constructs a StripSpace transform
+ * \param whitespaces characters classified as whitespaces, terminated with null
+ */
+unique_ptr<Transform>
+stripSpace(const char* whitespaces = StripSpace::DEFAULT_WHITESPACES);
+
+} // namespace transform
+} // namespace security
+} // namespace ndn
+
+#endif // NDN_CXX_SECURITY_TRANSFORM_STRIP_SPACE_HPP
diff --git a/src/util/io.cpp b/src/util/io.cpp
index 84db1e4..76fe18c 100644
--- a/src/util/io.cpp
+++ b/src/util/io.cpp
@@ -37,8 +37,8 @@
case NO_ENCODING:
t::streamSource(is) >> t::streamSink(os);
break;
- case BASE_64:
- t::streamSource(is) >> t::base64Decode() >> t::streamSink(os);
+ case BASE64:
+ t::streamSource(is) >> t::stripSpace("\n") >> t::base64Decode(false) >> t::streamSink(os);
break;
case HEX:
t::streamSource(is) >> t::hexDecode() >> t::streamSink(os);
@@ -69,7 +69,7 @@
case NO_ENCODING:
t::bufferSource(block.wire(), block.size()) >> t::streamSink(os);
break;
- case BASE_64:
+ case BASE64:
t::bufferSource(block.wire(), block.size()) >> t::base64Encode() >> t::streamSink(os);
break;
case HEX:
diff --git a/src/util/io.hpp b/src/util/io.hpp
index a169113..ea093d5 100644
--- a/src/util/io.hpp
+++ b/src/util/io.hpp
@@ -43,17 +43,32 @@
/** \brief indicates how a file or stream is encoded
*/
enum IoEncoding {
- NO_ENCODING, ///< binary without encoding
- BASE_64, ///< base64 encoding
- HEX ///< uppercase hexadecimal encoding
+ /** \brief binary without encoding
+ */
+ NO_ENCODING,
+
+ /** \brief base64 encoding
+ *
+ * \p save() inserts a newline after every 64 characters,
+ * \p load() can accept base64 text with or without newlines
+ */
+ BASE64,
+
+ /** \brief hexadecimal encoding
+ *
+ * \p save() uses uppercase letters A-F, \p load() can accept mixed-case
+ */
+ HEX
};
+constexpr IoEncoding DEPRECATED(BASE_64) = BASE64;
+
/** \brief loads a TLV block from a stream
* \return if success, the Block and true
* otherwise, a default-constructed Block and false
*/
optional<Block>
-loadBlock(std::istream& is, IoEncoding encoding = BASE_64);
+loadBlock(std::istream& is, IoEncoding encoding = BASE64);
/** \brief loads a TLV element from a stream
* \tparam T type of TLV element; T must be WireDecodable,
@@ -62,7 +77,7 @@
*/
template<typename T>
shared_ptr<T>
-load(std::istream& is, IoEncoding encoding = BASE_64)
+load(std::istream& is, IoEncoding encoding = BASE64)
{
optional<Block> block = loadBlock(is, encoding);
if (!block) {
@@ -86,7 +101,7 @@
*/
template<typename T>
shared_ptr<T>
-load(const std::string& filename, IoEncoding encoding = BASE_64)
+load(const std::string& filename, IoEncoding encoding = BASE64)
{
std::ifstream is(filename);
return load<T>(is, encoding);
@@ -96,7 +111,7 @@
* \throw Error error during saving
*/
void
-saveBlock(const Block& block, std::ostream& os, IoEncoding encoding = BASE_64);
+saveBlock(const Block& block, std::ostream& os, IoEncoding encoding = BASE64);
/** \brief saves a TLV element to a stream
* \tparam T type of TLV element; T must be WireEncodable,
@@ -105,7 +120,7 @@
*/
template<typename T>
void
-save(const T& obj, std::ostream& os, IoEncoding encoding = BASE_64)
+save(const T& obj, std::ostream& os, IoEncoding encoding = BASE64)
{
Block block;
try {
@@ -125,7 +140,7 @@
*/
template<typename T>
void
-save(const T& obj, const std::string& filename, IoEncoding encoding = BASE_64)
+save(const T& obj, const std::string& filename, IoEncoding encoding = BASE64)
{
std::ofstream os(filename);
save(obj, os, encoding);