1ab8a20700564f24445b972c341cd36d8ccb1c7e
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / hs / provider / SharedMemoryShibHandle.java
1 /*
2  * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation
3  * for Advanced Internet Development, Inc. All rights reserved
4  * 
5  * 
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  * 
9  * Redistributions of source code must retain the above copyright notice, this
10  * list of conditions and the following disclaimer.
11  * 
12  * Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution, if any, must include
15  * the following acknowledgment: "This product includes software developed by
16  * the University Corporation for Advanced Internet Development
17  * <http://www.ucaid.edu> Internet2 Project. Alternately, this acknowledegement
18  * may appear in the software itself, if and wherever such third-party
19  * acknowledgments normally appear.
20  * 
21  * Neither the name of Shibboleth nor the names of its contributors, nor
22  * Internet2, nor the University Corporation for Advanced Internet Development,
23  * Inc., nor UCAID may be used to endorse or promote products derived from this
24  * software without specific prior written permission. For written permission,
25  * please contact shibboleth@shibboleth.org
26  * 
27  * Products derived from this software may not be called Shibboleth, Internet2,
28  * UCAID, or the University Corporation for Advanced Internet Development, nor
29  * may Shibboleth appear in their name, without prior written permission of the
30  * University Corporation for Advanced Internet Development.
31  * 
32  * 
33  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
34  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
35  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
36  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
37  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
38  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
39  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY
40  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
41  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
45  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46  */
47 package edu.internet2.middleware.shibboleth.hs.provider;
48
49 import org.apache.log4j.Logger;
50 import org.doomdark.uuid.UUIDGenerator;
51 import org.opensaml.SAMLNameIdentifier;
52 import org.w3c.dom.Element;
53
54 import edu.internet2.middleware.shibboleth.common.AuthNPrincipal;
55 import edu.internet2.middleware.shibboleth.common.BaseNameIdentifierMapping;
56 import edu.internet2.middleware.shibboleth.common.IdentityProvider;
57 import edu.internet2.middleware.shibboleth.common.InvalidNameIdentifierException;
58 import edu.internet2.middleware.shibboleth.common.NameIdentifierMappingException;
59 import edu.internet2.middleware.shibboleth.common.ServiceProvider;
60 import edu.internet2.middleware.shibboleth.hs.HSNameIdentifierMapping;
61
62 /**
63  * @author Walter Hoehn
64  */
65 public class SharedMemoryShibHandle extends BaseNameIdentifierMapping implements HSNameIdentifierMapping {
66 //TODO need to move the guts of this class out of the HandleRepository implementations
67         private String id;
68         protected HandleCache cache = HandleCache.instance();
69         private static Logger log = Logger.getLogger(SharedMemoryShibHandle.class.getName());
70
71         public SharedMemoryShibHandle(Element config) throws NameIdentifierMappingException {
72                 super(config);
73                 String id = ((Element) config).getAttribute("id");
74                 if (id != null || !id.equals("")) {
75                         this.id = id;
76                 }
77         }
78
79         public String getId() {
80                 return id;
81         }
82
83         public SAMLNameIdentifier getNameIdentifierName(
84                 AuthNPrincipal principal,
85                 ServiceProvider sProv,
86                 IdentityProvider idProv)
87                 throws NameIdentifierMappingException {
88
89                 if (principal == null) {
90                         log.error("A principal must be supplied for Attribute Query Handle creation.");
91                         throw new IllegalArgumentException("A principal must be supplied for Attribute Query Handle creation.");
92                 }
93
94                 String handle = UUIDGenerator.getInstance().generateRandomBasedUUID().toString();
95                 log.debug("Assigning handle (" + handle + ") to principal (" + principal.getName() + ").");
96                 synchronized (cache.handleEntries) {
97                         cache.handleEntries.put(handle, createHandleEntry(principal));
98                 }
99                 
100                 return new SAMLNameIdentifier(handle, "qualifier", getNameIdentifierFormat().toString());
101
102         }
103
104         public AuthNPrincipal getPrincipal(SAMLNameIdentifier nameId, ServiceProvider sProv, IdentityProvider idProv)
105                 throws NameIdentifierMappingException, InvalidNameIdentifierException {
106
107                 synchronized (cache.handleEntries) {
108                         if (!cache.handleEntries.containsKey(nameId.getName())) {
109                                 log.debug("The Name Mapping Cache does not contain an entry for this Attribute Query Handle.");
110                                 throw new InvalidNameIdentifierException("The Name Mapping Cache does not contain an entry for this Attribute Query Handle.");
111                         }
112                 }
113
114                 HandleEntry handleEntry;
115                 synchronized (cache.handleEntries) {
116                         handleEntry = (HandleEntry) cache.handleEntries.get(nameId.getName());
117                 }
118
119                 if (handleEntry.isExpired()) {
120                         log.debug("Attribute Query Handle is expired.");
121                         synchronized (cache.handleEntries) {
122                                 cache.handleEntries.remove(nameId.getName());
123                         }
124                         throw new InvalidNameIdentifierException("Attribute Query Handle is expired.");
125                 } else {
126                         log.debug("Attribute Query Handle recognized.");
127                         return handleEntry.principal;
128                 }
129         }
130
131
132 }