注册页面
用户管理是绝大部分Web网站都需要解决的问题。用户管理涉及到用户注册和登录。用户注册相对简单,我们可以先通过API把用户注册这个功能实现了:
## 用户注册API
@post('/api/users')
async def api_register_user(*, email, name, passwd):
if not name or not name.strip():
raise APIValueError('name')
if not email or not _RE_EMAIL.match(email):
raise APIValueError('email')
if not passwd or not _RE_SHA1.match(passwd):
raise APIValueError('passwd')
users = await User.findAll('email=?', [email])
if len(users) > 0:
raise APIError('register:failed', 'email', 'Email is already in use.')
uid = next_id()
sha1_passwd = '%s:%s' % (uid, passwd)
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())
await user.save()
# make session cookie:
r = web.Response()
r.set_cookie(COOKIE_NAME, user2cookie(user, 86400), max_age=86400, httponly=True)
user.passwd = '******'
r.content_type = 'application/json'
r.body = json.dumps(user, ensure_ascii=False).encode('utf-8')
return r
注意用户口令是客户端传递的经过SHA1计算后的40位Hash字符串,所以服务器端并不知道用户的原始口令。有了父模板,有了用户注册和登录验证的API,构建注册和登录页面就十分容易了。首先我们来构建用户注册页面register.html(在路径www/templates下):
<!-- 继承父模板 '__base__.html' -->
{% extends '__base__.html' %}
<!--jinja2 title 块内容替换-->
{% block title %}Register/注册{% endblock %}
<!--jinja2 beforehead 块内容替换-->
{% block beforehead %}
<!--script中构建vue,向后端API提交合格的注册信息数据-->
<script>
function validateEmail(email) {
var re = /^[a-z0-9\.\-\_]+\@[a-z0-9\-\_]+(\.[a-z0-9\-\_]+){1,4}$/;
return re.test(email.toLowerCase());
}
$(function () {
var vm = new Vue({
el: '#vm',
data: {
name: '',
email: '',
password1: '',
password2: ''
},
methods: {
submit: function (event) {
event.preventDefault();
var $form = $('#vm');
if (! this.name.trim()) {
return $form.showFormError('NAME/请输入名字');
}
if (! validateEmail(this.email.trim().toLowerCase())) {
return $form.showFormError('CORRECT EMAIL/请输入正确的Email地址');
}
if (this.password1.length < 6) {
return $form.showFormError('PASSWORD AT LEAST 6 CHAR/口令长度至少为6个字符');
}
if (this.password1 !== this.password2) {
return $form.showFormError('PASSWORD INCONSIST/两次输入的口令不一致');
}
var email = this.email.trim().toLowerCase();
$form.postJSON('/api/users', {
name: this.name.trim(),
email: email,
passwd: CryptoJS.SHA1(email + ':' + this.password1).toString()
}, function (err, r) {
if (err) {
return $form.showFormError(err);
}
return location.assign('/');
});
}
}
});
$('#vm').show();
});
</script>
{% endblock %}
<!--jinja2 content 块内容替换,构建注册页面UI主要内容-->
{% block content %}
<div class="uk-grid">
<div class="uk-width-1-1">
<h4>REGISTER/欢迎注册!</h4>
<form id="vm" v-on="submit: submit" class="uk-form-stacked">
<div class="uk-alert uk-alert-danger uk-hidden"></div>
<div class="uk-margin-top">
<label class="uk-form-label">NAME/名字:</label>
<div class="uk-form-controls">
<input class="uk-input uk-form-width-medium" v-model="name" type="text" maxlength="50" placeholder="名字">
</div>
</div>
<div class="uk-margin-top">
<label class="uk-form-label">EMAIL/电子邮件:</label>
<div class="uk-form-controls">
<input class="uk-input uk-form-width-medium" v-model="email" type="text" maxlength="50" placeholder="your-name@example.com">
</div>
</div>
<div class="uk-margin-top">
<label class="uk-form-label">PASSWORD/输入口令:</label>
<div class="uk-form-controls">
<input class="uk-input uk-form-width-medium" v-model="password1" type="password" maxlength="50" placeholder="输入口令">
</div>
</div>
<div class="uk-margin">
<label class="uk-form-label">REPEAT PASSWORD/重复口令:</label>
<div class="uk-form-controls">
<input class="uk-input uk-form-width-medium" v-model="password2" type="password" maxlength="50" placeholder="重复口令">
</div>
</div>
<div class="uk-margin-large">
<button type="submit" class="uk-button uk-button-primary"><i class="uk-icon-user"></i>REGISTER/注册</button>
</div>
</form>
</div>
</div>
{% endblock %}
用户登录比用户注册复杂。由于HTTP协议是一种无状态协议,而服务器要跟踪用户状态,就只能通过cookie实现。大多数Web框架提供了Session功能来封装保存用户状态的cookie。
Session的优点是简单易用,可以直接从Session中取出用户登录信息。
Session的缺点是服务器需要在内存中维护一个映射表来存储用户登录信息,如果有两台以上服务器,就需要对Session做集群,因此,使用Session的Web App很难扩展。
我们采用直接读取cookie的方式来验证用户登录,每次用户访问任意URL,都会对cookie进行验证,这种方式的好处是保证服务器处理任意的URL都是无状态的,可以扩展到多台服务器。
由于登录成功后是由服务器生成一个cookie发送给浏览器,所以,要保证这个cookie不会被客户端伪造出来。
实现防伪造cookie的关键是通过一个单向算法(例如SHA1),举例如下:
当用户输入了正确的口令登录成功后,服务器可以从数据库取到用户的id,并按照如下方式计算出一个字符串:
“用户id” + “过期时间” + SHA1(“用户id” + “用户口令” + “过期时间” + “SecretKey”)
当浏览器发送cookie到服务器端后,服务器可以拿到的信息包括:
用户id
过期时间
SHA1值
如果未到过期时间,服务器就根据用户id查找用户口令,并计算:
SHA1(“用户id” + “用户口令” + “过期时间” + “SecretKey”)
并与浏览器cookie中的哈希进行比较,如果相等,则说明用户已登录,否则,cookie就是伪造的。
这个算法的关键在于SHA1是一种单向算法,即可以通过原始字符串计算出SHA1结果,但无法通过SHA1结果反推出原始字符串。
所以登录API可以实现如下:
# 用户登录验证API
@post('/api/authenticate')
async def authenticate(*, email, passwd):
if not email:
raise APIValueError('email', 'Invalid email.')
if not passwd:
raise APIValueError('passwd', 'Invalid password.')
users = await User.findAll('email=?', [email])
if len(users) == 0:
raise APIValueError('email', 'Email not exist.')
user = users[0]
# check passwd:
sha1 = hashlib.sha1()
sha1.update(user.id.encode('utf-8'))
sha1.update(b':')
sha1.update(passwd.encode('utf-8'))
if user.passwd != sha1.hexdigest():
raise APIValueError('passwd', 'Invalid password.')
# authenticate ok, set cookie:
r = web.Response()
r.set_cookie(COOKIE_NAME, user2cookie(user, 86400), max_age=86400, httponly=True)
user.passwd = '******'
r.content_type = 'application/json'
r.body = json.dumps(user, ensure_ascii=False).encode('utf-8')
return r
根据api编写登录页面更为简单,在www/templates下编写signin.html:
<!-- 继承父模板 '__base__.html' -->
{% extends '__base__.html' %}
<!--jinja2 title 块内容替换-->
{% block title %}Signin/登陆{% endblock %}
<!--jinja2 beforehead 块内容替换-->
{% block beforehead %}
<!--script中构建vue,向后端API提交登录验证信息数据-->
<script>
$(function() {
var vmAuth = new Vue({
el: '#vm',
data: {
email: '',
passwd: ''
},
methods: {
submit: function(event) {
event.preventDefault();
var $form = $('#vm');
var email = this.email.trim().toLowerCase();
var data = {
email: email,
passwd: this.passwd==='' ? '' : CryptoJS.SHA1(email + ':' + this.passwd).toString()
};
$form.postJSON('/api/authenticate', data, function(err, result) {
if (! err) {
location.assign('/');
}
});
}
}
});
$('#vm').show();
});
</script>
{% endblock %}
<!--jinja2 content 块内容替换,构建登录页面UI主要内容-->
{% block content %}
<div class="uk-grid">
<div class="uk-width-1-1">
<h4>SIGNIN/欢迎登陆!</h4>
<form id="vm" v-on="submit: submit" class="uk-form-stacked">
<div class="uk-alert uk-alert-danger uk-hidden"></div>
<div class="uk-margin-top">
<label class="uk-form-label">EMAIL/电子邮箱:</label>
<div class="uk-inline">
<span class="uk-form-icon" uk-icon="user"></span>
<input class="uk-input uk-form-width-medium" v-model="email" type="text" maxlength="50" placeholder="Email">
</div>
</div>
<div class="uk-margin-top">
<label class="uk-form-label">PASSWORD/输入口令:</label>
<div class="uk-inline">
<span class="uk-form-icon uk-form-icon-flip" uk-icon="lock"></span>
<input class="uk-input uk-form-width-medium" v-model="passwd" type="password" maxlength="50" placeholder="口令">
</div>
</div>
<div class="uk-margin-top">
<button type="submit" class="uk-button uk-button-primary">SIGNIN/登陆</button>
</div>
</form>
</div>
</div>
{% endblock %}