LANCommander/LANCommander.SDK/PowerShell/PowerShellScript.cs

using LANCommander.SDK.Enums;
using LANCommander.SDK.Helpers;
using LANCommander.SDK.PowerShell.Cmdlets;
using Microsoft.Extensions.Logging;
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Management.Automation;
using System.Management.Automation.Runspaces;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading.Tasks;
using System.Web.Services.Description;
using LANCommander.SDK.Factories;
using LANCommander.SDK.PowerShell.Extensions;
using Microsoft.Extensions.DependencyInjection;
using Serilog;
using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;

namespace LANCommander.SDK.PowerShell
{
    public class PowerShellScript
    {
        public ScriptType Type { get; private set; }
        private string Contents { get; set; }           = "";
        public string WorkingDirectory { get; private set; }   = "";
        private bool ShellExecute { get; set; }         = false;
        public bool RunAsAdmin { get; private set; }       = false;
        private bool IgnoreWow64 { get; set; }          = false;
        private bool Debug { get; set; }                = false;
        public PowerShellVariableList Variables { get; private set; }
        public Dictionary<string, string> Arguments { get; private set; }

        private InitialSessionState InitialSessionState { get; set; }

        private TaskCompletionSource<string> Input { get; set; }
        
        private IntPtr _wow64 = IntPtr.Zero;
        private ILogger<PowerShellScript> Logger { get; set; }
        private IServiceScope ServiceScope { get; set; }
        private IEnumerable<IScriptDebugger> Debuggers { get; set; }
        private System.Management.Automation.PowerShell Context { get; set; }

