xref: /openbsd-src/usr.sbin/radiusd/radiusd_standard.8 (revision 563222a6e533c4623cedadcc031efab0c1ea1cc4)
1.\"	$OpenBSD: radiusd_standard.8,v 1.4 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_STANDARD 8
22.Os
23.Sh NAME
24.Nm radiusd_standard
25.Nd provide standard decorations for RADIUS messages
26.Sh SYNOPSIS
27.Nm radiusd_standard
28.Sh DESCRIPTION
29The
30.Nm
31utility is executed by
32.Xr radiusd 8
33as a module to provide various standard functionalities.
34It can be configured as a module for decoration which modifies request and
35response RADIUS messages.
36Also it can be configured as an accounting module that logs accounting
37information through
38.Xr syslog 3 .
39.Sh CONFIGURATIONS
40The
41.Nm
42module supports the following configuration key and value:
43.Pp
44.Bl -tag -width Ds -compact
45.It Ic strip-atmark-realm Ar true | false
46Remove the realm part which starts with @
47.Pq atmark
48from the User-Name attribute of the Access-Request.
49.Pp
50.It Ic strip-nt-domain Ar true | false
51Remove NT domain which ends with \\
52.Pq backslash
53from the User-Name attribute of the Access-Request.
54.Pp
55.It Cm remove-request-attribute Oo Ar vendor Oc Ar type
56.It Cm remove-response-attribute Oo Ar vendor Oc Ar type
57Remove all the specified attributes from request or response
58messages of Access-Request.
59Specify
60.Ar type
61of the attribute in a decimal number.
62To specify a vendor attribute,
63specify the Vendor-Id
64in a decimal number for
65.Ar vendor .
66.El
67.Sh FILES
68.Bl -tag -width "/usr/libexec/radiusd/radiusd_standard" -compact
69.It Pa /usr/libexec/radiusd/radiusd_standard
70.Dq standard
71module executable.
72.El
73.Sh HISTORY
74The
75.Nm
76module first appeared in
77.Ox 5.8 .
78