9#include <botan/internal/os_utils.h>
10#include <botan/internal/cpuid.h>
11#include <botan/exceptn.h>
12#include <botan/mem_ops.h>
18#if defined(BOTAN_TARGET_OS_HAS_THREADS)
22#if defined(BOTAN_TARGET_OS_HAS_EXPLICIT_BZERO)
26#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
27 #include <sys/types.h>
28 #include <sys/resource.h>
39#if defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
40 #include <emscripten/emscripten.h>
43#if defined(BOTAN_TARGET_OS_HAS_GETAUXVAL) || defined(BOTAN_TARGET_OS_IS_ANDROID) || \
44 defined(BOTAN_TARGET_OS_HAS_ELF_AUX_INFO)
48#if defined(BOTAN_TARGET_OS_HAS_AUXINFO)
53#if defined(BOTAN_TARGET_OS_HAS_WIN32)
59#if defined(BOTAN_TARGET_OS_IS_ANDROID)
61 extern "C" char **environ;
64#if defined(BOTAN_TARGET_OS_IS_IOS) || defined(BOTAN_TARGET_OS_IS_MACOS)
65 #include <sys/types.h>
66 #include <sys/sysctl.h>
67 #include <mach/vm_statistics.h>
70#if defined(BOTAN_TARGET_OS_HAS_PRCTL)
71 #include <sys/prctl.h>
72 #if !defined(PR_SET_VMA)
73 #define PR_SET_VMA 0x53564d41
74 #define PR_SET_VMA_ANON_NAME 0
83#if defined(BOTAN_TARGET_OS_HAS_RTLSECUREZEROMEMORY)
84 ::RtlSecureZeroMemory(ptr, n);
86#elif defined(BOTAN_TARGET_OS_HAS_EXPLICIT_BZERO)
87 ::explicit_bzero(ptr, n);
89#elif defined(BOTAN_TARGET_OS_HAS_EXPLICIT_MEMSET)
90 (void)::explicit_memset(ptr, 0, n);
92#elif defined(BOTAN_USE_VOLATILE_MEMSET_FOR_ZERO) && (BOTAN_USE_VOLATILE_MEMSET_FOR_ZERO == 1)
100 static void* (*
const volatile memset_ptr)(
void*,
int,
size_t) = std::memset;
101 (memset_ptr)(ptr, 0, n);
104 volatile uint8_t* p =
reinterpret_cast<volatile uint8_t*
>(ptr);
106 for(
size_t i = 0; i != n; ++i)
113#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
115#elif defined(BOTAN_TARGET_OS_HAS_WIN32)
116 return ::GetCurrentProcessId();
117#elif defined(BOTAN_TARGET_OS_IS_LLVM) || defined(BOTAN_TARGET_OS_IS_NONE)
120 #error "Missing get_process_id"
126#if defined(BOTAN_TARGET_OS_HAS_GETAUXVAL)
127 return ::getauxval(
id);
128#elif defined(BOTAN_TARGET_OS_IS_ANDROID) && defined(BOTAN_TARGET_ARCH_IS_ARM32)
135 while(*p++ !=
nullptr)
138 Elf32_auxv_t *e =
reinterpret_cast<Elf32_auxv_t*
>(p);
143 return e->a_un.a_val;
148#elif defined(BOTAN_TARGET_OS_HAS_ELF_AUX_INFO)
149 unsigned long auxinfo = 0;
150 ::elf_aux_info(
static_cast<int>(
id), &auxinfo,
sizeof(auxinfo));
152#elif defined(BOTAN_TARGET_OS_HAS_AUXINFO)
153 for (
const AuxInfo *auxinfo =
static_cast<AuxInfo *
>(::_dlauxinfo()); auxinfo != AT_NULL; ++auxinfo)
155 if (
id == auxinfo->a_type)
168#if defined(AT_SECURE)
170#elif defined(BOTAN_TARGET_OS_HAS_POSIX1)
171 return (::getuid() != ::geteuid()) || (::getgid() != ::getegid());
181#if defined(BOTAN_TARGET_OS_HAS_WIN32)
183 ::QueryPerformanceCounter(&tv);
186#elif defined(BOTAN_USE_GCC_INLINE_ASM)
188#if defined(BOTAN_TARGET_CPU_IS_X86_FAMILY)
190 if(CPUID::has_rdtsc())
192 uint32_t rtc_low = 0, rtc_high = 0;
193 asm volatile(
"rdtsc" :
"=d" (rtc_high),
"=a" (rtc_low));
194 rtc = (
static_cast<uint64_t
>(rtc_high) << 32) | rtc_low;
197#elif defined(BOTAN_TARGET_ARCH_IS_PPC64)
201 uint32_t rtc_low = 0, rtc_high = 0, rtc_high2 = 0;
202 asm volatile(
"mftbu %0" :
"=r" (rtc_high));
203 asm volatile(
"mftb %0" :
"=r" (rtc_low));
204 asm volatile(
"mftbu %0" :
"=r" (rtc_high2));
206 if(rtc_high == rtc_high2)
208 rtc = (
static_cast<uint64_t
>(rtc_high) << 32) | rtc_low;
213#elif defined(BOTAN_TARGET_ARCH_IS_ALPHA)
214 asm volatile(
"rpcc %0" :
"=r" (rtc));
217#elif defined(BOTAN_TARGET_ARCH_IS_SPARC64) && !defined(BOTAN_TARGET_OS_IS_OPENBSD)
218 asm volatile(
"rd %%tick, %0" :
"=r" (rtc));
220#elif defined(BOTAN_TARGET_ARCH_IS_IA64)
221 asm volatile(
"mov %0=ar.itc" :
"=r" (rtc));
223#elif defined(BOTAN_TARGET_ARCH_IS_S390X)
224 asm volatile(
"stck 0(%0)" : :
"a" (&rtc) :
"memory",
"cc");
226#elif defined(BOTAN_TARGET_ARCH_IS_HPPA)
227 asm volatile(
"mfctl 16,%0" :
"=r" (rtc));
240#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
242#if defined(_SC_NPROCESSORS_ONLN)
243 const long cpu_online = ::sysconf(_SC_NPROCESSORS_ONLN);
245 return static_cast<size_t>(cpu_online);
248#if defined(_SC_NPROCESSORS_CONF)
249 const long cpu_conf = ::sysconf(_SC_NPROCESSORS_CONF);
251 return static_cast<size_t>(cpu_conf);
256#if defined(BOTAN_TARGET_OS_HAS_THREADS)
259 const size_t hw_concur = std::thread::hardware_concurrency();
273#if defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
274 return emscripten_get_now();
284#if defined(BOTAN_TARGET_OS_HAS_CLOCK_GETTIME)
287 const clockid_t clock_types[] = {
288#if defined(CLOCK_MONOTONIC_HR)
291#if defined(CLOCK_MONOTONIC_RAW)
294#if defined(CLOCK_MONOTONIC)
297#if defined(CLOCK_PROCESS_CPUTIME_ID)
298 CLOCK_PROCESS_CPUTIME_ID,
300#if defined(CLOCK_THREAD_CPUTIME_ID)
301 CLOCK_THREAD_CPUTIME_ID,
305 for(clockid_t clock : clock_types)
308 if(::clock_gettime(clock, &ts) == 0)
310 return (
static_cast<uint64_t
>(ts.tv_sec) * 1000000000) +
static_cast<uint64_t
>(ts.tv_nsec);
316 auto now = std::chrono::high_resolution_clock::now().time_since_epoch();
317 return std::chrono::duration_cast<std::chrono::nanoseconds>(now).count();
322#if defined(BOTAN_TARGET_OS_HAS_CLOCK_GETTIME)
324 if(::clock_gettime(CLOCK_REALTIME, &ts) == 0)
326 return (
static_cast<uint64_t
>(ts.tv_sec) * 1000000000) +
static_cast<uint64_t
>(ts.tv_nsec);
330 auto now = std::chrono::system_clock::now().time_since_epoch();
331 return std::chrono::duration_cast<std::chrono::nanoseconds>(now).count();
336 const size_t default_page_size = 4096;
338#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
339 long p = ::sysconf(_SC_PAGESIZE);
341 return static_cast<size_t>(p);
343 return default_page_size;
344#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
346 SYSTEM_INFO sys_info;
347 ::GetSystemInfo(&sys_info);
348 return sys_info.dwPageSize;
350 return default_page_size;
364 const size_t max_locked_kb = 512;
370#if defined(RLIMIT_MEMLOCK) && defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
371 const size_t mlock_requested = std::min<size_t>(
375 if(mlock_requested > 0)
377 struct ::rlimit limits;
379 ::getrlimit(RLIMIT_MEMLOCK, &limits);
381 if(limits.rlim_cur < limits.rlim_max)
383 limits.rlim_cur = limits.rlim_max;
384 ::setrlimit(RLIMIT_MEMLOCK, &limits);
385 ::getrlimit(RLIMIT_MEMLOCK, &limits);
388 return std::min<size_t>(limits.rlim_cur, mlock_requested * 1024);
391#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
392 const size_t mlock_requested = std::min<size_t>(
396 SIZE_T working_min = 0, working_max = 0;
397 if(!::GetProcessWorkingSetSize(::GetCurrentProcess(), &working_min, &working_max))
409 if(working_min > overhead)
411 const size_t lockable_bytes = working_min - overhead;
412 return std::min<size_t>(lockable_bytes, mlock_requested * 1024);
429#if defined(BOTAN_TARGET_OS_HAS_WIN32) && defined(BOTAN_BUILD_COMPILER_IS_MSVC)
430 const std::string
name(name_view);
431 char val[128] = { 0 };
433 if(getenv_s(&req_size, val,
sizeof(val),
name.c_str()) == 0)
435 value_out = std::string(val, req_size);
439 const std::string
name(name_view);
440 if(
const char* val = std::getenv(
name.c_str()))
457 const size_t val = std::stoul(value,
nullptr);
460 catch(std::exception&) { }
466#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
472#if defined(BOTAN_TARGET_OS_IS_IOS) || defined(BOTAN_TARGET_OS_IS_MACOS)
475 static constexpr int default_locked_fd = 255;
476 int locked_fd = default_locked_fd;
478 if(
size_t locked_fdl = OS::read_env_variable_sz(
"BOTAN_LOCKED_FD", default_locked_fd))
480 if(locked_fdl < 240 || locked_fdl > 255)
482 locked_fdl = default_locked_fd;
484 locked_fd =
static_cast<int>(locked_fdl);
486 return VM_MAKE_TAG(locked_fd);
498 std::vector<void*> result;
500#if (defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)) || defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
502 result.reserve(count);
506#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
507 static const int locked_fd = get_locked_fd();
510 for(
size_t i = 0; i != count; ++i)
514#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
516 int mmap_flags = MAP_PRIVATE;
518#if defined(MAP_ANONYMOUS)
519 mmap_flags |= MAP_ANONYMOUS;
520#elif defined(MAP_ANON)
521 mmap_flags |= MAP_ANON;
524#if defined(MAP_CONCEAL)
525 mmap_flags |= MAP_CONCEAL;
526#elif defined(MAP_NOCORE)
527 mmap_flags |= MAP_NOCORE;
530 int mmap_prot = PROT_READ | PROT_WRITE;
533 mmap_prot |= PROT_MAX(mmap_prot);
536 ptr = ::mmap(
nullptr, 3*page_size,
537 mmap_prot, mmap_flags,
540 if(ptr == MAP_FAILED)
546 if(::mlock(
static_cast<uint8_t*
>(ptr) + page_size, page_size) != 0)
548 ::munmap(ptr, 3*page_size);
552#if defined(MADV_DONTDUMP)
554 ::madvise(
static_cast<uint8_t*
>(ptr) + page_size, page_size, MADV_DONTDUMP);
557#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
558 ptr = ::VirtualAlloc(
nullptr, 3*page_size, MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
563 if(::VirtualLock(
static_cast<uint8_t*
>(ptr) + page_size, page_size) == 0)
565 ::VirtualFree(ptr, 0, MEM_RELEASE);
570 std::memset(ptr, 0, 3*page_size);
579 result.push_back(
static_cast<uint8_t*
>(ptr) + page_size);
590#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
592 ::mprotect(page, page_size, PROT_READ | PROT_WRITE);
593#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
596 ::VirtualProtect(page, page_size, PAGE_READWRITE, &old_perms);
605#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
607 ::mprotect(page, page_size, PROT_NONE);
608#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
611 ::VirtualProtect(page, page_size, PAGE_NOACCESS, &old_perms);
622 for(
size_t i = 0; i != pages.size(); ++i)
624 void* ptr = pages[i];
632#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
633 ::munlock(ptr, page_size);
634 ::munmap(
static_cast<uint8_t*
>(ptr) - page_size, 3*page_size);
635#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
636 ::VirtualUnlock(ptr, page_size);
637 ::VirtualFree(
static_cast<uint8_t*
>(ptr) - page_size, 0, MEM_RELEASE);
644#if defined(BOTAN_TARGET_OS_HAS_PRCTL)
645 static constexpr char name[] =
"Botan mlock pool";
646 int r = prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME,
reinterpret_cast<uintptr_t
>(page), size,
name);
653#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && !defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
657::sigjmp_buf g_sigill_jmp_buf;
659void botan_sigill_handler(
int )
661 siglongjmp(g_sigill_jmp_buf, 1);
670 volatile int probe_result = -3;
672#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && !defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
673 struct sigaction old_sigaction;
674 struct sigaction sigaction;
676 sigaction.sa_handler = botan_sigill_handler;
677 sigemptyset(&sigaction.sa_mask);
678 sigaction.sa_flags = 0;
680 int rc = ::sigaction(SIGILL, &sigaction, &old_sigaction);
683 throw System_Error(
"run_cpu_instruction_probe sigaction failed", errno);
685 rc = sigsetjmp(g_sigill_jmp_buf, 1);
690 probe_result = probe_fn();
699 rc = ::sigaction(SIGILL, &old_sigaction,
nullptr);
701 throw System_Error(
"run_cpu_instruction_probe sigaction restore failed", errno);
712#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
716 POSIX_Echo_Suppression()
718 m_stdin_fd = fileno(stdin);
719 if(::tcgetattr(m_stdin_fd, &m_old_termios) != 0)
720 throw System_Error(
"Getting terminal status failed", errno);
722 struct termios noecho_flags = m_old_termios;
723 noecho_flags.c_lflag &= ~ECHO;
724 noecho_flags.c_lflag |= ECHONL;
726 if(::tcsetattr(m_stdin_fd, TCSANOW, &noecho_flags) != 0)
727 throw System_Error(
"Clearing terminal echo bit failed", errno);
730 void reenable_echo()
override
734 if(::tcsetattr(m_stdin_fd, TCSANOW, &m_old_termios) != 0)
735 throw System_Error(
"Restoring terminal echo bit failed", errno);
740 ~POSIX_Echo_Suppression()
override
751 POSIX_Echo_Suppression(
const POSIX_Echo_Suppression& other) =
delete;
752 POSIX_Echo_Suppression(POSIX_Echo_Suppression&& other) =
delete;
753 POSIX_Echo_Suppression& operator=(
const POSIX_Echo_Suppression& other) =
delete;
754 POSIX_Echo_Suppression& operator=(POSIX_Echo_Suppression&& other) =
delete;
758 struct termios m_old_termios;
761 return std::make_unique<POSIX_Echo_Suppression>();
763#elif defined(BOTAN_TARGET_OS_HAS_WIN32)
768 Win32_Echo_Suppression()
770 m_input_handle = ::GetStdHandle(STD_INPUT_HANDLE);
771 if(::GetConsoleMode(m_input_handle, &m_console_state) == 0)
772 throw System_Error(
"Getting console mode failed", ::GetLastError());
774 DWORD new_mode = ENABLE_LINE_INPUT | ENABLE_PROCESSED_INPUT;
775 if(::SetConsoleMode(m_input_handle, new_mode) == 0)
776 throw System_Error(
"Setting console mode failed", ::GetLastError());
779 void reenable_echo()
override
781 if(m_input_handle != INVALID_HANDLE_VALUE)
783 if(::SetConsoleMode(m_input_handle, m_console_state) == 0)
784 throw System_Error(
"Setting console mode failed", ::GetLastError());
785 m_input_handle = INVALID_HANDLE_VALUE;
789 ~Win32_Echo_Suppression()
override
800 Win32_Echo_Suppression(
const Win32_Echo_Suppression& other) =
delete;
801 Win32_Echo_Suppression(Win32_Echo_Suppression&& other) =
delete;
802 Win32_Echo_Suppression& operator=(
const Win32_Echo_Suppression& other) =
delete;
803 Win32_Echo_Suppression& operator=(Win32_Echo_Suppression&& other) =
delete;
806 HANDLE m_input_handle;
807 DWORD m_console_state;
810 return std::make_unique<Win32_Echo_Suppression>();
#define BOTAN_UNUSED(...)
bool running_in_privileged_state()
size_t get_memory_locking_limit()
uint64_t BOTAN_TEST_API get_high_resolution_clock()
size_t BOTAN_TEST_API get_cpu_available()
std::unique_ptr< Echo_Suppression > BOTAN_UNSTABLE_API suppress_echo_on_terminal()
size_t read_env_variable_sz(std::string_view var_name, size_t def_value=0)
void page_allow_access(void *page)
bool read_env_variable(std::string &value_out, std::string_view var_name)
void page_prohibit_access(void *page)
int BOTAN_TEST_API run_cpu_instruction_probe(const std::function< int()> &probe_fn)
std::vector< void * > allocate_locked_pages(size_t count)
size_t system_page_size()
uint64_t BOTAN_TEST_API get_system_timestamp_ns()
unsigned long get_auxval(unsigned long id)
void free_locked_pages(const std::vector< void * > &pages)
void page_named(void *page, size_t size)
uint32_t BOTAN_TEST_API get_process_id()
uint64_t BOTAN_TEST_API get_cpu_cycle_counter()
void secure_scrub_memory(void *ptr, size_t n)