VeraCrypt

Документация >> Технические подробности >> Сборка VeraCrypt из исходного кода >> Руководство по сборке в Windows

В этом руководстве описано, как настроить систему Windows для компилирования VeraCrypt и как cкомпилировать программу.
Здесь как пример приведена процедура для Windows 10/11, процедуры для других версий Windows аналогичны.
Для компиляции текущих двоичных файлов VeraCrypt для Windows и драйверов необходимы следующие компоненты; необязательные альтернативы или инструменты, нужные только для выпуска, отмечены отдельно:
  1. Microsoft Visual Studio 2022 или Build Tools for Visual Studio 2022 как альтернатива для командной строки
  2. Набор инструментов MSVC v143 C++ с компонентами x86/x64 и ARM64
  3. Windows 10/11 SDK (10.0.19041.0 или новее), включая signtool.exe для скриптов подписи. Если SDK и WDK устанавливаются отдельно, используйте совпадающие номера сборок.
  4. Windows Driver Kit для Windows 10/11 с расширением Visual Studio 2022
  5. NASM
  6. YASM
  7. WiX Toolset v3.x (требуется для MSI-пакетов)
  8. Инструменты устаревшего загрузчика BIOS (необязательно; требуются только при пересборке проекта Boot): Microsoft Visual C++ 1.52, gzip, UPX и dd.exe
Ниже приведены шаги процедуры. Нажав на любую ссылку, вы сразу перейдёте к соответствующему шагу:
Установка NASM

  1. Загрузите установщик актуальной версии NASM (например, "nasm-2.16.03-installer-x64.exe") отсюда:
    https://www.nasm.us/pub/nasm/releasebuilds/
    Подходят актуальные версии NASM; для проверенных в этом руководстве сборок приложений Windows использовался NASM 2.16.03.
  2. Запустите файл от имени администратора.
  3. Установите NASM с настройками по умолчанию.
  4. Добавьте путь к папке NASM в системную переменную PATH. Это сделает команду доступной отовсюду при вызове из командной строки.
    1. Откройте Проводник.
    2. В левой панели щёлкните правой кнопкой мыши по "Этот компьютер" и выберите "Свойства".
    3. В правой части окна щёлкните по "Дополнительные параметры системы".
    4. Нажмите кнопку "Переменные среды".
    5. В поле "Системные переменные" выберите переменную "Path" и нажмите кнопку "Изменить...".
    6. Нажмите кнопку "Создать" и добавьте папку, в которую установлен NASM, например:

      C:\Program Files\NASM

      (32-битный установщик NASM использует "C:\Program Files (x86)\nasm")
    7. Закройте окна, нажимая кнопки OK.
  5. Чтобы проверить установку, откройте новую командную строку и выполните:

    where.exe nasm
    nasm -v

    Первая команда выводит исполняемые файлы NASM, найденные в Path; вторая показывает версию, которая будет использована. Убедитесь, что команды указывают на нужную установку.

Установка YASM

  1. Создайте следующую папку:
    C:\Program Files\YASM
  2. Загрузите "yasm-1.3.0-win64.exe" из раздела Assets официальной страницы релиза:
    https://github.com/yasm/yasm/releases/tag/v1.3.0
  3. Переименуйте файл в "yasm.exe" и скопируйте его в папку "C:\Program Files\YASM".
  4. Добавьте путь к папке YASM в переменную PATH. Это сделает команду доступной отовсюду при вызове из командной строки.
    1. Откройте Проводник.
    2. В левой панели щёлкните правой кнопкой мыши по "Этот компьютер" и выберите "Свойства".
    3. В правой части окна щёлкните по "Дополнительные параметры системы".
    4. Нажмите кнопку "Переменные среды".
    5. В поле "Системные переменные" выберите переменную "Path" и нажмите кнопку "Изменить...".
    6. Нажмите кнопку "Создать" и добавьте следующее значение:

      C:\Program Files\YASM

    7. Закройте окна, нажимая кнопки OK.
  5. Чтобы проверить установку, откройте новую командную строку и выполните:

    where.exe yasm
    yasm --version

    Первая команда выводит исполняемые файлы YASM, найденные в Path; вторая должна сообщить версию YASM 1.3.0. Убедитесь, что команды указывают на нужную установку.

Установка инструментов устаревшего загрузчика BIOS (необязательно)

