added WebAuth module

docs/api/steam.rst

@@ -6,5 +6,6 @@ steam
     steam.core
     steam.enums
     steam.steamid
-    steam.util
     steam.webapi
+    steam.webauth
+    steam.util

docs/api/steam.webauth.rst

@@ -0,0 +1,7 @@
+steam.webauth
+=============
+
+.. automodule:: steam.webauth
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/user_guide.rst

@@ -237,3 +237,17 @@ Alternatively, a callback can be registered to handle the response event every t
         pass
     # OR
     client.on(EMsg.ClientAddFriendResponse, handle_add_response)
+
+
+Web Authentication
+==================
+
+There are currently two paths for gaining accessing to steam websites.
+Either using :class:`steam.webauth.WebAuth`, or via a :class:`steam.client.SteamClient` instance.
+
+.. code:: python
+
+    session = client.get_web_session()  # returns request.Session
+    session.get('https://store.steampowered.com')
+
+For more details about :class:`steam.webauth.WebAuth`, see :doc:`api/steam.webauth`

steam/__init__.py

@@ -5,6 +5,7 @@ version_info = (0, 7, 4)
 
 from steam.steamid import SteamID
 from steam.webapi import WebAPI
+from steam.webauth import WebAuth
 
 
 # proxy object

steam/webauth.py

