Skip to main content

Assign an existing certificate to your IIS website with WiX - Part 2 (PowerShell version)

In my previous post I explained how to assign an existing certificate with a custom action. Because of all kind of IIS Manager related failures I had on my work with this solution I did some research and constructed a version based on the usage of a PowerShell step within the WiX installer.

PowerShellWixExtension

In this new scenario I use the PowerShellWixExtension written by David Gardiner which I found on GitHub. To use this extension you have to add a reference to the PowerShellWixExtension.dll in your WiX Setup project. I added this reference with the published NuGet package. Search for PowershellWixExtension in the store. The further steps to use this library are documented on the GitHub page.

PowerShell script

Add to your WiX setup project a PowerShell file name Add-ExistingCertificateToBinding.ps1 which will contain the steps to find and add the certificate to an existing IIS binding.

Add the below PowerShell code to this file.
param (
    [Parameter(Mandatory = $False, HelpMessage = "The name of the IIS site.")]
    [string] $siteName = "Default Web Site",

    [Parameter(Mandatory = $False, HelpMessage = "The IP address which the IIS binding uses.")]
    [string] $ip,

    [Parameter(Mandatory = $False, HelpMessage = "The port number which the IIS binding uses.")]
    [string] $port = 443,

    [Parameter(Mandatory = $False, HelpMessage = "The host name which the IIS binding uses.")]
    [string] $hostname,

    [Parameter(Mandatory = $True, HelpMessage = "The common name of the client certificate to use..")]
    [string] $certificateCommonName
)

function Execute-WithRetry([ScriptBlock] $command) {
    $attemptCount = 0
    $operationIncomplete = $true
    $maxFailures = 5
    $sleepBetweenFailures = 1

    while ($operationIncomplete -and $attemptCount -lt $maxFailures) {
        $attemptCount = ($attemptCount + 1)

        if ($attemptCount -ge 2) {
            Write-Host "Waiting for $sleepBetweenFailures seconds before retrying..."
            Start-Sleep -s $sleepBetweenFailures
            Write-Host "Retrying..."
        }

        try {
            # Call the script block
            & $command

            $operationIncomplete = $false
        }
        catch [System.Exception] {
            if ($attemptCount -lt ($maxFailures)) {
                Write-Host ("Attempt $attemptCount of $maxFailures failed: " + $_.Exception.Message)
            }
            else {
                throw
            }
        }
    }
}

function Ensure-IISAdministration {
    [CmdletBinding()]
    param ()

    $version = "1.1.0.0"

    if (-not (Get-Module IISAdministration -ListAvailable | Where-Object { $_.Version -eq $version })) {
        Install-Module IISAdministration -RequiredVersion $version -Scope AllUsers -Force
        Write-Host "IISAdministration version '$version' installed on machine."
    }
}

function Get-ClientCertificate {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $True)]
        [string] $CommonName
    )

    $certificates = (Get-ChildItem Cert:\LocalMachine\My | Where-Object { $_.Subject.StartsWith("CN=$CommonName") })

    $now = Get-Date
    $validCertificate = $null
    $notAfter = $now

    foreach ($certificate in $certificates) {
        if ($certificate.NotBefore -le $now -and $certificate.NotAfter -ge $notAfter) {
            $validCertificate = $certificate
        }
    }

    Write-Verbose ("Found valid certificate '{0}' with expiration date '{1}'." -f $validCertificate.Subject, $validCertificate.NotAfter)

    return $validCertificate
}

function Add-ExistingCertificateToBinding {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $False, HelpMessage = "The name of the IIS site.")]
        [string] $siteName = "Default Web Site",

        [Parameter(Mandatory = $False, HelpMessage = "The IP address which the IIS binding uses.")]
        [string] $ip,

        [Parameter(Mandatory = $False, HelpMessage = "The port number which the IIS binding uses.")]
        [string] $port = 443,

        [Parameter(Mandatory = $False, HelpMessage = "The host name which the IIS binding uses.")]
        [string] $hostname,

        [Parameter(Mandatory = $True, HelpMessage = "The common name of the client certificate to use..")]
        [string] $certificateCommonName
    )

    Ensure-IISAdministration

    if ($ip -eq "*") {
        $ip = $null
    }

    $bindingInformation = $ip + ":" + $port + ":" + $hostname

    $certificate = Get-ClientCertificate -CommonName $certificateCommonName

    if ($certificate -eq $null) {
        Throw "Certificate '$certificateCommonName' not found on server '$ENV:COMPUTERNAME'."
    }

    $binding = Get-IISSiteBinding -Name $siteName -BindingInformation $bindingInformation

    $sslFlag = "None"

    if ($Hostname) {
        $sslFlag = "Sni"
    }

    if ($binding -eq $null) {
        Execute-WithRetry {
            New-IISSiteBinding -Name $siteName -BindingInformation $bindingInformation -Protocol https -CertificateThumbPrint $certificate.Thumbprint -SslFlag $sslFlag -CertStoreLocation Cert:\LocalMachine\My
        }

        Write-Host ("Added web site binding '{0}' to IIS website '{1}'." -f $bindingInformation, $siteName)
    }
    else {
        Execute-WithRetry {
            Remove-IISSiteBinding -Name $siteName -BindingInformation $bindingInformation -Protocol https -RemoveConfigOnly -Confirm:$False
            New-IISSiteBinding -Name $siteName -BindingInformation $bindingInformation -Protocol https -CertificateThumbPrint $certificate.Thumbprint -SslFlag $sslFlag -CertStoreLocation Cert:\LocalMachine\My
        }

        Write-Host ("Modified existing web site binding '{0}' for IIS website '{1}'." -f $bindingInformation, $siteName)
    }
}

