Added hardcoded id to all classes involved in ARP serialiazation. Intended to fix...
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / ArpCore.java
1 /* 
2  * The Shibboleth License, Version 1. 
3  * Copyright (c) 2002 
4  * University Corporation for Advanced Internet Development, Inc. 
5  * All rights reserved
6  * 
7  * 
8  * Redistribution and use in source and binary forms, with or without 
9  * modification, are permitted provided that the following conditions are met:
10  * 
11  * Redistributions of source code must retain the above copyright notice, this 
12  * list of conditions and the following disclaimer.
13  * 
14  * Redistributions in binary form must reproduce the above copyright notice, 
15  * this list of conditions and the following disclaimer in the documentation 
16  * and/or other materials provided with the distribution, if any, must include 
17  * the following acknowledgment: "This product includes software developed by 
18  * the University Corporation for Advanced Internet Development 
19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement 
20  * may appear in the software itself, if and wherever such third-party 
21  * acknowledgments normally appear.
22  * 
23  * Neither the name of Shibboleth nor the names of its contributors, nor 
24  * Internet2, nor the University Corporation for Advanced Internet Development, 
25  * Inc., nor UCAID may be used to endorse or promote products derived from this 
26  * software without specific prior written permission. For written permission, 
27  * please contact shibboleth@shibboleth.org
28  * 
29  * Products derived from this software may not be called Shibboleth, Internet2, 
30  * UCAID, or the University Corporation for Advanced Internet Development, nor 
31  * may Shibboleth appear in their name, without prior written permission of the 
32  * University Corporation for Advanced Internet Development.
33  * 
34  * 
35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK 
39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. 
40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY 
41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, 
42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  */
49
50 package edu.internet2.middleware.shibboleth.aa;
51
52 /**
53  *  Attribute Authority & Release Policy
54  *  Core structure for all ARP nodes
55  *
56  * @author     Parviz Dousti (dousti@cmu.edu)
57  * @created    June, 2002
58  */
59
60
61 import java.util.Enumeration;
62 import java.security.Principal;
63 import java.security.acl.*;
64 import java.io.Serializable;
65
66 public class ArpCore implements Serializable{
67
68         static final long serialVersionUID = 1L;
69         
70     // Attributes
71     protected String userEnv = "user.name";
72     protected Acl acl;
73
74     // Associations
75
76     // Constructors
77
78
79     // Operations
80     public Principal getCaller(){
81         // return new KerberosPrincipal(System.getProperty(userEnv));
82         return new AA_Identity(System.getProperty(userEnv));
83     }
84
85     public void makeAcl(String name)throws NotOwnerException{
86         Principal owner = getCaller();
87         acl = new AA_Acl(name, owner);
88         AclEntry entry = new AA_AclEntry(owner);
89         entry.addPermission(new AA_Permission(AA_Permission.ALL));
90         acl.addEntry(owner, entry);
91     }
92
93
94     public Acl getAcl(){
95         return acl;
96     }
97
98     public void setAcl(String user, String permit)
99         throws AAPermissionException, NotOwnerException{
100
101         Principal prince = new AA_Identity(user);
102         if(permit.equalsIgnoreCase("NONE")){
103             setAcl(prince, null);
104             return;
105         }
106         String[] permitNames = AA_Permission.names;
107         for(int i=0; i < permitNames.length; i++){
108             if(permitNames[i].equalsIgnoreCase(permit)){
109                 setAcl(prince, new AA_Permission(i));
110                 return;
111             }
112         }
113         throw new AAPermissionException("No such ACL: "+permit);
114     }
115
116     public void setAcl(Principal user, Permission permit)
117         throws NotOwnerException, AAPermissionException{
118
119         if(!setAclPermitted())
120             throw new AAPermissionException("ALL access is needed to set ACL.");
121         if(permit == null){
122             AclEntry entry = getAclEntry(user);
123             if(entry == null)
124                 throw new AAPermissionException("No ACL entry found for user: "+user);
125             if(!acl.removeEntry(getCaller(), entry))
126                 throw new AAPermissionException("No ACL entry found. System Eror");
127             return;
128         }
129
130         if(acl.checkPermission(user, permit))
131             return; // already has it
132         AclEntry entry = getAclEntry(user);
133         if(entry == null){
134             entry = new AA_AclEntry(user);
135             entry.addPermission(permit);
136             acl.addEntry(getCaller(), entry);
137         }else{
138             entry.addPermission(permit);
139         }
140         return;
141     }
142
143     private AclEntry getAclEntry(Principal user){
144         AclEntry entry = null;
145
146         Enumeration en = acl.entries();
147         while(en.hasMoreElements()){
148             entry = (AclEntry)en.nextElement();
149             if(entry.getPrincipal().equals(user))
150                 return entry;
151         }
152         return null;
153     }
154
155         
156     /**
157      * Check to see if caller has permission to remove and insert (i.e replace) for this object.
158      * Returns true if permitted.
159      */
160     
161     public boolean replacePermitted(){
162         Permission rm = new AA_Permission(AA_Permission.DELETE);
163         Permission add = new AA_Permission(AA_Permission.INSERT);
164         Principal user = getCaller();
165         if(acl.checkPermission(user, rm) && acl.checkPermission(user, add))
166             return true;
167         return false;
168     }
169
170     public boolean insertPermitted(){
171         Permission add = new AA_Permission(AA_Permission.INSERT);
172         if(acl.checkPermission(getCaller(), add))
173             return true;
174         return false;
175     }
176
177     public boolean removePermitted(){
178         Permission rm = new AA_Permission(AA_Permission.DELETE);
179         if(acl.checkPermission(getCaller(), rm))
180             return true;
181         return false;
182     }
183
184     public boolean setAclPermitted(){
185         Permission all = new AA_Permission(AA_Permission.ALL);
186         if(acl.checkPermission(getCaller(), all))
187             return true;
188         return false;
189     }
190
191
192             
193
194
195 } /* end class ArpCore */