CHANGES 9.43 KB
Newer Older
haemmer's avatar
haemmer committed
1
Copyright (c) 2013, SWITCH - Serving Swiss Universities
2 3 4
See LICENSE file for details.

-------------------------------------------------------------------------------
haemmer's avatar
haemmer committed
5 6 7 8 9 10 11

SWITCHwayf Changes
==================

Find below the changes for past releases of the SWITCHwayf and in the credits
sections the people who contributed to the SWITCHwayf.

12 13
-------------------------------------------------------------------------------

haemmer's avatar
haemmer committed
14
**This document is written in the markdown syntax**
haemmer's avatar
haemmer committed
15

haemmer's avatar
haemmer committed
16 17 18 19 20 21 22 23 24 25
-------------------------------------------------------------------------------

Version Number Policy
---------------------

Releases with a version number 'X.Y.Z' are bug fix releases correcting
small bugs, typos and graphical issues.
Releases with a version number 'X.Y' are minor releases that introduce 
new functionality of fix non-trivial bugs. Few adaptions in the configuration 
might be necessary to upgrade to minor releases.
haemmer's avatar
haemmer committed
26 27 28 29 30 31
Releases with a version number X are major releases that will require major 
changes in the configuration files. Therefore, a clean instalation might be 
necessary for such releases.

-------------------------------------------------------------------------------

haemmer's avatar
haemmer committed
32 33
SWITCHwayf Version History
--------------------------
haemmer's avatar
haemmer committed
34 35 36 37 38 39 40 41 42
* Version 1.19 - Release date: ??? 2013
  - Added search-as-you-type support to Embedded WAYF. This feature is off by
    default as it is currently experimental. Can be activated with:  
    var wayf_use_improved_drop_down_list = true
  - Added MDUI logo support. Only favicon logos (16x16 px) will be used.
  - Various Javascript improvements to offload computation from WAYF to client
  - Replaced the term 'Home Organisation' in the language strings to more
    generic terms that probably are better understood by users.
  - SP names from MDUI metadata elements are now used if available
haemmer's avatar
haemmer committed
43
  - Added new version of JQuery library
haemmer's avatar
haemmer committed
44 45 46 47 48
  - Some small styling changes/CSS improvements
  
  Issues: <https://forge.switch.ch/redmine/projects/wayf/versions/???>
  Please read the specific update instructions in the README file.
  
haemmer's avatar
haemmer committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
* Version 1.18 - Release date:  5. August 2013
  - Changed default SessionInitiator of the Embedded WAYF to 
    /Login because this has been the default SessionInitiator in 
    Shibboleth for quite some time now.
  - Corrected viewport meta tag separator of default header as suggested
    by Andrew Sokolov from Saint Petersburg State University 
  - Fixed a bug in the IdP preselection of the embedded wayf when
    additional IdPs where added
  - Removed as many SWITCH-specific graphics and texts as possible.
  - Introduced configuration options to allow easier customization.
  - Fixed a few small bugs
  - Added some optimizations to the drop-down list search-as-you type 
    feature
  - The log file now logs - if possible - also the SP entityID/providerId
  - Some small styling changes/CSS improvements
  - Added Japanese locales from the GakuNin version of the WAYF
  
  Issues: <https://forge.switch.ch/redmine/projects/wayf/versions/62>
  Please read the specific update instructions in the README file, as some
  new configuration options were introduced that should be revised.

* Version 1.17.1 -  Release date:  14. June 2012
  - Fixed a bug occuring when wayf_sp_samlDSURL contains GET arguments  
    Bug reported with a patch by Takeshi Nishimura
  - Fixed typo in configuration otpion useImprovedDropDownList
  - Added Javascripts required for improved drop down list
  
  Issues: <https://forge.switch.ch/redmine/projects/wayf/versions/55>

* Version 1.17    Release date:  18. May 2012
  - Added CSS styles for mobile view
  - Embedded WAYF now reads 'entityID' and 'return' GET arguments.  
    They get precedence over the values configured for the Embedded WAYF.
  - Embedded WAYF logged in message now contains a link to target URL
  
  Issues: <https://forge.switch.ch/redmine/projects/wayf/versions/45>

* Version 1.16 - Release date: 19. January 2012
  - Added an improved version of the drop down list to the WAYF  
    Inspired by code from Takeshi Nishimura from NII (Japan)  
    Uses modified ImprovedDropdown JQuery library by John Fuex  
    See LICENSE file for further information
  - Added cookieSecurity option to set and transmit cookies securely  
    Code contributed by Takeshi Nishimura from NII (Japan)
  - Added additional data protection feature that uses the referer to
    decide whether or not to preselect an Identity Provider in the
    Embedded WAYF.  
    Code contributed by Takeshi Nishimura from NII (Japan)
  - If the Discovery Feed feature is activated only those IdPs are shown 
    that are contained in the feed. Others will be hidden automatically.
  - Added Keywords property to format of IDP entries to allow users to
    search Identity Providers using a keyword.

  Issues: <https://forge.switch.ch/redmine/projects/wayf/versions/40>

