DSC_WebSite: Change CertificateStoreName value in the schema (#641)

webalexeu · web-flow · commit c5e65a48f1a1 · 2024-10-29T15:54:12.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,11 @@ For older change log history see the [historic changelog](HISTORIC_CHANGELOG.md)
 - IisMimeTypeMapping
   - Set default for Ensure property to Present.
 
+### Fixed
+
+- WebAdministrationDsc
+  - Fixed CertificateStoreName default value from `MY` to `My` ([issue #642](https://github.com/dsccommunity/WebAdministrationDsc/issues/542))
+
 ## [4.2.0] - 2024-08-26
 
 ### Removed
diff --git a/source/DSCResources/DSC_WebSite/DSC_WebSite.psm1 b/source/DSCResources/DSC_WebSite/DSC_WebSite.psm1
@@ -1310,7 +1310,7 @@ function ConvertTo-CimBinding
             }
 
             $cimProperties.Add('CertificateThumbprint', [String]$binding.certificateHash)
-            $cimProperties.Add('CertificateStoreName',  [String]$binding.certificateStoreName)
+            $cimProperties.Add('CertificateStoreName',  [String]($binding.certificateStoreName) -creplace ('^MY$','My'))
 
             New-CimInstance -ClassName $cimClassName `
                             -Namespace $cimNamespace `
@@ -1460,14 +1460,14 @@ function ConvertTo-WebBinding
 
                     if ([String]::IsNullOrEmpty($binding.CertificateStoreName))
                     {
-                        $certificateStoreName = 'MY'
+                        $certificateStoreName = 'My'
                         Write-Verbose -Message `
                             ($script:localizedData.VerboseConvertToWebBindingDefaultCertificateStoreName `
                             -f $certificateStoreName)
                     }
                     else
                     {
-                        $certificateStoreName = $binding.CertificateStoreName
+                        $certificateStoreName = $binding.CertificateStoreName -creplace ('^MY$','My')
                     }
 
                     $certificateHash = $null
diff --git a/source/Examples/Resources/WebSite/Sample_WebSite_NewWebsite_UsingCertificateSubject.ps1 b/source/Examples/Resources/WebSite/Sample_WebSite_NewWebsite_UsingCertificateSubject.ps1
@@ -79,7 +79,7 @@ Configuration Sample_WebSite_NewWebsite_UsingCertificateSubject
                     Protocol              = 'HTTPS'
                     Port                  = 8444
                     CertificateSubject    = 'CN=CertificateSubject'
-                    CertificateStoreName  = 'MY'
+                    CertificateStoreName  = 'My'
                 }
             )
             DependsOn       = '[File]WebContent'
diff --git a/source/Examples/Resources/WebSite/Sample_WebSite_NewWebsite_UsingCertificateThumbprint.ps1 b/source/Examples/Resources/WebSite/Sample_WebSite_NewWebsite_UsingCertificateThumbprint.ps1
@@ -88,7 +88,7 @@ Configuration Sample_WebSite_NewWebsite_UsingCertificateThumbprint
                     Protocol              = 'HTTPS'
                     Port                  = 8444
                     CertificateThumbprint = 'DEDDD963B28095837F558FE14DA1FDEFB7FA9DA7'
-                    CertificateStoreName  = 'MY'
+                    CertificateStoreName  = 'My'
                 }
             )
             DependsOn       = '[File]WebContent'