        private const string Logo = @"
   __   ___   _  _______                              __       
  / /  / _ | / |/ / ___/__  __ _  __ _  ___ ____  ___/ /__ ____
 / /__/ __ |/    / /__/ _ \/  ' \/  ' \/ _ `/ _ \/ _  / -_) __/
/____/_/ |_/_/|_/\___/\___/_/_/_/_/_/_/\_,_/_//_/\_,_/\__/_/   

";

        public PowerShellScript(
            IServiceProvider serviceProvider,
            ScriptType type)
        {
            
            Type = type;
            Variables = new PowerShellVariableList();
            Arguments = new Dictionary<string, string>();

            InitialSessionState = InitialSessionState.CreateDefault();
            InitialSessionState.RegisterCustomCmdlets();
            
            // Instantiate a new scope
            ServiceScope = serviceProvider.CreateScope();
            Logger = ServiceScope.ServiceProvider.GetService<ILogger<PowerShellScript>>();

            IgnoreWow64Redirection();
        }

        public PowerShellScript UseFile(string path)
        {
            Contents = File.ReadAllText(path);

            if (Contents.StartsWith("# Requires Admin"))
                RunAsAdmin = true;

            return this;
        }

        public PowerShellScript UseInline(string contents)
        {
            Contents = contents;

            if (Contents.StartsWith("# Requires Admin"))
                RunAsAdmin = true;

            return this;
        }

        public PowerShellScript UseWorkingDirectory(string path)
        {
            WorkingDirectory = path;

            return this;
        }

        public PowerShellScript UseShellExecute()
        {
            ShellExecute = true;

            return this;
        }

        public PowerShellScript AddVariable<T>(string name, T value)
        {
            Variables.Add(new PowerShellVariable(name, value, typeof(T)));

            return this;
        }

        public PowerShellScript AddArgument<T>(string name, T value)
        {
            Arguments.Add(name, $"\"{value}\"");

            return this;
        }

        public PowerShellScript AddArgument(string name, int value)
        {
            Arguments[name] = value.ToString();

            return this;
        }

        public PowerShellScript AddArgument(string name, long value)
        {
            Arguments[name] = value.ToString();

            return this;
        }

        public PowerShellScript IgnoreWow64Redirection()
        {
            IgnoreWow64 = true;

            return this;
        }

        public PowerShellScript EnableDebug()
        {
            Debug = true;

            return this;
        }

        public PowerShellScript AsAdmin()
        {
            RunAsAdmin = true;

            return this;
        }

        public async Task<T> ExecuteAsync<T>()
        {
            T result = default;

            DisableWow64Redirection();

            using (Runspace runspace = RunspaceFactory.CreateRunspace(InitialSessionState))
            {
                runspace.Open();

                runspace.SessionStateProxy.Path.SetLocation(WorkingDirectory);

                foreach (var variable in Variables)
                {
                    runspace.SessionStateProxy.SetVariable(variable.Name, variable.Value);
                }

                runspace.SessionStateProxy.SetVariable("Logo", Logo);
                runspace.SessionStateProxy.SetVariable("ScriptType", Type);
                runspace.SessionStateProxy.SetVariable("WorkingDirectory", WorkingDirectory);
                
                Context = System.Management.Automation.PowerShell.Create();

                Context.Runspace = runspace;

                await DebugAsync(async dbg =>
                {
                    await dbg.StartAsync(Context);
                });

                Context.AddScript("Write-Host $Logo");
                Context.AddScript(Contents);

                if (Debug) {
                    Context.AddScript("Write-Host '--------- DEBUG ---------'");
                    Context.AddScript("Write-Host \"Script Type: $ScriptType\"");
                    Context.AddScript("Write-Host \"Working Directory: $WorkingDirectory\"");
                    Context.AddScript("Write-Host 'Variables:'");

                    foreach (var variable in Variables)
                    {
                        Context.AddScript($"Write-Host '    ${variable.Name}'");
                    }

                    Context.AddScript("Write-Host ''");
                    Context.AddScript("Write-Host 'Enter \"exit\" to continue'");
                    
                    Context.Streams.Information.DataAdded += Information_DataAdded;
                    Context.Streams.Verbose.DataAdded += Verbose_DataAdded;
                    Context.Streams.Debug.DataAdded += Debug_DataAdded;
                    Context.Streams.Warning.DataAdded += Warning_DataAdded;
                    Context.Streams.Error.DataAdded += Error_DataAdded;
                }

                try
                {
                    var results = await Context.InvokeAsync();

                    await DebugAsync(async dbg =>
                    {
                        await dbg.BreakAsync(Context);
                    });
                    
                    var returnValue = Context.Runspace.SessionStateProxy.PSVariable.GetValue("Return");

                    if (returnValue != null)
                        result = (T)returnValue;
                }
                catch (Exception ex)
                {
                    Log.Error(ex, "Could not execute script");
                }
                finally
                {
                    Context.Dispose();
                }
            }

            RevertWow64Redirection();

            return result;
        }

        private async Task DebugAsync(Func<IScriptDebugger, Task> action)
        {
            if (!Debug)
                return;
            
            if (Debuggers == null)
                Debuggers = ServiceScope.ServiceProvider.GetServices<IScriptDebugger>();

            foreach (var debugger in Debuggers)
            {
                await action.Invoke(debugger);
            }
        }

        private async void Error_DataAdded(object sender, DataAddedEventArgs e)
        {
            var record = ((PSDataCollection<ErrorRecord>)sender)[e.Index];

            await DebugAsync(async dbg =>
            {
                await dbg.OutputAsync(LogLevel.Error, "{InvocationName} : {ExceptionMessage}", record.InvocationInfo.InvocationName, record.Exception.Message);
                await dbg.OutputAsync(LogLevel.Error, record.InvocationInfo.PositionMessage);
            });
        }

        private async void Warning_DataAdded(object sender, DataAddedEventArgs e)
        {
            var record = ((PSDataCollection<WarningRecord>)sender)[e.Index];
            
            await DebugAsync(async dbg =>
            {
                await dbg.OutputAsync(LogLevel.Warning, record.Message);
            });
        }

        private async void Debug_DataAdded(object sender, DataAddedEventArgs e)
        {
            var record = ((PSDataCollection<DebugRecord>)sender)[e.Index];

            await DebugAsync(async dbg =>
            {
                await dbg.OutputAsync(LogLevel.Debug, record.Message);
            });
        }

        private async void Verbose_DataAdded(object sender, DataAddedEventArgs e)
        {
            var record = ((PSDataCollection<VerboseRecord>)sender)[e.Index];

            await DebugAsync(async dbg =>
            {
                await dbg.OutputAsync(LogLevel.Trace, record.Message);
            });
        }

        private async void Information_DataAdded(object sender, DataAddedEventArgs e)
        {
            var record = ((PSDataCollection<InformationRecord>)sender)[e.Index];
            
            await DebugAsync(async dbg =>
            {
                await dbg.OutputAsync(LogLevel.Information, (record.MessageData as HostInformationMessage).Message);
            });
        }

        public static string Serialize<T>(T input)
        {
            var serializer = YamlSerializerFactory.Create();

            // Use the YamlDotNet serializer to generate a string for our input. Then convert to base64 so we can put it on one line.
            return Convert.ToBase64String(Encoding.UTF8.GetBytes(serializer.Serialize(input)));
        }

        private void DisableWow64Redirection()
        {
            try
            {
                if (IgnoreWow64)
                    Wow64DisableWow64FsRedirection(ref _wow64);
            }
            catch (Exception ex)
            {
                Logger.LogError(ex, "Could not disable Wow64 Redirection");
            }
        }

        private void RevertWow64Redirection()
        {
            try
            {
                if (IgnoreWow64 && _wow64 != IntPtr.Zero)
                    Wow64RevertWow64FsRedirection(ref _wow64);
            }
            catch (Exception ex)
            {
                Logger.LogError(ex, "Could not revert Wow64 Redirection");
            }
        }

        [DllImport("kernel32.dll", SetLastError = true)]
        static extern bool Wow64DisableWow64FsRedirection(ref IntPtr ptr);

        [DllImport("kernel32.dll", SetLastError = true)]
        static extern bool Wow64RevertWow64FsRedirection(ref IntPtr ptr);
    }
}