maintenance.psm1
|
# Helper function Test-SupportForClusterPatch { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } $local:IsReplica = (Get-SafeguardStatus -Appliance $Appliance -Insecure:$Insecure).IsReplica if ($local:IsReplica) { $false return; } $local:ApplianceVersion = (Get-SafeguardVersion -Appliance $Appliance -Insecure:$Insecure) if ($local:ApplianceVersion.Major -gt 2 -or ($local:ApplianceVersion.Major -eq 2 -and $local:ApplianceVersion.Minor -gt 0)) { $true } else { $false } } function Add-SendFileStreamCmdletType { [CmdletBinding()] Param( ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (-not ([System.Management.Automation.PSTypeName]"SendFileStreamCmdlet").Type) { Write-Verbose "Adding the PSType for uploading a file stream" # For PowerShell 7, the default behavior is to not include the default assemblies when the # -ReferencedAssemblies parameter is explicitly specified. Therefore, we must be sure to # include them ourselves along with anything else we need. When running on Linux, the # TransportContext and X509Certificate2 object types are in separate assemblies, different # from how they are on Windows. So we need to explicitly include/specify those additional # assemblies. Which then means, to maintain compatibility with all versions of PowerShell, # we also need to explicitly specify what are typically the default assemblies that are # automatically included. # Fortunately, having them as always included doesn't appear to have any ill side effects # when running on Windows. $referenceAssemblies = ("System.dll", "System.Management.Automation.dll", "System.Net.Http.dll", "System.Net.Primitives", "System.Security.Cryptography.X509Certificates.dll") # Use the PassThru parameter to return the type that gets generated so we can assign it to # a variable and access it next in order to load/import it, making it available directly in # the PowerShell script, usable/callable like any other Cmdlet. $cls = Add-Type -PassThru -ReferencedAssemblies $referenceAssemblies -TypeDefinition @" using System; using System.IO; using System.Management.Automation; using System.Net; using System.Net.Http; using System.Net.Security; using System.Security.Cryptography.X509Certificates; using System.Threading.Tasks; // Implement a Cmdlet type so we can utilize the WriteProgress() method and get PowerShell's native // progress bar overlayed while uploading. Using Console.Write() and trying to manually move/set // the cursor position doesn't work in the PowerShell ISE, nor on Linux. // // Also unfortunate is the fact that on Linux, the HttpWebRequest.AllowWriteStreamBuffering cannot // be set to false. https://github.com/dotnet/runtime/issues/18632 // With .NET Core (whoes source code is now under .NET Rumtime) on Linux, the HttpWebRequest actually // uses the HttpClient under the hood (with the .NET Framewrok it's the other way around). // https://github.com/dotnet/runtime/blob/master/src/libraries/System.Net.Requests/src/System/Net/HttpWebRequest.cs // And when getting the request stream (see the InternalGetRequestStream() method), it simply creates // a new instance of the RequestStream object // https://github.com/dotnet/runtime/blob/b783c5b42b3d35ef793a9d7aa8c06bcc27567e8d/src/libraries/System.Net.Requests/src/System/Net/RequestStream.cs // Which states in the comments the use of a MemoryStream and it being inefficient for uploading // large amounts of data. There is no way to change this or override it. // // Therefore, we'd be back to the same original problem that made us switch to this embedded code // in the first place, namely, uploading a patch file would use as much memory as the size of the file. // // So the next hurdle is switching to use the HttpClient class. But with that, there was no native // support for being able to compute the progress while uploading. So we had to implement another // custom class. Then, there was a problem with trying to use the WriteProgress() method from outside // the ProcessRecord() method of the Cmdlet and making any async calls synchronous to ensure that we // stay on the same thread. [Cmdlet("Send", "FileStream")] public class SendFileStreamCmdlet : PSCmdlet { [Parameter(Mandatory = true, Position = 0)] public string PathAndFilename { get; set; } [Parameter(Mandatory = true, Position = 1)] public string Appliance { get; set; } [Parameter(Mandatory = true, Position = 2)] public string AuthorizationToken { get; set; } [Parameter(Mandatory = true, Position = 3)] public string Version { get; set; } [Parameter(Mandatory = true, Position = 4)] public bool Insecure { get; set; } private static readonly HttpClientHandler httpClientHandler = new HttpClientHandler() { ClientCertificateOptions = ClientCertificateOption.Manual }; private static readonly HttpClient httpClient = new HttpClient(httpClientHandler); private static bool insecurePerRequest = false; private class ProgressStreamContent : HttpContent { private FileStream content = null; private PSCmdlet cmdlet = null; private readonly byte[] UploadBuffer = new byte[80 * 1024]; public ProgressStreamContent(FileStream content, PSCmdlet cmdlet) { this.content = content; this.cmdlet = cmdlet; } protected override Task SerializeToStreamAsync(Stream stream, TransportContext context) { ProgressRecord progressRecord = new ProgressRecord(1, "Uploading Patch", "0% Complete"); cmdlet.Host.UI.WriteProgress(1, progressRecord); long bytesLeft = this.content.Length; System.Diagnostics.Stopwatch stopwatch = System.Diagnostics.Stopwatch.StartNew(); while (bytesLeft > 0) { int bytesRead = this.content.Read(UploadBuffer, 0, UploadBuffer.Length); stream.Write(UploadBuffer, 0, bytesRead); bytesLeft -= bytesRead; if (stopwatch.ElapsedMilliseconds > 1000) { int percentDone = (int)((this.content.Length - bytesLeft) / (double)this.content.Length * 100); progressRecord.StatusDescription = string.Format("{0}% Complete", percentDone); progressRecord.PercentComplete = percentDone; cmdlet.Host.UI.WriteProgress(1, progressRecord); stopwatch.Restart(); } } progressRecord.StatusDescription = "100% Complete"; progressRecord.PercentComplete = 100; progressRecord.RecordType = ProgressRecordType.Completed; cmdlet.Host.UI.WriteProgress(1, progressRecord); cmdlet.Host.UI.WriteLine("Upload complete. Server is processing data. Waiting for response..."); return Task.WhenAll(); // Returns a completed task. Compatible with .NET < 4.6. } protected override bool TryComputeLength(out long length) { length = this.content.Length; return true; } } private static bool ServerCertificateCustomValidation(HttpRequestMessage requestMessage, X509Certificate2 certificate, X509Chain chain, SslPolicyErrors sslErrors) { if (insecurePerRequest) { return true; } return sslErrors == SslPolicyErrors.None; } protected override void ProcessRecord() { try { // The SSL and Timeout are not per-request settings. Fortunately, this will most likely // only be used in a single threaded environment. The Timeout property can only be set // before a request is made. Once a request is made, we can't attempt to set it again. // Because we have a static instance, it means we can only set it once. if (httpClient.Timeout != System.Threading.Timeout.InfiniteTimeSpan) { httpClient.Timeout = System.Threading.Timeout.InfiniteTimeSpan; } // These SSL settings also can't be changed after a request is made. Therefore, we will // always configure it for manual validation and provide our own callback handler so that // we can dynamically decide what to do. Problem is, we have a static instance and static // callback method, but need to access the Insecure instance parameter for each call. // // We need to handle the use case of connecting to 2 different servers, over the course // of 2 sessions (Connect-Safeguard/Disconnect-Safeguard), where one connection is made // securely and the other is not. Noting the fact that this embedded type is only loaded // once and that the 'httpClientHandler' is a static instance. So this lambda is only // assigned once, but we need to account for the Insecure parameter on a call-by-call // basis. So again, this is a bit of a hack and we rely upon the fact that this will most // likely only be used in a single threaded environment. Therefore, we will set a static // variable on each request that can then be accessed by our static callback method. if (httpClientHandler.ServerCertificateCustomValidationCallback == null) { httpClientHandler.ServerCertificateCustomValidationCallback = ServerCertificateCustomValidation; } insecurePerRequest = Insecure; using (FileStream stream = new FileStream(PathAndFilename, FileMode.Open, FileAccess.Read, FileShare.ReadWrite)) using (HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, string.Format("https://{0}/service/appliance/v{1}/Patch", Appliance, Version))) { this.Host.UI.WriteLine("Uploading..."); request.Headers.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", AuthorizationToken); request.Headers.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json")); request.Content = new ProgressStreamContent(stream, this); var response = httpClient.SendAsync(request).GetAwaiter().GetResult(); // Any response we get back, we will attempt to parse as Json. So we're not concerned with // the HTTP status code. If the response cannot be parsed as Json, the script will fail and // output the raw response for debugging purposes. WriteObject(response.Content.ReadAsStringAsync().GetAwaiter().GetResult()); } } catch (Exception ex) { WriteObject(ex.ToString()); } } } "@ # Import the dynamically generated assembly like it were any other PowerShell script and # we'll be able to call it like regular PowerShell too. Import-Module $cls.Assembly } } function Send-PatchFile { [CmdletBinding()] Param( [Parameter(Mandatory=$true)] [string]$Patch, [Parameter(Mandatory=$true)] [string]$Appliance, [Parameter(Mandatory=$true)] [object]$AccessToken, [Parameter(Mandatory=$true)] [int]$Version, [Parameter(Mandatory=$false)] [switch]$Insecure ) try { Import-Module -Name "$PSScriptRoot\sslhandling.psm1" -Scope Local Edit-SslVersionSupport if ($Insecure) { Disable-SslVerification if ($global:PSDefaultParameterValues) { $PSDefaultParameterValues = $global:PSDefaultParameterValues.Clone() } } Add-SendFileStreamCmdletType $local:JsonData = Send-FileStream (Resolve-Path $Patch) $Appliance $AccessToken $Version $Insecure.IsPresent try { $local:JsonData = (ConvertFrom-Json $local:JsonData) Write-Verbose (ConvertTo-Json $local:JsonData) } catch { throw "Send-FileStream didn't return valid JSON. Cannot continue.`nOutput:`n$local:JsonData" } if ($local:JsonData.Code) { $local:ErrMsg = "$($local:JsonData.Code): $($local:JsonData.Message)" throw $local:ErrMsg } # For Safeguard version 6.0 and greater, some precondition checks/errors are returned immediately. # We can try and look for them now, and if there are any, there is no need to continue. if ($local:JsonData.Errors) { Write-Host "There are one or more precondition patch errors. The patch cannot be applied." for ($num = 0; $num -lt $local:JsonData.Errors.Count; $num++) { Write-Host -ForegroundColor Magenta "$($num + 1). $($local:JsonData.Errors[$num])`n" } return $false } return $true } catch [System.Exception] { Import-Module -Name "$PSScriptRoot\sg-utilities.psm1" -Scope Local Out-SafeguardExceptionIfPossible $_ } finally { if ($Insecure) { Enable-SslVerification if ($global:PSDefaultParameterValues) { $PSDefaultParameterValues = $global:PSDefaultParameterValues.Clone() } } } } <# .SYNOPSIS Get the current status of Safeguard appliance via the Web API. .DESCRIPTION Get the current status of Safeguard appliance which will include version information, current state, previous state, maintenance status, cluster status, and primary appliance IP address. This cmdlet is DEPRECATED. Use Get-SafeguardApplianceAvailability instead. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardStatus .EXAMPLE Get-SafeguardStatus -Appliance 10.5.32.54 -Insecure #> function Get-SafeguardStatus { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } # Remove the IsClustered property since it is deprecated and inaccurate Invoke-SafeguardMethod -Anonymous -Appliance $Appliance -Insecure:$Insecure Notification GET Status | Select-Object -Property * -ExcludeProperty IsClustered } <# .SYNOPSIS Get the current availability of Safeguard appliance via the Web API. .DESCRIPTION Get the current availability of Safeguard appliance which will include version information, current state, previous state, maintenance status, cluster status, and primary appliance IP address. It will also give the availability of individual services from this appliance such as password or session requests, password check/change management, policy/configuration changes, etc. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardApplianceAvailability .EXAMPLE Get-SafeguardApplianceAvailability -Appliance 10.5.32.54 -Insecure #> function Get-SafeguardApplianceAvailability { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Invoke-SafeguardMethod -Anonymous -Appliance $Appliance -Insecure:$Insecure Notification GET "Status/Availability" } <# .SYNOPSIS Wait for the Safeguard appliance to be Online via the Web API. .DESCRIPTION Get the current availability of Safeguard appliance and wait for it to report Online. Once the appliance is online, the output will also give the availability of individual services from this appliance such as password or session requests, password check/change management, policy/configuration changes, etc. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .PARAMETER Timeout Number of seconds to wait before timing out (Default: 30 minutes) .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Wait-SafeguardApplianceStateOnline .EXAMPLE Wait-SafeguardApplianceStateOnline -Appliance 10.5.32.54 -Insecure #> function Wait-SafeguardApplianceStateOnline { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false)] [int]$Timeout = 1800 ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Import-Module -Name "$PSScriptRoot\sg-utilities.psm1" -Scope Local Wait-ForSafeguardOnlineStatus -Appliance $Appliance -Insecure:$Insecure -Timeout $Timeout Get-SafeguardApplianceAvailability -Appliance $Appliance -Insecure:$Insecure } <# .SYNOPSIS Get the current state of Safeguard appliance via the Web API. .DESCRIPTION This cmdlet only returns this appliance's state via the Web API. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardApplianceState .EXAMPLE Get-SafeguardApplianceState -Appliance 10.5.32.54 -Insecure #> function Get-SafeguardApplianceState { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Invoke-SafeguardMethod -Anonymous -Appliance $Appliance -Insecure:$Insecure Notification GET "Status/State" } <# .SYNOPSIS Get the version of a Safeguard appliance via the Web API. .DESCRIPTION Get the version information from a Safeguard appliance which will be returned as an object containing major.minor.revision.build portions separated into different properties. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardVersion .EXAMPLE Get-SafeguardVersion -Appliance 10.5.32.54 -Insecure #> function Get-SafeguardVersion { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Invoke-SafeguardMethod -Anonymous -Appliance $Appliance -Insecure:$Insecure Appliance GET Version } <# .SYNOPSIS Test whether the version of a Safeguard appliance is greater than or equal to a minimum version via the Web API. .DESCRIPTION Get the version information from a Safeguard appliance and compare whether it is greater than or equal to a minimum version provided as a string in x.y format. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .PARAMETER MinVersion A string containing the desired minimum major and minor version in x.y format. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Test-SafeguardVersion 2.3 .EXAMPLE Test-SafeguardVersion -Appliance 10.5.32.54 -Insecure 2.6 #> function Test-SafeguardVersion { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$true,Position=0)] [ValidatePattern("^\d+\.\d+$")] [string]$MinVersion ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Import-Module -Name "$PSScriptRoot\sg-utilities.psm1" -Scope Local Test-SafeguardMinVersionInternal -Appliance $Appliance -Insecure:$Insecure -MinVersion $MinVersion } <# .SYNOPSIS Get the system verification information on a Safeguard appliance via the Web API. .DESCRIPTION System verification information about a Safeguard appliance used during manufacturing. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardApplianceVerification .EXAMPLE Get-SafeguardApplianceVerification -Appliance 10.5.32.54 -Insecure #> function Get-SafeguardApplianceVerification { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Invoke-SafeguardMethod -Anonymous -Appliance $Appliance -Insecure:$Insecure Notification GET SystemVerification/Manufacturing } <# .SYNOPSIS Get the current time on a Safeguard appliance via the Web API. .DESCRIPTION Get the current time on a Safeguard appliance which will be returned in UTC format, e.g. 2017-09-07T19:11:37.2995203Z .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardTime .EXAMPLE Get-SafeguardTime -Appliance 10.5.32.54 -Insecure #> function Get-SafeguardTime { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Invoke-SafeguardMethod -Anonymous -Appliance $Appliance -Insecure:$Insecure Appliance GET SystemTime } <# .SYNOPSIS Set the time on a Safeguard appliance via the Web API. .DESCRIPTION Set the current time on a Safeguard appliance. If you don't specify a time, then the current time on your client computer will be used. When you specify a time, you can do it in local time and this cmdlet will convert it to UTC before calling the Safeguard API. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER SystemTime The time in UTC to set to the appliance, when omitted the current time of your client machine is used. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Set-SafeguardTime .EXAMPLE Set-SafeguardTime -SystemTime "2019-09-24T21:10:06.1911657Z" #> function Set-SafeguardTime { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [DateTime]$SystemTime ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (-not $PSBoundParameters.ContainsKey("SystemTime")) { $local:SystemTimeString = (Get-Date).ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ss.fffZ") } else { $local:SystemTimeString = $SystemTime.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ss.fffZ") } Import-Module -Name "$PSScriptRoot\ps-utilities.psm1" -Scope Local Write-Host -ForegroundColor Magenta "Setting the UTC time of the Safeguard appliance to: $($local:SystemTimeString)" Write-Host -ForegroundColor Yellow "WARNING: Setting the wrong time can break a Safeguard appliance." $local:Confirmed = (Get-Confirmation "Set Safeguard Time" "Are you sure you want to set the time on this Safeguard appliance?" ` "Set the time." "Cancels this operation.") if ($local:Confirmed) { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance PUT SystemTime -Body @{ CurrentTime = $local:SystemTimeString } Write-Host -ForegroundColor Yellow "Depending on the time change, you may need to log in again." } } <# .SYNOPSIS Get the current uptime on a Safeguard appliance via the Web API. .DESCRIPTION Get the current uptime on a Safeguard appliance which will be returned as an object with days, hours, minutes, seconds, total seconds, and composite string. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardApplianceUptime .EXAMPLE Get-SafeguardApplianceUptime -Appliance 10.5.32.54 -Insecure #> function Get-SafeguardApplianceUptime { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } $local:Os = (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance GET OperatingSystem) $local:Ts = [timespan]::FromSeconds($local:Os.UptimeInSeconds) New-Object -TypeName PSObject -Property @{ TotalSeconds = $local:Ts.TotalSeconds; Days = $local:Ts.Days; Hours = $local:Ts.Hours; Minutes = $local:Ts.Minutes; Seconds = $local:Ts.Seconds; Value = $local:Ts.ToString("c") } } <# .SYNOPSIS Get the current health of Safeguard appliance via the Web API. .DESCRIPTION Get the current health of Safeguard appliance which will include several components: AuditLog, ClusterCommunication, ClusterConnectivity, AccessWorkflow, PolicyData. Additional information is provided about NetworkInformation, ResourceUsage, Uptime, Version, and ApplianceState. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER ForceUpdate Force health checks to run and wait to get up-to-date information. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardHealth .EXAMPLE Get-SafeguardHealth -Appliance 10.5.32.54 -AccessToken $token -Insecure #> function Get-SafeguardHealth { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false)] [switch]$ForceUpdate ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if ($ForceUpdate) { (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET "Cluster/Members/Self").Health } else { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance GET ApplianceStatus/Health } } <# .SYNOPSIS Get user-defined name of a Safeguard appliance via the Web API. .DESCRIPTION Get user-defined name of a Safeguard appliance. This name can be specified using the Set-SafeguardApplianceName cmdlet. Each appliance in a cluster can have a unique name. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardApplianceName .EXAMPLE Get-SafeguardApplianceName -Appliance 10.5.32.54 -Insecure #> function Get-SafeguardApplianceName { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } (Invoke-SafeguardMethod -Anonymous -Appliance $Appliance -Insecure:$Insecure Notification GET Status).ApplianceName } <# .SYNOPSIS Set user-defined name of a Safeguard appliance via the Web API. .DESCRIPTION Set user-defined name of a Safeguard appliance. Each appliance in a cluster can have a unique name. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .PARAMETER Name A string containing the name to give the appliance. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Set-SafeguardApplianceName node1 #> function Set-SafeguardApplianceName { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$true,Position=0)] [string]$Name ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance PUT ApplianceStatus/Name -Body $Name } <# .SYNOPSIS Get user-defined DNS suffix of a Safeguard appliance via the Web API. .DESCRIPTION Get user-defined DNS suffix of a Safeguard appliance. This value can be specified using the Set-SafeguardApplianceDnsSuffix cmdlet. Each appliance in a cluster can have a unique name. The appliance name and appliance DNS suffix can be combined to get the full DNS name of the appliance. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardApplianceDnsSuffix .EXAMPLE Get-SafeguardApplianceDnsSuffix -Appliance 10.5.32.54 -Insecure #> function Get-SafeguardApplianceDnsSuffix { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } (Invoke-SafeguardMethod -Anonymous -Appliance $Appliance -Insecure:$Insecure Notification GET Status).HostDnsSuffix } <# .SYNOPSIS Set user-defined DNS suffx of a Safeguard appliance via the Web API. .DESCRIPTION Set user-defined DNS suffx of a Safeguard appliance. Each appliance in a cluster can have a unique name and a DNS suffix. Together they specify the full DNS name of the appliance. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .PARAMETER Name A string containing the name to give the appliance. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Set-SafeguardApplianceDnsSuffix mycompany.corp #> function Set-SafeguardApplianceDnsSuffix { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$true,Position=0)] [string]$DnsSuffix ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance PUT ApplianceStatus/HostDnsSuffix -Body $DnsSuffix } <# .SYNOPSIS Get user-defined DNS name of a Safeguard appliance via the Web API. .DESCRIPTION Get user-defined DNS name of a Safeguard appliance. Each appliance in a cluster can have a unique DNS name. The appliance name and appliance DNS suffix are combined to get the full DNS name of the appliance. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardApplianceDnsName .EXAMPLE Get-SafeguardApplianceDnsName -Appliance 10.5.32.54 -Insecure #> function Get-SafeguardApplianceDnsName { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure ) $local:Status = (Invoke-SafeguardMethod -Anonymous -Appliance $Appliance -Insecure:$Insecure Notification GET Status) if ($local:Status.HostDnsSuffix) { "$($local:Status.ApplianceName).$($local:Status.HostDnsSuffix)" } else { Write-Host -ForegroundColor Yellow "Appliance DNS suffix is not set, use Set-SafeguardApplianceDnsSuffix" $local:Status.ApplianceName } } <# .SYNOPSIS Send a command to a Safeguard appliance to shut down via the Web API. .DESCRIPTION This command will shut down the Safeguard appliance. The only way to get Safeguard running again is to manually turn the power back on. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .PARAMETER Reason A string containing the name to give the appliance. .PARAMETER Force Do not prompt for confirmation. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Invoke-SafeguardApplianceShutdown -Reason "Because I said so." .EXAMPLE Get-SafeguardName -Appliance 10.5.32.54 -AccessToken $token -Insecure -Force "Because I said so." #> function Invoke-SafeguardApplianceShutdown { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$true,Position=0)] [string]$Reason, [Parameter(Mandatory=$false)] [switch]$Force ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Import-Module -Name "$PSScriptRoot\ps-utilities.psm1" -Scope Local if ($Force) { $local:Confirmed = $true } else { Write-Host -ForegroundColor Yellow "You will be required to MANUALLY power the appliance on again!" $local:Confirmed = (Get-Confirmation "Safeguard Appliance Shutdown" "Do you want to initiate shutdown on this Safeguard appliance?" ` "Initiates shutdown immediately." "Cancels this operation.") } if ($local:Confirmed) { Write-Host "Sending shutdown command..." Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance POST ApplianceStatus/Shutdown -Body $Reason } else { Write-Host -ForegroundColor Yellow "Operation canceled." } } <# .SYNOPSIS Send a command to a Safeguard appliance to reboot via the Web API. .DESCRIPTION This command will reboot the Safeguard appliance. Safeguard will be unavailable via the API for a period of time. To determine if Safeguard is back online you may poll the appliance status using Get-SafeguardStatus. Look at the ApplianceCurrentState property. When it says Online then Safeguard is completely rebooted. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .PARAMETER Reason A string containing the name to give the appliance. .PARAMETER Force Do not prompt for confirmation. .PARAMETER NoWait Specify this flag to continue immediately without waiting for the patch to install to the connected appliance. .PARAMETER Timeout A timeout value in seconds, only used if waiting (default: 30 minutes or 1800 seconds). .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Invoke-SafeguardApplianceShutdown -Reason "Because I said so." .EXAMPLE Get-SafeguardName -Appliance 10.5.32.54 -AccessToken $token -Insecure -Force "Because I said so." #> function Invoke-SafeguardApplianceReboot { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$true,Position=0)] [string]$Reason, [Parameter(Mandatory=$false)] [switch]$Force, [Parameter(Mandatory=$false)] [switch]$NoWait = $false, [Parameter(Mandatory=$false)] [int]$Timeout = 1800 ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Import-Module -Name "$PSScriptRoot\ps-utilities.psm1" -Scope Local if ($Force) { $local:Confirmed = $true } else { Write-Host -ForegroundColor Yellow "There will be a period of time when Safeguard is unavailable via the API while it reboots." $local:Confirmed = (Get-Confirmation "Safeguard Appliance Reboot" "Do you want to initiate reboot on this Safeguard appliance?" ` "Initiates reboot immediately." "Cancels this operation.") } if ($local:Confirmed) { if (-not $NoWait) { Import-Module -Name "$PSScriptRoot\sg-utilities.psm1" -Scope Local $local:CurrentState = (Get-SafeguardStatus -Appliance $Appliance -Insecure:$Insecure).ApplianceCurrentState } Write-Host "Sending reboot command..." Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance ` POST ApplianceStatus/Reboot -Body $Reason if (-not $NoWait) { Wait-ForSafeguardStatus -Appliance $Appliance -Insecure:$Insecure -Timeout $Timeout -DesiredStatus $local:CurrentState } } else { Write-Host -ForegroundColor Yellow "Operation canceled." } } <# .SYNOPSIS Send a command to a Safeguard appliance to factory reset via the Web API. .DESCRIPTION This command will revert the Safeguard appliance to its initial factory state. This will drop all data stored on the appliance. This should generally only be done as a last resort. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .PARAMETER Reason A string containing the name to give the appliance. .PARAMETER Force Do not prompt for confirmation. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Invoke-SafeguardApplianceShutdown -Reason "Because I said so." .EXAMPLE Get-SafeguardName -Appliance 10.5.32.54 -AccessToken $token -Insecure -Force "Because I said so." #> function Invoke-SafeguardApplianceFactoryReset { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$true,Position=0)] [string]$Reason, [Parameter(Mandatory=$false)] [switch]$Force ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Import-Module -Name "$PSScriptRoot\ps-utilities.psm1" -Scope Local if ($Force) { $local:Confirmed = $true } else { Write-Host -ForegroundColor Red "This operation will remove existing data stored on this appliance." Write-Host -ForegroundColor Red "In order to not lose data, you must have an existing replica or a backup you can restore." Write-Host -ForegroundColor Yellow "As Safeguard is performing the factory reset, progress information is only available via the LCD." Write-Host -ForegroundColor Yellow "The factory reset process can take up to an hour." Write-Host -ForegroundColor Yellow "Please do not touch any of the LCD buttons during factory reset!" Write-Host -ForegroundColor Magenta "When Safeguard completes the factory reset process it will have the default IP address." Write-Host -ForegroundColor Magenta "You will have to set the X0 IP address just as if you had just purchased the appliance." $local:Confirmed = (Get-Confirmation "Safeguard Appliance Factory Reset" "Do you want to initiate factory reset on this Safeguard appliance?" ` "Initiates factory reset immediately." "Cancels this operation.") } if ($local:Confirmed) { Write-Host "Sending factory reset command..." Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance POST ApplianceStatus/FactoryReset -Body $Reason } else { Write-Host -ForegroundColor Yellow "Operation canceled." } } <# .SYNOPSIS Get a support bundle from a Safeguard appliance via the Web API. .DESCRIPTION Save a support bundle from the Safeguard appliance as a ZIP file to the file system. If a file path is not specified, one will be generated in the current directory. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .PARAMETER OutFile A string containing the path to store the support bundle (default: SG-<id>-<date>.zip). .PARAMETER Version Version of the Web API you are using (default: 2). .PARAMETER Timeout A timeout value in seconds (default timeout depends on options specified). .PARAMETER IncludeExtendedEventLog Whether to include extended event logs (increases size and generation time). .PARAMETER IncludeExtendedSessionsLog Whether to include extended sessions logs (dramatically increases generation time). .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardSupportBundle -Appliance 10.5.32.54 -AccessToken $token #> function Get-SafeguardSupportBundle { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [string]$OutFile, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false)] [int]$Version = 3, [Parameter(Mandatory=$false)] [int]$Timeout, [Parameter(Mandatory=$false)] [switch]$IncludeExtendedEventLog, [Parameter(Mandatory=$false)] [switch]$IncludeExtendedSessionsLog ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Import-Module -Name "$PSScriptRoot\sslhandling.psm1" -Scope Local if ($SafeguardSession) { $Insecure = $SafeguardSession["Insecure"] } if (-not ($PSBoundParameters.ContainsKey("Version")) -and $SafeguardSession) { $Version = $SafeguardSession["Version"] } if (-not $Appliance -and $SafeguardSession) { $Appliance = $SafeguardSession["Appliance"] } if (-not $AccessToken -and $SafeguardSession) { $AccessToken = $SafeguardSession["AccessToken"] } if (-not $Appliance) { $Appliance = (Read-Host "Appliance") } if (-not $AccessToken) { $AccessToken = (Connect-Safeguard -Appliance $Appliance -Insecure:$Insecure -NoSessionVariable) } if (-not $OutFile) { $OutFile = (Join-Path (Get-Location) "SG-$Appliance-$((Get-Date).ToString("MMddTHHmmssZz")).zip") } # Handle options and timeout $DefaultTimeout = 1200 $Url = "https://$Appliance/service/appliance/v$Version/SupportBundle" if ($IncludeExtendedEventLog) { $DefaultTimeout = 1800 $Url += "?includeEventLogs=true" } else { $Url += "?includeEventLogs=false" } if ($IncludeExtendedSessionsLog) { $DefaultTimeout = 3600 $Url += "&IncludeSessions=true" } else { $Url += "&IncludeSessions=false" } if (-not $Timeout) { $Timeout = $DefaultTimeout } try { Edit-SslVersionSupport if ($Insecure) { Disable-SslVerification if ($global:PSDefaultParameterValues) { $PSDefaultParameterValues = $global:PSDefaultParameterValues.Clone() } } # Use the WebClient class to avoid the content scraping slow down from Invoke-RestMethod as well as timeout issues Import-Module -Name "$PSScriptRoot\ps-utilities.psm1" -Scope Local Add-ExWebClientExType $OutFile = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($OutFile) $WebClient = (New-Object Ex.WebClientEx -ArgumentList @($Timeout)) $WebClient.Headers.Add("Accept", "application/octet-stream") $WebClient.Headers.Add("Content-type", "application/json") $WebClient.Headers.Add("Authorization", "Bearer $AccessToken") Write-Host "This operation may take several minutes..." Write-Host "Downloading support bundle to: $OutFile" $WebClient.DownloadFile($Url, $OutFile) } catch [System.Net.WebException] { Import-Module -Name "$PSScriptRoot\sg-utilities.psm1" -Scope Local Out-SafeguardExceptionIfPossible $_ } catch { Write-Error $_ throw "Failed to GET support bundle from Safeguard" } finally { if ($Insecure) { Enable-SslVerification if ($global:PSDefaultParameterValues) { $PSDefaultParameterValues = $global:PSDefaultParameterValues.Clone() } } } } <# .SYNOPSIS Get a support bundle quick glance file from a Safeguard appliance via the Web API. .DESCRIPTION Save a quick glance file from the Safeguard appliance as a plain text file to the file system. If a file path is not specified, one will be generated in the current directory. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .PARAMETER OutFile A string containing the path to store the support bundle (default: SG-<id>-<date>.zip). .PARAMETER Version Version of the Web API you are using (default: 2). .PARAMETER Timeout A timeout value in seconds (default timeout depends on options specified). .INPUTS None. .OUTPUTS Plain text response from Safeguard Web API. .EXAMPLE Get-SafeguardSupportBundleQuickGlance -Appliance 10.5.32.54 -AccessToken $token #> function Get-SafeguardSupportBundleQuickGlance { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [string]$OutFile, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false)] [int]$Version = 3, [Parameter(Mandatory=$false)] [int]$Timeout ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Import-Module -Name "$PSScriptRoot\sslhandling.psm1" -Scope Local if ($SafeguardSession) { $Insecure = $SafeguardSession["Insecure"] } if (-not ($PSBoundParameters.ContainsKey("Version")) -and $SafeguardSession) { $Version = $SafeguardSession["Version"] } if (-not $Appliance -and $SafeguardSession) { $Appliance = $SafeguardSession["Appliance"] } if (-not $AccessToken -and $SafeguardSession) { $AccessToken = $SafeguardSession["AccessToken"] } if (-not $Appliance) { $Appliance = (Read-Host "Appliance") } if (-not $AccessToken) { $AccessToken = (Connect-Safeguard -Appliance $Appliance -Insecure:$Insecure -NoSessionVariable) } if (-not $OutFile) { $OutFile = (Join-Path (Get-Location) "SG-GC-$Appliance-$((Get-Date).ToString("MMddTHHmmssZz")).txt") } # Handle options and timeout $DefaultTimeout = 1200 $Url = "https://$Appliance/service/appliance/v$Version/SupportBundle/QuickGlance" if (-not $Timeout) { $Timeout = $DefaultTimeout } try { Edit-SslVersionSupport if ($Insecure) { Disable-SslVerification if ($global:PSDefaultParameterValues) { $PSDefaultParameterValues = $global:PSDefaultParameterValues.Clone() } } # Use the WebClient class to avoid the content scraping slow down from Invoke-RestMethod as well as timeout issues Import-Module -Name "$PSScriptRoot\ps-utilities.psm1" -Scope Local Add-ExWebClientExType $OutFile = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($OutFile) $WebClient = (New-Object Ex.WebClientEx -ArgumentList @($Timeout)) $WebClient.Headers.Add("Accept", "application/octet-stream") $WebClient.Headers.Add("Content-type", "application/json") $WebClient.Headers.Add("Authorization", "Bearer $AccessToken") Write-Host "This operation may take few minutes..." Write-Host "Downloading Safeguard quick glance file to: $OutFile" $WebClient.DownloadFile($Url, $OutFile) } catch [System.Net.WebException] { Import-Module -Name "$PSScriptRoot\sg-utilities.psm1" -Scope Local Out-SafeguardExceptionIfPossible $_ } catch { Write-Error $_ throw "Failed to GET quick glance from Safeguard" } finally { if ($Insecure) { Enable-SslVerification if ($global:PSDefaultParameterValues) { $PSDefaultParameterValues = $global:PSDefaultParameterValues.Clone() } } } } <# .SYNOPSIS Get patch that is currently staged on an appliance via the Web API. .DESCRIPTION Get the patch that is currently staged on the Safeguard appliance if there is one. This cmdlet returns the metadata associated with the patch. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .INPUTS None. .OUTPUTS Script output as strings. .EXAMPLE Get-SafeguardPatch .EXAMPLE Get-SafeguardPatch -AccessToken $token -Appliance 10.5.32.54. #> function Get-SafeguardPatch { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance GET Patch).Metadata } <# .SYNOPSIS Remove patch that is currently staged on an appliance via the Web API. .DESCRIPTION Remove the patch that is currently staged on the Safeguard appliance if there is one. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .INPUTS None. .OUTPUTS Script output as strings. .EXAMPLE Clear-SafeguardPatch .EXAMPLE Clear-SafeguardPatch -AccessToken $token -Appliance 10.5.32.54. #> function Clear-SafeguardPatch { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (Test-SupportForClusterPatch -Appliance $Appliance -Insecure:$Insecure) { if ((Invoke-SafeguardMethod -Appliance $Appliance -AccessToken $AccessToken -Insecure:$Insecure Core GET "Cluster/Members").Count -gt 1) { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance DELETE Patch/Distribute } } Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance DELETE Patch } <# .SYNOPSIS Install patch on Safeguard appliance via the Web API. .DESCRIPTION Upload a patch to a Safeguard appliance via the Web API, or use a previously staged patch. If you don't specify to use the currently staged patch, if one exists, it will be overwritten. If successful and on the primary appliance, the patch will automatically be distributed to other appliances in the cluster. Upon distribution, also removes any patch on the other appliance and stages the specified patch. Then, if there are no patch precondition warnings or errors (on applicable versions of Safeguard), you will be prompted to install the patch. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER Version Version of the Web API you are using (default: 2). .PARAMETER Patch A string containing the path to a patch file. .PARAMETER Timeout A timeout value in seconds for uploading and distributing; also used to wait for installation (default: 3 hours) .PARAMETER UseStagedPatch Use the currently staged patch rather than uploading a new one. .PARAMETER NoWait Specify this flag to continue immediately without waiting for the patch to install to the connected appliance. .PARAMETER Force Do not prompt for confirmation. .INPUTS None. .OUTPUTS Script output as strings. .EXAMPLE Install-SafeguardPatch -AccessToken $token -Patch XX.sgp -Appliance 10.5.32.54. #> function Install-SafeguardPatch { [CmdletBinding(DefaultParameterSetName="NewPatch")] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false)] [int]$Version = 4, [Parameter(ParameterSetName="NewPatch",Mandatory=$true,Position=0)] [string]$Patch, [Parameter(ParameterSetName="NewPatch",Mandatory=$false)] [int]$Timeout = 10800, [Parameter(ParameterSetName="UseExisting",Mandatory=$false)] [switch]$UseStagedPatch = $false, [Parameter(Mandatory=$false)] [switch]$NoWait, [Parameter(Mandatory=$false)] [switch]$Force ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if ($SafeguardSession) { $Insecure = $SafeguardSession["Insecure"] } if (-not ($PSBoundParameters.ContainsKey("Version")) -and $SafeguardSession) { $Version = $SafeguardSession["Version"] } if (-not $Appliance -and $SafeguardSession) { $Appliance = $SafeguardSession["Appliance"] } if (-not $AccessToken -and $SafeguardSession) { $AccessToken = $SafeguardSession["AccessToken"] } if (-not $Appliance) { $Appliance = (Read-Host "Appliance") } if (-not $AccessToken) { $AccessToken = (Connect-Safeguard -Appliance $Appliance -Insecure:$Insecure -NoSessionVariable -Version $Version) } if (-not $UseStagedPatch) { $Response = (Get-SafeguardPatch -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure) if ($Response) { Write-Host "Removing currently staged patch..." Clear-SafeguardPatch -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $Response = (Get-SafeguardPatch -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure) if ($Response) { throw "Failed to delete existing patch" } } if (-not (Send-PatchFile $Patch $Appliance $AccessToken $Version -Insecure:$Insecure)) { return } } $local:StagedPatch = (Get-SafeguardPatch -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure) Import-Module -Name "$PSScriptRoot\sg-utilities.psm1" -Scope Local if (Test-SupportForClusterPatch -Appliance $Appliance -Insecure:$Insecure) { Write-Host "Distributing patch to cluster..." Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance POST Patch/Distribute Wait-ForPatchDistribution -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure -Timeout $Timeout } if (Test-SafeguardVersion -Appliance $Appliance -Insecure:$Insecure 6.0) { Write-Host "Precondition checks...`n" $local:Preconditions = (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure ` core GET "Cluster/Patch/PreconditionCheck").ClusterResults $local:Preconditions | ForEach-Object { Write-Host "Appliance ID: $($_.ApplianceId)" Write-Host -NoNewline "Warnings: " if ($_.Warnings) { $local:Warnings = $true Write-Host " " $_.Warnings | ForEach-Object { Write-Warning $_ } } else { Write-Host "None" } Write-Host -NoNewline "Errors: " if ($_.Errors) { $local:Errors = $true Write-Host " " # Note, we don't use the Write-Error commandlet because in all of our methods we set the # $ErrorActionPreference to Stop. So if there was more than one error, we'd only see the # first one. $_.Errors | ForEach-Object { Write-Host -ForegroundColor Magenta $_ } } else { Write-Host "None" } Write-Host " " } } if ($Force) { $local:Confirmed = $true $local:ExtraHeaders = @{ "X-Force" = "true"; } } else { if ($local:Errors) { Write-Host -ForegroundColor Magenta "You may not install a patch with errors." $local:Confirmed = $false } elseif ($local:Warnings) { Write-Host -ForegroundColor Magenta "Installing a patch with warnings requires the -Force parameter, use -UseStagedPatch to avoid re-uploading the patch." $local:Confirmed = $false } else { Import-Module -Name "$PSScriptRoot\ps-utilities.psm1" -Scope Local $local:Confirmed = (Get-Confirmation "Install Safeguard Patch" ` "Do you want to install $($local:StagedPatch.Title) on this cluster?" ` "Starts cluster patch immediately." ` "Cancels this operation.") } } if ($local:Confirmed) { Write-Host "Starting patch install..." $local:MetaData = (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance POST Patch/Install -ExtraHeaders $local:ExtraHeaders) if ($? -ne 0 -or $LastExitCode -eq 0) { Write-Host "Patch is currently installing..." if ($local:MetaData.Metadata) { $local:MetaData.Metadata } if ($NoWait) { Write-Host "Use Get-SafeguardStatus to monitor patching progress." } else { Wait-ForSafeguardOnlineStatus -Appliance $Appliance -Insecure:$Insecure -Timeout $Timeout } } } else { Write-Host "Patch installation canceled." } } <# .SYNOPSIS Stages a patch on Safeguard appliance via the Web API. .DESCRIPTION Upload a patch to a Safeguard appliance via the Web API. If there is already a staged patch, removes it and uploads the specified one. If successful and on the primary appliance, prompts for distribution of the staged patch to other appliances in the cluster. Upon distribution, also removes any patch on the other appliance and stages the specified patch. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER Version Version of the Web API you are using (default: 2). .PARAMETER Patch A string containing the path to a patch file. .PARAMETER Timeout A timeout value in seconds for uploading and distributing. (default 3 hours) .PARAMETER Force Do not prompt for confirmation. Automatically distribute the patch once successfully staged. .INPUTS None. .OUTPUTS Script output as strings. .EXAMPLE Set-SafeguardPatch -AccessToken $token -Patch XX.sgp -Appliance 10.5.32.54. #> function Set-SafeguardPatch { [CmdletBinding(DefaultParameterSetName="NewPatch")] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false)] [int]$Version = 3, [Parameter(ParameterSetName="NewPatch",Mandatory=$true,Position=0)] [string]$Patch, [Parameter(ParameterSetName="NewPatch",Mandatory=$false)] [int]$Timeout = 10800, [Parameter(Mandatory=$false)] [switch]$Force ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if ($SafeguardSession) { $Insecure = $SafeguardSession["Insecure"] } if (-not ($PSBoundParameters.ContainsKey("Version")) -and $SafeguardSession) { $Version = $SafeguardSession["Version"] } if (-not $Appliance -and $SafeguardSession) { $Appliance = $SafeguardSession["Appliance"] } if (-not $AccessToken -and $SafeguardSession) { $AccessToken = $SafeguardSession["AccessToken"] } if (-not $Appliance) { $Appliance = (Read-Host "Appliance") } if (-not $AccessToken) { $AccessToken = (Connect-Safeguard -Appliance $Appliance -Insecure:$Insecure -NoSessionVariable -Version $Version) } $Response = (Get-SafeguardPatch -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure) if ($Response) { Write-Host "Removing currently staged patch..." Clear-SafeguardPatch -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $Response = (Get-SafeguardPatch -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure) if ($Response) { throw "Failed to delete existing patch" } } if (-not (Send-PatchFile $Patch $Appliance $AccessToken $Version -Insecure:$Insecure)) { return } $local:StagedPatch = (Get-SafeguardPatch -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure) if ($StagedPatch) { Write-Host "Patch $($local:StagedPatch.Title) staged to $($Appliance) successfully." } else { return; } Import-Module -Name "$PSScriptRoot\sg-utilities.psm1" -Scope Local if (Test-SupportForClusterPatch -Appliance $Appliance -Insecure:$Insecure) { if ($Force) { $local:Confirmed = $true } else { Import-Module -Name "$PSScriptRoot\ps-utilities.psm1" -Scope Local $local:Confirmed = (Get-Confirmation "Distribute Safeguard Patch" ` "Do you want to distribute $($local:StagedPatch.Title) to the cluster?" ` "Starts cluster distribute immediately." ` "Completes this operation.") } if ($local:Confirmed) { Write-Host "Distributing patch to cluster..." Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance POST Patch/Distribute Wait-ForPatchDistribution -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure -Timeout $Timeout Write-Host "Patch distribution of $($local:StagedPatch.Title) to the cluster is complete." } } } <# .SYNOPSIS Create a new backup on a Safeguard appliance via the Web API. .DESCRIPTION This cmdlet will initiate the creation of a new backup on a Safeguard appliance. The backup can be downloaded using the Export-SafeguardBackup cmdlet or archived using the Save-SafeguardBackupToArchive cmdlet. The Import-SafeguardBackup cmdlet can be used to upload the backup later to a Safeguard appliance. The Restore-SafeguardBackup cmdlet can be used to restore a backup that has been uploaded. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER Wait Specify this flag to wait until the backup is completed before returning. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE New-SafeguardBackup .EXAMPLE New-SafeguardBackup -Appliance 10.5.32.54 -AccessToken $token -Insecure #> function New-SafeguardBackup { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false)] [switch]$Wait ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Write-Host "Starting a backup operation..." $local:BackupInfo = (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance POST Backups) if ($Wait) { while ($local:BackupInfo.Status -eq "InProcess") { $local:BackupInfo = (Get-SafeguardBackup -Appliance $Appliance -AccessToken $AccessToken -Insecure:$Insecure $local:BackupInfo.Id) } } $local:BackupInfo } <# .SYNOPSIS Delete a backup from a Safeguard appliance via the Web API. .DESCRIPTION This cmdlet will delete a backup stored on a Safeguard appliance. Only delete backups that you have either downloaded or archived. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER BackupId A string containing a backup ID, which is a GUID. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Remove-SafeguardBackup -BackupId "c6f9a3b4-7a75-406d-ba5a-830e44c1c94d" .EXAMPLE Remove-SafeguardBackup -Appliance 10.5.32.54 -AccessToken $token -Insecure #> function Remove-SafeguardBackup { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [string]$BackupId ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (-not $BackupId) { $local:CurrentBackupIds = (Get-SafeguardBackup -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure).Id -join ", " Write-Host "Available Backups: [ $($local:CurrentBackupIds) ]" $BackupId = (Read-Host "BackupId") } Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance DELETE "Backups/$BackupId" } <# .SYNOPSIS Download signed, encrypted backup from Safeguard appliance via the Web API. .DESCRIPTION Download signed, encrypted backup for safe storage offline so that it can be uploaded to this appliance or another appliance in the future to recover data. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER Version Version of the Web API you are using (default: 2). .PARAMETER BackupId A string containing a backup ID, which is a GUID. .PARAMETER OutFile A string containing the path to store the backup (default: SG-<id>-backup-<backup date>.sgb) .PARAMETER Timeout A timeout value in seconds for uploading (default: 1200s or 20m) .INPUTS None. .OUTPUTS Script output as strings. .EXAMPLE Export-SafeguardBackup -AccessToken $token -Appliance 10.5.32.54 f1f42734-e0ea-4edb-80f3-9f018b1b8afd sg-backup.sgb #> function Export-SafeguardBackup { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false)] [int]$Version = 3, [Parameter(Mandatory=$false,Position=0)] [string]$BackupId, [Parameter(Mandatory=$false,Position=1)] [string]$OutFile, [Parameter(Mandatory=$false)] [int]$Timeout = 1200 ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Import-Module -Name "$PSScriptRoot\sslhandling.psm1" -Scope Local if ($SafeguardSession) { $Insecure = $SafeguardSession["Insecure"] } if (-not ($PSBoundParameters.ContainsKey("Version")) -and $SafeguardSession) { $Version = $SafeguardSession["Version"] } if (-not $Appliance -and $SafeguardSession) { $Appliance = $SafeguardSession["Appliance"] } if (-not $AccessToken -and $SafeguardSession) { $AccessToken = $SafeguardSession["AccessToken"] } if (-not $Appliance) { $Appliance = (Read-Host "Appliance") } if (-not $AccessToken) { $AccessToken = (Connect-Safeguard -Appliance $Appliance -Insecure:$Insecure -NoSessionVariable) } if (-not $BackupId) { $local:CurrentBackupIds = (Get-SafeguardBackup -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure).Id -join ", " Write-Host "Available Backups: [ $($local:CurrentBackupIds) ]" $BackupId = (Read-Host "BackupId") } if (-not $OutFile) { $CreatedOn = (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance GET Backups/$BackupId).CreatedOn $FileName = "SG-$Appliance-backup-$((Get-Date $CreatedOn).ToString("MMddyyyyTHHmmZ")).sgb" $OutFile = (Join-Path (Get-Location) $FileName) } try { Edit-SslVersionSupport if ($Insecure) { Disable-SslVerification if ($global:PSDefaultParameterValues) { $PSDefaultParameterValues = $global:PSDefaultParameterValues.Clone() } } # Use the WebClient class to avoid the content scraping slow down from Invoke-RestMethod as well as timeout issues Import-Module -Name "$PSScriptRoot\ps-utilities.psm1" -Scope Local Add-ExWebClientExType $WebClient = (New-Object Ex.WebClientEx -ArgumentList @($Timeout)) $WebClient.Headers.Add("Accept", "application/octet-stream") $WebClient.Headers.Add("Content-type", "application/json") $WebClient.Headers.Add("Authorization", "Bearer $AccessToken") Write-Host "This operation may take several minutes..." Write-Host "Downloading Safeguard backup to: $OutFile" $WebClient.DownloadFile("https://$Appliance/service/appliance/v$Version/Backups/$BackupId/Download", $OutFile) } catch [System.Net.WebException] { Import-Module -Name "$PSScriptRoot\sg-utilities.psm1" -Scope Local Out-SafeguardExceptionIfPossible $_ } catch { Write-Error $_ throw "Failed to GET backup to Safeguard" } finally { if ($Insecure) { Enable-SslVerification if ($global:PSDefaultParameterValues) { $PSDefaultParameterValues = $global:PSDefaultParameterValues.Clone() } } } } <# .SYNOPSIS Upload backup file to Safeguard appliance via the Web API. .DESCRIPTION Upload a backup to a Safeguard appliance via the Web API. Once it is uploaded, you can call the Restore-SafeguardBackup cmdlet to restore it. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .PARAMETER Version Version of the Web API you are using (default: 2). .PARAMETER BackupFile A string containing the path to a backup file. .PARAMETER Timeout A timeout value in seconds for uploading (default: 1200s or 20m) .INPUTS None. .OUTPUTS Script output as strings. .EXAMPLE Import-SafeguardBackup -AccessToken $token -Appliance 10.5.32.54 sg-backup.sgb #> function Import-SafeguardBackup { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false)] [int]$Version = 3, [Parameter(Mandatory=$true,Position=0)] [string]$BackupFile, [Parameter(Mandatory=$false)] [int]$Timeout = 1200 ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Import-Module -Name "$PSScriptRoot\sslhandling.psm1" -Scope Local if ($SafeguardSession) { $Insecure = $SafeguardSession["Insecure"] } if (-not ($PSBoundParameters.ContainsKey("Version")) -and $SafeguardSession) { $Version = $SafeguardSession["Version"] } if (-not $Appliance -and $SafeguardSession) { $Appliance = $SafeguardSession["Appliance"] } if (-not $AccessToken -and $SafeguardSession) { $AccessToken = $SafeguardSession["AccessToken"] } if (-not $Appliance) { $Appliance = (Read-Host "Appliance") } if (-not $AccessToken) { $AccessToken = (Connect-Safeguard -Appliance $Appliance -Insecure:$Insecure -NoSessionVariable) } try { Edit-SslVersionSupport if ($Insecure) { Disable-SslVerification if ($global:PSDefaultParameterValues) { $PSDefaultParameterValues = $global:PSDefaultParameterValues.Clone() } } # Use the WebClient class to avoid the content scraping slow down from Invoke-RestMethod as well as timeout issues Import-Module -Name "$PSScriptRoot\ps-utilities.psm1" -Scope Local Add-ExWebClientExType $WebClient = (New-Object Ex.WebClientEx -ArgumentList @($Timeout)) $WebClient.Headers.Add("Accept", "application/json") $WebClient.Headers.Add("Content-type", "application/octet-stream") $WebClient.Headers.Add("Authorization", "Bearer $AccessToken") $BackupFile = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($BackupFile) Write-Host "Loading backup from $BackupFile" Write-Host "POSTing backup to Safeguard. This operation may take several minutes..." $Bytes = [System.IO.File]::ReadAllBytes($BackupFile); $ResponseBytes = $WebClient.UploadData("https://$Appliance/service/appliance/v$Version/Backups/Upload", "POST", $Bytes) | Out-Null if ($ResponseBytes) { [System.Text.Encoding]::UTF8.GetString($ResponseBytes) } } catch [System.Net.WebException] { Import-Module -Name "$PSScriptRoot\sg-utilities.psm1" -Scope Local Out-SafeguardExceptionIfPossible $_ } catch { Write-Error $_ throw "Failed to POST backup to Safeguard" } finally { if ($Insecure) { Enable-SslVerification if ($global:PSDefaultParameterValues) { $PSDefaultParameterValues = $global:PSDefaultParameterValues.Clone() } } } } <# .SYNOPSIS Restore a backup that was created on or uploaded to a Safeguard appliance via the Web API. .DESCRIPTION This cmdlet will restore a backup stored on a Safeguard appliance. The backup needs to already be on the appliance .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER BackupId A string containing a backup ID, which is a GUID. .PARAMETER RequirePassword Specify that a password is required, you will be prompted for it. .PARAMETER NoWait Specify this flag to continue immediately without waiting for the restore to complete. .PARAMETER Timeout A timeout value in seconds for restore (default: 3600s or 60m) .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Restore-SafeguardBackup -BackupId "c6f9a3b4-7a75-406d-ba5a-830e44c1c94d" .EXAMPLE Restore-SafeguardBackup -Appliance 10.5.32.54 -AccessToken $SafeguardSession.AccessToken -Insecure -NoWait #> function Restore-SafeguardBackup { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [string]$BackupId, [Parameter(Mandatory=$false)] [switch]$RequirePassword, [Parameter(Mandatory=$false)] [switch]$NoWait, [Parameter(ParameterSetName="NewPatch",Mandatory=$false)] [int]$Timeout = 3600 ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (-not $BackupId) { $CurrentBackupIds = (Get-SafeguardBackup -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure).Id -join ", " Write-Host "Available Backups: [ $CurrentBackupIds ]" $BackupId = (Read-Host "BackupId") } Write-Host "Starting restore operation for backup..." if ($RequirePassword) { $local:Password = (Read-Host -AsSecureString -Prompt "Password") Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance POST "Backups/$BackupId/Restore" ` -Body ([System.Net.NetworkCredential]::new("", $local:Password).Password) } else { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance POST "Backups/$BackupId/Restore" } if (-not $NoWait) { Write-Host "Waiting for operation to complete..." Import-Module -Name "$PSScriptRoot\sg-utilities.psm1" -Scope Local Wait-ForSafeguardStatus -Appliance $Appliance -Insecure:$Insecure -Timeout $Timeout -DesiredStatus "StandaloneReadOnly" Write-Host "Safeguard is currently standalone readonly. You might need to login again, and you will need to use Enable-SafeguardClusterPrimary to go online." } else { Write-Host "Not waiting for operation to complete, this Safeguard appliance will not be available as it processes in the background." } } <# .SYNOPSIS Save a Safeguard backup on an archive server via the Web API. .DESCRIPTION This cmdlet will archive a Safeguard backup by saving it to an archive server configured in Safeguard. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER BackupId A string containing a backup ID, which is a GUID. .PARAMETER ArchiveServerId An integer containing the archive server ID. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Save-SafeguardBackupToArchive -BackupId "c6f9a3b4-7a75-406d-ba5a-830e44c1c94d" .EXAMPLE Save-SafeguardBackupToArchive -Appliance 10.5.32.54 -AccessToken $token -Insecure "c6f9a3b4-7a75-406d-ba5a-830e44c1c94d" 12 #> function Save-SafeguardBackupToArchive { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [string]$BackupId, [Parameter(Mandatory=$false,Position=1)] [int]$ArchiveServerId ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (-not $BackupId) { $CurrentBackupIds = (Get-SafeguardBackup -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure).Id -join ", " Write-Host "Available Backups: [ $CurrentBackupIds ]" $BackupId = (Read-Host "BackupId") } if (-not $ArchiveServerId) { $ArchiveServerIds = ((Get-SafeguardArchiveServer -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure) | ForEach-Object { "$($_.Id): $($_.Name)" }) -join ", " Write-Host "Archive servers: [ $ArchiveServerIds ]" $ArchiveServerId = (Read-Host "ArchiveServerId") } Write-Host "Moving backup to archive server..." Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance POST "Backups/$BackupId/Archive" -Body @{ ArchiveServerId = $ArchiveServerId } } <# .SYNOPSIS Get backups on a Safeguard appliance via the Web API. .DESCRIPTION This cmdlet will return information about backups that have occurred on the appliance. Backups that are archived are no longer stored on Safeguard. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardBackup "c6f9a3b4-7a75-406d-ba5a-830e44c1c94d" .EXAMPLE Get-SafeguardBackup -Appliance 10.5.32.54 -AccessToken $token -Insecure #> function Get-SafeguardBackup { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [string]$BackupId ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if ($BackupId) { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance GET "Backups/$BackupId" } else { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance GET Backups } } <# .SYNOPSIS Get BMC configuration of a Safeguard appliance via the Web API. .DESCRIPTION Get the BMC network settings and enable state. The AdminPassword field returned will always be blank. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardBmcConfiguration -Appliance 10.5.32.54 -AccessToken $token -Insecure #> function Get-SafeguardBmcConfiguration { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance GET BmcConfiguration } <# .SYNOPSIS Enable BMC configuration of a Safeguard appliance via the Web API. .DESCRIPTION Set the BMC to enabled and provide network settings and ADMIN password. The AdminPassword field in the object returned will always be blank. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .PARAMETER Ipv4Address A string containing the new address. .PARAMETER Ipv4NetMask A string containing the netmask (e.g. 255.255.255.0). .PARAMETER Ipv4Gateway A string containing the address of a gateway. .PARAMETER Password SecureString containing the password for the ADMIN account. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Enable-SafeguardBmcConfiguration 10.10.10.233 255.255.255.0 10.10.10.1 .EXAMPLE Enable-SafeguardBmcConfiguration 10.10.10.233 255.255.255.0 10.10.10.1 -Password (ConvertTo-SecureString -AsPlainText -Force "reallylongpass") #> function Enable-SafeguardBmcConfiguration { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [string]$Ipv4Address, [Parameter(Mandatory=$false,Position=1)] [string]$Ipv4NetMask, [Parameter(Mandatory=$false,Position=2)] [string]$Ipv4Gateway, [Parameter(Mandatory=$false,Position=3)] [SecureString]$Password ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } $local:Body = @{ Enabled = $true } if ($PSBoundParameters.ContainsKey("Ipv4Address") ` -or $PSBoundParameters.ContainsKey("Ipv4NetMask") ` -or $PSBoundParameters.ContainsKey("Ipv4Gateway")) { $local:Body.NetworkConfiguration = @{} if ($PSBoundParameters.ContainsKey("Ipv4Address")) { $local:Body.NetworkConfiguration.Ipv4Address = $Ipv4Address } if ($PSBoundParameters.ContainsKey("Ipv4NetMask")) { $local:Body.NetworkConfiguration.Netmask = $Ipv4NetMask } if ($PSBoundParameters.ContainsKey("Ipv4Gateway")) { $local:Body.NetworkConfiguration.DefaultGateway = $Ipv4Gateway } } if ($PSBoundParameters.ContainsKey("Password")) { $local:PasswordPlainText = [System.Net.NetworkCredential]::new("", $Password).Password $local:Body.AdminPassword = $local:PasswordPlainText } Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance PUT BmcConfiguration -Body $local:Body } <# .SYNOPSIS Disable BMC configuration of a Safeguard appliance via the Web API. .DESCRIPTION Disable the BMC by returning network settings to default and scrambling the password. The AdminPassword field in the object returned will always be blank. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Disable-SafeguardBmcConfiguration -Appliance 10.5.32.54 -AccessToken $token -Insecure #> function Disable-SafeguardBmcConfiguration { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance PUT BmcConfiguration -Body @{ Enabled = $false } } <# .SYNOPSIS Set password for BMC configuration of a Safeguard appliance via the Web API. .DESCRIPTION Set the BMC ADMIN password. The AdminPassword field in the object returned will always be blank. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .PARAMETER Password SecureString containing the password for the ADMIN account. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Set-SafeguardBmcAdminPassword -Appliance 10.5.32.54 -AccessToken $token -Insecure .EXAMPLE Set-SafeguardBmcAdminPassword (ConvertTo-SecureString -AsPlainText -Force "reallylongpass") #> function Set-SafeguardBmcAdminPassword { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [SecureString]$Password ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } $local:Body = (Get-SafeguardBmcConfiguration -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure) if (-not $local:Body.Enabled) { throw "Unable to set admin password, this appliance does not have BMC enabled." } if (-not $Password) { $Password = Read-Host -AsSecureString "Password" } $local:PasswordPlainText = [System.Net.NetworkCredential]::new("", $Password).Password $local:Body.AdminPassword = $local:PasswordPlainText Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance PUT BmcConfiguration -Body $local:Body } <# .SYNOPSIS Get current status of TLS 1.2 Only setting in Safeguard via the Web API. .DESCRIPTION TLS 1.2 Only means Safeguard will only negotiate TLS 1.2+ connections when clients access the Web API and Web UI. This cmdlet reports the current status of that setting: true or false. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS Boolean from Safeguard Web API. .EXAMPLE Get-SafeguardTls12OnlyStatus -Appliance 10.5.32.54 -AccessToken $token -Insecure .EXAMPLE Get-SafeguardTls12OnlyStatus #> function Get-SafeguardTls12OnlyStatus { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance GET "ApplianceStatus/SecureSsl" } <# .SYNOPSIS Enable the TLS 1.2 Only setting in Safeguard via the Web API. .DESCRIPTION TLS 1.2 Only means Safeguard will only negotiate TLS 1.2+ connections when clients access the Web API and Web UI. This cmdlet sets the setting to true. Running this cmdlet requires a Safeguard reboot for the setting to take effect. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS Boolean from Safeguard Web API. .EXAMPLE Enable-SafeguardTls12Only -Appliance 10.5.32.54 -AccessToken $token -Insecure .EXAMPLE Enable-SafeguardTls12Only #> function Enable-SafeguardTls12Only { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance PUT "ApplianceStatus/SecureSsl" -Body $true Import-Module -Name "$PSScriptRoot\ps-utilities.psm1" -Scope Local Write-Host -ForegroundColor Yellow "In order for this setting to take effect you need to reboot the Safeguard appliance." $local:Confirmed = (Get-Confirmation "Safeguard Appliance Reboot" "Do you want to initiate reboot on this Safeguard appliance?" ` "Initiates reboot immediately." "Reboot manually later.") if ($local:Confirmed) { Invoke-SafeguardApplianceReboot -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure -Reason "Enable TLS 1.2 Only" -Force } } <# .SYNOPSIS Disable the TLS 1.2 Only setting in Safeguard via the Web API. .DESCRIPTION TLS 1.2 Only means Safeguard will only negotiate TLS 1.2+ connections when clients access the Web API and Web UI. This cmdlet sets the setting to false. Running this cmdlet requires a Safeguard reboot for the setting to take effect. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate .INPUTS None. .OUTPUTS Boolean from Safeguard Web API. .EXAMPLE Disable-SafeguardTls12Only -Appliance 10.5.32.54 -AccessToken $token -Insecure .EXAMPLE Disable-SafeguardTls12Only #> function Disable-SafeguardTls12Only { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Appliance PUT "ApplianceStatus/SecureSsl" -Body $false Import-Module -Name "$PSScriptRoot\ps-utilities.psm1" -Scope Local Write-Host -ForegroundColor Yellow "In order for this setting to take effect you need to reboot the Safeguard appliance." $local:Confirmed = (Get-Confirmation "Safeguard Appliance Reboot" "Do you want to initiate reboot on this Safeguard appliance?" ` "Initiates reboot immediately." "Reboot manually later.") if ($local:Confirmed) { Invoke-SafeguardApplianceReboot -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure -Reason "Disable TLS 1.2 Only" -Force } } <# .SYNOPSIS Verify the contents of an audit log archive file. .DESCRIPTION This cmdlet will read the ZIP file archive exported from Safeguard and verify the signature of each of the JSON files inside the archive. By default this cmdlet uses the currently configured audit log signing certificate, but you may also specify a certificate as a file. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER ArchiveZip A string containing the file path to a Safeguard audit log archive file. .PARAMETER SigningCertificate A string containing the file path to a certificate that will be used to verify signatures. .INPUTS None. .OUTPUTS Boolean from Safeguard Web API. .EXAMPLE Test-SafeguardAuditLogArchive 4419154e2128482f9232e3e0a1708f41_Safeguard_Audit_20200510-000000.zip .EXAMPLE Test-SafeguardAuditLogArchive 4419154e2128482f9232e3e0a1708f41_Safeguard_Audit_20200510-000000.zip -SigningCertificate cert.crt #> function Test-SafeguardAuditLogArchive { [CmdletBinding(DefaultParameterSetName="Online")] Param( [Parameter(ParameterSetName="Online",Mandatory=$false)] [string]$Appliance, [Parameter(ParameterSetName="Online",Mandatory=$false)] [object]$AccessToken, [Parameter(ParameterSetName="Online",Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$true,Position=0)] [string]$ArchiveZip, [Parameter(ParameterSetName="Local",Mandatory=$true)] [string]$SigningCertificate ) if (-not $PSBoundParameters.ContainsKey("ErrorAction")) { $ErrorActionPreference = "Stop" } if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if ($PSCmdlet.ParameterSetName -eq "Local") { $local:Base64CertificateData = [System.Convert]::ToBase64String((Get-PfxCertificate $SigningCertificate).RawData) } else { $local:Base64CertificateData = (Get-SafeguardAuditLogSigningCertificate -Appliance $Appliance -AccessToken $AccessToken -Insecure:$Insecure).Base64CertificateData } if (-not ([System.Management.Automation.PSTypeName]"AuditLogSignatureVerifier").Type) { Write-Verbose "Adding the PSType for audit log signature verification" Add-Type -TypeDefinition @" using System; using System.IO; using System.IO.Compression; using System.Linq; using System.Security.Cryptography; using System.Security.Cryptography.X509Certificates; using System.Text.RegularExpressions; public class AuditLogSignatureVerifier { private static byte[] ToBuffer(string base64Data) { var match = Regex.Match(base64Data, "-----.*?-----", RegexOptions.Multiline & RegexOptions.Compiled & RegexOptions.IgnoreCase & RegexOptions.ECMAScript); var dataNoLabel = Regex.Replace(base64Data, "-----.*?-----", "", RegexOptions.Multiline & RegexOptions.Compiled & RegexOptions.IgnoreCase & RegexOptions.ECMAScript); var b64String = Regex.Replace(dataNoLabel, "\r|\n", "", RegexOptions.Multiline & RegexOptions.Compiled & RegexOptions.IgnoreCase & RegexOptions.ECMAScript); return Convert.FromBase64String(b64String); } private static byte[] ReadAllBytes(Stream zipStream) { using (var memoryStream = new MemoryStream()) { zipStream.CopyTo(memoryStream); return memoryStream.ToArray(); } } public static bool VerifyArchive(string certificateBase64Data, string zipFilePath) { var buffer = ToBuffer(certificateBase64Data); var cert = new X509Certificate2(buffer); var success = true; using (var archive = ZipFile.OpenRead(zipFilePath)) { Console.WriteLine(string.Format("Verifying audit log archive: {0} ...", zipFilePath)); if (!string.Equals(cert.PublicKey.Oid.FriendlyName, "RSA")) { Console.WriteLine(string.Format(" Unable to verify archive with {0} certificate", cert.PublicKey.Oid.FriendlyName)); return false; } using (var rsa = cert.GetRSAPublicKey()) { foreach (var entry in archive.Entries.Where(e => e.FullName.EndsWith("json"))) { Console.Write(string.Format(" {0} -- ", entry.FullName)); var stream = entry.Open(); var sigEntry = archive.GetEntry(entry.FullName.Replace(".json", ".sig")); if (sigEntry == null) { Console.WriteLine("FAILED, unable to find .sig file"); success = false; } else { var sigStream = sigEntry.Open(); var sigBytes = ReadAllBytes(sigStream); using (var hasher = SHA256.Create()) { var hash = hasher.ComputeHash(stream); if (rsa.VerifyHash(hash, sigBytes, HashAlgorithmName.SHA256, RSASignaturePadding.Pss)) Console.WriteLine("verified"); else { Console.WriteLine("FAILED, signature does not match"); success = false; } } } } } } return success; } } "@ -ReferencedAssemblies System.Security,System.IO.Compression,System.IO.Compression.ZipFile,System.IO.Compression.FileSystem } if ([AuditLogSignatureVerifier]::VerifyArchive($local:Base64CertificateData, $ArchiveZip)) { Write-Output "SUCCESS: All signatures verified successfully." } else { throw "Audit log signature verification failed" } } |