* Version 1.15 - Release date: 21. October 2011
  - A default and custom CSS file can now be used
  - Graphical design now is based new SWITCH harmos elements
  - Adapted JSON output to use format used by Shibboleth SP
  - Renamed some string keys to make them independent from SWITCH
    **Please review the 'Specific Update Instructions' in the README file**
  - Added support for the Shibboleth SP 2.4 Discovery Feed JSON output
    in Embedded WAYF
  - Focus on submit button works better with different browsers
  - Invalid values for width and height are now defaulted to auto for
    Embedded WAYF
  - Fixed a URL composing bug that resulted in a wrong return URL to 
    the Service Provider if the return parameter did not contain any GET
    arguments. Reported by Tom Scavo
  - Made implementation behave according to the Discovery Service protocol
    specification when it comes to the return parameter. This parameter
    is optional in case the DS knows the SP Discovery URL.  
    Reported by Tom Scavo.

  Issues: <https://forge.switch.ch/redmine/projects/wayf/versions/26>
    
* Version 1.14.3 - Release date: 4. March 2011
  - Fixed a race condition.  
    Thanks go to Robert Basch for reporting the issue and providing a patch.

  Issues: <https://forge.switch.ch/redmine/projects/wayf/versions/32>

* Version 1.14.2 - Release date: 15. December 2010
  - IDProvider.conf.php and config.php are not overwritten anymore by upgrades
  - Logging to syslog now works properly and is more consistent
  - Access log now properly locks file
  - Unknown category is not shown anymore when there is no other category
  - Namespaces are now taken properly into account when parsing SAML2 
    metadata. Thanks go to Olivier Salaün for reporting this issue and
    submitting a patch.
  - Improved installation instructions

  Issues: <https://forge.switch.ch/redmine/projects/wayf/versions/25>

* Version 1.14.1 - Release date: 12. November 2010
  - Fixed an encoding bug that affected non-ASCII characters in JavaScripts.  
    Thanks to Prof. Kazutsuna Yamaji for reporting this issue.
  - Corrected behaviour of $enableDSReturnParamCheck and 
    $useACURLsForReturnParamCheck. There won't be an error anymore if an SP 
    has no <idpdisc:DiscoveryResponse> extension defined. In such a case
    there will only be a check if $useACURLsForReturnParamCheck is enabled.
  - Fixed a bug in readMetadata.php that prevented CLI execution
  - Changed the default configuration option to generate the Embedded WAYF
    to false due to some concerns regarding phishing attacks
  - Added proper copyright statements to all source code files

  Issues: <https://forge.switch.ch/redmine/projects/wayf/versions/21>


haemmer's avatar
haemmer committed
158
The revision history of older versions, can be found on the SWITCHwayf web page:
haemmer's avatar
haemmer committed
159
<https://forge.switch.ch/redmine/projects/wayf/wiki/Changes>
160 161 162

-------------------------------------------------------------------------------

haemmer's avatar
haemmer committed
163 164
Credits
-------
haemmer's avatar
haemmer committed
165 166 167 168 169 170 171 172 173 174 175 176 177

The SWITCHwayf uses code from the following libraries:

* jQuery by the jQuery Foundation and other contributors, 
  http://jquery.com/
* Improved Dropdown by John Fuex
  https://bitbucket.org/Johnfx/improveddropdown-jquery-plugin/src
* jQuery Plug-in "Basic Visibility Detection" by Digital Fusion
  http://teamdf.com/

Please consult the LICENSE file for the individual licenses of these components.

Find below a list of people who have contributed to the code, either because they 
178 179 180 181 182 183 184 185 186 187 188
found bugs, suggested improvements or contributed code. Have a look at the 
version history in order to see the individual contributions. The list is sorted 
alphabetically.

- Robert Basch from MIT (US)
- Pavlos Drandakis from University of Athens (GR)
- Nicolas Dunand from Université Lausanne (CH)
- Michael R. Gettes from Internet2 (US)
- Nuno Gonçalves from FCCN (PT)
- Florent Guilleux from CRU (FR)
- Josh Howlett from University of Bristol (UK)
haemmer's avatar
haemmer committed
189
- Franz Kuster from ETH Zurich (CH)
190
- Wolgang Lierz from ETH Zurich (CH)
haemmer's avatar
haemmer committed
191
- Takeshi Nishimura NII National Institute of Informatics (JP)
192 193 194 195
- Lourival Pereira Vieira Neto from RNP (BR)
- Martins Purins from Latvijas Universitates (LV)
- Olivier Salaün from RENATER (FR)
- Tom Scavo from Internet2 (US)
haemmer's avatar
haemmer committed
196
- Andrew Sokolov, Saint Petersburg State University (RU)
197 198
- Mika Suvanto from CSC (FI)
- Huân Thebault from Centre de Calcul de l'IN2P3 (FR)
haemmer's avatar
haemmer committed
199
- Prof. Kazutsuna Yamaji from NII National Institute of Informatics (JP)
200 201
- And of course all SWITCH staff members who have contributed suggestions,
  bug fixes and translation to this code.
haemmer's avatar
haemmer committed
202 203 204 205 206

Special also go to RENATER, the French Research & Education Network. The main 
developer (Lukas Hämmerle) has been a guest at REANTER for 6 months in 2013, 
during which he worked - among other things - also on the versions 1.18 and 1.19
of the SWITCHwayf.