en-US/MISP.Tools-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-MispContext</command:name> <command:verb>Save</command:verb> <command:noun>MispContext</command:noun> <maml:description> <maml:para>Get details of a MISP Attribute by Id, or get all.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details of a MISP Attribute by Id, or return details of all MISP Attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-MispContext</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object - MISP Context</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String - DestinationPath</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String - Filename</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $MispAttribute = Get-MispAttribute -Context $MispContext -Id 12345</dev:code> <dev:remarks> <maml:para>Get details of the MISP Attribute with id 12345 and store them in the variable $MispAttribute.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $MispAttribute = Get-MispAttribute -Context $MispContext</dev:code> <dev:remarks> <maml:para>Return all MISP Attributes and store them in the variable $MispAttribute</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>MISP.Tools on GitHub</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/misp.tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-MispRestMethod</command:name> <command:verb>Invoke</command:verb> <command:noun>MispRestMethod</command:noun> <maml:description> <maml:para>Make a call to the MISP Rest API</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Make a call to the MISP Rest API. This function abstracts the authentication and error handling into a single location, meaning a PSCredential Object can be passed for authentication purposes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-MispRestMethod</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>MISP.Tools on GitHub</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/misp.tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-MispContext</command:name> <command:verb>Save</command:verb> <command:noun>MispContext</command:noun> <maml:description> <maml:para>Create a new MISP Attribute Object for association with a New Event.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a New MISP Attribute that can be associated with a MISP Event. Provides default values when parameters are not specified.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-MispContext</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object - MISP Context</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String - DestinationPath</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String - Filename</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $MispAttribute = New-MispAttribute -Category 'Network Traffic' -Type 'ip-src' -Value '192.168.100.100' -Comment 'Some comment'</dev:code> <dev:remarks> <maml:para>Create a new MISP Attribute that can be used in an array of attributes associated to an Event.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>MISP.Tools on GitHub</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/misp.tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-MispContext</command:name> <command:verb>New</command:verb> <command:noun>MispContext</command:noun> <maml:description> <maml:para>Create a PSObject containing Credentials and Base URI for interaction with MISP</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a PSObject containing Credentials and Base URI for interaction with MISP</maml:para> <maml:para>Credentials supplied in the form of a PSCredential Object and Base URI as either a string or Uri::Builder object</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-MispContext</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>[PSCredential] - PSCredential Object with ApiKey as Password</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BaseUri</maml:name> <maml:description> <maml:para>[uri::builder] or [string] - Base API URL for the API Calls to MISP as [string] or [Uri::Builder]</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NoValidateSsl</maml:name> <maml:description> <maml:para>[switch] - Don't validate the SSL Certificate, default is to validate</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential - Credential</maml:name> </dev:type> <maml:description> <maml:para>PSCredential Object consisting of Username and Password. The Password is protected from casual in-memory examination. The Password property contains the API Key for MISP.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String or System.UriBuilder - BaseUri</maml:name> </dev:type> <maml:description> <maml:para>String or UriBuilder object containing the base Uri for your MISP instance.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Switch - NoValidateSsl</maml:name> </dev:type> <maml:description> <maml:para>Indicates that SSL/TLS Certificate Validation should not be performed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS> $MispContext = New-MispContext -Credential (Get-Credential -Username 'MISP Api Key') -BaseUri 'https://misp.domain.com'</dev:code> <dev:remarks> <maml:para>Create a new MISP Context, prompting for the password via Get-Credential.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>MISP.Tools on GitHub</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/misp.tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Read-MispContext</command:name> <command:verb>Read</command:verb> <command:noun>MispContext</command:noun> <maml:description> <maml:para>Read the MISP Context from a saved preferences file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Read the MISP Context from a saved preferences file</maml:para> <maml:para>Check to see that the contents of the file matches our expectations after loading.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Read-MispContext</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Location on disk to read saved MISP Context from. This defaults to the user's AppDataLocal path, which varies between Operating Systems, and on Windows may be modified through Group Policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filename</maml:name> <maml:description> <maml:para>Name of file to use for MISP Context, defaults to MISPContext.xml</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String - Path</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String - Filename</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $MispContext = Read-MispContext</dev:code> <dev:remarks> <maml:para>Read saved MISP Context from default file and context directory</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $MispContext = Read-MispContext -Filename 'MyMISP.xml'</dev:code> <dev:remarks> <maml:para>Read saved MISP Context with custom filename from the default context directory</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>MISP.Tools on GitHub</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/misp.tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-MispContext</command:name> <command:verb>Save</command:verb> <command:noun>MispContext</command:noun> <maml:description> <maml:para>Write MISP Context containing Api Key/URL out to a file for future reference</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Write MISP Context containing Api Key/Url out to a file for future reference</maml:para> <maml:para>Default location is user's profile path, but can be overridden with -DestinationPath Default Filename is MISPContext.xml, but can be overridden with -Filename</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-MispContext</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object - MISP Context</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String - DestinationPath</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String - Filename</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $MispContext | Save-MispContext</dev:code> <dev:remarks> <maml:para>Save MISP Context to default location and filename</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $MispContext | Save-MispContext -Filename 'MyMISP.xml'</dev:code> <dev:remarks> <maml:para>Save MISP Context to default location with alternate filename</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>MISP.Tools on GitHub</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/misp.tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-MispContext</command:name> <command:verb>Save</command:verb> <command:noun>MispContext</command:noun> <maml:description> <maml:para>Search MISP for Attributes matching the specified Search Criteria.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Search MISP for Attributes matching the specified Search Criteria as per criteria defined in the documentation (https://www.misp-project.org/openapi/#tag/Attributes/operation/restSearchAttributes)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-MispContext</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object - MISP Context</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String - DestinationPath</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String - Filename</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $Search = @{eventId = 12345} PS > $MispAttributes = Search-MispAttributes -Context $MispContext -Search $Search</dev:code> <dev:remarks> <maml:para>Search for MISP Attributes related to Event Id 12345</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $Search = @{ eventId = 12345 type = 'ip-src' org = 1 } PS > $MispAttributes = Search-MispAttributes -Context $MispContext -Search $Search</dev:code> <dev:remarks> <maml:para>Search for MISP attributes related to Event Id 12345 of type 'ip-src' and matching Organisation 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>MISP.Tools on GitHub</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/misp.tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |