diff options
author | lovetox <philipp@hoerist.com> | 2020-10-19 18:02:54 +0300 |
---|---|---|
committer | lovetox <philipp@hoerist.com> | 2020-10-19 18:07:13 +0300 |
commit | 1cb28e12cfccaf64459dd34ab339f329cbfc6f14 (patch) | |
tree | 0d9f577a0e9b50fd1100419f7cf78d4d256a4ff4 /nbxmpp/modules/register | |
parent | 4f2e6246c87a44b55ea1fda1e18ee0caf2705fc8 (diff) |
Register: Refactor module
- Use tasks
Diffstat (limited to 'nbxmpp/modules/register')
-rw-r--r-- | nbxmpp/modules/register/__init__.py | 1 | ||||
-rw-r--r-- | nbxmpp/modules/register/register.py | 102 | ||||
-rw-r--r-- | nbxmpp/modules/register/util.py | 131 |
3 files changed, 234 insertions, 0 deletions
diff --git a/nbxmpp/modules/register/__init__.py b/nbxmpp/modules/register/__init__.py new file mode 100644 index 0000000..da1db62 --- /dev/null +++ b/nbxmpp/modules/register/__init__.py @@ -0,0 +1 @@ +from .register import Register diff --git a/nbxmpp/modules/register/register.py b/nbxmpp/modules/register/register.py new file mode 100644 index 0000000..2ba402c --- /dev/null +++ b/nbxmpp/modules/register/register.py @@ -0,0 +1,102 @@ +# Copyright (C) 2020 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. + +from nbxmpp.namespaces import Namespace +from nbxmpp.protocol import Iq +from nbxmpp.util import get_form +from nbxmpp.task import iq_request_task +from nbxmpp.errors import StanzaError +from nbxmpp.errors import RegisterStanzaError +from nbxmpp.errors import ChangePasswordStanzaError +from nbxmpp.modules.base import BaseModule +from nbxmpp.modules.util import process_response +from nbxmpp.modules.register.util import _make_unregister_request +from nbxmpp.modules.register.util import _make_register_form +from nbxmpp.modules.register.util import _make_password_change_request +from nbxmpp.modules.register.util import _make_password_change_with_form +from nbxmpp.modules.register.util import _parse_register_data + + +class Register(BaseModule): + def __init__(self, client): + BaseModule.__init__(self, client) + + self._client = client + self.handlers = [] + + @iq_request_task + def unregister(self, jid=None): + _task = yield + + response = yield _make_unregister_request(jid) + yield process_response(response) + + @iq_request_task + def request_register_form(self, jid=None): + _task = yield + + if jid is None: + jid = self._client.domain + + response = yield Iq('get', Namespace.REGISTER, to=jid) + if response.isError(): + raise StanzaError(response) + + yield _parse_register_data(response) + + @iq_request_task + def submit_register_form(self, form, jid=None): + _task = yield + + if jid is None: + jid = self._client.domain + + response = yield _make_register_form(jid, form) + if not response.isError(): + yield process_response(response) + + else: + data = _parse_register_data(response) + raise RegisterStanzaError(response, data) + + @iq_request_task + def change_password(self, password): + _task = yield + + response = yield _make_password_change_request( + self._client.domain, self._client.username, password) + if not response.isError(): + yield process_response(response) + + else: + query = response.getQuery() + if query is None: + raise StanzaError(response) + + form = get_form(query, 'jabber:iq:register:changepassword') + if form is None or response.getType() != 'modify': + raise StanzaError(response) + + raise ChangePasswordStanzaError(response, form) + + @iq_request_task + def change_password_with_form(self, form): + _task = yield + + response = yield _make_password_change_with_form(self._client.domain, + form) + yield process_response(response) diff --git a/nbxmpp/modules/register/util.py b/nbxmpp/modules/register/util.py new file mode 100644 index 0000000..53f5dd0 --- /dev/null +++ b/nbxmpp/modules/register/util.py @@ -0,0 +1,131 @@ +# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. + +from nbxmpp.namespaces import Namespace +from nbxmpp.protocol import Iq +from nbxmpp.const import REGISTER_FIELDS +from nbxmpp.structs import RegisterData +from nbxmpp.errors import StanzaError +from nbxmpp.errors import MalformedStanzaError +from nbxmpp.modules.dataforms import create_field +from nbxmpp.modules.dataforms import extend_form +from nbxmpp.modules.dataforms import SimpleDataForm +from nbxmpp.modules.bits_of_binary import parse_bob_data + + +def _make_password_change_request(domain, username, password): + iq = Iq('set', Namespace.REGISTER, to=domain) + query = iq.getQuery() + query.setTagData('username', username) + query.setTagData('password', password) + return iq + + +def _make_password_change_with_form(domain, form): + iq = Iq('set', Namespace.REGISTER, to=domain) + iq.setQueryPayload(form) + return iq + + +def _make_register_form(jid, form): + iq = Iq('set', Namespace.REGISTER, to=jid) + if form.is_fake_form(): + query = iq.getTag('query') + for field in form.iter_fields(): + if field.var == 'fakeform': + continue + query.addChild(field.var, payload=[field.value]) + return iq + + iq.setQueryPayload(form) + return iq + + +def _make_unregister_request(jid): + iq = Iq('set', to=jid) + query = iq.setQuery() + query.setNamespace(Namespace.REGISTER) + query.addChild('remove') + return iq + + +def _parse_oob_url(query): + oob = query.getTag('x', namespace=Namespace.X_OOB) + if oob is not None: + return oob.getTagData('url') or None + return None + + +def _parse_form(stanza): + query = stanza.getTag('query', namespace=Namespace.REGISTER) + form = query.getTag('x', namespace=Namespace.DATA) + if form is None: + return None + + form = extend_form(node=form) + field = form.vars.get('FORM_TYPE') + if field is None: + return None + + # Invalid urn:xmpp:captcha used by ejabberd + # See https://github.com/processone/ejabberd/issues/3045 + if field.value in ('jabber:iq:register', 'urn:xmpp:captcha'): + return form + return None + + +def _parse_fields_form(query): + fields = [] + for field in query.getChildren(): + field_name = field.getName() + if field_name not in REGISTER_FIELDS: + continue + + required = field_name in ('username', 'password') + typ = 'text-single' if field_name != 'password' else 'text-private' + fields.append(create_field(typ=typ, + var=field_name, + required=required)) + + if not fields: + return None + + fields.append(create_field(typ='hidden', var='fakeform')) + return SimpleDataForm(type_='form', + instructions=query.getTagData('instructions'), + fields=fields) + + +def _parse_register_data(response): + query = response.getTag('query', namespace=Namespace.REGISTER) + if query is None: + raise StanzaError(response) + + instructions = query.getTagData('instructions') or None + + data = RegisterData(instructions=instructions, + form=_parse_form(response), + fields_form=_parse_fields_form(query), + oob_url=_parse_oob_url(query), + bob_data=parse_bob_data(query)) + + if (data.form is None and + data.fields_form is None and + data.oob_url is None): + raise MalformedStanzaError('invalid register response', response) + + return data |