aboutsummaryrefslogtreecommitdiffstats
path: root/core/src/main/java/com/att/cadi/AbsUserCache.java
blob: 0229a71dada2e0ef51db1f86cfff101178974ba1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
/*******************************************************************************
 * ============LICENSE_START====================================================
 * * org.onap.aai
 * * ===========================================================================
 * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * * Copyright © 2017 Amdocs
 * * ===========================================================================
 * * Licensed under the Apache License, Version 2.0 (the "License");
 * * you may not use this file except in compliance with the License.
 * * You may obtain a copy of the License at
 * * 
 *  *      http://www.apache.org/licenses/LICENSE-2.0
 * * 
 *  * Unless required by applicable law or agreed to in writing, software
 * * distributed under the License is distributed on an "AS IS" BASIS,
 * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * * See the License for the specific language governing permissions and
 * * limitations under the License.
 * * ============LICENSE_END====================================================
 * *
 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 * *
 ******************************************************************************/
package com.att.cadi;


import java.security.Principal;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Timer;
import java.util.TimerTask;
import java.util.TreeMap;
import java.util.concurrent.ConcurrentHashMap;

import com.att.cadi.Access.Level;
import com.att.cadi.CachedPrincipal.Resp;

/**
 * Implement Fast lookup and Cache for Local User Info
 * 
 * Include ability to add and remove Users
 * 
 * Also includes a Timer Thread (when necessary) to invoke cleanup on expiring Credentials
 * 
 *
 */
public abstract class AbsUserCache<PERM extends Permission> {
	static final int MIN_INTERVAL = 15000;
	static final int MAX_INTERVAL = 1000*60*5; // 5 mins
	private static Timer timer;
	// Map of userName to User
	private final Map<String, User<PERM>> userMap;
	private final Map<String, Miss> missMap;
	private Clean clean;
	protected Access access;
//	private final static Permission teaser = new LocalPermission("***NoPERM****");
	
	protected AbsUserCache(Access access, long cleanInterval, int highCount, int usageCount) {
		this.access = access;
		userMap = new ConcurrentHashMap<String, User<PERM>>();
		missMap = new TreeMap<String,Miss>();
		if(cleanInterval>0) {
			cleanInterval = Math.max(MIN_INTERVAL, cleanInterval);
			synchronized(AbsUserCache.class) { // Lazy instantiate.. in case there is no cleanup needed
				if(timer==null) {
					timer = new Timer("CADI Cleanup Timer",true);
				}
				
				timer.schedule(clean = new Clean(access, cleanInterval, highCount, usageCount), cleanInterval, cleanInterval);
				access.log(Access.Level.INIT, "Cleaning Thread initialized with interval of",cleanInterval, "ms and max objects of", highCount);
			}
		}
	}
	
	@SuppressWarnings("unchecked")
	public AbsUserCache(AbsUserCache<PERM> cache) {
		this.access = cache.access;
		userMap = cache.userMap;
		missMap = cache.missMap;
		synchronized(AbsUserCache.class) {
			if(cache.clean!=null && cache.clean.lur==null && this instanceof CachingLur) {
				cache.clean.lur=(CachingLur<PERM>)this;
			}
		}
	}

	protected void setLur(CachingLur<PERM> lur) {
		if(clean!=null)clean.lur = lur;
		
	}
	
	protected void addUser(User<PERM> user) {
		userMap.put(user.principal.getName(), user);
	}

	// Useful for looking up by WebToken, etc.
	protected void addUser(String key, User<PERM> user) {
		userMap.put(key, user);
	}
	
	/**
	 * Add miss to missMap.  If Miss exists, or too many tries, returns false.
	 * 
	 * otherwise, returns true to allow another attempt.
	 * 
	 * @param key
	 * @param bs
	 * @return
	 */
	protected boolean addMiss(String key, byte[] bs) {
		Miss miss = missMap.get(key);
		if(miss==null) {
			synchronized(missMap) {
				missMap.put(key, new Miss(bs,clean==null?MIN_INTERVAL:clean.timeInterval));
			}
			return true;
		}
		return miss.add(bs); 
	}

