2 * ============LICENSE_START====================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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====================================================
22 package org.onap.aaf.cadi;
25 import java.io.FileInputStream;
26 import java.io.IOException;
27 import java.io.InputStream;
28 import java.io.PrintStream;
29 import java.io.PrintWriter;
30 import java.io.StringWriter;
31 import java.text.DateFormat;
32 import java.text.SimpleDateFormat;
33 import java.util.ArrayList;
34 import java.util.Date;
35 import java.util.List;
36 import java.util.Map.Entry;
37 import java.util.Properties;
39 import org.onap.aaf.cadi.config.Config;
40 import org.onap.aaf.cadi.config.SecurityInfo;
41 import org.onap.aaf.cadi.util.Split;
43 public class PropAccess implements Access {
44 // Sonar says cannot be static... it's ok. not too many PropAccesses created.
45 private final SimpleDateFormat iso8601 = newISO8601();
47 public static SimpleDateFormat newISO8601() {
48 return new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");
51 public static final Level DEFAULT = Level.AUDIT;
55 private Properties props;
56 private List<String> recursionProtection = null;
61 logIt = new StreamLogIt(System.out);
66 * This Constructor soly exists to instantiate Servlet Context Based Logging that will call "init" later.
69 protected PropAccess(Object o) {
70 logIt = new StreamLogIt(System.out);
71 props = new Properties();
74 public PropAccess(String ... args) {
75 this(System.out,args);
78 public PropAccess(PrintStream ps, String[] args) {
79 logIt = new StreamLogIt(ps==null?System.out:ps);
83 public PropAccess(LogIt logit, String[] args) {
87 public PropAccess(Properties p) {
91 public PropAccess(PrintStream ps, Properties p) {
92 logIt = new StreamLogIt(ps==null?System.out:ps);
96 protected void init(final LogIt logIt, final String[] args) {
98 Properties nprops=new Properties();
100 for (String arg : args) {
101 if ((eq=arg.indexOf('='))>0) {
102 nprops.setProperty(arg.substring(0, eq),arg.substring(eq+1));
108 protected synchronized void init(Properties p) {
109 // Make sure these two are set before any changes in Logging
111 level=DEFAULT.maskOf();
113 props = new Properties();
114 // First, load related System Properties
115 for (Entry<Object,Object> es : System.getProperties().entrySet()) {
116 String key = es.getKey().toString();
117 for (String start : new String[] {"cadi_","aaf_","cm_"}) {
118 if (key.startsWith(start)) {
119 props.put(key, es.getValue());
123 // Second, overlay or fill in with Passed in Props
129 String sLevel = props.getProperty(Config.CADI_LOGLEVEL);
131 level=Level.valueOf(sLevel).maskOf();
134 // Third, load any Chained Property Files
135 load(props.getProperty(Config.CADI_PROP_FILES));
137 if(sLevel==null) { // if LogLev wasn't set before, check again after Chained Load
138 sLevel = props.getProperty(Config.CADI_LOGLEVEL);
140 level=Level.valueOf(sLevel).maskOf();
143 // Setup local Symmetrical key encryption
146 symm = Symm.obtain(this);
147 } catch (CadiException e) {
148 System.err.append("FATAL ERROR: Cannot obtain Key Information.");
149 e.printStackTrace(System.err);
154 name = props.getProperty(Config.CADI_LOGNAME, name);
156 SecurityInfo.setHTTPProtocols(this);
161 private void load(String cadi_prop_files) {
162 if (cadi_prop_files==null) {
165 String prevKeyFile = props.getProperty(Config.CADI_KEYFILE);
168 for(String filename : Split.splitTrim(File.pathSeparatorChar, cadi_prop_files)) {
169 Properties fileProps = new Properties();
170 File file = new File(filename);
172 printf(Level.INIT,"Loading CADI Properties from %s",file.getAbsolutePath());
174 FileInputStream fis = new FileInputStream(file);
177 // Only load props from recursion which are not already in props
178 // meaning top Property file takes precedence
179 for(Entry<Object, Object> es : fileProps.entrySet()) {
180 if(props.get(es.getKey())==null) {
181 String key = es.getKey().toString();
182 String value = es.getValue().toString();
183 props.put(key, value);
184 if(key.contains("pass")) {
187 printf(Level.DEBUG," %s=%s",key,value);
191 String chainProp = fileProps.getProperty(Config.CADI_PROP_FILES);
192 if (chainProp!=null) {
193 if (recursionProtection==null) {
194 recursionProtection = new ArrayList<>();
195 recursionProtection.add(cadi_prop_files);
197 if (!recursionProtection.contains(chainProp)) {
198 recursionProtection.add(chainProp);
199 load(chainProp); // recurse
205 } catch (Exception e) {
206 log(e,filename,"cannot be opened");
209 printf(Level.WARN,"Warning: recursive CADI Property %s does not exist",file.getAbsolutePath());
214 for (Entry<Object, Object> es : props.entrySet()) {
215 Object value = es.getValue();
216 if (value instanceof String) {
217 String trim = ((String)value).trim();
218 // Remove Beginning/End Quotes, which might be there if mixed with Bash Props
219 int s = 0, e=trim.length()-1;
220 if (s<e && trim.charAt(s)=='"' && trim.charAt(e)=='"') {
221 trim=trim.substring(s+1,e);
223 if (trim!=value) { // Yes, I want OBJECT equals
224 props.setProperty((String)es.getKey(), trim);
228 // Reset Symm if Keyfile Changes:
229 String newKeyFile = props.getProperty(Config.CADI_KEYFILE);
230 if ((prevKeyFile!=null && newKeyFile!=null) || (newKeyFile!=null && !newKeyFile.equals(prevKeyFile))) {
232 symm = Symm.obtain(this);
233 } catch (CadiException e) {
234 System.err.append("FATAL ERROR: Cannot obtain Key Information.");
235 e.printStackTrace(System.err);
239 prevKeyFile=newKeyFile;
242 String loglevel = props.getProperty(Config.CADI_LOGLEVEL);
243 if (loglevel!=null) {
245 level=Level.valueOf(loglevel).maskOf();
246 } catch (IllegalArgumentException e) {
247 printf(Level.ERROR,"%s=%s is an Invalid Log Level",Config.CADI_LOGLEVEL,loglevel);
253 public void load(InputStream is) throws IOException {
255 load(props.getProperty(Config.CADI_PROP_FILES));
259 public void log(Level level, Object ... elements) {
260 if (willLog(level)) {
261 logIt.push(level,elements);
265 public StringBuilder buildMsg(Level level, Object[] elements) {
266 return buildMsg(name,iso8601,level,elements);
270 * Need to pass in DateFormat per thread, because not marked as thread safe
272 public static StringBuilder buildMsg(final String name, final DateFormat sdf, Level level, Object[] elements) {
273 final StringBuilder sb;
274 int end = elements.length;
276 sb = new StringBuilder();
277 write(true,sb,elements);
279 sb = new StringBuilder(
280 sdf.format(new Date())
283 sb.append(level.name());
290 if(elements[idx]!=null &&
291 elements[idx] instanceof Integer) {
293 sb.append(elements[idx]);
297 write(true,sb,elements);
303 private static boolean write(boolean first, StringBuilder sb, Object[] elements) {
305 for (Object o : elements) {
307 if(o.getClass().isArray()) {
308 first = write(first,sb,(Object[])o);
316 switch(s.charAt(l-1)) {
332 public void log(Exception e, Object... elements) {
333 StringWriter sw = new StringWriter();
334 PrintWriter pw = new PrintWriter(sw);
336 e.printStackTrace(pw);
337 log(Level.ERROR,elements,sw.toString());
341 public void printf(Level level, String fmt, Object... elements) {
342 if (willLog(level)) {
343 log(level,String.format(fmt, elements));
348 public void setLogLevel(Level level) {
349 this.level = level.maskOf();
353 public boolean willLog(Level level) {
354 return level.inMask(this.level);
358 public ClassLoader classLoader() {
359 return ClassLoader.getSystemClassLoader();
363 public String getProperty(String tag, String def) {
364 return props.getProperty(tag,def);
368 public String decrypt(String encrypted, boolean anytext) throws IOException {
369 return (encrypted!=null && (anytext==true || encrypted.startsWith(Symm.ENC)))
370 ? symm.depass(encrypted)
374 public String encrypt(String unencrypted) throws IOException {
375 return Symm.ENC+symm.enpass(unencrypted);
381 public String getProperty(String tag) {
382 return props.getProperty(tag);
386 public Properties getProperties() {
390 public void setProperty(String tag, String value) {
392 props.put(tag, value);
393 if (Config.CADI_KEYFILE.equals(tag)) {
394 // reset decryption too
396 symm = Symm.obtain(this);
397 } catch (CadiException e) {
398 System.err.append("FATAL ERROR: Cannot obtain Key Information.");
399 e.printStackTrace(System.err);
406 public interface LogIt {
407 public void push(Level level, Object ... elements) ;
410 private class StreamLogIt implements LogIt {
411 private PrintStream ps;
413 public StreamLogIt(PrintStream ps) {
417 public void push(Level level, Object ... elements) {
418 ps.println(buildMsg(level,elements));
423 public void set(LogIt logit) {
427 public void setStreamLogIt(PrintStream ps) {
428 logIt = new StreamLogIt(ps);
431 public String toString() {
432 return props.toString();