Repository navigation
Document enrichment webhooks and key paths for RADIUS reply attributes - #581
Open
JoeWagstaff wants to merge 4 commits into
Open
JoeWagstaff wants to merge 4 commits into
JoeWagstaff wants to merge 4 commits into
Conversation
The RADIUS webhook reference covered authorization webhooks only and said that Smallstep support configures them. It now covers both webhook types, how to add one in the console, and how a reply attribute rule takes its value from an enrichment webhook response with a key path. Also corrects the request reference: the body includes clientIP, the timestamp is RFC 3339, and the signing secret is base64 and must be decoded before computing the signature. Change-Type: docs Release-Note: no Audience: user, admin Impact: none Breaking: false Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
|
|
A review against bouncer, gateway and the console found statements that did not match the code: - The console shows signing secrets only when a RADIUS server is created. Document the API route for a webhook added later. - clientIP is sent to enrichment webhooks only, and is the address of the network equipment. - Webhook authentication is required and the URL must use HTTPS. - A failed enrichment webhook drops every configured reply attribute, so a static fallback rule does not cover it. - Smallstep does not retry a failed webhook request. Also states that data must be an object, that replyAttributes is a reserved key, which rules are ignored without an error, and keeps the old #radius-authorization-webhooks anchor that the console links to. Change-Type: docs Release-Note: no Audience: user, admin Impact: none Breaking: false Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
thauber
previously approved these changes
Nov 19, 2026
thauber
left a comment
There was a problem hiding this comment.
I had one question, but it's not blocking. Looking pretty good.
|
|
||
| If `replyAttributes` is present, it must be an array of objects with a `name` and a `value`. | ||
| Any other shape makes the whole response invalid. | ||
|
|
There was a problem hiding this comment.
Do enriching reply attrs overwrite the radius rules reply attrs or the other way around? Or does it cause an error?
Contributor
Author
There was a problem hiding this comment.
there shouldn't be an error on our side, I guess it might be an issue depending on specific equipment might handle it. Pushed a small change to make the wording more explicit
A reviewer asked whether reply attribute rules override the attributes an enrichment webhook returns in replyAttributes, or the other way around. Neither does: bouncer appends the webhook's attributes after the rule attributes without removing duplicates, so both values reach the network equipment. Change-Type: docs Release-Note: no Audience: user, admin Impact: none Breaking: false Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
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
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.
Describe your changes:
The RADIUS webhook section of the wireless tutorial covered authorization webhooks only and said that Smallstep support configures them. This PR extends it to cover enrichment webhooks and the key path added to the console in smallstep/web#3177.
tutorials/protect-wireless-networks.mdxdataobject of the webhook response, with examples for nested keys and list indexesvalueFromWebhook: "<webhook name>.<key path>")data.replyAttributesclientIP, the timestamp is RFC 3339, and the signing secret is base64 and must be decoded before computing the HMAC.tutorials/protect-wired-networks.mdxChecked against the implementation
The second commit corrects the section against bouncer, gateway and the console: where the signing secret can be read, which webhooks receive
clientIP, required authentication and HTTPS, what a failed enrichment webhook does to reply attributes, and that requests are not retried.To confirm before merge
#radius-webhooks. The console links to#radius-authorization-webhooks, so the old id is kept with a<span id>above the heading. Check on the preview that the old anchor still scrolls to the section.Related links/other PRs/issues:
smallstep/web#3177, PRO-675, PRO-676. PRO-677 (the API reference still describes
valueFromWebhookas a webhook UUID) is still open.🤖 Generated with Claude Code