	protected Miss missed(String key) {
		return missMap.get(key);
	}

	protected User<PERM> getUser(String userName) {
		User<PERM> u = userMap.get(userName);
		if(u!=null) {
			u.incCount();
		}
		return u;
	}
	
	protected User<PERM> getUser(Principal principal) {
		return getUser(principal.getName()); 
	}
	
	/**
	 * Removes User from the Cache
	 * @param user
	 */
	protected void remove(User<PERM> user) {
		userMap.remove(user.principal.getName());
	}
	
	/**
	 * Removes user from the Cache
	 * 
	 * @param user
	 */
	public void remove(String user) {
		Object o = userMap.remove(user);
		if(o!=null) {
			access.log(Level.INFO, user,"removed from Client Cache by Request");
		}
	}
	
	/**
	 * Clear all users from the Client Cache
	 */
	public void clearAll() {
		userMap.clear();
	}
	
	public final List<DumpInfo> dumpInfo() {
		List<DumpInfo> rv = new ArrayList<DumpInfo>();
		for(User<PERM> user : userMap.values()) {
			rv.add(new DumpInfo(user));
		}
		return rv;
	}

	/**
	 * The default behavior of a LUR is to not handle something exclusively.
	 */
	public boolean handlesExclusively(Permission pond) {
		return false;
	}
	
	/**
	 * Container calls when cleaning up... 
	 * 
	 * If overloading in Derived class, be sure to call "super.destroy()"
	 */
	public void destroy() {
		if(timer!=null) {
			timer.purge();
			timer.cancel();
		}
	}
	
	

	// Simple map of Group name to a set of User Names
	//	private Map<String, Set<String>> groupMap = new HashMap<String, Set<String>>();

	/**
	 * Class to hold a small subset of the data, because we don't want to expose actual Permission or User Objects
	 */
	public final class DumpInfo {
		public String user;
		public List<String> perms;
		
		public DumpInfo(User<PERM> user) {
			this.user = user.principal.getName();
			perms = new ArrayList<String>(user.perms.keySet());
		}
	}
	
	/**
	 * Clean will examine resources, and remove those that have expired.
	 * 
	 * If "highs" have been exceeded, then we'll expire 10% more the next time.  This will adjust after each run
	 * without checking contents more than once, making a good average "high" in the minimum speed.
	 * 
	 *
	 */
	private final class Clean extends TimerTask {
		private final Access access;
		private CachingLur<PERM> lur;
		
		// The idea here is to not be too restrictive on a high, but to Expire more items by 
		// shortening the time to expire.  This is done by judiciously incrementing "advance"
		// when the "highs" are exceeded.  This effectively reduces numbers of cached items quickly.
		private final int high;
		private long advance;
		private final long timeInterval;
		private final int usageTriggerCount;
		
