Back out changed related to resource backed metadata provider
[java-idp.git] / doc / README.txt
1 Welcome to Internet2's Shibboleth
2
3 Shibboleth is a federated web authentication and attribute exchange system
4 based on SAML developed by Internet2 and MACE.
5
6 Shibboleth is licensed under the Apache 2.0 license which is provided in the
7 LICENSE.txt file.
8
9 Shibboleth Project Site:
10 http://shibboleth.internet2.edu/
11
12 Shibboleth Documentation Site:
13 https://spaces.internet2.edu/display/SHIB2/Home
14
15 Source and binary distributions
16 http://shibboleth.internet2.edu/downloads
17
18 Bug Tracker:
19 https://bugs.internet2.edu/jira
20
21
22 Known Issues
23 ====================
24 There is an issue that is causing old metadata to be kept in memory (i.e. a memory leak).  This is being 
25 looked in to, but while present, no site has yet reported this to be a cause of an error (i.e out of 
26 memory exceptions).  Therefore, given the need to release a fix in order to address the security
27 vulnerability found in 2.0.0 it was decided to make this release even with this known bug.  Sites can 
28 mitigate this by using Entity Role White List metadata filter to ensure that at least the IdP isn't caching 
29 information (IdP entity descriptors) that it doesn't need.  And, while less than optimal, this can be 
30 addressed by periodic restarts of the IdP.
31
32
33 Upgrading 
34 ====================
35
36 from 2.0.0 to 2.1.0
37 -------------------
38 The following configuration changes must be made to upgrade from 2.0.0 to 2.1.0
39 - in internal.xml replace 'org.opensaml.util.storage.MapBasedStorageService' with 
40   'edu.internet2.middleware.shibboleth.common.util.EventingMapBasedStorageService'
41   as the value for the class attribute of bean 'shibboleth.StorageService' (line 82 in the
42   default configuration file)
43   
44 - in service.xml add the service 'shibboleth.StorageService' to the whitespace delimited 
45   list of services already present in the service, shibboleth.ServiceServletContextAttributeExporter
46   (service definition starts at line 57 in the default configuration file)
47
48 - in internal.xml, replace the string 'org.apache.velocity.runtime.resource.loader.StringResourceLoader' 
49   with 'edu.internet2.middleware.shibboleth.common.util.StringResourceLoader' (this is located at line 
50   41 in the default configuration file)