Pulsar学习笔记之 Authentication认证机制与插件开发

Posted 2021-10-05 tabalt

Pulsar自带的Authentication认证方式有很多种：TLS/Basic/JWT Token/Athenz/Sasl，但是均存在安全性或复杂性的一些问题，且有时候我们需要和已有的账户系统做集成，以保持一致的产品体验，此时需要自行开发认证插件。这里介绍一个使用签名机制增强安全性的认证插件开发方案。

Pulsar认证的扩展机制

Pulsar认证提供了比较好的扩展机制，通过实现几个预定义的接口类，就可以方便的插入自己开发的认证实现。这些接口主要包括以下4个：

#客户端包装认证参数
org.apache.pulsar.client.api.Authentication
org.apache.pulsar.client.api.AuthenticationDataProvider

#服务端验证认证参数
org.apache.pulsar.broker.authentication.AuthenticationProvider
org.apache.pulsar.broker.authentication.AuthenticationState

此外默认的多种认证方式的代码可以提供非常丰富的认证实现参考。

待集成的认证服务

假设我们已经有了一个账号系统，里面存储有账号名（accessKey）、加盐hash过的密码（accessSecret）等认证需要的信息；我们需要再开发一个专用的接口，供我们实现的Pulsar认证插件调用。为避免认证接口被他人滥用，通过Header中的Auth参数做简单比对校验。

接口参数

• 接收POST参数：accessKey,timeStr,paramStr,signature
• 接收Header参数：Auth

认证大致过程

• 对收到的accessKey做格式校验
• 请求账号系统接口或查询数据库获取accessSecret
• 用跟客户端相同的方式重新计算签名
• sginStr：accessKey+timeStr+paramStr
• signature=base64(HmacSHA1.init(accessSecret).doFinal(signStr))
• 比对签名，失败报错
• 构造userRole

认证通过后响应结果

{
    "uid":"123456",
    "userRole": "ur-123456", #命名规则可以自行觉得定
}

Pulsar认证插件的实现要点

客户端包装认证参数

• 传入参数：accessKey,accessSecret

• 生成参数

  • paramStr：method=akauth&client=$UUID&rand=Math.rand()
  • timeStr：String.valueOf(System.currentTimeMillis()/1000)
  • sginStr：accessKey+timeStr+paramStr
• 签名计算：signature=base64(HmacSHA1.init(accessSecret).doFinal(signStr))
• 传递参数：accessKey,timeStr,paramStr,signature

服务端转发认证参数

• 接收参数：accessKey,timeStr,paramStr,signature
• 请求 认证服务接口

服务端签名存活期校验

• AuthenticationProviderTabaltAK.authenticate 判断是否过期

// check auth params survival time
long currentTimeSeconds = System.currentTimeMillis() / 1000;
long authTimeSeconds = Long.parseLong(authParams.getTimeStr());
if ((authTimeSeconds + this.akSignatureSurvivalSeconds) < currentTimeSeconds) {
    throw new AuthenticationException("auth out of survival time");
}

• TokenAuthenticationState.isExpired 判断是否过期

  • 具体判断逻辑与上面相同

Pulsar认证插件的使用配置

Pulsar服务端配置

服务端通常在Broker和Proxy的配置文件中配置

# 配置Broker的认证插件和参数
authenticationEnabled=true
authenticationProviders=net.tabalt.pulsar.broker.authentication.AuthenticationProviderTabaltAK
tabaltAKServerUrl=http://127.0.0.1/ak  #AK服务地址
tabaltAKServerAuth=test-auth  #AK服务接口认证Token，通过header传递给认证服务
tabaltAKSignatureSurvivalSeconds=3600 #签名存活秒数

# 配置Broker作为客户端请求其他Broker的认证插件和参数，此处需要配置一个超级账号
brokerClientAuthenticationPlugin=net.tabalt.pulsar.client.auth.AuthenticationTabaltAK
brokerClientAuthenticationParameters={"accessKey":"test_access_key","accessSecret":"test_access_secret"}

Pulsar客户端配置

AuthenticationTabaltAK authAK = new AuthenticationTabaltAK("test_access_key", "test_access_secret");
PulsarClient client = PulsarClient.builder()
                .serviceUrl("pulsar://127.0.0.1:6650")
                .authentication(authAK).build();
Producer<byte[]> producer = client.newProducer().topic("my-topic").create();
...