Google App Engine の webapp2 で認証してみた

Google App Engine で Python2.7 が使えるようになった。
前のポストで紹介したとおり、チュートリアルで利用される Web アプリケーションフレームワークが webapp2 に変更された。
webapp2 では webapp2_extras を呼び出すことで、セッション管理や国際化といったオプション機能を使うことができる。
Issue 20 – webapp-improved – Sample auth app – Google App Engine’s webapp, take two – Google Project Hosting で紹介されているコードを参考に、認証機能を提供する Auth モジュールの使い方を勉強した。ソースは github で公開している

app.yaml

application: webapp2-auth
version: 1
runtime: python27
api_version: 1
threadsafe: true

handlers:
- url: /.*
  script: handlers.app

handlers.py

import webapp2
from webapp2_extras import auth
from webapp2_extras import sessions
from webapp2_extras.auth import InvalidAuthIdError
from webapp2_extras.auth import InvalidPasswordError

authsessions をインポートして利用する。

def user_required(handler):
    """
         Decorator for checking if there's a user associated with the current session.
         Will also fail if there's no session present.
     """
    def check_login(self, *args, **kwargs):
        auth = self.auth
        if not auth.get_user_by_session():
            # If handler has no login_url specified invoke a 403 error
            try:
                self.redirect(self.auth_config['login_url'], abort=True)
            except (AttributeError, KeyError), e:
                self.abort(403)
        else:
            return handler(self, *args, **kwargs)
    return check_login

user_required はauth.get_user_by_session()を使って、現在のsessionに関連付けられたuserがいるかどうかをチェックするデコレーター。
userがいなければwebapp2.Route(name=’login’)で定義されたログイン画面へ遷移する。もしログイン画面が設定されていなければ、403エラーを表示する。
デコレーターについては Life is beautiful: Python入門:デコレータとは を参照のこと。認証を必要とする処理の前に@user_requiredと記述するだけで、認証を要求できる。

class BaseHandler(webapp2.RequestHandler):
    """
         BaseHandler for all requests
         Holds the auth and session properties so they are reachable for all requests
     """
    def dispatch(self):
        """
              Save the sessions for preservation across requests
          """
        try:
            response = super(BaseHandler, self).dispatch()
            self.response.write(response)
        finally:
            self.session_store.save_sessions(self.response)

    @webapp2.cached_property
    def auth(self):
        return auth.get_auth()

    @webapp2.cached_property
    def session_store(self):
        return sessions.get_store(request=self.request)

    @webapp2.cached_property
    def auth_config(self):
        """
              Dict to hold urls for login/logout
          """
        return {
            'login_url': self.uri_for('login'),
            'logout_url': self.uri_for('logout')
        }

BaseHandlerは全てレスポンスをsessionに保持する。それ以外にも、auth と session へ簡便にアクセスするためのメソッドを定義する。

class LoginHandler(BaseHandler):
    def get(self):
        """
              Returns a simple HTML form for login
          """
        return """
            <!DOCTYPE hml>
            <html>
                <head>
                    <title>webapp2 auth example</title>
                </head>
                <body>
                <form action="%s" method="post">
                    <fieldset>
                        <legend>Login form</legend>
                        <label>Username <input type="text" name="username" placeholder="Your username" /></label>
                        <label>Password <input type="password" name="password" placeholder="Your password" /></label>
                        </fieldset>
                        <button>Login</button>
                 </form>
            </html>
        """ % self.request.url

    def post(self):
        """
              username: Get the username from POST dict
              password: Get the password from POST dict
          """
        username = self.request.POST.get('username')
        password = self.request.POST.get('password')
        # Try to login user with password
        # Raises InvalidAuthIdError if user is not found
        # Raises InvalidPasswordError if provided password doesn't match with specified user
        try:
            self.auth.get_user_by_password(username, password)
            self.redirect('/secure/')
        except (InvalidAuthIdError, InvalidPasswordError), e:
            # Returns error message to self.response.write in the BaseHandler.dispatcher
            # return e
            return """
                Could not login. <a href="/login/">retry</a>
            """

/login/にアクセスしたとき、ログイン画面を表示する。
ログイン画面で入力されたユーザー名とパスワードを auth.get_user_by_password() を使って認証し、エラーがでたらログインできなかったことを表示する。

