Authentication docs - #1708
Open
chrisbeard wants to merge 3 commits into
Open
Conversation
The Security page will cover authn, authz, and TLS. The initial authn docs cover the basics: the feature set, the protocol, client configuration, and broker plugin/configuration. Broker-to-broker authn, authz, and TLS docs will be added when the features are fully ready. Signed-off-by: Christopher Beard <cbeard9@bloomberg.net>
This commit introduces authenticator plugins to the plugin docs, which now covers mulitple plugin types. Signed-off-by: Christopher Beard <cbeard9@bloomberg.net>
678098
reviewed
Aug 12, 2026
| connection (see [Failure Handling](#failure-handling) below). | ||
|
|
||
| 5. If `lifetimeMs` is present, the client SDK schedules reauthentication at | ||
| **90 % of the lifetime** so authentication is renewed before expiry. |
Collaborator
There was a problem hiding this comment.
I am now curious do we have a good reason to have 90% in SDK and 80% in broker-broker
blazingmq/src/groups/mqb/mqba/mqba_authenticationclient.cpp
Lines 229 to 230 in e2c0f29
Contributor
Author
There was a problem hiding this comment.
It doesn't really matter, but we can normalize to 90%.
|
|
||
| | Field | Description | | ||
| |-------|-------------| | ||
| | `authenticators` | List of authenticator plugin configurations. Each entry names a plugin and provides its settings. All plugins must have unique mechanisms. | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `authenticators` | List of authenticator plugin configurations. Each entry names a plugin and provides its settings. All plugins must have unique mechanisms. | | |
| | `authenticators` | List of authenticator plugin configurations. Each entry names a plugin and provides its settings. All plugins must have unique mechanisms, or the broker will refuse to start. | |
Might mention consequences.
Contributor
Author
There was a problem hiding this comment.
Added this to the top, it's generally true for all plugins.
Signed-off-by: Christopher Beard <cbeard9@bloomberg.net>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Security page will cover authn, authz, and TLS. The initial authn docs cover the basics: the feature set, the protocol, client configuration, and broker plugin/configuration.
Broker-to-broker authn, authz, and TLS docs will be added when the features are fully ready.
Authenticator plugin essentials are also documented in the Plugins page, which we may want to revisit as we expand with additional plugin types, built-in vs external plugins, etc.