Files
MaxKey/README.md

128 lines
5.5 KiB
Markdown
Raw Normal View History

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-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.
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-06 20:05:00 +08:00
<b> Single Sign On </b>, referred to as <b> SSO </b >.
2020-11-24 22:01:40 +08:00
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-05-10 09:34:58 +08:00
| --------| :----- | :----: |
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
2021-05-10 09:34:58 +08:00
| 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/Dingding/Google/Facebook/other |
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
2020-11-24 22:01:40 +08:00
7. Based on Java platform, Adopts Spring, MySQL, Tomcat, Apache Kafka, Redis 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
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>
2021-05-10 09:42:16 +08:00
2020-11-24 22:01:40 +08:00
| Version | ReleaseDate | Download URL | Code |
2020-02-18 10:17:49 +08:00
| --------| :----- | :---- | :----: |
2021-05-30 09:51:20 +08:00
| v 2.8.0 RC1 | 2021/06/01 | <a href="https://pan.baidu.com/s/1fMr45bhahVWpdcTxXDxP9Q" target="_blank">Download</a> | **06ms** |
2020-06-13 09:27:20 +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
2020-12-26 18:13:08 +08:00
1. Zero trust scenario integration
2020-09-23 23:32:46 +08:00
2020-12-26 18:13:08 +08:00
2. Maxkey-Cloud (micro service version)-2021
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-06-21 23:34:28 +08:00
| 序号 | 单位 | 性质 |
| --------| :----- | :----: |
2021-06-21 23:40:11 +08:00
| 1.1 | 兰州现代职业学院 | 院校 |
| 1.2 | 无锡立信高等职业技术学校 | 院校 |
2021-06-21 23:34:28 +08:00
| 2.1 | 武汉英特沃科技有限公司 | 企业 |
| 2.2 | 江苏创致信息科技有限公司 | 企业 |
| 2.3 | 之江实验室 | 企业 |
| 2.4 | 遂宁市经济大数据平台 | 企业 |
| 2.5 | 同方节能工程技术有限公司 | 企业 |
| 2.6 | 云南航天工程物探检测股份有限公司 | 企业 |
| 2.7 | 华夏金融租赁有限公司 | 企业 |
| 2.8 | 宁波金融资产交易中心 | 企业 |
| 2.9 | 山东港口陆海国际物流集团有限公司 | 企业 |
| 2.10 | 深圳市中悦科技有限公司 | 企业 |
| 3.1 | 王朔日记 | 个人 |
2021-06-22 07:40:38 +08:00
| 3.2 | 一席南风(张彬) | 个人 |
| 3.3 | glzpcw | 个人 |
| 3.4 | ynduck | 个人 |