Merge "Sonar fixes related to exceptions"
[aaf/authz.git] / cadi / aaf / src / main / java / org / onap / aaf / cadi / aaf / v2_0 / AAFLurPerm.java
1 /**
2  * ============LICENSE_START====================================================
3  * org.onap.aaf
4  * ===========================================================================
5  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
6  * ===========================================================================
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  * 
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  * 
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ============LICENSE_END====================================================
19  *
20  */
21
22 package org.onap.aaf.cadi.aaf.v2_0;
23
24 import java.lang.reflect.Constructor;
25 import java.lang.reflect.InvocationTargetException;
26 import java.net.ConnectException;
27 import java.net.URISyntaxException;
28 import java.security.Principal;
29 import java.util.Map;
30
31 import org.onap.aaf.cadi.AbsUserCache;
32 import org.onap.aaf.cadi.Access;
33 import org.onap.aaf.cadi.CadiException;
34 import org.onap.aaf.cadi.Lur;
35 import org.onap.aaf.cadi.Permission;
36 import org.onap.aaf.cadi.User;
37 import org.onap.aaf.cadi.Access.Level;
38 import org.onap.aaf.cadi.CachedPrincipal.Resp;
39 import org.onap.aaf.cadi.aaf.AAFPermission;
40 import org.onap.aaf.cadi.client.Future;
41 import org.onap.aaf.cadi.client.Rcli;
42 import org.onap.aaf.cadi.client.Retryable;
43 import org.onap.aaf.cadi.config.Config;
44 import org.onap.aaf.cadi.lur.LocalPermission;
45 import org.onap.aaf.misc.env.APIException;
46 import org.onap.aaf.misc.env.util.Split;
47
48 import aaf.v2_0.Perm;
49 import aaf.v2_0.Perms;
50
51 /**
52  * Use AAF Service as Permission Service.
53  * 
54  * This Lur goes after AAF Permissions, which are elements of Roles, not the Roles themselves.
55  * 
56  * If you want a simple Role Lur, use AAFRoleLur
57  * 
58  * @author Jonathan
59  *
60  */
61 public class AAFLurPerm extends AbsAAFLur<AAFPermission> {
62         private static final String ORG_OSAAF_CADI_OAUTH_O_AUTH2_LUR = "org.osaaf.cadi.oauth.OAuth2Lur";
63
64         /**
65          *  Need to be able to transmutate a Principal into either Person or AppID, which are the only ones accepted at this
66          *  point by AAF.  There is no "domain", aka, no "@att.com" in "ab1234@att.com".  
67          *  
68          *  The only thing that matters here for AAF is that we don't waste calls with IDs that obviously aren't valid.
69          *  Thus, we validate that the ID portion follows the rules before we waste time accessing AAF remotely
70          * @throws APIException 
71          * @throws URISyntaxException 
72          * @throws DME2Exception 
73          */
74         // Package on purpose
75         AAFLurPerm(AAFCon<?> con) throws CadiException, APIException {
76                 super(con);
77                 attachOAuth2(con);
78         }
79
80         // Package on purpose
81         AAFLurPerm(AAFCon<?> con, AbsUserCache<AAFPermission> auc) throws APIException {
82                 super(con,auc);
83                 attachOAuth2(con);
84         }
85         
86         private void attachOAuth2(AAFCon<?> con) throws APIException {
87                 String oauth2_url;
88                 Class<?> tmcls = Config.loadClass(access,"org.osaaf.cadi.oauth.TokenMgr");
89                 if(tmcls!=null) {
90                         if((oauth2_url = con.access.getProperty(Config.CADI_OAUTH2_URL,null))!=null) {
91                                 try {
92                                         Constructor<?> tmconst = tmcls.getConstructor(AAFCon.class,String.class);
93                                         Object tokMangr = tmconst.newInstance(con,oauth2_url);
94                                         @SuppressWarnings("unchecked")
95                                         Class<Lur> oa2cls = (Class<Lur>)Config.loadClass(access,ORG_OSAAF_CADI_OAUTH_O_AUTH2_LUR);
96                                         Constructor<Lur> oa2const = oa2cls.getConstructor(tmcls);
97                                         Lur oa2 = oa2const.newInstance(tokMangr);
98                                         setPreemptiveLur(oa2);
99                                 } catch (NoSuchMethodException | SecurityException | InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
100                                         throw new APIException(e);
101                                 }
102                         } else {
103                                 access.log(Level.INIT, "Both cadi-oauth jar and Property",Config.CADI_OAUTH2_URL,"is required to initialize OAuth2");
104                         }
105                 }
106         }
107
108         protected User<AAFPermission> loadUser(final Principal principal)  {
109                 final String name = principal.getName();
110 //              TODO Create a dynamic way to declare domains supported.
111                 final long start = System.nanoTime();
112                 final boolean[] success = new boolean[]{false};
113                 
114 //              new Exception("loadUser").printStackTrace();
115                 try {
116                         return aaf.best(new Retryable<User<AAFPermission>>() {
117                                 @Override
118                                 public User<AAFPermission> code(Rcli<?> client) throws CadiException, ConnectException, APIException {
119                                         Future<Perms> fp = client.read("/authz/perms/user/"+name,aaf.permsDF);
120                                         
121                                         // In the meantime, lookup User, create if necessary
122                                         User<AAFPermission> user = getUser(principal);
123                                         Principal p;
124                                         if(user!=null && user.principal == null) {
125                                                 p = new Principal() {// Create a holder for lookups
126                                                         private String n = name;
127                                                         public String getName() {
128                                                                 return n;
129                                                         }
130                                                 };
131                                         } else {
132                                                 p = principal;
133                                         }
134                                         
135                                         if(user==null) {
136                                                 addUser(user = new User<AAFPermission>(p,aaf.userExpires)); // no password
137                                         }
138                                         
139                                         // OK, done all we can, now get content
140                                         if(fp.get(aaf.timeout)) {
141                                                 success[0]=true;
142                                                 Map<String, Permission> newMap = user.newMap();
143                                                 boolean willLog = aaf.access.willLog(Level.DEBUG);
144                                                 for(Perm perm : fp.value.getPerm()) {
145                                                         user.add(newMap,new AAFPermission(perm.getNs(),perm.getType(),perm.getInstance(),perm.getAction(),perm.getRoles()));
146                                                         if(willLog) {
147                                                                 aaf.access.log(Level.DEBUG, name,"has '",perm.getType(),'|',perm.getInstance(),'|',perm.getAction(),'\'');
148                                                         }
149                                                 }
150                                                 user.setMap(newMap);
151                                         } else {
152                                                 int code;
153                                                 switch(code=fp.code()) {
154                                                         case 401:
155                                                                 aaf.access.log(Access.Level.ERROR, code, "Unauthorized to make AAF calls");
156                                                                 break;
157                                                         case 404:
158                                                                 user.setNoPerms();
159                                                                 break;
160                                                         default:
161                                                                 aaf.access.log(Access.Level.ERROR, code, fp.body());
162                                                 }
163                                         }
164
165                                         return user;
166                                 }
167                         });
168                 } catch (Exception e) {
169                         aaf.access.log(e,"Calling","/authz/perms/user/"+name);
170                         success[0]=false;
171                         return null;
172                 } finally {
173                         float time = (System.nanoTime()-start)/1000000f;
174                         aaf.access.log(Level.INFO, success[0]?"Loaded":"Load Failure",name,"from AAF in",time,"ms");
175                 }
176         }
177
178         public Resp reload(User<AAFPermission> user) {
179                 final String name = user.name;
180                 long start = System.nanoTime();
181                 boolean success = false;
182                 try {
183                         Future<Perms> fp = aaf.client(Config.AAF_DEFAULT_VERSION).read(
184                                         "/authz/perms/user/"+name,
185                                         aaf.permsDF
186                                         );
187                         
188                         // OK, done all we can, now get content
189                         if(fp.get(aaf.timeout)) {
190                                 success = true;
191                                 Map<String,Permission> newMap = user.newMap(); 
192                                 boolean willLog = aaf.access.willLog(Level.DEBUG);
193                                 for(Perm perm : fp.value.getPerm()) {
194                                         user.add(newMap, new AAFPermission(perm.getNs(),perm.getType(),perm.getInstance(),perm.getAction(),perm.getRoles()));
195                                         if(willLog) {
196                                                 aaf.access.log(Level.DEBUG, name,"has",perm.getType(),perm.getInstance(),perm.getAction());
197                                         }
198                                 }
199                                 user.renewPerm();
200                                 return Resp.REVALIDATED;
201                         } else {
202                                 int code;
203                                 switch(code=fp.code()) {
204                                         case 401:
205                                                 aaf.access.log(Access.Level.ERROR, code, "Unauthorized to make AAF calls");
206                                                 break;
207                                         default:
208                                                 aaf.access.log(Access.Level.ERROR, code, fp.body());
209                                 }
210                                 return Resp.UNVALIDATED;
211                         }
212                 } catch (Exception e) {
213                         aaf.access.log(e,"Calling","/authz/perms/user/"+name);
214                         return Resp.INACCESSIBLE;
215                 } finally {
216                         float time = (System.nanoTime()-start)/1000000f;
217                         aaf.access.log(Level.AUDIT, success?"Reloaded":"Reload Failure",name,"from AAF in",time,"ms");
218                 }
219         }
220
221         @Override
222         protected boolean isCorrectPermType(Permission pond) {
223                 return pond instanceof AAFPermission;
224         }
225
226         /* (non-Javadoc)
227          * @see org.onap.aaf.cadi.Lur#createPerm(java.lang.String)
228          */
229         @Override
230         public Permission createPerm(String p) {
231                 String[] params = Split.split('|', p);
232                 switch(params.length) {
233                         case 3:
234                                 return new AAFPermission(null,params[0],params[1],params[2]);
235                         case 4:
236                                 return new AAFPermission(params[0],params[1],params[2],params[3]);
237                         default:
238                                 return new LocalPermission(p);
239                 }
240         }
241         
242 }