Invoke-Terraform.psm1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 |
Function Copy-TerraformBinary { param( [parameter(Mandatory)] [string]$ZipPath ) $installPath = (Get-TerraformConfiguration).TFPath if (-not (Test-Path $installPath -PathType Container)) { if (-not (New-Item -Path $installPath -ItemType 'directory')) { throw "Failed to create $($installPath) preference directory" } } $binary = 'terraform' if ($isWindows) { $binary += '.exe' } $binaryVersion = 'terraform_{0}' -f $TFVersion if ($IsWindows) { $binaryVersion += '.exe' } $destPath = (Join-Path $installPath $binaryVersion) $tmpPath = [System.IO.Path]::GetTempPath() [string] $guid = [System.Guid]::NewGuid() $tmpfolder = (Join-Path $tmpPath $guid) Expand-Archive -Path $zipPath -DestinationPath $tmpFolder Copy-Item -Path $tmpfolder/$binary -Destination $destPath -Force # TODO: Is Powershelly way? if (-not $IsWindows) { & chmod +x $destPath } } Function Get-TerraformBinary { param( [parameter(Mandatory)] [string]$TFVersion, [switch]$SkipChecksum = $False ) $platform = Get-TerraformPlatform $archiveName = 'terraform_{0}_{1}_amd64.zip' -f $TFVersion, $platform $zipUrl = '{0}/{1}/terraform_{1}_{2}_amd64.zip' -f (Get-TerraformConfiguration).ReleaseUrl, $TFVersion, $platform $shaUrl = '{0}/{1}/terraform_{1}_SHA256SUMS' -f (Get-TerraformConfiguration).ReleaseUrl, $TFVersion $shaSigUrl = '{0}/{1}/terraform_{1}_SHA256SUMS.sig' -f (Get-TerraformConfiguration).ReleaseUrl, $TFVersion $tmpPath = [System.IO.Path]::GetTempPath() [string] $guid = [System.Guid]::NewGuid() $zipPath = (Join-Path $tmpPath "$($guid).zip") $shaPath = (Join-Path $tmpPath "$($guid)_SHA256SUMS") $shaSigPath = (Join-Path $tmpPath "$($guid)_SHA256SUMS.sig") try { Invoke-WebRequest -Uri $zipUrl -OutFile $zipPath } catch { Write-Error "Unable to request $($zipUrl)" throw $_ } try { Invoke-WebRequest -Uri $shaUrl -OutFile $shaPath } catch { throw "Unable to request $($shaUrl)" } try { Invoke-WebRequest -Uri $shaSigUrl -OutFile $shaSigPath } catch { throw "Unable to request $($shaSigUrl)" } if ( -not (Test-TerraformArchiveChecksum -SkipChecksum:$SkipChecksum -ArchiveName $archiveName -ZipPath $zipPath -SHAPath $shaPath -SHASigPath $shaSigPath) ) { throw 'Terraform Archive failed Checksum test.' } return $zipPath } function Get-TerraformLatestRelease { $headers = @{ Accept = 'application/vnd.github.v3+json' } $response = Invoke-RestMethod 'https://api.github.com/repos/hashicorp/terraform/releases/latest' -Method 'GET' -Headers $headers $latest = $response.name.substring(1) return $latest } Function Get-TerraformPath { param( [parameter(Mandatory)] [string]$TFVersion ) if ($isWindows) { $fileExt = '.exe' } return Join-Path (Get-TerraformConfiguration).TFPath "terraform_$($TFVersion)$($fileExt)" } function Get-TerraformPlatform { if ($IsWindows) { return 'windows' } if ($IsLinux) { return 'linux' } if ($IsMacOS) { return 'darwin' } throw 'Unknown platform.' } Function Install-TerraformBinary { param( [parameter(Mandatory)] [string]$TFVersion, [switch]$SkipChecksum = $False, [switch]$SkipCodeSignature = $False ) $zipPath = Get-TerraformBinary -TFVersion $TFVersion -SkipChecksum:$SkipChecksum try { Copy-TerraformBinary -ZipPath $zipPath } catch { Write-Error "Unable to copy binary from $zipPath." throw $_ } if (-not (Test-TerraformPath -TFVersion $TFVersion)) { throw "Failed to install Terraform $($TFversion) binary." } if ( -not (Test-TerraformCodeSignature -TFVersion $TFVersion -SkipCodeSignature:$SkipCodeSignature)) { Uninstall-Terraform -TFVersion $TFVersion throw "Terraform $($TFversion) fail to pass Code Signature test. Uninstalling." } } function Test-TerraformArchiveChecksum { param ( [parameter(Mandatory)] [string]$ArchiveName, [parameter(Mandatory)] [string]$ZipPath, [parameter(Mandatory)] [string]$SHAPath, [parameter(Mandatory)] [string]$SHASigPath, [switch]$SkipChecksum = $False ) if ($SkipChecksum -or (Get-TerraformConfiguration).SkipChecksum) { Write-Verbose 'Skipping Terraform Archive Checksum test.' return $true } gpg --list-keys (Get-TerraformConfiguration).HashiCorpPGPKeyId # 2>&1 | Out-Null if ($LASTEXITCODE -ne 0) { gpg --quiet --keyserver (Get-TerraformConfiguration).PGPKeyServer --recv (Get-TerraformConfiguration).HashiCorpPGPKeyId if ($LASTEXITCODE -ne 0) { throw 'Unable to retrieve HashiCorp key' } } gpg --verify $SHASigPath $SHAPath if ($LASTEXITCODE -ne 0) { throw "Unable to verify signature on $($SHAPath)" } if (-not ((Get-TerraformConfiguration).SquelchChecksumWarning) -and ($output | Select-String 'WARNING: This key is not certified' -Quiet)) { Write-Warning @' The HashiCorp key has been installed but not certified. Run either of the following - Confirm-TerraformHashiCorpKey - Set-TerraformSquelchChecksumWarning $true '@ } $SHASum = (Get-FileHash $ZipPath).Hash $HashiCorpSHASum = (Get-Content $shaPath | Select-String $ArchiveName).ToString().Split()[0] if ($SHASum -ne $HashiCorpSHASum ) { throw "Unable to verify SHASUM with $($SHAPath)" } Write-Verbose "Terraform archive $($zipPath) passed checksum test" return $true } Function Test-TerraformCodeSignature { param( [parameter(Mandatory)] [string]$TFVersion, [switch]$SkipCodeSignature ) if ($SkipCodeSignature -or (Get-TerraformConfiguration).SkipCodeSignature) { Write-Verbose 'Skipping Code Signature test' return $true } if ($IsWindows) { # HashiCorp started signing with version 0.12.24 # TODO return true and throw a Warning $tfThumbprint = (Get-AuthenticodeSignature -FilePath (Get-TerraformPath -TFVersion $TFVersion)).SignerCertificate.Thumbprint return $tfthumbprint -eq (Get-TerraformConfiguration).HashiCorpWindowsThumbprint } if ($IsMacOs) { # $tfThumbprint = codesign --verify -d --verbose=2 (Get-TerraformPath -TFVersion $TFVersion) | Select-String TeamIdentifier).ToString().Split('=')[1] # return $tfthumbprint -eq (Get-TerraformConfiguration).HashiCorpTeamIdentifier codesign --verify -d --verbose=2 (Get-TerraformPath -TFVersion $TFVersion) return $LASTEXITCODE -eq 0 } if ($IsLinux) { Write-Verbose 'CodeSignature check at runtime is not supported on Linux.' return $true } Write-Error 'Unable to test terraform CodeSignature. Unknown platform.' throw $_ } Function Test-TerraformPath { param( [parameter(Mandatory)] [string]$TFVersion ) Write-Verbose "Testing path for Terraform version $($TFVersion) " return Test-Path (Get-TerraformPath -TFVersion $TFVersion) -PathType leaf } <# .SYNOPSIS Helper function to sign the Hashi Corp PHP key. .DESCRIPTION Helper function to sign the Hashi Corp PHP key. .EXAMPLE Confirm-TerraformHashicorpKey Runs gpg to sign a HasiCorp PGP key. .INPUTS None. You cannot pipe objects to Confirm-TerraformHashicorpKey. .OUTPUTS None. Confirm-TerraformHashicorpKey returns nothing. .LINK Online version: https://github.com/pearcec/Invoke-Terraform #> Function Confirm-TerraformHashicorpKey { & gpg --sign-key (Get-TerraformConfiguration).HashiCorpPGPKeyId } function Get-TerraformConfiguration { Import-Configuration } <# .SYNOPSIS Install a version of terraform. .DESCRIPTION Install a version of terraform. .PARAMETER TFVersion The version of terraform to install. .PARAMETER SkipChecksum Skip release archive checksum verification. .PARAMETER SkipCodeSignature Skip code signature verifcation. .EXAMPLE Install-Terraform -TFVersion 0.14.7 Installs terraform version 0.14.7 .INPUTS None. You cannot pipe objects to Install-Terraform. .OUTPUTS None. Install-Terraform returns nothing. .LINK Uninstall-Terraform .LINK Online version: https://github.com/pearcec/Invoke-Terraform #> Function Install-Terraform { param( [string]$TFVersion, [switch]$SkipChecksum = $False, [switch]$SkipCodeSignature = $False ) if (-not $TFVersion) { $TFVersion = Get-TerraformLatestRelease } if (Test-TerraformPath -TFVersion $TFVersion) { Write-Verbose "Terraform $($TFversion) already installed." return } Write-Verbose "Installing terraform version $($TFVersion)" Install-TerraformBinary -TFVersion $TFVersion -SkipChecksum:$SkipChecksum -SkipCodeSignature:$SkipCodeSignature } Function Invoke-Terraform { <# .SYNOPSIS Run terraform version based on user preference. .DESCRIPTION Run terraform version based on user preference. Additional parameters are passed to the terraform binary. .PARAMETER TFVersion Override preferred version of terraform to run. .PARAMETER SkipCodeSignature Skip code signature verifcation. .EXAMPLE Invoke-Terraform -TFVersion 0.14.7 Runs terraform version 0.14.7 .EXAMPLE Invoke-Terraform Runs terraform version based on user preference or default preference. .INPUTS None. You cannot pipe objects to Invoke-Terraform. .OUTPUTS None. Invoke-Terraform returns nothing. .LINK Install-Terraform .LINK Online version: https://github.com/pearcec/Invoke-Terraform #> param( [string]$TFVersion, [switch]$SkipCodeSignature = $False ) # HACK: # # Due to positional parameters the first unnamed parameter # is passed to $TFVersion. This catches non version parameters # intended to pass to the terraform run. if (-not ($TFVersion -match '^0\.\d\d?\.\d\d?$')) { # Build $TFargs and null $TFVersion for default preference $TFargs = @($TFVersion) + $args $TFVersion = $null } else { $TFArgs = $args } if ((Test-Path .terraform-version) -and (-not $TFVersion)) { $TFVersion = Get-Content .terraform-version # TODO regex validate the version Write-Verbose "Found .terraform-version $TFVersion" } # If Version still isn't set if (-not $TFVersion) { $TFVersion = (Get-TerraformConfiguration).TFVersion } if (-not (Test-TerraformPath -TFVersion $TFVersion)) { Write-Warning "Terraform version $($TFVersion) not found." if ((Get-TerraformConfiguration).AutoDownload) { Write-Verbose "Auto downloading terraform version $($TFVersion)" Install-Terraform -TFVersion $TFVersion } else { Write-Error @" Terraform version $($TFVersion) not installed. Run either - Install-Terraform -TFVersion $($TFVersion) - Set-TerraformAutoDownload `$true "@ throw '' } } if (-not (Test-TerraformCodeSignature -TFVersion $TFVersion -SkipCodeSignature:$SkipCodeSignature)) { throw 'Unable to confirm Code Signature of terraform binary' } & (Get-TerraformPath -TFVersion $TFVersion) $TFargs } Set-Alias -Name terraform -Value Invoke-Terraform <# .SYNOPSIS Set auto download configuration. .DESCRIPTION Set auto download configuration. .PARAMETER AutoDownload Either true or false. .EXAMPLE Set-TerraformAutoDownload $true Sets auto download configuration to true .INPUTS None. You cannot pipe objects to Set-TerraformAutoDownload. .OUTPUTS None. Set-TerraformAutoDownload returns nothing. .LINK Get-TerraformConfiguration .LINK Online version: https://github.com/pearcec/Invoke-Terraform #> function Set-TerraformAutoDownload { [cmdletbinding(SupportsShouldProcess, ConfirmImpact = 'High')] param( [parameter(Mandatory)] [boolean]$AutoDownload ) begin { Write-Debug -Message 'Beginning' $configurationPath = Get-ConfigurationPath } process { if ($PSCmdlet.ShouldProcess($configurationPath, "Setting AutoDownload configuration to $($AutoDownload)")) { Write-Verbose "Setting AutoDownload configuration to $($AutoDownload)" Set-TerraformConfiguration @{ AutoDownload = $AutoDownload } -Confirm:$False } } end { Write-Debug -Message 'Ending' } } function Set-TerraformConfiguration { [cmdletbinding(SupportsShouldProcess, ConfirmImpact = 'High')] param( [parameter(Mandatory)] [hashtable]$Configuration ) begin { Write-Debug -Message 'Beginning' $configurationPath = Get-ConfigurationPath } process { # Merge existing configuration with updates $existingConfiguration = Import-Configuration $existingConfiguration.keys | Where-Object { $_ -notin $Configuration.keys } | ForEach-Object { $Configuration.Add($_, $existingConfiguration.Item($_) ) } # Drop keys not defined by default configuration $remove = $Configuration.keys | Where-Object { $_ -notin $existingConfiguration.keys } $remove | ForEach-Object { $Configuration.Remove($_) } if ($PSCmdlet.ShouldProcess($configurationPath, "Setting Configuration configuration to $($Configuration | ConvertTo-Json -Depth 5)")) { Write-Verbose "Setting configuration to $($Configuration | ConvertTo-Json -Depth 5)" $Configuration | Export-Configuration } } end { Write-Debug -Message 'Ending' } } <# .SYNOPSIS Set squelch checksum warning configuration. .DESCRIPTION Set squelch checksum warning configuration. .PARAMETER SquelchChecksumWarning Either true or false. .EXAMPLE Set-TerraformSquelchChecksumWarning $true Set squelch checksum warning configuration to true .INPUTS None. You cannot pipe objects to Set-TerraformSquelchChecksumWarning. .OUTPUTS None. Set-TerraformSquelchChecksumWarningreturns nothing. .LINK Get-TerraformConfiguration .LINK Online version: https://github.com/pearcec/Invoke-Terraform #> function Set-TerraformSquelchChecksumWarning { [cmdletbinding(SupportsShouldProcess, ConfirmImpact = 'High')] param( [parameter(Mandatory)] [boolean]$SquelchChecksumWarning ) begin { Write-Debug -Message 'Beginning' $configurationPath = Get-ConfigurationPath } process { if ($PSCmdlet.ShouldProcess($configurationPath, "Setting SquelchChecksumWarning configuration to $($SquelchChecksumWarning)")) { Write-Verbose "Setting SquelchChecksumWarning configuration to $($SquelchChecksumWarning)" Set-TerraformConfiguration @{ SquelchChecksumWarning = $SquelchChecksumWarning } -Confirm:$False } } end { Write-Debug -Message 'Ending' } } <# .SYNOPSIS Set configuration version for terraform. .DESCRIPTION Set configuration version for terraform. .PARAMETER TFVersion The preferred version. .EXAMPLE Set-TerraformVersion -TFVersion 0.14.7 Sets configuration version for terraform to 0.14.7 .INPUTS None. You cannot pipe objects to Set-TerraformVersion. .OUTPUTS None. Set-TerraformVersion returns nothing. .LINK Get-TerraformConfiguration .LINK Online version: https://github.com/pearcec/Invoke-Terraform #> Function Set-TerraformVersion { [cmdletbinding(SupportsShouldProcess, ConfirmImpact = 'High')] param( [parameter(Mandatory)] [string]$TFVersion ) begin { Write-Debug -Message 'Beginning' $configurationPath = Get-ConfigurationPath } process { if ($PSCmdlet.ShouldProcess($configurationPath, "Setting TFVesion configuration version to $($TFVersion)")) { Write-Verbose "Setting TFVersion configuration version to $($TFVersion)" Set-TerraformConfiguration @{ TFVersion = $TfVersion } -Confirm:$False } } end { Write-Debug -Message 'Ending' } } Set-Alias -Name Switch-Terraform -Value Set-TerraformVersion <# .SYNOPSIS Uninstall a version of terraform. .DESCRIPTION Unnstall a version of terraform. .PARAMETER TFVersion The version of terraform to uninstall. .EXAMPLE Uninstall-Terraform -TFVersion 0.14.7 Uninstalls terraform version 0.14.7 .INPUTS None. You cannot pipe objects to Uninstall-Terraform. .OUTPUTS None. Uninstall-Terraform returns nothing. .LINK Install-Terraform .LINK Online version: https://github.com/pearcec/Invoke-Terraform #> Function Uninstall-Terraform { param( [parameter(Mandatory)] [string]$TFVersion ) if (Test-TerraformPath -TFVersion $TFVersion) { Write-Verbose "Uninstalling terraform version $($TFVersion)" Remove-Item (Get-TerraformPath -TFVersion $TFVersion) -Force } else { Write-Warning "Unable to uninstall terraform. Version ($TFVersion) not found." } } $PSDefaultParameterValues = @{ 'Invoke-WebRequest:Verbose' = $false 'Invoke-WebRequest:Debug' = $false } $ProgressPreference = 'SilentlyContinue' |