| | | 1 | | using Microsoft.Extensions.Logging; |
| | | 2 | | |
| | | 3 | | namespace Chronicis.Shared.Extensions; |
| | | 4 | | |
| | | 5 | | /// <summary> |
| | | 6 | | /// Extension methods for ILogger that automatically sanitize user input before logging. |
| | | 7 | | /// These methods should be used whenever logging data that originates from user input. |
| | | 8 | | /// </summary> |
| | | 9 | | public static class LoggerExtensions |
| | | 10 | | { |
| | | 11 | | #pragma warning disable CA2254 |
| | | 12 | | /// <summary> |
| | | 13 | | /// Logs an informational message with sanitized arguments. |
| | | 14 | | /// Use this when logging user-provided data. |
| | | 15 | | /// </summary> |
| | | 16 | | public static void LogInformationSanitized(this ILogger logger, string message, params object?[] args) |
| | | 17 | | { |
| | 10 | 18 | | if (!logger.IsEnabled(LogLevel.Information)) |
| | 2 | 19 | | return; |
| | | 20 | | |
| | 8 | 21 | | var sanitizedArgs = args.Select(arg => Utilities.LogSanitizer.SanitizeObject(arg)).ToArray(); |
| | 8 | 22 | | logger.LogInformation(message, sanitizedArgs); |
| | 8 | 23 | | } |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// Logs a warning message with sanitized arguments. |
| | | 27 | | /// Use this when logging user-provided data. |
| | | 28 | | /// </summary> |
| | | 29 | | public static void LogWarningSanitized(this ILogger logger, string message, params object?[] args) |
| | | 30 | | { |
| | 5 | 31 | | if (!logger.IsEnabled(LogLevel.Warning)) |
| | 2 | 32 | | return; |
| | | 33 | | |
| | 3 | 34 | | var sanitizedArgs = args.Select(arg => Utilities.LogSanitizer.SanitizeObject(arg)).ToArray(); |
| | 3 | 35 | | logger.LogWarning(message, sanitizedArgs); |
| | 3 | 36 | | } |
| | | 37 | | |
| | | 38 | | /// <summary> |
| | | 39 | | /// Logs a warning message with exception and sanitized arguments. |
| | | 40 | | /// Use this when logging user-provided data along with an exception. |
| | | 41 | | /// </summary> |
| | | 42 | | public static void LogWarningSanitized(this ILogger logger, Exception exception, string message, params object?[] ar |
| | | 43 | | { |
| | 2 | 44 | | if (!logger.IsEnabled(LogLevel.Warning)) |
| | 1 | 45 | | return; |
| | | 46 | | |
| | 1 | 47 | | var sanitizedArgs = args.Select(arg => Utilities.LogSanitizer.SanitizeObject(arg)).ToArray(); |
| | 1 | 48 | | logger.LogWarning(exception, message, sanitizedArgs); |
| | 1 | 49 | | } |
| | | 50 | | |
| | | 51 | | /// <summary> |
| | | 52 | | /// Logs an error message with sanitized arguments. |
| | | 53 | | /// Use this when logging user-provided data. |
| | | 54 | | /// </summary> |
| | | 55 | | public static void LogErrorSanitized(this ILogger logger, string message, params object?[] args) |
| | | 56 | | { |
| | 5 | 57 | | if (!logger.IsEnabled(LogLevel.Error)) |
| | 2 | 58 | | return; |
| | | 59 | | |
| | 3 | 60 | | var sanitizedArgs = args.Select(arg => Utilities.LogSanitizer.SanitizeObject(arg)).ToArray(); |
| | | 61 | | |
| | 3 | 62 | | logger.LogError(message, sanitizedArgs); |
| | 3 | 63 | | } |
| | | 64 | | |
| | | 65 | | /// <summary> |
| | | 66 | | /// Logs an error message with exception and sanitized arguments. |
| | | 67 | | /// Use this when logging user-provided data along with an exception. |
| | | 68 | | /// </summary> |
| | | 69 | | public static void LogErrorSanitized(this ILogger logger, Exception exception, string message, params object?[] args |
| | | 70 | | { |
| | 3 | 71 | | if (!logger.IsEnabled(LogLevel.Error)) |
| | 1 | 72 | | return; |
| | | 73 | | |
| | 2 | 74 | | var sanitizedArgs = args.Select(arg => Utilities.LogSanitizer.SanitizeObject(arg)).ToArray(); |
| | 2 | 75 | | logger.LogError(exception, message, sanitizedArgs); |
| | 2 | 76 | | } |
| | | 77 | | |
| | | 78 | | /// <summary> |
| | | 79 | | /// Logs a debug message with sanitized arguments. |
| | | 80 | | /// Use this when logging user-provided data. |
| | | 81 | | /// </summary> |
| | | 82 | | public static void LogDebugSanitized(this ILogger logger, string message, params object?[] args) |
| | | 83 | | { |
| | 5 | 84 | | if (!logger.IsEnabled(LogLevel.Debug)) |
| | 2 | 85 | | return; |
| | | 86 | | |
| | 3 | 87 | | var sanitizedArgs = args.Select(arg => Utilities.LogSanitizer.SanitizeObject(arg)).ToArray(); |
| | 3 | 88 | | logger.LogDebug(message, sanitizedArgs); |
| | 3 | 89 | | } |
| | | 90 | | |
| | | 91 | | /// <summary> |
| | | 92 | | /// Logs a trace message with sanitized arguments. |
| | | 93 | | /// Use this when logging user-provided data. |
| | | 94 | | /// </summary> |
| | | 95 | | public static void LogTraceSanitized(this ILogger logger, string message, params object?[] args) |
| | | 96 | | { |
| | 5 | 97 | | if (!logger.IsEnabled(LogLevel.Trace)) |
| | 2 | 98 | | return; |
| | | 99 | | |
| | 3 | 100 | | var sanitizedArgs = args.Select(arg => Utilities.LogSanitizer.SanitizeObject(arg)).ToArray(); |
| | 3 | 101 | | logger.LogTrace(message, sanitizedArgs); |
| | 3 | 102 | | } |
| | | 103 | | |
| | | 104 | | /// <summary> |
| | | 105 | | /// Logs a trace message with exception and sanitized arguments. |
| | | 106 | | /// Use this when logging user-provided data along with an exception. |
| | | 107 | | /// </summary> |
| | | 108 | | public static void LogTraceSanitized(this ILogger logger, Exception exception, string message, params object?[] args |
| | | 109 | | { |
| | 2 | 110 | | if (!logger.IsEnabled(LogLevel.Trace)) |
| | 1 | 111 | | return; |
| | | 112 | | |
| | 1 | 113 | | var sanitizedArgs = args.Select(arg => Utilities.LogSanitizer.SanitizeObject(arg)).ToArray(); |
| | 1 | 114 | | logger.LogTrace(exception, message, sanitizedArgs); |
| | 1 | 115 | | } |
| | | 116 | | |
| | | 117 | | /// <summary> |
| | | 118 | | /// Logs a critical message with sanitized arguments. |
| | | 119 | | /// Use this when logging user-provided data. |
| | | 120 | | /// </summary> |
| | | 121 | | public static void LogCriticalSanitized(this ILogger logger, string message, params object?[] args) |
| | | 122 | | { |
| | 5 | 123 | | if (!logger.IsEnabled(LogLevel.Critical)) |
| | 2 | 124 | | return; |
| | | 125 | | |
| | 3 | 126 | | var sanitizedArgs = args.Select(arg => Utilities.LogSanitizer.SanitizeObject(arg)).ToArray(); |
| | 3 | 127 | | logger.LogCritical(message, sanitizedArgs); |
| | 3 | 128 | | } |
| | | 129 | | |
| | | 130 | | /// <summary> |
| | | 131 | | /// Logs a critical message with exception and sanitized arguments. |
| | | 132 | | /// Use this when logging user-provided data along with an exception. |
| | | 133 | | /// </summary> |
| | | 134 | | public static void LogCriticalSanitized(this ILogger logger, Exception exception, string message, params object?[] a |
| | | 135 | | { |
| | 2 | 136 | | if (!logger.IsEnabled(LogLevel.Critical)) |
| | 1 | 137 | | return; |
| | | 138 | | |
| | 1 | 139 | | var sanitizedArgs = args.Select(arg => Utilities.LogSanitizer.SanitizeObject(arg)).ToArray(); |
| | 1 | 140 | | logger.LogCritical(exception, message, sanitizedArgs); |
| | 1 | 141 | | } |
| | | 142 | | |
| | | 143 | | #pragma warning restore CA2254 |
| | | 144 | | } |