From 12ad9ab84c8c0fc91cf9d565ace02388e8fe53d5 Mon Sep 17 00:00:00 2001
From: shimingxy <shimingxy@163.com>
Date: Fri, 15 May 2020 16:22:49 +0800
Subject: [PATCH] =?UTF-8?q?=E5=8F=8C=E5=9B=A0=E7=B4=A0=E8=AE=A4=E8=AF=81?=
 =?UTF-8?q?=EF=BC=88MFA=EF=BC=89?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/_includes/navigation.html                |   1 +
 docs/authn/mfa.md                             | 120 ++++++++++++++++++
 .../sms/{netease => }/SmsOtpAuthnAliyun.java  |   2 +-
 .../SmsOtpAuthnTencentCloud.java              |   2 +-
 .../sms/{netease => }/SmsOtpAuthnYunxin.java  |   2 +-
 .../SmsOtpAuthnYunxinCheckSumBuilder.java     |   2 +-
 .../main/resources/spring/maxkey-security.xml |   4 +-
 7 files changed, 127 insertions(+), 6 deletions(-)
 create mode 100644 docs/authn/mfa.md
 rename maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/{netease => }/SmsOtpAuthnAliyun.java (98%)
 rename maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/{netease => }/SmsOtpAuthnTencentCloud.java (98%)
 rename maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/{netease => }/SmsOtpAuthnYunxin.java (99%)
 rename maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/{netease => }/SmsOtpAuthnYunxinCheckSumBuilder.java (95%)

diff --git a/docs/_includes/navigation.html b/docs/_includes/navigation.html
index de047040..0a3b8d0a 100644
--- a/docs/_includes/navigation.html
+++ b/docs/_includes/navigation.html
@@ -17,6 +17,7 @@
 				<a href="#"><span class="icon-chevron-down"></span>登录集成</a>
 				<ul class="nav nav-list">
 					<li class=""><a href="{{site.baseurl}}/authn/captcha.html"><span class="none"></span>登录验证码</a></li>
+					<li class=""><a href="{{site.baseurl}}/authn/mfa.html"><span class="none"></span>双因素认证MFA</a></li>
 					<li class=""><a href="{{site.baseurl}}/authn/social.html"><span class="none"></span>社交集成</a></li>
 					<li class=""><a href="{{site.baseurl}}/authn/google.html"><span class="none"></span>TOTP/Google Authenticator</a></li>
 					<li class=""><a href="{{site.baseurl}}/authn/kerberos.html"><span class="none"></span>Kerberos/Spengo/AD</a></li>
