Merge pull request #70 from KrazyKirby99999/access_token

Access token login support added.

Author: KrazyKirby99999

doc/manual/creds.md

@@ -14,9 +14,21 @@ creds = botlib.Creds(
 or
 ```python
 creds = botlib.Creds(
-    homeserver="https://example.org", 
-    login_token="MDA..gZ2"
+    homeserver="https://example.org",
+    username="username", 
+    login_token="MDA..gZ2",
     session_stored_file="session.txt"
     )
 ```
-The homeserver argument is always required. The username, and password arguments are also required unless the login_token argument is used. The keyword "login_token" must be specified when the login_token argument is used. Although the login_token can only be used to authenticate with the homeserver once, it is required in every run of the bot in order to encrypt/decrypt the session data such as the access_token. If the login_token is used and the session_stored_file argument is set to `None`, then the bot will only be able to run once per login_token. The session_stored_file argument is optional and allows for specific data relating to each session such as the access token and the device name to be preserved across each run of the bot.
+or
+```python
+creds = botlib.Creds(
+    homeserver="https://example.org",
+    username="username",
+    access_token="syt_c2...DTJ",
+    session_stored_file="session.txt"
+    )
+```
+The homeserver and username arguments are always required.  The password argument may be replaced by either the login_token argument or the access_token argument. The login_token is used with handling SSO logins (See the [Matrix Docs](https://matrix.org/docs/guides/sso-for-client-developers#handling-sso)). The access_token is normally generated after using a different login method with another client. 
+
+The optional session_stored_file argument is the location of a file used by the bot to store session information such as the generated access token and device name. A login_token can only be used to authenticate once, so setting the session_stored_file argument to "" will require you to enter a new SSO token each time the program is run.

simplematrixbotlib/api.py

@@ -5,8 +5,10 @@
 import mimetypes
 import os
 import markdown
-
+import aiohttp
+import ast
 from nio.responses import UploadResponse
+import nio
 
 
 class Api:
@@ -37,30 +39,36 @@ async def login(self):
 
         """
 
-        self.creds.session_read_file()
+        if not self.creds.homeserver:
+            raise ValueError("Missing homeserver")
+        if not self.creds.username:
+            raise ValueError("Missing Username")
+        if not (self.creds.password or self.creds.login_token or self.creds.access_token):
+            raise ValueError("Missing password, login token, access token. Either password, login token or access token must be provided")
 
-        self.async_client = AsyncClient(self.creds.homeserver,
-                                        self.creds.username)
+        self.async_client = AsyncClient(homeserver=self.creds.homeserver, user=self.creds.username, device_id=self.creds.device_id)
 
-        if self.creds.device_id:
-            self.async_client.device_id = self.creds.device_id
+        if self.creds.password:
+            resp = await self.async_client.login(password=self.creds.password,  device_name=self.creds.device_name)
 
-        if self.creds.password or self.creds.login_token:
-            response = await self.async_client.login(
-                password=self.creds.password,
-                device_name='Bot Client built with Simple-Matrix-Bot-Lib',
-                token=self.creds.login_token)
-            print(response)
+        elif self.creds.access_token:
+            self.async_client.access_token = self.creds.access_token
 
-            self.creds.device_id = response.device_id
-            self.creds.access_token = response.access_token
+            async with aiohttp.ClientSession() as session:
+                async with session.get(f'https://matrix.org/_matrix/client/r0/account/whoami?access_token={self.creds.access_token}') as response:
+                    device_id = ast.literal_eval((await response.text()).replace(":false,", ":\"false\","))['device_id']
+                    user_id = ast.literal_eval((await response.text()).replace(":false,", ":\"false\","))['user_id']
+            
+            self.async_client.device_id, self.creds.device_id = device_id, device_id
+            self.async_client.user_id, self.creds.user_id = user_id, user_id
+            resp = None
 
-        else:
-            self.async_client.access_token = self.creds.access_token
-            self.async_client.user_id = f"@{self.creds.username}:{self.creds.homeserver}"
-            self.async_client.device_id = self.creds.device_id
+        elif self.creds.login_token:
+            resp = await self.async_client.login(token=self.creds.login_token,  device_name=self.creds.device_name)
+        
+        if isinstance(resp, nio.responses.LoginError):
+            raise Exception(resp)
 
-        self.creds.session_write_file()
 
     async def send_text_message(self, room_id, message):
         """
@@ -159,3 +167,5 @@ async def send_markdown_message(self, room_id, message):
                                               "formatted_body":
                                               markdown.markdown(message)
                                           })
+
+

simplematrixbotlib/auth.py

@@ -24,6 +24,7 @@ def __init__(self,
                  username=None,
                  password=None,
                  login_token=None,
+                 access_token=None,
                  session_stored_file='session.txt'):
         """
         Initializes the simplematrixbotlib.Creds class.
@@ -37,10 +38,13 @@ def __init__(self,
             The username for the bot to connect as. This is neccesary if password is used instead of login_token.
     
         password : str, optional
-            The password for the bot to connect with. Can be used instead of login_token. Either the login_token or password must be provided.
+            The password for the bot to connect with. Can be used instead of login_token. One of the password, login_token, or access_token must be provided.
 
         login_token : str, optional
-            The login_token for the bot to connect with. Can be used instead of password. Either the login_token or password must be provided.
+            The login_token for the bot to connect with. Can be used instead of password. One of the password, login_token, or access_token must be provided.
+
+        access_token : str, optional
+            The access_token for the bot to connect with. Can be used instead of password. One of the password, login_token, or access_token must be provided.
         
         session_stored_file : str, optional
             Location for the bot to read and write device_id and access_token. The data within this file is encrypted and decrypted with the password parameter using the cryptography package. If set to None, session data will not be saved to file.
@@ -51,11 +55,19 @@ def __init__(self,
         self.username = username
         self.password = password
         self.login_token = login_token
+        self.access_token = access_token
         self._session_stored_file = session_stored_file
+        self.device_name = "Bot Client using Simple-Matrix-Bot-Lib"
+        self.device_id = ""
+
         if self.password:
             self._key = fw.key_from_pass(self.password)
-        else:
+        elif self.login_token:
             self._key = fw.key_from_pass(self.login_token)
+        elif self.access_token:
+            self._key = fw.key_from_pass(self.access_token)
+        else:
+            raise ValueError("password or login_token or access_token is required")
 
     def session_read_file(self):
         """
@@ -85,7 +97,6 @@ def session_read_file(self):
 
         if not file_exists:
             self.device_id = None
-            self.access_token = None
 
     def session_write_file(self):
         """

simplematrixbotlib/bot.py

@@ -1,5 +1,6 @@
 import asyncio
 import simplematrixbotlib as botlib
+from nio import SyncResponse
 
 
 class Bot:
@@ -29,12 +30,22 @@ def __init__(self, creds):
         self.listener = botlib.Listener(self)
 
     async def main(self):
+
+        self.creds.session_read_file()
+
         await self.api.login()
+        
         self.async_client = self.api.async_client
 
-        await self.async_client.sync(timeout=65536,
+
+        resp = await self.async_client.sync(timeout=65536,
                                      full_state=False)  #Ignore prior messages
 
+        if isinstance(resp, SyncResponse):
+            print(f"Connected to {self.async_client.homeserver} as {self.async_client.user_id} ({self.async_client.device_id})")
+
+        self.creds.session_write_file()
+
         self.callbacks = botlib.Callbacks(self.async_client, self)
         await self.callbacks.setup_callbacks()