Apollo是配置管理系统，会提供权限管理（Authorization），理论上是不负责用户登录认证功能的实现（Authentication）。

所以Apollo定义了一些SPI用来解耦，Apollo接入登录的关键就是实现这些SPI。

实现方式一：使用Apollo提供的Spring Security简单认证

可能很多公司并没有统一的登录认证系统，如果自己实现一套会比较麻烦。Apollo针对这种情况，从0.9.0开始提供了利用Spring Security实现的Http Basic简单认证版本。

使用步骤如下：

1. 安装0.9.0以上版本

如果之前是0.8.0版本，需要导入apolloportaldb-v080-v090.sql

查看ApolloPortalDB，应该已经存在Users表，并有一条初始记录。初始用户名是apollo，密码是admin。

Id Username Password Email Enabled
1 apollo $2a$10$7r20uS.BQ9uBpf3Baj3uQOZvMVvB1RN3PYoKE94gtz2.WAOuiiwXS apollo@acme.com 1

2. 重启Portal

如果是IDE启动的话，确保-Dapollo_profile=github,auth

3. 添加用户

超级管理员登录系统后打开管理员工具 - 用户管理即可添加用户。

4. 修改用户密码

超级管理员登录系统后打开管理员工具 - 用户管理，输入用户名和密码后即可修改用户密码，建议同时修改超级管理员apollo的密码。

实现方式二： 接入LDAP

从1.2.0版本开始，Apollo支持了ldap协议的登录，按照如下方式配置即可。

如果采用helm chart部署方式，建议通过配置方式实现，不用修改镜像，可以参考启用 LDAP 支持

1. OpenLDAP接入方式

1.1 配置application-ldap.yml

解压apollo-portal-x.x.x-github.zip后，在config目录下创建application-ldap.yml，内容参考如下（样例），相关的内容需要按照具体情况调整：

  1. spring:
  2.   ldap:
  3.     base: "dc=example,dc=org"
  4.     username: "cn=admin,dc=example,dc=org" # 配置管理员账号，用于搜索、匹配用户
  5.     password: "password"
  6.     searchFilter: "(uid={0})"  # 用户过滤器，登录的时候用这个过滤器来搜索用户
  7.     urls:
  8.     - "ldap://localhost:389"
  10. ldap:
  11.   mapping: # 配置 ldap 属性
  12.     objectClass: "inetOrgPerson" # ldap 用户 objectClass 配置
  13.     loginId: "uid" # ldap 用户惟一 id，用来作为登录的 id
  14.     userDisplayName: "cn" # ldap 用户名，用来作为显示名
  15.     email: "mail" # ldap 邮箱属性
1.1.1 基于memberOf过滤用户

OpenLDAP开启memberOf特性后，可以配置filter从而缩小用户搜索的范围：

  1. spring:
  2.   ldap:
  3.     base: "dc=example,dc=org"
  4.     username: "cn=admin,dc=example,dc=org" # 配置管理员账号，用于搜索、匹配用户
  5.     password: "password"
  6.     searchFilter: "(uid={0})"  # 用户过滤器，登录的时候用这个过滤器来搜索用户
  7.     urls:
  8.     - "ldap://localhost:389"
  10. ldap:
  11.   mapping: # 配置 ldap 属性
  12.     objectClass: "inetOrgPerson" # ldap 用户 objectClass 配置
  13.     loginId: "uid" # ldap 用户惟一 id，用来作为登录的 id
  14.     userDisplayName: "cn" # ldap 用户名，用来作为显示名
  15.     email: "mail" # ldap 邮箱属性
  16.   filter: # 配置过滤，目前只支持 memberOf
  17.     memberOf: "cn=ServiceDEV,ou=DEV,dc=example,dc=org|cn=WebDEV,ou=DEV,dc=example,dc=org" # 只允许 memberOf 属性为 ServiceDEV 和 WebDEV 的用户访问
1.1.2 基于Group过滤用户

