File size: 14,702 Bytes
8c763fb | 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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Globalization;
using System.Management.Automation.Host;
using System.Management.Automation.Remoting.Server;
using System.Management.Automation.Runspaces;
using Dbg = System.Management.Automation.Diagnostics;
namespace System.Management.Automation.Remoting
{
/// <summary>
/// The ServerRemoteHost class.
/// </summary>
internal class ServerRemoteHost : PSHost, IHostSupportsInteractiveSession
{
#region Private Members
/// <summary>
/// Remote host user interface.
/// </summary>
private readonly ServerRemoteHostUserInterface _remoteHostUserInterface;
/// <summary>
/// Server method executor.
/// </summary>
private readonly ServerMethodExecutor _serverMethodExecutor;
/// <summary>
/// Client runspace pool id.
/// </summary>
private readonly Guid _clientRunspacePoolId;
/// <summary>
/// Client power shell id.
/// </summary>
private readonly Guid _clientPowerShellId;
/// <summary>
/// Transport manager.
/// </summary>
protected AbstractServerTransportManager _transportManager;
/// <summary>
/// ServerDriverRemoteHost.
/// </summary>
private readonly ServerDriverRemoteHost _serverDriverRemoteHost;
#endregion
#region Constructor
/// <summary>
/// Constructor for ServerRemoteHost.
/// </summary>
internal ServerRemoteHost(
Guid clientRunspacePoolId,
Guid clientPowerShellId,
HostInfo hostInfo,
AbstractServerTransportManager transportManager,
Runspace runspace,
ServerDriverRemoteHost serverDriverRemoteHost)
{
_clientRunspacePoolId = clientRunspacePoolId;
_clientPowerShellId = clientPowerShellId;
Dbg.Assert(hostInfo != null, "Expected hostInfo != null");
Dbg.Assert(transportManager != null, "Expected transportManager != null");
// Set host-info and the transport-manager.
HostInfo = hostInfo;
_transportManager = transportManager;
_serverDriverRemoteHost = serverDriverRemoteHost;
// Create the executor for the host methods.
_serverMethodExecutor = new ServerMethodExecutor(
clientRunspacePoolId, clientPowerShellId, _transportManager);
// Use HostInfo to create host-UI as null or non-null based on the client's host-UI.
_remoteHostUserInterface = hostInfo.IsHostUINull ? null : new ServerRemoteHostUserInterface(this);
Runspace = runspace;
}
#endregion
#region Properties
/// <summary>
/// Server method executor.
/// </summary>
internal ServerMethodExecutor ServerMethodExecutor
{
get { return _serverMethodExecutor; }
}
/// <summary>
/// The user interface.
/// </summary>
public override PSHostUserInterface UI
{
get { return _remoteHostUserInterface; }
}
/// <summary>
/// Name.
/// </summary>
public override string Name
{
get { return "ServerRemoteHost"; }
}
/// <summary>
/// Version.
/// </summary>
public override Version Version
{
get { return RemotingConstants.HostVersion; }
}
/// <summary>
/// Instance id.
/// </summary>
public override Guid InstanceId { get; } = Guid.NewGuid();
/// <summary>
/// Is runspace pushed.
/// </summary>
public virtual bool IsRunspacePushed
{
get
{
if (_serverDriverRemoteHost != null)
{
return _serverDriverRemoteHost.IsRunspacePushed;
}
else
{
throw RemoteHostExceptions.NewNotImplementedException(RemoteHostMethodId.GetIsRunspacePushed);
}
}
}
/// <summary>
/// Runspace.
/// </summary>
public Runspace Runspace { get; internal set; }
/// <summary>
/// Host info.
/// </summary>
internal HostInfo HostInfo { get; }
#endregion
#region Method Overrides
/// <summary>
/// Set should exit.
/// </summary>
public override void SetShouldExit(int exitCode)
{
_serverMethodExecutor.ExecuteVoidMethod(RemoteHostMethodId.SetShouldExit, new object[] { exitCode });
}
/// <summary>
/// Enter nested prompt.
/// </summary>
public override void EnterNestedPrompt()
{
throw RemoteHostExceptions.NewNotImplementedException(RemoteHostMethodId.EnterNestedPrompt);
}
/// <summary>
/// Exit nested prompt.
/// </summary>
public override void ExitNestedPrompt()
{
throw RemoteHostExceptions.NewNotImplementedException(RemoteHostMethodId.ExitNestedPrompt);
}
/// <summary>
/// Notify begin application.
/// </summary>
public override void NotifyBeginApplication()
{
// This is called when a native application is executed on the server. It gives the
// host an opportunity to save state that might be altered by the native application.
// This call should not be sent to the client because the native application running
// on the server cannot affect the state of the machine on the client.
}
/// <summary>
/// Notify end application.
/// </summary>
public override void NotifyEndApplication()
{
// See note in NotifyBeginApplication.
}
/// <summary>
/// Current culture.
/// </summary>
public override CultureInfo CurrentCulture
{
get
{
// Return the thread's current culture and rely on WinRM to set this
// correctly based on the client's culture.
return CultureInfo.CurrentCulture;
}
}
/// <summary>
/// Current ui culture.
/// </summary>
public override CultureInfo CurrentUICulture
{
get
{
// Return the thread's current UI culture and rely on WinRM to set
// this correctly based on the client's UI culture.
return CultureInfo.CurrentUICulture;
}
}
#endregion
#region Methods
/// <summary>
/// Push runspace.
/// </summary>
public virtual void PushRunspace(Runspace runspace)
{
if (_serverDriverRemoteHost != null)
{
_serverDriverRemoteHost.PushRunspace(runspace);
}
else
{
throw RemoteHostExceptions.NewNotImplementedException(RemoteHostMethodId.PushRunspace);
}
}
/// <summary>
/// Pop runspace.
/// </summary>
public virtual void PopRunspace()
{
if ((_serverDriverRemoteHost != null) && (_serverDriverRemoteHost.IsRunspacePushed))
{
if (_serverDriverRemoteHost.PropagatePop)
{
// Forward the PopRunspace command to client and keep *this* pushed runspace as
// the configured JEA restricted session.
_serverMethodExecutor.ExecuteVoidMethod(RemoteHostMethodId.PopRunspace);
}
else
{
_serverDriverRemoteHost.PopRunspace();
}
}
else
{
_serverMethodExecutor.ExecuteVoidMethod(RemoteHostMethodId.PopRunspace);
}
}
#endregion
}
/// <summary>
/// The remote host class for the ServerRunspacePoolDriver.
/// </summary>
internal class ServerDriverRemoteHost : ServerRemoteHost
{
#region Private Members
private RemoteRunspace _pushedRunspace;
private ServerRemoteDebugger _debugger;
private bool _hostSupportsPSEdit;
#endregion
#region Constructor
internal ServerDriverRemoteHost(
Guid clientRunspacePoolId,
Guid clientPowerShellId,
HostInfo hostInfo,
AbstractServerSessionTransportManager transportManager,
ServerRemoteDebugger debugger)
: base(clientRunspacePoolId, clientPowerShellId, hostInfo, transportManager, null, null)
{
_debugger = debugger;
}
#endregion
#region Overrides
/// <summary>
/// True if runspace is pushed.
/// </summary>
public override bool IsRunspacePushed
{
get
{
return (_pushedRunspace != null);
}
}
/// <summary>
/// Push runspace to use for remote command execution.
/// </summary>
/// <param name="runspace">RemoteRunspace.</param>
public override void PushRunspace(Runspace runspace)
{
if (_debugger == null)
{
throw new PSInvalidOperationException(RemotingErrorIdStrings.ServerDriverRemoteHostNoDebuggerToPush);
}
if (_pushedRunspace != null)
{
throw new PSInvalidOperationException(RemotingErrorIdStrings.ServerDriverRemoteHostAlreadyPushed);
}
if (runspace is not RemoteRunspace remoteRunspace)
{
throw new PSInvalidOperationException(RemotingErrorIdStrings.ServerDriverRemoteHostNotRemoteRunspace);
}
// PSEdit support. Existence of RemoteSessionOpenFileEvent event indicates host supports PSEdit
_hostSupportsPSEdit = false;
PSEventManager localEventManager = Runspace?.Events;
_hostSupportsPSEdit = localEventManager != null && localEventManager.GetEventSubscribers(HostUtilities.RemoteSessionOpenFileEvent).GetEnumerator().MoveNext();
if (_hostSupportsPSEdit)
{
AddPSEditForRunspace(remoteRunspace);
}
_debugger.PushDebugger(runspace.Debugger);
_pushedRunspace = remoteRunspace;
}
/// <summary>
/// Pop runspace.
/// </summary>
public override void PopRunspace()
{
if (_pushedRunspace != null)
{
_debugger?.PopDebugger();
if (_hostSupportsPSEdit)
{
RemovePSEditFromRunspace(_pushedRunspace);
}
if (_pushedRunspace.ShouldCloseOnPop)
{
_pushedRunspace.Close();
}
_pushedRunspace = null;
}
}
#endregion
#region Properties
/// <summary>
/// Server Debugger.
/// </summary>
internal Debugger ServerDebugger
{
get { return _debugger; }
set { _debugger = value as ServerRemoteDebugger; }
}
/// <summary>
/// Pushed runspace or null.
/// </summary>
internal Runspace PushedRunspace
{
get { return _pushedRunspace; }
}
/// <summary>
/// When true will propagate pop call to client after popping runspace from this
/// host. Used for OutOfProc remote sessions in a restricted (pushed) remote runspace,
/// where a pop (exit session) should occur.
/// </summary>
internal bool PropagatePop
{
get;
set;
}
#endregion
#region PSEdit Support for ISE Host
private void AddPSEditForRunspace(RemoteRunspace remoteRunspace)
{
if (remoteRunspace.Events == null)
{
return;
}
// Add event handler.
remoteRunspace.Events.ReceivedEvents.PSEventReceived += HandleRemoteSessionForwardedEvent;
// Add script function.
using (PowerShell powershell = PowerShell.Create())
{
powershell.Runspace = remoteRunspace;
powershell.AddScript(HostUtilities.CreatePSEditFunction).AddParameter("PSEditFunction", HostUtilities.PSEditFunction);
try
{
powershell.Invoke();
}
catch (RemoteException) { }
}
}
private void RemovePSEditFromRunspace(RemoteRunspace remoteRunspace)
{
if (remoteRunspace.Events == null)
{
return;
}
// It is possible for the popped runspace to be in a bad state after an error.
if ((remoteRunspace.RunspaceStateInfo.State != RunspaceState.Opened) || (remoteRunspace.RunspaceAvailability != RunspaceAvailability.Available))
{
return;
}
// Remove event handler.
remoteRunspace.Events.ReceivedEvents.PSEventReceived -= HandleRemoteSessionForwardedEvent;
// Remove script function.
using (PowerShell powershell = PowerShell.Create())
{
powershell.Runspace = remoteRunspace;
powershell.AddScript(HostUtilities.RemovePSEditFunction);
try
{
powershell.Invoke();
}
catch (RemoteException) { }
}
}
private void HandleRemoteSessionForwardedEvent(object sender, PSEventArgs args)
{
if ((Runspace == null) || (Runspace.Events == null))
{
return;
}
// Forward events from nested pushed session to parent session.
try
{
Runspace.Events.GenerateEvent(
sourceIdentifier: args.SourceIdentifier,
sender: null,
args: args.SourceArgs,
extraData: null);
}
catch (Exception)
{
}
}
#endregion
}
}
|