Note recent changes
[freeradius.git] / doc / ChangeLog
1 FreeRADIUS 3.0.4 Mon 12 May 2014 15:30:00 EDT urgency=medium
2         Feature improvements
3
4         Bug fixes
5         * make case-insensitive regular expressions work again.
6
7 FreeRADIUS 3.0.3 Mon 12 May 2014 15:30:00 EDT urgency=medium
8         Feature improvements
9         * Everything now builds with no warnings from the C compiler,
10           clang static analyzer, or cppcheck.
11         * rlm_ldap now supports defining the LDAP attribute name via
12           backticked expansion (i.e. shell command) in
13           RADIUS <-> LDAP mappings.
14         * rlm_ldap now supports older style generic attributes.
15         * dynamic expansions (e.g. "%{expr:1 + 2}" are now parsed
16           when the server starts.  Syntax errors in the strings
17           are caught, and a descriptive error is printed.
18         * Static regular expressions (e.g. /a*b/) are now parsed
19           when the server starts.  Syntax errors in the strings
20           are caught, and a descriptive error is printed.
21         * dynamic expansions are cached after being parsed.  They are
22           no longer re-parsed at run-time for every request.
23         * regular expressions are now parsed and cached when the server
24           starts.
25         * Added the %{rest:} expansion to rlm_rest, which will send
26           a GET request to the URL passed as the format string.
27           Any body text will be written to the expansion buffer.
28         * rlm_rest now available as a debian package.
29         * When an 'if' condition statically evaluates to true/false,
30           unlang does more static optimization.  For examples, see
31           src/tests/keywords/if-skip
32         * All modules are marked as safe for '-C', which lets the
33           dynamic expansion checks work in more situations.
34         * Added 'none' and 'custom' rlm_rest body types. 'custom'
35           allows sending of arbitrary expanded text and content-type
36           headers.
37         * Added "config" section to Perl.  See mods-available/perl
38         * Added '%v' which expands to the server version - Patch
39           from Alan Buxey.
40         * more mis-matched casts are caught in "if" conditions,
41           and descriptive errors are printed.
42         * Support basic response validation in radclient. This allows
43           administrators to write local test cases for their
44           site-specific configurations.
45         * Removed radconf2xml and radmin "show client config" and
46           "show home_server config".
47         * Forbid running with vulnerable versions of OpenSSL.
48           See "allow_vulnerable_openssl" in the "security"
49           subsection of "radiusd.conf"
50         * Catch underlying "heartbleed" problem, so that nothing bad
51           happens even when using a vulnerable version of OpenSSL.
52         * Add locking API for sql_null, linelog, and detail modules,
53           which should improve performance and work around issues
54           on platforms with bad file locking.
55         * Allow DHCP NAKs to be delayed, via setting
56           reply:FreeRADIUS-Response-Delay = 1
57         * Allow tag and array references anywhere attributes
58           are allowed in "unlang".
59         * many enhancements to radsniff, including output
60           to collectd, ipv6 support and packet loss statistics.
61         * Many dictionary updates (ZTE, Brocade, Motorola).
62         * rlm_yubikey now automatically splits passwords from OTP
63           strings.
64         * The detail file reader is now threaded by default.
65           This should improve performance reading the files.
66
67         Bug fixes
68         * Fix xlat expression %{attribute[n]} so that it actually
69           returns the n'th attribute instead of the first one.
70         * Don't parse string on RHS of update {} when using unary
71           operators (!*).  The RHS should always be ignored.
72         * Check for more optional functions in json-c so we can
73           Build with libjson0, which is the name of the json-c package
74           on debian/ubuntu.
75         * Fix issue in radmin where the main dictionaries would
76           not be loaded which, depending on the configuration, may
77           have caused validation errors.
78         * Fix handling of "%{reply:3GPP-*}"
79         * Fix rlm_perl garbage attributes
80         * Fix oracle SQL queries, which amongst other things still
81           used the old expansion format, which is no longer
82           supported/parsed.
83         * Truncate long format strings and error markers instead of
84           omitting them.
85         * Fix multiple attribute parsing in rlm_rest JSON.
86         * Don't crash in rlm_rest if connect_uri is commented out
87           in the configuration.
88         * Don't double-escape strings to / from Perl.  You may need
89           to double-check your Perl scripts if they use "\" characters.
90           See mods-available/perl for documentation.
91         * Don't re-run "authorize" if a home server fails to respond.
92         * Don't append "0x" to hex output of octets types, for xlat
93           expansions.  This is the same as v2, and makes it easier
94           to concatenate multiple attributes of type "octets"
95         * FreeBSD fixes for execinfo linking.
96         * Make some of the module configurations more consistent.
97         * Fix corner cases where STDOUT wouldn't be closed in
98           daemon mode.
99         * Re-enable "update coa" and originating CoA requests.
100         * Prevent multiple threads writing to the sql query logs.
101         * Fix zombie period calculation.  Closes #579
102         * Properly parent VPs for talloc, when moving them in map2request.
103         * Various fixes for talloc parent / child relationships
104         * Allow rlm_counter to support VSAs.
105         * Normalize return codes for many modules. "do nothing" is noop,
106           not "ok".
107         * Run Post-Proxy-Type Fail.  Closes #576
108         * Fix DHCP destination port for replies to relays.  Closes #591
109         * Do-Not-Respond policy works again  Closes #593
110         * Proxy-To-Virtual-Server works again.  Closes #596
111         * Build fixes for ancient systems.  Closes #607, #608, #609.
112         * %{Module-Return-Code} works again.  Closes #610.
113         * Don't increment statistics for Status-Server responses.
114           Closes #612.
115         * A duplicate request isn't a duplicate if the original one
116           is marked "done".  This should lower retransmissions from
117           clients.
118         * Fix multiple regular expression and glob memory leaks.
119         * Don't allocate any memory in fr_fault() as it can cause malloc
120           to deadlock.
121         * Temporarily set dumpable flag before calling system in fr_fault()
122           else the debugger may not be able to attach.
123         * Set nonblock on all TCP client sockets.
124         * Fix minor buffer overrun in mschapv2 where some attribute strings
125           were not correctly \0 terminated.
126         * Fix crash on authentication failure with MIT kerberos.
127         * Fix code so that octal escape sequences aren't prematurely unescaped
128           in rlm_sql, radclient, preprocess, and other places. This may
129           require configuration changes, as these sequences will no longer
130           need double escaping (\\) of the backslash.
131         * The connection pools no longer have one connection used twice
132           in certain rare conditions.
133         * Use self pipes for internal signals.  The code was there, but was
134           unused.
135         * Don't crash if there are outstanding EAP sessions and were told to
136           exit gracefully.
137         * Fix typo in dictionary.rfc4072
138
139 FreeRADIUS 3.0.2 Fri 21 Mar 2014 08:30:00 EDT urgency=medium
140         Feature improvements
141         * secret keys and LDAP / SQL passwords are now printed as
142           '<<< secret >>>' in debugging mode.  Use -Xx to see the
143           actual passwords.
144         * Print out more information about passwords in -Xx,
145           including hashes, comparisons, etc.
146         * Allow cast (and implicit conversion) of integers to IPv4 addresses
147         * More xlats allow attribute references.  This means they can
148           operate on binary data.  e.g. expr, base64, md5, sha1.
149         * Added more tests.
150         * The dictionaries are now auto-loaded.  raddb/dictionary
151           should no longer have $INCLUDE ${prefix}/share/dictionary
152         * A "panic_action" can be set to have the server dump a gdb
153           log on SEGV or other fatal error.  See radiusd.conf
154         * Add support for SHA-224, SHA-256, SHA-384, SHA-512 to rlm_pap.
155         * Add "%{sha256:}" and "%{sha512:}" xlat functions.
156         * Cache CUI in EAP session resumption.
157         * templates can now have sub-sections, which will be included
158           in the section referencing the template.
159         * Update more dictionaries.
160         * Added more instances of the "always" module, for all return
161           codes.
162         * Suppress broken NASes when proxying.  Retransmits which occur
163           more than once per second are rate-limited to once per second.
164         * Allow '&' in more xlat expansions.
165         * Update PostgreSQL schema and queries to record last updated
166           time, and accounting interim.
167         * Optimize more "if" conditions when the server loads.  This will
168           avoid work at run time.  e.g. ("foo" == "bar") --> FALSE.
169         * Allow removal of all attributes within a list with !* operator.
170         * Allow list to list copies with request qualifiers (outer.).
171         * Add support for ipv4 prefixes and ipv6 addresses and prefixes to
172           %{integer:}.
173         * allow radmin command "set module status <module> <code>"
174           which can be used to forcibly enable/disable modules.
175         * pap module now assumes Cleartext-Password if Password-With-Header
176           doesn't have a {...} header.
177         * Added "unpack" module.  It can unpack binary data from horrible
178           VSA formats.  See raddb/mods-available/unpack
179         * Added example IP Pool for DHCP, using sqlite.  From Matthew Newton
180           See raddb/mods-config/sql/ippool-dhcp/
181
182         Bug fixes
183         * Fix SQL groups.
184         * Fix operation of fr_strerror() with RE*() macros.
185         * Don't assert if the connection we're trying to reconnect
186           is not in_use.
187         * Fix %{mschap:User-Name} xlat.
188         * Allow comparisons of signed integers and of ethernet addresses.
189         * Fix parsing of text-based ascend binary filters.
190         * Fix a few minor Coverity and clang analyzer issues.
191         * Log WARNING and ERROR prefixes only once, not twice.
192         * Fix attribute truncation seen in Perl and other places.
193         * Use correct port when DHCP relaying.
194         * Fix behaviour on FreeBSD where sending packets from an interface
195           bound to an IP address would fail when the server was built with
196           udpfromto.
197         * Don't abort() when freeing home servers on exit.
198         * Fix edge case in pairmove() when some attributes could be over-
199           written.
200         * Do checks for individual sqlite v2 functions so rlm_sqlite builds
201           correctly with more versions of the library.
202         * In heimdal kerberos, create MEMORY ccaches on a per context basis.
203           This prevents issues with the root ccache being used.
204         * Fix corner case with proxying, where home server goes down.
205         * Rate-limit "max_requests" complaint.  We don't want to fill the
206           logs when something goes wrong.
207         * Use /dev/urandom for raddb/certs/random, if it exists.
208         * Issue WARNING that old-style clients should no longer be used.
209         * Auto-set secret to "radsec" for tcp+tls home servers.
210         * Fix double free in home_server_add when there is a parse error
211           on startup.
212         * rlm_unix checks if the dictionaries are broken, instead of crashing
213         * Fix potential memory corruption when normalising salted password
214           hashes from hex, where the combined hash and salt was > 64 bytes.
215         * Register sqlcounter attributes correctly, and other issues with it
216         * treat 127.0.0.1/32 as being identical to 127.0.0.1
217         * Don't mangle error output of SQL drivers like PostgreSQL
218         * Fix usage of "tls = ${tls}".  It could previously cause problems
219           when the reference was used multiple times.
220         * Fix TLS session leak for incoming sockets.
221         * Try harder to clean up memory on exit when using "-mM"
222         * Fix memory leak when home server is down for RadSec connections
223         * rate-limit outgoing connection attempts when the home server
224           is down.  It will retry no more than once per second.
225         * When parsing ipv6 address prefixes, always mask off the host
226           portion.
227         * Fix rlm_counter so that it does not create two reply
228           attributes.
229         * Fix issues with DHCP Sub-TLVs where the value of the first
230           Sub-TLV would appear corrupted, and subsequent TLVs would
231           not appear in debug output.
232         * Initialize scope in IP address parsing
233         * Prevent vendor attributes and RFC space attributes from clashing
234           in rlm_attr_filter.
235         * Set source IP address for DHCP packets from DHCP-Server-IP-Address,
236           or DHCP-DHCP-Server-Identifier, if we're unable to otherwise
237           determine the source IP.
238         * Fix POST attribute parsing in rlm_rest.
239         * Fix JSON attribute parsing in rlm_rest.
240         * Don't append trailing & to POST options in rlm_rest (minor).
241         * Process HTTP 100 Continue messages correctly in rlm_rest
242         * Fix generation of long > 512 byte POST payloads, where attribute
243           values on the chunk boundary may have been omitted in rlm_rest.
244         * Remove duplicate escape sequence parsing in rlm_sqlippool and
245           rlm_sqlcounter which caused issues with escaping %. Escape
246           sequence parsing is now handled purely by the xlat functions.
247         * Ensure %% is treated as a string literal, and so not passed to any
248           xlat escape functions for processing.
249         * Correct calculation of Message-Authenticator
250           for CoA packets.  Closes #556
251
252 FreeRADIUS 3.0.1 Mon 13 Jan 2014 14:30:00 EDT urgency=medium
253         Feature improvements
254         * Add "timeout" to exec, and "ntlm_auth_timeout" to mschap.
255           So that run-away child processes are caught earlier.
256         * Allow TLS clients to use "proto = tls", in which case
257           TLS is required.  The shared secret is then set to "radsec".
258         * More documentation in the tls virtual server.
259         * Add "date" module for date formatting.
260           See raddb/mods-available/date.
261         * Added unit test suite for internal server functionality
262         * When loading "update" sections, check if the RHS is a literal
263           value.  If so, syntax check it immediately.
264         * Update LDAP module documentation and functionality.
265           The generic attribute can now update lists.
266         * Updated dictionary.extreme.
267         * Update sqlippool to do clears as a separate transaction,
268           and at most once per second.  This should help MySQL.
269         * Respect control:Response-Packet-Type for all types of
270           requests.
271         * Add support for SSL encryption to the MySQL driver.
272         * Allow arbitrary connection parameters to be used with the
273           PostgreSQL driver.
274         * Changes to the OpenLDAP schema to fully expose functionality
275           of the new LDAP module.
276         * Update debian packaging to include a freeradius-config
277           package. This package may be provided as a site local
278           package to avoid fighting with the preinstalled config
279           files.
280
281         Bug fixes
282         * Use correct field for ARP setting in DHCP.
283         * Fix crash on debug condition (#454).
284         * Fix a number of minor issues caught by the clang
285           analyzer.
286         * Set WARNING messages to yellow instead of normal text.
287         * Correct debug colorise logic.  Patch from Phil Mayers.
288         * Encode attributes of type "ethernet".  No one uses them,
289           but it makes sense.
290         * Work around regex initialization issues.
291         * Fix build when linking against OpenSSL.
292         * Print IDs as positive numbers, which helps for large DHCP
293           XIDs.
294         * Fix issue with sql_ippool.
295         * sqlcounter now uses 64-bit counters, to deal with 4G overflow.
296         * Fix issues with DHCP subsystem.
297         * Don't build / install disabled modules, or their config
298           files.
299         * Fix build for OSX Mavericks, which hid the header files
300           in a magical place.
301         * Fix LEAP buffer issue.  You should still avoid LEAP.
302         * Mark "unknown" WiMAX attributes as being WiMAX.
303         * Fix typo in packet decoder for fragmented extended attrs
304         * RPM spec fixes.
305         * Fix rlm_perl build issues when not using threads.
306         * Enable %{Response-Packet-Type} again.
307         * Update configuration file parser to handle "bool"
308           consistently.
309         * Update declarations of global boolean variables to use
310           "bool" consistently. This fixes an issue where some
311           modules were instantiated in "config check" mode and
312           did not work correctly.
313         * Make more messages debug instead of info, to avoid
314           polluting the logs with messages that can't be fixed.
315         * Set operator in internal unlang code to suppress spurious
316           warning messages.
317         * Fix debian packaging.
318         * Added "status" to Debian init script.
319         * Fix "update outer.request" to update the outer request.
320         * Don't print TLS debugging messages when not in debug mode.
321         * Correctly manage counters for "limit" sections of TCP / TLS
322           "listen" sockets.
323         * Fix libldap debug output.
324         * Fix rlm_ldap tls functionality.
325         * Initialise OpenSSL globals early to avoid issues with the
326           PostgreSQL library.
327         * Fix typo in sqlcounter expansion code.  Fixes #463
328         * Overwrite previous instances of SQL-User-Name when adding
329           it to the request.
330         * Work around bugs in both MIT and heimdal versions of
331           krb5_copy_context(), which caused segfaults in
332           multithreaded mode.
333         * Provide meaningful error messages if Heimdal krb5 is used.
334         * Fix attribute supression in rlm_detail.
335         * Exit with error code if child fails to complete server
336           initialisation after forking.  This allows init scripts to
337           correctly report whether the server started ok.
338
339 FreeRADIUS 3.0.0 Mon  7 Oct 2013 15:48:14 EDT urgency=medium
340         Feature improvements
341         * Documentation for upgrading from 2.x is in raddb/README.rst
342           Please follow it.  It will make the upgrade easier.
343         * Moved configuration entries in radiusd.conf to make more sense.
344         * Added the "integer64" and "ipv4prefix" data types.
345         * Added RADIUS over TLS (i.e. RadSec). See raddb/sites-available/tls
346         * Updated internal API to support new attributes and formats
347         * Added code to send SNMP Traps.  See raddb/trigger.conf.
348         * Added preliminary support for Apple's Grand Central Dispatch
349         * Added provisions for raddb/dictionary.local, for local changes.
350           See raddb/dictionary for more details.
351         * Added packet/s tracking. See max_pps in the "listen" section.
352         * The %{} expansions and "unlang" conditions are now parsed at server
353           start. Descriptive errors are produced for syntax and format errors.
354         * Casting is now supported for "unlang" comparisons.  See "man unlang"
355           e.g. <ipaddr>127.0.0.1 == Framed-IP-Address.
356         * Direct comparison of attribute references is now supported.
357           e.g. &Foo == &Bar.  This avoids stringification of the attributes.
358         * Direct assignment of attributes is now supported.
359           e.g. Foo := &Bar.  It also works for "octets" data types.
360         * Comparisons of IPv4 and IPv6 prefixes are now supported.
361           The "<" operator means "within the prefix" for comparisons.
362         * New sha1 xlat expansion (thanks to Alan Buxey)
363         * Colourised log messages when logging to stdout.  Look for yellow
364           warnings and red errors.  Doing this will save you a LOT of grief.
365         * If the PCRE library is available, use it (insted of the POSIX
366           functions) to process regular expressions (thanks to Phil Mayers).
367         * -xv now displays all the features the server was built with, and
368           the versions of the core libraries (libtalloc, libssl).
369
370         Module Changes
371         * Moved raddb/modules/ to raddb/mods-available/, and raddb/mods-enabled/,
372           following the examples of other projects.
373         * Additional files for each module are now in raddb/mods-config/.
374           See raddb/mods-config/README.rst for documentation.
375         * Moved "users" to raddb/mods-config/files/authorize
376         * Moved "hints" and "huntgroups" to raddb/mods-config/preprocess/
377         * Moved eap.conf to mods-available/eap
378         * Moved sql.conf to mods-available/sql
379         * Moved TLS configuration for EAP into a common subsection.
380           See raddb/mods-available/eap, "tls-config" section.
381         * Added for MS-CHAP Change Password from Phil Mayers.
382           See raddb/mods-available/mschap, "passchange" subsection.
383         * Added EAP-PWD implementation from Dan Harkins
384         * Added connection pools for modules. This unifies connection
385           management which was previously different for different modules.
386         * SQL now uses the connection pool.  See mods-available/sql
387         * SQL now supports arbitrary Acct-Status-Types.
388           These changes are not compatible with 2.x.
389         * SQL now has full support for SQLite.  See raddb/sql/main/sqlite/
390         * SQLite supports auto-creation of new databases on server startup for
391           bootstrapping purposes.
392         * LDAP now uses the connection pool.  The LDAP module has been
393           completely re-written for performance and simplicity.
394         * LDAP now caches groups.  This makes multiple group checks MUCH
395           faster.
396         * Removed all limitations on 253 octet attributes.  RFC 6929 allows
397           for attributes up to 4K in length.
398         * New rlm_idn module providing an expansion for performing IDNA encoding
399         of internationalized domain names.  Thanks to 'skids'.
400         * New rlm_yubikey module to validate yubikey OTP tokens.
401           See raddb/modules/yubikey
402
403         Bug fixes
404         * All known bug fixes from 2.2.x are included.
405         * Removed "addport" functionality.
406         * Removed many unused or duplicate modules.  See raddb/README.rst.
407
408         Internal / API changes:
409         * All traces of the old build system have been removed.
410           The new build system is faster and simpler.
411         * clang is fully supported.
412         * We now use "talloc" for memory management.  A number of new
413           features required this change.  Thanks to the Samba people!
414         * Many internal APIs have been updated to use talloc.
415         * New API for iterating over VALUE_PAIRs.  This is in preparation
416           for attributes, in version 3.1.
417         * No new code should directly modify any field of a VALUE_PAIR.
418         * VALUE_PAIRs contain pointers to DICT_ATTR instead of containing
419           attribute and vendor fields.  This will allow nested attributes.
420         * Some protocol specific code has been moved out into proto_* modules.
421           More will come in subsequent versions.  See proto_dhcp and proto_vmps.
422         * Standardised internal logging macros.  radlog() should not be used.
423           See src/include/log.h
424         * Use OpenSSL hashing functions when available.
425         * The server now builds with no warnings on most platforms.
426         * New RADIUS encoder/decoder, to support new formats.
427         * Added RFC 6929 "extended attributes", via the new encoder/decoder.
428         * Added full WiMAX support, via the new encoder/decoder.  The old
429           code could not handle some unusual corner cases.