从1.3.0版本开始支持基于Group过滤用户，从而可以控制只有特定Group的用户可以登录和使用apollo：

  1. spring:
  2.   ldap:
  3.     base: "dc=example,dc=org"
  4.     username: "cn=admin,dc=example,dc=org" # 配置管理员账号，用于搜索、匹配用户
  5.     password: "password"
  6.     searchFilter: "(uid={0})"  # 用户过滤器，登录的时候用这个过滤器来搜索用户
  7.     urls:
  8.     - "ldap://localhost:389"
  10. ldap:
  11.   mapping: # 配置 ldap 属性
  12.     objectClass: "inetOrgPerson" # ldap 用户 objectClass 配置
  13.     loginId: "uid" # ldap 用户惟一 id，用来作为登录的 id
  14.     rdnKey: "uid" # ldap rdn key
  15.     userDisplayName: "cn" # ldap 用户名，用来作为显示名
  16.     email: "mail" # ldap 邮箱属性
  17.   group: # 启用group search，启用后只有特定group的用户可以登录apollo
  18.     objectClass: "posixGroup"  # 配置groupClassName
  19.     groupBase: "ou=group" # group search base
  20.     groupSearch: "(&(cn=dev))" # group filter
  21.     groupMembership: "memberUid" # group memberShip eg. member or memberUid

1.2 配置startup.sh

修改scripts/startup.sh，指定spring.profiles.active为github,ldap。

  1. SERVICE_NAME=apollo-portal
  2. ## Adjust log dir if necessary
  3. LOG_DIR=/opt/logs/100003173
  4. ## Adjust server port if necessary
  5. SERVER_PORT=8070
  7. export JAVA_OPTS="$JAVA_OPTS -Dspring.profiles.active=github,ldap"

2. Active Directory接入方式

2.1 配置application-ldap.yml

解压apollo-portal-x.x.x-github.zip后，在config目录下创建application-ldap.yml，内容参考如下（样例），相关的内容需要按照具体情况调整：

  1. spring:
  2.   ldap:
  3.     base: "dc=example,dc=com"
  4.     username: "admin" # 配置管理员账号，用于搜索、匹配用户
  5.     password: "password"
  6.     searchFilter: "(sAMAccountName={0})"  # 用户过滤器，登录的时候用这个过滤器来搜索用户
  7.     urls:
  8.     - "ldap://1.1.1.1:389"
  10. ldap:
  11.   mapping: # 配置 ldap 属性
  12.     objectClass: "user" # ldap 用户 objectClass 配置
  13.     loginId: "sAMAccountName" # ldap 用户惟一 id，用来作为登录的 id
  14.     userDisplayName: "cn" # ldap 用户名，用来作为显示名
  15.     email: "userPrincipalName" # ldap 邮箱属性
  16.   filter: # 可选项，配置过滤，目前只支持 memberOf
  17.     memberOf: "CN=ServiceDEV,OU=test,DC=example,DC=com|CN=WebDEV,OU=test,DC=example,DC=com" # 只允许 memberOf 属性为 ServiceDEV 和 WebDEV 的用户访问

2.2 配置startup.sh

修改scripts/startup.sh，指定spring.profiles.active为github,ldap。

  1. SERVICE_NAME=apollo-portal
  2. ## Adjust log dir if necessary
  3. LOG_DIR=/opt/logs/100003173
  4. ## Adjust server port if necessary
  5. SERVER_PORT=8070
  7. export JAVA_OPTS="$JAVA_OPTS -Dspring.profiles.active=github,ldap"

3. ApacheDS接入方式

3.1 配置application-ldap.yml

解压apollo-portal-x.x.x-github.zip后，在config目录下创建application-ldap.yml，内容参考如下（样例），相关的内容需要按照具体情况调整：

  1. spring:
  2.   ldap:
  3.     base: "dc=example,dc=com"
  4.     username: "uid=admin,ou=system" # 配置管理员账号，用于搜索、匹配用户
  5.     password: "password"
  6.     searchFilter: "(uid={0})"  # 用户过滤器，登录的时候用这个过滤器来搜索用户
  7.     urls:
  8.     - "ldap://localhost:10389"
  10. ldap:
  11.   mapping: # 配置 ldap 属性
  12.     objectClass: "inetOrgPerson" # ldap 用户 objectClass 配置
  13.     loginId: "uid" # ldap 用户惟一 id，用来作为登录的 id
  14.     userDisplayName: "displayName" # ldap 用户名，用来作为显示名
  15.     email: "mail" # ldap 邮箱属性
3.1.1 基于Group过滤用户

