一次性驗(yàn)證碼，英文是 One Time Password，簡(jiǎn)寫為 OTP，又稱動(dòng)態(tài)密碼或單次有效密碼，是指計(jì)算機(jī)系統(tǒng)或其他數(shù)字設(shè)備上只能使用一次的密碼，有效期為只有一次登錄會(huì)話或很短如 1 分鐘。OTP 避免了一些靜態(tài)密碼認(rèn)證相關(guān)系的缺點(diǎn)，不容易受到重放攻擊，比如常見的注冊(cè)場(chǎng)景，用戶的郵箱或短信會(huì)收到一條一次性的激活鏈接，或者收到一次隨機(jī)的驗(yàn)證碼（只能使用一次），從而驗(yàn)證了郵箱或手機(jī)號(hào)的有效性。
要實(shí)現(xiàn)的功能就是：
1、驗(yàn)證碼是 6 位的數(shù)字和小寫字母的組合。
2、有效期為 5 分鐘，第二次發(fā)送驗(yàn)證碼的必須在 1 分鐘之后。
3、如果該郵箱/手機(jī)號(hào)已經(jīng)注冊(cè)，則不能發(fā)送注冊(cè)驗(yàn)證碼。
具體的實(shí)現(xiàn)邏輯就是：
1、先生成滿足條件的驗(yàn)證碼。
2、發(fā)送前驗(yàn)證，是否上次發(fā)送的驗(yàn)證碼在 1 分鐘之內(nèi)？是否郵箱已經(jīng)注冊(cè)？，如果是，拒絕發(fā)送，并提示用戶，如果否，發(fā)送驗(yàn)證碼。
3、驗(yàn)證，是否是 5 分鐘之內(nèi)的驗(yàn)證碼，是否正確，如果是，則放行。否則提示用戶。
為了驗(yàn)證驗(yàn)證碼及其時(shí)效，我們需要把發(fā)送驗(yàn)證碼的時(shí)間和對(duì)應(yīng)的郵箱記錄下來(lái)，那么就需要設(shè)計(jì)一張表來(lái)存儲(chǔ)。
|
1
2
3
4
5
|
class VerifyCode(models.Model): mobile = models.CharField(max_length=11, verbose_name="手機(jī)號(hào)", blank=True) email = models.EmailField(verbose_name="email", blank=True) code = models.CharField(max_length=8, verbose_name="驗(yàn)證碼") add_time = models.DateTimeField(verbose_name='生成時(shí)間', auto_now_add=True) |
1、生成驗(yàn)證碼
第一個(gè)邏輯非常簡(jiǎn)單，可以直接寫出代碼：
|
1
2
3
4
5
6
7
8
9
10
11
|
from random import choice def generate_code(self): """ 生成 6 位數(shù)驗(yàn)證碼，防止破解 :return: """ seeds = "1234567890abcdefghijklmnopqrstuvwxyz" random_str = [] for i in range(6): random_str.append(choice(seeds)) return "".join(random_str) |
2、發(fā)送前驗(yàn)證
Django REST framework 框架的 Serializer 可以對(duì) Models 里的每一個(gè)字段進(jìn)行驗(yàn)證，我們直接在里面做填空題即可：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
# serializers.pyclass VerifyCodeSerializer(serializers.Serializer): email = serializers.EmailField(required=True) def validate_email(self, email): """ 驗(yàn)證郵箱是否合法 """ # 郵箱是否注冊(cè) if User.objects.filter(email = email).count(): raise serializers.ValidationError('該郵箱已經(jīng)注冊(cè)') # 驗(yàn)證郵箱號(hào)碼合法 if not re.match(EMAIL_REGEX, email): raise serializers.ValidationError('郵箱格式錯(cuò)誤') # 驗(yàn)證碼發(fā)送頻率 one_minute_age = datetime.now() - timedelta(hours=0, minutes=1, seconds=0) if VerifyCode.objects.filter(add_time__gt=one_minute_age, email=email).count(): raise serializers.ValidationError('請(qǐng)一分鐘后再次發(fā)送') return email |
3、發(fā)送驗(yàn)證碼
發(fā)送驗(yàn)證碼，其實(shí)就是生成驗(yàn)證碼并保存的過程，借助于 Django REST framework 框架的 GenericViewSet 和 CreateModelMixin 即可實(shí)現(xiàn) view 類，代碼都有詳細(xì)的注釋，你很容易就看明白：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
from rest_framework.response import Responsefrom rest_framework.views import statusfrom rest_framework import mixins, viewsetsclass VerifyCodeViewSet(viewsets.GenericViewSet, mixins.CreateModelMixin): """ 發(fā)送驗(yàn)證碼 """ permission_classes = [AllowAny] #允許所有人注冊(cè) serializer_class = VerifyCodeSerializer #相關(guān)的發(fā)送前驗(yàn)證邏輯 def generate_code(self): """ 生成6位數(shù)驗(yàn)證碼 防止破解 :return: """ seeds = "1234567890abcdefghijklmnopqrstuvwxyz" random_str = [] for i in range(6): random_str.append(choice(seeds)) return "".join(random_str) def create(self, request, *args, **kwargs): # 自定義的 create() 的內(nèi)容 serializer = self.get_serializer(data=request.data) serializer.is_valid(raise_exception=True) #這一步相當(dāng)于發(fā)送前驗(yàn)證 # 從 validated_data 中獲取 mobile email = serializer.validated_data["email"] # 隨機(jī)生成code code = self.generate_code() # 發(fā)送短信或郵件驗(yàn)證碼 sms_status = SendVerifyCode.send_email_code(code=code, to_email_adress=email) if sms_status == 0: # 記錄日志 return Response({"msg": "郵件發(fā)送失敗"}, status=status.HTTP_400_BAD_REQUEST) else: code_record = VerifyCode(code=code, email=email) # 保存驗(yàn)證碼 code_record.save() return Response( {"msg": f"驗(yàn)證碼已經(jīng)向 {email} 發(fā)送完成"}, status=status.HTTP_201_CREATED ) |
SendVerifyCode.send_email_code 的實(shí)現(xiàn)如下：
|
1
2
3
4
5
6
7
8
9
10
|
#encoding=utf-8from django.core.mail import send_mailclass SendVerifyCode(object): @staticmethod def send_email_code(code,to_email_adress): try: success_num = send_mail(subject='xxx 系統(tǒng)驗(yàn)碼', message=f'您的驗(yàn)證碼是【[code]】。如非本人操作，請(qǐng)忽略。',from_email='[email protected]',recipient_list = [to_email_adress], fail_silently=False) return success_num except: return 0 |
4、注冊(cè)時(shí)驗(yàn)證
用戶注冊(cè)對(duì)于數(shù)據(jù)庫(kù)來(lái)講就是 User 類插入一條記錄，也就是 User 的 view 類的 create 操作來(lái)實(shí)現(xiàn)注冊(cè)。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
from .serializers import UserRegisterSerializer, UserSerializerclass UserViewSet(viewsets.ModelViewSet): """ API endpoint that allows users to be viewed or edited. """ serializer_class = UserSerializer def get_serializer_class(self): if self.action == "create": # 如果是創(chuàng)建用戶，那么用 UserRegisterSerializer serializer_class = UserRegisterSerializer else: serializer_class = UserSerializer return serializer_class |
這個(gè)骨架好了以后，我們現(xiàn)在來(lái)編寫 UserRegisterSerializer 類，實(shí)現(xiàn)注冊(cè)時(shí)驗(yàn)證：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
# serializers.pyclass UserRegisterSerializer(serializers.ModelSerializer): # error_message:自定義錯(cuò)誤消息提示的格式 code = serializers.CharField(required=True, allow_blank=False, min_length=6, max_length=6, help_text='驗(yàn)證碼', error_messages={ 'blank': '請(qǐng)輸入驗(yàn)證碼', 'required': '請(qǐng)輸入驗(yàn)證碼', 'min_length': '驗(yàn)證碼格式錯(cuò)誤', 'max_length': '驗(yàn)證碼格式錯(cuò)誤', }, write_only=True) # 利用drf中的validators驗(yàn)證username是否唯一 username = serializers.CharField(required=True, allow_blank=False, validators=[UniqueValidator(queryset=User.objects.all(), message='用戶已經(jīng)存在')]) email = serializers.EmailField(required=True, allow_blank=False, validators=[UniqueValidator(queryset=User.objects.all(), message='郵箱已被注冊(cè)')]) # 對(duì)code字段單獨(dú)驗(yàn)證(validate_+字段名) def validate_code(self, code): verify_records = VerifyCode.objects.filter(email=self.initial_data['email']).order_by('-add_time') if verify_records: last_record = verify_records[0] # 判斷驗(yàn)證碼是否過期 five_minutes_ago = datetime.now() - timedelta(hours=0, minutes=5, seconds=0) # 獲取5分鐘之前的時(shí)間 if last_record.add_time < five_minutes_ago: raise serializers.ValidationError('驗(yàn)證碼過期') # 判斷驗(yàn)證碼是否正確 if last_record.code != code: raise serializers.ValidationError('驗(yàn)證碼錯(cuò)誤') # 不用將code返回到數(shù)據(jù)庫(kù)中，只是做驗(yàn)證 # return code else: raise serializers.ValidationError('驗(yàn)證碼不存在') # attrs：每個(gè)字段validate之后總的dict def validate(self, attrs): # attrs['mobile'] = attrs['username'] # 從attrs中刪除code字段 del attrs['code'] return attrs class Meta: model = User fields = ('username', 'email', 'password', 'code') extra_kwargs = {'password': {'write_only': True}} def create(self, validated_data): user = User( email=validated_data['email'], username=validated_data['username'] ) user.set_password(validated_data['password']) user.save() return user |
至此發(fā)送驗(yàn)證碼的后端編碼已經(jīng)結(jié)束。
最后的話
一次性驗(yàn)證碼（OTP）的邏輯簡(jiǎn)單，需要思考的是如何在 DRF 的框架中填空，填在哪里？這其實(shí)需要了解 DRF 的 ModelSerializer 類和 ViewSet 類之前的關(guān)系，在調(diào)用關(guān)系上，ViewSet 類調(diào)用 ModelSerializer 來(lái)實(shí)現(xiàn)字段的驗(yàn)證和數(shù)據(jù)保存及序列化，Serializers 類不是必須的，你可以完全自己實(shí)現(xiàn)驗(yàn)證和數(shù)據(jù)保存及序列化，只不過這樣會(huì)導(dǎo)致 View 類特別臃腫，不夠優(yōu)雅，不易維護(hù)。
參考資料
[1]
Django REST framework: https://www.django-rest-framework.org
以上就是Python編程使用DRF實(shí)現(xiàn)一次性驗(yàn)證碼OTP的詳細(xì)內(nèi)容，更多關(guān)于Python編程DRF一次性驗(yàn)證碼OTP的資料請(qǐng)關(guān)注服務(wù)器之家其它相關(guān)文章！
原文鏈接：https://blog.csdn.net/somenzz/article/details/120072996