class CreateUserHandler(BaseHandler):
    def get(self):
        """
              Returns a simple HTML form for create a new user
          """
        return """
            <!DOCTYPE hml>
            <html>
                <head>
                    <title>webapp2 auth example</title>
                </head>
                <body>
                <form action="%s" method="post">
                    <fieldset>
                        <legend>Create user form</legend>
                        <label>Username <input type="text" name="username" placeholder="Your username" /></label>
                        <label>Password <input type="password" name="password" placeholder="Your password" /></label>
                    </fieldset>
                    <button>Create user</button>
                </form>
            </html>
        """ % self.request.url

    def post(self):
        """
              username: Get the username from POST dict
              password: Get the password from POST dict
          """
        username = self.request.POST.get('username')
        password = self.request.POST.get('password')
        # Passing password_raw=password so password will be hashed
        # Returns a tuple, where first value is BOOL. If True ok, If False no new user is created
        user = self.auth.store.user_model.create_user(username, password_raw=password)
        if not user[0]: #user is a tuple
            return user[1] # Error message
        else:
            # User is created, let's try redirecting to login page
            try:
                self.redirect(self.auth_config['login_url'], abort=True)
            except (AttributeError, KeyError), e:
                self.abort(403)

ユーザー追加画面を表示する。
ユーザー追加画面で auth.store.user_model.create_user() を呼び出し、ユーザーを生成できれば、ログイン画面へ遷移する。生成できなければ403エラーを表示する。

class LogoutHandler(BaseHandler):
    """
         Destroy user session and redirect to login
     """

    def get(self):
        self.auth.unset_session()
        # User is logged out, let's try redirecting to login page
        try:
            self.redirect(self.auth_config['login_url'])
        except (AttributeError, KeyError), e:
            return "User is logged out"

/logout/にアクセスしたとき、auth.unset_session() を呼び出し、現在のsessionとユーザーの関連付けを外す。

class SecureRequestHandler(BaseHandler):
    """
         Only accessible to users that are logged in
     """

    @user_required
    def get(self, **kwargs):
        user = self.auth.get_user_by_session()
        try:
            return "Secure zone for %s Logout" % (str(user), self.auth_config['logout_url'])
        except (AttributeError, KeyError), e:
            return "Secure zone"

/secure/にアクセスしたとき、デコレーター user_required() でログイン済みかチェックした後、ログインしているユーザーの情報を表示する。

webapp2_config = {}
webapp2_config['webapp2_extras.sessions'] = {
		'secret_key': 'Set_this_to_something_random_and_unguessable',
	}

app = webapp2.WSGIApplication([
		webapp2.Route(r'/login/', handler=LoginHandler, name='login'),
		webapp2.Route(r'/logout/', handler=LogoutHandler, name='logout'),
		webapp2.Route(r'/secure/', handler=SecureRequestHandler, name='secure'),
		webapp2.Route(r'/create/', handler=CreateUserHandler, name='create-user')
	], debug=True, config=webapp2_config)

sessions の secret_key は推測されないものを指定しなければならない。
/login/ にアクセスしたとき、ログイン画面を表示する。
/logout/ にアクセスしたとき、ユーザーをログアウトさせ、ログイン画面に遷移する。
/secure/ にアクセスしたとき、認証を要求する。
/create/ にアクセスしたとき、ユーザー追加画面を表示する。

Google App Engine Launcher を起動して、localhost:8080/create/ にアクセスしてユーザーを追加。ログイン画面に遷移するのでログイン。その後 localhost:8080/secure/ にアクセスすると、ユーザー情報が表示される。
http://localhost:8083/_ah/admin/ にアクセスして Datastore Viewer を使うと、User が保存されていることを確認できる。

Google App Engine の webapp2 で認証してみた」への1件のフィードバック

  1. ピンバック: webapp2での認証?ユーザー? « なすびのGAE/Python開発日記

コメントを残す

以下に詳細を記入するか、アイコンをクリックしてログインしてください。

WordPress.com ロゴ

WordPress.com アカウントを使ってコメントしています。 ログアウト /  変更 )

Twitter 画像

Twitter アカウントを使ってコメントしています。 ログアウト /  変更 )

Facebook の写真

Facebook アカウントを使ってコメントしています。 ログアウト /  変更 )

%s と連携中