从1.3.0版本开始支持基于Group过滤用户，从而可以控制只有特定Group的用户可以登录和使用apollo：

  1. spring:
  2.   ldap:
  3.     base: "dc=example,dc=com"
  4.     username: "uid=admin,ou=system" # 配置管理员账号，用于搜索、匹配用户
  5.     password: "password"
  6.     searchFilter: "(uid={0})"  # 用户过滤器，登录的时候用这个过滤器来搜索用户
  7.     urls:
  8.     - "ldap://localhost:10389"
  10. ldap:
  11.   mapping: # 配置 ldap 属性
  12.     objectClass: "inetOrgPerson" # ldap 用户 objectClass 配置
  13.     loginId: "uid" # ldap 用户惟一 id，用来作为登录的 id
  14.     rdnKey: "cn" # ldap rdn key
  15.     userDisplayName: "displayName" # ldap 用户名，用来作为显示名
  16.     email: "mail" # ldap 邮箱属性
  17.   group: # 配置ldap group，启用后只有特定group的用户可以登录apollo
  18.     objectClass: "groupOfNames"  # 配置groupClassName
  19.     groupBase: "ou=group" # group search base
  20.     groupSearch: "(&(cn=dev))" # group filter
  21.     groupMembership: "member" # group memberShip eg. member or memberUid

3.2 配置startup.sh

修改scripts/startup.sh，指定spring.profiles.active为github,ldap。

  1. SERVICE_NAME=apollo-portal
  2. ## Adjust log dir if necessary
  3. LOG_DIR=/opt/logs/100003173
  4. ## Adjust server port if necessary
  5. SERVER_PORT=8070
  7. export JAVA_OPTS="$JAVA_OPTS -Dspring.profiles.active=github,ldap"

实现方式三： 接入OIDC

从 1.8.0 版本开始支持 OpenID Connect 登录, 这种实现方式的前提是已经部署了 OpenID Connect 登录服务
配置前需要准备:

1. 配置 application-oidc.yml

解压apollo-portal-x.x.x-github.zip后，在config目录下创建application-oidc.yml，内容参考如下（样例），相关的内容需要按照具体情况调整：

1.1 最小配置

  1. server:
  2.   # 解析反向代理请求头
  3.   forward-headers-strategy: framework
  4. spring:
  5.   security:
  6.     oauth2:
  7.       client:
  8.         provider:
  9.           # provider-name 是 oidc 提供者的名称, 任意字符均可, registration 的配置需要用到这个名称
  10.           <fill-in-the-provider-name-here>:
  11.             # 必须是 https, oidc 的 issuer-uri
  12.             # 例如 你的 issuer-uri 是 https://host:port/auth/realms/apollo/.well-known/openid-configuration, 那么此处只需要配置 https://host:port/auth/realms/apollo 即可, spring boot 处理的时候会加上 /.well-known/openid-configuration 的后缀
  13.             issuer-uri: https://host:port/auth/realms/apollo
  14.         registration:
  15.           # registration-name 是 oidc 客户端的名称, 任意字符均可, oidc 登录必须配置一个 authorization_code 类型的 registration
  16.           <fill-in-the-registration-name-here>:
  17.             # oidc 登录必须配置一个 authorization_code 类型的 registration
  18.             authorization-grant-type: authorization_code
  19.             client-authentication-method: basic
  20.             # client-id 是在 oidc 提供者处配置的客户端ID, 用于登录 provider
  21.             client-id: apollo-portal
  22.             # provider 的名称, 需要和上面配置的 provider 名称保持一致
  23.             provider: <fill-in-the-provider-name-here>
  24.             # openid 为 oidc 登录的必须 scope, 此处可以添加其它自定义的 scope
  25.             scope:
  26.               - openid
  27.             # client-secret 是在 oidc 提供者处配置的客户端密码, 用于登录 provider
  28.             # 从安全角度考虑更推荐使用环境变量来配置, 环境变量的命名规则为: 将配置项的 key 当中的 点(.)、横杠(-)替换为下划线(_), 然后将所有字母改为大写, spring boot 会自动处理符合此规则的环境变量
  29.             # 例如 spring.security.oauth2.client.registration.registration-name.client-secret -> SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_NAME_VDISK_CLIENT_SECRET (REGISTRATION_NAME 可以替换为自定义的 oidc 客户端的名称)
  30.             client-secret: d43c91c0-xxxx-xxxx-xxxx-xxxxxxxxxxxx

