2020-12-20 10:00:17 +08:00
# <img src="images/logo_maxkey.png?raw=true" width="200px" alt=""/>
2020-09-28 08:55:05 +08:00
2020-11-24 22:18:37 +08:00
<a href="README_en.md" target="_blank"><b>English</b></a> | <a href="README_zh.md" target="_blank"><b>中文</b></a>
2020-11-24 22:01:40 +08:00
# Overview
2020-09-28 08:55:05 +08:00
2021-10-13 10:00:59 +08:00
<b>Maxkey </b> Single Sign On system, which means the Maximum key, <b>Leading-Edge Enterprise-Class IAM Identity and Access management product </b>, Support OAuth 2.x/OPENID CONNECT, SAML 2.0, JWT, CAS, SCIM and other standard protocols, and provide <b> Simple, Standard, Secure and Open </b> Identity management (IDM), Access management (AM), Single Sign On (SSO), RBAC permission management and Resource management.
2019-04-21 13:50:23 +08:00
2020-11-24 22:36:35 +08:00
Official Website <a href="https://www.maxkey.top" target="_blank"><b>Official</b></a> | <a href="https://maxkeytop.gitee.io" target="_blank"><b>Line2</b></a>
2020-08-01 22:18:46 +08:00
2020-12-10 14:02:21 +08:00
QQ Community: <b> 434469201 </b>
email: <b> maxkeysupport@163 .com </b>
2020-08-01 22:19:56 +08:00
2021-03-15 16:14:02 +08:00
Code Hosting <a href="https://github.com/dromara/MaxKey" target="_blank"><b>GitHub</b></a> | <a href="https://gitee.com/dromara/MaxKey" target="_blank"><b>Gitee</b></a>
2020-08-01 22:19:56 +08:00
2021-06-22 22:41:17 +08:00
<b> Single Sign On </b>(<b> SSO </b >),Users only need to login to the authentication center once , access all the trusted application systems without logging in again.
2020-04-17 21:56:29 +08:00
2020-11-24 22:01:40 +08:00
Key Functions
2020-05-06 10:54:00 +08:00
2020-11-24 22:01:40 +08:00
1) All application systems share one Identity authentication system
2020-05-06 10:54:00 +08:00
2020-11-24 22:01:40 +08:00
2) All application systems can Identify and extract Ticket
2020-05-06 10:54:00 +08:00
2020-04-27 22:17:06 +08:00
2020-11-24 22:01:40 +08:00
# Features
2019-04-21 13:50:23 +08:00
2020-11-24 22:01:40 +08:00
1. Standard Protocols
2019-04-21 13:50:23 +08:00
2020-11-24 22:01:40 +08:00
| No. | Protocols | Support |
2021-09-15 21:24:37 +08:00
| --------| :----- | :---- |
2021-10-11 13:14:44 +08:00
| 1.1 | OAuth 2.x/OpenID Connect | HIGH |
| 1.2 | SAML 2.0 | HIGH |
| 1.3 | JWT | HIGH |
| 1.4 | CAS | HIGH |
| 1.5 | FormBased | MIDDLE|
| 1.6 | TokenBased(Post/Cookie) | MIDDLE|
| 1.7 | ExtendApi | LOW |
| 1.8 | EXT | LOW |
2020-11-24 22:01:40 +08:00
2. Authentication
2021-05-10 09:34:58 +08:00
| No. | SignIn Support | Support |
2021-09-15 21:24:37 +08:00
| --------| :----- | :---- |
| 2.1 | Captcha | letter / number / arithmetic |
2021-05-10 09:34:58 +08:00
| 2.2 | Two Factor Authentication | SMS / TOPT/ Mail |
2021-09-15 21:24:37 +08:00
| 2.3 | SMS | Tencent SMS / Alibaba SMS / NetEaseYunXin |
| 2.4 | TOTP | Denglu1/Google/Microsoft Authenticator/FreeOTP/Support TOTP or HOTP |
2021-05-10 09:34:58 +08:00
| 2.5 | Domain | Kerberos/SPNEGO/AD domain|
2021-09-15 21:24:37 +08:00
| 2.6 | LDAP | OpenLDAP/ActiveDirectory/Standard LDAP Server |
2021-08-07 19:05:20 +08:00
| 2.7 | Social Account | WeChat/QQ/ Weibo/DingTalk/Google/Facebook/other |
| 2.8 | Scan QR Code | WorkWeiXin/DingTalk Scan QR Code |
2020-02-15 17:03:53 +08:00
2019-04-21 13:50:23 +08:00
2020-11-24 22:01:40 +08:00
3. Standard Authentication Protocols for applications to integrate sso, secure mobile access, secure API, third-party authentication and Internet authentication.
2019-04-21 13:50:23 +08:00
2020-11-24 22:01:40 +08:00
4. Identity Lifecycle management, support SCIM 2 , and realize Identity supply synchronization through connector based on Apache Kafka agent.
2019-04-21 13:50:23 +08:00
2020-11-24 22:01:40 +08:00
5. The platform independence and diversity of environment. It supports web, mobile phone, mobile devices, such as apple IOS, Android, etc., and covers the certification ability from B/S to mobile applications.
2019-04-21 23:41:37 +08:00
2020-11-24 22:01:40 +08:00
6. Variety of authentication mechanisms coexist, each application system can retain the original authentication mechanism, and integrate the authentication of the MaxKey; the application has a high degree of independence, does not rely on the MaxKey, and can use the authentication of the MaxKey to realize single sign on.
2019-04-21 23:41:37 +08:00
2021-09-29 09:01:14 +08:00
7. Based on Java EE platform, Adopts Spring, MySQL, Tomcat, Redis , Apache Kafka and other open source technologies, supports microservices, and has strong scalability.
2020-06-15 15:21:27 +08:00
2020-12-10 14:47:19 +08:00
8. Open Source, Secure, Independent and Controllable , License Under Apache 2.0 License & <a href="https://maxkey.top/zh/about/licenses.html" target="_blank">MaxKey copyright</a> .
2019-12-07 13:30:56 +08:00
2020-09-28 08:54:30 +08:00
2020-11-24 22:01:40 +08:00
# Interface
2020-09-28 08:55:05 +08:00
2020-11-24 22:01:40 +08:00
**MaxKey**
2019-12-06 22:08:08 +08:00
2020-11-24 22:01:40 +08:00
Login UI
2020-12-20 10:00:17 +08:00
<img src="images/maxkey_login.png?raw=true"/>
2019-12-06 21:56:44 +08:00
2020-11-24 22:01:40 +08:00
App List UI
2020-12-20 10:00:17 +08:00
<img src="images/maxkey_index.png?raw=true"/>
2019-12-06 21:53:39 +08:00
2020-11-24 22:01:40 +08:00
**MaxKey Management**
2019-12-06 22:08:08 +08:00
2020-11-24 22:01:40 +08:00
Report UI
2020-12-20 10:00:17 +08:00
<img src="images/maxkey_mgt_rpt.png?raw=true"/>
2019-12-06 21:56:44 +08:00
2020-11-24 22:01:40 +08:00
User Management UI
2020-12-20 10:00:17 +08:00
<img src="images/maxkey_mgt_users.png?raw=true"/>
2020-04-06 21:54:25 +08:00
2020-11-24 22:01:40 +08:00
App Management UI
2020-12-20 10:00:17 +08:00
<img src="images/maxkey_mgt_apps.png?raw=true"/>
2019-12-06 21:56:44 +08:00
2020-09-28 08:54:30 +08:00
2020-11-24 22:01:40 +08:00
# Download
2019-12-06 22:00:32 +08:00
2021-10-13 10:00:59 +08:00
Download the current version from Baidu Pan,<a href="https://maxkey.top/zh/about/download.html" target="_blank"> history version</a>
2021-05-10 09:42:16 +08:00
2021-09-09 17:16:27 +08:00
| Version | Date | Docker | Pan URL | Pan Code |
2021-09-15 21:24:37 +08:00
| -------- | :----- | :---- | :---- | :---- |
2021-09-27 23:29:57 +08:00
| v 3.0.0 GA | 2021/09/29 |<a href="https://hub.docker.com/u/maxkeytop" target="_blank">Home</a> | <a href="https://pan.baidu.com/s/1UtEgLD1Pz7FQXZePZaP9Tw" target="_blank">Download</a> | **mxk9 ** |
2021-09-09 17:16:27 +08:00
2020-07-11 23:20:06 +08:00
2020-06-13 09:27:20 +08:00
# Roadmap
2020-07-04 09:43:15 +08:00
2021-09-15 21:24:37 +08:00
| No. | Plan | Date |
| --------| :----- | :---- |
| 1 | Maxkey-Cloud (micro service support) | 2021Q3 |
| 2 | Zero trust scenario integration | 2021Q4 |
| 3 | React, and Ant Design | 2021Q4 |
| 4 | OAuth 2.1 | 2022Q1 |
| 5 | OpenID Connect optimize | 2022Q2 |
| 6 | Java 17+ | 2022Q3 |
| 7 | Jakarta EE 9+ | 2022Q3 |
| 8 | Spring Framework 6 | 2022Q4 |
| 9 | Spring Boot 3 | 2022Q4 |
2020-09-23 23:32:46 +08:00
2020-09-03 20:52:23 +08:00
2021-01-03 18:33:58 +08:00
# User Registration
2020-09-03 20:52:23 +08:00
2021-03-19 23:17:00 +08:00
<a href="https://github.com/dromara/MaxKey/issues/40" target="_blank"> Click to register </a> as MaxKey user and contribute to MaxKey!
2021-06-21 23:34:28 +08:00
2021-06-21 23:37:42 +08:00
以下为部分接入或测试中的用户
2021-09-15 21:24:37 +08:00
| 序号 | 单位 | 行业 |
| --------| :----- | :---- |
| 1.1 | 兰州现代职业学院 | 院校 |
| 1.2 | 长春职业技术学院 | 院校 |
| 1.3 | 德清智慧教育平台 | 教育 |
| 2.1 | 深圳市金溢科技股份有限公司 | 企业 |
| 2.2 | 之江实验室 | 企业 |
| 2.3 | 深圳市中悦科技有限公司 | 企业 |
| 3.1 | 国元证券 | 金融 |
| 3.2 | 华夏金融租赁有限公司 | 金融 |
| 3.3 | 宁波金融资产交易中心 | 金融 |
| 3.4 | 北京银泰置业有限公司 | 企业 |
| 3.5 | 遂宁市经济大数据平台 | 企业 |
| 3.6 | 同方节能工程技术有限公司 | 企业 |
| 3.7 | 云南航天工程物探检测股份有限公司 | 企业 |
| 3.8 | 山东港口陆海国际物流集团有限公司 | 企业 |
| 3.9 | 河南新辰环保科技有限公司 | 企业 |
| 3.10 | 广州思迈特软件有限公司 | 科技 |
| 3.11 | 尚企云链 | 科技 |
| 4.1 | 北京博亚思科技有限公司 | 科技 |
| 4.2 | 武汉英特沃科技有限公司 | 科技 |
| 4.3 | 江苏创致信息科技有限公司 | 科技 |
| 4.4 | 江西云车科技有限公司 | 科技 |
2021-09-27 23:29:57 +08:00
| 4.5 | 无锡市陶都巨龙软件有限责任公司 | 科技 |
| 4.6 | NGROK(ngrok.io) | 科技 |
2021-09-15 21:24:37 +08:00
| 5.1 | 王朔日记 | 个人 |
| 5.2 | 一席南风（张彬） | 个人 |
| 5.3 | glzpcw | 个人 |
| 5.4 | ynduck | 个人 |
