Day 10 - 用户注册和登录

用户管理是绝大部分Web网站都需要解决的问题。用户管理涉及到用户注册和登录。

用户注册相对简单，我们可以先通过API把用户注册这个功能实现了：

  1. _RE_EMAIL = re.compile(r'^[a-z0-9\.\-\_]+\@[a-z0-9\-\_]+(\.[a-z0-9\-\_]+){1,4}$')
  2. _RE_SHA1 = re.compile(r'^[0-9a-f]{40}$')
  4. @post('/api/users')
  5. def api_register_user(*, email, name, passwd):
  6.     if not name or not name.strip():
  7.         raise APIValueError('name')
  8.     if not email or not _RE_EMAIL.match(email):
  9.         raise APIValueError('email')
  10.     if not passwd or not _RE_SHA1.match(passwd):
  11.         raise APIValueError('passwd')
  12.     users = yield from User.findAll('email=?', [email])
  13.     if len(users) > 0:
  14.         raise APIError('register:failed', 'email', 'Email is already in use.')
  15.     uid = next_id()
  16.     sha1_passwd = '%s:%s' % (uid, passwd)
  17.     user = User(id=uid, name=name.strip(), email=email, passwd=hashlib.sha1(sha1_passwd.encode('utf-8')).hexdigest(), image='http://www.gravatar.com/avatar/%s?d=mm&s=120' % hashlib.md5(email.encode('utf-8')).hexdigest())
  18.     yield from user.save()
  19.     # make session cookie:
  20.     r = web.Response()
  21.     r.set_cookie(COOKIE_NAME, user2cookie(user, 86400), max_age=86400, httponly=True)
  22.     user.passwd = '******'
  23.     r.content_type = 'application/json'
  24.     r.body = json.dumps(user, ensure_ascii=False).encode('utf-8')
  25.     return r

注意用户口令是客户端传递的经过SHA1计算后的40位Hash字符串，所以服务器端并不知道用户的原始口令。

接下来可以创建一个注册页面，让用户填写注册表单，然后，提交数据到注册用户的API：

  1. {% extends '__base__.html' %}
  3. {% block title %}注册{% endblock %}
  5. {% block beforehead %}
  7. <script>
  8. function validateEmail(email) {
  9.     var re = /^[a-z0-9\.\-\_]+\@[a-z0-9\-\_]+(\.[a-z0-9\-\_]+){1,4}$/;
  10.     return re.test(email.toLowerCase());
  11. }
  12. $(function () {
  13.     var vm = new Vue({
  14.         el: '#vm',
  15.         data: {
  16.             name: '',
  17.             email: '',
  18.             password1: '',
  19.             password2: ''
  20.         },
  21.         methods: {
  22.             submit: function (event) {
  23.                 event.preventDefault();
  24.                 var $form = $('#vm');
  25.                 if (! this.name.trim()) {
  26.                     return $form.showFormError('请输入名字');
  27.                 }
  28.                 if (! validateEmail(this.email.trim().toLowerCase())) {
  29.                     return $form.showFormError('请输入正确的Email地址');
  30.                 }
  31.                 if (this.password1.length < 6) {
  32.                     return $form.showFormError('口令长度至少为6个字符');
  33.                 }
  34.                 if (this.password1 !== this.password2) {
  35.                     return $form.showFormError('两次输入的口令不一致');
  36.                 }
  37.                 var email = this.email.trim().toLowerCase();
  38.                 $form.postJSON('/api/users', {
  39.                     name: this.name.trim(),
  40.                     email: email,
  41.                     passwd: CryptoJS.SHA1(email + ':' + this.password1).toString()
  42.                 }, function (err, r) {
  43.                     if (err) {
  44.                         return $form.showFormError(err);
  45.                     }
  46.                     return location.assign('/');
  47.                 });
  48.             }
  49.         }
  50.     });
  51.     $('#vm').show();
  52. });
  53. </script>
  55. {% endblock %}
  57. {% block content %}
  59.     <div class="uk-width-2-3">
  60.         <h1>欢迎注册！</h1>
  61.         <form id="vm" v-on="submit: submit" class="uk-form uk-form-stacked">
  62.             <div class="uk-alert uk-alert-danger uk-hidden"></div>
  63.             <div class="uk-form-row">
  64.                 <label class="uk-form-label">名字:</label>
  65.                 <div class="uk-form-controls">
  66.                     <input v-model="name" type="text" maxlength="50" placeholder="名字" class="uk-width-1-1">
  67.                 </div>
  68.             </div>
  69.             <div class="uk-form-row">
  70.                 <label class="uk-form-label">电子邮件:</label>
  71.                 <div class="uk-form-controls">
  72.                     <input v-model="email" type="text" maxlength="50" placeholder="your-name@example.com" class="uk-width-1-1">
  73.                 </div>
  74.             </div>
  75.             <div class="uk-form-row">
  76.                 <label class="uk-form-label">输入口令:</label>
  77.                 <div class="uk-form-controls">
  78.                     <input v-model="password1" type="password" maxlength="50" placeholder="输入口令" class="uk-width-1-1">
  79.                 </div>
  80.             </div>
  81.             <div class="uk-form-row">
  82.                 <label class="uk-form-label">重复口令:</label>
  83.                 <div class="uk-form-controls">
  84.                     <input v-model="password2" type="password" maxlength="50" placeholder="重复口令" class="uk-width-1-1">
  85.                 </div>
  86.             </div>
  87.             <div class="uk-form-row">
  88.                 <button type="submit" class="uk-button uk-button-primary"><i class="uk-icon-user"></i> 注册</button>
  89.             </div>
  90.         </form>
  91.     </div>
  93. {% endblock %}

