diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..01f267b5 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,84 @@ +# MaxKey + +**MaxKey(马克思的钥匙)**,寓意是最大钥匙,是基于开放用户安全身份认证系统(User Security Access System),提供简单、可靠和安全的用户认证和单点登录,包含用户认证、单点登录、资源管理、权限管理等。 + +什么是**单点登录(Single Sign On)**,简称为**SSO**? + + 用户只需要登录认证中心一次就可以访问所有相互信任的应用系统,无需再次登录。 + + **MaxKey on GitHub** + + **MaxKey on 码云(Gitee)** + + QQ交流群:**434469201** 点击链接加入群聊 + +------------ + +1. 标准化认证协议: + +| 序号 | 协议 | 支持 | +| --------| :----- | :----: | +| 1 | OAuth 2.0/OpenID Connect | 高 | +| 2 | SAML 2.0 | 高 | +| 3 | JWT | 高 | +| 4 | CAS | 高 | +| 5 | FormBased | 中 | +| 6 | TokenBased(Post/Cookie) | 中 | +| 7 | ExtendApi | 低 | +| 8 | EXT | 低 | + +2. 登录支持 + +| 序号 | 登录方式 | +| --------| :----- | +| 1 | 动态验证码 | +| 2 | 双因素认证 | +| 3 | Google Authenticator | +| 4 | Kerberos/Spengo/AD域| +| 5 | 社交账号 微信/QQ/微博/钉钉/Google/Facebook/其他 | + + +3. 提供标准的认证接口以便于其他应用集成SSO,安全的移动接入,安全的API、第三方认证和互联网认证的整合。 + +4. 认证中心具有平台无关性、环境多样性,支持Web、手机、移动设备等, 如Apple iOS,Andriod等,将认证能力从B/S到移动应用全面覆盖。 + +5. 多种认证机制并存,各应用系统可保留原有认证机制,同时集成认证中心的认证;应用具有高度独立性,不依赖认证中心,又可用使用认证中心的认证,实现单点登录。 + +6. 基于Java平台开发,采用Spring、Spring Boot、MyBatis、bootstrap等开源技术,支持微服务,扩展性强。 + +7. 许可证 Apache License, Version 2.0,开源免费。 + +------------ +# 界面 +**MaxKey认证** + +登录界面 +![mahua](https://github.com/shimingxy/MaxKey/blob/master/images/maxkey_login.png) + +主界面 +![mahua](https://github.com/shimingxy/MaxKey/blob/master/images/maxkey_index.png) + +**MaxKey管理** + +用户管理界面 +![mahua](https://github.com/shimingxy/MaxKey/blob/master/images/maxkey_mgt_users.png) + +应用管理界面 +![mahua](https://github.com/shimingxy/MaxKey/blob/master/images/maxkey_mgt_apps.png) + +------------ +# 下载 + +百度网盘下载 +| 版本 | 日期 | 下载地址 | 提取码 | +| --------| :----- | :---- | :----: | +| v 1.0 GA | 2019/12/06 | https://pan.baidu.com/s/15j7RSUQybCVlHx8uyFk2rQ | **g17z** | +| v 1.2 GA | 2020/02/18 | https://pan.baidu.com/s/1NDeB_g_-6Qbn_bHkTGnFGA | **6bda** | + + + + +------------ + + +