Fixed: Discordnotifier is now Notifiarr

Fixed: Cleanse Notifiarr APIKey from logs

Fixes #2130
Fixes #2221
This commit is contained in:
bakerboy448 2021-05-03 16:14:06 -05:00 committed by Qstick
parent 44bd224125
commit bd0e1899ae
9 changed files with 86 additions and 70 deletions

View File

@ -64,6 +64,7 @@ namespace NzbDrone.Common.Test.InstrumentationTests
[TestCase(@"OutputPath=/home/mySecret/Downloads")]
[TestCase("Hardlinking episode file: /home/mySecret/Downloads to /media/abc.mkv")]
[TestCase("Hardlink '/home/mySecret/Downloads/abs.mkv' to '/media/abc.mkv' failed.")]
[TestCase("https://notifiarr.com/notifier.php: api=1234530f-422f-4aac-b6b3-01233210aaaa&radarr_health_issue_message=Download")]
// Announce URLs (passkeys) Magnet & Tracker
[TestCase(@"magnet_uri"":""magnet:?xt=urn:btih:9pr04sgkillroyimaveql2tyu8xyui&dn=&tr=https%3a%2f%2fxxx.yyy%2f9pr04sg601233210imaveql2tyu8xyui%2fannounce""}")]

View File

@ -1,4 +1,4 @@
using System;
using System;
using System.Linq;
using System.Net;
using System.Text.RegularExpressions;
@ -11,7 +11,7 @@ namespace NzbDrone.Common.Instrumentation
private static readonly Regex[] CleansingRules = new[]
{
// Url
new Regex(@"(?<=\?|&)(apikey|token|passkey|auth|authkey|user|uid|api|[a-z_]*apikey|refresh_token|account|passwd)=(?<secret>[^&=]+?)(?= |&|$)", RegexOptions.Compiled | RegexOptions.IgnoreCase),
new Regex(@"(?<=\?|&|: )(apikey|token|passkey|auth|authkey|user|uid|api|[a-z_]*apikey|refresh_token|account|passwd)=(?<secret>[^&=]+?)(?= |&|$)", RegexOptions.Compiled | RegexOptions.IgnoreCase),
new Regex(@"(?<=\?|&)[^=]*?(username|password)=(?<secret>[^&=]+?)(?= |&|$)", RegexOptions.Compiled | RegexOptions.IgnoreCase),
new Regex(@"torrentleech\.org/(?!rss)(?<secret>[0-9a-z]+)", RegexOptions.Compiled | RegexOptions.IgnoreCase),
new Regex(@"torrentleech\.org/rss/download/[0-9]+/(?<secret>[0-9a-z]+)", RegexOptions.Compiled | RegexOptions.IgnoreCase),
@ -19,13 +19,13 @@ namespace NzbDrone.Common.Instrumentation
new Regex(@"/fetch/[a-z0-9]{32}/(?<secret>[a-z0-9]{32})", RegexOptions.Compiled),
new Regex(@"getnzb.*?(?<=\?|&)(r)=(?<secret>[^&=]+?)(?= |&|$)", RegexOptions.Compiled | RegexOptions.IgnoreCase),
// Trackers Announce Keys; Designed for Qbit Json; should work for all in theory
new Regex(@"announce(\.php)?(/|%2f|%3fpasskey%3d)(?<secret>[a-z0-9]{16,})|(?<secret>[a-z0-9]{16,})(/|%2f)announce"),
// Path
new Regex(@"C:\\Users\\(?<secret>[^\""]+?)(\\|$)", RegexOptions.Compiled | RegexOptions.IgnoreCase),
new Regex(@"/home/(?<secret>[^/""]+?)(/|$)", RegexOptions.Compiled | RegexOptions.IgnoreCase),
// Trackers Announce Keys; Designed for Qbit Json; should work for all in theory
new Regex(@"announce(\.php)?(/|%2f|%3fpasskey%3d)(?<secret>[a-z0-9]{16,})|(?<secret>[a-z0-9]{16,})(/|%2f)announce"),
// NzbGet
new Regex(@"""Name""\s*:\s*""[^""]*(username|password)""\s*,\s*""Value""\s*:\s*""(?<secret>[^""]+?)""", RegexOptions.Compiled | RegexOptions.IgnoreCase),

View File

@ -0,0 +1,15 @@
using FluentMigrator;
using Newtonsoft.Json.Linq;
using NzbDrone.Core.Datastore.Migration.Framework;
namespace NzbDrone.Core.Datastore.Migration
{
[Migration(47)]
public class update_notifiarr : NzbDroneMigrationBase
{
protected override void MainDbUpgrade()
{
Execute.Sql("UPDATE Notifications SET Implementation = Replace(Implementation, 'DiscordNotifier', 'Notifiarr'),ConfigContract = Replace(ConfigContract, 'DiscordNotifierSettings', 'NotifiarrSettings') WHERE Implementation = 'DiscordNotifier';");
}
}
}

View File

@ -1,18 +0,0 @@
using System;
using NzbDrone.Common.Exceptions;
namespace NzbDrone.Core.Notifications.DiscordNotifier
{
public class DiscordNotifierException : NzbDroneException
{
public DiscordNotifierException(string message)
: base(message)
{
}
public DiscordNotifierException(string message, Exception innerException, params object[] args)
: base(message, innerException, args)
{
}
}
}

View File

