epee::wipeable_string Class Reference

#include <wipeable_string.h>

Public Types
typedef char	value_type

Public Member Functions
	wipeable_string ()
	wipeable_string (const wipeable_string &other)
	wipeable_string (wipeable_string &&other)
	wipeable_string (const std::string &other)
	wipeable_string (std::string &&other)
	wipeable_string (const char *s)
	wipeable_string (const char *s, size_t len)
	~wipeable_string ()
void	wipe ()
void	push_back (char c)
void	operator+= (char c)
void	operator+= (const std::string &s)
void	operator+= (const epee::wipeable_string &s)
void	operator+= (const char *s)
void	append (const char *ptr, size_t len)
char	pop_back ()
const char *	data () const noexcept
char *	data () noexcept
size_t	size () const noexcept
size_t	length () const noexcept
bool	empty () const noexcept
void	trim ()
void	split (std::vector< wipeable_string > &fields) const
boost::optional< wipeable_string >	parse_hexstr () const
template<typename T >
bool	hex_to_pod (T &pod) const
template<typename T >
bool	hex_to_pod (tools::scrubbed< T > &pod) const
void	resize (size_t sz)
void	reserve (size_t sz)
void	clear ()
bool	operator== (const wipeable_string &other) const noexcept
bool	operator!= (const wipeable_string &other) const noexcept
wipeable_string &	operator= (wipeable_string &&other)
wipeable_string &	operator= (const wipeable_string &other)

Detailed Description

Definition at line 40 of file wipeable_string.h.

Member Typedef Documentation

value_type

typedef char epee::wipeable_string::value_type

Definition at line 43 of file wipeable_string.h.

Constructor & Destructor Documentation

wipeable_string() [1/7]

epee::wipeable_string::wipeable_string ( )

inline

Definition at line 45 of file wipeable_string.h.

{}

wipeable_string() [2/7]

epee::wipeable_string::wipeable_string

(

const wipeable_string &

other

)

Definition at line 50 of file wipeable_string.cpp.

                                                            :
  buffer(other.buffer)
{
}

wipeable_string() [3/7]

epee::wipeable_string::wipeable_string

(

wipeable_string &&

other

)

Definition at line 55 of file wipeable_string.cpp.

{
  if (&other == this)
    return;
  buffer = std::move(other.buffer);
}

Here is the call graph for this function:

wipeable_string() [4/7]

epee::wipeable_string::wipeable_string

(

const std::string &

other

)

Definition at line 62 of file wipeable_string.cpp.

{
  grow(other.size());
  if (size() > 0)
    memcpy(buffer.data(), other.c_str(), size());
}

Here is the call graph for this function:

wipeable_string() [5/7]

epee::wipeable_string::wipeable_string

(

std::string &&

other

)

Definition at line 69 of file wipeable_string.cpp.

{
  grow(other.size());
  if (size() > 0)
    memcpy(buffer.data(), other.c_str(), size());
  if (!other.empty())
  {
    memwipe(&other[0], other.size()); // we're kinda left with this again aren't we
    other = std::string();
  }
}

Here is the call graph for this function:

wipeable_string() [6/7]

epee::wipeable_string::wipeable_string

(

const char *

s

)

Definition at line 81 of file wipeable_string.cpp.

{
  grow(strlen(s));
  if (size() > 0)
    memcpy(buffer.data(), s, size());
}

Here is the call graph for this function:

wipeable_string() [7/7]

epee::wipeable_string::wipeable_string	(	const char *	s,
		size_t	len
	)

Definition at line 88 of file wipeable_string.cpp.

{
  grow(len);
  memcpy(buffer.data(), s, len);
}

Here is the call graph for this function:

~wipeable_string()

epee::wipeable_string::~wipeable_string

(

)

Definition at line 94 of file wipeable_string.cpp.

{
  wipe();
}

Here is the call graph for this function:

Member Function Documentation

append()

void epee::wipeable_string::append	(	const char *	ptr,
		size_t	len
	)

Definition at line 143 of file wipeable_string.cpp.

{
  const size_t orgsz = size();
  CHECK_AND_ASSERT_THROW_MES(orgsz < std::numeric_limits<size_t>::max() - len, "Appended data too large");
  grow(orgsz + len);
  if (len > 0)
    memcpy(data() + orgsz, ptr, len);
}

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

void epee::wipeable_string::clear

(

)

Definition at line 243 of file wipeable_string.cpp.