Эти инструменты не требуются для компиляции стандартных двоичных файлов приложения VeraCrypt или драйвера Windows с помощью Visual Studio 2022 и текущего WDK. Устанавливайте их только если нужно пересобрать устаревший загрузчик BIOS в "src\Boot\Windows" или собрать конфигурации решения, включающие проект Boot, например "ReleaseCustomEFI".

  1. Установите Microsoft Visual C++ 1.52. Он доступен по платной подписке Microsoft MSDN. Если у вас нет подписки, образ ISO также доступен в интернет-архиве:
    https://archive.org/details/ms-vc152
  2. Создайте папку "C:\MSVC15". Смонтируйте файл ISO и скопируйте содержимое папки "MSVC" в "C:\MSVC15".
  3. Создайте системную переменную "MSVC16_ROOT" со значением "C:\MSVC15".
  4. Установите gzip и добавьте папку с "gzip.exe" в переменную Path.
  5. Установите UPX и добавьте папку с "upx.exe" в переменную Path.
  6. Установите Windows-порт dd и добавьте папку с "dd.exe" в переменную Path.
  7. Откройте новую командную строку и убедитесь, что находятся следующие команды:

    nasm
    gzip
    upx
    dd --help

Установка WiX Toolset v3.x

  1. Загрузите WiX Toolset v3.x отсюда:
    https://github.com/wixtoolset/wix3/releases
  2. Запустите загруженный файл от имени администратора и установите WiX с настройками по умолчанию.

Установка Microsoft Visual Studio 2022

  1. Загрузите Visual Studio 2022 отсюда:
    https://visualstudio.microsoft.com/vs/
  2. Запустите загруженный установщик от имени администратора.
  3. Выберите рабочую нагрузку "Desktop development with C++".
  4. Выберите следующие отдельные компоненты:
    1. MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest)
    2. MSVC v143 - VS 2022 C++ x64/x86 Spectre-mitigated libs (Latest)
    3. MSVC v143 - VS 2022 C++ ARM64 build tools (Latest)
    4. MSVC v143 - VS 2022 C++ ARM64 Spectre-mitigated libs (Latest)
    5. C++ ATL for latest v143 build tools (x86 & x64)
    6. C++ ATL for latest v143 build tools (ARM64)
    7. C++ ATL for latest v143 build tools with Spectre Mitigations (x86 & x64)
    8. C++ ATL for latest v143 build tools with Spectre Mitigations (ARM64)
    9. Windows 10/11 SDK (10.0.19041.0 или новее)

Установка Windows Driver Kit

  1. Загрузите Windows Driver Kit (WDK), совместимый с Visual Studio 2022, отсюда:
    https://learn.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk
  2. Запустите загруженный файл от имени администратора и установите WDK с настройками по умолчанию.
  3. Если Windows SDK и WDK устанавливаются отдельно, убедитесь, что их номера сборок совпадают.
  4. Убедитесь, что установлено расширение WDK для Visual Studio. Если установщик WDK спрашивает, нужно ли установить расширение Windows Driver Kit Visual Studio, выберите эту опцию перед закрытием диалогового окна. В текущих установщиках Visual Studio 2022 его также можно установить через Individual Components, выбрав "Windows Driver Kit".
  5. Если автоматически запустится отдельный установщик VSIX, он определит Visual Studio 2022 как возможную цель для расширения. Выберите её и продолжите установку.

Установка Build Tools for Visual Studio 2022

Если вы установили Visual Studio 2022 с перечисленными выше компонентами, этот шаг можно пропустить. Устанавливайте Build Tools только если нужна среда сборки из командной строки без полного IDE Visual Studio.

  1. Загрузите Build Tools for Visual Studio 2022 отсюда:
    https://visualstudio.microsoft.com/downloads/
  2. Запустите загруженный установщик от имени администратора и выберите рабочую нагрузку "C++ build tools".
  3. Выберите следующие отдельные компоненты:
    1. MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest)
    2. MSVC v143 - VS 2022 C++ x64/x86 Spectre-mitigated libs (Latest)
    3. MSVC v143 - VS 2022 C++ ARM64 build tools (Latest)
    4. MSVC v143 - VS 2022 C++ ARM64 Spectre-mitigated libs (Latest)
    5. C++ ATL for latest v143 build tools (x86 & x64)
    6. C++ ATL for latest v143 build tools (ARM64)
    7. C++ ATL for latest v143 build tools with Spectre Mitigations (x86 & x64)
    8. C++ ATL for latest v143 build tools with Spectre Mitigations (ARM64)
    9. Windows 10/11 SDK (10.0.19041.0 или новее)

