Merge pull request #46 from PowerShell/dev

Release of version 1.4.0.0 of xBitlocker
dsccommunity · Jan 9, 2019 · af3361e · af3361e
2 parents 2facc14 + ebb676e
commit af3361e
Show file tree

Hide file tree

Showing 9 changed files with 154 additions and 161 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,14 @@
 
 ## Unreleased
 
+## 1.4.0.0
+
+- Change double quoted string literals to single quotes
+- Add spaces between array members
+- Add spaces between variable types and variable names
+- Add spaces between comment hashtag and comments
+- Explicitly removed extra hidden files from release package
+
 ## 1.3.0.0
 
 - Update appveyor.yml to use the default template.

diff --git a/DSCResources/MSFT_xBLAutoBitlocker/MSFT_xBLAutoBitlocker.psm1 b/DSCResources/MSFT_xBLAutoBitlocker/MSFT_xBLAutoBitlocker.psm1
@@ -87,7 +87,7 @@ function Get-TargetResource
     param
     (
         [Parameter(Mandatory = $true)]
-        [ValidateSet("Fixed","Removable")]
+        [ValidateSet('Fixed', 'Removable')]
         [System.String]
         $DriveType,
 
@@ -96,7 +96,7 @@ function Get-TargetResource
         $MinDiskCapacityGB,
 
         [Parameter(Mandatory = $true)]
-        [ValidateSet("PasswordProtector","RecoveryPasswordProtector","StartupKeyProtector","TpmProtector")]
+        [ValidateSet('PasswordProtector', 'RecoveryPasswordProtector', 'StartupKeyProtector', 'TpmProtector')]
         [System.String]
         $PrimaryProtector,
 
@@ -113,7 +113,7 @@ function Get-TargetResource
         $AutoUnlock = $false,
 
         [Parameter()]
-        [ValidateSet("Aes128","Aes256")]
+        [ValidateSet('Aes128', 'Aes256')]
         [System.String]
         $EncryptionMethod,
 
@@ -170,7 +170,7 @@ function Get-TargetResource
         $UsedSpaceOnly
     )
 
-    #Load helper module
+    # Load helper module
     Import-Module "$((Get-Item -LiteralPath "$($PSScriptRoot)").Parent.Parent.FullName)\Misc\xBitlockerCommon.psm1" -Verbose:0
 
     Assert-HasPrereqsForBitlocker
@@ -270,7 +270,7 @@ function Set-TargetResource
     param
     (
         [Parameter(Mandatory = $true)]
-        [ValidateSet("Fixed","Removable")]
+        [ValidateSet('Fixed', 'Removable')]
         [System.String]
         $DriveType,
 
@@ -279,7 +279,7 @@ function Set-TargetResource
         $MinDiskCapacityGB,
 
         [Parameter(Mandatory = $true)]
-        [ValidateSet("PasswordProtector","RecoveryPasswordProtector","StartupKeyProtector","TpmProtector")]
+        [ValidateSet('PasswordProtector', 'RecoveryPasswordProtector', 'StartupKeyProtector', 'TpmProtector')]
         [System.String]
         $PrimaryProtector,
 
@@ -296,7 +296,7 @@ function Set-TargetResource
         $AutoUnlock = $false,
 
         [Parameter()]
-        [ValidateSet("Aes128","Aes256")]
+        [ValidateSet('Aes128', 'Aes256')]
         [System.String]
         $EncryptionMethod,
 
@@ -353,7 +353,7 @@ function Set-TargetResource
         $UsedSpaceOnly
     )
 
-    #Load helper module
+    # Load helper module
     Import-Module "$((Get-Item -LiteralPath "$($PSScriptRoot)").Parent.Parent.FullName)\Misc\xBitlockerCommon.psm1" -Verbose:0
 
     Assert-HasPrereqsForBitlocker