diff --git a/source/Examples/Resources/WebSite/Sample_WebSite_WithSSLFlags.ps1 b/source/Examples/Resources/WebSite/Sample_WebSite_WithSSLFlags.ps1
@@ -76,7 +76,7 @@ configuration Sample_WebSite_WithSSLFlags
             {
                 Protocol              = 'https'
                 Port                  = '443'
-                CertificateStoreName  = 'MY'
+                CertificateStoreName  = 'My'
                 CertificateThumbprint = 'BB84DE3EC423DDDE90C08AB3C5A828692089493C'
                 HostName              = $WebSiteName
                 IPAddress             = '*'
diff --git a/tests/Integration/DSC_SslSettings.config.psd1 b/tests/Integration/DSC_SslSettings.config.psd1
@@ -11,7 +11,7 @@
             HTTPSProtocol               = 'https'
             HTTPSPort                   = '443'
             HTTPSHostname               = 'https.website'
-            CertificateStoreName        = 'MY'
+            CertificateStoreName        = 'My'
             SslFlags                    = '1'
             Bindings                    = @('Ssl')
         }
diff --git a/tests/Integration/DSC_WebApplication.config.psd1 b/tests/Integration/DSC_WebApplication.config.psd1
@@ -19,7 +19,7 @@
             HTTPSProtocol               = 'https'
             HTTPSPort                   = '443'
             HTTPSHostname               = 'https.website'
-            CertificateStoreName        = 'MY'
+            CertificateStoreName        = 'My'
             SslFlags                    = '1'
             WebApplicationSslFlags      = @('Ssl')
             EnabledProtocols            = @('http', 'net.tcp')
diff --git a/tests/Integration/DSC_WebSite.config.psd1 b/tests/Integration/DSC_WebSite.config.psd1
@@ -27,7 +27,7 @@
             HTTPSPort                   = '443'
             HTTPSPort2                  = '8444'
             HTTPSHostname               = 'https.website'
-            CertificateStoreName        = 'MY'
+            CertificateStoreName        = 'My'
             SslFlags                    = '1'
             LogFieldName1               = 'CustomField1'
             SourceName1                 = 'Accept-Encoding'
diff --git a/tests/Unit/DSC_Website.Tests.ps1 b/tests/Unit/DSC_Website.Tests.ps1
@@ -2249,7 +2249,7 @@ try
                     bindingInformation   = '127.0.0.1:443:MockHostName'
                     protocol             = 'https'
                     certificateHash      = '1D3324C6E2F7ABC794C9CB6CA426B8D0F81045CD'
-                    certificateStoreName = 'MY'
+                    certificateStoreName = 'My'
                     sslFlags             = '1'
                 }
 
@@ -2276,7 +2276,7 @@ try
                 }
 
                 It 'should return the CertificateStoreName' {
-                    $Result.CertificateStoreName | Should Be 'MY'
+                    $Result.CertificateStoreName | Should BeExactly 'My'
                 }
 
                 It 'should return the SslFlags' {
@@ -2289,7 +2289,7 @@ try
                     bindingInformation   = '[0:0:0:0:0:0:0:1]:443:MockHostName'
                     protocol             = 'https'
                     certificateHash      = '1D3324C6E2F7ABC794C9CB6CA426B8D0F81045CD'
-                    certificateStoreName = 'MY'
+                    certificateStoreName = 'My'
                     sslFlags             = '1'
                 }
 
@@ -2316,7 +2316,7 @@ try
                 }
 
                 It 'should return the CertificateStoreName' {
-                    $Result.CertificateStoreName | Should Be 'MY'
+                    $Result.CertificateStoreName | Should BeExactly 'My'
                 }
 
                 It 'should return the SslFlags' {
@@ -2470,7 +2470,7 @@ try
                     -Property @{
                         Protocol              = 'https'
                         CertificateThumbprint = $MockThumbprintWithLrmChar
-                        CertificateStoreName  = 'MY'
+                        CertificateStoreName  = 'My'
                     } -ClientOnly
                 )
 
@@ -2617,7 +2617,7 @@ try
                     -Property @{
                         Protocol              = 'https'
                         CertificateSubject    = 'TestCertificate'
-                        CertificateStoreName  = 'MY'
+                        CertificateStoreName  = 'My'
                     } -ClientOnly
                 )
 