Загрузка исходных файлов VeraCrypt

  1. Посетите репозитарий VeraCrypt на Github:
    https://github.com/veracrypt/VeraCrypt
  2. Нажмите зелёную кнопку с надписью "Code" и скачайте код.
    Загрузить репозиторий можно в виде zip-архива, но вы, возможно, предпочтёте использовать протокол git для отслеживания изменений.

Компиляция x64-, ARM64- и драйверных сборок VeraCrypt

  1. Откройте файл "src/VeraCrypt.sln" в Visual Studio 2022.
  2. Выберите "Release|x64" как активную конфигурацию.
  3. Нажмите "Build -> Build Solution".
  4. Процесс компиляции должен завершиться с предупреждениями, но без ошибок. Некоторые проекты следует пропустить.
  5. Выберите "Release|ARM64" как активную конфигурацию.
  6. Нажмите "Build -> Build Solution".
  7. Процесс компиляции должен завершиться с предупреждениями, но без ошибок. Некоторые проекты следует пропустить.
  8. Выберите "Release|Win32" как активную конфигурацию и соберите решение, чтобы скомпилировать проекты Setup, Portable, COMReg и SetupDLL, используемые скриптами упаковки релиза. Стандартные сборки решения "Release|x64" и "Release|ARM64" пропускают эти Win32-проекты, поэтому при подготовке пакетов релиза необходима эта дополнительная сборка.
  9. Чтобы собрать драйверы VeraCrypt, выберите проект "Driver" и соберите его для "Release|x64" и "Release|ARM64".
  10. Собирайте "ReleaseCustomEFI|x64" или "ReleaseCustomEFI|ARM64" только если нужны конфигурации выпуска с пользовательским EFI/загрузчиком. Эти конфигурации включают проект Boot и требуют необязательные инструменты устаревшего загрузчика BIOS, перечисленные выше. Они также собирают проекты Setup, Portable, COMReg и SetupDLL в конфигурациях Win32.
  11. Если вы используете Build Tools for Visual Studio 2022 вместо IDE Visual Studio, откройте "Developer Command Prompt for VS 2022" или "Developer PowerShell for VS 2022", перейдите в корневой каталог исходного кода VeraCrypt и выполните эквивалентные команды MSBuild (для компиляции права администратора не требуются):
    msbuild src\VeraCrypt.sln /m /p:Configuration=Release /p:Platform=x64
    msbuild src\VeraCrypt.sln /m /p:Configuration=Release /p:Platform=ARM64
    msbuild src\VeraCrypt.sln /m /p:Configuration=Release /p:Platform=Win32
    msbuild src\Driver\Driver.vcxproj /m /p:Configuration=Release /p:Platform=x64
    msbuild src\Driver\Driver.vcxproj /m /p:Configuration=Release /p:Platform=ARM64

    Для сборки необязательных конфигураций выпуска с пользовательским EFI/загрузчиком также выполните:
    msbuild src\VeraCrypt.sln /m /p:Configuration=ReleaseCustomEFI /p:Platform=x64
    msbuild src\VeraCrypt.sln /m /p:Configuration=ReleaseCustomEFI /p:Platform=ARM64
  12. Если сборка выполнялась из IDE, закройте Visual Studio 2022 после завершения процесса компиляции.

Сборка исполняемых файлов VeraCrypt

  1. Откройте командную строку разработчика Visual Studio 2022 от имени администратора для описанной ниже процедуры подписи и упаковки. Убедитесь, что средства подписи Windows SDK, включая "signtool.exe", доступны через Path.
  2. Перейдите в папку "src/Signing/".
  3. Запустите скрипт "sign_test.bat".
  4. Сгенерированные исполняемые файлы будут в папке "src/Release/Setup Files".

Импорт сертификатов

С помощью скрипта sign_test.bat вы только что подписали исполняемые файлы VeraCrypt. Это необходимо, поскольку Windows принимает только те драйверы, которым доверяет подписанный центр сертификации.
Поскольку вы использовали не официальный сертификат подписи VeraCrypt для подписи своего кода, а общедоступную версию для разработки, вы должны импортировать и, следовательно, доверять используемым сертификатам.

  1. Откройте папку "src/Signing".
  2. Импортируйте следующие сертификаты в хранилище сертификатов локального компьютера, дважды щёлкнув по ним:
    • GlobalSign_R3Cross.cer
    • GlobalSign_SHA256_EV_CodeSigning_CA.cer
    • TestCertificate/idrix_codeSign.pfx
    • TestCertificate/idrix_Sha256CodeSign.pfx
    • TestCertificate/idrix_SHA256TestRootCA.crt
    • TestCertificate/idrix_TestRootCA.crt