		public Clean(Access access, long cleanInterval, int highCount, int usageTriggerCount) {
			this.access = access;
			lur = null;
			high = highCount;
			timeInterval = cleanInterval;
			advance = 0;
			this.usageTriggerCount=usageTriggerCount;
		}
		public void run() {
			int renewed = 0;
			int count = 0;
			int total = 0;
			try {
				// look at now.  If we need to expire more by increasing "now" by "advance"
				ArrayList<User<PERM>> al = new ArrayList<User<PERM>>(userMap.values().size());
				al.addAll(0, userMap.values());
				long now = System.currentTimeMillis() + advance;
				for(User<PERM> user : al) {
					++total;
						if(user.count>usageTriggerCount) {
	//						access.log(Level.AUDIT, "Checking Thread", new Date(now));
							boolean touched = false, removed=false;
							if(user.principal instanceof CachedPrincipal) {
								CachedPrincipal cp = (CachedPrincipal)user.principal;
								if(cp.expires() < now) {
									switch(cp.revalidate()) {
										case INACCESSIBLE:
											access.log(Level.AUDIT, "AAF Inaccessible.  Keeping credentials");
											break;
										case REVALIDATED:
											user.resetCount();
			//								access.log(Level.AUDIT, "CACHE revalidated credentials");
											touched = true;
											break;
										default:
											user.resetCount();
											remove(user);
											++count;
											removed = true;
											break;
									}
								}
							}
						
	//						access.log(Level.AUDIT, "User Perm Expires", new Date(user.permExpires));
							if(!removed && lur!=null && user.permExpires<= now ) {
	//							access.log(Level.AUDIT, "Reloading");
								if(lur.reload(user).equals(Resp.REVALIDATED)) {
									user.renewPerm();
									access.log(Level.DEBUG, "Reloaded Perms for",user);
									touched = true;
								}
							}
							user.resetCount();
							if(touched) {
								++renewed;
							}
	
						} else {
							if(user.permExpired()) {
								remove(user);
								++count;
							}
						}
				}
				
				// Clean out Misses
				int missTotal = missMap.keySet().size();
				int miss = 0;
				if(missTotal>0) {
					ArrayList<String> keys = new ArrayList<String>(missTotal);
					keys.addAll(missMap.keySet());
					for(String key : keys) {
						Miss m = missMap.get(key);
						if(m!=null && m.timestamp<System.currentTimeMillis()) {
							synchronized(missMap) {
								missMap.remove(key);
							}
							access.log(Level.INFO, key, "has been removed from Missed Credential Map (" + m.tries + " invalid tries)");
							++miss;
						}
					}
				}
				
				if(count+renewed+miss>0) {
					access.log(Level.INFO, (lur==null?"Cache":lur.getClass().getSimpleName()), "removed",count,
						"and renewed",renewed,"expired Permissions out of", total,"and removed", miss, "password misses out of",missTotal);
				}
	
				// If High (total) is reached during this period, increase the number of expired services removed for next time.
				// There's no point doing it again here, as there should have been cleaned items.
				if(total>high) {
					// advance cleanup by 10%, without getting greater than timeInterval.
					advance = Math.min(timeInterval, advance+(timeInterval/10));
				} else {
					// reduce advance by 10%, without getting lower than 0.
					advance = Math.max(0, advance-(timeInterval/10));
				}
			} catch (Exception e) {
				access.log(Level.ERROR,e.getMessage());
			}
		}
	}
	
	public static class Miss {
		private static final int MAX_TRIES = 3;

		long timestamp;
		byte[][] array;

		private long timetolive;

		private int tries;
		
		public Miss(byte[] first, long timeInterval) {
			array = new byte[MAX_TRIES][];
			array[0]=first;
			timestamp = System.currentTimeMillis() + timeInterval;
			this.timetolive = timeInterval;
			tries = 1;
		}
		
		public boolean mayContinue(byte[] bs) {
			if(++tries > MAX_TRIES) return false;
			for(byte[] a : array) {
				if(a==null)return true;
				if(equals(a,bs)) {
					return false;
				}
			}
			return true;
		}

		public synchronized boolean add(byte[] bc) {
			if(++tries>MAX_TRIES)return false;
			timestamp = System.currentTimeMillis()+timetolive;
			for(int i=0;i<MAX_TRIES;++i) {
				if(array[i]==null) {
					array[i]=bc;
					return true; // add to array, and allow more tries
				} else if(equals(array[i],bc)) {
					return false;
				}
			}
			return false; // no more tries until cache cleared.
		}
		
		private boolean equals(byte[] src, byte[] target) {
			if(target.length==src.length) {
				for(int j=0;j<src.length;++j) {
					if(src[j]!=target[j]) return false;
				}
				return true; // same length and same chars
			}
			return false;
		}
	}
	
	/**
	 * Report on state
	 */
	public String toString() {
		return getClass().getSimpleName() + 
				" Cache:\n  Users Cached: " +
				userMap.size() +
				"\n  Misses Saved: " +
				missMap.size() +
				'\n';
				
	}

	public void clear(Principal p, StringBuilder sb) {
		sb.append(toString());
		userMap.clear();
		missMap.clear();
		access.log(Level.AUDIT, p.getName(),"has cleared User Cache in",getClass().getSimpleName());
		sb.append("Now cleared\n");
	}

}