mirror of
				https://git.proxmox.com/git/efi-boot-shim
				synced 2025-11-04 09:45:58 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			328 lines
		
	
	
		
			8.2 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			328 lines
		
	
	
		
			8.2 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
// SPDX-License-Identifier: BSD-2-Clause-Patent
 | 
						|
 | 
						|
#ifndef SHIM_H_
 | 
						|
#define SHIM_H_
 | 
						|
 | 
						|
#ifdef SHIM_UNIT_TEST
 | 
						|
#define _GNU_SOURCE
 | 
						|
#endif
 | 
						|
 | 
						|
#if defined __GNUC__ && defined __GNUC_MINOR__
 | 
						|
# define GNUC_PREREQ(maj, min) \
 | 
						|
        ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
 | 
						|
#else
 | 
						|
# define GNUC_PREREQ(maj, min) 0
 | 
						|
#endif
 | 
						|
#if defined __clang_major__ && defined __clang_minor__
 | 
						|
# define CLANG_PREREQ(maj, min) \
 | 
						|
  ((__clang_major__ << 16) + __clang_minor__ >= ((maj) << 16) + (min))
 | 
						|
#else
 | 
						|
# define CLANG_PREREQ(maj, min) 0
 | 
						|
#endif
 | 
						|
 | 
						|
#if defined(__x86_64__)
 | 
						|
/* gcc 4.5.4 is the first documented release with -mabi=ms */
 | 
						|
/* gcc 4.7.1 is the first one with __builtin_ms_va_list */
 | 
						|
#if !GNUC_PREREQ(4, 7) && !CLANG_PREREQ(3, 4)
 | 
						|
#error On x86_64 you must have a compiler new enough to support __attribute__((__ms_abi__))
 | 
						|
#endif
 | 
						|
 | 
						|
#if CLANG_PREREQ(3, 4)
 | 
						|
#pragma GCC diagnostic ignored "-Wpointer-bool-conversion"
 | 
						|
#endif
 | 
						|
 | 
						|
#if !defined(GNU_EFI_USE_EXTERNAL_STDARG)
 | 
						|
#define GNU_EFI_USE_EXTERNAL_STDARG
 | 
						|
#endif
 | 
						|
 | 
						|
#if !defined(GNU_EFI_USE_MS_ABI)
 | 
						|
#define GNU_EFI_USE_MS_ABI
 | 
						|
#endif
 | 
						|
 | 
						|
#ifdef NO_BUILTIN_VA_FUNCS
 | 
						|
#undef NO_BUILTIN_VA_FUNCS
 | 
						|
#endif
 | 
						|
#endif
 | 
						|
 | 
						|
#include <ctype.h>
 | 
						|
#include <stdbool.h>
 | 
						|
#include <stddef.h>
 | 
						|
#include <stdint.h>
 | 
						|
#include <stdarg.h>
 | 
						|
#include <string.h>
 | 
						|
#include <strings.h>
 | 
						|
 | 
						|
#ifndef SHIM_UNIT_TEST
 | 
						|
#include <efi.h>
 | 
						|
#include <efilib.h>
 | 
						|
#undef uefi_call_wrapper
 | 
						|
#include <efierr.h>
 | 
						|
#include <efiip.h>
 | 
						|
 | 
						|
#if defined(__x86_64__) && !defined(HAVE_USE_MS_ABI)
 | 
						|
#error something has gone wrong with the gnu-efi includes and defines
 | 
						|
#endif
 | 
						|
#endif
 | 
						|
 | 
						|
#ifdef SHIM_UNIT_TEST
 | 
						|
#include "include/test.h"
 | 
						|
#endif
 | 
						|
 | 
						|
#ifdef __x86_64__
 | 
						|
#ifndef DEFAULT_LOADER
 | 
						|
#define DEFAULT_LOADER L"\\grubx64.efi"
 | 
						|
#endif
 | 
						|
#ifndef DEFAULT_LOADER_CHAR
 | 
						|
#define DEFAULT_LOADER_CHAR "\\grubx64.efi"
 | 
						|
#endif
 | 
						|
#ifndef EFI_ARCH
 | 
						|
#define EFI_ARCH L"x64"
 | 
						|
#endif
 | 
						|
#ifndef DEBUGDIR
 | 
						|
#define DEBUGDIR L"/usr/lib/debug/usr/share/shim/x64/"
 | 
						|
#endif
 | 
						|
