Skip to content

Latest commit

 

History

History
204 lines (153 loc) · 8.94 KB

README_CN.md

File metadata and controls

204 lines (153 loc) · 8.94 KB
Raw

IAM (Identity Authentication and Access Identification Management)

一个企业级开源统一身份认证和访问控制管理平台，开箱即用，支持微信/qq/google/facebook等其他SNS和openldap联合认证，AOP实现API级多因素认证；其中，增强企业级网关模块：支持如基于金丝雀请求响应缓存过滤器、金丝雀负载均衡器、通用签名认证过滤器、oidc v1/oauth2.x 认证过滤器、ip 过滤器、流量复制过滤器、基于配额请求限制器过滤器、基于金丝雀故障注入器过滤器、基于金丝雀人性化日志过滤器；其中消息总线和基于Flink/Kafka/Pulsar/Rabbitmq/HBase/ES/Hive等实时分析模块，支持如异常事件或风险实时告警预警，以及历史事件分析报告等。

温馨提示：目前最新版及文档正在整理完善中，建议首先在测试环境部署，如有问题或建议请提交 Issue

IAM

A enterprise-level universal unified authentication and authorization 5A management platform based on cloud native and Spring Cloud.
-- Home Page --

English version goes here

1. Features

    1. 简洁：API直观简洁，可快速上手
    1. 轻量级：环境依赖小，部署与接入成本较低
    1. 单点登录：只需要登录一次就可以访问所有相互信任的应用系统
    1. 分布式：接入 IAM/SSO 认证中心的应用，支持分布式部署
    1. HA：Server端与Client端，均支持集群部署，提高系统可用性
    1. 跨域：支持跨域应用接入 IAM/SSO 认证中心
    1. Cookie+Token均支持：支持基于Cookie和基于Token两种接入方式，并均提供Sample项目
    1. Web+APP均支持：支持Web和APP接入
    1. 实时性：系统登陆、注销状态，全部有IAM Server统一控制，与Client端准同步
    1. CS结构：基于CS结构，包括Server"认证中心"与Client"受保护应用"
    1. 路径排除：支持自定义多个排除路径，支持Ant表达式。用于排除 IAM/SSO 客户端不需要过滤的路径
    1. 支持多种模式部署运行（local模式）：传统单体应用，没有认证客户端一说，即，IAM server与BizApp在同一JVM进程，好处是部署、运维简单，适合小型管理类项目。
    1. 支持多种模式部署运行（cluster模式）：将认证中心与业务应用和认证客户端分离，即，IAM client与BizApp在同一JVM进程，IAM server在一个进程，适合微服务或跨站跨域的多应用需要统一认证的情况。
    1. 支持多种模式部署运行（gateway模式）：与cluster类似，区别是将认证客户端放到了网关，使BizApp专注于提供业务服务，实现了网关、业务应用、认证中心的完全分离， 即，gateway+IAM client、BizApp、IAM server，非常适合完全微服务架构的认证中心部署（量身定制）
    1. OIDC 支持
    1. 对比 keycloak 请参考这里

2. 服务端部署

  • Docker 部署

TODO

  • 主机部署

TODO

3. 客户端集成

3.1 Gateway 模式 (推荐)

此模式的架构哲学是 sidecar，以业务层和通用层尽量分离为思想，在传统企业应用中，由于业务应用代码与各认证、中间件等 SDK 是以依赖的形式强耦合，导致 SDK 升级难、易出错等，严重影响业务应用的快速迭代和服务的稳定性，而使用 gateway 将认证等通用逻辑分离，让其只专注于业务逻辑，极大降低大规模微服务部署出错概率，同时各组件由不同团队专人维护有助于稳定性及快速迭代能力极大提升，让企业收益最大化。

TODO

3.1 Spring Boot sdk 模式

<dependency>
    <groupId>com.wl4g</groupId>
    <artifactId>iam-client-springboot</artifactId>
    <version>${latest}</version>
</dependency>

4. 认证机制原理

TODO

5. 运维、监控、可观测

