CyThreats.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
<#
.SYNOPSIS
    Gets the threat list
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
#>

function Get-CyThreatList {
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle
        )

    Read-CyData -API $API -Uri "$($API.BaseUrl)/threats/v2"
}

<#
.SYNOPSIS
    Gets the threat list for the given device
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER Device
    The device to retrieve the threats for.
#>

function Get-CyDeviceThreatList {
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(Mandatory=$true,ParameterSetName="ByDevice",ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true)]
        [object]$Device,
        [Parameter(Mandatory=$true,ParameterSetName="ByDeviceId")]
        [object]$DeviceId
        )

    Process {
        switch ($PSCmdlet.ParameterSetName) {
            "ByDevice" {
                $Uri = "$($API.BaseUrl)/devices/v2/$($Device.id)/threats"
            }
            "ByDeviceId" {
                $Uri = "$($API.BaseUrl)/devices/v2/$($DeviceId)/threats"
            }
        }
        
        Read-CyData -API $API -Uri $Uri    
    }
}

<#
.SYNOPSIS
    Update a device threat.
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER Action
    The action to take (quarantine or waive the threat)
 
.PARAMETER Device
    The device object to apply this threat action to.
#>

function Update-CyDeviceThreat {
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(
            Mandatory=$true, 
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true)]
            [object[]]$DeviceThreat,
        [Parameter(Mandatory=$true)]
        [ValidateSet("Quarantine", "Waive")]
        [String]$Action,
        [Parameter(Mandatory=$true,ParameterSetName="ByDevice")]
        [object]$Device,
        [Parameter(Mandatory=$true,ParameterSetName="ByDeviceId")]
        [object]$DeviceId

    )

    Begin {
    }

    Process {
        $hash = $DeviceThreat.sha256
        if ($null -eq $hash) {
            $hash = $DeviceThreat
        }

        $updateMap = @{
            "threat_id" = $($hash)
            "event" = $Action
        }

        $json = $updateMap | ConvertTo-Json
        # remain silent
        switch ($PSCmdlet.ParameterSetName) {
            "ByDeviceId" {
                $output = Invoke-CyRestMethod -API $API -Method POST -Uri "$($API.BaseUrl)/devices/v2/$($DeviceId)/threats" -ContentType "application/json; charset=utf-8" -Body $json
            }
            "ByDevice" {
                $output = Invoke-CyRestMethod -API $API -Method POST -Uri "$($API.BaseUrl)/devices/v2/$($Device.id)/threats" -ContentType "application/json; charset=utf-8" -Body $json
            }
        }
        
    }
}

<#
.SYNOPSIS
    Retrieves the given threat's Detail from the console. Gets full data, not a shallow version.
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER SHA256
    A collection of SHA256 values (as strings) to retrieve the data for, or threat objects with a "sha256" property.
#>

function Get-CyThreatDetail {
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(Mandatory=$true, ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true)]
        [object]$SHA256
        )

    Process {
        if ($SHA256 -is [String]) {
            $Hash = $SHA256
        } elseif (![String]::IsNullOrEmpty($SHA256.sha256)) {
            $Hash = $SHA256.sha256
        } else {
            Throw "Cannot determine SHA256 value from threat object"
        }
        Invoke-CyRestMethod -API $API -Method GET -Uri  "$($API.BaseUrl)/threats/v2/$($Hash)" | Convert-CyObject
    }
}

<#
.SYNOPSIS
    Retrieves a download link for the given threat
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER SHA256
    The threat to retrieve the download link for.
#>

function Get-CyThreatDownloadLink {
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(
            Mandatory=$true, 
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true)]
            [String[]]$SHA256
        )

    Process {
        Invoke-CyRestMethod -API $API -Method GET -Uri  "$($API.BaseUrl)/threats/v2/download/$($SHA256)" 
    }
}


<#
.SYNOPSIS
    Gets the devices affected by a particular threat.
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER SHA256
    The threat SHA256 hash
#>

function Get-CyThreatDeviceList {
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(Mandatory=$true, ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true)]
        [object]$SHA256
        )

    Process {
        if ($SHA256 -is [String]) {
            $Hash = $SHA256
        } elseif (![String]::IsNullOrEmpty($SHA256.sha256)) {
            $Hash = $SHA256.sha256
        } else {
            Throw "Cannot determine SHA256 value from threat object"
        }

        Read-CyData -API $API -Uri "$($API.BaseUrl)/threats/v2/$($Hash)/devices"
    }
}