@@ -366,13 +366,13 @@ function Set-TargetResource
     }
     else
     {
-        Remove-FromPSBoundParametersUsingHashtable -PSBoundParametersIn $PSBoundParameters -ParamsToRemove "DriveType","MinDiskCapacityGB"
-        Add-ToPSBoundParametersFromHashtable -PSBoundParametersIn $PSBoundParameters -ParamsToAdd @{"MountPoint" = ""}
+        Remove-FromPSBoundParametersUsingHashtable -PSBoundParametersIn $PSBoundParameters -ParamsToRemove 'DriveType', 'MinDiskCapacityGB'
+        Add-ToPSBoundParametersFromHashtable -PSBoundParametersIn $PSBoundParameters -ParamsToAdd @{'MountPoint' = ''}
 
-        #Loop through each potential AutoBitlocker volume, see whether they are enabled for Bitlocker, and if not, enable it
+        # Loop through each potential AutoBitlocker volume, see whether they are enabled for Bitlocker, and if not, enable it
         foreach ($key in $autoBlVols.Keys)
         {
-            $PSBoundParameters["MountPoint"] = $key
+            $PSBoundParameters['MountPoint'] = $key
 
             $testResult = Test-BitlockerEnabled @PSBoundParameters
 
@@ -474,7 +474,7 @@ function Test-TargetResource
     param
     (
         [Parameter(Mandatory = $true)]
-        [ValidateSet("Fixed","Removable")]
+        [ValidateSet('Fixed', 'Removable')]
         [System.String]
         $DriveType,
 
@@ -483,7 +483,7 @@ function Test-TargetResource
         $MinDiskCapacityGB,
 
         [Parameter(Mandatory = $true)]
-        [ValidateSet("PasswordProtector","RecoveryPasswordProtector","StartupKeyProtector","TpmProtector")]
+        [ValidateSet('PasswordProtector', 'RecoveryPasswordProtector', 'StartupKeyProtector', 'TpmProtector')]
         [System.String]
         $PrimaryProtector,
 
@@ -500,7 +500,7 @@ function Test-TargetResource
         $AutoUnlock = $false,
 
         [Parameter()]
-        [ValidateSet("Aes128","Aes256")]
+        [ValidateSet('Aes128', 'Aes256')]
         [System.String]
         $EncryptionMethod,
 
@@ -557,7 +557,7 @@ function Test-TargetResource
         $UsedSpaceOnly
     )
 
-    #Load helper module
+    # Load helper module
     Import-Module "$((Get-Item -LiteralPath "$($PSScriptRoot)").Parent.Parent.FullName)\Misc\xBitlockerCommon.psm1" -Verbose:0
 
     Assert-HasPrereqsForBitlocker
@@ -574,13 +574,13 @@ function Test-TargetResource
     }
     else
     {
-        Remove-FromPSBoundParametersUsingHashtable -PSBoundParametersIn $PSBoundParameters -ParamsToRemove "DriveType","MinDiskCapacityGB"
-        Add-ToPSBoundParametersFromHashtable -PSBoundParametersIn $PSBoundParameters -ParamsToAdd @{"MountPoint" = ""}
+        Remove-FromPSBoundParametersUsingHashtable -PSBoundParametersIn $PSBoundParameters -ParamsToRemove 'DriveType', 'MinDiskCapacityGB'
+        Add-ToPSBoundParametersFromHashtable -PSBoundParametersIn $PSBoundParameters -ParamsToAdd @{'MountPoint' = ''}
 
-        #Check whether any potential AutoBitlocker volume is not currently enabled for Bitlocker, or doesn't have the correct settings
+        # Check whether any potential AutoBitlocker volume is not currently enabled for Bitlocker, or doesn't have the correct settings
         foreach ($key in $autoBlVols.Keys)
         {
-            $PSBoundParameters["MountPoint"] = $key
+            $PSBoundParameters['MountPoint'] = $key
 
             $testResult = Test-BitlockerEnabled @PSBoundParameters -VerbosePreference $VerbosePreference
 
@@ -684,7 +684,7 @@ function Get-AutoBitlockerStatus
     param
     (
         [Parameter(Mandatory = $true)]
-        [ValidateSet("Fixed","Removable")]
+        [ValidateSet('Fixed', 'Removable')]
         [System.String]
         $DriveType,
 
@@ -693,7 +693,7 @@ function Get-AutoBitlockerStatus
         $MinDiskCapacityGB,
 
         [Parameter(Mandatory = $true)]
-        [ValidateSet("PasswordProtector","RecoveryPasswordProtector","StartupKeyProtector","TpmProtector")]
+        [ValidateSet('PasswordProtector', 'RecoveryPasswordProtector', 'StartupKeyProtector', 'TpmProtector')]
         [System.String]
         $PrimaryProtector,
 
@@ -710,7 +710,7 @@ function Get-AutoBitlockerStatus
         $AutoUnlock = $false,
 
         [Parameter()]
-        [ValidateSet("Aes128","Aes256")]
+        [ValidateSet('Aes128', 'Aes256')]
         [System.String]
         $EncryptionMethod,
 
@@ -767,19 +767,19 @@ function Get-AutoBitlockerStatus
         $UsedSpaceOnly
     )
 
-    #First get all Bitlocker Volumes of type Data
+    # First get all Bitlocker Volumes of type Data
     $allBlvs = Get-BitLockerVolume | Where-Object -FilterScript {$_.VolumeType -eq 'Data'}
 
-    #Filter on size if it was specified
-    if ($PSBoundParameters.ContainsKey("MinDiskCapacityGB"))
+    # Filter on size if it was specified
+    if ($PSBoundParameters.ContainsKey('MinDiskCapacityGB'))
     {
         $allBlvs = $allBlvs | Where-Object -FilterScript {$_.CapacityGB -ge $MinDiskCapacityGB}
     }
 
-    #Now find disks of the appropriate drive type, and add them to the collection
+    # Now find disks of the appropriate drive type, and add them to the collection
     if ($null -ne $allBlvs)
     {
-        [Hashtable]$returnValue = @{}
+        [Hashtable] $returnValue = @{}
 
         # Convert DriveType into values returned by Win32_EncryptableVolume.VolumeType
         switch ($DriveType)
@@ -813,7 +813,7 @@ function Get-AutoBitlockerStatus
 
             if ($null -ne $vol)
             {
-                [Hashtable]$props = @{
+                [Hashtable] $props = @{
                     VolumeStatus = $blv.VolumeStatus
                     KeyProtectors = $blv.KeyProtector
                     EncryptionMethod = $blv.EncryptionMethod

diff --git a/DSCResources/MSFT_xBLBitlocker/MSFT_xBLBitlocker.psm1 b/DSCResources/MSFT_xBLBitlocker/MSFT_xBLBitlocker.psm1
@@ -87,7 +87,7 @@ function Get-TargetResource
         $MountPoint,
 
         [Parameter(Mandatory = $true)]
-        [ValidateSet("PasswordProtector","RecoveryPasswordProtector","StartupKeyProtector","TpmProtector")]
+        [ValidateSet('PasswordProtector', 'RecoveryPasswordProtector', 'StartupKeyProtector', 'TpmProtector')]
         [System.String]
         $PrimaryProtector,
 
@@ -108,7 +108,7 @@ function Get-TargetResource
         $AutoUnlock = $false,
 
         [Parameter()]
-        [ValidateSet("Aes128","Aes256")]
+        [ValidateSet('Aes128', 'Aes256')]
         [System.String]
         $EncryptionMethod,
 
@@ -165,7 +165,7 @@ function Get-TargetResource
         $UsedSpaceOnly
     )
 
-    #Load helper module
+    # Load helper module
     Import-Module "$((Get-Item -LiteralPath "$($PSScriptRoot)").Parent.Parent.FullName)\Misc\xBitlockerCommon.psm1" -Verbose:0
 
     Assert-HasPrereqsForBitlocker
@@ -265,7 +265,7 @@ function Set-TargetResource
         $MountPoint,
 
         [Parameter(Mandatory = $true)]
-        [ValidateSet("PasswordProtector","RecoveryPasswordProtector","StartupKeyProtector","TpmProtector")]
+        [ValidateSet('PasswordProtector', 'RecoveryPasswordProtector', 'StartupKeyProtector', 'TpmProtector')]
         [System.String]
         $PrimaryProtector,
 
@@ -286,7 +286,7 @@ function Set-TargetResource
         $AutoUnlock = $false,
 
         [Parameter()]
-        [ValidateSet("Aes128","Aes256")]
+        [ValidateSet('Aes128', 'Aes256')]
         [System.String]
         $EncryptionMethod,
 
@@ -343,7 +343,7 @@ function Set-TargetResource
         $UsedSpaceOnly
     )
 
-    #Load helper module
+    # Load helper module
     Import-Module "$((Get-Item -LiteralPath "$($PSScriptRoot)").Parent.Parent.FullName)\Misc\xBitlockerCommon.psm1" -Verbose:0
 
     Assert-HasPrereqsForBitlocker
@@ -441,7 +441,7 @@ function Test-TargetResource
         $MountPoint,
 
         [Parameter(Mandatory = $true)]
-        [ValidateSet("PasswordProtector","RecoveryPasswordProtector","StartupKeyProtector","TpmProtector")]
+        [ValidateSet('PasswordProtector', 'RecoveryPasswordProtector', 'StartupKeyProtector', 'TpmProtector')]
         [System.String]
         $PrimaryProtector,
 
@@ -462,7 +462,7 @@ function Test-TargetResource
         $AutoUnlock = $false,
 
         [Parameter()]
-        [ValidateSet("Aes128","Aes256")]
+        [ValidateSet('Aes128', 'Aes256')]
         [System.String]
         $EncryptionMethod,
 
@@ -519,7 +519,7 @@ function Test-TargetResource
         $UsedSpaceOnly
     )
 
-    #Load helper module
+    # Load helper module
     Import-Module "$((Get-Item -LiteralPath "$($PSScriptRoot)").Parent.Parent.FullName)\Misc\xBitlockerCommon.psm1" -Verbose:0
 
     Assert-HasPrereqsForBitlocker

diff --git a/DSCResources/MSFT_xBLTpm/MSFT_xBLTpm.psm1 b/DSCResources/MSFT_xBLTpm/MSFT_xBLTpm.psm1
@@ -42,7 +42,7 @@ function Get-TargetResource
         $AllowImmediateReboot = $false
     )
 
-    #Load helper module
+    # Load helper module
     Import-Module "$((Get-Item -LiteralPath "$($PSScriptRoot)").Parent.Parent.FullName)\Misc\xBitlockerCommon.psm1" -Verbose:0
 
     Assert-HasPrereqsForBitlocker
@@ -109,7 +109,7 @@ function Set-TargetResource
         $AllowImmediateReboot = $false
     )
 
-    #Load helper module
+    # Load helper module
     Import-Module "$((Get-Item -LiteralPath "$($PSScriptRoot)").Parent.Parent.FullName)\Misc\xBitlockerCommon.psm1" -Verbose:0
 
     Assert-HasPrereqsForBitlocker
@@ -185,7 +185,7 @@ function Test-TargetResource
         $AllowImmediateReboot = $false
     )
 
-    #Load helper module
+    # Load helper module
     Import-Module "$((Get-Item -LiteralPath "$($PSScriptRoot)").Parent.Parent.FullName)\Misc\xBitlockerCommon.psm1" -Verbose:0
 
     Assert-HasPrereqsForBitlocker

diff --git a/Examples/ConfigureBitlockerAndAutoBitlocker/ConfigureBitlockerAndAutoBitlocker.ps1 b/Examples/ConfigureBitlockerAndAutoBitlocker/ConfigureBitlockerAndAutoBitlocker.ps1
@@ -1,11 +1,11 @@
 Configuration ConfigureBitlockerAndAutoBitlocker
 {
-    Import-DscResource –ModuleName PSDesiredStateConfiguration
+    Import-DscResource -ModuleName PSDesiredStateConfiguration
     Import-DscResource -ModuleName xBitlocker
 
-    Node 'E15-1'
+    Node 'localhost'
     {
-        #First install the required Bitlocker features
+        # First install the required Bitlocker features
         WindowsFeature BitlockerFeature
         {
             Name                 = 'Bitlocker'
@@ -20,7 +20,7 @@ Configuration ConfigureBitlockerAndAutoBitlocker
             IncludeAllSubFeature = $true
         }
 
-        #This example enables Bitlocker on the Operating System drive using both a RecoveryPasswordProtector and a StartupKeyProtector
+        # This example enables Bitlocker on the Operating System drive using both a RecoveryPasswordProtector and a StartupKeyProtector
         xBLBitlocker Bitlocker
         {
             MountPoint                = 'C:'
@@ -31,22 +31,20 @@ Configuration ConfigureBitlockerAndAutoBitlocker
             AllowImmediateReboot      = $true
             UsedSpaceOnly             = $true
 
-            DependsOn                 = '[WindowsFeature]BitlockerFeature','[WindowsFeature]BitlockerToolsFeature'
+            DependsOn                 = '[WindowsFeature]BitlockerFeature', '[WindowsFeature]BitlockerToolsFeature'
         }
 
-        #This example sets up AutoBitlocker for any drive of type Fixed with a RecoveryPasswordProtector only.
+        # This example sets up AutoBitlocker for any drive of type Fixed with a RecoveryPasswordProtector only.
         xBLAutoBitlocker AutoBitlocker
         {
             DriveType                 = 'Fixed'
             PrimaryProtector          = 'RecoveryPasswordProtector'
             RecoveryPasswordProtector = $true
             UsedSpaceOnly             = $true
-
-            DependsOn                 = '[xBLBitlocker]Bitlocker' #Don't enable AutoBL until the OS drive has been encrypted
+            # Don't enable AutoBL until the OS drive has been encrypted
+            DependsOn                 = '[xBLBitlocker]Bitlocker'
         }
     }
 }
 
 ConfigureBitlockerAndAutoBitlocker
-
-#Start-DscConfiguration -Verbose -Wait -Path .\ConfigureBitlockerAndAutoBitlocker -ComputerName "E15-1"