1.2 扩展配置

  • 如果 OpenID Connect 登录服务支持 client_credentials 模式, 还可以再配置一个 client_credentials 类型的 registration, 用于 apollo-portal 作为客户端请求其它被 oidc 保护的资源
  • 如果 OpenID Connect 登录服务支持 jwt, 还可以配置 ${spring.security.oauth2.resourceserver.jwt.issuer-uri}, 以支持通过 jwt 访问 apollo-portal
  1. server:
  2.   # 解析反向代理请求头
  3.   forward-headers-strategy: framework
  4. spring:
  5.   security:
  6.     oauth2:
  7.       client:
  8.         provider:
  9.           # provider-name 是 oidc 提供者的名称, 任意字符均可, registration 的配置需要用到这个名称
  10.           <fill-in-the-provider-name-here>:
  11.             # 必须是 https, oidc 的 issuer-uri, 和 jwt 的 issuer-uri 一致的话直接引用即可, 也可以单独设置
  12.             issuer-uri: ${spring.security.oauth2.resourceserver.jwt.issuer-uri}
  13.         registration:
  14.           # registration-name 是 oidc 客户端的名称, 任意字符均可, oidc 登录必须配置一个 authorization_code 类型的 registration
  15.           <fill-in-the-registration-name-here>:
  16.             # oidc 登录必须配置一个 authorization_code 类型的 registration
  17.             authorization-grant-type: authorization_code
  18.             client-authentication-method: basic
  19.             # client-id 是在 oidc 提供者处配置的客户端ID, 用于登录 provider
  20.             client-id: apollo-portal
  21.             # provider 的名称, 需要和上面配置的 provider 名称保持一致
  22.             provider: <fill-in-the-provider-name-here>
  23.             # openid 为 oidc 登录的必须 scope, 此处可以添加其它自定义的 scope
  24.             scope:
  25.               - openid
  26.             # client-secret 是在 oidc 提供者处配置的客户端密码, 用于登录 provider
  27.             # 从安全角度考虑更推荐使用环境变量来配置, 环境变量的命名规则为: 将配置项的 key 当中的 点(.)、横杠(-)替换为下划线(_), 然后将所有字母改为大写, spring boot 会自动处理符合此规则的环境变量
  28.             # 例如 spring.security.oauth2.client.registration.registration-name.client-secret -> SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_NAME_VDISK_CLIENT_SECRET (REGISTRATION_NAME 可以替换为自定义的 oidc 客户端的名称)
  29.             client-secret: d43c91c0-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  30.           # registration-name-client 是 oidc 客户端的名称, 任意字符均可, client_credentials 类型的 registration 为选填项, 可以不配置
  31.           registration-name-client:
  32.             # client_credentials 类型的 registration 为选填项, 用于 apollo-portal 作为客户端请求其它被 oidc 保护的资源, 可以不配置
  33.             authorization-grant-type: client_credentials
  34.             client-authentication-method: basic
  35.             # client-id 是在 oidc 提供者处配置的客户端ID, 用于登录 provider
  36.             client-id: apollo-portal
  37.             # provider 的名称, 需要和上面配置的 provider 名称保持一致
  38.             provider: <fill-in-the-provider-name-here>
  39.             # openid 为 oidc 登录的必须 scope, 此处可以添加其它自定义的 scope
  40.             scope:
  41.               - openid
  42.             # client-secret 是在 oidc 提供者处配置的客户端密码, 用于登录 provider, 多个 registration 的密码如果一致可以直接引用
  43.             client-secret: ${spring.security.oauth2.client.registration.registration-name.client-secret}
  44.       resourceserver:
  45.         jwt:
  46.           # 必须是 https, jwt 的 issuer-uri
  47.           # 例如 你的 issuer-uri 是 https://host:port/auth/realms/apollo/.well-known/openid-configuration, 那么此处只需要配置 https://host:port/auth/realms/apollo 即可, spring boot 处理的时候会自动加上 /.well-known/openid-configuration 的后缀
  48.           issuer-uri: https://host:port/auth/realms/apollo

2. 配置 startup.sh

修改scripts/startup.sh，指定spring.profiles.active为github,oidc。

  1. SERVICE_NAME=apollo-portal
  2. ## Adjust log dir if necessary
  3. LOG_DIR=/opt/logs/100003173
  4. ## Adjust server port if necessary
  5. SERVER_PORT=8070
  7. export JAVA_OPTS="$JAVA_OPTS -Dspring.profiles.active=github,oidc"

