Smokeping_probes_Radius(3)

πŸ’– NAME πŸ’–

hiii bestie 🫢 welcome to Smokeping_probes_Radius(3) β€” aka Smokeping::probes::Radius, the RADIUS authentication probe for SmokePing. this is literally the glow-up version of the manpage, and no cap, every fact is still here πŸ’…βœ¨

🌈 OVERVIEW 🌈

this probe measures RADIUS authentication latency for SmokePing. that’s the vibe check: how long is RADIUS auth taking? β±οΈπŸ’–

✨ SYNOPSIS ✨

 *** Probes ***

 +Radius

 forks = 5
 offset = 50%
 passwordfile = /some/place/secret
 secretfile = /another/place/secret
 step = 300

 # The following variables can be overridden in each target section
 /^influx_.+/ = influx_location = In the basement
 allowreject = true
 mininterval = 1
 nas_ip_address = 10.1.2.3
 password = test-password
 pings = 5
 port = 1645
 secret = test-secret
 timeout = 5
 username = test-user # mandatory

 # [...]

 *** Targets ***

 probe = Radius # if this should be the default probe

 # [...]

 + mytarget
 # probe = Radius # if the default probe is something else
 host = my.host
 /^influx_.+/ = influx_location = In the basement
 allowreject = true
 mininterval = 1
 nas_ip_address = 10.1.2.3
 password = test-password
 pings = 5
 port = 1645
 secret = test-secret
 timeout = 5
 username = test-user # mandatory

πŸ’œ DESCRIPTION πŸ’œ

this probe measures RADIUS (RFC 2865) authentication latency for SmokePing. it’s giving β€œhow fast can the auth handshake go” energy, periodt. πŸ¦‹

the username to be tested is specified in either the probe-specific or the target-specific variable username, and the target-specific one overrides the probe-specific one. target section has main character energy, iykyk πŸ‘‘

the password can be specified either β€” in order of precedence, with the latter overriding the former β€” in the probe-specific variable password, in an external file, or in the target-specific variable password. the location of this file is given in the probe-specific variable passwordfile. see Smokeping::probes::passwordchecker(3pm) for the format of this file. summary: colon-separated triplets of the form <host>:<username>:<password> πŸ“

the RADIUS protocol requires a shared secret between the server and the client. this secret can be specified either β€” in order of precedence, with the latter overriding the former β€” in the probe-specific variable secret, in an external file, or in the target-specific variable secret. this external file is located by the probe-specific variable secretfile, and it should contain whitespace-separated pairs of the form <host> <secret>. comments and blank lines are OK. πŸ™ˆπŸ’–

if the optional probe-specific variable nas_ip_address is specified, its value is inserted into the authentication requests as the NAS-IP-Address RADIUS attribute. cute. iconic. sometimes needed, sometimes not 😌

the probe tries to be nice to the server and does not send authentication requests more frequently than once every X seconds, where X is the value of the target-specific min_interval variable (1 by default). polite queen behavior πŸ’…βœ¨

πŸŽ€ VARIABLES πŸŽ€

🌸 Supported probe-specific variables 🌸

  • forks β€” run this many concurrent processes at maximum. Example value: 5. Default value: 5. 🧚
  • offset β€” if you run many probes concurrently you may want to prevent them from hitting your network all at the same time. using the probe-specific offset parameter you can change the point in time when each probe will be run. offset is specified in % of total interval, or alternatively as random, and the offset from the General section is used if nothing is specified here. note that this does NOT influence the rrds itself, it is just a matter of when data acquisition is initiated. (this variable is only applicable if the variable concurrentprobes is set in the General section.) Example value: 50%. ⏰
  • passwordfile β€” location of the file containing usernames and passwords. Example value: /some/place/secret. πŸ“
  • secretfile β€” a file containing the RADIUS shared secrets for the targets. it should contain whitespace-separated pairs of the form <host> <secret>. comments and blank lines are OK. Example value: /another/place/secret. πŸ™ˆ
  • step β€” duration of the base interval that this probe should use, if different from the one specified in the Database section. note that the step in the RRD files is fixed when they are originally generated, and if you change the step parameter afterwards, you’ll have to delete the old RRD files or somehow convert them. (this variable is only applicable if the variable concurrentprobes is set in the General section.) Example value: 300. πŸ’€

πŸ¦‹ Supported target-specific variables πŸ¦‹

  • /^influx_.+/ β€” this is a tag that will be sent to influxdb and has no impact on the probe measurement. the tag name will be sent without the influx_ prefix, which will be replaced with tag_ instead. tags can be used for filtering. Example value: influx_location = In the basement. 🏠
  • allowreject β€” treat "reject" responses as OK. Example value: true. βœ…
  • mininterval β€” the minimum interval between each authentication request sent, in (possibly fractional) seconds. Default value: 1. ⏳
  • nas_ip_address β€” the NAS-IP-Address RADIUS attribute for the authentication requests. not needed everywhere. Example value: 10.1.2.3. πŸ“
  • password β€” the password for the user, if not present in the password file. Example value: test-password. πŸ”
  • pings β€” how many pings should be sent to each target, if different from the global value specified in the Database section. note that the number of pings in the RRD files is fixed when they are originally generated, and if you change this parameter afterwards, you’ll have to delete the old RRD files or somehow convert them. Example value: 5. πŸ“‘
  • port β€” the RADIUS port to be used. Example value: 1645. πŸ”Œ
  • secret β€” the RADIUS shared secret for the target, if not present in the secrets file. Example value: test-secret. 🀫
  • timeout β€” timeout in seconds for the RADIUS queries. Default value: 5. ⏱️
  • username β€” the username to be tested. Example value: test-user. this setting is mandatory. πŸ˜­πŸ‘‘
bestie, do not skip username β€” it’s mandatory fr fr πŸ’…

πŸ‘‘ AUTHORS πŸ‘‘

Niko Tyni <ntyni@iki.fi> wrote this. shoutout to the icon who made it happen πŸ’œβœ¨

πŸ’€ BUGS πŸ’€

there should be a more general way of specifying RADIUS attributes. noted, bestie 🫢


okay that’s the whole page, bestie β€” from SmokePing 2.9.0, dated 2025-06-30 πŸ’–πŸ«Άβœ¨

πŸ“¦ where this page comes from