#endif
 | 
						|
 | 
						|
#if defined(__i686__) || defined(__i386__)
 | 
						|
#ifndef DEFAULT_LOADER
 | 
						|
#define DEFAULT_LOADER L"\\grubia32.efi"
 | 
						|
#endif
 | 
						|
#ifndef DEFAULT_LOADER_CHAR
 | 
						|
#define DEFAULT_LOADER_CHAR "\\grubia32.efi"
 | 
						|
#endif
 | 
						|
#ifndef EFI_ARCH
 | 
						|
#define EFI_ARCH L"ia32"
 | 
						|
#endif
 | 
						|
#ifndef DEBUGDIR
 | 
						|
#define DEBUGDIR L"/usr/lib/debug/usr/share/shim/ia32/"
 | 
						|
#endif
 | 
						|
#endif
 | 
						|
 | 
						|
#if defined(__aarch64__)
 | 
						|
#ifndef DEFAULT_LOADER
 | 
						|
#define DEFAULT_LOADER L"\\grubaa64.efi"
 | 
						|
#endif
 | 
						|
#ifndef DEFAULT_LOADER_CHAR
 | 
						|
#define DEFAULT_LOADER_CHAR "\\grubaa64.efi"
 | 
						|
#endif
 | 
						|
#ifndef EFI_ARCH
 | 
						|
#define EFI_ARCH L"aa64"
 | 
						|
#endif
 | 
						|
#ifndef DEBUGDIR
 | 
						|
#define DEBUGDIR L"/usr/lib/debug/usr/share/shim/aa64/"
 | 
						|
#endif
 | 
						|
#endif
 | 
						|
 | 
						|
#if defined(__arm__)
 | 
						|
#ifndef DEFAULT_LOADER
 | 
						|
#define DEFAULT_LOADER L"\\grubarm.efi"
 | 
						|
#endif
 | 
						|
#ifndef DEFAULT_LOADER_CHAR
 | 
						|
#define DEFAULT_LOADER_CHAR "\\grubarm.efi"
 | 
						|
#endif
 | 
						|
#ifndef EFI_ARCH
 | 
						|
#define EFI_ARCH L"arm"
 | 
						|
#endif
 | 
						|
#ifndef DEBUGDIR
 | 
						|
#define DEBUGDIR L"/usr/lib/debug/usr/share/shim/arm/"
 | 
						|
#endif
 | 
						|
#endif
 | 
						|
 | 
						|
#ifndef DEBUGSRC
 | 
						|
#define DEBUGSRC L"/usr/src/debug/shim-" VERSIONSTR "." EFI_ARCH
 | 
						|
#endif
 | 
						|
 | 
						|
#define FALLBACK L"\\fb" EFI_ARCH L".efi"
 | 
						|
#define MOK_MANAGER L"\\mm" EFI_ARCH L".efi"
 | 
						|
 | 
						|
#if defined(VENDOR_DB_FILE)
 | 
						|
# define vendor_authorized vendor_db
 | 
						|
# define vendor_authorized_size vendor_db_size
 | 
						|
# define vendor_authorized_category VENDOR_ADDEND_DB
 | 
						|
#elif defined(VENDOR_CERT_FILE)
 | 
						|
# define vendor_authorized vendor_cert
 | 
						|
# define vendor_authorized_size vendor_cert_size
 | 
						|
# define vendor_authorized_category VENDOR_ADDEND_X509
 | 
						|
#else
 | 
						|
# define vendor_authorized vendor_null
 | 
						|
# define vendor_authorized_size vendor_null_size
 | 
						|
# define vendor_authorized_category VENDOR_ADDEND_NONE
 | 
						|
#endif
 | 
						|
 | 
						|
#if defined(VENDOR_DBX_FILE)
 | 
						|
# define vendor_deauthorized vendor_dbx
 | 
						|
# define vendor_deauthorized_size vendor_dbx_size
 | 
						|
#else
 | 
						|
# define vendor_deauthorized vendor_deauthorized_null
 | 
						|
# define vendor_deauthorized_size vendor_deauthorized_null_size
 | 
						|
#endif
 | 
						|
 | 
						|
#include "include/asm.h"
 | 
						|
#include "include/compiler.h"
 | 
						|
#include "include/list.h"
 | 
						|
#include "include/configtable.h"
 | 
						|
#include "include/console.h"
 | 
						|
#include "include/crypt_blowfish.h"
 | 
						|