diff --git a/docs/authn/mfa.md b/docs/authn/mfa.md
new file mode 100644
index 00000000..9fcdbac2
--- /dev/null
+++ b/docs/authn/mfa.md
@@ -0,0 +1,120 @@
+<h2>双因素认证（MFA）</h2>
+
+<b>双因素身份认证</b>就是通过你所知道再加上你所能拥有的这二个要素组合到一起才能发挥作用的身份认证系统。双因素认证是一种采用时间同步技术的系统，采用了基于时间、事件和密钥三变量而产生的一次性密码来代替传统的静态密码。每个动态密码卡都有一个唯一的密钥，该密钥同时存放在服务器端，每次认证时动态密码卡与服务器分别根据同样的密钥，同样的随机参数（时间、事件）和同样的算法计算了认证的动态密码，从而确保密码的一致性，从而实现了用户的认证。就像我们去银行办卡送的口令牌.
+
+多因素认证（MFA），是一种计算机访问控制的方法，用户要通过两种以上的认证机制之后，才能得到授权，使用计算机资源。MFA的目的是建立一个多层次的防御，使未经授权的人访问计算机系统或网络更加困难，从而提高安全性。
+
+
+<h2>双因素认证</h2>
+
+1、短信认证  腾讯云短信/阿里云短信/网易云信/定制
+
+2、电子邮件 
+
+
+<h2>短信认证</h2>
+
+<h3>腾讯云短信</h3>
+secretId 账号Appkey
+
+secretKey 密钥appSecret
+
+smsSdkAppid 短信SDKAPPID
+
+templateId 短信模板ID
+
+sign 签名
+
+<pre><code class="xml hljs">
+&lt;!--
+&lt;bean id="tfaOptAuthn" class="org.maxkey.crypto.password.opt.impl.TimeBasedOtpAuthn"&gt;
+&lt;/bean&gt;
+--&gt;	
+&lt;bean id="tfaOptAuthn" class="org.maxkey.crypto.password.opt.impl.sms.SmsOtpAuthnTencentCloud"&gt;
+	&lt;property name="secretId" value="94395d754eb55693043f5d6a2b772ef4" /&gt;
+	&lt;property name="secretKey" value="05d5485357bc" /&gt;
+	&lt;property name="smsSdkAppid" value="1486220095" /&gt;
+	&lt;property name="templateId" value="14860095" /&gt;
+	&lt;property name="sign" value="1486009522" /&gt;
+&lt;/bean&gt;
+
+</code></pre>
+
+<h3>阿里云短信</h3>
+accessKeyId 账号Appkey
+
+accessSecret 密钥appSecret
+
+templateCode 短信模板ID
+
+signName 签名
+
+<pre><code class="xml hljs">
+&lt;!--
+&lt;bean id="tfaOptAuthn" class="org.maxkey.crypto.password.opt.impl.TimeBasedOtpAuthn"&gt;
+&lt;/bean&gt;
+--&gt;	
+&lt;bean id="tfaOptAuthn" class="org.maxkey.crypto.password.opt.impl.sms.SmsOtpAuthnAliyun"&gt;
+	&lt;property name="accessKeyId" value="94395d754eb55693043f5d6a2b772ef3" /&gt;
+	&lt;property name="accessSecret" value="05d5485357bc" /&gt;
+	&lt;property name="templateCode" value="SMS_187590021" /&gt;
+	&lt;property name="signName" value="MaxKey" /&gt;
+&lt;/bean&gt;
+
+</code></pre>
+
+<h3>网易云信</h3>
+配置maxkey中spring/maxkey-security.xml
+
+appKey 网易云信分配的账号Appkey
+
+appSecret 网易云信分配的密钥appSecret
+
+templateId 短信模板ID
+
+<pre><code class="xml hljs">
+&lt;!--
+&lt;bean id="tfaOptAuthn" class="org.maxkey.crypto.password.opt.impl.TimeBasedOtpAuthn"&gt;
+&lt;/bean&gt;
+--&gt;	
+&lt;bean id="tfaOptAuthn" class="org.maxkey.crypto.password.opt.impl.sms.SmsOtpAuthnYunxin"&gt;
+	&lt;property name="appKey" value="94395d754eb55693043f5d6a2b772ef4" /&gt;
+	&lt;property name="appSecret" value="05d5485357bc" /&gt;
+	&lt;property name="templateId" value="14860095" /&gt;
+&lt;/bean&gt;
+
+</code></pre>
+
+<h2>电子邮件</h2>
+
+配置邮箱地址
+
+文件
+maxkey/config/applicationConfig.properties
+
+<pre><code class="ini hljs">
+#  EMAIL configuration
+config.email.username=maxkey@163.com
+config.email.password=password
+config.email.smtpHost=smtp.163.com
+config.email.port=465
+config.email.senderMail=maxkey@163.com
+config.email.ssl=true
+</code></pre>
+
+配置maxkey中spring/maxkey-security.xml
+
+subject 邮件主题
+
+messageTemplate 邮件内容模板，请勿修改参数{0}为用户名，{1}认证码，{2}有效间隔
+
+<pre><code class="xml hljs">
+&lt;!--
+&lt;bean id="tfaOptAuthn" class="org.maxkey.crypto.password.opt.impl.TimeBasedOtpAuthn"&gt;
+&lt;/bean&gt;
+--&gt;	
+&lt;bean id="tfaOptAuthn" class="org.maxkey.crypto.password.opt.impl.MailOtpAuthn"&gt;
+	&lt;property name="subject" value="MaxKey One Time PassWord" /&gt;
+	&lt;property name="messageTemplate" value="{0} You Token is {1} , it validity in {2}  minutes." /&gt;
+&lt;/bean&gt;
+</code></pre>
\ No newline at end of file
diff --git a/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/netease/SmsOtpAuthnAliyun.java b/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/SmsOtpAuthnAliyun.java
similarity index 98%
rename from maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/netease/SmsOtpAuthnAliyun.java
rename to maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/SmsOtpAuthnAliyun.java
index f6b48b86..cb168fbe 100644
--- a/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/netease/SmsOtpAuthnAliyun.java
+++ b/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/SmsOtpAuthnAliyun.java
@@ -1,4 +1,4 @@
-package org.maxkey.crypto.password.opt.impl.sms.netease;
+package org.maxkey.crypto.password.opt.impl.sms;
 
 import com.aliyuncs.CommonRequest;
 import com.aliyuncs.CommonResponse;