Add-ExistingCertificateToBinding -siteName $siteName -ip $ip -port $port -hostname $hostname -certificateCommonName $certificateCommonName

WiX configuration

In the WiX file we have to call this PowerShell function and pass the necessary parameters.
<!-- Add existing client certificate to HTTPS binding -->
<powershell:File Id="AddExistingCertificateToBindingAction"
                 File="[#AddExistingCertificateToBinding]"
                 Arguments="-siteName "[WEBSITE_DESCRIPTION]" -ip "[WEBSITE_BINDING_IP]" -port "[WEBSITE_BINDING_PORT]" -hostName "[WEBSITE_BINDING_URL]" -certificateCommonName "[CERTIFICATE_COMMON_NAME]"" />
We also have to instruct the WIX installer to execute this step after the install is finalized.
<InstallExecuteSequence>
  <Custom Action="PowerShellFilesDeferred" Before="InstallFinalize">NOT Installed</Custom>
</InstallExecuteSequence>

Comments

Popular posts from this blog

CS8357: The specified version string contains wildcards, which are not compatible with determinism.

Today I was busy with creating a WCF service solution in Visual Studio Enterprise 2017 (15.9.2). In this solution I use a few C# class libraries based on .NET 4.7.2. When I compiled the solution I got this error message: Error CS8357: The specified version string contains wildcards, which are not compatible with determinism. Either remove wildcards from the version string, or disable determinism for this compilation The error message is linking to my AssemblyInfo.cs file of the Class library projects. In all the projects of this solution I use the wildcard notation for generating build and revision numbers. // Version information for an assembly consists of the following four values: // // Major Version // Minor Version // Build Number // Revision // // You can specify all the values or you can default the Build and Revision Numbers // by using the '*' as shown below: // [assembly: AssemblyVersion("1.0.*")] [assembly: AssemblyVersion("1.0.

Make steps conditional in multi-stage YAML pipelines

To make the switch from the graphical release pipelines in Azure DevOps I am missing two features. The first one is to be able to defer a deploy and the second one is to exclude certain deployment steps without the need for editing the YAML file.  The defer option is something Microsoft has to solve in their Azure DevOps proposition. It's a feature which you have in the graphical release pipeline but what they have not implemented yet in their YAML pipeline replacement. Approvals and certain gate conditions are implemented on the environment but the defer option is still missing .  Pipeline The conditional deployment option can be implemented with the help of runtime parameters and expressions . In the parameter section you define boolean parameters which will control the deploy behavior. With the expressions you can control which stage/job/task should be executed when the pipeline runs. In the below YAML sample I experimented with conditions in the azure-pipelines.yml  file

Switch from Azure DevOps release pipeline to YAML based CI/CD pipeline

It has been years ago I started applying continuous integration (CI) and continuous deployment (CD) principles at work. Around 2005, it was the time of Visual Studio 2005 Team System, we started using a build server in our daily development process. From then on it was no longer more: "it works on my machine". With every check-in of code changes a CI build was started which compiled your code and run unit tests which verified the quality of your code.  Deployment was in the beginning still a process of manually copying build artifacts and script files to servers and doing the installation process based on the instructions from the deployment manual (if available). Gradually it migrated to scripts (mix of batch/PowerShell/VBScript files) that our release automatically ran from the build server. In 2016 we migrated from our on-premise TFS 2008 based environment to the cloud solution nowadays known as Azure DevOps . We upgraded our MSBuild driven CI/CD pipelines to the new vis