Merged PR 10493895: Add Windows user mode module

This change adds a new Windows user-mode module, symcrypt.dll. We plan to integrate this module into a future release of Windows as our primary FIPS-certified cryptographic module. Until that happens, we're making the module publicly available for the convenience of other projects that build on top of SymCrypt, such as our [rust-symcrypt crate](https://github.com/microsoft/rust-symcrypt).

Tested: dynamic unit tests run locally against the new module, ADO pipeline CI tests

Author: mlindgren

.pipelines/OneBranch.WindowsUndocked.Official.yml

@@ -25,7 +25,7 @@ trigger:
     - publish
 
 schedules:
-- cron: "0 8 * * *" # Daily at 1am UTC (midnight PST/1am PDT)
+- cron: "0 8 * * *" # Daily at 8am UTC (midnight PST/1am PDT)
   displayName: Daily build
   branches:
     include:
@@ -80,12 +80,13 @@ extends:
       - template: .pipelines/templates/build-windows-undocked.yml@self
         parameters:
           sln: symcrypt.sln
-          buildSuffix: '-official'
+          buildType: 'official'
           # Package args
           package: ${{ parameters.package }}
           name: 'SymCrypt'
           description: 'SymCrypt cryptographic library'
           owner: '[email protected]'
+          sign: true
           # Windows ingestion args
           # ingest: ${{ parameters.ingest }}
           # osPath: 'onecore/ds/security/symcrypt'

.pipelines/OneBranch.WindowsUndocked.PullRequest.yml

@@ -46,4 +46,4 @@ extends:
       - template: .pipelines/templates/build-windows-undocked.yml@self
         parameters:
           sln: SymCrypt.sln
-          buildSuffix: '-pr'
+          buildType: 'pr'

.pipelines/templates/build-windows-undocked.yml

@@ -8,7 +8,7 @@ parameters:
   config: 'Debug,Release'
   platform: 'x86,x64,arm64'
   nativeCompiler: true
-  buildSuffix: '-private'
+  buildType: 'private'
   sign: false # Only signs UM binaries, for external (to Windows repo) release
   # Packaging args
   package: false
@@ -127,7 +127,7 @@ jobs:
       configuration: $(ob_build_config)
       maximumCpuCount: true
       restoreNugetPackages: ${{ parameters.restoreNugetPackages }}
-      msbuildArgs: '-p:UndockedOfficial=${{ parameters.nativeCompiler }} -p:UndockedBuildId=$(Build.BuildId) -p:VER_BUILD_ID=$(Build.BuildId) -p:VER_SUFFIX=${{ parameters.buildSuffix }} -p:SymCryptTestLegacyImpl=true ${{ parameters.msbuildArgs }}'
+      msbuildArgs: '-p:UndockedOfficial=${{ parameters.nativeCompiler }} -p:UndockedBuildId=$(Build.BuildId) -p:VER_BUILD_ID=$(Build.BuildId) -p:VER_SUFFIX=${{ parameters.buildType }} -p:SymCryptTestLegacyImpl=true ${{ parameters.msbuildArgs }}'
 
   # Overwrite default artifact publishing with our copy (enables publishing binaries for failed runs)
   - task: PowerShell@2
@@ -148,14 +148,23 @@ jobs:
       workingDirectory: $(Build.SourcesDirectory)
 
   - task: PythonScript@0
-    displayName: 'Run dynamic unit tests'
+    displayName: 'Run dynamic unit tests (test module)'
     condition: or(eq(variables['ob_build_platform'], 'x64'), eq(variables['ob_build_platform'], 'x86'))
     inputs:
       scriptSource: 'filePath'
       scriptPath: scripts\test.py
       arguments: 'build\bin dynamic:build\bin\$(ob_build_platform_win)$(ob_build_config_win)\dll\symcrypttestmodule.dll noperftests'
       workingDirectory: $(Build.SourcesDirectory)
 
+  - task: PythonScript@0
+    displayName: 'Run dynamic unit tests (prod module)'
+    condition: and(eq('${{ parameters.buildType }}', 'official'), or(eq(variables['ob_build_platform'], 'x64'), eq(variables['ob_build_platform'], 'x86')))
+    inputs:
+      scriptSource: 'filePath'
+      scriptPath: scripts\test.py
+      arguments: 'build\bin dynamic:build\bin\$(ob_build_platform_win)$(ob_build_config_win)\dll\symcrypt.dll noperftests'
+      workingDirectory: $(Build.SourcesDirectory)
+
   - task: onebranch.pipeline.signing@1 # https://aka.ms/obpipelines/signing
     displayName: 'Sign Binaries'
     condition: eq('${{ parameters.sign }}', true)

CHANGELOG.md

@@ -3,12 +3,16 @@
 New changes will be listed here as they are developed. The version number is determined
 prior to the creation of a new release, based on the changes contained in that release.
 
+# Version 103.4.2
+
 - Add SymCryptEntropyAccumulator to Windows kernel module
 - Fix tweak lower 64 bit overflow calculation in SYMCRYPT_XtsAesXxx
 - Add OpenSSL implementation for XtsAes to symcryptunittest
