eap-radius: Add ability to configure RADIUS retransmission behavior
[strongswan.git] / conf / plugins / eap-radius.opt
1 charon.plugins.eap-radius.accounting = no
2         Send RADIUS accounting information to RADIUS servers.
3
4 charon.plugins.eap-radius.accounting_close_on_timeout = yes
5         Close the IKE_SA if there is a timeout during interim RADIUS accounting
6         updates.
7
8 charon.plugins.eap-radius.accounting_interval = 0
9         Interval in seconds for interim RADIUS accounting updates, if not specified
10         by the RADIUS server in the Access-Accept message.
11
12 charon.plugins.eap-radius.accounting_requires_vip = no
13         If enabled, accounting is disabled unless an IKE_SA has at least one
14         virtual IP. Only for IKEv2, for IKEv1 a virtual IP is strictly necessary.
15
16 charon.plugins.eap-radius.class_group = no
17         Use class attributes in Access-Accept messages as group membership
18         information.
19
20         Use the _class_ attribute sent in the RADIUS-Accept message as group
21         membership information that is compared to the groups specified in the
22         **rightgroups** option in **ipsec.conf**(5).
23
24 charon.plugins.eap-radius.close_all_on_timeout = no
25         Closes all IKE_SAs if communication with the RADIUS server times out. If it
26         is not set only the current IKE_SA is closed.
27
28 charon.plugins.eap-radius.dae.enable = no
29         Enables support for the Dynamic Authorization Extension (RFC 5176).
30
31 charon.plugins.eap-radius.dae.listen = 0.0.0.0
32         Address to listen for DAE messages from the RADIUS server.
33
34 charon.plugins.eap-radius.dae.port = 3799
35         Port to listen for DAE requests.
36
37 charon.plugins.eap-radius.dae.secret
38         Shared secret used to verify/sign DAE messages. If set, make sure to adjust
39         the permissions of the config file accordingly.
40
41 charon.plugins.eap-radius.eap_start = no
42         Send EAP-Start instead of EAP-Identity to start RADIUS conversation.
43
44 charon.plugins.eap-radius.filter_id = no
45         Use filter_id attribute as group membership information.
46
47         If the RADIUS _tunnel_type_ attribute with value **ESP** is received, use
48         the _filter_id_ attribute sent in the RADIUS-Accept message as group
49         membership information that is compared to the groups specified in the
50         **rightgroups** option in **ipsec.conf**(5).
51
52 charon.plugins.eap-radius.forward.ike_to_radius
53         RADIUS attributes to be forwarded from IKEv2 to RADIUS.
54
55         RADIUS attributes to be forwarded from IKEv2 to RADIUS (can be defined by
56         name or attribute number, a colon can be used to specify vendor-specific
57         attributes, e.g. Reply-Message, or 11, or 36906:12).
58
59 charon.plugins.eap-radius.forward.radius_to_ike =
60         Same as ike_to_radius but from RADIUS to IKEv2.
61
62         Same as _charon.plugins.eap-radius.forward.ike_to_radius_ but from RADIUS to
63         IKEv2, a strongSwan specific private notify (40969) is used to transmit the
64         attributes.
65
66 charon.plugins.eap-radius.id_prefix
67         Prefix to EAP-Identity, some AAA servers use a IMSI prefix to select the
68         EAP method.
69
70 charon.plugins.eap-radius.nas_identifier = strongSwan
71         NAS-Identifier to include in RADIUS messages.
72
73 charon.plugins.eap-radius.port = 1812
74         Port of RADIUS server (authentication).
75
76 charon.plugins.eap-radius.secret =
77         Shared secret between RADIUS and NAS. If set, make sure to adjust the
78         permissions of the config file accordingly.
79
80 charon.plugins.eap-radius.server =
81         IP/Hostname of RADIUS server.
82
83 charon.plugins.eap-radius.retransmit_base = 1.4
84         Base to use for calculating exponential back off.
85
86 charon.plugins.eap-radius.retransmit_timeout = 2.0
87         Timeout in seconds before sending first retransmit.
88
89 charon.plugins.eap-radius.retransmit_tries = 4
90         Number of times to retransmit a packet before giving up.
91
92 charon.plugins.eap-radius.servers {}
93         Section to specify multiple RADIUS servers.
94
95         Section to specify multiple RADIUS servers. The **nas_identifier**,
96         **secret**, **sockets** and **port** (or **auth_port**) options can be
97         specified for each server. A server's IP/Hostname can be configured using
98         the **address** option. The **acct_port** [1813] option can be used to
99         specify the port used for RADIUS accounting. For each RADIUS server a
100         priority can be specified using the **preference** [0] option. The
101         retransmission time for each server can set set using **retransmit_base**,
102         **retransmit_timeout** and **retransmit_tries**.
103
104 charon.plugins.eap-radius.sockets = 1
105         Number of sockets (ports) to use, increase for high load.
106
107 charon.plugins.eap-radius.xauth {}
108         Section to configure multiple XAuth authentication rounds via RADIUS.
109
110         Section to configure multiple XAuth authentication rounds via RADIUS.
111         The subsections define so called authentication profiles with arbitrary
112         names. In each profile section one or more XAuth types can be configured,
113         with an assigned message. For each type a separate XAuth exchange will be
114         initiated and all replies get concatenated into the User-Password attribute,
115         which then gets verified over RADIUS.
116
117         Available XAuth types are **password**, **passcode**, **nextpin**, and
118         **answer**. This type is not relevant to strongSwan or the AAA server, but
119         the client may show a different dialog (along with the configured message).
120
121         To use the configured profiles, they have to be configured in the respective
122         connection in **ipsec.conf**(5) by appending the profile name, separated by
123         a colon, to the **xauth-radius** XAauth backend configuration in _rightauth_
124         or _rightauth2_, for instance, _rightauth2=xauth-radius:profile_.