README_en.md

# <img src="images/logo_maxkey.png?raw=true"  width="200px"   alt=""/>

<a href="README_en.md" target="_blank"><b>English</b></a>  |  <a href="README_zh.md" target="_blank"><b>中文</b></a>

# Overview

<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.0/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.

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>

QQ Community: <b> 434469201 </b> 

email: <b> maxkeysupport@163.com </b>

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>

<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.

Key Functions

1) All application systems share one Identity authentication system

2) All application systems can Identify and extract Ticket
 
 
# Features

1.  Standard Protocols

| No.     | Protocols   |  Support  |
| --------| :-----  	| :----  	|
| 1.1     | OAuth 2.0/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   |

2. Authentication

| No.     | SignIn Support  | Support   |
| --------| :-----  		| :----  	|
| 2.1     | Captcha			| letter / number / arithmetic 	| 
| 2.2     | Two Factor Authentication  | SMS / TOPT/ Mail     |
| 2.3     | SMS				| Tencent SMS / Alibaba SMS / NetEaseYunXin 	|
| 2.4     | TOTP			| Denglu1/Google/Microsoft Authenticator/FreeOTP/Support TOTP or HOTP |
| 2.5     | Domain          | Kerberos/SPNEGO/AD domain|
| 2.6     | LDAP 			| OpenLDAP/ActiveDirectory/Standard LDAP Server |
| 2.7     | Social Account  | WeChat/QQ/ Weibo/DingTalk/Google/Facebook/other  | 
| 2.8     | Scan QR Code    | WorkWeiXin/DingTalk Scan QR Code | 


3. Standard Authentication Protocols for applications to integrate sso, secure mobile access, secure API, third-party authentication and Internet authentication.

4. Identity Lifecycle management, support SCIM 2 , and realize Identity supply synchronization through connector based on Apache Kafka agent.

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.

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.

7. Based on Java platform, Adopts Spring, MySQL, Tomcat, Apache Kafka, Redis and other open source technologies, supports microservices, and has strong scalability.

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>. 


# UI

**MaxKey**

Login UI
<img src="images/maxkey_login.png?raw=true"/>

App List UI
<img src="images/maxkey_index.png?raw=true"/>

**MaxKey Management**

Report UI
<img src="images/maxkey_mgt_rpt.png?raw=true"/>

User Management UI
<img src="images/maxkey_mgt_users.png?raw=true"/>

App Management UI
<img src="images/maxkey_mgt_apps.png?raw=true"/>


# Download

Download the current version of Baidu Pan,<a href="https://maxkey.top/zh/about/download.html" target="_blank"> history version</a>

| Version    | Date   |  Docker  |  Pan URL  |  Pan Code  |
| --------| :-----  | :----  | :----  | :----   |
| v 2.9.0 GA | 2021/08/24   |<a href="https://hub.docker.com/u/maxkeytop" target="_blank">Home</a>  |  <a href="https://pan.baidu.com/s/1fYkTHDk2PQ9iAP05PmuPAg" target="_blank">Download</a>  |  **mxk9**  |


# Roadmap

1. Zero trust scenario integration

2. Maxkey-Cloud (micro service version)-2021

# User Registration

<a href="https://github.com/dromara/MaxKey/issues/40" target="_blank"> Click to register </a> as MaxKey user and contribute to MaxKey!

以下为部分接入或测试中的用户
| 序号    | 单位   	|  行业   |
| --------| :-----  | :----  |
| 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     | 江西云车科技有限公司   				 	    |  科技  |
| 4.5     | NGROK(ngrok.io)					  			|  科技  |
| 5.1     | 王朔日记    								|  个人  |
| 5.2     | 一席南风（张彬）    						|  个人  |
| 5.3     | glzpcw    									|  个人  |
| 5.4     | ynduck    									|  个人  |
readme 2020-12-20 10:00:17 +08:00			`# <img src="images/logo_maxkey.png?raw=true" width="200px" alt=""/>`
README 2020-11-24 22:01:40 +08:00
README 2020-11-24 22:21:13 +08:00			`<a href="README_en.md" target="_blank"><b>English</b></a> \| <a href="README_zh.md" target="_blank"><b>中文</b></a>`

README 2020-11-24 22:01:40 +08:00			`# Overview`

v2.8.0 2021-06-06 20:05:00 +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.0/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.`
README 2020-11-24 22:01:40 +08:00
README Official Official 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>`
README 2020-11-24 22:01:40 +08:00
email 2020-12-10 14:02:21 +08:00			`QQ Community: <b> 434469201 </b>`

			`email: <b> maxkeysupport@163.com </b>`
README 2020-11-24 22:01:40 +08:00
dromara 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>`
README 2020-11-24 22:01:40 +08:00
readme 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.`
README 2020-11-24 22:01:40 +08:00
			`Key Functions`

			`1) All application systems share one Identity authentication system`

			`2) All application systems can Identify and extract Ticket`


			`# Features`

			`1. Standard Protocols`

			`\| No. \| Protocols \| Support \|`
springBoot 2.5.2 2021-07-11 10:30:29 +08:00			`\| --------\| :----- \| :---- \|`
README 2020-11-24 22:01:40 +08:00			`\| 1.1 \| OAuth 2.0/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 \|`

			`2. Authentication`

