PosixSystem.hpp

Go to the documentation of this file.

/*
 * PosixSystem.hpp
 *
 * Copyright (C) 2022 by RStudio, PBC
 *
 * Unless you have received this program directly from RStudio pursuant to the terms of a commercial license agreement
 * with RStudio, then this program is licensed to you under the following terms:
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */
 
#ifndef LAUNCHER_PLUGINS_POSIX_SYSTEM_HPP
#define LAUNCHER_PLUGINS_POSIX_SYSTEM_HPP
 
#include <functional>
 
#include <Optional.hpp>
#include <Error.hpp>
 
namespace rstudio {
namespace launcher_plugins  {
namespace system {
 
class User;
 
} // namespace system
} // namespace launcher_plugins
} // namespace rstudio
 
namespace rstudio {
namespace launcher_plugins {
namespace system {
namespace posix {
 
struct IpAddress
{
   std::string Name;
 
   std::string Address;
};
 
Error enableCoreDumps();
 
std::string getEnvironmentVariable(const std::string& in_name);
 
launcher_plugins::Error getIpAddresses(std::vector<IpAddress>& out_addresses, bool in_includeIPv6 = false);
 
Error ignoreSignal(int in_signal);
 
template <typename T>
T posixCall(const std::function<T()>& in_posixFunction)
{
   const T ERR = -1;
 
   T result;
   while (true)
   {
      result = in_posixFunction();
 
      if (result == ERR && errno == EINTR)
         continue;
      else
         break;
   }
 
   return result;
}
 
template <typename T>
Error posixCall(const std::function<T()>& in_posixFunction,
                const ErrorLocation& in_errorLocation,
                T* out_result = nullptr)
{
   const T ERR = -1;
 
   // make the call
   T result = posixCall<T>(in_posixFunction);
 
   // set out param (if requested)
   if (out_result)
      *out_result = result;
 
   // return status
   if (result == ERR)
      return systemError(errno, in_errorLocation);
   else
      return Success();
}
 
bool realUserIsRoot();
 
Error restoreRoot();
 
Error restorePrivileges();
 
Error temporarilyDropPrivileges(const User& in_user, const Optional<GidType>& in_group);
 
} // namespace posix
} // namespace system
} // namespace launcher_plugins
} // namespace rstudio
 
#endif