9#include <botan/internal/os_utils.h>
10#include <botan/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_WIN32)
54#if defined(BOTAN_TARGET_OS_IS_ANDROID)
56 extern "C" char **environ;
59#if defined(BOTAN_TARGET_OS_IS_IOS) || defined(BOTAN_TARGET_OS_IS_MACOS)
60 #include <mach/vm_statistics.h>
68#if defined(BOTAN_TARGET_OS_HAS_RTLSECUREZEROMEMORY)
69 ::RtlSecureZeroMemory(ptr, n);
71#elif defined(BOTAN_TARGET_OS_HAS_EXPLICIT_BZERO)
72 ::explicit_bzero(ptr, n);
74#elif defined(BOTAN_TARGET_OS_HAS_EXPLICIT_MEMSET)
75 (void)::explicit_memset(ptr, 0, n);
77#elif defined(BOTAN_USE_VOLATILE_MEMSET_FOR_ZERO) && (BOTAN_USE_VOLATILE_MEMSET_FOR_ZERO == 1)
85 static void* (*
const volatile memset_ptr)(
void*,
int,
size_t) = std::memset;
86 (memset_ptr)(ptr, 0, n);
89 volatile uint8_t* p =
reinterpret_cast<volatile uint8_t*
>(ptr);
91 for(
size_t i = 0; i != n; ++i)
98#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
100#elif defined(BOTAN_TARGET_OS_HAS_WIN32)
101 return ::GetCurrentProcessId();
102#elif defined(BOTAN_TARGET_OS_IS_INCLUDEOS) || defined(BOTAN_TARGET_OS_IS_LLVM) || defined(BOTAN_TARGET_OS_IS_NONE)
105 #error "Missing get_process_id"
111#if defined(BOTAN_TARGET_OS_HAS_GETAUXVAL)
112 return ::getauxval(
id);
113#elif defined(BOTAN_TARGET_OS_IS_ANDROID) && defined(BOTAN_TARGET_ARCH_IS_ARM32)
120 while(*p++ !=
nullptr)
123 Elf32_auxv_t *e =
reinterpret_cast<Elf32_auxv_t*
>(p);
128 return e->a_un.a_val;
133#elif defined(BOTAN_TARGET_OS_HAS_ELF_AUX_INFO)
134 unsigned long auxinfo = 0;
135 ::elf_aux_info(
id, &auxinfo,
sizeof(auxinfo));
145#if defined(AT_SECURE)
147#elif defined(BOTAN_TARGET_OS_HAS_POSIX1)
148 return (::getuid() != ::geteuid()) || (::getgid() != ::getegid());
158#if defined(BOTAN_TARGET_OS_HAS_WIN32)
160 ::QueryPerformanceCounter(&tv);
163#elif defined(BOTAN_USE_GCC_INLINE_ASM)
165#if defined(BOTAN_TARGET_CPU_IS_X86_FAMILY)
167 if(CPUID::has_rdtsc())
169 uint32_t rtc_low = 0, rtc_high = 0;
170 asm volatile(
"rdtsc" :
"=d" (rtc_high),
"=a" (rtc_low));
171 rtc = (
static_cast<uint64_t
>(rtc_high) << 32) | rtc_low;
174#elif defined(BOTAN_TARGET_ARCH_IS_PPC64)
178 uint32_t rtc_low = 0, rtc_high = 0, rtc_high2 = 0;
179 asm volatile(
"mftbu %0" :
"=r" (rtc_high));
180 asm volatile(
"mftb %0" :
"=r" (rtc_low));
181 asm volatile(
"mftbu %0" :
"=r" (rtc_high2));
183 if(rtc_high == rtc_high2)
185 rtc = (
static_cast<uint64_t
>(rtc_high) << 32) | rtc_low;
190#elif defined(BOTAN_TARGET_ARCH_IS_ALPHA)
191 asm volatile(
"rpcc %0" :
"=r" (rtc));
194#elif defined(BOTAN_TARGET_ARCH_IS_SPARC64) && !defined(BOTAN_TARGET_OS_IS_OPENBSD)
195 asm volatile(
"rd %%tick, %0" :
"=r" (rtc));
197#elif defined(BOTAN_TARGET_ARCH_IS_IA64)
198 asm volatile(
"mov %0=ar.itc" :
"=r" (rtc));
200#elif defined(BOTAN_TARGET_ARCH_IS_S390X)
201 asm volatile(
"stck 0(%0)" : :
"a" (&rtc) :
"memory",
"cc");
203#elif defined(BOTAN_TARGET_ARCH_IS_HPPA)
204 asm volatile(
"mfctl 16,%0" :
"=r" (rtc));
217#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(_SC_NPROCESSORS_CONF)
218 const long res = ::sysconf(_SC_NPROCESSORS_CONF);
220 return static_cast<size_t>(res);
223#if defined(BOTAN_TARGET_OS_HAS_THREADS)
224 return static_cast<size_t>(std::thread::hardware_concurrency());
232#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(_SC_NPROCESSORS_ONLN)
233 const long res = ::sysconf(_SC_NPROCESSORS_ONLN);
235 return static_cast<size_t>(res);
246#if defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
247 return emscripten_get_now();
257#if defined(BOTAN_TARGET_OS_HAS_CLOCK_GETTIME)
260 const clockid_t clock_types[] = {
261#if defined(CLOCK_MONOTONIC_HR)
264#if defined(CLOCK_MONOTONIC_RAW)
267#if defined(CLOCK_MONOTONIC)
270#if defined(CLOCK_PROCESS_CPUTIME_ID)
271 CLOCK_PROCESS_CPUTIME_ID,
273#if defined(CLOCK_THREAD_CPUTIME_ID)
274 CLOCK_THREAD_CPUTIME_ID,
278 for(clockid_t clock : clock_types)
281 if(::clock_gettime(clock, &ts) == 0)
283 return (
static_cast<uint64_t
>(ts.tv_sec) * 1000000000) +
static_cast<uint64_t
>(ts.tv_nsec);
289 auto now = std::chrono::high_resolution_clock::now().time_since_epoch();
290 return std::chrono::duration_cast<std::chrono::nanoseconds>(now).count();
295#if defined(BOTAN_TARGET_OS_HAS_CLOCK_GETTIME)
297 if(::clock_gettime(CLOCK_REALTIME, &ts) == 0)
299 return (
static_cast<uint64_t
>(ts.tv_sec) * 1000000000) +
static_cast<uint64_t
>(ts.tv_nsec);
303 auto now = std::chrono::system_clock::now().time_since_epoch();
304 return std::chrono::duration_cast<std::chrono::nanoseconds>(now).count();
309 const size_t default_page_size = 4096;
311#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
312 long p = ::sysconf(_SC_PAGESIZE);
314 return static_cast<size_t>(p);
316 return default_page_size;
317#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
319 SYSTEM_INFO sys_info;
320 ::GetSystemInfo(&sys_info);
321 return sys_info.dwPageSize;
323 return default_page_size;
329#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK) && defined(RLIMIT_MEMLOCK)
342 const size_t user_req =
read_env_variable_sz(
"BOTAN_MLOCK_POOL_SIZE", BOTAN_MLOCK_ALLOCATOR_MAX_LOCKED_KB);
344 const size_t mlock_requested = std::min<size_t>(user_req, BOTAN_MLOCK_ALLOCATOR_MAX_LOCKED_KB);
346 if(mlock_requested > 0)
348 struct ::rlimit limits;
350 ::getrlimit(RLIMIT_MEMLOCK, &limits);
352 if(limits.rlim_cur < limits.rlim_max)
354 limits.rlim_cur = limits.rlim_max;
355 ::setrlimit(RLIMIT_MEMLOCK, &limits);
356 ::getrlimit(RLIMIT_MEMLOCK, &limits);
359 return std::min<size_t>(limits.rlim_cur, mlock_requested * 1024);
362#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
363 SIZE_T working_min = 0, working_max = 0;
364 if(!::GetProcessWorkingSetSize(::GetCurrentProcess(), &working_min, &working_max))
376 if(working_min > overhead)
378 const size_t lockable_bytes = working_min - overhead;
379 return std::min<size_t>(lockable_bytes, BOTAN_MLOCK_ALLOCATOR_MAX_LOCKED_KB * 1024);
394#if defined(BOTAN_TARGET_OS_HAS_WIN32) && defined(BOTAN_BUILD_COMPILER_IS_MSVC)
395 char val[128] = { 0 };
397 if(getenv_s(&req_size, val,
sizeof(val),
name.c_str()) == 0)
399 value_out = std::string(val, req_size);
403 if(
const char* val = std::getenv(
name.c_str()))
420 const size_t val = std::stoul(value,
nullptr);
423 catch(std::exception&) { }
429#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
435#if defined(BOTAN_TARGET_OS_IS_IOS) || defined(BOTAN_TARGET_OS_IS_MACOS)
438 static constexpr int default_locked_fd = 255;
439 int locked_fd = default_locked_fd;
441 if(
size_t locked_fdl = OS::read_env_variable_sz(
"BOTAN_LOCKED_FD", default_locked_fd))
443 if(locked_fdl < 240 || locked_fdl > 255)
445 locked_fdl = default_locked_fd;
447 locked_fd =
static_cast<int>(locked_fdl);
449 return VM_MAKE_TAG(locked_fd);
461 std::vector<void*> result;
463#if (defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)) || defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
465 result.reserve(count);
469#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
470 static const int locked_fd = get_locked_fd();
473 for(
size_t i = 0; i != count; ++i)
477#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
479#if !defined(MAP_ANONYMOUS)
480 #define MAP_ANONYMOUS MAP_ANON
483#if !defined(MAP_NOCORE)
484#if defined(MAP_CONCEAL)
485 #define MAP_NOCORE MAP_CONCEAL
491#if !defined(PROT_MAX)
492 #define PROT_MAX(p) 0
494 const int pflags = PROT_READ | PROT_WRITE;
496 ptr = ::mmap(
nullptr, 3*page_size,
497 pflags | PROT_MAX(pflags),
498 MAP_ANONYMOUS | MAP_PRIVATE | MAP_NOCORE,
501 if(ptr == MAP_FAILED)
507 if(::mlock(
static_cast<uint8_t*
>(ptr) + page_size, page_size) != 0)
509 ::munmap(ptr, 3*page_size);
513#if defined(MADV_DONTDUMP)
515 ::madvise(
static_cast<uint8_t*
>(ptr) + page_size, page_size, MADV_DONTDUMP);
518#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
519 ptr = ::VirtualAlloc(
nullptr, 3*page_size, MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
524 if(::VirtualLock(
static_cast<uint8_t*
>(ptr) + page_size, page_size) == 0)
526 ::VirtualFree(ptr, 0, MEM_RELEASE);
531 std::memset(ptr, 0, 3*page_size);
538 result.push_back(
static_cast<uint8_t*
>(ptr) + page_size);
549#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
551 ::mprotect(page, page_size, PROT_READ | PROT_WRITE);
552#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
555 ::VirtualProtect(page, page_size, PAGE_READWRITE, &old_perms);
564#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
566 ::mprotect(page, page_size, PROT_NONE);
567#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
570 ::VirtualProtect(page, page_size, PAGE_NOACCESS, &old_perms);
581 for(
size_t i = 0; i != pages.size(); ++i)
583 void* ptr = pages[i];
591#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
592 ::munlock(ptr, page_size);
593 ::munmap(
static_cast<uint8_t*
>(ptr) - page_size, 3*page_size);
594#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
595 ::VirtualUnlock(ptr, page_size);
596 ::VirtualFree(
static_cast<uint8_t*
>(ptr) - page_size, 0, MEM_RELEASE);
601#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && !defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
605static ::sigjmp_buf g_sigill_jmp_buf;
607void botan_sigill_handler(
int)
609 siglongjmp(g_sigill_jmp_buf, 1);
618 volatile int probe_result = -3;
620#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && !defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
621 struct sigaction old_sigaction;
622 struct sigaction sigaction;
624 sigaction.sa_handler = botan_sigill_handler;
625 sigemptyset(&sigaction.sa_mask);
626 sigaction.sa_flags = 0;
628 int rc = ::sigaction(SIGILL, &sigaction, &old_sigaction);
631 throw System_Error(
"run_cpu_instruction_probe sigaction failed", errno);
633 rc = sigsetjmp(g_sigill_jmp_buf, 1);
638 probe_result = probe_fn();
647 rc = ::sigaction(SIGILL, &old_sigaction,
nullptr);
649 throw System_Error(
"run_cpu_instruction_probe sigaction restore failed", errno);
660#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
664 POSIX_Echo_Suppression()
666 m_stdin_fd = fileno(stdin);
667 if(::tcgetattr(m_stdin_fd, &m_old_termios) != 0)
668 throw System_Error(
"Getting terminal status failed", errno);
670 struct termios noecho_flags = m_old_termios;
671 noecho_flags.c_lflag &= ~ECHO;
672 noecho_flags.c_lflag |= ECHONL;
674 if(::tcsetattr(m_stdin_fd, TCSANOW, &noecho_flags) != 0)
675 throw System_Error(
"Clearing terminal echo bit failed", errno);
678 void reenable_echo()
override
682 if(::tcsetattr(m_stdin_fd, TCSANOW, &m_old_termios) != 0)
683 throw System_Error(
"Restoring terminal echo bit failed", errno);
688 ~POSIX_Echo_Suppression()
701 struct termios m_old_termios;
704 return std::unique_ptr<Echo_Suppression>(
new POSIX_Echo_Suppression);
706#elif defined(BOTAN_TARGET_OS_HAS_WIN32)
711 Win32_Echo_Suppression()
713 m_input_handle = ::GetStdHandle(STD_INPUT_HANDLE);
714 if(::GetConsoleMode(m_input_handle, &m_console_state) == 0)
715 throw System_Error(
"Getting console mode failed", ::GetLastError());
717 DWORD new_mode = ENABLE_LINE_INPUT | ENABLE_PROCESSED_INPUT;
718 if(::SetConsoleMode(m_input_handle, new_mode) == 0)
719 throw System_Error(
"Setting console mode failed", ::GetLastError());
722 void reenable_echo()
override
724 if(m_input_handle != INVALID_HANDLE_VALUE)
726 if(::SetConsoleMode(m_input_handle, m_console_state) == 0)
727 throw System_Error(
"Setting console mode failed", ::GetLastError());
728 m_input_handle = INVALID_HANDLE_VALUE;
732 ~Win32_Echo_Suppression()
744 HANDLE m_input_handle;
745 DWORD m_console_state;
748 return std::unique_ptr<Echo_Suppression>(
new Win32_Echo_Suppression);
753 return std::unique_ptr<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()
void page_allow_access(void *page)
size_t BOTAN_TEST_API get_cpu_total()
void page_prohibit_access(void *page)
size_t read_env_variable_sz(const std::string &var_name, size_t def_value=0)
bool read_env_variable(std::string &value_out, const std::string &var_name)
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)
uint32_t BOTAN_TEST_API get_process_id()
uint64_t BOTAN_TEST_API get_cpu_cycle_counter()
int BOTAN_TEST_API run_cpu_instruction_probe(std::function< int()> probe_fn)
void secure_scrub_memory(void *ptr, size_t n)