readme 2021-05-10 09:34:58 +08:00			`\| No. \| SignIn Support \| Support \|`
springBoot 2.5.2 2021-07-11 10:30:29 +08:00			`\| --------\| :----- \| :---- \|`
readme 2021-05-10 09:34:58 +08:00			`\| 2.1 \| Captcha \| letter / number / arithmetic \|`
			`\| 2.2 \| Two Factor Authentication \| SMS / TOPT/ Mail \|`
			`\| 2.3 \| SMS \| Tencent SMS / Alibaba SMS / NetEaseYunXin \|`
			`\| 2.4 \| TOTP \| Denglu1/Google/Microsoft Authenticator/FreeOTP/Support TOTP or HOTP \|`
			`\| 2.5 \| Domain \| Kerberos/SPNEGO/AD domain\|`
			`\| 2.6 \| LDAP \| OpenLDAP/ActiveDirectory/Standard LDAP Server \|`
v 2.9.0 & 企业微信&钉钉扫描登录 v 2.9.0 & 企业微信&钉钉扫描登录 readme 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 \|`
README 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.`

			`4. Identity Lifecycle management, support SCIM 2 , and realize Identity supply synchronization through connector based on Apache Kafka agent.`

			`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.`

			`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.`

			`7. Based on Java platform, Adopts Spring, MySQL, Tomcat, Apache Kafka, Redis and other open source technologies, supports microservices, and has strong scalability.`

License 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>.`
README 2020-11-24 22:01:40 +08:00

README 2020-11-24 22:21:13 +08:00			`# UI`
README 2020-11-24 22:01:40 +08:00
			`MaxKey`

			`Login UI`
readme 2020-12-20 10:00:17 +08:00			`<img src="images/maxkey_login.png?raw=true"/>`
README 2020-11-24 22:01:40 +08:00
			`App List UI`
readme 2020-12-20 10:00:17 +08:00			`<img src="images/maxkey_index.png?raw=true"/>`
README 2020-11-24 22:01:40 +08:00
			`MaxKey Management`

			`Report UI`
readme 2020-12-20 10:00:17 +08:00			`<img src="images/maxkey_mgt_rpt.png?raw=true"/>`
README 2020-11-24 22:01:40 +08:00
			`User Management UI`
readme 2020-12-20 10:00:17 +08:00			`<img src="images/maxkey_mgt_users.png?raw=true"/>`
README 2020-11-24 22:01:40 +08:00
			`App Management UI`
readme 2020-12-20 10:00:17 +08:00			`<img src="images/maxkey_mgt_apps.png?raw=true"/>`
README 2020-11-24 22:01:40 +08:00

			`# Download`

about 2020-12-03 21:10:22 +08:00			`Download the current version of Baidu Pan,<a href="https://maxkey.top/zh/about/download.html" target="_blank"> history version</a>`
readme 2021-05-10 09:42:16 +08:00
README Docker 2021-09-09 17:16:27 +08:00			`\| Version \| Date \| Docker \| Pan URL \| Pan Code \|`
			`\| --------\| :----- \| :---- \| :---- \| :---- \|`
			`\| v 2.9.0 GA \| 2021/08/24 \|<a href="https://hub.docker.com/u/maxkeytop" target="_blank">Home</a> \| <a href="https://pan.baidu.com/s/1fYkTHDk2PQ9iAP05PmuPAg" target="_blank">Download</a> \| mxk9 \|`
README 2020-11-24 22:01:40 +08:00

			`# Roadmap`

v2.4.0.GA 2020-12-26 18:13:08 +08:00			`1. Zero trust scenario integration`
README 2020-11-24 22:01:40 +08:00
v2.4.0.GA 2020-12-26 18:13:08 +08:00			`2. Maxkey-Cloud (micro service version)-2021`
README 2020-11-24 22:01:40 +08:00
User Registration 2021-01-03 18:33:58 +08:00			`# User Registration`
README 2020-11-24 22:01:40 +08:00
dromara 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!`
User Registration 2021-01-03 18:33:58 +08:00
部分接入或测试中的用户 2021-06-21 23:37:42 +08:00			`以下为部分接入或测试中的用户`
行业 2021-06-22 22:17:49 +08:00			`\| 序号 \| 单位 \| 行业 \|`
readme 2021-09-15 16:08:13 +08:00			`\| --------\| :----- \| :---- \|`
部分接入或测试中的用户 2021-06-21 23:40:11 +08:00			`\| 1.1 \| 兰州现代职业学院 \| 院校 \|`
readme 2021-08-03 09:49:56 +08:00			`\| 1.2 \| 长春职业技术学院 \| 院校 \|`
readme 2021-09-15 16:08:13 +08:00			`\| 1.3 \| 德清智慧教育平台 \| 教育 \|`
readme update 2021-07-23 15:19:35 +08:00			`\| 2.1 \| 深圳市金溢科技股份有限公司 \| 企业 \|`
			`\| 2.2 \| 之江实验室 \| 企业 \|`
			`\| 2.3 \| 深圳市中悦科技有限公司 \| 企业 \|`
readme 2021-09-15 16:08:13 +08:00			`\| 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 \| 江西云车科技有限公司 \| 科技 \|`
			`\| 4.5 \| NGROK(ngrok.io) \| 科技 \|`
			`\| 5.1 \| 王朔日记 \| 个人 \|`
			`\| 5.2 \| 一席南风（张彬） \| 个人 \|`
			`\| 5.3 \| glzpcw \| 个人 \|`
			`\| 5.4 \| ynduck \| 个人 \|`