1.\"	$OpenBSD: radiusd_radius.8,v 1.2 2024/08/04 03:56:57 yasuoka Exp $
2.\"
3.\" Copyright (c) 2014 Esdenera Networks GmbH
4.\" Copyright (c) 2014, 2024 Internet Initiative Japan Inc.
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.\" The following requests are required for all man pages.
19.\"
20.Dd $Mdocdate: August 4 2024 $
21.Dt RADIUSD_RADIUS 8
22.Os
23.Sh NAME
24.Nm radiusd_radius
25.Nd provide authentication from upstream RADIUS servers
26.Sh SYNOPSIS
27.Nm radiusd_radius
28.Sh DESCRIPTION
29The
30.Nm
31utility is executed by
32.Xr radiusd 8
33as a module to provide authentication from upstream RADIUS servers.
34.Sh CONFIGURATIONS
35The
36.Nm
37supports the following configuration key and value:
38.Bl -tag -width Ds
39.It Ic server Ar address Ns Op : Ns Ar port
40Specify the upstream server's address and port.
41If
42.Ar port
43is omitted, 1812 is used.
44This configuration can be specified multiple times.
45.It Ic secret Ar secret
46Specify the shared secret with the servers.
47This configuration cannot be omitted.
48.It Ic max-tries Ar number
49Specify the maximum number of retransmissions for a server.
50.Xr radiusd 8
51will retransmit 2, 6, 14, 22, and 30 seconds after the first transmission
52and subsequent retransmissions will occur every 8 seconds.
53If the number of retransmissions per server reaches this value,
54the current server is marked as
55.Dq fail ,
56and the next server is used for subsequent requests.
57The default value is 3.
58.It Ic max-failovers Ar number
59If a positive number is specified,
60.Xr radiusd 8
61will failover to the next server
62when the current server is marked
63.Dq fail .
64This key and value specifies the maximum number of failovers.
65The default value is 0.
66.It Ic request-timeout Ar sec
67Specify the request timeout in seconds.
68If this value is specified,
69.Ar max-tries
70and
71.Ar max-failover
72will not be used.
73.El
74.Sh FILES
75.Bl -tag -width "/usr/libexec/radiusd/radiusd_radius" -compact
76.It Pa /usr/libexec/radiusd/radiusd_radius
77.Dq radius
78module executable.
79.El
80.Sh HISTORY
81The
82.Nm
83module first appeared in
84.Ox 5.8 .
85