mirror of https://gitee.com/topiam/eiam
240 lines
13 KiB
Markdown
240 lines
13 KiB
Markdown
<div align="center">
|
||
|
||
<img src="https://user-images.githubusercontent.com/30397655/205442696-ccd32d07-2f7b-4335-8083-cac1d740b824.jpg" alt="logo" width="60%"/>
|
||
|
||
[](https://www.oracle.com/au/java/technologies/javase/jdk17-archive-downloads.html)
|
||
[](https://www.mysql.com/downloads/)
|
||
[](https://github.com/topaim/eiam/blob/master/LICENSE)
|
||
[](https://maven.apache.org)
|
||
|
||
[官方网站](https://eiam.topiam.cn) | [需求收集](https://github.com/topiam/eiam/issues/new) | [问题反馈](https://github.com/topiam/eiam/issues/new)
|
||
|
||
</div>
|
||
|
||
--------------------------
|
||
|
||
<div align="center">⭐️ 如果你喜欢 TopIAM，请给它一个 Star，您的支持将是我们前行的动力，项目正在积极开发，欢迎共建 👏🏻。</div>
|
||
|
||
--------------------------
|
||
|
||
## 项目介绍
|
||
|
||
**TopIAM** 数字身份管控平台，简称：EIAM（Employee Identity and Access Management），
|
||
用于管理企业内员工账号、权限、身份认证、应用访问，帮助整合部署在本地或云端的内部办公系统、业务系统及三方 SaaS
|
||
系统的所有身份，实现一个账号打通所有应用的服务。
|
||
|
||
## 产品价值
|
||
|
||
传统企业 IT
|
||
大多采用烟囱式建设方式，各系统独立建设账号体系、权限体系，当企业团队人数达到数十人至数百人时，由于系统数量多，在账户、密码、权限管理上会出现瓶颈。员工入职、离职，转岗都需要进行账号权限分配等此类管理，操作低效、功能重复、价值低，员工需要记录多套系统密码，容易出现安全问题，导致数据外泄。用户身份认证安全存疑，敏感系统缺乏严格的身份认证机制。
|
||
|
||
`EIAM` 提供一套集中式账号、权限、认证、应用、审计等，帮助企业打通身份数据孤岛，实现用户全生命周期，实现一个账号打通所有应用的服务，强化企业安全体系，提升组织管理效率，助力企业数字化转型升级。
|
||
|
||
## 核心特性
|
||
|
||
+ 提供统一组织信息管理，多维度建立对应关系，实现在一个平台对企业人员、组织架构、应用信息的高效统一管理。
|
||
+ 支持钉钉、飞书、企业微信等身份源集成能力，实现系统和企业OA平台数据联动，以用户为管理基点，结合入职、离职、调岗、兼职等人事事件，关联其相关应用权限变化而变化，保证应用访问权限的安全控制。
|
||
+ 支持多因素认证，行为验证码、社交认证，融合认证等机制，保证用户认证安全可靠。
|
||
+ 支持微信、微博、QQ等社交认证集成，使企业具有快速纳入互联网化认证能力。
|
||
+ 支持 `SAML2`，`OAuth2`，`OIDC`，`CAS`，表单代填等认证协议及机制，实现单点登录功能，预配置大量 SaaS 应用及传统应用模板，开箱即用。
|
||
+ 完善的安全审计，详尽记录每一次用户行为，使每一步操作有据可循，实时记录企业信息安全状况，精准识别企业异常访问和潜在威胁的源头。
|
||
+ 提供标准`REST`和`SCIM2.0`接口轻松完成机构用户同步，实现企业对于账号生命周期的精细化管理。
|
||
+ 开源、安全、自主可控。
|
||
|
||
|
||
## 页面展示
|
||
|
||
> 仅展示部分UI页面
|
||
|
||
+ 管理端
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
--------------------------
|
||
|
||
+ 门户端
|
||
|
||
|
||
|
||
## 在线演示
|
||
|
||
+ 管理端：https://eiam-console.topiam.cn
|
||
+ 用户端：https://eiam-portal.topiam.cn
|
||
|
||
> 注意：演示环境已屏蔽敏感权限和相关操作
|
||
|
||
## 开源说明
|
||
|
||
一方面希望通过开源加强项目产品化程度；另一方面希望在社区中吸收更多的实践场景进而继续完善产品，也欢迎大家参与到项目中来。
|
||
|
||
为保证社区繁荣和项目自由健康发展，在开源许可证方面，`TopIAM` 选择采用 `AGPL-3.0` 开源协议，`AGPL-3.0` 是 OSI
|
||
批准的许可证，符合自由和开源软件的所有标准，**开源永远是我们的初心与核心，我们将始终不渝的坚持去做这件事，我们相信在社区的推动下，这件事我们一定会做的更好**。
|
||
|
||
或许很多开发者对此协议抱有一些疑问，开源社区目前也有很多采用 `AGPL-3.0` 协议的开源软件，例如 `MongoDB`、`Grafana`、`Loki`
|
||
等，维基百科还专门有一份列表列出了哪些[开源项目](https://en.wikipedia.org/wiki/Category:Software_using_the_GNU_AGPL_license)
|
||
采用了 `AGPL-3.0` 开源协议。
|
||
|
||
`AGPL-3.0` 协议有一个非常关键的点，即对修改上游开源项目代码后的二次分发版本必须也要开源，协议限制的是部分企业想 `Folk`
|
||
开源项目代码后进行闭源商业分发，跟上游开源项目的维护团队进行直接的商业竞争，如果仅仅只是企业内部自己使用而不进行任何层面修改，用户大可不必担心 `AGPL-3.0`
|
||
协议带来的限制， 这些条件旨在鼓励和希望修改软件的第三方也为项目和社区做出贡献。我们认为这是一种更公平的前进方式，我们相信这将有助于我们建立更强大的社区。
|
||
|
||
简单来讲：如果您修改了 `TopIAM` 项目源代码，那么您必须将这些修改贡献给社区，**绝不允许修改后和衍生的代码做为闭源的商业软件发布和销售**。
|
||
|
||
我们也提供了商业授权，如果您**需要将本产品进行二次开发、更改并进行任何附带商业化性质行为使用**
|
||
，请联系我们进行商业授权，以遵守 `AGPL-3.0` 协议保证您的正常使用。
|
||
|
||
除此之外，我们也会酌情接受根据个人或企业需求的定制化开发。
|
||
|
||
目前在国内 `GPL` 协议**具备合同特征，是一种民事法律行为** ，属于我国《合同法》调整的范围。 `TopIAM` 项目团队保留诉讼权利。
|
||
|
||
[相关案例：违反 `GPL` 协议赔偿 50 万，国内首例！](https://mp.weixin.qq.com/s/YQ6sNjbDS-P7BViLZIsaoA)
|
||
|
||
> **TopIAM 开源团队拥有对本开源协议的最终解释权。**
|
||
|
||
## 技术架构
|
||
|
||
前端技术栈：`ES6`、`React`、`TypeScript`、`UmiJS`、`Axios`、`Ant Design`；
|
||
|
||
后端技术栈：`JDK17`、`Spring Boot`、`Spring Data`、`Spring Security`、`Elasticsearch`、`Redis`、`MySQL`；
|
||
|
||
## 模块说明
|
||
|
||
```
|
||
eiam
|
||
├── eiam-alert -- 报警模块
|
||
├── eiam-application -- 应用模块
|
||
├ ├── eiam-application-all -- 应用聚合模块
|
||
├ ├── eiam-application-core -- 应用核心模块
|
||
├ ├── eiam-application-cas -- cas应用模块
|
||
├ ├── eiam-application-form -- form应用模块
|
||
├ ├── eiam-application-jwt -- jwt应用模块
|
||
├ ├── eiam-application-oidc -- oidc应用模块
|
||
├ ├── eiam-application-saml2 -- saml2应用模块
|
||
├── eiam-audit -- 日志审计模块
|
||
├── eiam-authentication -- 身份认证模块
|
||
├ ├── eiam-authentication-all -- 身份认证聚合模块
|
||
├ ├── eiam-authentication-core -- 身份认证核心模块
|
||
├ ├── eiam-authentication-dingtalk -- 钉钉身份认证模块
|
||
├ ├── eiam-authentication-feishu -- 飞书身份认证模块
|
||
├ ├── eiam-authentication-qq -- qq身份认证模块
|
||
├ ├── eiam-authentication-wechat -- 微信身份认证模块
|
||
├ ├── eiam-authentication-wechatwork -- 企业微信身份认证模块
|
||
├ ├── eiam-authentication-sms -- 短信身份认证模块
|
||
├ ├── eiam-authentication-mfa -- MFA身份认证模块
|
||
├── eiam-common -- 公共模块
|
||
├── eiam-console -- 控制台服务
|
||
├── eiam-core -- 核心模块
|
||
├── eiam-identity-source -- 身份源模块
|
||
├ ├── eiam-identity-source-all -- 身份源聚合模块模块
|
||
├ ├── eiam-identity-source-core -- 身份源对接核心模块
|
||
├ ├── eiam-identity-source-dingtalk -- 钉钉身份源模块
|
||
├ ├── eiam-identity-source-wechatwork -- 企业微信身份源模块
|
||
├ ├── eiam-identity-source-feishu -- 飞书身份源模块
|
||
├── eiam-openapi -- OpenAPI服务
|
||
├── eiam-portal -- 门户端服务
|
||
├── eiam-protocol -- 协议模块
|
||
├ ├── eiam-protocol-all -- 协议聚合模块
|
||
├ ├── eiam-protocol-core-- 协议核心模块
|
||
├ ├── eiam-protocol-cas -- cas协议模块
|
||
├ ├── eiam-protocol-form -- form协议模块
|
||
├ ├── eiam-protocol-jwt -- jwt协议模块
|
||
├ ├── eiam-protocol-oidc -- oidc协议模块
|
||
├ ├── eiam-protocol-saml2 -- saml2协议模块
|
||
├── eiam-support -- support模块
|
||
└── eiam-synchronizer -- 同步服务
|
||
```
|
||
|
||
## 快速启动
|
||
|
||
### 下载项目
|
||
|
||
``` shell
|
||
git clone https://gitee.com/topiam/eiam.git
|
||
```
|
||
|
||
### 配置参数
|
||
|
||
application.yml文件依次修改以下配置
|
||
* database 配置
|
||
* redis 配置
|
||
* elasticsearch 配置
|
||
|
||
>项目使用 [liquibase](https://www.liquibase.org/) 管理数据库，新建`eiam_develop`数据库 不需要手动创建表结构，服务启动后，会自动创建表结构。
|
||
|
||
### 启动项目
|
||
|
||
* eiam-openapi (必选)
|
||
* eiam-console (必选)
|
||
* eiam-protal (必选)
|
||
* eiam-synchronizer（可选）
|
||
|
||
> 项目启动没有依赖顺序
|
||
|
||
项目启动完毕后，控制台会打印出访问地址
|
||
|
||
`eiam-console` 服务启动后，控制台会打印出控制台端管理员的初始化密码，及初始化密码内容文件存储位置。
|
||
|
||
|
||
|
||
|
||
## 联系我们
|
||
|
||
如果您在 `TopIAM` 产品上的任何想法、意见建议，商务上的合作需求，请扫码添加下方微信进一步沟通。
|
||
|
||
|
||
|
||
欢迎关注 TopIAM 微信公众号，接收产品最新动态。
|
||
|
||
|
||
|
||
## 加入社群
|
||
|
||
|
||
|
||
## 参与贡献
|
||
|
||
我们强烈欢迎有兴趣的开发者参与到项目建设中来，同时欢迎大家对项目提出宝贵意见建议和功能需求，项目正在积极开发，欢迎 PR 👏。
|
||
|
||
强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545)
|
||
和 [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393)
|
||
，更好的问题更容易获得帮助。
|
||
|
||
## License
|
||
|
||
<img src='https://www.gnu.org/graphics/agplv3-with-text-162x68.png' alt="license">
|
||
|
||
## 捐赠支持
|
||
|
||
如果您觉得我们的开源项目对您有帮助，那就请项目开发者们来一杯咖啡☕️吧！当前我们接受来自于**微信**、**支付宝**或者**码云**
|
||
的捐赠，请在捐赠时备注自己的昵称或附言。
|
||
|
||
您的捐赠将用于支付该项目的一些费用支出，并激励开发者们更好的推动项目的发展，同时欢迎捐赠**公网服务器**
|
||
用于提高开发基础设施环境及在线演示系统体验。
|
||
|
||
|
||
|
||
|
||
## 常见错误
|
||
|
||
1、项目启动：java.lang.IllegalArgumentException: topiam.server.console-public-base-url must be configured!
|
||
|
||
解决方案：application.yml 配置文件中需要对报错的信息地址进行完善
|
||
- console-public-base-url (后台前端服务域名，可配置IP+端口）
|
||
- portal-public-base-url (门户前台服务域名，可配置IP+端口）
|
||
- openapi-public-base-url (后台服务域名，可配置IP+端口）
|
||
- synchronizer-public-base-url (同步认证源服务域名，可配置IP+端口）
|
||
|
||
2、提示 cn.topiam.employee.common.entity.* 相关包缺失
|
||
|
||
因项目用到了 `QueryDSL` 查询框架，需要进行编译。
|
||
|
||
解决方案：
|
||
- 使用命令 `mvn compile`之后，自动生成代码，对应的代码目标在target/generated-sources目录下。
|
||
- 通过 IDEA 选中其目录，Mark Directory as -> generated sources root 。
|
||
- 通过 IDEA 工具类中File -> Invalidate Caches 清理缓存(可选操作) |