Build Environment

All Platforms

• git
  • macOS: installed with Xcode
  • Windows: https://git-scm.com/download/win
• doxygen latest from http://www.doxygen.org

macOS System Extensions

• enable system extension debugging https://developer.apple.com/documentation/driverkit/debugging_and_testing_system_extensions
  • boot into system recovery https://support.apple.com/en-gb/guide/mac-help/mchl82829c17/mac
  • disable System Integrity Protection https://khronokernel.com/macos/2022/12/09/SIP.html

    csrutil disable

  • reboot into macOS and enable dext debugging

    systemextensionsctl developer on

  • list installed system extensions

    systemextensionsctl list

IOKit Kernel Extension Framework

• 10.7 for 32bit and 64bit Intel kernels and any later for 64bit Intel kernels only
• Latest XCode
  • 7.3 disables earlier SDKs to re-enable earlier SDKs:
    • install Xcode, run and quit. Now Xcode.app can be modified:
    • edit MinimumSDKVersion key value in /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Info.plist

      sudo plutil -replace MinimumSDKVersion -string "10.6" /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Info.plist

• USB device kext matching: https://developer.apple.com/library/content/qa/qa1076/_index.html
• Kernel Debug Kit according to the OS of the driver test https://developer.apple.com/download/more/
• further information about isolating kernel panics: http://developer.apple.com/mac/library/technotes/tn2002/tn2063.html#TNTAG5
• debugging information: https://developer.apple.com/library/mac/#documentation/Darwin/Conceptual/KEXTConcept/KEXTConceptDebugger/debug_tutorial.html
• finding Info.plist kext dependencies:

  kextlibs -xml MyDriver.kext

• working with unsigned kexts with 10.9+

  sudo nvram boot-args="kext-dev-mode=1"

• disable System Integrity Protection (for debugging)
  • reboot to the Recovery System by restarting your Mac and hold down the Command and R keys at startup.
  • from the Utilities menu, select “Terminal”.
  • type, “csrutil disable” to disable System Integrity Protection, “csrutil enable” to reenable System Integrity Protection.
  • restart your Mac.
• allowing ptr display from kernel log in 10.11 - 10.11.2

  sudo nvram boot-args="-show_pointers"

  }
• 10.12+ unified logging

  log show|stream --predicate 'senderImagePath contains "$PRODUCT_NAME"'

• notarization https://eclecticlight.co/2019/05/31/can-you-tell-whether-code-has-been-notarized

WDK - Windows Driver Framework

• latest Windows
• latest WDK + Visual Studio
• WixToolset Windows XML Installer framework 4 - latest Version with DifxApp support -
  
  • https://wixtoolset.org

    #install wixtoolset
    dotnet tool install --global wix --version 4.0.6.0

  • HeatWave for Visual Studio https://marketplace.visualstudio.com/search?term=HeatWave&target=VS&category=Tools&vsVersion=&subCategory=Coding&sortBy=Relevance
    Additional information about the log file created during Windows SetupAPI installation http://download.microsoft.com/download/e/b/a/eba1050f-a31d-436b-9281-92cdfeae4b45/SetupAPILog.doc
• signing certificate
  
  • get a code signing certificate
  • deprecated: install MS cross signed certificate in [WDK root]\CrossCertificates:
    • http://msdn.microsoft.com/en-us/library/windows/hardware/hh967734(v=vs.85).aspx
    • signtool.exe does not seem to be able to find the cross signing certificates by itself from the Windows cert stores. Instead the WDK comes with a pre-selected choice of the obove certifcates "installed" @

      Program Files (x86)/Windows Kits/10/CrossCertificates

      Instead of explicitly selecting your cross certifiacte by filename as a command line option to signtool.exe you may consider adding your specific cross signing certificate to this path and therefor preparing the machine to find the correct certifacte for kernel code signing.
  • deprecated: allow cross signed drivers @ Windows 10

    [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\CI\Policy]
    "UpgradedSystem"=dword:00000001

  • display your installed signing certificate(s)
    

    certutil -store -user My

  • install your signing certificate .pfx (.p12) with double click or
    

    certutil -user -p CertificatePassword -importPFX .pfx/.p12

  • install your signing certificate under the ssh user (login via ssh)

    certutil -p CertificatePassword -importPFX .pfx/.p12

    ... reboot(!)

    certutil -repairstore "My" *

    ... doesn't seem to help here anymore - so reboot
• latest VS2019
  
• disable UAC

  HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System\EnableLUA = 0

  
  
  
• Debug View is helpful http://technet.microsoft.com/en-us/sysinternals/bb896647.aspx
• further hints: http://www.osronline.com/article.cfm?article=496 and http://windbg.info/download/doc/pdf/WinDbg_A_to_Z_bw2.pdf
• enable driver installation over a network mapping: open command prompt as administrator

  net use drive: \\server\path

  
  
  
• to be able to remove driver entries add

  devmgr_show_nonpresent_devices=1

• fine list of devcon scripts to cleanup installation mess http://www.robvanderwoude.com/devcon.php

Two machine kernel debug setup

• enable debugging on Target:

  bcdedit /debug on

• translation of user mode and kernel error error codes http://www.x86code.com/ntstatus.txt

Build server

• ssh server https://learn.microsoft.com/en-us/windows-server/administration/openssh/openssh_keymanagement On the (virtual) machine, open an administrative PowerShell and run

  # Install OpenSSH
  Add-WindowsCapability -Online -Name OpenSSH.Server
  # Set the sshd service to be started automatically.
  Get-Service -Name sshd | Set-Service -StartupType Automatic -PassThru
  # Start the sshd service.
  Start-Service sshd
  # Load your key files into ssh-agent.
  ssh-add $env:USERPROFILE\.ssh\id_ecdsa
  # Copy the public key file generated previously on your client to the authorized_keys file on your server.
  Copy-Item $env:USERPROFILE\.ssh\id_ecdsa.pub $env:ProgramData\ssh\administrators_authorized_keys
  # fix ACLs
  Icacls.exe $env:ProgramData\ssh\administrators_authorized_keys /inheritance:r /grant Administrators:F /grant SYSTEM:F

• install your signing certs under the service "user" - Windows has no strict user concept

tools

• Prime95 - to place load on all CPU cores - https://www.mersenne.org/download

CoreAudio client device

CoreAudio client device

CoreAudio server plugin driver

• Installation

  /Library/Audio/Plug-Ins/HAL

• stop CoreAudio server

  sudo launchctl stop com.apple.audio.coreaudiod

• start CoreAudio server

  sudo launchctl load com.apple.audio.coreaudiod

• debug CoreAudio Daemon by attaching to /usr/sbin/coreaudiod as root and wait for executable to be launched
• restart CoreAudio server

  sudo launchctl stop com.apple.audio.coreaudiod && launchctl start com.apple.audio.coreaudiod

CoreMIDI server plugin driver interface

CoreMIDI client driver

CoreMIDI server plugin driver interface

CoreMIDI server plugin

• Installation

  ~/Library/Audio/MIDI Drivers
  /Library/Audio/MIDI Drivers