#include "include/efiauthenticated.h"
 | 
						|
#include "include/errors.h"
 | 
						|
#include "include/execute.h"
 | 
						|
#include "include/guid.h"
 | 
						|
#include "include/http.h"
 | 
						|
#include "include/httpboot.h"
 | 
						|
#include "include/ip4config2.h"
 | 
						|
#include "include/ip6config.h"
 | 
						|
#include "include/load-options.h"
 | 
						|
#include "include/mok.h"
 | 
						|
#include "include/netboot.h"
 | 
						|
#include "include/passwordcrypt.h"
 | 
						|
#include "include/peimage.h"
 | 
						|
#include "include/pe.h"
 | 
						|
#include "include/replacements.h"
 | 
						|
#include "include/sbat.h"
 | 
						|
#include "include/sbat_var_defs.h"
 | 
						|
#include "include/ssp.h"
 | 
						|
#if defined(OVERRIDE_SECURITY_POLICY)
 | 
						|
#include "include/security_policy.h"
 | 
						|
#endif
 | 
						|
#include "include/simple_file.h"
 | 
						|
#include "include/str.h"
 | 
						|
#include "include/tpm.h"
 | 
						|
#include "include/cc.h"
 | 
						|
#include "include/ucs2.h"
 | 
						|
#include "include/variables.h"
 | 
						|
#include "include/hexdump.h"
 | 
						|
 | 
						|
#include "version.h"
 | 
						|
 | 
						|
#ifndef SHIM_UNIT_TEST
 | 
						|
#include "Cryptlib/Include/OpenSslSupport.h"
 | 
						|
#endif
 | 
						|
 | 
						|
#define MEM_ATTR_R	4
 | 
						|
#define MEM_ATTR_W	2
 | 
						|
#define MEM_ATTR_X	1
 | 
						|
 | 
						|
INTERFACE_DECL(_SHIM_LOCK);
 | 
						|
 | 
						|
typedef
 | 
						|
EFI_STATUS
 | 
						|
(*EFI_SHIM_LOCK_VERIFY) (
 | 
						|
	IN VOID *buffer,
 | 
						|
	IN UINT32 size
 | 
						|
	);
 | 
						|
 | 
						|
typedef
 | 
						|
EFI_STATUS
 | 
						|
(*EFI_SHIM_LOCK_HASH) (
 | 
						|
	IN char *data,
 | 
						|
	IN int datasize,
 | 
						|
	PE_COFF_LOADER_IMAGE_CONTEXT *context,
 | 
						|
	UINT8 *sha256hash,
 | 
						|
	UINT8 *sha1hash
 | 
						|
	);
 | 
						|
 | 
						|
typedef
 | 
						|
EFI_STATUS
 | 
						|
(*EFI_SHIM_LOCK_CONTEXT) (
 | 
						|
	IN VOID *data,
 | 
						|
	IN unsigned int datasize,
 | 
						|
	PE_COFF_LOADER_IMAGE_CONTEXT *context
 | 
						|
	);
 | 
						|
 | 
						|
typedef struct _SHIM_LOCK {
 | 
						|
	EFI_SHIM_LOCK_VERIFY Verify;
 | 
						|
	EFI_SHIM_LOCK_HASH Hash;
 | 
						|
	EFI_SHIM_LOCK_CONTEXT Context;
 | 
						|
} SHIM_LOCK;
 | 
						|
 | 
						|
extern EFI_STATUS shim_init(void);
 | 
						|
extern void shim_fini(void);
 | 
						|
extern EFI_STATUS EFIAPI LogError_(const char *file, int line, const char *func,
 | 
						|
                                   const CHAR16 *fmt, ...);
 | 
						|
extern EFI_STATUS EFIAPI VLogError(const char *file, int line, const char *func,
 | 
						|
                                   const CHAR16 *fmt, ms_va_list args);
 | 
						|
extern VOID LogHexdump_(const char *file, int line, const char *func,
 | 
						|
                        const void *data, size_t sz);
 | 
						|
extern VOID PrintErrors(VOID);
 | 
						|
extern VOID ClearErrors(VOID);
 | 
						|
extern VOID restore_loaded_image(VOID);
 | 
						|
extern EFI_STATUS start_image(EFI_HANDLE image_handle, CHAR16 *ImagePath);
 | 
						|
extern EFI_STATUS import_mok_state(EFI_HANDLE image_handle);
 | 
						|
 | 
						|