diff --git a/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/netease/SmsOtpAuthnTencentCloud.java b/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/SmsOtpAuthnTencentCloud.java
similarity index 98%
rename from maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/netease/SmsOtpAuthnTencentCloud.java
rename to maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/SmsOtpAuthnTencentCloud.java
index 37861c33..36bf9775 100644
--- a/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/netease/SmsOtpAuthnTencentCloud.java
+++ b/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/SmsOtpAuthnTencentCloud.java
@@ -1,4 +1,4 @@
-package org.maxkey.crypto.password.opt.impl.sms.netease;
+package org.maxkey.crypto.password.opt.impl.sms;
 
 import com.tencentcloudapi.common.Credential;
 import com.tencentcloudapi.common.profile.ClientProfile;
diff --git a/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/netease/SmsOtpAuthnYunxin.java b/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/SmsOtpAuthnYunxin.java
similarity index 99%
rename from maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/netease/SmsOtpAuthnYunxin.java
rename to maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/SmsOtpAuthnYunxin.java
index a422a437..a01f7c25 100644
--- a/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/netease/SmsOtpAuthnYunxin.java
+++ b/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/SmsOtpAuthnYunxin.java
@@ -1,4 +1,4 @@
-package org.maxkey.crypto.password.opt.impl.sms.netease;
+package org.maxkey.crypto.password.opt.impl.sms;
 
 import java.util.ArrayList;
 import java.util.Date;
diff --git a/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/netease/SmsOtpAuthnYunxinCheckSumBuilder.java b/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/SmsOtpAuthnYunxinCheckSumBuilder.java
similarity index 95%
rename from maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/netease/SmsOtpAuthnYunxinCheckSumBuilder.java
rename to maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/SmsOtpAuthnYunxinCheckSumBuilder.java
index 83d306d9..f5a5b4b9 100644
--- a/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/netease/SmsOtpAuthnYunxinCheckSumBuilder.java
+++ b/maxkey-core/src/main/java/org/maxkey/crypto/password/opt/impl/sms/SmsOtpAuthnYunxinCheckSumBuilder.java
@@ -1,4 +1,4 @@
-package org.maxkey.crypto.password.opt.impl.sms.netease;
+package org.maxkey.crypto.password.opt.impl.sms;
 
 import java.security.MessageDigest;
 
diff --git a/maxkey-web-maxkey/src/main/resources/spring/maxkey-security.xml b/maxkey-web-maxkey/src/main/resources/spring/maxkey-security.xml
index e98d886e..6ca8f200 100644
--- a/maxkey-web-maxkey/src/main/resources/spring/maxkey-security.xml
+++ b/maxkey-web-maxkey/src/main/resources/spring/maxkey-security.xml
@@ -87,7 +87,7 @@
 	<bean id="tfaOptAuthn" class="org.maxkey.crypto.password.opt.impl.TimeBasedOtpAuthn">
 	</bean>
 	<!-- 
-	<bean id="tfaOptAuthn" class="org.maxkey.crypto.password.opt.impl.sms.netease.SmsOtpAuthnYunxin">
+	<bean id="tfaOptAuthn" class="org.maxkey.crypto.password.opt.impl.sms.SmsOtpAuthnYunxin">
 	</bean>
 	-->
 	
@@ -95,7 +95,7 @@
 	<bean id="tfaMailOptAuthn" class="org.maxkey.crypto.password.opt.impl.MailOtpAuthn">
 	</bean>
 	
-	<bean id="tfaMobileOptAuthn" class="org.maxkey.crypto.password.opt.impl.sms.netease.SmsOtpAuthnYunxin">
+	<bean id="tfaMobileOptAuthn" class="org.maxkey.crypto.password.opt.impl.sms.SmsOtpAuthnYunxin">
 	</bean>