Lib/Default/FileInspectorX.PowerShell.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>FileInspectorX.PowerShell</name> </assembly> <members> <member name="T:FileInspectorX.PowerShell.CmdletGetFileInsight"> <summary> <para type="synopsis">Analyzes files and returns a full FileAnalysis object by default, with optional compact views.</para> <para type="description">By default (-View Raw), returns the full FileAnalysis with detection, flags, permissions (unless excluded), signatures, installer metadata, references and assessment. Use -View to project compact views (Summary/Detection/Analysis/Permissions/Signature/References/Assessment/Installer/ShellProperties). Each view exposes Raw with the full FileAnalysis for drill-down.</para> <example> <para>Analyze a single file</para> <code>Get-FileInsight -Path C:\\files\\sample.docx</code> </example> <example> <para>Detect only (no analysis)</para> <code>Get-FileInsight -Path .\\payload.bin -DetectOnly</code> </example> <example> <para>Detect only for all EXE files under current directory</para> <code>Get-ChildItem -Filter *.exe -File -Recurse | Get-FileInsight -View Detection</code> </example> <example> <para>Summarize a directory, skipping signature and installer enrichment</para> <code>Get-ChildItem -File -Recurse | Get-FileInsight -View Summary -ExcludeSignature -ExcludeInstaller</code> </example> <example> <para>Include SHA-256 and first 16 bytes header (hex)</para> <code>Get-FileInsight -Path .\\app.exe -ComputeSha256 -MagicHeaderBytes 16</code> </example> <seealso cref="T:FileInspectorX.PowerShell.AsyncPSCmdlet" /> </summary> </member> <member name="P:FileInspectorX.PowerShell.CmdletGetFileInsight.Path"> <summary> One or more file paths to analyze. Accepts pipeline input of strings and resolves PowerShell provider paths. </summary> </member> <member name="P:FileInspectorX.PowerShell.CmdletGetFileInsight.View"> <summary>Output shape to emit. Defaults to Raw (full FileAnalysis object). Other values: Summary, Detection, Analysis, Permissions, Signature, References, Assessment, Policy, Installer, ShellProperties.</summary> </member> <member name="P:FileInspectorX.PowerShell.CmdletGetFileInsight.DetectOnly"> <summary>Return only detection result (skip analysis). Back-compat shim for -View Detection.</summary> </member> <member name="P:FileInspectorX.PowerShell.CmdletGetFileInsight.ComputeSha256"> <summary>Compute SHA-256 of the file and include in output.</summary> </member> <member name="P:FileInspectorX.PowerShell.CmdletGetFileInsight.MagicHeaderBytes"> <summary>Capture first N bytes of the header as uppercase hex.</summary> </member> <member name="P:FileInspectorX.PowerShell.CmdletGetFileInsight.ExcludePermissions"> <summary>Exclude permissions/ownership snapshot from the analysis.</summary> </member> <member name="P:FileInspectorX.PowerShell.CmdletGetFileInsight.ExcludeSignature"> <summary>Exclude signature/Authenticode and package signature analysis.</summary> </member> <member name="P:FileInspectorX.PowerShell.CmdletGetFileInsight.ExcludeReferences"> <summary>Exclude references extraction (Task XML, scripts.ini/xml).</summary> </member> <member name="P:FileInspectorX.PowerShell.CmdletGetFileInsight.ExcludeInstaller"> <summary>Exclude installer/package metadata (MSIX/APPX/VSIX/MSI).</summary> </member> <member name="P:FileInspectorX.PowerShell.CmdletGetFileInsight.ExcludeContainer"> <summary>Exclude container triage (ZIP/TAR sampling, subtype and inner hints).</summary> </member> <member name="P:FileInspectorX.PowerShell.CmdletGetFileInsight.ExcludeAssessment"> <summary>Exclude assessment (score/decision/codes).</summary> </member> <member name="P:FileInspectorX.PowerShell.CmdletGetFileInsight.ExcludeShellProperties"> <summary>Exclude Windows shell properties (Explorer Details).</summary> </member> <member name="M:FileInspectorX.PowerShell.CmdletGetFileInsight.BeginProcessingAsync"> <inheritdoc /> </member> <member name="M:FileInspectorX.PowerShell.CmdletGetFileInsight.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:FileInspectorX.PowerShell.AsyncPSCmdlet"> <summary> An abstract base class for asynchronous PowerShell cmdlets. </summary> </member> <member name="T:FileInspectorX.PowerShell.AsyncPSCmdlet.PipelineType"> <summary> Defines the types of pipelines used in the cmdlet. </summary> </member> <member name="F:FileInspectorX.PowerShell.AsyncPSCmdlet._cancelSource"> <summary> Cancels the processing of the cmdlet. </summary> </member> <member name="P:FileInspectorX.PowerShell.AsyncPSCmdlet.CancelToken"> <summary> Gets the cancellation token that is triggered when the cmdlet is stopped. </summary> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.BeginProcessing"> <inheritdoc /> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.BeginProcessingAsync"> <summary> Override this method to implement asynchronous begin processing logic. </summary> <returns>A task representing the asynchronous operation.</returns> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.ProcessRecordAsync"> <summary> Override this method to implement asynchronous record processing logic. </summary> <returns>A task representing the asynchronous operation.</returns> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.EndProcessing"> <inheritdoc /> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.EndProcessingAsync"> <summary> Override this method to implement asynchronous end processing logic. </summary> <returns>A task representing the asynchronous operation.</returns> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.StopProcessing"> <inheritdoc /> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.RunBlockInAsync(System.Func{System.Threading.Tasks.Task})"> <summary> Runs the specified task asynchronously and handles the output and reply pipelines. </summary> <param name="task">The task to run asynchronously.</param> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.ShouldProcess(System.String,System.String)"> <summary> Determines whether the cmdlet should continue processing. </summary> <param name="target">The target of the operation.</param> <param name="action">The action to be performed.</param> <returns>True if the cmdlet should continue processing; otherwise, false.</returns> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.WriteObject(System.Object)"> <summary> Writes an object to the output pipeline. </summary> <param name="sendToPipeline">The object to send to the pipeline.</param> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.WriteObject(System.Object,System.Boolean)"> <summary> Writes an object to the output pipeline, optionally enumerating collections. </summary> <param name="sendToPipeline">The object to send to the pipeline.</param> <param name="enumerateCollection">If true, enumerates the collection.</param> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.WriteError(System.Management.Automation.ErrorRecord)"> <summary> Writes an error record to the error pipeline. </summary> <param name="errorRecord">The error record to write.</param> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.WriteWarning(System.String)"> <summary> Writes a warning message to the warning pipeline. </summary> <param name="message">The warning message to write.</param> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.WriteVerbose(System.String)"> <summary> Writes a verbose message to the verbose pipeline. </summary> <param name="message">The verbose message to write.</param> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.WriteDebug(System.String)"> <summary> Writes a debug message to the debug pipeline. </summary> <param name="message">The debug message to write.</param> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.WriteInformation(System.Management.Automation.InformationRecord)"> <summary> Writes an information record to the information pipeline. </summary> <param name="informationRecord">The information record to write.</param> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.WriteProgress(System.Management.Automation.ProgressRecord)"> <summary> Writes a progress record to the progress pipeline. </summary> <param name="progressRecord">The progress record to write.</param> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.ThrowIfStopped"> <summary> Throws a <see cref="T:System.Management.Automation.PipelineStoppedException"/> if the cmdlet has been stopped. </summary> </member> <member name="M:FileInspectorX.PowerShell.AsyncPSCmdlet.Dispose"> <summary> Disposes the resources used by the cmdlet. </summary> </member> <member name="T:FileInspectorX.PowerShell.InternalLoggerPowerShell"> <summary> This class allow connecting to the InternalLogger class of ADPlayground and act on events from it in different streams </summary> </member> <member name="M:FileInspectorX.PowerShell.InternalLoggerPowerShell.#ctor(FileInspectorX.InternalLogger,System.Action{System.String},System.Action{System.String},System.Action{System.String},System.Action{System.Management.Automation.ErrorRecord},System.Action{System.Management.Automation.ProgressRecord},System.Action{System.Management.Automation.InformationRecord})"> <summary> Initialize the InternalLoggerPowerShell class </summary> <param name="logger"></param> <param name="writeVerboseAction"></param> <param name="writeWarningAction"></param> <param name="writeDebugAction"></param> <param name="writeErrorAction"></param> <param name="writeProgressAction"></param> <param name="writeInformationAction"></param> </member> <member name="M:FileInspectorX.PowerShell.InternalLoggerPowerShell.Logger_OnVerboseMessage(System.Object,FileInspectorX.LogEventArgs)"> <summary> Message event handler </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:FileInspectorX.PowerShell.InternalLoggerPowerShell.WriteVerbose(System.String,System.Object[])"> <summary> Method to write verbose message to PowerShell </summary> <param name="message"></param> <param name="eArgs"></param> </member> <member name="T:OnModuleImportAndRemove"> <summary> OnModuleImportAndRemove is a class that implements the IModuleAssemblyInitializer and IModuleAssemblyCleanup interfaces. This class is used to handle the assembly resolve event when the module is imported and removed. </summary> </member> <member name="M:OnModuleImportAndRemove.OnImport"> <inheritdoc /> </member> <member name="M:OnModuleImportAndRemove.OnRemove(System.Management.Automation.PSModuleInfo)"> <inheritdoc /> </member> <member name="M:OnModuleImportAndRemove.MyResolveEventHandler(System.Object,System.ResolveEventArgs)"> <summary> MyResolveEventHandler is a method that handles the AssemblyResolve event. </summary> <param name="sender"></param> <param name="args"></param> <returns></returns> </member> <member name="M:OnModuleImportAndRemove.IsNetFramework"> <summary> Determine if the current runtime is .NET Framework </summary> <returns></returns> </member> <member name="M:OnModuleImportAndRemove.IsNet5OrHigher"> <summary> Determine if the current runtime is .NET 5 or higher </summary> <returns></returns> </member> </members> </doc> |