• flask源码解析之session


    flask的session机制

    session是用来干什么的呢?由于http协议是一个无状态的协议,也就是说同一个用户第一次请求和第二次请求是完全没有关系的,但是现在的网站基本上有登录使用的功能,这就要求必须实现有状态,而session机制实现的就是这个功能。

    实现的原理:

    用户第一次请求后,将产生的状态信息保存在session中,这时可以把session当做一个容器,它保存了正在使用的所有用户的状态信息;这段状态信息分配了一个唯一的标识符用来标识用户的身份,将其保存在响应对象的cookie中;当第二次请求时,解析cookie中的标识符,拿到标识符后去session找到对应的用户的信息。

    简单使用

    1.session设置

    Flask除请求对象之外,还有一个 session 对象。

    它允许你在不同请求间存储特定用户的信息。它是在 Cookies 的基础上实现的,并且对 Cookies 进行密钥签名要使用会话,你需要设置一个密钥。

    我们知道,在django中的session是存储在服务器中的数据库中的,也就是django_session表中,而flask中的session是交由客户端保管的,也就是存储在本地的cookie中。

    session的方法:

    • session['username'] = 'ryxiong';设置session

    • session.pop("username",None);删除session

    关于session的设置

    app.session_cookie_name = "I am not Session"

    2.cookies中的session

    cookies 中 session 存储的是通过 secret_key 加密后的 key , 通过这个 key 从flask程序的内存中找到用户对应的session信息

    session序列化机制

    当我们开启session时,设置session["username"]="ryxiong",flask会帮我们创建一个字典{"username":"ryxiong"},然后通过secret_key + 时间戳 + 签名经过加密生成一个字符串。

    session反序列化机制

    当客户端发送请求时,request请求会带上cookie,也就是session中的数据存储在其中,这个数据就是之前加密后的字符串,发送到后端后,flask会通过secret_key去解密session中的加密字符串,从而获取{"username":"ryxiong"}从而来验证是否登录。

    3.session的使用和验证

    from flask import Flask, session, redirect, url_for, escape, request
     
    app = Flask(__name__)
     
    @app.route('/')
    def index():
        if 'username' in session:
            return 'Logged in as %s' % escape(session['username'])
        return 'You are not logged in'
    @app.route("/login", methods=["GET", "POST"])
    
    def login():
        if request.method == "POST":
            if request.form["username"] == USER["username"] and request.form["password"] == USER["password"]:
                session["user"] = USER["username"]
                return redirect("/student_list")
            return render_template("login.html", msg="用户名密码错误")
    
        return render_template("login.html", msg=None)  # 如果前端Jinja2模板中使用了msg,这里就算是传递None也要出现msg
    
    # session的验证
    @app.route("/student_list")
    def student():
        if session.get("user"):
            return render_template("student_list.html", student=STUDENT_DICT)
    
        return redirect("/login")
    example

    在flask中,如果我们想要获取session信息,直接通过flask的session获取就可以了,这是因为session是一个代理对象,代理当前请求上下文的session属性。

    session源码分析

    依据上述session的原理,来分析一下flask框架的session机制实现的过程。

    Flask对象使用open_session方法和save_session方法打开和保存会话信息,请求在创建请求上下文后会调用open_session方法获取用户的信息,在执行完处理逻辑后会调用save_session方法保存用户的信息。

    • open_session和save_session
    def open_session(self, request):
        # 调用了app的session_interface对象的方法
        return self.session_interface.open_session(self, request)
    
    def save_session(self, session, response):
        return self.session_interface.save_session(self, session, response)

    app对象默认的session_interface = SecureCookieSessionInterface(),SecureCookieSessionInterface重写了SessionInterface对象的open_session方法和save_session方法。

    class SecureCookieSessionInterface(SessionInterface):
        pass
    
        def open_session(self, app, request):
            # 检测是否设置了secret_key参数,返回一个签名对象
            s = self.get_signing_serializer(app)
            if s is None:
                return None
            # 去cookie中获取session信息
            val = request.cookies.get(app.session_cookie_name)
            # 如果是第一次请求,返回一个空的SecureCookieSession对象,会被交给请求上下文的session属性管理
            if not val:
                return self.session_class()
            # 获取session的失效时间
            max_age = total_seconds(app.permanent_session_lifetime)
            try:
                # 对session信息进行解码得到用户信息
                data = s.loads(val, max_age=max_age)
                # 返回有用户信息的session对象
                return self.session_class(data)
            except BadSignature:
                return self.session_class()
    
        def save_session(self, app, session, response):
            # 获取cookie设置的域
            domain = self.get_cookie_domain(app)
            # 获取cookie设置的路径
            path = self.get_cookie_path(app)
            ...
    
            # 检测SESSION_REFRESH_EACH_REQUEST参数配置
            if not self.should_set_cookie(app, session):
                return
            # 返回SESSION_COOKIE_HTTPONLY参数配置
            httponly = self.get_cookie_httponly(app)
            # 返回SESSION_COOKIE_SECURE参数配置
            secure = self.get_cookie_secure(app)
            # 返回失效的时间点
            expires = self.get_expiration_time(app, session)
            #将用户的数据加密
            val = self.get_signing_serializer(app).dumps(dict(session))
            # 设置cookie
            response.set_cookie(app.session_cookie_name, val,
                                expires=expires, httponly=httponly,
                                domain=domain, path=path, secure=secure)

    请求上下文RequestContext的session属性是一个SecureCookieSession对象,可以将其看做一个字典;

    小结

    flask默认通过SecureCookieSessionInterface对象管理session,其重写了SessionInterface对象的open_session方法和save_session方法,将用户的数据加密后存储在cookie中。

     

     

    Flask中的session ,自定义实现 session机制, 和 flask-session组件

     

    session 是基于cookie实现, 保存在服务端的键值对(形式为 {随机字符串:‘xxxxxx’}), 同时在浏览器中的cookie中也对应一相同的随机字符串,用来再次请求的 时候验证;

        注意 :Flask中的session是存在浏览器中  默认key是session(加密的cookie), 也可以像Django一样基于上述的方式实现保存在数据库

    1 flask中 session的基本概念

    flask 有一个 session 对象。它允许你在不同请求间存储特定用户的信息。它是在 Cookies 的基础上实现的,并且对 Cookies 进行密钥签名要使用会话,你需要设置一个密钥

        同 reqeust 一样 session 基于上下文管理

    本质是字典,具有字典的操作方法

        设置:session['username'] = 'xxx'
        删除:session.pop('username', None)

    大概流程:

    第一次请求进来 会把session所有的值都放入内存,对session的增删改查的操作都是在内存中进行的;
    
        class SecureCookieSessionInterface(SessionInterface):
    
            open_session --> 打开,获取 app.session_cookie_name获取加密的session(没有的话会创建)
                                          然后进行解密
    
            save_session  --> 对操作完的sesison进行加密 保存

    session的超时时间如何配置:

        app.config['SESSION_COOKIE_NAME'] = ''
    
        'SESSION_COOKIE_NAME':                  'session',    # 默认
        'SESSION_COOKIE_DOMAIN':                None,
        'SESSION_COOKIE_PATH':                  None,
        'SESSION_COOKIE_HTTPONLY':              True,
        'SESSION_COOKIE_SECURE':                False,
        'SESSION_REFRESH_EACH_REQUEST':         True,
        'PERMANENT_SESSION_LIFETIME':           timedelta(days=31),

    2 flask中 session的流程详解



    刚进来创建 request_context 对象(request,初始化session(最开始为空))-->>

    当接收到用户请求之后,会调用 Flask对象的 session_interface对象的open_session方法,以此来获取一个session对象。-->>

    数据返回给用户,并且把内容中的session重新保存-->>

    3 自定义session

    根据内置session原理可以进行session的定制:

        import uuid
        import json
        from flask.sessions import SessionInterface
        from flask.sessions import SessionMixin
        from itsdangerous import Signer, BadSignature, want_bytes
    
        class MySession(dict, SessionMixin):
            def __init__(self, initial=None, sid=None):
                self.sid = sid
                self.initial = initial
                super(MySession, self).__init__(initial or ())
    
            def __setitem__(self, key, value):
                super(MySession, self).__setitem__(key, value)
    
            def __getitem__(self, item):
                return super(MySession, self).__getitem__(item)
    
            def __delitem__(self, key):
                super(MySession, self).__delitem__(key)
        class MySessionInterface(SessionInterface):
            session_class = MySession
            container = {}
    
            def __init__(self):
                import redis
                self.redis = redis.Redis()
    
            def _generate_sid(self):
                return str(uuid.uuid4())
    
            def _get_signer(self, app):
                if not app.secret_key:
                    return None
                return Signer(app.secret_key, salt='flask-session',
                              key_derivation='hmac')
    
            def open_session(self, app, request):
                """
                程序刚启动时执行,需要返回一个session对象
                """
                sid = request.cookies.get(app.session_cookie_name)
                if not sid:
                    sid = self._generate_sid()
                    return self.session_class(sid=sid)
    
                signer = self._get_signer(app)
                try:
                    sid_as_bytes = signer.unsign(sid)
                    sid = sid_as_bytes.decode()
                except BadSignature:
                    sid = self._generate_sid()
                    return self.session_class(sid=sid)
    
                # session保存在redis中
                # val = self.redis.get(sid)
                # session保存在内存中
                val = self.container.get(sid)
    
                if val is not None:
                    try:
                        data = json.loads(val)
                        return self.session_class(data, sid=sid)
                    except:
                        return self.session_class(sid=sid)
                return self.session_class(sid=sid)
    
            def save_session(self, app, session, response):
                """
                程序结束前执行,可以保存session中所有的值
                如:
                    保存到resit
                    写入到用户cookie
                """
                domain = self.get_cookie_domain(app)
                path = self.get_cookie_path(app)
                httponly = self.get_cookie_httponly(app)
                secure = self.get_cookie_secure(app)
                expires = self.get_expiration_time(app, session)
    
                val = json.dumps(dict(session))
    
                # session保存在redis中
                # self.redis.setex(name=session.sid, value=val, time=app.permanent_session_lifetime)
                # session保存在内存中
                self.container.setdefault(session.sid, val)
    
                session_id = self._get_signer(app).sign(want_bytes(session.sid))
    
                response.set_cookie(app.session_cookie_name, session_id,
                                    expires=expires, httponly=httponly,
                                    domain=domain, path=path, secure=secure)
        使用时,需要先新进行配置:
        from flask import Flask
        from flask import session
        from pro_flask.utils.session import MySessionInterface
    
        app = Flask(__name__)
    
        app.secret_key = 'A0Zr98j/3yX R~XHH!jmN]LWX/,?RT'
        app.session_interface = MySessionInterface()
    
    
        @app.route('/login.html', methods=['GET', "POST"])
        def login():
            print(session)
            session['user1'] = 'alex'
            session['user2'] = 'alex'
            del session['user2']
    
            return "内容"
    
    
        if __name__ == '__main__':
            app.run()

    4 flask-session组件

    flask内置session使用签名cookie保存

    flask-session 组件则将支持session保存到多个地方:

    redis:
    memcached
    filesystem
    mongodb
    sqlalchmey:拿数据存到数据库表里面
    
    
    安装
    
    pip3 install flask-session

    redis存储方式

    import redis
    from flask import Flask, session
    from flask_session import Session
    
    app = Flask(__name__)
    app.debug = True
    app.secret_key = 'xxxx'
    
    app.config['SESSION_TYPE'] = 'redis'  # session类型为redis
    app.config['SESSION_PERMANENT'] = False  # 如果设置为True,则关闭浏览器session就失效。
    app.config['SESSION_USE_SIGNER'] = False  # 是否对发送到浏览器上session的cookie值进行加密
    app.config['SESSION_KEY_PREFIX'] = 'session:'  # 保存到session中的值的前缀
    app.config['SESSION_REDIS'] = redis.Redis(host='127.0.0.1', port='6379', password='123123')  # 用于连接redis的配置
    
    Session(app)
    
    
    @app.route('/index')
    def index():
        session['k1'] = 'v1'
        return 'xx'
    
    
    if __name__ == '__main__':
        app.run()

     example2:

    #coding=utf-8
    import os
    from flask import Flask, session, request
    from flask_session import Session
    from redis import Redis
    
    app = Flask(__name__)
    app.config['SESSION_TYPE'] = 'redis'   #session存储格式为redis
    app.config['SESSION_REDIS'] = Redis(    #redis的服务器参数
        host='192.168.1.72',                 #服务器地址
        port=6379)                           #服务器端口
    
    app.config['SESSION_USE_SIGNER'] = True   #是否强制加盐,混淆session
    app.config['SECRET_KEY'] = os.urandom(24)  #如果加盐,那么必须设置的安全码,盐
    app.config['SESSION_PERMANENT'] = False  #sessons是否长期有效,false,则关闭浏览器,session失效
    app.config['PERMANENT_SESSION_LIFETIME'] = 3600   #session长期有效,则设定session生命周期,整数秒,默认大概不到3小时。
    Session(app)
    
    
    @app.route('/')
    def default():
        return session.get('key', 'not set')
    
    @app.route('/test/')
    def test():
        session['key'] = 'test'
        return 'ok'
    
    @app.route('/set/')
    def set():
        arg = request.args.get('key')
        print(arg)
        session['key'] = arg
        return 'ok'
    
    
    @app.route('/get/')
    def get():
        return session.get('key', 'not set')
    
    
    @app.route('/pop/')
    def pop():
        session.pop('key')
        return session.get('key', 'not set')
    
    
    @app.route('/clear/')
    def clear():
        session.clear()
        return session.get('key', 'not set')
    
    
    if __name__ == "__main__":
        app.run(debug=True)

    memcached

    import redis
    from flask import Flask, session
    from flask_session import Session
    import memcache
    
    app = Flask(__name__)
    app.debug = True
    app.secret_key = 'xxxx'
    
    
    app.config['SESSION_TYPE'] = 'memcached' 
    app.config['SESSION_PERMANENT'] = True # 如果设置为True,则关闭浏览器session就失效。
    app.config['SESSION_USE_SIGNER'] = False # 是否对发送到浏览器上session的cookie值进行加密
    app.config['SESSION_KEY_PREFIX'] = 'session:' # 保存到session中的值的前缀
    app.config['SESSION_MEMCACHED'] = memcache.Client(['10.211.55.4:12000'])
    
    
    Session(app)
    
    
    @app.route('/index')
    def index():
        session['k1'] = 'v1'
        return 'xx'
    
    
    if __name__ == '__main__':
        app.run()

    filesystem

    import redis
    from flask import Flask, session
    from flask_session import Session
    
    app = Flask(__name__)
    app.debug = True
    app.secret_key = 'xxxx'
    
    app.config['SESSION_TYPE'] = 'filesystem'  
    app.config[
        'SESSION_FILE_DIR'] = '/Users/wupeiqi/PycharmProjects/grocery/96.Flask新课程/组件/2.flask-session'  # session类型为redis
    app.config['SESSION_FILE_THRESHOLD'] = 500  # 存储session的个数如果大于这个值时,就要开始进行删除了
    app.config['SESSION_FILE_MODE'] = 384  # 文件权限类型
    
    app.config['SESSION_PERMANENT'] = True  # 如果设置为True,则关闭浏览器session就失效。
    app.config['SESSION_USE_SIGNER'] = False  # 是否对发送到浏览器上session的cookie值进行加密
    app.config['SESSION_KEY_PREFIX'] = 'session:'  # 保存到session中的值的前缀
    
    Session(app)
    
    
    @app.route('/index')
    def index():
        session['k1'] = 'v1'
        session['k2'] = 'v1'
        return 'xx'
    
    
    if __name__ == '__main__':
        app.run()

    mongodb

    from flask import Flask, session
    from flask_session import Session
    import pymongo
    
    app = Flask(__name__)
    app.debug = True
    app.secret_key = 'xxxx'
    
    app.config['SESSION_TYPE'] = 'mongodb'  
    
    app.config['SESSION_MONGODB'] = pymongo.MongoClient()
    app.config['SESSION_MONGODB_DB'] = 'mongo的db名称(数据库名称)'
    app.config['SESSION_MONGODB_COLLECT'] = 'mongo的collect名称(表名称)'
    
    app.config['SESSION_PERMANENT'] = True  # 如果设置为True,则关闭浏览器session就失效。
    app.config['SESSION_USE_SIGNER'] = False  # 是否对发送到浏览器上session的cookie值进行加密
    app.config['SESSION_KEY_PREFIX'] = 'session:'  # 保存到session中的值的前缀
    
    Session(app)
    
    
    @app.route('/index')
    def index():
        session['k1'] = 'v1'
        session['k2'] = 'v1'
        return 'xx'
    
    
    if __name__ == '__main__':
        app.run()

    sqlalchemy

    import redis
    from flask import Flask, session
    from flask_session import Session as FSession
    from flask_sqlalchemy import SQLAlchemy
    
    app = Flask(__name__)
    app.debug = True
    app.secret_key = 'xxxx'
    
    # 设置数据库链接
    app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql+pymysql://root:123@127.0.0.1:3306/fssa?charset=utf8'
    app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True
    
    # 实例化SQLAlchemy
    db = SQLAlchemy(app)
    
    app.config['SESSION_TYPE'] = 'sqlalchemy'  # session类型为sqlalchemy
    app.config['SESSION_SQLALCHEMY'] = db # SQLAlchemy对象
    app.config['SESSION_SQLALCHEMY_TABLE'] = 'session' # session要保存的表名称
    app.config['SESSION_PERMANENT'] = True  # 如果设置为True,则关闭浏览器session就失效。
    app.config['SESSION_USE_SIGNER'] = False  # 是否对发送到浏览器上session的cookie值进行加密
    app.config['SESSION_KEY_PREFIX'] = 'session:'  # 保存到session中的值的前缀
    FSession(app)
    
    
    @app.route('/index')
    def index():
    
        session['k1'] = 'v1'
        session['k2'] = 'v1'
    
        return 'xx'
    
    
    if __name__ == '__main__':
        app.run()
        应用程序比较小,用原生的加密ccokie 保存session(内置)
        应用程序比较大,可以用redis(flask-session)

    原生session组件的扩展---flaks_session组件

     
    from flask import Flask,session
    
    
    app = Flask(__name__)
    app.secret_key = 'suijksdfsd'
    
    # 方式一:
    from redis import Redis
    from flask_session import RedisSessionInterface
    conn = Redis()
    app.session_interface = RedisSessionInterface(conn,key_prefix='__',use_signer=False,permanent=True)
    
    
    # 方式二:
    # from redis import Redis
    # from flask.ext.session import Session
    # app.config['SESSION_TYPE'] = 'redis'
    # app.config['SESSION_REDIS'] = Redis(host='192.168.0.94',port='6379')
    # Session(app)
    
    
    
    @app.route('/')
    def index():
        session['xxx'] = 123
        return 'Index'
    
    
    if __name__ == '__main__':
    
        app.run()
     
     

    这是 flask 源码解析系列文章的其中一篇,本系列所有文章列表:

    session 简介

    在解析 session 的实现之前,我们先介绍一下 session 怎么使用。session 可以看做是在不同的请求之间保存数据的方法,因为 HTTP 是无状态的协议,但是在业务应用上我们希望知道不同请求是否是同一个人发起的。比如购物网站在用户点击进入购物车的时候,服务器需要知道是哪个用户执行了这个操作。

    在 flask 中使用 session 也很简单,只要使用 from flask import session 导入这个变量,在代码中就能直接通过读写它和 session 交互。

    from flask import Flask, session, escape, request
    
    app = Flask(__name__)
    app.secret_key = 'please-generate-a-random-secret_key'
    
    
    @app.route("/")
    def index():
        if 'username' in session:
            return 'hello, {}
    '.format(escape(session['username']))
        return 'hello, stranger
    '
    
    
    @app.route("/login", methods=['POST'])
    def login():
        session['username'] = request.form['username']
        return 'login success'
    
    
    if __name__ == '__main__':
        app.run(host='0.0.0.0', port=5000, debug=True)

    上面这段代码模拟了一个非常简单的登陆逻辑,用户访问 POST /login 来登陆,后面访问页面的时候 GET /,会返回该用户的名字。我们看一下具体的操作实例(下面的操作都是用 httpie 来执行的,使用 curl 命令也能达到相同的效果):

    直接访问的话,我们可以看到返回 hello stranger

    ➜  ~ http -v http://127.0.0.1:5000/
    GET / HTTP/1.1
    Accept: */*
    Accept-Encoding: gzip, deflate
    Host: 127.0.0.1:5000
    User-Agent: HTTPie/0.8.0
    
    
    HTTP/1.0 200 OK
    Content-Length: 14
    Content-Type: text/html; charset=utf-8
    Date: Wed, 01 Mar 2017 04:22:18 GMT
    Server: Werkzeug/0.11.2 Python/2.7.10
    
    hello stranger

    然后我们模拟登陆请求,-v 是打印出请求,-f 是告诉服务器这是表单数据,--session=mysession 是把请求的 cookie 等信息保存到这个变量中,后面可以通过变量来指定 session:

    ➜  ~ http -v -f --session=mysession POST http://127.0.0.1:5000/login username=cizixs
    POST /login HTTP/1.1
    Accept: */*
    Accept-Encoding: gzip, deflate
    Content-Length: 15
    Content-Type: application/x-www-form-urlencoded; charset=utf-8
    Host: 127.0.0.1:5000
    User-Agent: HTTPie/0.8.0
    
    username=cizixs
    
    HTTP/1.0 200 OK
    Content-Length: 13
    Content-Type: text/html; charset=utf-8
    Date: Wed, 01 Mar 2017 04:20:54 GMT
    Server: Werkzeug/0.11.2 Python/2.7.10
    Set-Cookie: session=eyJ1c2VybmFtZSI6ImNpeml4cyJ9.C5fdpg.fqm3FTv0kYE2TuOyGF1mx2RuYQ4; HttpOnly; Path=/
    
    login success

    最重要的是我们看到 response 中有 Set-Cookie 的头部,cookie 的键是 session,值是一堆看起来随机的字符串。

    继续,这个时候我们用 --session=mysession 参数把这次的请求带上保存在 mysession 中的信息,登陆后访问,可以看到登陆的用户名:

    ➜  ~ http -v --session=mysession http://127.0.0.1:5000/
    GET / HTTP/1.1
    Accept: */*
    Accept-Encoding: gzip, deflate
    Cookie: session=eyJ1c2VybmFtZSI6ImNpeml4cyJ9.C5fevg.LE03yEZDWTUMQW-nNkTr1zBEhKk
    Host: 127.0.0.1:5000
    User-Agent: HTTPie/0.8.0
    
    
    HTTP/1.0 200 OK
    Content-Length: 11
    Content-Type: text/html; charset=utf-8
    Date: Wed, 01 Mar 2017 04:25:46 GMT
    Server: Werkzeug/0.11.2 Python/2.7.10
    Set-Cookie: session=eyJ1c2VybmFtZSI6ImNpeml4cyJ9.C5feyg.sfFCDIqfef4i8cvxUClUUGQNcHA; HttpOnly; Path=/
    
    hellocizixs

    这次注意在发送的请求中,客户端带了 Cookie 头部,上面的值保存了前一个请求的 response 给我们设置的值。

    总结一下:session 是通过在客户端设置 cookie 实现的,每次客户端发送请求的时候会附带着所有的 cookie,而里面保存着一些重要的信息(比如这里的用户信息),这样服务器端就能知道客户端的信息,然后根据这些数据做出对应的判断,就好像不同请求之间是有记忆的。

    解析

    我们知道 session 是怎么回事了,这部分就分析一下 flask 是怎么实现它的。

    请求过程

    不难想象,session 的大致解析过程是这样的:

    • 请求过来的时候,flask 会根据 cookie 信息创建出 session 变量(如果 cookie 不存在,这个变量有可能为空),保存在该请求的上下文中

    • 视图函数可以获取 session 中的信息,实现自己的逻辑处理

    • flask 会在发送 response 的时候,根据 session 的值,把它写回到 cookie 中

    注意:session 和 cookie 的转化过程中,应该考虑到安全性,不然直接使用伪造的 cookie 会是个很大的安全隐患。

     flask 上下文那篇文章中,我们知道,每次请求过来的时候,我们访问的 request 和 session 变量都是 RequestContext 实例的变量。在 RequestContext.Push() 方法的最后有这么一段代码:

    self.session = self.app.open_session(self.request)
    if self.session is None:
        self.session = self.app.make_null_session()

    它初始化了 session 变量,保存在 RequestContext 上,这样后面就能直接通过 from flask import session 来使用它。如果没有设置 secret_key 变量, open_session 就会返回 None,这个时候会调用 make_null_session 来生成一个空的 session,这个特殊的 session 不能进行任何读写操作,不然会报异常给用户。

    我们来看看 open_session 方法:

    def open_session(self, request):
        return self.session_interface.open_session(self, request)

    在 Flask 中,所有和 session 有关的调用,都是转发到 self.session_interface 的方法调用上(这样用户就能用自定义的 session_interface 来控制 session 的使用)。而默认的 session_inerface 有默认值:

    session_interface = SecureCookieSessionInterface()

    后面遇到 session 有关方法解释,我们会直接讲解 SecureCookieSessionInterface 的代码实现,跳过中间的这个转发说明。

    null_session_class = NullSession
    
    def make_null_session(self, app):
        return self.null_session_class()
    
    def open_session(self, app, request):
        # 获取 session 签名的算法
        s = self.get_signing_serializer(app)
        if s is None:
            return None
    
        # 从 cookie 中获取 session 变量的值
        val = request.cookies.get(app.session_cookie_name)
        if not val:
            return self.session_class()
    
        # 因为 cookie 的数据需要验证是否有篡改,所以需要签名算法来读取里面的值
        max_age = total_seconds(app.permanent_session_lifetime)
        try:
            data = s.loads(val, max_age=max_age)
            return self.session_class(data)
        except BadSignature:
            return self.session_class()

    open_session 根据请求中的 cookie 来获取对应的 session 对象。之所以有 app 参数,是因为根据 app 中的安全设置(比如签名算法、secret_key)对 cookie 进行验证。

    这里有两点需要特殊说明的:签名算法是怎么工作的?session 对象到底是怎么定义的?

    session 对象

    默认的 session 对象是 SecureCookieSession,这个类就是一个基本的字典,外加一些特殊的属性,比如 permanent(flask 插件会用到这个变量)、modified(表明实例是否被更新过,如果更新过就要重新计算并设置 cookie,因为计算过程比较贵,所以如果对象没有被修改,就直接跳过)。

    class SessionMixin(object):
        def _get_permanent(self):
            return self.get('_permanent', False)
    
        def _set_permanent(self, value):
            self['_permanent'] = bool(value)
    
        #: this reflects the ``'_permanent'`` key in the dict.
        permanent = property(_get_permanent, _set_permanent)
        del _get_permanent, _set_permanent
    
        modified = True
    
    class SecureCookieSession(CallbackDict, SessionMixin):
        """Base class for sessions based on signed cookies."""
    
        def __init__(self, initial=None):
            def on_update(self):
                self.modified = True
            CallbackDict.__init__(self, initial, on_update)
            self.modified = False

    怎么知道实例的数据被更新过呢? SecureCookieSession 是基于 werkzeug/datastructures:CallbackDict 实现的,这个类可以指定一个函数作为 on_update 参数,每次有字典操作的时候(__setitem____delitem__clearpopitemupdatepopsetdefault)会调用这个函数。

    NOTECallbackDict 的实现很巧妙,但是并不复杂,感兴趣的可以自己参考代码。主要思路就是重载字典的一些更新操作,让它们在做原来事情的同时,额外调用一下实现保存的某个函数。

    对于开发者来说,可以把 session 简单地看成字典,所有的操作都是和字典一致的。

    签名算法

    都获取 cookie 数据的过程中,最核心的几句话是:

    s = self.get_signing_serializer(app)
    val = request.cookies.get(app.session_cookie_name)
    data = s.loads(val, max_age=max_age)
    
    return self.session_class(data)

    其中两句都和 s 有关,signing_serializer 保证了 cookie 和 session 的转换过程中的安全问题。如果 flask 发现请求的 cookie 被篡改了,它会直接放弃使用。

    我们继续看 get_signing_serializer 方法:

    def get_signing_serializer(self, app):
        if not app.secret_key:
            return None
        signer_kwargs = dict(
            key_derivation=self.key_derivation,
            digest_method=self.digest_method
        )
        return URLSafeTimedSerializer(app.secret_key,
            salt=self.salt,
            serializer=self.serializer,
            signer_kwargs=signer_kwargs)

    我们看到这里需要用到很多参数:

    • secret_key:密钥。这个是必须的,如果没有配置 secret_key 就直接使用 session 会报错

    • salt:为了增强安全性而设置一个 salt 字符串(可以自行搜索“安全加盐”了解对应的原理)

    • serializer:序列算法

    • signer_kwargs:其他参数,包括摘要/hash算法(默认是 sha1)和 签名算法(默认是 hmac

    URLSafeTimedSerializer 是 itsdangerous 库的类,主要用来进行数据验证,增加网络中数据的安全性。itsdangerours 提供了多种 Serializer,可以方便地进行类似 json 处理的数据序列化和反序列的操作。至于具体的实现,因为篇幅限制,就不解释了。

    应答过程

    flask 会在请求过来的时候自动解析 cookie 的值,把它变成 session 变量。开发在视图函数中可以使用它的值,也可以对它进行更新。最后再返回的 response 中,flask 也会自动把 session 写回到 cookie。我们来看看这部分是怎么实现的!

    之前的文章讲解了应答的过程,其中 finalize_response 方法在根据视图函数的返回生成 response 对象之后,会调用 process_response 方法进行处理。process_response 方法的最后有这样两句话:

    def process_response(self, response):
        ...
        if not self.session_interface.is_null_session(ctx.session):
            self.save_session(ctx.session, response)
        return response

    这里就是 session 在应答中出现的地方,思路也很简单,如果需要就调用 save_sessoin,把当前上下文中的 session 对象保存到 response 。

    save_session 的代码和 open_session 对应:

    def save_session(self, app, session, response):
            domain = self.get_cookie_domain(app)
            path = self.get_cookie_path(app)
    
            # 如果 session 变成了空字典,flask 会直接删除对应的 cookie
            if not session:
                if session.modified:
                    response.delete_cookie(app.session_cookie_name,
                                           domain=domain, path=path)
                return
    
            # 是否需要设置 cookie。如果 session 发生了变化,就一定要更新 cookie,否则用户可以 `SESSION_REFRESH_EACH_REQUEST` 变量控制是否要设置 cookie
            if not self.should_set_cookie(app, session):
                return
    
            httponly = self.get_cookie_httponly(app)
            secure = self.get_cookie_secure(app)
            expires = self.get_expiration_time(app, session)
            val = self.get_signing_serializer(app).dumps(dict(session))
            response.set_cookie(app.session_cookie_name, val,
                                expires=expires,
                                httponly=httponly,
                                domain=domain, path=path, secure=secure)

    这段代码也很容易理解,就是从 app 和 session 变量中获取所有需要的信息,然后调用 response.set_cookie 设置最后的 cookie。这样客户端就能在 cookie 中保存 session 有关的信息,以后访问的时候再次发送给服务器端,以此来实现有状态的交互。

    解密 session

    有时候在开发或者调试的过程中,需要了解 cookie 中保存的到底是什么值,可以通过手动解析它的值。session 在 cookie 中的值,是一个字符串,由句号分割成三个部分。第一部分是 base64 加密的数据,第二部分是时间戳,第三部分是校验信息。

    前面两部分的内容可以通过下面的方式获取,代码也可直观,就不给出解释了:

     
    In [1]: from itsdangerous import *
    
    In [2]: s = 'eyJ1c2VybmFtZSI6ImNpeml4cyJ9.C5fdpg.fqm3FTv0kYE2TuOyGF1mx2RuYQ4'
    
    In [3]: data, timstamp, secret = s.split('.')
    
    In [4]: base64_decode(data)
    Out[4]: '{"username":"cizixs"}'
    
    In [5]: bytes_to_int(base64_decode(timstamp))
    Out[5]: 194502054
    
    In [7]: time.strftime('%Y-%m-%d %H:%I%S', time.localtime(194502054+EPOCH))
    Out[7]: '2017-03-01 12:1254'

    总结

    flask 默认提供的 session 功能还是很简单的,满足了基本的功能。但是我们看到 flask 把 session 的数据都保存在客户端的 cookie 中,这里只有用户名还好,如果有一些私密的数据(比如密码,账户余额等等),就会造成严重的安全问题。可以考虑使用 flask-session 这个三方的库,它把数据保存在服务器端(本地文件、redis、memcached),客户端只拿到一个 sessionid。

    session 主要是用来在不同的请求之间保存信息,最常见的应用就是登陆功能。虽然直接通过 session 自己也可以写出来不错的登陆功能,但是在实际的项目中可以考虑 flask-login 这个三方的插件,方便我们的开发

    参考资料

  • 相关阅读:
    Node.js 究竟是什么?
    天津自考学习之“六步看书法”
    C专家编程cdecl
    Linux系统启动流程及安装命令行版本
    Java学习路线
    GCC内置宏
    GMP
    二级存储构建倒排索引
    余弦距离与欧式距离
    af
  • 原文地址:https://www.cnblogs.com/leijiangtao/p/8708647.html
Copyright © 2020-2023  润新知