1 # -*- coding: utf-8 -*-
2 # SPDX-FileCopyrightText: 2023 kaliko <kaliko@azylum.org>
3 # SPDX-License-Identifier: GPL-3.0-or-later
4 """A Real Time Block List plugin"""
6 from hashlib import sha256
7 from typing import Dict, Optional
9 from slixmpp import JID
10 from slixmpp.exceptions import XMPPError
11 from slixmpp.xmlstream import tostring
13 from .plugin import Plugin
16 def jid_to_sha256(jid: JID) -> str:
17 """Convert Bare JID to sha256 hexdigest"""
18 return sha256(jid.bare.encode('utf-8')).hexdigest()
22 """Plain object to keep track of block list items.
23 Only used in RTBL plugin."""
25 def __init__(self, initial_bl):
26 self.sha256_jids: Dict[str, Optional[str]] = {}
27 for item in initial_bl:
28 self.insert_item(item)
30 def check(self, jid: JID) -> bool:
31 """Check the presence of the JID in the blocklist"""
32 jidhash = jid_to_sha256(jid)
33 return jidhash in self.sha256_jids
35 def retract_item(self, item):
37 self.sha256_jids.pop(item[id], None)
39 def insert_item(self, item):
42 for i in item['payload']:
46 except AttributeError:
48 self.sha256_jids[item['id']] = text
50 def get_reason(self, jid: JID) -> Optional[str]:
51 """Check the presence of the JID in the blocklist"""
52 jidhash = jid_to_sha256(jid)
53 # Raises if item does not exist
54 return self.sha256_jids[jidhash]
57 """Implement the built-in function len(), use for boolean evaluation"""
58 return len(self.sha256_jids)
62 """Spam guard plugin for MUC.
65 pubsub_server = 'example.org'
66 #: Pubsub server node to subscribe to
67 node = 'muc_bans_sha256'
69 def __init__(self, bot):
70 Plugin.__init__(self, bot)
71 bot.register_plugin('xep_0059') # Result Set Management
72 bot.register_plugin('xep_0060') # Publish-Subscribe
74 ('session_start', self._subscribe),
75 ('pubsub_retract', self._retract),
76 ('pubsub_publish', self._publish),
77 (f'muc::{self.bot.room}::presence', self.got_presence),
78 (f'muc::{self.bot.room}::got_offline', self.got_offline),
79 (f'muc::{self.bot.room}::got_online', self.got_online)
83 self.participants = set()
84 self.moderator = False
85 self.blocklist: BL = None
89 self.bot.unregister_bot_plugin(self)
91 async def _subscribe(self, *args):
93 nodes = await self.bot['xep_0060'].get_nodes(self.pubsub_server)
94 nodes_av = [_.get('node') for _ in nodes['disco_items']]
95 self.log.debug(f'nodes available: {nodes_av}')
96 if self.node not in nodes_av:
97 self.log.error(f'{self.node} node not available on {self.pubsub_server}')
99 iq = await self.bot['xep_0060'].subscribe(self.pubsub_server, self.node)
100 subscription = iq['pubsub']['subscription']
101 self.log.info('Subscribed %s to node %s', subscription['jid'], subscription['node'])
102 except XMPPError as error:
103 self.log.error('Could not subscribe %s to node %s: %s',
104 self.bot.boundjid.full, self.node, error.format())
107 node_blocklist = await self.bot['xep_0060'].get_items(self.pubsub_server, self.node)
108 self.blocklist = BL(node_blocklist['pubsub']['items'])
109 mess = f'Got {len(self.blocklist)} items in block list'
111 # Are current participants in the block list
112 for jid in list(self.participants):
113 await self.rtbl_ban(jid)
115 async def _create(self):
116 """Try to create node"""
118 await self.bot['xep_0060'].create_node(self.pubsub_server, self.node)
119 self.log.info('Created node %s', self.node)
120 except XMPPError as err:
121 self.log.error('Could not create node %s: %s', self.node, err.format())
122 raise XMPPError(f'Could not create node {self.node}') from err
124 def _retract(self, msg):
125 """Handler receiving a retract item event."""
126 self.log.debug('Retracted item %s from %s' % (
127 msg['pubsub_event']['items']['retract']['id'],
128 msg['pubsub_event']['items']['node']))
129 self.blocklist.retract_item(msg['pubsub_event']['items']['retract'])
131 async def _publish(self, msg):
132 """Handler receiving a publish item event."""
133 self.log.debug('Published item %s to %s:' % (
134 msg['pubsub_event']['items']['item']['id'],
135 msg['pubsub_event']['items']['node']))
136 data = msg['pubsub_event']['items']['item']['payload']
138 self.log.debug(tostring(data))
140 self.log.debug('No item content')
142 self.blocklist.insert_item(msg['pubsub_event']['items']['item'])
143 # Are current participants in the block list
144 for jid in list(self.participants):
145 await self.rtbl_ban(jid)
147 async def rtbl_ban(self, jid):
148 """Ban jid in RTBL"""
149 if not self.moderator:
151 if not self.blocklist:
152 self.log.debug("block list not populated yet")
154 if self.blocklist.check(jid):
155 self.log.debug(f'About to ban {jid}')
156 reason = self.blocklist.get_reason(jid)
157 if reason is not None:
158 reason = f'rtbl {reason}'
159 await self.ban(jid.bare, reason=reason)
161 def got_offline(self, pres):
162 """Handler method for leaving MUC participants"""
163 fjid = pres['muc']['jid']
164 user = fjid if fjid.full else pres['muc']['nick']
166 self.participants.remove(user)
168 self.log.error('KeyError removing participant: "%s"', user)
169 self.log.debug(f'participants: -{user} (len:{len(self.participants)})')
171 def got_presence(self, pres):
172 """Does bot have required permissions"""
173 if 110 in pres['muc']['status_codes']:
174 if pres['muc']['role'] != 'moderator':
176 'Please give the bot moderator permissions. Will only log actions.'
178 self.moderator = False
181 self.log.info('Got moderator permissions.')
182 self.moderator = True
184 async def got_online(self, pres):
185 """Handler method for new MUC participants"""
186 fjid = pres['muc']['jid']
187 user = fjid if fjid.full else pres['muc']['nick']
188 self.participants.add(user)
189 self.log.debug(f'participants: +{user} (len:{len(self.participants)})')
190 await self.rtbl_ban(user)
193 # vim: ai ts=4 sw=4 sts=4 expandtab