这样我们就把用户注册的功能完成了：

awesomepy-register

用户登录比用户注册复杂。由于HTTP协议是一种无状态协议，而服务器要跟踪用户状态，就只能通过cookie实现。大多数Web框架提供了Session功能来封装保存用户状态的cookie。

Session的优点是简单易用，可以直接从Session中取出用户登录信息。

Session的缺点是服务器需要在内存中维护一个映射表来存储用户登录信息，如果有两台以上服务器，就需要对Session做集群，因此，使用Session的Web App很难扩展。

我们采用直接读取cookie的方式来验证用户登录，每次用户访问任意URL，都会对cookie进行验证，这种方式的好处是保证服务器处理任意的URL都是无状态的，可以扩展到多台服务器。

由于登录成功后是由服务器生成一个cookie发送给浏览器，所以，要保证这个cookie不会被客户端伪造出来。

实现防伪造cookie的关键是通过一个单向算法（例如SHA1），举例如下：

当用户输入了正确的口令登录成功后，服务器可以从数据库取到用户的id，并按照如下方式计算出一个字符串：

  1. "用户id" + "过期时间" + SHA1("用户id" + "用户口令" + "过期时间" + "SecretKey")

当浏览器发送cookie到服务器端后，服务器可以拿到的信息包括：

  • 用户id

  • 过期时间

  • SHA1值

如果未到过期时间，服务器就根据用户id查找用户口令，并计算：

  1. SHA1("用户id" + "用户口令" + "过期时间" + "SecretKey")

并与浏览器cookie中的MD5进行比较，如果相等，则说明用户已登录，否则，cookie就是伪造的。

这个算法的关键在于SHA1是一种单向算法，即可以通过原始字符串计算出SHA1结果，但无法通过SHA1结果反推出原始字符串。

所以登录API可以实现如下：

  1. @post('/api/authenticate')
  2. def authenticate(*, email, passwd):
  3.     if not email:
  4.         raise APIValueError('email', 'Invalid email.')
  5.     if not passwd:
  6.         raise APIValueError('passwd', 'Invalid password.')
  7.     users = yield from User.findAll('email=?', [email])
  8.     if len(users) == 0:
  9.         raise APIValueError('email', 'Email not exist.')
  10.     user = users[0]
  11.     # check passwd:
  12.     sha1 = hashlib.sha1()
  13.     sha1.update(user.id.encode('utf-8'))
  14.     sha1.update(b':')
  15.     sha1.update(passwd.encode('utf-8'))
  16.     if user.passwd != sha1.hexdigest():
  17.         raise APIValueError('passwd', 'Invalid password.')
  18.     # authenticate ok, set cookie:
  19.     r = web.Response()
  20.     r.set_cookie(COOKIE_NAME, user2cookie(user, 86400), max_age=86400, httponly=True)
  21.     user.passwd = '******'
  22.     r.content_type = 'application/json'
  23.     r.body = json.dumps(user, ensure_ascii=False).encode('utf-8')
  24.     return r
  26. # 计算加密cookie:
  27. def user2cookie(user, max_age):
  28.     # build cookie string by: id-expires-sha1
  29.     expires = str(int(time.time() + max_age))
  30.     s = '%s-%s-%s-%s' % (user.id, user.passwd, expires, _COOKIE_KEY)
  31.     L = [user.id, expires, hashlib.sha1(s.encode('utf-8')).hexdigest()]
  32.     return '-'.join(L)

对于每个URL处理函数，如果我们都去写解析cookie的代码，那会导致代码重复很多次。

利用middle在处理URL之前，把cookie解析出来，并将登录用户绑定到request对象上，这样，后续的URL处理函数就可以直接拿到登录用户：

  1. @asyncio.coroutine
  2. def auth_factory(app, handler):
  3.     @asyncio.coroutine
  4.     def auth(request):
  5.         logging.info('check user: %s %s' % (request.method, request.path))
  6.         request.__user__ = None
  7.         cookie_str = request.cookies.get(COOKIE_NAME)
  8.         if cookie_str:
  9.             user = yield from cookie2user(cookie_str)
  10.             if user:
  11.                 logging.info('set current user: %s' % user.email)
  12.                 request.__user__ = user
  13.         return (yield from handler(request))
  14.     return auth
  16. # 解密cookie:
  17. @asyncio.coroutine
  18. def cookie2user(cookie_str):
  19.     '''
  20.     Parse cookie and load user if cookie is valid.
  21.     '''
  22.     if not cookie_str:
  23.         return None
  24.     try:
  25.         L = cookie_str.split('-')
  26.         if len(L) != 3:
  27.             return None
  28.         uid, expires, sha1 = L
  29.         if int(expires) < time.time():
  30.             return None
  31.         user = yield from User.find(uid)
  32.         if user is None:
  33.             return None
  34.         s = '%s-%s-%s-%s' % (uid, user.passwd, expires, _COOKIE_KEY)
  35.         if sha1 != hashlib.sha1(s.encode('utf-8')).hexdigest():
  36.             logging.info('invalid sha1')
  37.             return None
  38.         user.passwd = '******'
  39.         return user
  40.     except Exception as e:
  41.         logging.exception(e)
  42.         return None

这样，我们就完成了用户注册和登录的功能。

参考源码

day-10

原文: https://wizardforcel.gitbooks.io/liaoxuefeng/content/py3/116.html