Известные проблемы

  • Распространённые ошибки сборки и их причины
    Отсутствие компонентов сборки может вызывать следующие ошибки. Проверьте соответствующие пункты в приведённых выше списках компонентов:
    • error MSB8040: Spectre-mitigated libraries are required for this project

      В Visual Studio Installer на вкладке "Individual components" установите библиотеки MSVC v143 с защитой от Spectre, соответствующие версии набора инструментов и каждой целевой архитектуре (x64/x86 или ARM64), а также соответствующие компоненты ATL "with Spectre Mitigations".
    • error C1083: Cannot open include file: 'atlbase.h' (or 'atlcomcli.h')

      Компоненты ATL не установлены. В Visual Studio Installer на вкладке "Individual components" установите "C++ ATL for latest v143 build tools" (и вариант с защитой от Spectre) для каждой архитектуры, под которую выполняется сборка.
    • error MSB8066: Custom build for 'Aes_hw_cpu.asm;...' exited with code 9009

      Ассемблеры не найдены: "nasm.exe" и "yasm.exe" должны быть доступны через Path (код завершения 9009 означает "команда не найдена"). Командная строка или экземпляр Visual Studio, открытые до изменения переменной Path, не видят нового значения — откройте их заново и повторите сборку.
  • Этот дистрибутив повреждён.

    В Windows 10 или более новой версии возможно появление указанного выше сообщения об ошибке. Чтобы этого избежать, необходимо сделать следующее:
    • Перепроверьте установку корневого сертификата, выдавшего сертификат подписи тестового кода, в хранилище доверенных корневых центров сертификации локальной машины ("Local Machine Trusted Root Certification Authorities").
    • Вычислите отпечаток SHA512 сертификата подписи тестового кода и соответствующим образом обновите массив gpbSha512CodeSignCertFingerprint в файле "src/Common/Dlgcode.c".
    См. подробности тут: https://sourceforge.net/p/veracrypt/discussion/technical/thread/83d5a2d6e8/#db12.

    Другой подход – отключить проверку подписи в коде VeraCrypt. Это следует делать только в целях тестирования, но не для нормального использования:
    1. Откройте файл "src/Common/Dlgcode.c".
    2. Найдите функцию "VerifyModuleSignature".
    3. Замените следующие строки:
      Найти:

      if (!IsOSAtLeast (WIN_10))
      return TRUE;


      Заменить на:

      return TRUE;

    4. Снова скомпилируйте код VeraCrypt.
  • Ошибка сертификата.

    Windows проверяет подпись каждого устанавливаемого драйвера.
    Из соображений безопасности Windows позволяет загружать только драйверы, подписанные Microsoft.
    Поэтому при использовании пользовательской сборки:
    • Если вы не изменяли исходный код драйвера VeraCrypt, то можете использовать подписанные Microsoft драйверы, включённые в исходный код VeraCrypt (в "src\Release\Setup Files").
    • Если вы внесли изменения, то нужно будет загрузить Windows в "тестовом режиме" ("Test Mode"). Этот режим позволяет Windows загружать драйверы, не подписанные Microsoft. Однако даже в "тестовом режиме" существуют определённые требования к подписям, и сбои всё равно могут возникать по описанным ниже причинам.
    Возможные причины сбоя установки в "тестовом режиме" ("Test Mode"):
    1. Используемый для подписи сертификат не является доверенным для Windows.
      Чтобы проверить, относится ли это к вам, проверьте свойства исполняемого файла:
      1. Щёлкните правой кнопкой мыши по исполняемому файлу VeraCrypt Setup: "src/Release/Setup Files/VeraCrypt Setup 1.XX.exe".
      2. Выберите Свойства.
      3. Сверху выберите вкладку "Цифровые подписи". Здесь вы увидите две подписи.
      4. Проверьте обе, дважды щёлкая по ним. Если в заголовке написано "Подпись сертификата не может быть проверена", то соответствующий сертификат подписи не был правильно импортирован.
        Нажмите кнопку "Просмотр сертификата", а затем "Установить сертификат...", чтобы импортировать сертификат в хранилище сертификатов.

    2. Драйвер был изменён после подписания.
      В этом случае воспользуйтесь скриптом "src/Signing/sign_test.bat", чтобы снова подписать ваш код тестовыми сертификатами.