FunctionAppDeploymentTools.psm1
|
$script:ModuleRoot = $PSScriptRoot $script:ModuleVersion = (Import-PowerShellDataFile -Path "$($script:ModuleRoot)\FunctionAppDeploymentTools.psd1").ModuleVersion # Detect whether at some level dotsourcing was enforced $script:doDotSource = Get-PSFConfigValue -FullName FunctionAppDeploymentTools.Import.DoDotSource -Fallback $false if ($FunctionAppDeploymentTools_dotsourcemodule) { $script:doDotSource = $true } <# Note on Resolve-Path: All paths are sent through Resolve-Path/Resolve-PSFPath in order to convert them to the correct path separator. This allows ignoring path separators throughout the import sequence, which could otherwise cause trouble depending on OS. Resolve-Path can only be used for paths that already exist, Resolve-PSFPath can accept that the last leaf my not exist. This is important when testing for paths. #> # Detect whether at some level loading individual module files, rather than the compiled module was enforced $importIndividualFiles = Get-PSFConfigValue -FullName FunctionAppDeploymentTools.Import.IndividualFiles -Fallback $false if ($FunctionAppDeploymentTools_importIndividualFiles) { $importIndividualFiles = $true } if (Test-Path (Resolve-PSFPath -Path "$($script:ModuleRoot)\..\.git" -SingleItem -NewChild)) { $importIndividualFiles = $true } if ("<was compiled>" -eq '<was not compiled>') { $importIndividualFiles = $true } function Import-ModuleFile { <# .SYNOPSIS Loads files into the module on module import. .DESCRIPTION This helper function is used during module initialization. It should always be dotsourced itself, in order to proper function. This provides a central location to react to files being imported, if later desired .PARAMETER Path The path to the file to load .EXAMPLE PS C:\> . Import-ModuleFile -File $function.FullName Imports the file stored in $function according to import policy #> [CmdletBinding()] Param ( [string] $Path ) $resolvedPath = $ExecutionContext.SessionState.Path.GetResolvedPSPathFromPSPath($Path).ProviderPath if ($doDotSource) { . $resolvedPath } else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText($resolvedPath))), $null, $null) } } #region Load individual files if ($importIndividualFiles) { # Execute Preimport actions foreach ($path in (& "$ModuleRoot\internal\scripts\preimport.ps1")) { . Import-ModuleFile -Path $path } # Import all internal functions foreach ($function in (Get-ChildItem "$ModuleRoot\internal\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Import all public functions foreach ($function in (Get-ChildItem "$ModuleRoot\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Execute Postimport actions foreach ($path in (& "$ModuleRoot\internal\scripts\postimport.ps1")) { . Import-ModuleFile -Path $path } # End it here, do not load compiled code below return } #endregion Load individual files #region Load compiled code <# This file loads the strings documents from the respective language folders. This allows localizing messages and errors. Load psd1 language files for each language you wish to support. Partial translations are acceptable - when missing a current language message, it will fallback to English or another available language. #> Import-PSFLocalizedString -Path "$($script:ModuleRoot)\en-us\*.psd1" -Module 'FunctionAppDeploymentTools' -Language 'en-US' function Get-FDKeyVaultCertificate { <# .SYNOPSIS Retrieve the certificate from an Azure KeyVault .DESCRIPTION Retrieve the certificate from an Azure KeyVault Returns the certificate object as consumed by PowerShell. Supports retrieving either only the public key or both public and private. In opposite to the native KeyVault commands, it does not return any KV metadata. .PARAMETER VaultName Name of the KeyyVault to access. .PARAMETER Name Name of the certificate to access. .PARAMETER PrivateKey Include the private key in the certificate retrieved. .PARAMETER WhatIf if this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run. .PARAMETER Confirm If this switch is enabled, you will be prompted for confirmation before executing any operations that change state. .EXAMPLE PS C:\> Get-FDKeyVault -VaultName 'myVault' -Name 'myCert' Retrieve the public version of the 'myCert' certificate from vault 'myVault' .EXAMPLE PS C:\> Get-FDKeyVault -VaultName 'myVault' -Name 'myCert' -PrivateKey Retrieve both the public & private key of the 'myCert' certificate from vault 'myVault' #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '')] [OutputType([System.Security.Cryptography.X509Certificates.X509Certificate2])] [CmdletBinding(SupportsShouldProcess = $true)] Param ( [Parameter(Mandatory = $true)] [string] $VaultName, [Parameter(Mandatory = $true)] [string] $Name, [switch] $PrivateKey ) process { if ($PrivateKey) { Invoke-PSFProtectedCommand -ActionString 'Get-FDKeyVaultCertificate.Retrieving.Secret' -ActionStringValues $VaultName, $Name -Target $Name -ScriptBlock { $secret = Get-AzKeyVaultSecret -VaultName $VaultName -Name $Name -ErrorAction Stop } -EnableException $true -PSCmdlet $PSCmdlet $certString = [PSCredential]::New("irrelevant", $secret.SecretValue).GetNetworkCredential().Password $bytes = [convert]::FromBase64String($certString) [System.Security.Cryptography.X509Certificates.X509Certificate2]::new($bytes, "", "Exportable,PersistKeySet") } else { Invoke-PSFProtectedCommand -ActionString 'Get-FDKeyVaultCertificate.Retrieving.Public' -ActionStringValues $VaultName, $Name -Target $Name -ScriptBlock { $cert = Get-AzKeyVaultCertificate -VaultName $VaultName -Name $Name -ErrorAction Stop } -EnableException $true -PSCmdlet $PSCmdlett $cert.Certificate } } } function Save-FDKeyVaultCertificate { <# .SYNOPSIS Exports a certificate from Azure KeyVault and stores it in file. .DESCRIPTION Exports a certificate from Azure KeyVault and stores it in file. Supports retrieving the secret information in different format: - Public key information only (.cer) - Encrypted private key information (.pfx) - Unencrypted private key information (.pem) The format is chosen based on the file extension selected for the output file. To save as pfx certificate, specifying a passsword is required. .PARAMETER VaultName Name of the Key Vault to access. .PARAMETER Name Name of the Certificate to save to file. .PARAMETER Path The path to write the certificate to. Include the filename and extension, the extension will determine thee data format retrieved. Supported extensions: .cer, .pfx, .pem .PARAMETER Password The password to protect the certificate with. Only applies to pfx certificates .PARAMETER WhatIf if this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run. .PARAMETER Confirm If this switch is enabled, you will be prompted for confirmation before executing any operations that change state. .EXAMPLE PS C:\> Save-FDKeyVaultCertificate -VaultName myVault -Name myCert -Path .\cert.cer Saves the public key information of the "myCert" certificate in vault "myVault" to the file "cert.cer" in the current folder. .EXAMPLE PS C:\> Save-FDKeyVaultCertificate -VaultName myVault -Name myCert -Path .\cert.pfx -Password (Read-Host -AsSecureString) Saves the "myCert" certificate in vault "myVault" to the file "cert.pfx" in the current folder, protected by the specified password. .EXAMPLE PS C:\> Save-FDKeyVaultCertificate -VaultName myVault -Name myCert -Path .\cert.pem Saves the unencrypted private key information of the "myCert" certificate in vault "myVault" to the file "cert.pem" in the current folder. #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '')] [CmdletBinding(SupportsShouldProcess = $true)] Param ( [Parameter(Mandatory = $true)] [string] $VaultName, [Parameter(Mandatory = $true)] [string] $Name, [Parameter(Mandatory = $true)] [PsfValidateScript('PSFramework.Validate.FSPath.FileOrParent', ErrorString = 'PSFramework.Validate.FSPath.FileOrParent')] [string] $Path, [securestring] $Password ) begin { $outPath = Resolve-PSFPath -Path $Path -Provider FileSystem -NewChild -SingleItem $type = ($outPath -split "\.")[-1] } process { switch ($type) { #region PFX 'pfx' { if (-not $Password) { Stop-PSFFunction -String 'Save-FDKeyVaultCertificate.Error.NoPassword' -Cmdlet $PSCmdlet -EnableException $true } Invoke-PSFProtectedCommand -ActionString 'Save-FDKeyVaultCertificate.Retrieving.Secret' -ActionStringValues $VaultName, $Name -Target $Name -ScriptBlock { $secret = Get-AzKeyVaultSecret -VaultName $VaultName -Name $Name -ErrorAction Stop } -EnableException $true -PSCmdlet $PSCmdlet $certString = [PSCredential]::New("irrelevant", $secret.SecretValue).GetNetworkCredential().Password $bytes = [convert]::FromBase64String($certString) $cert = [System.Security.Cryptography.X509Certificates.X509Certificate2]::new($bytes, "", "Exportable,PersistKeySet") $newBytes = $cert.Export([System.Security.Cryptography.X509Certificates.X509ContentType]::Pfx, $Password) [System.IO.File]::WriteAllBytes($outPath, $newBytes) } #endregion PFX #region PEM 'pem' { Invoke-PSFProtectedCommand -ActionString 'Save-FDKeyVaultCertificate.Retrieving.Secret' -ActionStringValues $VaultName, $Name -Target $Name -ScriptBlock { $secret = Get-AzKeyVaultSecret -VaultName $VaultName -Name $Name -ErrorAction Stop } -EnableException $true -PSCmdlet $PSCmdlet $certString = [PSCredential]::New("irrelevant", $secret.SecretValue).GetNetworkCredential().Password $bytes = [convert]::FromBase64String($certString) $cert = [System.Security.Cryptography.X509Certificates.X509Certificate2]::new($bytes, "", "Exportable,PersistKeySet") $certificatePem = [System.Security.Cryptography.PemEncoding]::Write("CERTIFICATE", $cert.RawData) -join "" $key = [System.Security.Cryptography.X509Certificates.RSACertificateExtensions]::GetRSAPrivateKey($cert) $pubKeyPem = [System.Security.Cryptography.PemEncoding]::Write("PUBLIC KEY", $key.ExportSubjectPublicKeyInfo()) -join "" $privKeyPem = [System.Security.Cryptography.PemEncoding]::Write("PRIVATE KEY", $key.ExportPkcs8PrivateKey()) -join "" $certString = $certificatePem, $pubKeyPem, $privKeyPem -join "`n`n" $encoding = [System.Text.UTF8Encoding]::new($false) [System.IO.File]::WriteAllText($outPath, $certString, $encoding) } #endregion PEM #region CER 'cer' { Invoke-PSFProtectedCommand -ActionString 'Save-FDKeyVaultCertificate.Retrieving.Public' -ActionStringValues $VaultName, $Name -Target $Name -ScriptBlock { $cert = Get-AzKeyVaultCertificate -VaultName $VaultName -Name $Name -ErrorAction Stop } -EnableException $true -PSCmdlet $PSCmdlet $bytes = $cert.Certificate.GetRawCertData() [System.IO.File]::WriteAllBytes($outPath, $bytes) } #endregion CER default { Stop-PSFFunction -String 'Save-FDKeyVaultCertificate.Error.UnknownExtension' -StringValues $type, $outPath -Cmdlet $PSCmdlet -EnableException $true } } } } <# This is an example configuration file By default, it is enough to have a single one of them, however if you have enough configuration settings to justify having multiple copies of it, feel totally free to split them into multiple files. #> <# # Example Configuration Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Example.Setting' -Value 10 -Initialize -Validation 'integer' -Handler { } -Description "Example configuration setting. Your module can then use the setting using 'Get-PSFConfigValue'" #> Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Import.DoDotSource' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be dotsourced on import. By default, the files of this module are read as string value and invoked, which is faster but worse on debugging." Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Import.IndividualFiles' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be imported individually. During the module build, all module code is compiled into few files, which are imported instead by default. Loading the compiled versions is faster, using the individual files is easier for debugging and testing out adjustments." Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Default.Location' -Value 'eastus' -Initialize -Validation string -Description 'Default location to deploy resources to.' Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Default.StorageAccount.SKU' -Value 'Standard_LRS' -Initialize -Validation string -Description '' Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Default.StorageAccount.Kind' -Value 'Storage' -Initialize -Validation string -Description '' Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Naming.ResourceGroup.Pattern' -Value '' -Initialize -Validation string -Description '' Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Naming.ResourceGroup.Default' -Value '{0}' -Initialize -Validation string -Description '' Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Naming.FunctionApp.Pattern' -Value '' -Initialize -Validation string -Description '' Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Naming.FunctionApp.Default' -Value '{0}' -Initialize -Validation string -Description '' Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Naming.KeyVault.Pattern' -Value '' -Initialize -Validation string -Description '' Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Naming.KeyVault.Default' -Value '{0}' -Initialize -Validation string -Description '' Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Naming.StorageAccount.Pattern' -Value '' -Initialize -Validation string -Description '' Set-PSFConfig -Module 'FunctionAppDeploymentTools' -Name 'Naming.StorageAccount.Default' -Value '{0}' -Initialize -Validation string -Description '' <# Stored scriptblocks are available in [PsfValidateScript()] attributes. This makes it easier to centrally provide the same scriptblock multiple times, without having to maintain it in separate locations. It also prevents lengthy validation scriptblocks from making your parameter block hard to read. Set-PSFScriptblock -Name 'FunctionAppDeploymentTools.ScriptBlockName' -Scriptblock { } #> <# # Example: Register-PSFTeppScriptblock -Name "FunctionAppDeploymentTools.alcohol" -ScriptBlock { 'Beer','Mead','Whiskey','Wine','Vodka','Rum (3y)', 'Rum (5y)', 'Rum (7y)' } #> <# # Example: Register-PSFTeppArgumentCompleter -Command Get-Alcohol -Parameter Type -Name FunctionAppDeploymentTools.alcohol #> New-PSFLicense -Product 'FunctionAppDeploymentTools' -Manufacturer 'Friedrich Weinmann' -ProductVersion $script:ModuleVersion -ProductType Module -Name MIT -Version "1.0.0.0" -Date (Get-Date "2022-02-24") -Text @" Copyright (c) 2022 Friedrich Weinmann Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. "@ #endregion Load compiled code |