setuptools: Structure module to be compliant with setuptools installation routine

Author: tuxuser

.gitignore

@@ -6,5 +6,12 @@ __pycache__
 .vscode/
 .idea/
 venv/
+.venv/
+.env/
 
 appconfig*
+
+# Python build artifacts
+*.egg-info/
+build/
+dist/

README.md

@@ -10,6 +10,7 @@ source venv/bin/activate
 ```
 
 And install the dependencies
+
 ```sh
 pip install -r requirements.txt
 ```
@@ -18,8 +19,8 @@ pip install -r requirements.txt
 
 You can invoke 3 different parts of the script
 
-```
+```sh
 python -m main smartglass
 python -m main xhome
 python -m main xcloud
-```
+```

requirements.txt

@@ -3,4 +3,5 @@ ms_cv
 pydantic
 httpx
 aiortc
-construct
+construct
+dpkt

setup.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+
+from setuptools import setup, find_packages
+
+setup(
+    name='xcloud',
+    version='0.1.0',
+    description='XCloud Gamestreaming library for python',
+    author='tuxuser',
+    author_email='noreply@openxbox.org',
+    url='https://github.com/OpenXbox/xcloud-python',
+    packages=find_packages(),
+    entry_points={'console_scripts': ['xcloud-pcap-reader=xcloud.scripts.pcap_reader:main']},
+    install_requires=[
+        "ecdsa",
+        "ms_cv",
+        "pydantic",
+        "httpx",
+        "aiortc",
+        "construct",
+        "dpkt"
+    ]
+)

__init__.py renamed to xcloud/__init__.py

@@ -1,6 +1,6 @@
 from pydantic import BaseModel
 from typing import Dict, List, Optional
-from auth.constants import XalAppId, XalTitleId, XalRedirectUri,\
+from .constants import XalAppId, XalTitleId, XalRedirectUri,\
     XalQueryDisplay, XalDeviceType, XalUserAgents
 
 

auth/__init__.py renamed to xcloud/auth/__init__.py

@@ -7,10 +7,10 @@
 import hashlib
 import struct
 from datetime import datetime
-
-from auth import filetimes
 from ecdsa import SigningKey, NIST256p
 
+from . import filetimes
+
 
 class RequestSigner:
 

auth/constants.py renamed to xcloud/auth/constants.py

@@ -6,7 +6,7 @@
 
 import asyncio
 import httpx
-from auth.request_signer import RequestSigner
+from .request_signer import RequestSigner
 
 
 class SignedSession(httpx.AsyncClient):

auth/filetimes.py renamed to xcloud/auth/filetimes.py

@@ -13,12 +13,12 @@
 from typing import Optional, Tuple
 
 import ms_cv
-from auth.signed_session import SignedSession
-from auth.request_signer import RequestSigner
-from auth.models import SisuAuthenticationResponse, SisuAuthorizationResponse, \
+from .signed_session import SignedSession
+from .request_signer import RequestSigner
+from .models import SisuAuthenticationResponse, SisuAuthorizationResponse, \
     WindowsLiveTokenResponse, XADResponse, XalClientParameters, XSTSResponse, \
     XCloudTokenResponse
-from auth.constants import XalDeviceType
+from .constants import XalDeviceType
 
 log = logging.getLogger('auth')
 

auth/models.py renamed to xcloud/auth/models.py

@@ -1,7 +1,7 @@
 from typing import Optional
 
 from pydantic import BaseModel, UUID4
-from auth.models import SisuAuthorizationResponse, WindowsLiveTokenResponse,\
+from .auth.models import SisuAuthorizationResponse, WindowsLiveTokenResponse,\
     XalClientParameters
 
 

auth/request_signer.py renamed to xcloud/auth/request_signer.py

@@ -1,4 +1,4 @@
-from typing import List
+from typing import List, Tuple
 
 
 from aiortc import (
@@ -78,7 +78,9 @@ async def generate_local_config(self) -> dict:
         return ice_config
 
     @staticmethod
-    def parse_remote_config(ice_config: dict) -> (List[RTCIceCandidate], RTCIceParameters):
+    def parse_remote_config(
+        ice_config: dict
+    ) -> Tuple[List[RTCIceCandidate], RTCIceParameters]:
         candidate_nodes: dict = ice_config.get('Candidates')
         if not candidate_nodes:
             raise Exception(

auth/signed_session.py renamed to xcloud/auth/signed_session.py

@@ -4,16 +4,16 @@
 import time
 import asyncio
 
-from common import AppConfiguration
+from .common import AppConfiguration
 
-from auth.constants import IOS_XBOXBETA_APP_PARAMS, ANDROID_GAMEPASS_BETA_PARAMS
-from auth.models import XalClientParameters, XSTSResponse
-from auth.xal_auth import XalAuthenticator
-from auth.request_signer import RequestSigner
+from .auth.constants import IOS_XBOXBETA_APP_PARAMS, ANDROID_GAMEPASS_BETA_PARAMS
+from .auth.models import XalClientParameters, XSTSResponse
+from .auth.xal_auth import XalAuthenticator
+from .auth.request_signer import RequestSigner
 
-from smartglass_api import SmartglassApi
-from xcloud_api import XCloudApi
-from xhomestreaming_api import XHomeStreamingApi
+from .smartglass_api import SmartglassApi
+from .xcloud_api import XCloudApi
+from .xhomestreaming_api import XHomeStreamingApi
 
 APP_CONFIG_XBOXBETA_FILE = "appconfig.xboxbeta.json"
 APP_CONFIG_XBOXGAMEPASS_FILE = "appconfig.xboxgamepass.json"

auth/xal_auth.py renamed to xcloud/auth/xal_auth.py

@@ -1,5 +1,22 @@
+from enum import Enum
 from construct import Struct, this, Int32ul, Int64ul, PrefixedArray, Bytes, Array
 
+"""
+Payload types
+"""
+class PayloadType(Enum):
+    MuxDCTChannelRangeDefault = 0x23
+    MuxDCTChannelRangeEnd = 0x3f
+    BaseLinkControl = 0x60
+    MuxDCTControl = 0x61
+    FECControl = 0x62
+    SecurityLayerCtrl = 0x63
+    URCPControl = 0x64
+    UDPKeepAlive = 0x65
+    UDPConnectionProbing = 0x66
+    URCPDummyPacket = 0x68
+    MockUDPDctCtrl = 0x7f
+
 """
 Video Channel
 """
@@ -83,3 +100,12 @@ class QosControlFlags:
     # TBD
 )
 
+"""
+Control Protocol
+"""
+class ControlProtocolMessageOpCode(Enum):
+    Auth = 0x1
+    AuthComplete = 0x2
+    Config = 0x3
+    ControllerChange = 0x4
+    Config2 = 0x6

common.py renamed to xcloud/common.py

@@ -0,0 +1,20 @@
+"""
+PCAP Parser for XCloud network traffic
+"""
+import argparse
+
+def parse_file(filepath: str) -> None:
+    print(f"hello -> {filepath}")
+
+def main():
+    parser = argparse.ArgumentParser(
+        "XCloud PCAP parser",
+        description="PCAP Parser for XCloud network traffic"
+    )
+    parser.add_argument("filepath", help="Path to PCAP/NG file")
+    args = parser.parse_args()
+
+    parse_file(args.filepath)
+
+if __name__ == "__main__":
+    main()

ice.py renamed to xcloud/ice.py

@@ -4,11 +4,11 @@
 from typing import Optional, Union, List
 
 import ms_cv
-from auth.models import SisuAuthorizationResponse, XSTSResponse
-from auth.signed_session import SignedSession
-from auth.request_signer import RequestSigner
+from .auth.models import SisuAuthorizationResponse, XSTSResponse
+from .auth.signed_session import SignedSession
+from .auth.request_signer import RequestSigner
 
-from smartglass_models import SmartglassConsoleList, \
+from .smartglass_models import SmartglassConsoleList, \
     SmartglassConsoleStatus, CommandResponse, VolumeDirection, InputKeyType,\
     MediaCommand, InstalledPackagesList, StorageDevicesList,\
     OperationStatusResponse

main.py renamed to xcloud/main.py

@@ -5,10 +5,10 @@
 import httpx
 import ms_cv
 
-from auth.models import XSTSResponse, XCloudTokenResponse
-from streaming_models import StreamLoginResponse, StreamSessionResponse, \
+from .auth.models import XSTSResponse, XCloudTokenResponse
+from .streaming_models import StreamLoginResponse, StreamSessionResponse, \
     StreamStateResponse, StreamConfig, StreamSetupState
-from xcloud_models import TitlesResponse, TitleWaitTimeResponse, CloudGameTitle
+from .xcloud_models import TitlesResponse, TitleWaitTimeResponse, CloudGameTitle
 
 USER_AGENT_ANDROID = '{"conn":{"cell":{"carrier":"congstar","mcc":"262","mnc":"01","networkDetail":"{\"ci\":\"unknown\",\"pci\":\"unknown\",\"rat\":\"unknown\",\"signalStrengthDbm\":\"-2147483648\",\"pilotPowerSignalQuality\":\"-2147483648\",\"snr\":\"-2147483648\"}","roaming":"NotRoaming","strengthPct":100},"type":"Wifi","wifi":{"freq":5300,"strengthDbm":-60,"strengthPct":88}},"dev":{"hw":{"make":"Google","model":"Pixel 3a"},"os":{"name":"Android","ver":"11-RP1A.200720.009-30"}}}'
 

xcloud/protocol/__init__.py

@@ -6,10 +6,10 @@
 import ms_cv
 
 import httpx
-from auth.models import XSTSResponse
-from ice import ICEHandler
+from .auth.models import XSTSResponse
+from .ice import ICEHandler
 
-from streaming_models import StreamLoginResponse, StreamSessionResponse, \
+from .streaming_models import StreamLoginResponse, StreamSessionResponse, \
     StreamStateResponse, StreamConfig, StreamICEConfig
 
 USER_AGENT_IOS = '{"conn":{"cell":{"carrier":"","mcc":"","mnc":"","networkDetail":"","roaming":"Unknown","strengthPct":-1},"type":"Wifi","wifi":{"freq":-2147483648,"strengthDbm":-2147483648,"strengthPct":-1}},"dev":{"hw":{"make":"Apple","model":"iPad6,11"},"os":{"name":"iOS","ver":"14.0.1 (Build 18A393)"}}}'