24 |
A list of radius servers. Each element of the list is: |
A list of radius servers. Each element of the list is: |
25 |
|
|
26 |
@lisp |
@lisp |
27 |
(list @var{ID-STR HOST-STR SECRET-STR AUTH-NUM ACCT-NUM |
(list @var{id-str host-str secret-str auth-num acct-num |
28 |
CNTL-NUM}) |
cntl-num}) |
29 |
@end lisp |
@end lisp |
30 |
|
|
31 |
@noindent |
@noindent |
32 |
where the arguments are as follows: |
where the arguments are as follows: |
33 |
|
|
34 |
@multitable @columnfractions .40 .45 |
@multitable @columnfractions .40 .45 |
35 |
@item @var{ID-STR} @tab Server @sc{id} |
@item @var{id-str} @tab Server @sc{id} |
36 |
@item @var{HOST-STR} @tab Server hostname or IP |
@item @var{host-str} @tab Server hostname or IP |
37 |
@item @var{SECRET-STR} @tab Shared secret key to use |
@item @var{secret-str} @tab Shared secret key to use |
38 |
@item @var{AUTH-NUM} @tab Authentication port number |
@item @var{auth-num} @tab Authentication port number |
39 |
@item @var{ACCT-NUM} @tab Accounting port number |
@item @var{acct-num} @tab Accounting port number |
40 |
@item @var{CNTL-NUM} @tab Control channel port number |
@item @var{cntl-num} @tab Control channel port number |
41 |
@end multitable |
@end multitable |
42 |
Thus, each entry can be used as an argument to |
Thus, each entry can be used as an argument to |
43 |
@function{rad-client-set-server} or |
@code{rad-client-set-server} or |
44 |
@function{rad-client-add-server}. |
@code{rad-client-add-server}. |
45 |
@end deffn |
@end deffn |
46 |
|
|
47 |
@heading Functions |
@heading Functions |
48 |
|
|
49 |
@deffn Function rad-send-internal PORT-NUMBER CODE-NUMBER PAIR-LIST |
@deffn Function rad-send-internal @var{port-number} @var{code-number} @var{pair-list} |
50 |
Sends the request to currently selected server. |
Sends the request to currently selected server. |
51 |
Arguments are: |
Arguments are: |
52 |
|
|
53 |
@table @var |
@table @var |
54 |
@item PORT-NUMBER |
@item port-number |
55 |
Port number to use. These values are allowed: |
Port number to use. These values are allowed: |
56 |
|
|
57 |
@multitable @columnfractions .40 .40 |
@multitable @columnfractions .40 .40 |
62 |
@noindent |
@noindent |
63 |
The actual port numbers are those configured for |
The actual port numbers are those configured for |
64 |
the given server. |
the given server. |
65 |
@item CODE-NUMBER |
@item code-number |
66 |
Request code. |
Request code. |
67 |
@item PAIR-LIST |
@item pair-list |
68 |
List of attribute-value pairs. Each pair is either |
List of attribute-value pairs. Each pair is either |
69 |
@lisp |
@lisp |
70 |
(cons @var{ATTR-NAME-STR VALUE}) |
(cons @var{attr-name-str value}) |
71 |
@end lisp |
@end lisp |
72 |
or |
or |
73 |
@lisp |
@lisp |
74 |
(cons @var{ATTR-NUMBER VALUE}) |
(cons @var{attr-number value}) |
75 |
@end lisp |
@end lisp |
76 |
@end table |
@end table |
77 |
@noindent |
@noindent |
78 |
|
|
79 |
Return: On success, |
Return: On success, |
80 |
@lisp |
@lisp |
81 |
(list RETURN-CODE-NUMBER PAIR-LIST) |
(list @var{return-code-number pair-list}) |
82 |
@end lisp |
@end lisp |
83 |
On failure, |
On failure, |
84 |
@lisp |
@lisp |
86 |
@end lisp |
@end lisp |
87 |
@end deffn |
@end deffn |
88 |
|
|
89 |
@deffn Function rad-send PORT-NUMBER CODE-NUMBER PAIR-LIST . VERBOSE |
@deffn Function rad-send @var{port-number} @var{code-number} @var{pair-list} . @var{verbose} |
90 |
Sends a radius request. Actually it does the same work as |
Sends a radius request. Actually it does the same work as |
91 |
@command{rad-send-internal}, |
@command{rad-send-internal}, |
92 |
but if @var{VERBOSE} is specified, the verbose report about interaction with |
but if @var{verbose} is specified, the verbose report about interaction with |
93 |
the radius server is printed. |
the radius server is printed. |
94 |
@end deffn |
@end deffn |
95 |
|
|
102 |
Returns the @sc{id} of the currently selected server. |
Returns the @sc{id} of the currently selected server. |
103 |
@end deffn |
@end deffn |
104 |
|
|
105 |
@deffn Function rad-client-set-server LIST |
@deffn Function rad-client-set-server @var{list} |
106 |
Selects for use the server described by @var{LIST}. Here @var{LIST} |
Selects for use the server described by @var{list}. Here @var{list} |
107 |
takes the form |
takes the form |
108 |
|
|
109 |
@lisp |
@lisp |
110 |
(list @var{ID-STR HOST-STR SECRET-STR AUTH-NUM ACCT-NUM |
(list @var{id-str host-str secret-str auth-num acct-num |
111 |
CNTL-NUM}) |
cntl-num}) |
112 |
@end lisp |
@end lisp |
113 |
@noindent |
@noindent |
114 |
where the arguments are as follows: |
where the elements are as follows: |
115 |
|
|
116 |
@multitable @columnfractions .40 .45 |
@multitable @columnfractions .40 .45 |
117 |
@item @var{ID-STR} @tab Server @sc{id} |
@item @var{id-str} @tab Server @sc{id} |
118 |
@item @var{HOST-STR} @tab Server hostname or IP |
@item @var{host-str} @tab Server hostname or IP |
119 |
@item @var{SECRET-STR} @tab Shared secret key to use |
@item @var{secret-str} @tab Shared secret key to use |
120 |
@item @var{AUTH-NUM} @tab Authentication port number |
@item @var{auth-num} @tab Authentication port number |
121 |
@item @var{ACCT-NUM} @tab Accounting port number |
@item @var{acct-num} @tab Accounting port number |
122 |
@item @var{CNTL-NUM} @tab Control channel port number |
@item @var{cntl-num} @tab Control channel port number |
123 |
@end multitable |
@end multitable |
124 |
@end deffn |
@end deffn |
125 |
|
|
126 |
@deffn Function rad-client-add-server LIST |
@deffn Function rad-client-add-server @var{list} |
127 |
Adds the server described by @var{LIST} to the list of active servers. |
Adds the server described by @var{list} to the list of active servers. |
128 |
Here @var{LIST} takes the form |
Here @var{list} takes the form |
129 |
|
|
130 |
@lisp |
@lisp |
131 |
(list @var{ID-STR HOST-STR SECRET-STR AUTH-NUM ACCT-NUM |
(list @var{id-str host-str secret-str auth-num acct-num |
132 |
CNTL-NUM}) |
cntl-num}) |
133 |
@end lisp |
@end lisp |
134 |
|
|
135 |
@noindent |
@noindent |
136 |
where the arguments are as follows: |
where the elements are as follows: |
137 |
|
|
138 |
@multitable @columnfractions .40 .45 |
@multitable @columnfractions .40 .45 |
139 |
@item @var{ID-STR} @tab Server @sc{id} |
@item @var{id-str} @tab Server @sc{id} |
140 |
@item @var{HOST-STR} @tab Server hostname or IP |
@item @var{host-str} @tab Server hostname or IP |
141 |
@item @var{SECRET-STR} @tab Shared secret key to use |
@item @var{secret-str} @tab Shared secret key to use |
142 |
@item @var{AUTH-NUM} @tab Authentication port number |
@item @var{auth-num} @tab Authentication port number |
143 |
@item @var{ACCT-NUM} @tab Accounting port number |
@item @var{acct-num} @tab Accounting port number |
144 |
@item @var{CNTL-NUM} @tab Control channel port number |
@item @var{cntl-num} @tab Control channel port number |
145 |
@end multitable |
@end multitable |
146 |
@end deffn |
@end deffn |
147 |
|
|
148 |
@deffn Function rad-read-no-echo PROMPT-STR |
@deffn Function rad-read-no-echo @var{prompt-str} |
149 |
Prints the given @var{PROMPT-STR}, disables echoing, reads a string up to the |
Prints the given @var{prompt-str}, disables echoing, reads a string up to the |
150 |
next newline character, restores echoing, and returns the string entered. |
next newline character, restores echoing, and returns the string entered. |
151 |
This is the interface to the C @command{getpass(3)} function. |
This is the interface to the C @command{getpass(3)} function. |
152 |
@end deffn |
@end deffn |
153 |
|
|
154 |
@deffn Function rad-client-source-ip IP-STR |
@deffn Function rad-client-source-ip @var{ip-str} |
155 |
Sets the IP to be used as source. @var{IP-STR} can be either an |
Sets the IP to be used as source. @var{ip-str} can be either an |
156 |
IP in dotted-quad form or a hostname. |
IP in dotted-quad form or a hostname. |
157 |
@end deffn |
@end deffn |
158 |
|
|
159 |
@deffn Function rad-client-timeout NUMBER |
@deffn Function rad-client-timeout @var{number} |
160 |
Sets the timeout in seconds for waiting for a server reply. |
Sets the timeout in seconds for waiting for a server reply. |
161 |
@end deffn |
@end deffn |
162 |
|
|
163 |
@deffn Function rad-client-retry NUMBER |
@deffn Function rad-client-retry @var{number} |
164 |
Sets the number of retries for sending requests to a Radius server. |
Sets the number of retries for sending requests to a Radius server. |
165 |
@end deffn |
@end deffn |
166 |
|
|
167 |
@deffn Function rad-format-code DEST-BOOL CODE-NUMBER |
@deffn Function rad-format-code @var{dest-bool} @var{code-number} |
168 |
Format a radius reply code into a human-readable form. |
Format a radius reply code into a human-readable form. |
169 |
@var{DEST-BOOL} has the same meaning as in format. |
@var{dest-bool} has the same meaning as in @code{format} |
170 |
|
(@xref{Formatted Output,,Formatted Output,guile,The Guile Reference Manual}.) |
171 |
@end deffn |
@end deffn |
172 |
|
|
173 |
@deffn Function rad-format-pair DEST-BOOL PAIR |
@deffn Function rad-format-pair @var{dest-bool} @var{pair} |
174 |
Format a radius attribute-value pair for output. |
Format a radius attribute-value pair for output. |
175 |
@var{DEST-BOOL} has the same meaning as in format. |
@var{dest-bool} has the same meaning as in @code{format}. |
176 |
PAIR is either |
@var{pair} is either |
177 |
@lisp |
@lisp |
178 |
(cons @var{NAME-STR VALUE}) |
(cons @var{name-str value}) |
179 |
@end lisp |
@end lisp |
180 |
or |
or |
181 |
@lisp |
@lisp |
182 |
(cons @var{ATTR-NUMBER VALUE}) |
(cons @var{attr-number value}) |
183 |
@end lisp |
@end lisp |
184 |
@noindent |
@noindent |
185 |
where @var{VALUE} may be of any type appropriate for the given attribute. |
where @var{value} may be of any type appropriate for the given attribute. |
186 |
@end deffn |
@end deffn |
187 |
|
|
188 |
@deffn Function rad-print-pairs DEST-BOOL PAIR-LIST |
@deffn Function rad-print-pairs @var{dest-bool} @var{pair-list} |
189 |
Output the radius attribute-value pairs from @var{PAIR-LIST}. |
Output the radius attribute-value pairs from @var{pair-list}. |
190 |
@var{DEST-BOOL} has the same meaning as in format. |
@var{dest-bool} has the same meaning as in format. |
191 |
@var{PAIR-LIST} is a list of pairs in the form |
@var{pair-list} is a list of pairs in the form |
192 |
|
|
193 |
@lisp |
@lisp |
194 |
(cons @var{NAME-STR VALUE}) |
(cons @var{name-str value}) |
195 |
@end lisp |
@end lisp |
196 |
@noindent |
@noindent |
197 |
or |
or |
198 |
|
|
199 |
@lisp |
@lisp |
200 |
(cons @var{ATTR-NUMBER VALUE}) |
(cons @var{attr-number value}) |
201 |
@end lisp |
@end lisp |
202 |
@noindent |
@noindent |
203 |
where @var{VALUE} may be of any type appropriate for the given attribute. |
where @var{value} may be of any type appropriate for the given attribute. |
204 |
|
|
205 |
All @attr{Reply-Message} pairs from the list are concatenated and displayed |
All @attr{Reply-Message} pairs from the list are concatenated and displayed |
206 |
as one. |
as one. |
207 |
@end deffn |
@end deffn |
208 |
|
|
209 |
@deffn Function rad-format-reply-msg PAIR-LIST . TEXT |
@deffn Function rad-format-reply-msg @var{pair-list} . @var{text} |
210 |
Concatenate and print text from all @attr{Reply-Message} pairs from |
Concatenate and print text from all @attr{Reply-Message} pairs from |
211 |
@var{PAIR-LIST}. If @var{TEXT} is specified, it is printed before the |
@var{pair-list}. If @var{text} is specified, it is printed before the |
212 |
concatenated |
concatenated |
213 |
text. |
text. |
214 |
@end deffn |
@end deffn |
218 |
or IP. |
or IP. |
219 |
@end deffn |
@end deffn |
220 |
|
|
221 |
@deffn Function rad-select-server ID-STR |
@deffn Function rad-select-server @var{ID-STR} |
222 |
Select the server identified by @var{ID-STR} as a current server. The server |
Select the server identified by @var{id-str} as a current server. The server |
223 |
data are looked up in rad-server-list variable. |
data are looked up in rad-server-list variable. |
224 |
@end deffn |
@end deffn |
225 |
|
|
226 |
@deffn Function rad-add-server ID-STR |
@deffn Function rad-add-server @var{id-str} |
227 |
Add the server identified by ID-STR to the list of current servers. |
Add the server identified by @var{id-str} to the list of current servers. |
228 |
The server data are looked up in rad-server-list variable. |
The server data are looked up in rad-server-list variable. |
229 |
@end deffn |
@end deffn |
230 |
|
|
231 |
|
|