v1.3.5
This commit is contained in:
@@ -0,0 +1,61 @@
|
||||
########################################################################
|
||||
# File name: __init__.py
|
||||
# This file is part of: aioxmpp
|
||||
#
|
||||
# LICENSE
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Lesser 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
|
||||
# Lesser General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Lesser General Public
|
||||
# License along with this program. If not, see
|
||||
# <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
########################################################################
|
||||
"""
|
||||
:mod:`~aioxmpp.ibr` --- In-Band Registration (:xep:`0077`)
|
||||
##########################################################
|
||||
|
||||
This module implements in-band registration.
|
||||
|
||||
Registration Functions
|
||||
======================
|
||||
|
||||
The module level registration functions work on an
|
||||
:class:`aioxmpp.protocol.XMLStream` and before authentication. They
|
||||
allow to register a new account with a server.
|
||||
|
||||
.. autofunction:: get_registration_fields
|
||||
|
||||
.. autofunction:: register
|
||||
|
||||
Helper Function
|
||||
===============
|
||||
|
||||
.. autofunction:: get_used_fields
|
||||
|
||||
Service
|
||||
=======
|
||||
|
||||
.. autoclass:: RegistrationService
|
||||
|
||||
XSO Definitions
|
||||
===============
|
||||
|
||||
.. autoclass:: Query
|
||||
"""
|
||||
|
||||
from .service import ( # NOQA: F401
|
||||
RegistrationService,
|
||||
get_registration_fields,
|
||||
register,
|
||||
)
|
||||
from .service import get_used_fields # NOQA: F401
|
||||
from .xso import Query # NOQA: F401
|
||||
BIN
Binary file not shown.
BIN
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,180 @@
|
||||
########################################################################
|
||||
# File name: service.py
|
||||
# This file is part of: aioxmpp
|
||||
#
|
||||
# LICENSE
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Lesser 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
|
||||
# Lesser General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Lesser General Public
|
||||
# License along with this program. If not, see
|
||||
# <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
########################################################################
|
||||
|
||||
import asyncio
|
||||
import aioxmpp
|
||||
import logging
|
||||
from aioxmpp.service import Service
|
||||
from . import xso
|
||||
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
async def get_registration_fields(xmlstream, timeout=60):
|
||||
"""
|
||||
A query is sent to the server to obtain the fields that need to be
|
||||
filled to register with the server.
|
||||
|
||||
:param xmlstream: Specifies the stream connected to the server where
|
||||
the account will be created.
|
||||
:type xmlstream: :class:`aioxmpp.protocol.XMLStream`
|
||||
|
||||
:param timeout: Maximum time in seconds to wait for an IQ response, or
|
||||
:data:`None` to disable the timeout.
|
||||
:type timeout: :class:`~numbers.Real` or :data:`None`
|
||||
|
||||
:return: :attr:`list`
|
||||
"""
|
||||
|
||||
iq = aioxmpp.IQ(
|
||||
to=aioxmpp.JID.fromstr(xmlstream._to),
|
||||
type_=aioxmpp.IQType.GET,
|
||||
payload=xso.Query()
|
||||
)
|
||||
iq.autoset_id()
|
||||
|
||||
reply = await aioxmpp.protocol.send_and_wait_for(
|
||||
xmlstream,
|
||||
[iq],
|
||||
[aioxmpp.IQ],
|
||||
timeout=timeout
|
||||
)
|
||||
return reply.payload
|
||||
|
||||
|
||||
async def register(xmlstream, query_xso, timeout=60):
|
||||
"""
|
||||
Create a new account on the server.
|
||||
|
||||
:param query_xso: XSO with the information needed for the registration.
|
||||
:type query_xso: :class:`~aioxmpp.ibr.Query`
|
||||
|
||||
:param xmlstream: Specifies the stream connected to the server where
|
||||
the account will be created.
|
||||
:type xmlstream: :class:`aioxmpp.protocol.XMLStream`
|
||||
|
||||
:param timeout: Maximum time in seconds to wait for an IQ response, or
|
||||
:data:`None` to disable the timeout.
|
||||
:type timeout: :class:`~numbers.Real` or :data:`None`
|
||||
"""
|
||||
iq = aioxmpp.IQ(
|
||||
to=aioxmpp.JID.fromstr(xmlstream._to),
|
||||
type_=aioxmpp.IQType.SET,
|
||||
payload=query_xso
|
||||
)
|
||||
iq.autoset_id()
|
||||
|
||||
await aioxmpp.protocol.send_and_wait_for(
|
||||
xmlstream,
|
||||
[iq],
|
||||
[aioxmpp.IQ],
|
||||
timeout=timeout
|
||||
)
|
||||
|
||||
|
||||
def get_used_fields(payload):
|
||||
"""
|
||||
Get a list containing the names of the fields that are used in the
|
||||
xso.Query.
|
||||
|
||||
:param payload: Query object o be
|
||||
:type payload: :class:`~aioxmpp.ibr.Query`
|
||||
:return: :attr:`list`
|
||||
"""
|
||||
return [
|
||||
tag
|
||||
for tag, descriptor in payload.CHILD_MAP.items()
|
||||
if descriptor.__get__(payload, type(payload)) is not None
|
||||
]
|
||||
|
||||
|
||||
class RegistrationService(Service):
|
||||
"""
|
||||
Service implementing the XMPP In-Band Registration(:xep:`0077`)
|
||||
use cases for registered entities.
|
||||
|
||||
This service allows an already registered and authenticated entity
|
||||
to request information about the registration, cancel an existing
|
||||
registration, or change a password.
|
||||
|
||||
.. automethod:: get_client_info
|
||||
|
||||
.. automethod:: change_pass
|
||||
|
||||
.. automethod:: cancel_registration
|
||||
|
||||
"""
|
||||
|
||||
async def get_client_info(self):
|
||||
"""
|
||||
A query is sent to the server to obtain the client's data stored at the
|
||||
server.
|
||||
|
||||
:return: :class:`~aioxmpp.ibr.Query`
|
||||
"""
|
||||
iq = aioxmpp.IQ(
|
||||
to=self.client.local_jid.bare().replace(localpart=None),
|
||||
type_=aioxmpp.IQType.GET,
|
||||
payload=xso.Query()
|
||||
)
|
||||
|
||||
reply = await self.client.send(iq)
|
||||
return reply
|
||||
|
||||
async def change_pass(self, new_pass):
|
||||
"""
|
||||
Change the client password for 'new_pass'.
|
||||
|
||||
:param new_pass: New password of the client.
|
||||
:type new_pass: :class:`str`
|
||||
|
||||
:param old_pass: Old password of the client.
|
||||
:type old_pass: :class:`str`
|
||||
|
||||
"""
|
||||
iq = aioxmpp.IQ(
|
||||
to=self.client.local_jid.bare().replace(localpart=None),
|
||||
type_=aioxmpp.IQType.SET,
|
||||
payload=xso.Query(self.client.local_jid.localpart, new_pass)
|
||||
)
|
||||
|
||||
await self.client.send(iq)
|
||||
|
||||
async def cancel_registration(self):
|
||||
"""
|
||||
Cancels the currents client's account with the server.
|
||||
|
||||
Even if the cancellation is successful, this method will raise an
|
||||
exception due to he account no longer exists for the server, so the
|
||||
client will fail.
|
||||
To continue with the execution, this method should be surrounded by a
|
||||
try/except statement.
|
||||
"""
|
||||
iq = aioxmpp.IQ(
|
||||
to=self.client.local_jid.bare().replace(localpart=None),
|
||||
type_=aioxmpp.IQType.SET,
|
||||
payload=xso.Query()
|
||||
)
|
||||
|
||||
iq.payload.remove = True
|
||||
await self.client.send(iq)
|
||||
@@ -0,0 +1,192 @@
|
||||
########################################################################
|
||||
# File name: xso.py
|
||||
# This file is part of: aioxmpp
|
||||
#
|
||||
# LICENSE
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Lesser 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
|
||||
# Lesser General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Lesser General Public
|
||||
# License along with this program. If not, see
|
||||
# <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
########################################################################
|
||||
import aioxmpp
|
||||
import aioxmpp.xso as xso
|
||||
|
||||
from aioxmpp.utils import namespaces
|
||||
|
||||
namespaces.xep0077_in_band = "jabber:iq:register"
|
||||
|
||||
|
||||
@aioxmpp.IQ.as_payload_class
|
||||
class Query(xso.XSO):
|
||||
"""
|
||||
:xep:`077` In-Band Registraion query :class:`~aioxmpp.xso.XSO`.
|
||||
|
||||
It has the following fields described in the XEP document:
|
||||
|
||||
.. attribute:: username
|
||||
|
||||
.. attribute:: nick
|
||||
|
||||
.. attribute:: password
|
||||
|
||||
.. attribute:: name
|
||||
|
||||
.. attribute:: first
|
||||
|
||||
.. attribute:: last
|
||||
|
||||
.. attribute:: email
|
||||
|
||||
.. attribute:: address
|
||||
|
||||
.. attribute:: city
|
||||
|
||||
.. attribute:: state
|
||||
|
||||
.. attribute:: zip
|
||||
|
||||
.. attribute:: phone
|
||||
|
||||
.. attribute:: url
|
||||
|
||||
.. attribute:: date
|
||||
|
||||
.. attribute:: misc
|
||||
|
||||
.. attribute:: text
|
||||
|
||||
.. attribute:: key
|
||||
|
||||
.. attribute:: registered
|
||||
|
||||
.. attribute:: remove
|
||||
"""
|
||||
|
||||
TAG = (namespaces.xep0077_in_band, "query")
|
||||
username = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "username"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
instructions = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "instructions"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
nick = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "nick"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
password = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "password"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
name = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "name"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
first = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "first"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
last = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "last"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
email = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "email"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
address = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "address"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
city = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "city"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
state = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "state"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
zip = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "zip"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
phone = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "phone"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
url = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "url"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
date = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "date"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
misc = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "misc"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
text = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "text"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
key = xso.ChildText(
|
||||
(namespaces.xep0077_in_band, "key"),
|
||||
default=None,
|
||||
)
|
||||
|
||||
registered = xso.ChildFlag(
|
||||
(namespaces.xep0077_in_band, "registered")
|
||||
)
|
||||
|
||||
remove = xso.ChildFlag(
|
||||
(namespaces.xep0077_in_band, "remove")
|
||||
)
|
||||
|
||||
def __init__(self, username=None, password=None, aux_fields=None):
|
||||
"""
|
||||
Get an xso.Query object with the info provided in he parameters.
|
||||
|
||||
:param username: Username of the query
|
||||
:type username: :class:`str`
|
||||
:param password: Password of the query.
|
||||
:type password: :class:`str`
|
||||
:param aux_fields: Auxiliary fields in case additional info is needed.
|
||||
:type aux_fields: :class:`dict`
|
||||
:return: :class:`xso.Query`
|
||||
"""
|
||||
self.username = username
|
||||
self.password = password
|
||||
|
||||
if aux_fields is not None:
|
||||
for key, value in aux_fields.items():
|
||||
setattr(self, key, value)
|
||||
Reference in New Issue
Block a user