@@ -0,0 +1,203 @@
+# -*- coding: utf-8 -*-
+"""
+This module simplifies the process of obtaining an authenticated session for steam websites.
+After authentication is complete, a :class:`requests.Session` is created containing the auth cookies.
+The session can be used to access ``steamcommunity.com`` and ``steampowered.com``.
+
+Example usage:
+
+.. code:: python
+
+    import steam.webauth as wa
+
+    user = wa.WebAuth('username', 'password')
+
+    try:
+        user.login()
+    except wa.CaptchaRequired:
+        print user.captcha_url
+        # ask a human to solve captcha
+        user.login(captcha='ABC123')
+    except wa.EmailCodeRequired:
+        user.login(email_code='ZXC123')
+    except wa.TwoFactorCodeRequired:
+        user.login(twofactor_code='ZXC123')
+
+    wa.session.get('https://store.steampowered.com/account/history/')
+
+Alternatively, if Steam Guard is not enabled on the account:
+
+.. code:: python
+
+    try:
+        session = wa.WebAuth('username', 'password').login()
+    except wa.HTTPError:
+        pass
+
+.. note::
+    If you are using :class:`steam.client.SteamClient`, see :meth:`steam.client.builtins.web.Web.get_web_session()`
+
+"""
+import time
+import sys
+from base64 import b64encode
+from Crypto.PublicKey import RSA
+from Crypto.Cipher import PKCS1_v1_5
+from steam.util.web import make_requests_session
+from steam import SteamID
+
+if sys.version_info < (3,):
+    intBase = long
+else:
+    intBase = int
+
+
+class WebAuth(object):
+    cipher = None
+    complete = False  #: whether authentication has been completed successfully
+    session = None    #: :class:`requests.Session` (with auth cookies after auth is complete)
+    captcha_gid = -1
+    steamid = None    #: :class:`steam.steamid.SteamID` (after auth is complete)
+
+    def __init__(self, username, password):
+        self.__dict__.update(locals())
+        self.session = make_requests_session()
+
+    @property
+    def captcha_url(self):
+        """If a captch is required this property will return url to the image, or ``None``"""
+        if self.captcha_gid == -1:
+            return None
+        else:
+            return "https://store.steampowered.com/login/rendercaptcha/?gid=%s" % self.captcha_gid
+
+    def get_rsa_key(self, username):
+        """Get rsa key for a given username
+
+        :param username: username
+        :type username: :class:`str`
+        :return: json response
+        :rtype: :class:`dict`
+        :raises HTTPError: when there is any problem with the rsa key request
+        """
+        try:
+            resp = self.session.get('https://store.steampowered.com/login/getrsakey/',
+                                    timeout=15,
+                                    params={
+                                        'username': username,
+                                        'donotchache': int(time.time() * 1000),
+                                        },
+                                    ).json()
+        except requests.exceptions.RequestException as e:
+            raise HTTPError(str(e))
+
+        return resp
+
+    def _make_cipher(self):
+        if not self.cipher:
+            resp = self.get_rsa_key(self.username)
+
+            rsa = RSA.construct((intBase(resp['publickey_mod'], 16),
+                                 intBase(resp['publickey_exp'], 16),
+                                 ))
+
+            self.cipher = PKCS1_v1_5.new(rsa)
+            self.timestamp = resp['timestamp']
+
+    def login(self, captcha='', email_code='', twofactor_code='', language='english'):
+        """Attempts web login and returns on a session with cookies set
+
+        :param captcha: text reponse for captcha challenge
+        :type captcha: :class:`str`
+        :param email_code: email code for steam guard
+        :type email_code: :class:`str`
+        :param twofactor_code: 2FA code for steam guard
+        :type twofactor_code: :class:`str`
+        :param language: select language for steam web pages (sets language cookie)
+        :type language: :class:`str`
+        :return: a session on success and :class:`None` otherwise
+        :rtype: :class:`requests.Session`, :class:`None`
+        :raises HTTPError: when there is any problem with the rsa key request
+        :raises CaptchaRequired: when captcha is needed
+        :raises EmailCodeRequired: when email is needed
+        :raises TwoFactorCodeRequired: when 2FA is needed
+        :raises LoginIncorrect: wrong username or password
+        """
+        if self.complete:
+            return self.session
+
+        self._make_cipher()
+
+        params = {
+            'username' : self.username,
+            "password": b64encode(self.cipher.encrypt(self.password)),
+            "emailauth": email_code,
+            "emailsteamid": str(self.steamid) if email_code else '',
+            "twofactorcode": twofactor_code,
+            "captchagid": self.captcha_gid,
+            "captcha_text": captcha,
+            "loginfriendlyname": "python-steam webauth",
+            "rsatimestamp": self.timestamp,
+            "remember_login": False,
+            "donotcache": int(time.time() * 1000),
+        }
+
+        try:
+            resp = self.session.get('https://store.steampowered.com/login/dologin/', params=params, timeout=15).json()
+        except requests.exceptions.RequestException as e:
+            raise HTTPError(str(e))
+
+        self.captcha_gid = -1
+
+        if resp['success'] and resp['login_complete']:
+            self.complete = True
+            self.password = None
+
+            # dologin will actually set the cookies, but only for steamcommunity.com  ¯\_(ツ)_/¯
+            self.session.cookies.clear()
+            data = resp['transfer_parameters']
+
+            self.steamid = SteamID(data['steamid'])
+
+            for domain in ['.steampowered.com', '.steamcommunity.com']:
+                self.session.cookies.set('steamLogin', '%s||%s' % (data['steamid'], data['token']),
+                                    domain=domain, secure=False)
+                self.session.cookies.set('steamLoginSecure', '%s||%s' % (data['steamid'], data['token_secure']),
+                                    domain=domain, secure=True)
+                self.session.cookies.set('Steam_Language', language, domain=domain)
+                self.session.cookies.set('birthtime', '-3333', domain=domain)
+
+            return self.session
+        else:
+            if resp.get('captcha_needed', False):
+                self.captcha_gid = resp['captcha_gid']
+
+                raise CaptchaRequired(resp['message'])
+            elif resp.get('emailauth_needed', False):
+                self.steamid = SteamID(resp['emailsteamid'])
+                raise EmailCodeRequired(resp['message'])
+            elif resp.get('requires_twofactor', False):
+                raise TwoFactorCodeRequired(resp['message'])
+            else:
+                raise LoginIncorrect(resp['message'])
+
+        return None
+
+
+class WebAuthException(Exception):
+    pass
+
+class HTTPError(WebAuthException):
+    pass
+
+class LoginIncorrect(WebAuthException):
+    pass
+
+class CaptchaRequired(WebAuthException):
+    pass
+
+class EmailCodeRequired(WebAuthException):
+    pass
+
+class TwoFactorCodeRequired(WebAuthException):
+    pass