DwmCredenceUtils.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath$
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2022, 2023
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================
 
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
 
#ifndef _DWMCREDENCEUTILS_HH_
#define _DWMCREDENCEUTILS_HH_
 
extern "C" {
  #include <sodium.h>
}
 
#include <chrono>
#include <cstdint>
#include <string>
#include <boost/asio.hpp>
#include <boost/version.hpp>
 
namespace Dwm {
 
  namespace Credence {
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    class Utils
    {
    public:
      using Clock = std::chrono::system_clock;
      using TimePoint = std::chrono::time_point<Clock>;
#if BOOST_VERSION >= 107400
      using BoostTcpSocket =
        boost::asio::basic_socket<boost::asio::ip::tcp,
                                  boost::asio::any_io_executor>;
      using BoostUnixSocket =
        boost::asio::basic_socket<boost::asio::local::stream_protocol,
                                  boost::asio::any_io_executor>;
#else
      using BoostTcpSocket =
        boost::asio::basic_socket<boost::asio::ip::tcp,
                                  boost::asio::executor>;
      using BoostUnixSocket =
        boost::asio::basic_socket<boost::asio::local::stream_protocol,
                                  boost::asio::executor>;
#endif
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static ssize_t BytesReady(BoostTcpSocket & sck);
      static ssize_t BytesReady(BoostUnixSocket & sck);
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static bool WaitUntilBytesReady(BoostTcpSocket & sck,
                                      uint32_t numBytes, TimePoint endTime);
      static bool WaitUntilBytesReady(BoostUnixSocket & sck,
                                      uint32_t numBytes, TimePoint endTime);
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static bool WaitForBytesReady(BoostTcpSocket & sck, uint32_t numBytes,
                                    std::chrono::milliseconds timeout);
      static bool WaitForBytesReady(BoostUnixSocket & sck, uint32_t numBytes,
                                    std::chrono::milliseconds timeout);
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static ssize_t
      ReadLengthRestrictedString(boost::asio::ip::tcp::socket & sck,
                                 std::string & s, uint64_t maxLen);
      static ssize_t
      ReadLengthRestrictedString(boost::asio::local::stream_protocol::socket & sck,
                                 std::string & s, uint64_t maxLen);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static std::istream & ReadLengthRestrictedString(std::istream & is,
                                                       std::string & s,
                                                       uint64_t maxLen);
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static ssize_t
      ReadLengthRestrictedString(boost::asio::ip::tcp::socket & sck,
                                 std::string & s, uint64_t maxLen,
                                 TimePoint endTime);
      static ssize_t
      ReadLengthRestrictedString(boost::asio::local::stream_protocol::socket & sck,
                                 std::string & s, uint64_t maxLen,
                                 TimePoint endTime);
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static std::string Bin2Base64(const std::string & s);
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static std::string Base642Bin(const std::string & s);
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static std::string UserHomeDirectory();
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static std::string UserName();
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static std::string HostName();
 
      static bool ScalarMult(const std::string & sk, const std::string & pk,
                             std::string & q);
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static std::string
      EndPointString(const boost::asio::ip::tcp::endpoint & endPoint);
    };
    
  }  // namespace Credence
 
}  // namespace Dwm
 
#endif  // _DWMCREDENCEUTILS_HH_