export OTEL_TRACES_EXPORTER=jaeger
export OTEL_EXPORTER_JAEGER_ENDPOINT=http://localhost:14250
export OTEL_EXPORTER_JAEGER_TIMEOUT=10000
export OTEL_METRICS_EXPORTER=prometheus
export OTEL_EXPORTER_PROMETHEUS_HOST=localhost
export OTEL_EXPORTER_PROMETHEUS_PORT=9090
java -javaagent:/opt/apps/some-javaagent/opentelemetry/opentelemetry-javaagent.jar -jar iam-web-{version}-bin.jar

6. 开发者指南

Maven mirrors 配置

mv $HOME/.m2/settings.xml $HOME/.m2/settings_bak.xml

cat <<-'EOF' >$HOME/.m2/settings.xml
<mirrors>
    <mirror>
        <id>alimaven-public</id>
        <mirrorOf>public</mirrorOf>
        <name>alimaven</name>
        <url>https://maven.aliyun.com/repository/public</url>
    </mirror>
    <mirror>
        <id>alimaven-central</id>
        <mirrorOf>central</mirrorOf>
        <name>alimaven</name>
        <url>https://maven.aliyun.com/repository/central</url>
    </mirror>
    <mirror>
        <id>alimaven-grails-core</id>
        <mirrorOf>grails-core</mirrorOf>
        <name>aliyun maven</name>
        <url>https://maven.aliyun.com/repository/grails-core</url>
    </mirror>
    <mirror>
        <id>alimaven-google</id>
        <mirrorOf>google</mirrorOf>
        <name>aliyun maven</name>
        <url>https://maven.aliyun.com/repository/google</url>
    </mirror>
    <mirror>
        <id>alimaven-spring</id>
        <mirrorOf>spring</mirrorOf>
        <name>aliyun maven</name>
        <url>https://maven.aliyun.com/repository/spring</url>
    </mirror>
  </mirrors>
EOF

构建发布包

cd iam

# 构建通用发布包(目录结构)
mvn -U clean install -DskipTests -T 2C -P build:tar -Pbuild:framework:feign-istio

# 构建 spring 单可执行 jar
mvn -U clean install -DskipTests -T 2C -P build:springjar -Pbuild:framework:feign-istio

# 构建 mvnAssTar 的 docker 镜像
mvn -U clean install -DskipTests -T 2C -P build:tar:docker -Pbuild:framework:feign-istio

# 构建 ELF native 执行文件
mvn -U clean install -DskipTests -T 2C -P build:native -Pbuild:framework:feign-istio

  • Supports profiles are:

    • -Pbuild:tar
    • -Pbuild:springjar
    • -Pbuild:tar:docker
    • -Pbuild:native (alpha)
    • -Pbuild:framework:feign-istio
    • -Pbuild:framework:feign-springcloud
    • -Pbuild:framework:feign-dubbo

7.1 将服务端以 SDK 集成定制开发

  • 5.1，独立运行模式，使用iam的数据库表，适用于新系统集成;

  • 5.2，依赖嵌入模式，使用外部自定义数据库表，适用于旧系统改造集成;

TODO

Development

于2018年初，我在github上创建 IAM 项目仓库并提交第一个commit，随之进行系统结构设计，UI选型，交互设计…… 至今，IAM/SSO 已接入某物联网平台的生产环境，稳定运行1year+，接入场景如电商业务，O2O业务和核心中间件配置动态化等。 欢迎大家的关注和使用，IAM/SSO也将拥抱变化，持续发展。

Contributing

欢迎参与项目贡献！比如提交PR修复一个bug，或者新建 Issue 讨论新特性或者变更。

Copyright and License

This product is open source and free, and will continue to provide free community technical support. Individual or enterprise users are free to access and use.

  • Licensed under the Apache License v2.
  • Copyright (c) 2018-present, wanglsir.

产品开源免费，并且将持续提供免费的社区技术支持。个人或企业内部可自由的接入和使用。

Stargazers over time

Stargazers over time