extern UINT32 vendor_authorized_size;
 | 
						|
extern UINT8 *vendor_authorized;
 | 
						|
 | 
						|
extern UINT32 vendor_deauthorized_size;
 | 
						|
extern UINT8 *vendor_deauthorized;
 | 
						|
 | 
						|
extern UINT32 user_cert_size;
 | 
						|
extern UINT8 *user_cert;
 | 
						|
 | 
						|
#if defined(ENABLE_SHIM_CERT)
 | 
						|
extern UINT32 build_cert_size;
 | 
						|
extern UINT8 *build_cert;
 | 
						|
#endif /* defined(ENABLE_SHIM_CERT) */
 | 
						|
 | 
						|
extern UINT8 user_insecure_mode;
 | 
						|
extern UINT8 ignore_db;
 | 
						|
extern UINT8 trust_mok_list;
 | 
						|
extern UINT8 mok_policy;
 | 
						|
 | 
						|
extern UINT8 in_protocol;
 | 
						|
extern void *load_options;
 | 
						|
extern UINT32 load_options_size;
 | 
						|
 | 
						|
BOOLEAN secure_mode (void);
 | 
						|
 | 
						|
EFI_STATUS
 | 
						|
verify_buffer (char *data, int datasize,
 | 
						|
	       PE_COFF_LOADER_IMAGE_CONTEXT *context,
 | 
						|
	       UINT8 *sha256hash, UINT8 *sha1hash);
 | 
						|
 | 
						|
#ifndef SHIM_UNIT_TEST
 | 
						|
#define perror_(file, line, func, fmt, ...) ({					\
 | 
						|
		UINTN __perror_ret = 0;						\
 | 
						|
		_Static_assert((fmt) != NULL,					\
 | 
						|
			       "format specifier cannot be NULL");		\
 | 
						|
		if (!in_protocol)						\
 | 
						|
			__perror_ret = console_print((fmt), ##__VA_ARGS__);	\
 | 
						|
		LogError_(file, line, func, fmt, ##__VA_ARGS__);		\
 | 
						|
		__perror_ret;							\
 | 
						|
	})
 | 
						|
#define perror(fmt, ...) ({							\
 | 
						|
		_Static_assert((fmt) != NULL,					\
 | 
						|
			       "format specifier cannot be NULL");		\
 | 
						|
		perror_(__FILE__, __LINE__ - 1, __func__, fmt, ##__VA_ARGS__);	\
 | 
						|
	})
 | 
						|
#define LogError(fmt, ...) ({							\
 | 
						|
		_Static_assert((fmt) != NULL,					\
 | 
						|
			       "format specifier cannot be NULL");		\
 | 
						|
		LogError_(__FILE__, __LINE__ - 1, __func__, fmt, ##__VA_ARGS__);\
 | 
						|
	})
 | 
						|
#else
 | 
						|
#define perror(fmt, ...) ({							\
 | 
						|
		_Static_assert((fmt) != NULL,					\
 | 
						|
			       "format specifier cannot be NULL");		\
 | 
						|
	})
 | 
						|
#define LogError(fmt, ...) ({							\
 | 
						|
		_Static_assert((fmt) != NULL,					\
 | 
						|
			       "format specifier cannot be NULL");		\
 | 
						|
	})
 | 
						|
#endif
 | 
						|
 | 
						|
#ifdef ENABLE_SHIM_DEVEL
 | 
						|
#define FALLBACK_VERBOSE_VAR_NAME L"FALLBACK_DEVEL_VERBOSE"
 | 
						|
#define VERBOSE_VAR_NAME L"SHIM_DEVEL_VERBOSE"
 | 
						|
#define DEBUG_VAR_NAME L"SHIM_DEVEL_DEBUG"
 | 
						|
#else
 | 
						|
#define FALLBACK_VERBOSE_VAR_NAME L"FALLBACK_VERBOSE"
 | 
						|
#define VERBOSE_VAR_NAME L"SHIM_VERBOSE"
 | 
						|
#define DEBUG_VAR_NAME L"SHIM_DEBUG"
 | 
						|
#endif
 | 
						|
 | 
						|
#define SHIM_RETAIN_PROTOCOL_VAR_NAME L"ShimRetainProtocol"
 | 
						|
 | 
						|
char *translate_slashes(char *out, const char *str);
 | 
						|
 | 
						|
#endif /* SHIM_H_ */
 |