File size: 18,319 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections.Generic;
using System.Management.Automation.Internal;
using System.Text;
namespace System.Management.Automation
{
/// <summary>
/// Monad Logging in general is a two layer architecture. At the upper layer are the
/// Msh Log Engine and Logging Api. At the lower layer is the Provider Interface
/// and Log Providers. This architecture is adopted to achieve independency between
/// Monad logging and logging details of different logging technology.
///
/// This file implements the lower layer of the Monad Logging architecture.
/// Upper layer of Msh Log architecture is implemented in MshLog.cs file.
///
/// This class defines the provider interface to be implemented by each providers.
///
/// Provider Interface.
///
/// Corresponding to 5 categories of logging api interface, provider interface provides
/// functions for logging
/// a. EngineHealthEvent
/// b. EngineLifecycleEvent
/// c. CommandLifecycleEvent
/// d. ProviderLifecycleEvent
/// e. SettingsEvent.
/// </summary>
internal abstract class LogProvider
{
/// <summary>
/// Constructor.
/// </summary>
internal LogProvider()
{
}
#region Provider api
/// <summary>
/// Provider interface function for logging health event.
/// </summary>
/// <param name="logContext"></param>
/// <param name="eventId"></param>
/// <param name="exception"></param>
/// <param name="additionalInfo"></param>
internal abstract void LogEngineHealthEvent(LogContext logContext, int eventId, Exception exception, Dictionary<string, string> additionalInfo);
/// <summary>
/// Provider interface function for logging engine lifecycle event.
/// </summary>
/// <param name="logContext"></param>
/// <param name="newState"></param>
/// <param name="previousState"></param>
internal abstract void LogEngineLifecycleEvent(LogContext logContext, EngineState newState, EngineState previousState);
/// <summary>
/// Provider interface function for logging command health event.
/// </summary>
/// <param name="logContext"></param>
/// <param name="exception"></param>
internal abstract void LogCommandHealthEvent(LogContext logContext, Exception exception);
/// <summary>
/// Provider interface function for logging command lifecycle event.
/// </summary>
/// <param name="getLogContext"></param>
/// <param name="newState"></param>
internal abstract void LogCommandLifecycleEvent(Func<LogContext> getLogContext, CommandState newState);
/// <summary>
/// Provider interface function for logging pipeline execution detail.
/// </summary>
/// <param name="logContext"></param>
/// <param name="pipelineExecutionDetail"></param>
internal abstract void LogPipelineExecutionDetailEvent(LogContext logContext, List<string> pipelineExecutionDetail);
/// <summary>
/// Provider interface function for logging provider health event.
/// </summary>
/// <param name="logContext"></param>
/// <param name="providerName"></param>
/// <param name="exception"></param>
internal abstract void LogProviderHealthEvent(LogContext logContext, string providerName, Exception exception);
/// <summary>
/// Provider interface function for logging provider lifecycle event.
/// </summary>
/// <param name="logContext"></param>
/// <param name="providerName"></param>
/// <param name="newState"></param>
internal abstract void LogProviderLifecycleEvent(LogContext logContext, string providerName, ProviderState newState);
/// <summary>
/// Provider interface function for logging settings event.
/// </summary>
/// <param name="logContext"></param>
/// <param name="variableName"></param>
/// <param name="value"></param>
/// <param name="previousValue"></param>
internal abstract void LogSettingsEvent(LogContext logContext, string variableName, string value, string previousValue);
/// <summary>
/// Provider interface function for logging AmsiUtil State event.
/// </summary>
/// <param name="state">This the action performed in AmsiUtil class, like init, scan, etc.</param>
/// <param name="context">The amsiContext handled - Session pair.</param>
internal abstract void LogAmsiUtilStateEvent(string state, string context);
/// <summary>
/// Provider interface function for logging WDAC query event.
/// </summary>
/// <param name="queryName">Name of the WDAC query.</param>
/// <param name="fileName">Name of script file for policy query. Can be null value.</param>
/// <param name="querySuccess">Query call succeed code.</param>
/// <param name="queryResult">Result code of WDAC query.</param>
internal abstract void LogWDACQueryEvent(
string queryName,
string fileName,
int querySuccess,
int queryResult);
/// <summary>
/// Provider interface function for logging WDAC audit event.
/// </summary>
/// <param name="title">Title of WDAC audit event.</param>
/// <param name="message">WDAC audit event message.</param>
/// <param name="fqid">FullyQualifiedId of WDAC audit event.</param>
internal abstract void LogWDACAuditEvent(
string title,
string message,
string fqid);
/// <summary>
/// True if the log provider needs to use logging variables.
/// </summary>
/// <returns></returns>
internal virtual bool UseLoggingVariables()
{
return true;
}
#endregion
#region Shared utilities
private static class Strings
{
// The strings are stored in a different class to defer loading the resources until as late
// as possible, e.g. if logging is never on, these strings won't be loaded.
internal static readonly string LogContextSeverity = EtwLoggingStrings.LogContextSeverity;
internal static readonly string LogContextHostName = EtwLoggingStrings.LogContextHostName;
internal static readonly string LogContextHostVersion = EtwLoggingStrings.LogContextHostVersion;
internal static readonly string LogContextHostId = EtwLoggingStrings.LogContextHostId;
internal static readonly string LogContextHostApplication = EtwLoggingStrings.LogContextHostApplication;
internal static readonly string LogContextEngineVersion = EtwLoggingStrings.LogContextEngineVersion;
internal static readonly string LogContextRunspaceId = EtwLoggingStrings.LogContextRunspaceId;
internal static readonly string LogContextPipelineId = EtwLoggingStrings.LogContextPipelineId;
internal static readonly string LogContextCommandName = EtwLoggingStrings.LogContextCommandName;
internal static readonly string LogContextCommandType = EtwLoggingStrings.LogContextCommandType;
internal static readonly string LogContextScriptName = EtwLoggingStrings.LogContextScriptName;
internal static readonly string LogContextCommandPath = EtwLoggingStrings.LogContextCommandPath;
internal static readonly string LogContextSequenceNumber = EtwLoggingStrings.LogContextSequenceNumber;
internal static readonly string LogContextUser = EtwLoggingStrings.LogContextUser;
internal static readonly string LogContextConnectedUser = EtwLoggingStrings.LogContextConnectedUser;
internal static readonly string LogContextTime = EtwLoggingStrings.LogContextTime;
internal static readonly string LogContextShellId = EtwLoggingStrings.LogContextShellId;
}
/// <summary>
/// Gets PSLogUserData from execution context.
/// </summary>
/// <param name="context"></param>
/// <returns></returns>
protected static string GetPSLogUserData(ExecutionContext context)
{
if (context == null)
{
return string.Empty;
}
object logData = context.GetVariableValue(SpecialVariables.PSLogUserDataPath);
if (logData == null)
{
return string.Empty;
}
return logData.ToString();
}
/// <summary>
/// Appends exception information.
/// </summary>
/// <param name="sb">String builder.</param>
/// <param name="except">Exception.</param>
protected static void AppendException(StringBuilder sb, Exception except)
{
sb.AppendLine(StringUtil.Format(EtwLoggingStrings.ErrorRecordMessage, except.Message));
if (except is IContainsErrorRecord ier)
{
ErrorRecord er = ier.ErrorRecord;
if (er != null)
{
sb.AppendLine(StringUtil.Format(EtwLoggingStrings.ErrorRecordId, er.FullyQualifiedErrorId));
ErrorDetails details = er.ErrorDetails;
if (details != null)
{
sb.AppendLine(StringUtil.Format(EtwLoggingStrings.ErrorRecordRecommendedAction, details.RecommendedAction));
}
}
}
}
/// <summary>
/// Appends additional information.
/// </summary>
/// <param name="sb">String builder.</param>
/// <param name="additionalInfo">Additional information.</param>
protected static void AppendAdditionalInfo(StringBuilder sb, Dictionary<string, string> additionalInfo)
{
if (additionalInfo != null)
{
foreach (KeyValuePair<string, string> value in additionalInfo)
{
sb.AppendLine(StringUtil.Format("{0} = {1}", value.Key, value.Value));
}
}
}
/// <summary>
/// Gets PSLevel from severity.
/// </summary>
/// <param name="severity">Error severity.</param>
/// <returns>PS log level.</returns>
protected static PSLevel GetPSLevelFromSeverity(string severity)
{
switch (severity)
{
case "Critical":
case "Error":
return PSLevel.Error;
case "Warning":
return PSLevel.Warning;
default:
return PSLevel.Informational;
}
}
// Estimate an approximate size to use for the StringBuilder in LogContextToString
// Estimated length of all Strings.* values
// Rough estimate of values
// max path for Command path
private const int LogContextInitialSize = 30 * 16 + 13 * 20 + 255;
/// <summary>
/// Converts log context to string.
/// </summary>
/// <param name="context">Log context.</param>
/// <returns>String representation.</returns>
protected static string LogContextToString(LogContext context)
{
StringBuilder sb = new StringBuilder(LogContextInitialSize);
sb.Append(Strings.LogContextSeverity);
sb.AppendLine(context.Severity);
sb.Append(Strings.LogContextHostName);
sb.AppendLine(context.HostName);
sb.Append(Strings.LogContextHostVersion);
sb.AppendLine(context.HostVersion);
sb.Append(Strings.LogContextHostId);
sb.AppendLine(context.HostId);
sb.Append(Strings.LogContextHostApplication);
sb.AppendLine(context.HostApplication);
sb.Append(Strings.LogContextEngineVersion);
sb.AppendLine(context.EngineVersion);
sb.Append(Strings.LogContextRunspaceId);
sb.AppendLine(context.RunspaceId);
sb.Append(Strings.LogContextPipelineId);
sb.AppendLine(context.PipelineId);
sb.Append(Strings.LogContextCommandName);
sb.AppendLine(context.CommandName);
sb.Append(Strings.LogContextCommandType);
sb.AppendLine(context.CommandType);
sb.Append(Strings.LogContextScriptName);
sb.AppendLine(context.ScriptName);
sb.Append(Strings.LogContextCommandPath);
sb.AppendLine(context.CommandPath);
sb.Append(Strings.LogContextSequenceNumber);
sb.AppendLine(context.SequenceNumber);
sb.Append(Strings.LogContextUser);
sb.AppendLine(context.User);
sb.Append(Strings.LogContextConnectedUser);
sb.AppendLine(context.ConnectedUser);
sb.Append(Strings.LogContextShellId);
sb.AppendLine(context.ShellId);
return sb.ToString();
}
#endregion
}
/// <summary>
/// </summary>
internal class DummyLogProvider : LogProvider
{
/// <summary>
/// Constructor.
/// </summary>
internal DummyLogProvider()
{
}
#region Provider api
/// <summary>
/// DummyLogProvider does nothing to Logging EngineHealthEvent.
/// </summary>
/// <param name="logContext"></param>
/// <param name="eventId"></param>
/// <param name="exception"></param>
/// <param name="additionalInfo"></param>
internal override void LogEngineHealthEvent(LogContext logContext, int eventId, Exception exception, Dictionary<string, string> additionalInfo)
{
}
/// <summary>
/// DummyLogProvider does nothing to Logging EngineLifecycleEvent.
/// </summary>
/// <param name="logContext"></param>
/// <param name="newState"></param>
/// <param name="previousState"></param>
internal override void LogEngineLifecycleEvent(LogContext logContext, EngineState newState, EngineState previousState)
{
}
/// <summary>
/// Provider interface function for logging command health event.
/// </summary>
/// <param name="logContext"></param>
/// <param name="exception"></param>
internal override void LogCommandHealthEvent(LogContext logContext, Exception exception)
{
}
/// <summary>
/// DummyLogProvider does nothing to Logging CommandLifecycleEvent.
/// </summary>
/// <param name="getLogContext"></param>
/// <param name="newState"></param>
internal override void LogCommandLifecycleEvent(Func<LogContext> getLogContext, CommandState newState)
{
}
/// <summary>
/// DummyLogProvider does nothing to Logging PipelineExecutionDetailEvent.
/// </summary>
/// <param name="logContext"></param>
/// <param name="pipelineExecutionDetail"></param>
internal override void LogPipelineExecutionDetailEvent(LogContext logContext, List<string> pipelineExecutionDetail)
{
}
/// <summary>
/// Provider interface function for logging provider health event.
/// </summary>
/// <param name="logContext"></param>
/// <param name="providerName"></param>
/// <param name="exception"></param>
internal override void LogProviderHealthEvent(LogContext logContext, string providerName, Exception exception)
{
}
/// <summary>
/// DummyLogProvider does nothing to Logging ProviderLifecycleEvent.
/// </summary>
/// <param name="logContext"></param>
/// <param name="providerName"></param>
/// <param name="newState"></param>
internal override void LogProviderLifecycleEvent(LogContext logContext, string providerName, ProviderState newState)
{
}
/// <summary>
/// DummyLogProvider does nothing to Logging SettingsEvent.
/// </summary>
/// <param name="logContext"></param>
/// <param name="variableName"></param>
/// <param name="value"></param>
/// <param name="previousValue"></param>
internal override void LogSettingsEvent(LogContext logContext, string variableName, string value, string previousValue)
{
}
/// <summary>
/// Provider interface function for logging provider health event.
/// </summary>
/// <param name="state">This the action performed in AmsiUtil class, like init, scan, etc.</param>
/// <param name="context">The amsiContext handled - Session pair.</param>
internal override void LogAmsiUtilStateEvent(string state, string context)
{
}
/// <summary>
/// Provider interface function for logging WDAC query event.
/// </summary>
/// <param name="queryName">Name of the WDAC query.</param>
/// <param name="fileName">Name of script file for policy query. Can be null value.</param>
/// <param name="querySuccess">Query call succeed code.</param>
/// <param name="queryResult">Result code of WDAC query.</param>
internal override void LogWDACQueryEvent(
string queryName,
string fileName,
int querySuccess,
int queryResult)
{
}
/// <summary>
/// Provider interface function for logging WDAC audit event.
/// </summary>
/// <param name="title">Title of WDAC audit event.</param>
/// <param name="message">WDAC audit event message.</param>
/// <param name="fqid">FullyQualifiedId of WDAC audit event.</param>
internal override void LogWDACAuditEvent(
string title,
string message,
string fqid)
{
}
#endregion
}
}
|