{
  resize(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

data() [1/2]

const char* epee::wipeable_string::data ( ) const

inlinenoexcept

Definition at line 61 of file wipeable_string.h.

{ return buffer.data(); }

Here is the caller graph for this function:

data() [2/2]

char* epee::wipeable_string::data ( )

inlinenoexcept

Definition at line 62 of file wipeable_string.h.

{ return buffer.data(); }

empty()

bool epee::wipeable_string::empty ( ) const

inlinenoexcept

Definition at line 65 of file wipeable_string.h.

{ return buffer.empty(); }

Here is the caller graph for this function:

hex_to_pod() [1/2]

template<typename T >

bool epee::wipeable_string::hex_to_pod ( T &  pod ) const

inline

Definition at line 86 of file wipeable_string.h.

  {
    static_assert(std::is_pod<T>::value, "expected pod type");
    if (size() != sizeof(T) * 2)
      return false;
    boost::optional<epee::wipeable_string> blob = parse_hexstr();
    if (!blob)
      return false;
    if (blob->size() != sizeof(T))
      return false;
    pod = *(const T*)blob->data();
    return true;
  }

Here is the call graph for this function:

hex_to_pod() [2/2]

template<typename T >

bool epee::wipeable_string::hex_to_pod ( tools::scrubbed< T > &  pod ) const

inline

Definition at line 70 of file wipeable_string.h.

{ return hex_to_pod(unwrap(pod)); }

Here is the call graph for this function:

Here is the caller graph for this function:

length()

size_t epee::wipeable_string::length ( ) const

inlinenoexcept

Definition at line 64 of file wipeable_string.h.

{ return buffer.size(); }

operator!=()

bool epee::wipeable_string::operator!= ( const wipeable_string &  other ) const

inlinenoexcept

Definition at line 75 of file wipeable_string.h.

{ return buffer != other.buffer; }

operator+=() [1/4]

void epee::wipeable_string::operator+=

(

char

c

)

Definition at line 138 of file wipeable_string.cpp.

{
  push_back(c);
}

Here is the call graph for this function:

operator+=() [2/4]

void epee::wipeable_string::operator+=

(

const char *

s

)

Definition at line 152 of file wipeable_string.cpp.

{
  append(s, strlen(s));
}

Here is the call graph for this function:

operator+=() [3/4]

void epee::wipeable_string::operator+=

(

const epee::wipeable_string &

s

)

Definition at line 157 of file wipeable_string.cpp.

{
  append(s.data(), s.size());
}

Here is the call graph for this function:

operator+=() [4/4]

void epee::wipeable_string::operator+=

(

const std::string &

s

)

Definition at line 162 of file wipeable_string.cpp.

{
  append(s.c_str(), s.size());
}

Here is the call graph for this function:

operator=() [1/2]

wipeable_string & epee::wipeable_string::operator=

(

const wipeable_string &

other

)

Definition at line 255 of file wipeable_string.cpp.

{
  if (&other != this)
    buffer = other.buffer;
  return *this;
}

operator=() [2/2]

wipeable_string & epee::wipeable_string::operator=

(

wipeable_string &&

other

)

Definition at line 248 of file wipeable_string.cpp.

{
  if (&other != this)
    buffer = std::move(other.buffer);
  return *this;
}

Here is the call graph for this function:

operator==()

bool epee::wipeable_string::operator== ( const wipeable_string &  other ) const

inlinenoexcept

Definition at line 74 of file wipeable_string.h.

{ return buffer == other.buffer; }

parse_hexstr()

boost::optional< epee::wipeable_string > epee::wipeable_string::parse_hexstr

(

)

const

Definition at line 201 of file wipeable_string.cpp.

{
  if (size() % 2 != 0)
    return boost::none;
  boost::optional<epee::wipeable_string> res = epee::wipeable_string("");
  const size_t len = size();
  const char *d = data();
  res->grow(0, len / 2);
  for (size_t i = 0; i < len; i += 2)
  {
    char c = atolower(d[i]);
    const char *ptr0 = strchr(hex, c);
    if (!ptr0)
      return boost::none;
    c = atolower(d[i+1]);
    const char *ptr1 = strchr(hex, c);
    if (!ptr1)
      return boost::none;
    res->push_back(((ptr0-hex)<<4) | (ptr1-hex));
  }
  return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pop_back()

char epee::wipeable_string::pop_back

(

)

Definition at line 224 of file wipeable_string.cpp.

{
  const size_t sz = size();
  CHECK_AND_ASSERT_THROW_MES(sz > 0, "Popping from an empty string");
  const char c = buffer.back();
  resize(sz - 1);
  return c;
}

Here is the call graph for this function:

Here is the caller graph for this function:

push_back()

void epee::wipeable_string::push_back

(

char

c

)

Definition at line 132 of file wipeable_string.cpp.

{
  grow(size() + 1);
  buffer.back() = c;
}

Here is the call graph for this function:

Here is the caller graph for this function:

reserve()

void epee::wipeable_string::reserve

(

size_t

sz

)

Definition at line 238 of file wipeable_string.cpp.

{
  grow(size(), sz);
}

Here is the call graph for this function:

resize()

void epee::wipeable_string::resize

(

size_t

sz

)

Definition at line 233 of file wipeable_string.cpp.

{
  grow(sz);
}

Here is the caller graph for this function:

size()

size_t epee::wipeable_string::size ( ) const

inlinenoexcept

Definition at line 63 of file wipeable_string.h.

{ return buffer.size(); }

Here is the caller graph for this function:

split()

void epee::wipeable_string::split

(

std::vector< wipeable_string > &

fields

)

const

Definition at line 182 of file wipeable_string.cpp.

{
  fields.clear();
  size_t len = size();
  const char *ptr = data();
  bool space = true;
  while (len--)
  {
    const char c = *ptr++;
    if (c != ' ')
    {
      if (space)
        fields.push_back({});
      fields.back().push_back(c);
    }
    space = c == ' ';
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

trim()

void epee::wipeable_string::trim

(

)

Definition at line 167 of file wipeable_string.cpp.

{
  size_t prefix = 0;
  while (prefix < size() && data()[prefix] == ' ')
    ++prefix;
  if (prefix > 0)
    memmove(buffer.data(), buffer.data() + prefix, size() - prefix);
 
  size_t suffix = 0;
  while (suffix < size()-prefix && data()[size() - 1 - prefix - suffix] == ' ')
    ++suffix;
 
  resize(size() - prefix - suffix);
}

Here is the call graph for this function:

wipe()

void epee::wipeable_string::wipe

(

)

Definition at line 99 of file wipeable_string.cpp.

{
  if (!buffer.empty())
    memwipe(buffer.data(), buffer.size() * sizeof(char));
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• /home/abuild/rpmbuild/BUILD/electroneum-4.0.0.0/contrib/epee/include/wipeable_string.h
• /home/abuild/rpmbuild/BUILD/electroneum-4.0.0.0/contrib/epee/src/wipeable_string.cpp