@@ -2651,7 +2651,7 @@ try
 
                 It 'should set CertificateStoreName to the default value' {
                     $Result = ConvertTo-WebBinding -InputObject $MockBindingInfo
-                    $Result.certificateStoreName | Should Be 'MY'
+                    $Result.certificateStoreName | Should BeExactly 'My'
                 }
             }
 
@@ -3427,7 +3427,7 @@ try
                             Port                  = 443
                             HostName              = ''
                             CertificateThumbprint = '1D3324C6E2F7ABC794C9CB6CA426B8D0F81045CD'
-                            CertificateStoreName  = 'MY'
+                            CertificateStoreName  = 'My'
                             SslFlags              = 0
                         }
                 )
@@ -3437,7 +3437,7 @@ try
                         bindingInformation   = '*:443:'
                         protocol             = 'https'
                         certificateHash      = 'B30F3184A831320382C61EFB0551766321FA88A5'
-                        certificateStoreName = 'MY'
+                        certificateStoreName = 'My'
                         sslFlags             = '0'
                     }
                 )
@@ -3468,7 +3468,7 @@ try
                             Port                  = 443
                             HostName              = ''
                             CertificateThumbprint = '1D3324C6E2F7ABC794C9CB6CA426B8D0F81045CD'
-                            CertificateStoreName  = 'MY'
+                            CertificateStoreName  = 'My'
                             SslFlags              = 0
                         }
                 )
@@ -3507,7 +3507,7 @@ try
                             Port                  = 443
                             HostName              = ''
                             CertificateThumbprint = ''
-                            CertificateStoreName  = 'MY'
+                            CertificateStoreName  = 'My'
                             SslFlags              = 0
                         }
                 )
@@ -3814,7 +3814,7 @@ try
                         Port                  = 443
                         HostName              = ''
                         CertificateThumbprint = '5846A1B276328B1A32A30150858F6383C1F30E1F'
-                        CertificateStoreName  = 'MY'
+                        CertificateStoreName  = 'My'
                         SslFlags              = 0
                     }
             )

Original file line number	Diff line number	Diff line change
`@@ -1310,7 +1310,7 @@ function ConvertTo-CimBinding`
`1310`	`1310`	`}`
`1311`	`1311`
`1312`	`1312`	`$cimProperties.Add('CertificateThumbprint', [String]$binding.certificateHash)`
`1313`		`- $cimProperties.Add('CertificateStoreName', [String]$binding.certificateStoreName)`
	`1313`	`+ $cimProperties.Add('CertificateStoreName', [String]($binding.certificateStoreName) -creplace ('^MY$','My'))`
`1314`	`1314`
`1315`	`1315`	New-CimInstance -ClassName $cimClassName `
`1316`	`1316`	-Namespace $cimNamespace `
`@@ -1460,14 +1460,14 @@ function ConvertTo-WebBinding`
`1460`	`1460`
`1461`	`1461`	`if ([String]::IsNullOrEmpty($binding.CertificateStoreName))`
`1462`	`1462`	`{`
`1463`		`- $certificateStoreName = 'MY'`
	`1463`	`+ $certificateStoreName = 'My'`
`1464`	`1464`	Write-Verbose -Message `
`1465`	`1465`	($script:localizedData.VerboseConvertToWebBindingDefaultCertificateStoreName `
`1466`	`1466`	`-f $certificateStoreName)`
`1467`	`1467`	`}`
`1468`	`1468`	`else`
`1469`	`1469`	`{`
`1470`		`- $certificateStoreName = $binding.CertificateStoreName`
	`1470`	`+ $certificateStoreName = $binding.CertificateStoreName -creplace ('^MY$','My')`
