github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

test cases working again; auth not so much

pull/1295/head
Chris Caron 2025-02-28 22:06:07 -05:00
parent a3155a6062
commit 14b361313d
3 changed files with 108 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
apprise/plugins/slack.py
View File

@ -89,7 +89,7 @@ from ..common import NotifyImageSize
from ..common import NotifyType from ..common import NotifyType
from ..common import NotifyFormat from ..common import NotifyFormat
from ..utils.parse import ( from ..utils.parse import (
is_email, parse_bool, parse_list, validate_regex) is_email, parse_bool, parse_list, validate_regex, urlencode)
from ..locale import gettext_lazy as _ from ..locale import gettext_lazy as _
# Extend HTTP Error Messages # Extend HTTP Error Messages
@ -102,7 +102,13 @@ CHANNEL_LIST_DELIM = re.compile(r'[ \t\r\n,#\\/]+')
# Channel Regular Expression Parsing # Channel Regular Expression Parsing
CHANNEL_RE = re.compile( CHANNEL_RE = re.compile(
r'^(?P<channel>[+#@]?[A-Z0-9_-]{1,32})(:(?P<thread_ts>[0-9.]+))?$', re.I) r'^(?P<channel>[+#@]?[a-z0-9_-]{1,32})(:(?P<thread_ts>[0-9.]+))?$', re.I)
# Webhook
WEBHOOK_RE = re.compile(
r'^([a-z]{4,5}://([^/:]+:)?([^/@]+@)?)?'
r'(?P<webhook>[a-z0-9]{9,12}/+[a-z0-9]{9,12}/+'
r'[a-z0-9]{20,24})([/?].*|\s*$)', re.I)
# For detecting Slack API v2 Client IDs # For detecting Slack API v2 Client IDs
CLIENT_ID_RE = re.compile(r'^\d{8,}\.\d{8,}$', re.I) CLIENT_ID_RE = re.compile(r'^\d{8,}\.\d{8,}$', re.I)
@ -267,7 +273,7 @@ class NotifySlack(NotifyBase):
'name': _('OAuth Access Token'), 'name': _('OAuth Access Token'),
'type': 'string', 'type': 'string',
'private': True, 'private': True,
'regex': (r'^xox[abp]-[A-Z0-9-]+$', 'i'), 'regex': (r'^xox[abp]-[a-z0-9-]+$', 'i'),
}, },
# Token required as part of the Webhook request # Token required as part of the Webhook request
# AAAAAAAAA/BBBBBBBBB/CCCCCCCCCCCCCCCCCCCCCCCC # AAAAAAAAA/BBBBBBBBB/CCCCCCCCCCCCCCCCCCCCCCCC
@ -275,7 +281,7 @@ class NotifySlack(NotifyBase):
'name': _('Legacy Webhook Token'), 'name': _('Legacy Webhook Token'),
'type': 'string', 'type': 'string',
'private': True, 'private': True,
'regex': (r'^[a-z0-9]+/[a-z0-9]+/[a-z0-9]$', 'i'), 'regex': (r'^[a-z0-9]+/[a-z0-9]+/[a-z0-9]+$', 'i'),
}, },
'target_encoded_id': { 'target_encoded_id': {
'name': _('Target Encoded ID'), 'name': _('Target Encoded ID'),
@ -403,16 +409,26 @@ class NotifySlack(NotifyBase):
# Setup our mode # Setup our mode
self.mode = SlackMode.BOT if access_token else SlackMode.WEBHOOK self.mode = SlackMode.BOT if access_token else SlackMode.WEBHOOK
# v1 Defaults
self.access_token = None
self.token = None
# v2 Defaults
self.code = None
self.client_id = None
self.secret = None
# Get our Slack API Version # Get our Slack API Version
self.api_ver = \ self.api_ver = SlackAPIVersion.TWO if client_id \
and secret and not (token or access_token) and ver is None \
else (
SLACK_API_VERSION_MAP[NotifySlack. SLACK_API_VERSION_MAP[NotifySlack.
template_args['ver']['default']] \ template_args['ver']['default']]
if ver is None else \ if ver is None else next((
next((
v for k, v in SLACK_API_VERSION_MAP.items() v for k, v in SLACK_API_VERSION_MAP.items()
if str(ver).lower().startswith(k)), if str(ver).lower().startswith(k)),
SLACK_API_VERSION_MAP[NotifySlack. SLACK_API_VERSION_MAP[NotifySlack.
template_args['ver']['default']]) template_args['ver']['default']]))
# Depricated Notification # Depricated Notification
if self.api_ver == SlackAPIVersion.ONE: if self.api_ver == SlackAPIVersion.ONE:
@ -421,7 +437,7 @@ class NotifySlack(NotifyBase):
'You must update your App and/or Bot') 'You must update your App and/or Bot')
if self.mode is SlackMode.WEBHOOK: if self.mode is SlackMode.WEBHOOK:
self.access_token = None if self.api_ver == SlackAPIVersion.ONE:
self.token = validate_regex( self.token = validate_regex(
token, *self.template_tokens['token']['regex']) token, *self.template_tokens['token']['regex'])
if not self.token: if not self.token:
@ -430,6 +446,11 @@ class NotifySlack(NotifyBase):
self.logger.warning(msg) self.logger.warning(msg)
raise TypeError(msg) raise TypeError(msg)
else: # version 2
self.code = code
self.client_id = client_id
self.secret = secret
else: # Bot else: # Bot
self.access_token = validate_regex( self.access_token = validate_regex(
access_token, *self.template_tokens['access_token']['regex']) access_token, *self.template_tokens['access_token']['regex'])
@ -492,23 +513,26 @@ class NotifySlack(NotifyBase):
'redirect_uri': 'urn:ietf:wg:oauth:2.0:oob', 'redirect_uri': 'urn:ietf:wg:oauth:2.0:oob',
} }
get_code_url = 'https://slack.com/oauth/v2/authorize' # Sharing this code with the user to click on and have a code generated
try: # does not work if there is no valid redirect_uri provided; the
r = requests.post( # 'out-of-band' on defined above does not work.
get_code_url, get_code_url = \
params=params, f'https://slack.com/oauth/v2/authorize?{urlencode(params)}'
verify=self.verify_certificate,
timeout=self.request_timeout,
)
import pdb
pdb.set_trace()
except requests.RequestException as e: # The following code does not work (below).
self.logger.warning( # try:
'A Connection error occurred acquiring Slack access code.', # r = requests.get(
) # get_code_url,
self.logger.debug('Socket Exception: %s' % str(e)) # verify=self.verify_certificate,
# Return; we're done # timeout=self.request_timeout,
# )
# except requests.RequestException as e:
# self.logger.warning(
# 'A Connection error occurred acquiring Slack access code.',
# )
# self.logger.debug('Socket Exception: %s' % str(e))
# # Return; we're done
return None return None
def send(self, body, title='', notify_type=NotifyType.INFO, attach=None, def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
@ -520,6 +544,9 @@ class NotifySlack(NotifyBase):
# error tracking (used for function return) # error tracking (used for function return)
has_error = False has_error = False
if self.api_ver == SlackAPIVersion.TWO:
if not self.authenticate():
return False
# #
# Prepare JSON Object (applicable to both WEBHOOK and BOT mode) # Prepare JSON Object (applicable to both WEBHOOK and BOT mode)
# #
@ -1144,7 +1171,8 @@ class NotifySlack(NotifyBase):
""" """
return ( return (
self.secure_protocol, self.token, self.access_token, self.secure_protocol, self.token, self.access_token,
self.client_id, self.secret, self.code self.client_id, self.secret,
# self.code is intentionally left out
) )
def url(self, privacy=False, *args, **kwargs): def url(self, privacy=False, *args, **kwargs):
@ -1177,7 +1205,9 @@ class NotifySlack(NotifyBase):
'{targets}/?{params}'.format( '{targets}/?{params}'.format(
schema=self.secure_protocol, schema=self.secure_protocol,
botname=botname, botname=botname,
token=self.pprint(self.token, privacy, safe=''), token='/'.join(
[self.pprint(token, privacy, safe='/')
for token in self.token.split('/')]),
targets='/'.join( targets='/'.join(
[NotifySlack.quote(x, safe='') [NotifySlack.quote(x, safe='')
for x in self.channels]), for x in self.channels]),
@ -1188,7 +1218,7 @@ class NotifySlack(NotifyBase):
'{targets}?{params}'.format( '{targets}?{params}'.format(
schema=self.secure_protocol, schema=self.secure_protocol,
botname=botname, botname=botname,
client_id=self.pprint(self.client_id, privacy, safe=''), client_id=self.pprint(self.client_id, privacy, safe='/'),
secret=self.pprint(self.secret, privacy, safe=''), secret=self.pprint(self.secret, privacy, safe=''),
code='' if not self.code else '/' + self.pprint( code='' if not self.code else '/' + self.pprint(
self.code, privacy, safe=''), self.code, privacy, safe=''),
@ -1203,7 +1233,7 @@ class NotifySlack(NotifyBase):
'?{params}'.format( '?{params}'.format(
schema=self.secure_protocol, schema=self.secure_protocol,
botname=botname, botname=botname,
access_token=self.pprint(self.access_token, privacy, safe=''), access_token=self.pprint(self.access_token, privacy, safe='/'),
targets='/'.join( targets='/'.join(
[NotifySlack.quote(x, safe='') for x in self.channels]), [NotifySlack.quote(x, safe='') for x in self.channels]),
params=NotifySlack.urlencode(params), params=NotifySlack.urlencode(params),
@ -1228,8 +1258,9 @@ class NotifySlack(NotifyBase):
return results return results
# The first token is stored in the hostname # The first token is stored in the hostname
results['targets'] = \ results['targets'] = re.split(
[NotifySlack.unquote(results['host'])] if results['host'] else [] r'[\s/]+', NotifySlack.unquote(results['host'])) \
if results['host'] else []
# Get unquoted entries # Get unquoted entries
results['targets'] += NotifySlack.split_path(results['fullpath']) results['targets'] += NotifySlack.split_path(results['fullpath'])
@ -1253,7 +1284,7 @@ class NotifySlack(NotifyBase):
if 'token' in results['qsd'] and len(results['qsd']['token']): if 'token' in results['qsd'] and len(results['qsd']['token']):
# We're dealing with a Slack v1 API # We're dealing with a Slack v1 API
token = NotifySlack.unquote(results['qsd']['token']) token = NotifySlack.unquote(results['qsd']['token']).strip('/')
# check to see if we're dealing with a bot/user token # check to see if we're dealing with a bot/user token
if token.startswith('xo'): if token.startswith('xo'):
# We're dealing with a bot # We're dealing with a bot
@ -1264,7 +1295,7 @@ class NotifySlack(NotifyBase):
results['access_token'] = None results['access_token'] = None
results['token'] = token results['token'] = token
# Verify if our token_a us a bot token or part of a webhook: # Verify if our token is a bot token or part of a webhook:
if not (results.get('token') or results.get('access_token') if not (results.get('token') or results.get('access_token')
or 'client_id' in results or 'secret' in results or 'client_id' in results or 'secret' in results
or 'code' in results) and results['targets'] \ or 'code' in results) and results['targets'] \
@ -1279,6 +1310,14 @@ class NotifySlack(NotifyBase):
# Store our Client ID # Store our Client ID
results['client_id'] = results['targets'].pop(0) results['client_id'] = results['targets'].pop(0)
else: # parse token from URL if present
match = WEBHOOK_RE.match(url)
if match:
results['access_token'] = None
results['token'] = match.group('webhook')
# Eliminate webhook entries
results['targets'] = results['targets'][3:]
# We have several entries on our URL and we don't know where they # We have several entries on our URL and we don't know where they
# go. They could also be channels/users/emails # go. They could also be channels/users/emails
if 'client_id' in results and 'secret' not in results: if 'client_id' in results and 'secret' not in results:
@ -1324,9 +1363,9 @@ class NotifySlack(NotifyBase):
result = re.match( result = re.match(
r'^https?://hooks\.slack\.com/services/' r'^https?://hooks\.slack\.com/services/'
r'(?P<token_a>[A-Z0-9]+)/' r'(?P<token_a>[a-z0-9]+)/'
r'(?P<token_b>[A-Z0-9]+)/' r'(?P<token_b>[a-z0-9]+)/'
r'(?P<token_c>[A-Z0-9]+)/?' r'(?P<token_c>[a-z0-9]+)/?'
r'(?P<params>\?.+)?$', url, re.I) r'(?P<params>\?.+)?$', url, re.I)
if result: if result:

30
test/helpers/rest.py
View File

@ -266,23 +266,11 @@ class AppriseURLTester:
# from the one that was already created properly # from the one that was already created properly
obj_cmp = Apprise.instantiate(obj.url()) obj_cmp = Apprise.instantiate(obj.url())
# Our new object should produce the same url identifier
if obj.url_identifier != obj_cmp.url_identifier:
print('Provided %s' % url)
raise AssertionError(
"URL Identifier: '{}' != expected '{}'".format(
obj_cmp.url_identifier, obj.url_identifier))
# Back our check up
if obj.url_id() != obj_cmp.url_id():
print('Provided %s' % url)
raise AssertionError(
"URL ID(): '{}' != expected '{}'".format(
obj_cmp.url_id(), obj.url_id()))
# Our object should be the same instance as what we had # Our object should be the same instance as what we had
# originally expected above. # originally expected above.
if not isinstance(obj_cmp, NotifyBase): if not isinstance(obj_cmp, NotifyBase):
import pdb
pdb.set_trace()
# Assert messages are hard to trace back with the # Assert messages are hard to trace back with the
# way these tests work. Just printing before # way these tests work. Just printing before
# throwing our assertion failure makes things # throwing our assertion failure makes things
@ -299,6 +287,20 @@ class AppriseURLTester:
len(obj_cmp), obj_cmp.url(privacy=True))) len(obj_cmp), obj_cmp.url(privacy=True)))
raise AssertionError("Target miscount %d != %d") raise AssertionError("Target miscount %d != %d")
# Our new object should produce the same url identifier
if obj.url_identifier != obj_cmp.url_identifier:
print('Provided %s' % url)
raise AssertionError(
"URL Identifier: '{}' != expected '{}'".format(
obj_cmp.url_identifier, obj.url_identifier))
# Back our check up
if obj.url_id() != obj_cmp.url_id():
print('Provided %s' % url)
raise AssertionError(
"URL ID(): '{}' != expected '{}'".format(
obj_cmp.url_id(), obj.url_id()))
# Tidy our object # Tidy our object
del obj_cmp del obj_cmp
del instance del instance

19
test/test_plugin_slack.py
View File

@ -102,14 +102,14 @@ apprise_url_tests = (
'requests_response_text': 'ok', 'requests_response_text': 'ok',
}), }),
# You can't send to email using webhook # You can't send to email using webhook
('slack://T1JJ3T3L2/A1BRTD4JD/TIiajkdnl/user@gmail.com', { ('slack://T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/user@gmail.com', {
'instance': NotifySlack, 'instance': NotifySlack,
'requests_response_text': 'ok', 'requests_response_text': 'ok',
# we'll have a notify response failure in this case # we'll have a notify response failure in this case
'notify_response': False, 'notify_response': False,
}), }),
# Specify Token on argument string (with username) # Specify Token on argument string (with username)
('slack://bot@_/#nuxref?token=T1JJ3T3L2/A1BRTD4JD/TIiajkdnadfdajkjkfl/', { ('slack://bot@_/#nuxref?token=T1JJ3T3L2/A1BRTD4JD/TIiajkdnadfdajkjkfKl/', {
'instance': NotifySlack, 'instance': NotifySlack,
'requests_response_text': 'ok', 'requests_response_text': 'ok',
}), }),
@ -452,15 +452,12 @@ def test_plugin_slack_webhook_mode(mock_request):
mock_request.return_value.text = 'ok' mock_request.return_value.text = 'ok'
# Initialize some generic (but valid) tokens # Initialize some generic (but valid) tokens
token_a = 'A' * 9 token = '{}/{}/{}'.format('A' * 9, 'B' * 9, 'c' * 24)
token_b = 'B' * 9
token_c = 'c' * 24
# Support strings # Support strings
channels = 'chan1,#chan2,+BAK4K23G5,@user,,,' channels = 'chan1,#chan2,+BAK4K23G5,@user,,,'
obj = NotifySlack( obj = NotifySlack(token=token, targets=channels)
token_a=token_a, token_b=token_b, token_c=token_c, targets=channels)
assert len(obj.channels) == 4 assert len(obj.channels) == 4
# This call includes an image with it's payload: # This call includes an image with it's payload:
@ -469,14 +466,10 @@ def test_plugin_slack_webhook_mode(mock_request):
# Missing first Token # Missing first Token
with pytest.raises(TypeError): with pytest.raises(TypeError):
NotifySlack( NotifySlack(token=None)
token_a=None, token_b=token_b, token_c=token_c,
targets=channels)
# Test include_image # Test include_image
obj = NotifySlack( obj = NotifySlack(token=token, targets=channels, include_image=True)
token_a=token_a, token_b=token_b, token_c=token_c, targets=channels,
include_image=True)
# This call includes an image with it's payload: # This call includes an image with it's payload:
assert obj.notify( assert obj.notify(