@ -1,28 +0,0 @@
using FluentValidation;
using NzbDrone.Core.Annotations;
using NzbDrone.Core.ThingiProvider;
using NzbDrone.Core.Validation;
namespace NzbDrone.Core.Notifications.DiscordNotifier
{
public class DiscordNotifierSettingsValidator : AbstractValidator<DiscordNotifierSettings>
{
public DiscordNotifierSettingsValidator()
{
RuleFor(c => c.APIKey).NotEmpty();
}
}
public class DiscordNotifierSettings : IProviderConfig
{
private static readonly DiscordNotifierSettingsValidator Validator = new DiscordNotifierSettingsValidator();
[FieldDefinition(0, Label = "API Key", HelpText = "Your API key from your profile", HelpLink = "https://discordnotifier.com")]
public string APIKey { get; set; }
public NzbDroneValidationResult Validate()
{
return new NzbDroneValidationResult(Validator.Validate(this));
}
}
}

View File

@ -6,19 +6,19 @@ using System.Linq;
using FluentValidation.Results;
using NzbDrone.Common.Extensions;
namespace NzbDrone.Core.Notifications.DiscordNotifier
namespace NzbDrone.Core.Notifications.Notifiarr
{
public class DiscordNotifier : NotificationBase<DiscordNotifierSettings>
public class Notifiarr : NotificationBase<NotifiarrSettings>
{
private readonly IDiscordNotifierProxy _proxy;
private readonly INotifiarrProxy _proxy;
public DiscordNotifier(IDiscordNotifierProxy proxy)
public Notifiarr(INotifiarrProxy proxy)
{
_proxy = proxy;
}
public override string Link => "https://discordnotifier.com";
public override string Name => "DiscordNotifier.com";
public override string Link => "https://notifiarr.com";
public override string Name => "Notifiarr";
public override void OnGrab(GrabMessage message)
{

View File

@ -0,0 +1,18 @@
using System;
using NzbDrone.Common.Exceptions;
namespace NzbDrone.Core.Notifications.Notifiarr
{
public class NotifiarrException : NzbDroneException
{
public NotifiarrException(string message)
: base(message)
{
}
public NotifiarrException(string message, Exception innerException, params object[] args)
: base(message, innerException, args)
{
}
}
}

View File

@ -7,40 +7,40 @@ using NLog;
using NzbDrone.Common.EnvironmentInfo;
using NzbDrone.Common.Http;
namespace NzbDrone.Core.Notifications.DiscordNotifier
namespace NzbDrone.Core.Notifications.Notifiarr
{
public interface IDiscordNotifierProxy
public interface INotifiarrProxy
{
void SendNotification(StringDictionary message, DiscordNotifierSettings settings);
ValidationFailure Test(DiscordNotifierSettings settings);
void SendNotification(StringDictionary message, NotifiarrSettings settings);
ValidationFailure Test(NotifiarrSettings settings);
}
public class DiscordNotifierProxy : IDiscordNotifierProxy
public class NotifiarrProxy : INotifiarrProxy
{
private const string URL = "https://discordnotifier.com/notifier.php";
private const string URL = "https://notifiarr.com/notifier.php";
private readonly IHttpClient _httpClient;
private readonly Logger _logger;
public DiscordNotifierProxy(IHttpClient httpClient, Logger logger)
public NotifiarrProxy(IHttpClient httpClient, Logger logger)
{
_httpClient = httpClient;
_logger = logger;
}
public void SendNotification(StringDictionary message, DiscordNotifierSettings settings)
public void SendNotification(StringDictionary message, NotifiarrSettings settings)
{
try
{
ProcessNotification(message, settings);
}
catch (DiscordNotifierException ex)
catch (NotifiarrException ex)
{
_logger.Error(ex, "Unable to send notification");
throw new DiscordNotifierException("Unable to send notification");
throw new NotifiarrException("Unable to send notification");
}
}
public ValidationFailure Test(DiscordNotifierSettings settings)
public ValidationFailure Test(NotifiarrSettings settings)
{
try
{
@ -68,7 +68,7 @@ namespace NzbDrone.Core.Notifications.DiscordNotifier
}
}
private void ProcessNotification(StringDictionary message, DiscordNotifierSettings settings)
private void ProcessNotification(StringDictionary message, NotifiarrSettings settings)
{
try
{
@ -92,7 +92,7 @@ namespace NzbDrone.Core.Notifications.DiscordNotifier
throw;
}
throw new DiscordNotifierException("Unable to send notification", ex);
throw new NotifiarrException("Unable to send notification", ex);
}
}
}

View File

@ -0,0 +1,28 @@
using FluentValidation;
using NzbDrone.Core.Annotations;
using NzbDrone.Core.ThingiProvider;
using NzbDrone.Core.Validation;
namespace NzbDrone.Core.Notifications.Notifiarr
{
public class NotifiarrSettingsValidator : AbstractValidator<NotifiarrSettings>
{
public NotifiarrSettingsValidator()
{
RuleFor(c => c.APIKey).NotEmpty();
}
}
public class NotifiarrSettings : IProviderConfig
{
private static readonly NotifiarrSettingsValidator Validator = new NotifiarrSettingsValidator();
[FieldDefinition(0, Label = "API Key", Privacy = PrivacyLevel.ApiKey, HelpText = "Your API key from your profile", HelpLink = "https://notifiarr.com")]
public string APIKey { get; set; }
public NzbDroneValidationResult Validate()
{
return new NzbDroneValidationResult(Validator.Validate(this));
}
}
}