+- Add Windows user mode DLL
 
 # Version 103.4.1
 - Add retpoline guard flags for undocked Windows build
+- Add Windows kernel mode DLL
 - Support ARM32 for Linux
 
 # Version 103.4.0

SymCrypt.sln

@@ -3,34 +3,39 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.4.33213.308
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "symcrypt", "lib\symcrypt.vcxproj", "{7C3BD5D2-7213-4CFA-B6CB-EB41623601BC}"
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "symcrypt.lib", "lib\symcrypt.vcxproj", "{7C3BD5D2-7213-4CFA-B6CB-EB41623601BC}"
 EndProject
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "symcryptunittest_lib", "unittest\lib\symcryptunittest_lib.vcxproj", "{1146804C-B04F-43F1-83B0-081A5187BA02}"
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "symcryptunittest.lib", "unittest\lib\symcryptunittest_lib.vcxproj", "{1146804C-B04F-43F1-83B0-081A5187BA02}"
 EndProject
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "symcryptunittest", "unittest\exe_test\symcryptunittest.vcxproj", "{1651C608-DD2F-4D18-8E5B-E3C1D11BD7B9}"
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "symcryptunittest.exe", "unittest\exe_test\symcryptunittest.vcxproj", "{1651C608-DD2F-4D18-8E5B-E3C1D11BD7B9}"
 	ProjectSection(ProjectDependencies) = postProject
 		{1146804C-B04F-43F1-83B0-081A5187BA02} = {1146804C-B04F-43F1-83B0-081A5187BA02}
 		{7C3BD5D2-7213-4CFA-B6CB-EB41623601BC} = {7C3BD5D2-7213-4CFA-B6CB-EB41623601BC}
 	EndProjectSection
 EndProject
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "symcrypttestmodule", "unittest\module_windows\symcrypttestmodule.vcxproj", "{E5919189-A4AF-40C4-81CB-A3685485276E}"
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "symcrypttestmodule.dll", "unittest\module_windows\symcrypttestmodule.vcxproj", "{E5919189-A4AF-40C4-81CB-A3685485276E}"
 	ProjectSection(ProjectDependencies) = postProject
 		{1146804C-B04F-43F1-83B0-081A5187BA02} = {1146804C-B04F-43F1-83B0-081A5187BA02}
 		{7C3BD5D2-7213-4CFA-B6CB-EB41623601BC} = {7C3BD5D2-7213-4CFA-B6CB-EB41623601BC}
 	EndProjectSection
 EndProject
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "SymCryptKernelTestModule", "unittest\module_windows_sys_km\SymCryptKernelTestModule.vcxproj", "{0C2652ED-2CCD-4FAF-910B-74FB90E0C31C}"
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "SymCryptKernelTestModule.sys", "unittest\module_windows_sys_km\SymCryptKernelTestModule.vcxproj", "{0C2652ED-2CCD-4FAF-910B-74FB90E0C31C}"
 	ProjectSection(ProjectDependencies) = postProject
 		{1146804C-B04F-43F1-83B0-081A5187BA02} = {1146804C-B04F-43F1-83B0-081A5187BA02}
 		{7C3BD5D2-7213-4CFA-B6CB-EB41623601BC} = {7C3BD5D2-7213-4CFA-B6CB-EB41623601BC}
 	EndProjectSection
 EndProject
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "SymCryptKernelTestModule_UM", "unittest\module_windows_sys_um\SymCryptKernelTestModule_UM.vcxproj", "{07DBF66B-64EA-4D2C-9182-9C6E2D89C7DB}"
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "SymCryptKernelTestModule.dll", "unittest\module_windows_sys_um\SymCryptKernelTestModule_UM.vcxproj", "{07DBF66B-64EA-4D2C-9182-9C6E2D89C7DB}"
 	ProjectSection(ProjectDependencies) = postProject
 		{7C3BD5D2-7213-4CFA-B6CB-EB41623601BC} = {7C3BD5D2-7213-4CFA-B6CB-EB41623601BC}
 	EndProjectSection
 EndProject
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "symcryptk", "modules\windows\kernel\symcryptk.vcxproj", "{5A666AF4-35C9-42FE-817D-9D9A07AAF253}"
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "symcryptk.dll", "modules\windows\kernel\symcryptk.vcxproj", "{5A666AF4-35C9-42FE-817D-9D9A07AAF253}"
+	ProjectSection(ProjectDependencies) = postProject
+		{7C3BD5D2-7213-4CFA-B6CB-EB41623601BC} = {7C3BD5D2-7213-4CFA-B6CB-EB41623601BC}
+	EndProjectSection
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "symcrypt.dll", "modules\windows\user\symcrypt.vcxproj", "{c75bcb09-00b2-4008-9700-e3b5e7391c69}"
 	ProjectSection(ProjectDependencies) = postProject
 		{7C3BD5D2-7213-4CFA-B6CB-EB41623601BC} = {7C3BD5D2-7213-4CFA-B6CB-EB41623601BC}
 	EndProjectSection
