9#include <botan/internal/os_utils.h>
11#include <botan/exceptn.h>
12#include <botan/mem_ops.h>
13#include <botan/internal/cpuid.h>
19#if defined(BOTAN_TARGET_OS_HAS_EXPLICIT_BZERO)
23#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
30 #include <sys/resource.h>
31 #include <sys/types.h>
37#if defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
38 #include <emscripten/emscripten.h>
41#if defined(BOTAN_TARGET_OS_HAS_GETAUXVAL) || defined(BOTAN_TARGET_OS_IS_ANDROID) || \
42 defined(BOTAN_TARGET_OS_HAS_ELF_AUX_INFO)
46#if defined(BOTAN_TARGET_OS_HAS_AUXINFO)
51#if defined(BOTAN_TARGET_OS_HAS_WIN32)
55 #if defined(BOTAN_BUILD_COMPILER_IS_MSVC)
56 #include <libloaderapi.h>
57 #include <stringapiset.h>
61#if defined(BOTAN_TARGET_OS_IS_ANDROID)
63extern "C" char** environ;
66#if defined(BOTAN_TARGET_OS_IS_IOS) || defined(BOTAN_TARGET_OS_IS_MACOS)
67 #include <mach/vm_statistics.h>
68 #include <sys/sysctl.h>
69 #include <sys/types.h>
72#if defined(BOTAN_TARGET_OS_HAS_PRCTL)
73 #include <sys/prctl.h>
76#if defined(BOTAN_TARGET_OS_IS_FREEBSD) || defined(BOTAN_TARGET_OS_IS_OPENBSD) || defined(BOTAN_TARGET_OS_IS_DRAGONFLY)
77 #include <pthread_np.h>
80#if defined(BOTAN_TARGET_OS_IS_HAIKU)
81 #include <kernel/OS.h>
88#if defined(BOTAN_TARGET_OS_HAS_RTLSECUREZEROMEMORY)
89 ::RtlSecureZeroMemory(ptr, n);
91#elif defined(BOTAN_TARGET_OS_HAS_EXPLICIT_BZERO)
92 ::explicit_bzero(ptr, n);
94#elif defined(BOTAN_TARGET_OS_HAS_EXPLICIT_MEMSET)
95 (void)::explicit_memset(ptr, 0, n);
97#elif defined(BOTAN_USE_VOLATILE_MEMSET_FOR_ZERO) && (BOTAN_USE_VOLATILE_MEMSET_FOR_ZERO == 1)
105 static void* (*
const volatile memset_ptr)(
void*,
int,
size_t) = std::memset;
106 (memset_ptr)(ptr, 0, n);
109 volatile uint8_t* p =
reinterpret_cast<volatile uint8_t*
>(ptr);
111 for(
size_t i = 0; i != n; ++i)
117#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
119#elif defined(BOTAN_TARGET_OS_HAS_WIN32)
120 return ::GetCurrentProcessId();
121#elif defined(BOTAN_TARGET_OS_IS_LLVM) || defined(BOTAN_TARGET_OS_IS_NONE)
124 #error "Missing get_process_id"
129#if defined(BOTAN_TARGET_OS_HAS_GETAUXVAL)
130 return ::getauxval(
id);
131#elif defined(BOTAN_TARGET_OS_IS_ANDROID) && defined(BOTAN_TARGET_ARCH_IS_ARM32)
138 while(*p++ !=
nullptr)
141 Elf32_auxv_t* e =
reinterpret_cast<Elf32_auxv_t*
>(p);
143 while(e !=
nullptr) {
145 return e->a_un.a_val;
150#elif defined(BOTAN_TARGET_OS_HAS_ELF_AUX_INFO)
151 unsigned long auxinfo = 0;
152 ::elf_aux_info(
static_cast<int>(
id), &auxinfo,
sizeof(auxinfo));
154#elif defined(BOTAN_TARGET_OS_HAS_AUXINFO)
155 for(
const AuxInfo* auxinfo =
static_cast<AuxInfo*
>(::_dlauxinfo()); auxinfo != AT_NULL; ++auxinfo) {
156 if(
id == auxinfo->a_type)
168#if defined(AT_SECURE)
170#elif defined(BOTAN_TARGET_OS_HAS_POSIX1)
171 return (::getuid() != ::geteuid()) || (::getgid() != ::getegid());
180#if defined(BOTAN_TARGET_OS_HAS_WIN32)
182 ::QueryPerformanceCounter(&tv);
185#elif defined(BOTAN_USE_GCC_INLINE_ASM)
187 #if defined(BOTAN_TARGET_CPU_IS_X86_FAMILY)
189 if(CPUID::has_rdtsc()) {
190 uint32_t rtc_low = 0, rtc_high = 0;
191 asm volatile(
"rdtsc" :
"=d"(rtc_high),
"=a"(rtc_low));
192 rtc = (
static_cast<uint64_t
>(rtc_high) << 32) | rtc_low;
195 #elif defined(BOTAN_TARGET_ARCH_IS_PPC64)
198 uint32_t rtc_low = 0, rtc_high = 0, rtc_high2 = 0;
199 asm volatile(
"mftbu %0" :
"=r"(rtc_high));
200 asm volatile(
"mftb %0" :
"=r"(rtc_low));
201 asm volatile(
"mftbu %0" :
"=r"(rtc_high2));
203 if(rtc_high == rtc_high2) {
204 rtc = (
static_cast<uint64_t
>(rtc_high) << 32) | rtc_low;
209 #elif defined(BOTAN_TARGET_ARCH_IS_ALPHA)
210 asm volatile(
"rpcc %0" :
"=r"(rtc));
213 #elif defined(BOTAN_TARGET_ARCH_IS_SPARC64) && !defined(BOTAN_TARGET_OS_IS_OPENBSD)
214 asm volatile(
"rd %%tick, %0" :
"=r"(rtc));
216 #elif defined(BOTAN_TARGET_ARCH_IS_IA64)
217 asm volatile(
"mov %0=ar.itc" :
"=r"(rtc));
219 #elif defined(BOTAN_TARGET_ARCH_IS_S390X)
220 asm volatile(
"stck 0(%0)" : :
"a"(&rtc) :
"memory",
"cc");
222 #elif defined(BOTAN_TARGET_ARCH_IS_HPPA)
223 asm volatile(
"mfctl 16,%0" :
"=r"(rtc));
235#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
237 #if defined(_SC_NPROCESSORS_ONLN)
238 const long cpu_online = ::sysconf(_SC_NPROCESSORS_ONLN);
240 return static_cast<size_t>(cpu_online);
244 #if defined(_SC_NPROCESSORS_CONF)
245 const long cpu_conf = ::sysconf(_SC_NPROCESSORS_CONF);
247 return static_cast<size_t>(cpu_conf);
253#if defined(BOTAN_TARGET_OS_HAS_THREADS)
256 const size_t hw_concur = std::thread::hardware_concurrency();
271#if defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
272 return emscripten_get_now();
282#if defined(BOTAN_TARGET_OS_HAS_CLOCK_GETTIME)
285 const clockid_t clock_types[] = {
286 #if defined(CLOCK_MONOTONIC_HR)
289 #if defined(CLOCK_MONOTONIC_RAW)
292 #if defined(CLOCK_MONOTONIC)
295 #if defined(CLOCK_PROCESS_CPUTIME_ID)
296 CLOCK_PROCESS_CPUTIME_ID,
298 #if defined(CLOCK_THREAD_CPUTIME_ID)
299 CLOCK_THREAD_CPUTIME_ID,
303 for(clockid_t clock : clock_types) {
305 if(::clock_gettime(clock, &ts) == 0) {
306 return (
static_cast<uint64_t
>(ts.tv_sec) * 1000000000) +
static_cast<uint64_t
>(ts.tv_nsec);
312 auto now = std::chrono::high_resolution_clock::now().time_since_epoch();
313 return std::chrono::duration_cast<std::chrono::nanoseconds>(now).count();
317#if defined(BOTAN_TARGET_OS_HAS_CLOCK_GETTIME)
319 if(::clock_gettime(CLOCK_REALTIME, &ts) == 0) {
320 return (
static_cast<uint64_t
>(ts.tv_sec) * 1000000000) +
static_cast<uint64_t
>(ts.tv_nsec);
324 auto now = std::chrono::system_clock::now().time_since_epoch();
325 return std::chrono::duration_cast<std::chrono::nanoseconds>(now).count();
329 const size_t default_page_size = 4096;
331#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
332 long p = ::sysconf(_SC_PAGESIZE);
334 return static_cast<size_t>(p);
336 return default_page_size;
338#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
340 SYSTEM_INFO sys_info;
341 ::GetSystemInfo(&sys_info);
342 return sys_info.dwPageSize;
344 return default_page_size;
357 const size_t max_locked_kb = 512;
363#if defined(RLIMIT_MEMLOCK) && defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
364 const size_t mlock_requested =
367 if(mlock_requested > 0) {
368 struct ::rlimit limits;
370 ::getrlimit(RLIMIT_MEMLOCK, &limits);
372 if(limits.rlim_cur < limits.rlim_max) {
373 limits.rlim_cur = limits.rlim_max;
374 ::setrlimit(RLIMIT_MEMLOCK, &limits);
375 ::getrlimit(RLIMIT_MEMLOCK, &limits);
378 return std::min<size_t>(limits.rlim_cur, mlock_requested * 1024);
381#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
382 const size_t mlock_requested =
385 SIZE_T working_min = 0, working_max = 0;
386 if(!::GetProcessWorkingSetSize(::GetCurrentProcess(), &working_min, &working_max)) {
397 if(working_min > overhead) {
398 const size_t lockable_bytes = working_min - overhead;
399 return std::min<size_t>(lockable_bytes, mlock_requested * 1024);
416#if defined(BOTAN_TARGET_OS_HAS_WIN32) && defined(BOTAN_BUILD_COMPILER_IS_MSVC)
417 const std::string
name(name_view);
420 if(getenv_s(&req_size, val,
sizeof(val),
name.c_str()) == 0) {
424 if(req_size > 0 && val[req_size - 1] ==
'\0') {
425 value_out = std::string(val);
427 value_out = std::string(val, req_size);
432 const std::string
name(name_view);
433 if(
const char* val = std::getenv(
name.c_str())) {
446 const size_t val = std::stoul(value,
nullptr);
448 }
catch(std::exception&) {
455#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
460 #if defined(BOTAN_TARGET_OS_IS_IOS) || defined(BOTAN_TARGET_OS_IS_MACOS)
463 static constexpr int default_locked_fd = 255;
464 int locked_fd = default_locked_fd;
466 if(
size_t locked_fdl = OS::read_env_variable_sz(
"BOTAN_LOCKED_FD", default_locked_fd)) {
467 if(locked_fdl < 240 || locked_fdl > 255) {
468 locked_fdl = default_locked_fd;
470 locked_fd =
static_cast<int>(locked_fdl);
472 return VM_MAKE_TAG(locked_fd);
483 std::vector<void*> result;
485#if(defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)) || \
486 defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
488 result.reserve(count);
492 #if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
493 static const int locked_fd = get_locked_fd();
496 for(
size_t i = 0; i != count; ++i) {
499 #if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
501 int mmap_flags = MAP_PRIVATE;
503 #if defined(MAP_ANONYMOUS)
504 mmap_flags |= MAP_ANONYMOUS;
505 #elif defined(MAP_ANON)
506 mmap_flags |= MAP_ANON;
509 #if defined(MAP_CONCEAL)
510 mmap_flags |= MAP_CONCEAL;
511 #elif defined(MAP_NOCORE)
512 mmap_flags |= MAP_NOCORE;
515 int mmap_prot = PROT_READ | PROT_WRITE;
517 #if defined(PROT_MAX)
518 mmap_prot |= PROT_MAX(mmap_prot);
521 ptr = ::mmap(
nullptr,
528 if(ptr == MAP_FAILED) {
533 if(::mlock(
static_cast<uint8_t*
>(ptr) + page_size, page_size) != 0) {
534 ::munmap(ptr, 3 * page_size);
538 #if defined(MADV_DONTDUMP)
540 ::madvise(
static_cast<uint8_t*
>(ptr) + page_size, page_size, MADV_DONTDUMP);
543 #elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
544 ptr = ::VirtualAlloc(
nullptr, 3 * page_size, MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
549 if(::VirtualLock(
static_cast<uint8_t*
>(ptr) + page_size, page_size) == 0) {
550 ::VirtualFree(ptr, 0, MEM_RELEASE);
555 std::memset(ptr, 0, 3 * page_size);
564 result.push_back(
static_cast<uint8_t*
>(ptr) + page_size);
574#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
576 ::mprotect(page, page_size, PROT_READ | PROT_WRITE);
577#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
580 ::VirtualProtect(page, page_size, PAGE_READWRITE, &old_perms);
588#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
590 ::mprotect(page, page_size, PROT_NONE);
591#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
594 ::VirtualProtect(page, page_size, PAGE_NOACCESS, &old_perms);
604 for(
size_t i = 0; i != pages.size(); ++i) {
605 void* ptr = pages[i];
613#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
614 ::munlock(ptr, page_size);
615 ::munmap(
static_cast<uint8_t*
>(ptr) - page_size, 3 * page_size);
616#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
617 ::VirtualUnlock(ptr, page_size);
618 ::VirtualFree(
static_cast<uint8_t*
>(ptr) - page_size, 0, MEM_RELEASE);
624#if defined(BOTAN_TARGET_OS_HAS_PRCTL) && defined(PR_SET_VMA) && defined(PR_SET_VMA_ANON_NAME)
625 static constexpr char name[] =
"Botan mlock pool";
626 int r = prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME,
reinterpret_cast<uintptr_t
>(page), size,
name);
633#if defined(BOTAN_TARGET_OS_HAS_THREADS)
634void OS::set_thread_name(std::thread& thread,
const std::string&
name) {
635 #if defined(BOTAN_TARGET_OS_IS_LINUX) || defined(BOTAN_TARGET_OS_IS_FREEBSD) || defined(BOTAN_TARGET_OS_IS_DRAGONFLY)
636 static_cast<void>(pthread_setname_np(thread.native_handle(),
name.c_str()));
637 #elif defined(BOTAN_TARGET_OS_IS_OPENBSD)
638 static_cast<void>(pthread_set_name_np(thread.native_handle(),
name.c_str()));
639 #elif defined(BOTAN_TARGET_OS_IS_NETBSD)
640 static_cast<void>(pthread_setname_np(thread.native_handle(),
"%s",
const_cast<char*
>(
name.c_str())));
641 #elif defined(BOTAN_TARGET_OS_HAS_WIN32) && defined(_LIBCPP_HAS_THREAD_API_PTHREAD)
642 static_cast<void>(pthread_setname_np(thread.native_handle(),
name.c_str()));
643 #elif defined(BOTAN_TARGET_OS_HAS_WIN32) && defined(BOTAN_BUILD_COMPILER_IS_MSVC)
644 typedef HRESULT(WINAPI * std_proc)(HANDLE, PCWSTR);
645 HMODULE kern = GetModuleHandleA(
"KernelBase.dll");
646 std_proc set_thread_name =
reinterpret_cast<std_proc
>(GetProcAddress(kern,
"SetThreadDescription"));
647 if(set_thread_name) {
649 auto sz = MultiByteToWideChar(CP_UTF8, 0,
name.data(), -1,
nullptr, 0);
652 if(MultiByteToWideChar(CP_UTF8, 0,
name.data(), -1, &w[0], sz) > 0) {
653 (void)set_thread_name(thread.native_handle(), w.c_str());
657 #elif defined(BOTAN_TARGET_OS_IF_HAIKU)
658 auto thread_id = get_pthread_thread_id(thread.native_handle());
659 static_cast<void>(rename_thread(thread_id,
name.c_str()));
668#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && !defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
673::sigjmp_buf g_sigill_jmp_buf;
675void botan_sigill_handler(
int ) {
676 siglongjmp(g_sigill_jmp_buf, 1);
684 volatile int probe_result = -3;
686#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && !defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
687 struct sigaction old_sigaction;
688 struct sigaction sigaction;
690 sigaction.sa_handler = botan_sigill_handler;
691 sigemptyset(&sigaction.sa_mask);
692 sigaction.sa_flags = 0;
694 int rc = ::sigaction(SIGILL, &sigaction, &old_sigaction);
697 throw System_Error(
"run_cpu_instruction_probe sigaction failed", errno);
700 rc = sigsetjmp(g_sigill_jmp_buf, 1);
704 probe_result = probe_fn();
711 rc = ::sigaction(SIGILL, &old_sigaction,
nullptr);
713 throw System_Error(
"run_cpu_instruction_probe sigaction restore failed", errno);
724#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
727 POSIX_Echo_Suppression() {
728 m_stdin_fd = fileno(stdin);
729 if(::tcgetattr(m_stdin_fd, &m_old_termios) != 0) {
730 throw System_Error(
"Getting terminal status failed", errno);
733 struct termios noecho_flags = m_old_termios;
734 noecho_flags.c_lflag &= ~ECHO;
735 noecho_flags.c_lflag |= ECHONL;
737 if(::tcsetattr(m_stdin_fd, TCSANOW, &noecho_flags) != 0) {
738 throw System_Error(
"Clearing terminal echo bit failed", errno);
742 void reenable_echo()
override {
744 if(::tcsetattr(m_stdin_fd, TCSANOW, &m_old_termios) != 0) {
745 throw System_Error(
"Restoring terminal echo bit failed", errno);
751 ~POSIX_Echo_Suppression()
override {
757 POSIX_Echo_Suppression(
const POSIX_Echo_Suppression& other) =
delete;
758 POSIX_Echo_Suppression(POSIX_Echo_Suppression&& other) =
delete;
759 POSIX_Echo_Suppression& operator=(
const POSIX_Echo_Suppression& other) =
delete;
760 POSIX_Echo_Suppression& operator=(POSIX_Echo_Suppression&& other) =
delete;
764 struct termios m_old_termios;
767 return std::make_unique<POSIX_Echo_Suppression>();
769#elif defined(BOTAN_TARGET_OS_HAS_WIN32)
773 Win32_Echo_Suppression() {
774 m_input_handle = ::GetStdHandle(STD_INPUT_HANDLE);
775 if(::GetConsoleMode(m_input_handle, &m_console_state) == 0)
776 throw System_Error(
"Getting console mode failed", ::GetLastError());
778 DWORD new_mode = ENABLE_LINE_INPUT | ENABLE_PROCESSED_INPUT;
779 if(::SetConsoleMode(m_input_handle, new_mode) == 0)
780 throw System_Error(
"Setting console mode failed", ::GetLastError());
783 void reenable_echo()
override {
784 if(m_input_handle != INVALID_HANDLE_VALUE) {
785 if(::SetConsoleMode(m_input_handle, m_console_state) == 0)
786 throw System_Error(
"Setting console mode failed", ::GetLastError());
787 m_input_handle = INVALID_HANDLE_VALUE;
791 ~Win32_Echo_Suppression()
override {
797 Win32_Echo_Suppression(
const Win32_Echo_Suppression& other) =
delete;
798 Win32_Echo_Suppression(Win32_Echo_Suppression&& other) =
delete;
799 Win32_Echo_Suppression& operator=(
const Win32_Echo_Suppression& other) =
delete;
800 Win32_Echo_Suppression& operator=(Win32_Echo_Suppression&& other) =
delete;
803 HANDLE m_input_handle;
804 DWORD m_console_state;
807 return std::make_unique<Win32_Echo_Suppression>();
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)