Use SkypeToken authentication in chat API. #1

altavista-79 · 2025-07-29T08:00:50Z

Use SkypeToken authentication in chat API. Parse Reg Token once seen in server response.

…tly, because it will be obtained passively from server responses.

…Token if available. Add TFL specific headers.

…tion token authentication provider.

mihalt · 2025-08-05T17:40:55Z

test/client.py

-        self.assertEqual(sk.conn.tokens["reg"], "registrationToken={0}".format(Data.regToken))
+        # Registration token is now obtained passively, so it won't be present until an API call returns it
+        # Make an API call that will trigger registration token extraction
+        sk.chats.recent()


I understand that you put it here just to check ["reg"] token and it is part of authentification, but the test testChatList already exist. We can do the same checks there.

Everything that can be tested for a lot of functionalities like redirects etc, can be moved to separate functions with assertions.

this is not an auth test, this is test to check that when reg token is provided by chat API it is saved to reuse in subsequent requests

If I understand correct, the adding of reg token is the part of auth process. And by the way, I think, we can need to check it with a lot of requests from the lib.

mihalt · 2025-08-05T17:47:34Z

test/client.py

                  body=json.dumps({"skypetoken": Data.skypeToken, "expiresIn": 86400}))
-    # Request registration token.
+    # Registration tokens are now provided passively in response headers
    expiry = int(time.mktime((datetime.now() + timedelta(days=1)).timetuple()))


it is interesting, why is Data.tokenExpiry not used here?

it is used in users/ME/conversations mock

Is it a problem?

mihalt · 2025-08-05T17:53:57Z

test/client.py

-        self.assertEqual(sk.conn.endpoints["main"].id, "{{{0}}}".format(Data.endpointId))
+        # Registration token is now obtained passively, so it won't be present until an API call returns it
+        # Make an API call that will trigger registration token extraction
+        sk.chats.recent()


Should be just auth redirects, not another functionality

no, here the issue is with redirect from /endpoint api that was used on explicit token retrieval, so tests is adjusted to how it works now

sk.chats.recent() haven't used here earlier. And just authentication via Skype() was tested. This is ok, that you removed assertions that are not actual for authorization now.

test/client.py

mihalt · 2025-08-05T18:03:53Z

test/client.py