@@ -212,6 +217,31 @@ Global
 
 		{5A666AF4-35C9-42FE-817D-9D9A07AAF253}.Release|x86.ActiveCfg = Release|Win32
 
+		# symcrypt.dll
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Debug|ARM64.ActiveCfg = Debug|ARM64
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Debug|ARM64.Build.0 = Debug|ARM64
+
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Debug|ARM64EC.ActiveCfg = Debug|ARM64EC
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Debug|ARM64EC.Build.0 = Debug|ARM64EC
+
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Debug|x64.ActiveCfg = Debug|x64
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Debug|x64.Build.0 = Debug|x64
+
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Debug|x86.ActiveCfg = Debug|Win32
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Debug|x86.Build.0 = Debug|Win32
+
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Release|ARM64.ActiveCfg = Release|ARM64
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Release|ARM64.Build.0 = Release|ARM64
+
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Release|ARM64EC.ActiveCfg = Release|ARM64EC
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Release|ARM64EC.Build.0 = Release|ARM64EC
+
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Release|x64.ActiveCfg = Release|x64
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Release|x64.Build.0 = Release|x64
+
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Release|x86.ActiveCfg = Release|Win32
+		{c75bcb09-00b2-4008-9700-e3b5e7391c69}.Release|x86.Build.0 = Release|Win32
+
 
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution

SymCryptPackage.json

@@ -87,6 +87,16 @@
         "dest" : "lib/symcrypt.lib",
         "platform" : "win32"
     },
+    {
+        "source" : "${BIN_DIR}/dll/symcrypt.dll",
+        "dest" : "dll/symcrypt.dll",
+        "platform" : "win32"
+    },
+    {
+        "source" : "${BIN_DIR}/dll/symcrypt.lib",
+        "dest" : "dll/symcrypt.lib",
+        "platform" : "win32"
+    },
     {
         "source" : "${BIN_DIR}/kmdll/symcryptk.dll",
         "dest" : "dll/symcryptk.dll",
@@ -121,6 +131,11 @@
         "dest" : "test/symcryptunittest.exe",
         "platform" : "win32"
     },
+    {
+        "source" : "${BIN_DIR}/dll/symcrypt.pdb",
+        "dest" : "dll/symcrypt.pdb",
+        "platform" : "win32"
+    },
     {
         "source" : "${BIN_DIR}/kmdll/symcryptk.pdb",
         "dest" : "dll/symcryptk.pdb",

inc/symcrypt.h

@@ -5605,7 +5605,7 @@ SymCryptRngAesFips140_2Uninstantiate(
 // Internal RNG functions
 //
 // To satisfy FIPS 140-3 and SP 800-90B, certain modules of SymCrypt may set up internal
-// RNG state(s) to keep random bit generation behind the module security boundary.
+// RNG state(s) to keep random bit generation behind the module's FIPS boundary.
 // These functions allow the caller to get random bits and provide entropy, respectively,
 // to SymCrypt's internal RNG state(s).
 // Implementation is module dependent, and these functions may not be defined

inc/symcrypt.rc.inc

@@ -15,7 +15,7 @@
 #endif
 
 #ifndef VER_SUFFIX
-#define VER_SUFFIX -private
+#define VER_SUFFIX private
 #endif
 
 //
@@ -33,7 +33,7 @@
 #define VER_FILEVERSION             VER_MAJOR,VER_MINOR,VER_PATCH,0
 #define VER_FILEVERSION_STR         STR(VER_MAJOR) "." STR(VER_MINOR) "." STR(VER_PATCH) "." STR(VER_BUILD_ID) "\0"
 
-#define VER_PRODUCTVERSION_STR      STR(VER_MAJOR) "." STR(VER_MINOR) "." STR(VER_PATCH) "." STR(VER_BUILD_ID) STR(VER_SUFFIX) "\0"
+#define VER_PRODUCTVERSION_STR      STR(VER_MAJOR) "." STR(VER_MINOR) "." STR(VER_PATCH) "." STR(VER_BUILD_ID) "-" STR(VER_SUFFIX) "\0"
 
 VS_VERSION_INFO                     VERSIONINFO
 FILEVERSION                         VER_FILEVERSION

inc/symcrypt_internal_shared.inc

@@ -24,7 +24,7 @@
 
 #define SYMCRYPT_CODE_VERSION_API       103
 #define SYMCRYPT_CODE_VERSION_MINOR     4
-#define SYMCRYPT_CODE_VERSION_PATCH     1
+#define SYMCRYPT_CODE_VERSION_PATCH     2
 
 #if defined(DBG)
 #define SYMCRYPT_DEBUG 1

modules/CMakeLists.txt

@@ -4,8 +4,6 @@ if(NOT WIN32 AND NOT CMAKE_BUILD_TYPE MATCHES Sanitize)
     add_subdirectory(linux)
 endif()
 
-# Placeholder: CMake can't build Windows kernel drivers, and we don't currently have a
-# Windows user-mode DLL
-# if(WIN32)
-#     add_subdirectory(windows)
-# endif()
+if(WIN32)
+    add_subdirectory(windows)
+endif()