From 358f88a96d8ff7e5c6043ddd0c8e4345c84cd830 Mon Sep 17 00:00:00 2001 From: "Crystal.Sea" Date: Tue, 24 Nov 2020 22:01:40 +0800 Subject: [PATCH] README --- README.md | 109 +++++++++++++++++++++++++-------------------------- README_en.md | 104 ++++++++++++++++++++++++++++++++++++++++++++++++ README_zh.md | 105 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 263 insertions(+), 55 deletions(-) create mode 100644 README_en.md create mode 100644 README_zh.md diff --git a/README.md b/README.md index 7099603a6..96b23a8b7 100644 --- a/README.md +++ b/README.md @@ -1,105 +1,104 @@ # -# 概述 +# Overview -MaxKey(马克思的钥匙)单点登录认证系统(Single Sign On System)，寓意是最大钥匙,是业界领先的企业级IAM身份管理和身份认证产品,支持OAuth 2.0/OpenID Connect、SAML 2.0、JWT、CAS、SCIM等标准协议，提供简单、标准、安全和开放的用户身份管理(IDM)、身份认证(AM)、单点登录(SSO)、RBAC权限管理和资源管理等。 +Maxkey (Marx's key) Single Sign On system, which means the Maximum key, Leading-Edge IAM Identity and Access management product , Support OAuth 2.0/OPENID CONNECT, SAML 2.0, JWT, CAS, SCIM and other standard protocols, and provide Simple, Standard, Secure and Open Identity management (IDM), Access management (AM), Single Sign On (SSO), RBAC permission management and Resource management. -官方网站 官方网站 | 官方网站二线 +Official Website official website | Second Line -社区交流 QQ群：434469201 | 邮箱EMAIL: maxkeysupport@163.com +QQ Community: 434469201 | email: maxkeysupport@163.com -代码托管 GitHub | 码云(Gitee) +Code Hosting GitHub | Gitee - -什么是单点登录(Single Sign On），简称为SSO？ +What is Single Sign On , referred to as SSO ? + +Users only need to login to the authentication center once , access all the trusted application systems without logging in again. -用户只需要登录认证中心一次就可以访问所有相互信任的应用系统，无需再次登录。 - -主要功能： +Key Functions -1) 所有应用系统共享一个身份认证系统 +1) All application systems share one Identity authentication system -2) 所有应用系统能够识别和提取ticket信息 +2) All application systems can Identify and extract Ticket -# 产品特性 +# Features -1. 标准认证协议： +1. Standard Protocols -| 序号 | 协议 | 支持 | +| No. | Protocols | Support | | --------| :----- | :----: | -| 1.1 | OAuth 2.0/OpenID Connect | 高 | -| 1.2 | SAML 2.0 | 高 | -| 1.3 | JWT | 高 | -| 1.4 | CAS | 高 | -| 1.5 | FormBased | 中 | -| 1.6 | TokenBased(Post/Cookie) | 中 | -| 1.7 | ExtendApi | 低 | -| 1.8 | EXT | 低 | - -2. 登录支持 - -| 序号 | 登录方式 | +| 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 | | --------| :----- | -| 2.1 | 动态验证码 字母/数字/算术 | -| 2.2 | 双因素认证 | -| 2.3 | 短信认证 腾讯云短信/阿里云短信/网易云信 | -| 2.4 | 登录易/Google/Microsoft Authenticator/FreeOTP/支持TOTP或者HOTP | -| 2.5 | Kerberos/SPNEGO/AD域| -| 2.6 | 社交账号 微信/QQ/微博/钉钉/Google/Facebook/其他 | +| 2.1 | Captcha : letter / number / arithmetic | +| 2.2 | Two Factor Authentication | +| 2.3 | SMS Tencent SMS / Alibaba SMS / NetEaseYunXin | +| 2.4 | Denglu1/Google/Microsoft Authenticator/FreeOTP/Support TOTP or HOTP | +| 2.5 | Kerberos/SPNEGO/AD domain| +| 2.6 | Social Account WeChat/QQ/ Weibo/Dingding/Google/Facebook/other | -3. 提供标准的认证接口以便于其他应用集成SSO，安全的移动接入，安全的API、第三方认证和互联网认证的整合。 +3. Standard Authentication Protocols for applications to integrate sso, secure mobile access, secure API, third-party authentication and Internet authentication. -4. 提供用户生命周期管理，支持SCIM 2协议，基于Apache Kafka代理，通过连接器(Connector)实现身份供给同步。 +4. Identity Lifecycle management, support SCIM 2 , and realize Identity supply synchronization through connector based on Apache Kafka agent. -5. 认证中心具有平台无关性、环境多样性，支持Web、手机、移动设备等, 如Apple iOS，Andriod等，将认证能力从B/S到移动应用全面覆盖。 +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. 多种认证机制并存，各应用系统可保留原有认证机制，同时集成认证中心的认证；应用具有高度独立性，不依赖认证中心，又可用使用认证中心的认证，实现单点登录。 +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. 基于Java平台开发，采用Spring、MySQL、Tomcat、Apache Kafka、Redis等开源技术，支持微服务，扩展性强。 +7. Based on Java platform, Adopts Spring, MySQL, Tomcat, Apache Kafka, Redis and other open source technologies, supports microservices, and has strong scalability. -8. 许可证 Apache License, Version 2.0，开源、安全、自主可控。 +8. License Apache license, version 2.0, Open Source, Secure, Independent and Controllable. -# 界面 +# Interface -**MaxKey认证** +**MaxKey** -登录界面 +Login UI -主界面 +App List UI -**MaxKey管理** +**MaxKey Management** -访问报表 +Report UI -用户管理 +User Management UI -应用管理 +App Management UI -# 下载 +# Download -当前版本百度网盘下载, 历史版本 -| 版本 | 日期 | 下载地址 | 提取码 | +Download the current version of Baidu Pan, history version +| Version | ReleaseDate | Download URL | Code | | --------| :----- | :---- | :----: | -| v 2.3.0 GA | 2020/11/11 | 链接下载 | **h3zw** | +| v 2.3.0 GA | 2020/11/11 | Download | **h3zw** | # Roadmap -1.动态用户组实现(基于用户属性或机构) +1. Implementation of dynamic group (based on user attribute or organization) -2.主任职机构和兼职机构 +2. Director and part-time organizations -3.零信任场景整合 +3. Zero trust scenario integration -4.MaxKey Cloud(微服务版)-2021年 +4. Maxkey-Cloud (micro service version)-2021 diff --git a/README_en.md b/README_en.md new file mode 100644 index 000000000..96b23a8b7 --- /dev/null +++ b/README_en.md @@ -0,0 +1,104 @@ +# + +# Overview + +Maxkey (Marx's key) Single Sign On system, which means the Maximum key, Leading-Edge IAM Identity and Access management product , Support OAuth 2.0/OPENID CONNECT, SAML 2.0, JWT, CAS, SCIM and other standard protocols, and provide Simple, Standard, Secure and Open Identity management (IDM), Access management (AM), Single Sign On (SSO), RBAC permission management and Resource management. + +Official Website official website | Second Line + +QQ Community: 434469201 | email: maxkeysupport@163.com + +Code Hosting GitHub | Gitee + +What is Single Sign On , referred to as SSO ? + +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 | +| --------| :----- | +| 2.1 | Captcha : letter / number / arithmetic | +| 2.2 | Two Factor Authentication | +| 2.3 | SMS Tencent SMS / Alibaba SMS / NetEaseYunXin | +| 2.4 | Denglu1/Google/Microsoft Authenticator/FreeOTP/Support TOTP or HOTP | +| 2.5 | Kerberos/SPNEGO/AD domain| +| 2.6 | Social Account WeChat/QQ/ Weibo/Dingding/Google/Facebook/other | + + +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. License Apache license, version 2.0, Open Source, Secure, Independent and Controllable. + + +# Interface + +**MaxKey** + +Login UI + + +App List UI + + +**MaxKey Management** + +Report UI + + +User Management UI + + +App Management UI + + + +# Download + +Download the current version of Baidu Pan, history version +| Version | ReleaseDate | Download URL | Code | +| --------| :----- | :---- | :----: | +| v 2.3.0 GA | 2020/11/11 | Download | **h3zw** | + + +# Roadmap + +1. Implementation of dynamic group (based on user attribute or organization) + +2. Director and part-time organizations + +3. Zero trust scenario integration + +4. Maxkey-Cloud (micro service version)-2021 + + diff --git a/README_zh.md b/README_zh.md new file mode 100644 index 000000000..7099603a6 --- /dev/null +++ b/README_zh.md @@ -0,0 +1,105 @@ +# + +# 概述 + +MaxKey(马克思的钥匙)单点登录认证系统(Single Sign On System)，寓意是最大钥匙,是业界领先的企业级IAM身份管理和身份认证产品,支持OAuth 2.0/OpenID Connect、SAML 2.0、JWT、CAS、SCIM等标准协议，提供简单、标准、安全和开放的用户身份管理(IDM)、身份认证(AM)、单点登录(SSO)、RBAC权限管理和资源管理等。 + +官方网站 官方网站 | 官方网站二线 + +社区交流 QQ群：434469201 | 邮箱EMAIL: maxkeysupport@163.com + +代码托管 GitHub | 码云(Gitee) + + +什么是单点登录(Single Sign On），简称为SSO？ + +用户只需要登录认证中心一次就可以访问所有相互信任的应用系统，无需再次登录。 + +主要功能： + +1) 所有应用系统共享一个身份认证系统 + +2) 所有应用系统能够识别和提取ticket信息 + + +# 产品特性 + +1. 标准认证协议： + +| 序号 | 协议 | 支持 | +| --------| :----- | :----: | +| 1.1 | OAuth 2.0/OpenID Connect | 高 | +| 1.2 | SAML 2.0 | 高 | +| 1.3 | JWT | 高 | +| 1.4 | CAS | 高 | +| 1.5 | FormBased | 中 | +| 1.6 | TokenBased(Post/Cookie) | 中 | +| 1.7 | ExtendApi | 低 | +| 1.8 | EXT | 低 | + +2. 登录支持 + +| 序号 | 登录方式 | +| --------| :----- | +| 2.1 | 动态验证码 字母/数字/算术 | +| 2.2 | 双因素认证 | +| 2.3 | 短信认证 腾讯云短信/阿里云短信/网易云信 | +| 2.4 | 登录易/Google/Microsoft Authenticator/FreeOTP/支持TOTP或者HOTP | +| 2.5 | Kerberos/SPNEGO/AD域| +| 2.6 | 社交账号 微信/QQ/微博/钉钉/Google/Facebook/其他 | + + +3. 提供标准的认证接口以便于其他应用集成SSO，安全的移动接入，安全的API、第三方认证和互联网认证的整合。 + +4. 提供用户生命周期管理，支持SCIM 2协议，基于Apache Kafka代理，通过连接器(Connector)实现身份供给同步。 + +5. 认证中心具有平台无关性、环境多样性，支持Web、手机、移动设备等, 如Apple iOS，Andriod等，将认证能力从B/S到移动应用全面覆盖。 + +6. 多种认证机制并存，各应用系统可保留原有认证机制，同时集成认证中心的认证；应用具有高度独立性，不依赖认证中心，又可用使用认证中心的认证，实现单点登录。 + +7. 基于Java平台开发，采用Spring、MySQL、Tomcat、Apache Kafka、Redis等开源技术，支持微服务，扩展性强。 + +8. 许可证 Apache License, Version 2.0，开源、安全、自主可控。 + + +# 界面 + +**MaxKey认证** + +登录界面 + + +主界面 + + +**MaxKey管理** + +访问报表 + + +用户管理 + + +应用管理 + + + +# 下载 + +当前版本百度网盘下载, 历史版本 +| 版本 | 日期 | 下载地址 | 提取码 | +| --------| :----- | :---- | :----: | +| v 2.3.0 GA | 2020/11/11 | 链接下载 | **h3zw** | + + +# Roadmap + +1.动态用户组实现(基于用户属性或机构) + +2.主任职机构和兼职机构 + +3.零信任场景整合 + +4.MaxKey Cloud(微服务版)-2021年 + + -- GitLab