+
+        expiry = int(time.mktime(Data.tokenExpiry.timetuple()))
+        # Mock a request that returns a Set-RegistrationToken header
+        responses.add(responses.GET, "{0}/users/ME/conversations".format(SkypeConnection.API_MSGSHOST),


we have added this dummy earlier, as I see. and generally I think we can just not do this test. We checked the same things earlier.

it is better to have explicit test for this functionality, test id left, recent() calls removed form auth tests

mihalt · 2025-08-05T18:05:49Z

test/client.py

+        sk = mockSkype()
+
+        # Intercept the actual request to verify headers
+        def request_callback(request):


we can just do this function separately and use everywhere it needed. This test can be deleted.

test is checking if headers included in requests created by chat api, totally legit tests, no other places where it is checked

yes, but we can check them on each request, where it is needed. Do you think that no scenarios when it could be useful?

mihalt · 2025-08-05T18:07:23Z

test/client.py

+        registerMocks()  # Re-register all the standard mocks
+
+        # Add our specific test mock with registration token
+        responses.add(responses.GET, "{0}/users/ME/conversations".format(SkypeConnection.API_MSGSHOST),


all dummies through responses are collected in registerMocks. They shouldn't be in tests

in general they must be per tests, so having all dummied in one method is bad pattern, because no arrange state visibility, but leaving as is

There are a lot of urls that can repeat from test to test. It will be hard to repeat responses dummies prepare for each.

test/client.py

skpy/conn.py

mihalt · 2025-08-05T19:32:36Z

skpy/conn.py

+        # No-op: Registration tokens are now extracted from Set-RegistrationToken headers
+        # in all HTTP responses via _extractRegistrationToken()
+        pass



I think better to do something like NotImplementedError

From backward compatibility it is not, better to have it undefined, it won't introduce breaking chages. I future it should just be removed, but on this stage looks ok

do you mean the legacy code with usage of previous versions skpy by users? How will they understand then, that this is not supported place that should be changed? If it just returns None, it can be a suffer to debug.

mihalt · 2025-08-05T20:21:05Z

skpy/conn.py

+        """
+        # No-op: Registration tokens are now extracted from Set-RegistrationToken headers
+        # in all HTTP responses via _extractRegistrationToken()
+        pass


_extractRegistrationToken doesn't exist yet here

_extractRegistrationToken is in same file, so it is correct to reference it here

_extractRegistrationToken is in same file, so it is correct to reference it here

yes, but it didn't exist in this commit yet :)

mihalt · 2025-08-05T20:28:35Z

skpy/conn.py

        return resp

+    def _extractRegistrationToken(self, resp):
+        """


I think would be better to name like _initializeRegTokenFromHeader

init is not correct here because reg token is extracted from each appropriate request and is updated if needed, FromHeader is also not describing properly what parameters are passed and what headers to use, thus better name can be _extractRegistrationTokenFromResponse or similar

_extractRegistrationTokenFromResponse

_updateRegistrationTokenFromResponse. The problem here is that not clear that something happens after token extraction.

mihalt · 2025-08-05T21:01:39Z

test/client.py

+                  status=200, content_type="application/json",
+                  json={"threadId": Data.chatThreadId})
+    # Guest auth: join the conversation.
+    responses.add(responses.POST, "{0}/threads/{1}/members".format(SkypeConnection.API_JOIN_CREATE, Data.chatThreadId),


I still can't understand when this both responses appear. Can you describe a bit more the user path here or in commit message?

mihalt · 2025-08-05T21:06:49Z

test/client.py

    responses.add(responses.GET, "{0}/users/ME/conversations".format(SkypeConnection.API_MSGSHOST),
                  status=200, content_type="application/json",
+                  adding_headers={"Set-RegistrationToken": "registrationToken={0}; expires={1}"
+                                                           .format(Data.regToken, expiry)},


I've just checked and I have Set-RegistrationToken header usually just on requests on this endpoint https://teams.live.com/api/chatsvc/consumer/v1/threads/48:calllogs. Are you sure that on /users/ME/conversations it can be too?

mihalt · 2025-08-05T21:07:58Z

test/client.py


+    @responses.activate
+    def testPassiveRegistrationTokenExtraction(self):
+        """


do I understand correct that this test is mainly for _extractRegistrationToken?

mihalt · 2025-08-05T21:11:12Z

test/client.py

+    def testRequiredHeaders(self):
+        """
+        Test that required ms-ic3 headers are included in all requests.
+        """


If I understand correct this is not for all requests, but just for requests connected with /users/ME/conversations, isn't it?

mihalt · 2025-08-06T12:44:28Z

test/API_FIXES_TODO.md

+## ❌ Need Fixes
+
+### 1. Contacts API
+- **Error**: User lookup returns `None`


I've just checked, contacts = myteams.contacts works fine, the same as contacts['teamsid']. Can you clearlify a bit, what is not working?

All notes here are related to server test expectations, in this particular case user lookup is not working, you can run testContacts server test

mihalt · 2025-08-06T13:06:38Z

test/API_FIXES_TODO.md

+### 1. Contacts API
+- **Error**: User lookup returns `None`
+- **Fix**: Update contact search endpoints
+


Yes, the search is indeed not working. The url have the format now like https://presence.teams.live.com/v1/pubsub/subscriptions/{x-ms-endpoint-id}. So, I think that header x-ms-endpoint-id is connected with subscriptions and it should be implemented first.

mihalt · 2025-08-06T14:21:54Z

test/API_FIXES_TODO.md

+
+### 2. Settings API  
+- **Error**: DNS failure for `options.skype.com`
+- **Fix**: Find new settings endpoint URL


myteams.settings works fine, but indeed even ping options.skype.com not works. And I see that it has influence just on callPrivacy and callPrivacyOpt from what myteams.settings returns. But generally, as I understand, this endpoint is not needed yet, because everything is ruled by https://account.microsoft.com/

This API can be deprecated if it is not needed

mihalt · 2025-08-06T14:23:51Z

test/API_FIXES_TODO.md

+- **Fix**: Find new settings endpoint URL
+
+### 3. Translation API
+- **Error**: `404 from dev.microsofttranslator.com`


This is the less important one :)

mihalt · 2025-08-06T14:35:09Z

test/API_FIXES_TODO.md

+
+### 5. Chat API
+- **Error**: `401/404` from conversation endpoints
+- **Fix**: Check conversation ID format changes


I see that everything is fine in .recent() call now. Just one problem is with raised skpy.core.SkypeRateLimitException: ('Rate limit exceeded', <Response [429]>) even with first iteration of .recent(). I think the general limitations of teams are much less now then in skype and we should take into accounting this.

Please describe steps to reproduce it in detail as well, do you use parallel calls, is registration token acquired and passed to the request, etc

Yes. Nothing unusual, reg token is available, how to test are calls parallel? Just call myteams.chats.recent(). But there are a lot of chats in my personal account. I think, that's why a lot of requests happen and raise this error.

mihalt · 2025-08-06T14:49:44Z

test/API_FIXES_TODO.md

+
+## ❌ Need Fixes
+
+### 1. Contacts API


I am not 100% sure, but contacts.contactIds can contain just old skype accounts, but not new. At least I haven't seen emails at first glance.

Check testContacts server test

mihalt · 2025-08-06T14:54:09Z

test/API_FIXES_TODO.md

+- **Fix**: Investigate new subscription method
+
+### 5. Chat API
+- **Error**: `401/404` from conversation endpoints


my_contact_chat.getMsgs() the same as .sendMsg() - I see the error 401 and the header 'StatusText': 'Invalid registration token header.'. Probably is not everything fine with current auth implementation. This tokens were on outcomming request to https://teams.live.com/api/chatsvc/consumer/v1/users/ME/conversations/8:my_contact_id/messages : {'Authentication': '',
'BehaviorOverride': 'redirectAs404',
'RegistrationToken': '',
'Sec-Fetch-Dest': 'empty',
'Sec-Fetch-Mode': 'cors',
'Sec-Fetch-Site': 'cross-site',
'X-SkypeToken': '***'}

Please describe test case more in detail, what was the token state at that stage, when it is reproduced, etc

oh, I am sorry, looks like that it is github formatting. There are *** in Authentication, Registrationtoken. So, the values are appeared. I see them in debuger too.

mihalt · 2025-08-07T15:19:51Z

.gitignore

+*.py[cod]
+
+# Virtual environment
+.env


there is not python-dotenv here. I think, should be deleted

altavista-79 force-pushed the reg-token branch 2 times, most recently from 665d7ed to e8394ae Compare August 5, 2025 15:11

altavista-79 added 8 commits August 5, 2025 20:19

Update authentication method to not use and retreive RegToken explici…

9eb861b

…tly, because it will be obtained passively from server responses.

Update default teams api headers to always include SkypeToken and Reg…

a26b192

…Token if available. Add TFL specific headers.

Obtain Registration Token from server responses and obsolete registra…

70aa69e

…tion token authentication provider.

Update chat API endpoint

b379000

Remove explicit registration token mock responses and client tests

24b99de

Fix guest auth tests

15d424c

Add tests for obtaining reg token from chat api response

3b5b7ac

Add TODO list for APIs

7c7e949

mihalt requested changes Aug 5, 2025

View reviewed changes

Add .gitignore for python

d9c674a

altavista-79 force-pushed the reg-token branch from e8394ae to d9c674a Compare August 5, 2025 18:18

mihalt requested changes Aug 5, 2025

View reviewed changes

mihalt requested changes Aug 6, 2025

View reviewed changes

mihalt requested changes Aug 7, 2025

View reviewed changes

.gitignore

*.py[cod]

# Virtual environment

.env

Copy link

Owner

mihalt Aug 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is not python-dotenv here. I think, should be deleted

Use SkypeToken authentication in chat API. #1

Are you sure you want to change the base?

Use SkypeToken authentication in chat API. #1

Uh oh!

Conversation

altavista-79 commented Jul 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mihalt Aug 6, 2025 •

edited

Loading