`1471`	`1471`	`}`
`1472`	`1472`
`1473`	`1473`	`$certificateHash = $null`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ Configuration Sample_WebSite_NewWebsite_UsingCertificateSubject`
`79`	`79`	`Protocol = 'HTTPS'`
`80`	`80`	`Port = 8444`
`81`	`81`	`CertificateSubject = 'CN=CertificateSubject'`
`82`		`- CertificateStoreName = 'MY'`
	`82`	`+ CertificateStoreName = 'My'`
`83`	`83`	`}`
`84`	`84`	`)`
`85`	`85`	`DependsOn = '[File]WebContent'`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ Configuration Sample_WebSite_NewWebsite_UsingCertificateThumbprint`
`88`	`88`	`Protocol = 'HTTPS'`
`89`	`89`	`Port = 8444`
`90`	`90`	`CertificateThumbprint = 'DEDDD963B28095837F558FE14DA1FDEFB7FA9DA7'`
`91`		`- CertificateStoreName = 'MY'`
	`91`	`+ CertificateStoreName = 'My'`
`92`	`92`	`}`
`93`	`93`	`)`
`94`	`94`	`DependsOn = '[File]WebContent'`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ configuration Sample_WebSite_WithSSLFlags`
`76`	`76`	`{`
`77`	`77`	`Protocol = 'https'`
`78`	`78`	`Port = '443'`
`79`		`- CertificateStoreName = 'MY'`
	`79`	`+ CertificateStoreName = 'My'`
`80`	`80`	`CertificateThumbprint = 'BB84DE3EC423DDDE90C08AB3C5A828692089493C'`
`81`	`81`	`HostName = $WebSiteName`
`82`	`82`	`IPAddress = '*'`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`HTTPSProtocol = 'https'`
`12`	`12`	`HTTPSPort = '443'`
`13`	`13`	`HTTPSHostname = 'https.website'`
`14`		`- CertificateStoreName = 'MY'`
	`14`	`+ CertificateStoreName = 'My'`
`15`	`15`	`SslFlags = '1'`
`16`	`16`	`Bindings = @('Ssl')`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2249,7 +2249,7 @@ try`
`2249`	`2249`	`bindingInformation = '127.0.0.1:443:MockHostName'`
`2250`	`2250`	`protocol = 'https'`
`2251`	`2251`	`certificateHash = '1D3324C6E2F7ABC794C9CB6CA426B8D0F81045CD'`
`2252`		`- certificateStoreName = 'MY'`
	`2252`	`+ certificateStoreName = 'My'`
`2253`	`2253`	`sslFlags = '1'`
`2254`	`2254`	`}`
`2255`	`2255`
`@@ -2276,7 +2276,7 @@ try`
`2276`	`2276`	`}`
`2277`	`2277`
`2278`	`2278`	`It 'should return the CertificateStoreName' {`
`2279`		`- $Result.CertificateStoreName \| Should Be 'MY'`
	`2279`	`+ $Result.CertificateStoreName \| Should BeExactly 'My'`
`2280`	`2280`	`}`
`2281`	`2281`
`2282`	`2282`	`It 'should return the SslFlags' {`
`@@ -2289,7 +2289,7 @@ try`
`2289`	`2289`	`bindingInformation = '[0:0:0:0:0:0:0:1]:443:MockHostName'`
`2290`	`2290`	`protocol = 'https'`
`2291`	`2291`	`certificateHash = '1D3324C6E2F7ABC794C9CB6CA426B8D0F81045CD'`
`2292`		`- certificateStoreName = 'MY'`
	`2292`	`+ certificateStoreName = 'My'`
`2293`	`2293`	`sslFlags = '1'`
`2294`	`2294`	`}`
`2295`	`2295`
`@@ -2316,7 +2316,7 @@ try`
`2316`	`2316`	`}`
`2317`	`2317`
`2318`	`2318`	`It 'should return the CertificateStoreName' {`
`2319`		`- $Result.CertificateStoreName \| Should Be 'MY'`
	`2319`	`+ $Result.CertificateStoreName \| Should BeExactly 'My'`
`2320`	`2320`	`}`
`2321`	`2321`
`2322`	`2322`	`It 'should return the SslFlags' {`
`@@ -2470,7 +2470,7 @@ try`
`2470`	`2470`	`-Property @{`
`2471`	`2471`	`Protocol = 'https'`
`2472`	`2472`	`CertificateThumbprint = $MockThumbprintWithLrmChar`
`2473`		`- CertificateStoreName = 'MY'`
	`2473`	`+ CertificateStoreName = 'My'`
`2474`	`2474`	`} -ClientOnly`
`2475`	`2475`	`)`
`2476`	`2476`
`@@ -2617,7 +2617,7 @@ try`
`2617`	`2617`	`-Property @{`
`2618`	`2618`	`Protocol = 'https'`
`2619`	`2619`	`CertificateSubject = 'TestCertificate'`
`2620`		`- CertificateStoreName = 'MY'`
	`2620`	`+ CertificateStoreName = 'My'`
`2621`	`2621`	`} -ClientOnly`
`2622`	`2622`	`)`
`2623`	`2623`
`@@ -2651,7 +2651,7 @@ try`
`2651`	`2651`
`2652`	`2652`	`It 'should set CertificateStoreName to the default value' {`
`2653`	`2653`	`$Result = ConvertTo-WebBinding -InputObject $MockBindingInfo`
`2654`		`- $Result.certificateStoreName \| Should Be 'MY'`
	`2654`	`+ $Result.certificateStoreName \| Should BeExactly 'My'`
`2655`	`2655`	`}`
`2656`	`2656`	`}`
`2657`	`2657`
`@@ -3427,7 +3427,7 @@ try`
`3427`	`3427`	`Port = 443`
`3428`	`3428`	`HostName = ''`
`3429`	`3429`	`CertificateThumbprint = '1D3324C6E2F7ABC794C9CB6CA426B8D0F81045CD'`
`3430`		`- CertificateStoreName = 'MY'`
	`3430`	`+ CertificateStoreName = 'My'`
`3431`	`3431`	`SslFlags = 0`
`3432`	`3432`	`}`
`3433`	`3433`	`)`
`@@ -3437,7 +3437,7 @@ try`
`3437`	`3437`	`bindingInformation = '*:443:'`
`3438`	`3438`	`protocol = 'https'`
`3439`	`3439`	`certificateHash = 'B30F3184A831320382C61EFB0551766321FA88A5'`
`3440`		`- certificateStoreName = 'MY'`
	`3440`	`+ certificateStoreName = 'My'`
`3441`	`3441`	`sslFlags = '0'`
`3442`	`3442`	`}`
`3443`	`3443`	`)`
`@@ -3468,7 +3468,7 @@ try`
`3468`	`3468`	`Port = 443`
`3469`	`3469`	`HostName = ''`
`3470`	`3470`	`CertificateThumbprint = '1D3324C6E2F7ABC794C9CB6CA426B8D0F81045CD'`
`3471`		`- CertificateStoreName = 'MY'`
	`3471`	`+ CertificateStoreName = 'My'`
`3472`	`3472`	`SslFlags = 0`
`3473`	`3473`	`}`
`3474`	`3474`	`)`
`@@ -3507,7 +3507,7 @@ try`
`3507`	`3507`	`Port = 443`
`3508`	`3508`	`HostName = ''`
`3509`	`3509`	`CertificateThumbprint = ''`
`3510`		`- CertificateStoreName = 'MY'`
	`3510`	`+ CertificateStoreName = 'My'`
`3511`	`3511`	`SslFlags = 0`
`3512`	`3512`	`}`
`3513`	`3513`	`)`
`@@ -3814,7 +3814,7 @@ try`
`3814`	`3814`	`Port = 443`
`3815`	`3815`	`HostName = ''`
`3816`	`3816`	`CertificateThumbprint = '5846A1B276328B1A32A30150858F6383C1F30E1F'`
`3817`		`- CertificateStoreName = 'MY'`
	`3817`	`+ CertificateStoreName = 'My'`
`3818`	`3818`	`SslFlags = 0`
`3819`	`3819`	`}`
`3820`	`3820`	`)`