feat(inputs.influxdb_listener): Add token based authentication

[srebhan]

• Updated associated README.md.
• Wrote appropriate unit tests.
• Pull request title or commits are in conventional commit format

resolves #9445

This PR adds token based authentication to the InfluxDB v1 listener to complement the authentication methods supported. This is especially relevant to get a forward compatibility with v2.x.

[powersj]

@srebhan thanks for this PR and looking at this feature request.

Looking at the original request, the user seems to be asking for "token" authentication. When I think about token authentication, especially in reference to v2, I think of the generated string API tokens, not a JWT token.

Effectively I was thinking we would have a a token value just like we have in the influxdb_v2 output.

Was that not your understanding?

Thanks!

[srebhan]

@powersj I talked to Geoffrey yesterday and he pointed me to the 1.8 server code. I reproduced what is there. The downside of a fixed token is that it cannot have an expiry date and token without an expiry won't work with InfluxDB 1.8...

[powersj]

That is not my understanding of reading the feature request. The background is a user is transitioning from v1 to v2 and wants that process to go more smoothly. The current behavior lists:

Telegraf InfluxDB Listener v1 input plugin only supports username/password not tokens.

They want the v1 input plugin to support tokens which is a v2 auth mechanism. Looking further down they use the go client library as an example:

Use the form username:password for an authentication token. Example: my-user:my-password. Use an empty string ("") if the server doesn't require authentication.

The JWT tokens are a legacy 1.8 auth mechanism, which is why I still think the correct item is allowing a username/password via a token value?

[srebhan]

Sorry, but isn't this what I added in line 116? What am I missing here? I just added all documented auth mechanisms as per documentation, so you can use Authentication: Basic <encoded user/password> , Authentication: Token <user>:<password> and Authentication: Bearer <token>...

[powersj]

Sorry, but isn't this what I added in line 116? What am I missing here?

If I was a user who wanted to use backwards compatibility, again I was expecting a token parameter in the sample config itself, again similar to the client libraries.

You are re-purposing the basic auth username and password configuration fields. To someone coming from v2 that is not obvious that they can use that as a token backwards comparability. At the very least you need to update the docs.

[powersj]

I've gone through this again and realized my comment may have come across a little harsh - my point is that the code is fine, rather we have not guided the user to the fact that this is even possibility.

Updating the sample config section near basic auth username/password to state that these can be set for users using compatibility mode via "username:password" is all that is needed to land this.

[srebhan]

@powersj no worries about the comment, I don't classify this as harsh, you have to try harder! ;-) Will add a comment as soon as possible to the sample-config.

[telegraf-tiger]

Download PR build artifacts for linux_amd64.tar.gz, darwin_amd64.tar.gz, and windows_amd64.zip.
Downloads for additional architectures and packages are available below.

☺️ This pull request doesn't significantly change the Telegraf binary size (less than 1%)

📦 Click here to get additional PR build artifacts

Artifact URLs

DEB	RPM	TAR GZ	ZIP
amd64.deb	aarch64.rpm	darwin_amd64.tar.gz	windows_amd64.zip
arm64.deb	armel.rpm	darwin_arm64.tar.gz	windows_arm64.zip
armel.deb	armv6hl.rpm	freebsd_amd64.tar.gz	windows_i386.zip
armhf.deb	i386.rpm	freebsd_armv7.tar.gz
i386.deb	ppc64le.rpm	freebsd_i386.tar.gz
mips.deb	riscv64.rpm	linux_amd64.tar.gz
mipsel.deb	s390x.rpm	linux_arm64.tar.gz
ppc64el.deb	x86_64.rpm	linux_armel.tar.gz
riscv64.deb		linux_armhf.tar.gz
s390x.deb		linux_i386.tar.gz
		linux_mips.tar.gz
		linux_mipsel.tar.gz
		linux_ppc64le.tar.gz
		linux_riscv64.tar.gz
		linux_s390x.tar.gz

[powersj]

Thank you!