FreeRADIUS / freeradius-server

FreeRADIUS - A multi-protocol policy server.
http://freeradius.org
GNU General Public License v2.0
2.14k stars 1.09k forks source link

[defect]: dictionary man page does not list all options #5346

Open johnthacker opened 5 months ago

johnthacker commented 5 months ago

What type of defect/bug is this?

Unexpected behaviour (obvious or verified by project member)

How can the issue be reproduced?

  1. Read the man page, whether online or as distributed.
  2. Compare it to the options present in the distributed dictionary, and parsed by the dictionary parser.

Log output from the FreeRADIUS daemon

New options like `secret`, `array`, `concat` and others are all not documented.

Relevant log output from client utilities

No response

Backtrace from LLDB or GDB

No response

alandekok commented 5 months ago

Only v4 supports secret, array, etc. We're moving away from man pages for much of v4, and moving to Antora, which is at https://freeradius.org/documentation/freeradius-server/4.0.0/reference/dictionary/attribute.html

johnthacker commented 5 months ago

array (and concat) are present in some of the dictionary files on v3.2.x though. (secret is only in the internal dictionary in v3.2) Is it that the case that array can be present and the parser simply ignores it in v3.2?

alandekok commented 5 months ago

array is only used for DHCP. And concat is only used for EAP-Message.

We're happy to take patches to fix the documentation, but it is definitely not a priority for us to do that work. The use-case where people need to know about those flags are vanishingly rare.

We're concentrating on getting v4 out the door, with full documentation.

johnthacker commented 5 months ago

Sure, no problem. I do think concat is used for a few others - EAPoL-Announcement, PKM-SS-Cert, PKM-CA-Cert, but in Wireshark at least only EAP-Message is actually reassembled.

Just trying to work on updating the parsing of the format within Wireshark so we can update to at least the 3.2.x dictionaries, offer any patches for a handful of missing attributes in the FreeRADIUS versions, and properly include the copyright and license lines that have been added to some of the files since the last time they were synced.

alandekok commented 5 months ago

That's helpful, thanks

I'll try to find time to update the man pages