3. 配置 apollo-portal 启用 https

3.1 添加反向代理 header

这里以 nginx 为例, 将以下配置直接添加或者 include (推荐) 到 nginx 的 http 配置段内

  1. server {
  2.     listen 80 default_server;
  4.     location / {
  5.         # 把 80 端口的请求全部都重定向到 https
  6.         return 301 https://$http_host$request_uri;
  7.     }
  8. }
  9. server {
  10.     # nginx 版本较低不支持 http2 的, 则配置 listen 443 ssl;
  11.     listen 443 ssl http2;
  12.     server_name xxx;
  14.     # ssl 证书, nginx 需要使用完整证书链的证书
  15.     ssl_certificate /etc/nginx/ssl/xxx.crt;
  16.     ssl_certificate_key /etc/nginx/ssl/xxx.key;
  17.     # ... 其余 ssl 配置
  19.     location / {
  20.         proxy_pass http://apollo-portal-dev:8070;
  21.         proxy_set_header x-real-ip $remote_addr;
  22.         proxy_set_header x-forwarded-for $proxy_add_x_forwarded_for;
  23.         # ！！！这里必须是 $http_host, 如果配置成 $host 会导致跳转的时候端口错误
  24.         proxy_set_header host $http_host;
  25.         proxy_set_header x-forwarded-proto $scheme;
  26.         proxy_http_version 1.1;
  27.     }
  28. }

3.2 检查 application-oidc.yml 配置

在 application-oidc.yml 里必须存在配置项 server.forward-headers-strategy=framework

  1. server:
  2.   # 解析反向代理请求头
  3.   forward-headers-strategy: framework

3.3 添加 OpenID Connect 登录服务的重定向地址白名单

出于安全考虑, 一般来说 OpenID Connect 登录服务对重定向的地址会有白名单限制, 所以需要将 apollo-portal 的 https 地址添加到白名单才能正常重定向

实现方式四： 接入公司的统一登录认证系统

这种实现方式的前提是公司已经有统一的登录认证系统，最常见的比如SSO、LDAP等。接入时，实现以下SPI。其中UserService和UserInfoHolder是必须要实现的。

接口说明如下：

  • UserService（Required）：用户服务，用来给Portal提供用户搜索相关功能
  • UserInfoHolder（Required）：获取当前登录用户信息，SSO一般都是把当前登录用户信息放在线程ThreadLocal上
  • LogoutHandler（Optional）：用来实现登出功能
  • SsoHeartbeatHandler（Optional）：Portal页面如果长时间不刷新，登录信息会过期。通过此接口来刷新登录信息

可以参考apollo-portal下的com.ctrip.framework.apollo.portal.spi这个包下面的四个实现：

  1. defaultimpl：默认实现，全局只有apollo一个账号
  2. ctrip：ctrip实现，接入了SSO并实现用户搜索、查询接口
  3. springsecurity: spring security实现，可以新增用户，修改用户密码等
  4. ldap: @pandalin和codepiano贡献的ldap实现

实现了相关接口后，可以通过com.ctrip.framework.apollo.portal.configuration.AuthConfiguration在运行时替换默认的实现。

接入SSO的思路如下：

  1. SSO会提供一个jar包，需要配置一个filter
  2. filter会拦截所有请求，检查是否已经登录
  3. 如果没有登录，那么就会跳转到SSO的登录页面
  4. 在SSO登录页面登录成功后，会跳转回apollo的页面，带上认证的信息
  5. 再次进入SSO的filter，校验认证信息，把用户的信息保存下来，并且把用户凭证写入cookie或分布式session，以免下次还要重新登录
  6. 进入Apollo的代码，Apollo的代码会调用UserInfoHolder.getUser获取当前登录用户

注意，以上1-5这几步都是SSO的代码，不是Apollo的代码，Apollo的代码只需要你实现第6步。

注：运行时使用不同的实现是通过Profiles实现的，比如你自己的sso实现是在custom profile中的话，在打包脚本中可以指定-Dapollo_profile=github,custom。其中github是Apollo必须的一个profile，用于数据库的配置，custom是你自己实现的profile。同时需要注意在AuthConfiguration中修改默认实现的条件 ，从@ConditionalOnMissingProfile({"ctrip", "auth", "ldap"})改为@ConditionalOnMissingProfile({"ctrip", "auth", "ldap", "custom"})。