Mask notifier and newsletter config passwords (Fixes Tautulli/Tautulli-Issues#172)

This commit is contained in:
JonnyWong16 2019-07-08 23:50:48 -07:00
parent 96c0f9cad5
commit 91476a420a
4 changed files with 95 additions and 49 deletions

View file

@ -1178,3 +1178,18 @@ def split_args(args=None):
return [arg.decode(plexpy.SYS_ENCODING, 'ignore') return [arg.decode(plexpy.SYS_ENCODING, 'ignore')
for arg in shlex.split(args.encode(plexpy.SYS_ENCODING, 'ignore'))] for arg in shlex.split(args.encode(plexpy.SYS_ENCODING, 'ignore'))]
return [] return []
def mask_config_passwords(config):
if isinstance(config, list):
for cfg in config:
if 'password' in cfg['name'] and cfg['value'] != '':
cfg['value'] = ' '
elif isinstance(config, dict):
for cfg, val in config.iteritems():
# Check for a password config keys and if the password is not blank
if 'password' in cfg and val != '':
# Set the password to blank so it is not exposed in the HTML form
config[cfg] = ' '
return config

View file

@ -125,7 +125,7 @@ def delete_newsletter(newsletter_id=None):
return False return False
def get_newsletter_config(newsletter_id=None): def get_newsletter_config(newsletter_id=None, mask_passwords=False):
if str(newsletter_id).isdigit(): if str(newsletter_id).isdigit():
newsletter_id = int(newsletter_id) newsletter_id = int(newsletter_id)
else: else:
@ -153,13 +153,16 @@ def get_newsletter_config(newsletter_id=None):
logger.error(u"Tautulli Newsletters :: Failed to get newsletter config options: %s." % e) logger.error(u"Tautulli Newsletters :: Failed to get newsletter config options: %s." % e)
return return
if mask_passwords:
newsletter_agent.email_config = helpers.mask_config_passwords(newsletter_agent.email_config)
result['subject'] = newsletter_agent.subject result['subject'] = newsletter_agent.subject
result['body'] = newsletter_agent.body result['body'] = newsletter_agent.body
result['message'] = newsletter_agent.message result['message'] = newsletter_agent.message
result['config'] = newsletter_agent.config result['config'] = newsletter_agent.config
result['email_config'] = newsletter_agent.email_config result['email_config'] = newsletter_agent.email_config
result['config_options'] = newsletter_agent.return_config_options() result['config_options'] = newsletter_agent.return_config_options(mask_passwords=mask_passwords)
result['email_config_options'] = newsletter_agent.return_email_config_options() result['email_config_options'] = newsletter_agent.return_email_config_options(mask_passwords=mask_passwords)
return result return result
@ -230,6 +233,13 @@ def set_newsletter_config(newsletter_id=None, agent_id=None, **kwargs):
email_config = {k[len(email_config_prefix):]: kwargs.pop(k) email_config = {k[len(email_config_prefix):]: kwargs.pop(k)
for k in kwargs.keys() if k.startswith(email_config_prefix)} for k in kwargs.keys() if k.startswith(email_config_prefix)}
for cfg, val in email_config.iteritems():
# Check for a password config keys and a blank password from the HTML form
if 'password' in cfg and val == ' ':
# Get the previous password so we don't overwrite it with a blank value
old_newsletter_config = get_newsletter_config(newsletter_id=newsletter_id)
email_config[cfg] = old_newsletter_config['email_config'][cfg]
subject = kwargs.pop('subject') subject = kwargs.pop('subject')
body = kwargs.pop('body') body = kwargs.pop('body')
message = kwargs.pop('message') message = kwargs.pop('message')
@ -647,16 +657,21 @@ class Newsletter(object):
return filename return filename
def return_config_options(self): def return_config_options(self, mask_passwords=False):
return self._return_config_options() config_options = self._return_config_options()
def _return_config_options(self): # Mask password config options
config_options = [] if mask_passwords:
helpers.mask_config_passwords(config_options)
return config_options return config_options
def return_email_config_options(self): def _return_config_options(self):
config_options = EMAIL(self.email_config).return_config_options() config_options = []
return config_options
def return_email_config_options(self, mask_passwords=False):
config_options = EMAIL(self.email_config).return_config_options(mask_passwords=mask_passwords)
for c in config_options: for c in config_options:
c['name'] = 'newsletter_' + c['name'] c['name'] = 'newsletter_' + c['name']
return config_options return config_options
@ -926,10 +941,8 @@ class RecentlyAdded(Newsletter):
return parameters return parameters
def return_config_options(self): def _return_config_options(self):
config_options = self._return_config_options() config_options = [
additional_config = [
{'label': 'Included Libraries', {'label': 'Included Libraries',
'value': self.config['incl_libraries'], 'value': self.config['incl_libraries'],
'description': 'Select the libraries to include in the newsletter.', 'description': 'Select the libraries to include in the newsletter.',
@ -939,4 +952,4 @@ class RecentlyAdded(Newsletter):
} }
] ]
return additional_config + config_options return config_options

View file

@ -455,7 +455,7 @@ def delete_notifier(notifier_id=None):
return False return False
def get_notifier_config(notifier_id=None): def get_notifier_config(notifier_id=None, mask_passwords=False):
if str(notifier_id).isdigit(): if str(notifier_id).isdigit():
notifier_id = int(notifier_id) notifier_id = int(notifier_id)
else: else:
@ -472,11 +472,13 @@ def get_notifier_config(notifier_id=None):
try: try:
config = json.loads(result.pop('notifier_config', '{}')) config = json.loads(result.pop('notifier_config', '{}'))
notifier_agent = get_agent_class(agent_id=result['agent_id'], config=config) notifier_agent = get_agent_class(agent_id=result['agent_id'], config=config)
notifier_config = notifier_agent.return_config_options()
except Exception as e: except Exception as e:
logger.error(u"Tautulli Notifiers :: Failed to get notifier config options: %s." % e) logger.error(u"Tautulli Notifiers :: Failed to get notifier config options: %s." % e)
return return
if mask_passwords:
notifier_agent.config = helpers.mask_config_passwords(notifier_agent.config)
notify_actions = get_notify_actions(return_dict=True) notify_actions = get_notify_actions(return_dict=True)
notifier_actions = {} notifier_actions = {}
@ -503,8 +505,8 @@ def get_notifier_config(notifier_id=None):
if not result['custom_conditions_logic']: if not result['custom_conditions_logic']:
result['custom_conditions_logic'] = '' result['custom_conditions_logic'] = ''
result['config'] = config result['config'] = notifier_agent.config
result['config_options'] = notifier_config result['config_options'] = notifier_agent.return_config_options(mask_passwords=mask_passwords)
result['actions'] = notifier_actions result['actions'] = notifier_actions
result['notify_text'] = notifier_text result['notify_text'] = notifier_text
@ -587,6 +589,13 @@ def set_notifier_config(notifier_id=None, agent_id=None, **kwargs):
notifier_config = {k[len(config_prefix):]: kwargs.pop(k) notifier_config = {k[len(config_prefix):]: kwargs.pop(k)
for k in kwargs.keys() if k.startswith(config_prefix)} for k in kwargs.keys() if k.startswith(config_prefix)}
for cfg, val in notifier_config.iteritems():
# Check for a password config keys and a blank password from the HTML form
if 'password' in cfg and val == ' ':
# Get the previous password so we don't overwrite it with a blank value
old_notifier_config = get_notifier_config(notifier_id=notifier_id)
notifier_config[cfg] = old_notifier_config['config'][cfg]
agent_class = get_agent_class(agent_id=agent['id'], config=notifier_config) agent_class = get_agent_class(agent_id=agent['id'], config=notifier_config)
keys = {'id': notifier_id} keys = {'id': notifier_id}
@ -835,7 +844,16 @@ class Notifier(object):
return False return False
def return_config_options(self): def return_config_options(self, mask_passwords=False):
config_options = self._return_config_options()
# Mask password config options
if mask_passwords:
helpers.mask_config_passwords(config_options)
return config_options
def _return_config_options(self):
config_options = [] config_options = []
return config_options return config_options
@ -942,7 +960,7 @@ class ANDROIDAPP(Notifier):
return devices return devices
def return_config_options(self): def _return_config_options(self):
config_option = [] config_option = []
if not CRYPTODOME: if not CRYPTODOME:
@ -1058,7 +1076,7 @@ class BOXCAR(Notifier):
return sounds return sounds
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Boxcar Access Token', config_option = [{'label': 'Boxcar Access Token',
'value': self.config['token'], 'value': self.config['token'],
'name': 'boxcar_token', 'name': 'boxcar_token',
@ -1089,7 +1107,7 @@ class BROWSER(Notifier):
logger.info(u"Tautulli Notifiers :: {name} notification sent.".format(name=self.NAME)) logger.info(u"Tautulli Notifiers :: {name} notification sent.".format(name=self.NAME))
return True return True
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Allow Notifications', config_option = [{'label': 'Allow Notifications',
'value': 'Allow Notifications', 'value': 'Allow Notifications',
'name': 'browser_allow_browser', 'name': 'browser_allow_browser',
@ -1202,7 +1220,7 @@ class DISCORD(Notifier):
return self.make_request(self.config['hook'], params=params, headers=headers, json=data) return self.make_request(self.config['hook'], params=params, headers=headers, json=data)
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Discord Webhook URL', config_option = [{'label': 'Discord Webhook URL',
'value': self.config['hook'], 'value': self.config['hook'],
'name': 'discord_hook', 'name': 'discord_hook',
@ -1389,7 +1407,7 @@ class EMAIL(Notifier):
return user_emails_to, user_emails_cc, user_emails_bcc return user_emails_to, user_emails_cc, user_emails_bcc
def return_config_options(self): def _return_config_options(self):
user_emails_to, user_emails_cc, user_emails_bcc = self.get_user_emails() user_emails_to, user_emails_cc, user_emails_bcc = self.get_user_emails()
config_option = [{'label': 'From Name', config_option = [{'label': 'From Name',
@ -1569,7 +1587,7 @@ class FACEBOOK(Notifier):
return self._post_facebook(**data) return self._post_facebook(**data)
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'OAuth Redirect URI', config_option = [{'label': 'OAuth Redirect URI',
'value': self.config['redirect_uri'], 'value': self.config['redirect_uri'],
'name': 'facebook_redirect_uri', 'name': 'facebook_redirect_uri',
@ -1699,7 +1717,7 @@ class GROUPME(Notifier):
return self.make_request('https://api.groupme.com/v3/bots/post', json=data) return self.make_request('https://api.groupme.com/v3/bots/post', json=data)
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'GroupMe Access Token', config_option = [{'label': 'GroupMe Access Token',
'value': self.config['access_token'], 'value': self.config['access_token'],
'name': 'groupme_access_token', 'name': 'groupme_access_token',
@ -1796,7 +1814,7 @@ class GROWL(Notifier):
logger.error(u"Tautulli Notifiers :: {name} notification failed: network error".format(name=self.NAME)) logger.error(u"Tautulli Notifiers :: {name} notification failed: network error".format(name=self.NAME))
return False return False
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Growl Host', config_option = [{'label': 'Growl Host',
'value': self.config['host'], 'value': self.config['host'],
'name': 'growl_host', 'name': 'growl_host',
@ -1901,7 +1919,7 @@ class HIPCHAT(Notifier):
return self.make_request(self.config['hook'], headers=headers, json=data) return self.make_request(self.config['hook'], headers=headers, json=data)
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Hipchat Custom Integrations URL', config_option = [{'label': 'Hipchat Custom Integrations URL',
'value': self.config['hook'], 'value': self.config['hook'],
'name': 'hipchat_hook', 'name': 'hipchat_hook',
@ -2012,7 +2030,7 @@ class IFTTT(Notifier):
return self.make_request('https://maker.ifttt.com/trigger/{}/with/key/{}'.format(event, self.config['key']), return self.make_request('https://maker.ifttt.com/trigger/{}/with/key/{}'.format(event, self.config['key']),
headers=headers, json=data) headers=headers, json=data)
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'IFTTT Webhook Key', config_option = [{'label': 'IFTTT Webhook Key',
'value': self.config['key'], 'value': self.config['key'],
'name': 'ifttt_key', 'name': 'ifttt_key',
@ -2131,7 +2149,7 @@ class JOIN(Notifier):
return devices return devices
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Join API Key', config_option = [{'label': 'Join API Key',
'value': self.config['api_key'], 'value': self.config['api_key'],
'name': 'join_api_key', 'name': 'join_api_key',
@ -2233,7 +2251,7 @@ class MQTT(Notifier):
return True return True
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Broker', config_option = [{'label': 'Broker',
'value': self.config['broker'], 'value': self.config['broker'],
'name': 'mqtt_broker', 'name': 'mqtt_broker',
@ -2335,7 +2353,7 @@ class NMA(Notifier):
logger.error(u"Tautulli Notifiers :: {name} notification failed.".format(name=self.NAME)) logger.error(u"Tautulli Notifiers :: {name} notification failed.".format(name=self.NAME))
return False return False
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'NotifyMyAndroid API Key', config_option = [{'label': 'NotifyMyAndroid API Key',
'value': self.config['api_key'], 'value': self.config['api_key'],
'name': 'nma_api_key', 'name': 'nma_api_key',
@ -2437,7 +2455,7 @@ class OSX(Notifier):
logger.error(u"Tautulli Notifiers :: {name} failed: {e}".format(name=self.NAME, e=e)) logger.error(u"Tautulli Notifiers :: {name} failed: {e}".format(name=self.NAME, e=e))
return False return False
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Register Notify App', config_option = [{'label': 'Register Notify App',
'value': self.config['notify_app'], 'value': self.config['notify_app'],
'name': 'osx_notify_app', 'name': 'osx_notify_app',
@ -2530,7 +2548,7 @@ class PLEX(Notifier):
return True return True
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Plex Home Theater Host Address', config_option = [{'label': 'Plex Home Theater Host Address',
'value': self.config['hosts'], 'value': self.config['hosts'],
'name': 'plex_hosts', 'name': 'plex_hosts',
@ -2586,7 +2604,7 @@ class PROWL(Notifier):
return self.make_request('https://api.prowlapp.com/publicapi/add', headers=headers, data=data) return self.make_request('https://api.prowlapp.com/publicapi/add', headers=headers, data=data)
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Prowl API Key', config_option = [{'label': 'Prowl API Key',
'value': self.config['key'], 'value': self.config['key'],
'name': 'prowl_key', 'name': 'prowl_key',
@ -2622,7 +2640,7 @@ class PUSHALOT(Notifier):
return self.make_request('https://pushalot.com/api/sendmessage', headers=headers, data=data) return self.make_request('https://pushalot.com/api/sendmessage', headers=headers, data=data)
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Pushalot API Key', config_option = [{'label': 'Pushalot API Key',
'value': self.config['api_key'], 'value': self.config['api_key'],
'name': 'pushalot_api_key', 'name': 'pushalot_api_key',
@ -2722,7 +2740,7 @@ class PUSHBULLET(Notifier):
return devices return devices
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Pushbullet Access Token', config_option = [{'label': 'Pushbullet Access Token',
'value': self.config['api_key'], 'value': self.config['api_key'],
'name': 'pushbullet_api_key', 'name': 'pushbullet_api_key',
@ -2888,7 +2906,7 @@ class PUSHOVER(Notifier):
# else: # else:
# return {'': ''} # return {'': ''}
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Pushover API Token', config_option = [{'label': 'Pushover API Token',
'value': self.config['api_token'], 'value': self.config['api_token'],
'name': 'pushover_api_token', 'name': 'pushover_api_token',
@ -3163,7 +3181,7 @@ class SCRIPTS(Notifier):
return True return True
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Supported File Types', config_option = [{'label': 'Supported File Types',
'description': '<span class="inline-pre">' + \ 'description': '<span class="inline-pre">' + \
', '.join(self.script_exts.keys()) + '</span>', ', '.join(self.script_exts.keys()) + '</span>',
@ -3286,7 +3304,7 @@ class SLACK(Notifier):
return self.make_request(self.config['hook'], headers=headers, json=data) return self.make_request(self.config['hook'], headers=headers, json=data)
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Slack Webhook URL', config_option = [{'label': 'Slack Webhook URL',
'value': self.config['hook'], 'value': self.config['hook'],
'name': 'slack_hook', 'name': 'slack_hook',
@ -3439,7 +3457,7 @@ class TELEGRAM(Notifier):
return self.make_request('https://api.telegram.org/bot{}/sendMessage'.format(self.config['bot_token']), return self.make_request('https://api.telegram.org/bot{}/sendMessage'.format(self.config['bot_token']),
headers=headers, data=data) headers=headers, data=data)
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Telegram Bot Token', config_option = [{'label': 'Telegram Bot Token',
'value': self.config['bot_token'], 'value': self.config['bot_token'],
'name': 'telegram_bot_token', 'name': 'telegram_bot_token',
@ -3537,7 +3555,7 @@ class TWITTER(Notifier):
else: else:
return self._send_tweet(body, attachment=poster_url) return self._send_tweet(body, attachment=poster_url)
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Twitter Consumer Key', config_option = [{'label': 'Twitter Consumer Key',
'value': self.config['consumer_key'], 'value': self.config['consumer_key'],
'name': 'twitter_consumer_key', 'name': 'twitter_consumer_key',
@ -3606,7 +3624,7 @@ class WEBHOOK(Notifier):
return self.make_request(self.config['hook'], method=self.config['method'], headers=headers, json=webhook_data) return self.make_request(self.config['hook'], method=self.config['method'], headers=headers, json=webhook_data)
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Webhook URL', config_option = [{'label': 'Webhook URL',
'value': self.config['hook'], 'value': self.config['hook'],
'name': 'webhook_hook', 'name': 'webhook_hook',
@ -3703,7 +3721,7 @@ class XBMC(Notifier):
return True return True
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Kodi Host Address', config_option = [{'label': 'Kodi Host Address',
'value': self.config['hosts'], 'value': self.config['hosts'],
'name': 'xbmc_hosts', 'name': 'xbmc_hosts',
@ -3796,7 +3814,7 @@ class ZAPIER(Notifier):
return self.make_request(self.config['hook'], headers=headers, json=data) return self.make_request(self.config['hook'], headers=headers, json=data)
def return_config_options(self): def _return_config_options(self):
config_option = [{'label': 'Zapier Webhook URL', config_option = [{'label': 'Zapier Webhook URL',
'value': self.config['hook'], 'value': self.config['hook'],
'name': 'zapier_hook', 'name': 'zapier_hook',

View file

@ -3168,13 +3168,13 @@ class WebInterface(object):
} }
``` ```
""" """
result = notifiers.get_notifier_config(notifier_id=notifier_id) result = notifiers.get_notifier_config(notifier_id=notifier_id, mask_passwords=True)
return result return result
@cherrypy.expose @cherrypy.expose
@requireAuth(member_of("admin")) @requireAuth(member_of("admin"))
def get_notifier_config_modal(self, notifier_id=None, **kwargs): def get_notifier_config_modal(self, notifier_id=None, **kwargs):
result = notifiers.get_notifier_config(notifier_id=notifier_id) result = notifiers.get_notifier_config(notifier_id=notifier_id, mask_passwords=True)
parameters = [ parameters = [
{'name': param['name'], 'type': param['type'], 'value': param['value']} {'name': param['name'], 'type': param['type'], 'value': param['value']}
@ -5667,13 +5667,13 @@ class WebInterface(object):
} }
``` ```
""" """
result = newsletters.get_newsletter_config(newsletter_id=newsletter_id) result = newsletters.get_newsletter_config(newsletter_id=newsletter_id, mask_passwords=True)
return result return result
@cherrypy.expose @cherrypy.expose
@requireAuth(member_of("admin")) @requireAuth(member_of("admin"))
def get_newsletter_config_modal(self, newsletter_id=None, **kwargs): def get_newsletter_config_modal(self, newsletter_id=None, **kwargs):
result = newsletters.get_newsletter_config(newsletter_id=newsletter_id) result = newsletters.get_newsletter_config(newsletter_id=newsletter_id, mask_passwords=True)
return serve_template(templatename="newsletter_config.html", newsletter=result) return serve_template(templatename="newsletter_config.html", newsletter=result)
@cherrypy.expose @cherrypy.expose