openaz-xacml-test/src/test/java/org/apache/openaz/xacml/pdp/test/conformance/ConformancePIPEngine.java - incubator-retired-openaz - Git at Google

 /*
  *  Licensed to the Apache Software Foundation (ASF) under one
  *  or more contributor license agreements.  See the NOTICE file
  *  distributed with this work for additional information
  *  regarding copyright ownership.  The ASF licenses this file
  *  to you 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.
  *
  */

 /*
  *                        AT&T - PROPRIETARY
  *          THIS FILE CONTAINS PROPRIETARY INFORMATION OF
  *        AT&T AND IS NOT TO BE DISCLOSED OR USED EXCEPT IN
  *             ACCORDANCE WITH APPLICABLE AGREEMENTS.
  *
  *          Copyright (c) 2013 AT&T Knowledge Ventures
  *              Unpublished and Not for Publication
  *                     All Rights Reserved
  */
 package org.apache.openaz.xacml.pdp.test.conformance;

 import java.io.BufferedReader;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.text.ParseException;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;

 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.apache.openaz.xacml.api.Attribute;
 import org.apache.openaz.xacml.api.AttributeValue;
 import org.apache.openaz.xacml.api.DataType;
 import org.apache.openaz.xacml.api.DataTypeException;
 import org.apache.openaz.xacml.api.DataTypeFactory;
 import org.apache.openaz.xacml.api.Identifier;
 import org.apache.openaz.xacml.api.pip.PIPException;
 import org.apache.openaz.xacml.api.pip.PIPFinder;
 import org.apache.openaz.xacml.api.pip.PIPRequest;
 import org.apache.openaz.xacml.api.pip.PIPResponse;
 import org.apache.openaz.xacml.std.IdentifierImpl;
 import org.apache.openaz.xacml.std.StdMutableAttribute;
 import org.apache.openaz.xacml.std.pip.StdPIPResponse;
 import org.apache.openaz.xacml.std.pip.engines.ConfigurableEngine;
 import org.apache.openaz.xacml.util.FactoryException;

 /**
  * ConformancePIPEngine implements the {@link org.apache.openaz.xacml.api.pip.PIPFinder} interface to find
  * attributes loaded from a text file containing the following fields:
  * category-id,attribute-id,datatype-id,issuer,value
  */
 public class ConformancePIPEngine implements ConfigurableEngine {
     public static final String PROP_DESCRIPTION = ".description";
     public static final String PROP_FILE = ".file";

     private static final Log logger = LogFactory.getLog(ConformancePIPEngine.class);

     private String name;
     private String description;
     private Map<String, PIPResponse> cache = new HashMap<String, PIPResponse>();
     private List<Attribute> listAttributes = new ArrayList<Attribute>();
     private DataTypeFactory dataTypeFactory;

     public ConformancePIPEngine() {

     }

     protected DataTypeFactory getDataTypeFactory() throws FactoryException {
         if (this.dataTypeFactory == null) {
             this.dataTypeFactory = DataTypeFactory.newInstance();
         }
         return this.dataTypeFactory;
     }

     protected static String generateKey(PIPRequest pipRequest) {
         StringBuilder stringBuilder = new StringBuilder(pipRequest.getCategory().toString());
         stringBuilder.append('+');
         stringBuilder.append(pipRequest.getAttributeId().toString());
         stringBuilder.append('+');
         stringBuilder.append(pipRequest.getDataTypeId().toString());
         String issuer = pipRequest.getIssuer();
         if (issuer != null) {
             stringBuilder.append('+');
             stringBuilder.append(issuer);
         }
         return stringBuilder.toString();
     }

     protected void store(String[] fields) throws FactoryException {
         DataTypeFactory thisDataTypeFactory = this.getDataTypeFactory();
         Identifier identifierCategory = new IdentifierImpl(fields[0]);
         Identifier identifierAttribute = new IdentifierImpl(fields[1]);
         Identifier identifierDataType = new IdentifierImpl(fields[2]);
         String issuer = (fields.length == 5 ? fields[3] : null);
         String value = fields[fields.length - 1];

         DataType<?> dataType = thisDataTypeFactory.getDataType(identifierDataType);
         if (dataType == null) {
             logger.error("Unknown data type " + identifierDataType.stringValue());
             return;
         }

         AttributeValue<?> attributeValue = null;
         try {
             attributeValue = dataType.createAttributeValue(value);
         } catch (DataTypeException ex) {
             throw new FactoryException("DataTypeException creating AttributeValue", ex);
         }
         Attribute attribute = new StdMutableAttribute(identifierCategory, identifierAttribute,
                                                       attributeValue, issuer, false);
         this.listAttributes.add(attribute);
     }

     public void loadAttributes(File fileAttributes) throws IOException, ParseException, FactoryException {
         if (fileAttributes != null) {
             if (!fileAttributes.exists()) {
                 throw new FileNotFoundException("Attributes file " + fileAttributes.getAbsolutePath()
                                                 + " not found.");
             } else if (!fileAttributes.canRead()) {
                 throw new IOException("Attributes file " + fileAttributes.getAbsolutePath()
                                       + " is not readable.");
             }

             try (BufferedReader bufferedReader = new BufferedReader(
                                                     new InputStreamReader(new FileInputStream(fileAttributes)))) {
                 String line;
                 while ((line = bufferedReader.readLine()) != null) {
                     if (line.length() > 0) {
                         String[] fields = line.split("[|]", -1);
                         if (fields.length < 4) {
                             logger.warn("Not enough fields in record \"" + line + "\"");
                             continue;
                         }
                         this.store(fields);

                     }
                 }
             }
         }
     }

     protected Attribute findAttribute(PIPRequest pipRequest) {
         Attribute attributeResult = null;
         Iterator<Attribute> iterAttributes = this.listAttributes.iterator();
         while ((attributeResult == null) && iterAttributes.hasNext()) {
             Attribute attributeTest = iterAttributes.next();
             if (pipRequest.getCategory().equals(attributeTest.getCategory())
                 && pipRequest.getAttributeId().equals(attributeTest.getAttributeId())
                 && (pipRequest.getIssuer() == null || pipRequest.getIssuer()
                     .equals(attributeTest.getIssuer()))) {
                 attributeResult = attributeTest;
             }
         }
         return attributeResult;
     }

     @Override
     public PIPResponse getAttributes(PIPRequest pipRequest, PIPFinder pipFinder) throws PIPException {
         String pipRequestKey = generateKey(pipRequest);
         PIPResponse pipResponse = this.cache.get(pipRequestKey);
         if (pipResponse != null) {
             return pipResponse;
         }
         Attribute attributeMatch = this.findAttribute(pipRequest);
         if (attributeMatch == null) {
             return StdPIPResponse.PIP_RESPONSE_EMPTY;
         }
         /*
          * Iterate through the values and only return the ones that match the requested data type
          */
         List<AttributeValue<?>> matchingValues = new ArrayList<AttributeValue<?>>();
         Iterator<AttributeValue<?>> iterAttributeValues = attributeMatch.getValues().iterator();
         while (iterAttributeValues.hasNext()) {
             AttributeValue<?> attributeValue = iterAttributeValues.next();
             if (pipRequest.getDataTypeId().equals(attributeValue.getDataTypeId())) {
                 matchingValues.add(attributeValue);
             }
         }
         if (matchingValues.size() > 0) {
             Attribute attributeResponse = new StdMutableAttribute(attributeMatch.getCategory(),
                                                                   attributeMatch.getAttributeId(),
                                                                   matchingValues, attributeMatch.getIssuer(),
                                                                   false);
             pipResponse = new StdPIPResponse(attributeResponse);
             this.cache.put(pipRequestKey, pipResponse);
         }
         return pipResponse;
     }

     @Override
     public String getName() {
         return this.name;
     }

     @Override
     public String getDescription() {
         return this.description;
     }

     @Override
     public void configure(String id, Properties properties) throws PIPException {
         this.name = id;
         this.description = properties.getProperty(id + PROP_DESCRIPTION);
         if (this.description == null) {
             this.description = "PIPEngine for the Conformance tests that loads attributes from a CSV file";
         }
         String pipFile = properties.getProperty(id + PROP_FILE);
         if (pipFile != null) {
             try {
                 this.loadAttributes(new File(pipFile));
             } catch (Exception ex) {
                 logger.error("Exception loading PIP file " + pipFile, ex);
                 throw new PIPException("Exception loading PIP file " + pipFile, ex);
             }
         }
     }

     @Override
     public Collection<PIPRequest> attributesRequired() {
         return Collections.emptyList();
     }

     @Override
     public Collection<PIPRequest> attributesProvided() {
         //
         // We could return everything in our list
         //
         return Collections.emptyList();
     }

 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you 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.
	*
	*/

	/*
	* AT&T - PROPRIETARY
	* THIS FILE CONTAINS PROPRIETARY INFORMATION OF
	* AT&T AND IS NOT TO BE DISCLOSED OR USED EXCEPT IN
	* ACCORDANCE WITH APPLICABLE AGREEMENTS.
	*
	* Copyright (c) 2013 AT&T Knowledge Ventures
	* Unpublished and Not for Publication
	* All Rights Reserved
	*/
	package org.apache.openaz.xacml.pdp.test.conformance;

	import java.io.BufferedReader;
	import java.io.File;
	import java.io.FileInputStream;
	import java.io.FileNotFoundException;
	import java.io.IOException;
	import java.io.InputStreamReader;
	import java.text.ParseException;
	import java.util.ArrayList;
	import java.util.Collection;
	import java.util.Collections;
	import java.util.HashMap;
	import java.util.Iterator;
	import java.util.List;
	import java.util.Map;
	import java.util.Properties;

	import org.apache.commons.logging.Log;
	import org.apache.commons.logging.LogFactory;
	import org.apache.openaz.xacml.api.Attribute;
	import org.apache.openaz.xacml.api.AttributeValue;
	import org.apache.openaz.xacml.api.DataType;
	import org.apache.openaz.xacml.api.DataTypeException;
	import org.apache.openaz.xacml.api.DataTypeFactory;
	import org.apache.openaz.xacml.api.Identifier;
	import org.apache.openaz.xacml.api.pip.PIPException;
	import org.apache.openaz.xacml.api.pip.PIPFinder;
	import org.apache.openaz.xacml.api.pip.PIPRequest;
	import org.apache.openaz.xacml.api.pip.PIPResponse;
	import org.apache.openaz.xacml.std.IdentifierImpl;
	import org.apache.openaz.xacml.std.StdMutableAttribute;
	import org.apache.openaz.xacml.std.pip.StdPIPResponse;
	import org.apache.openaz.xacml.std.pip.engines.ConfigurableEngine;
	import org.apache.openaz.xacml.util.FactoryException;

	/**
	* ConformancePIPEngine implements the {@link org.apache.openaz.xacml.api.pip.PIPFinder} interface to find
	* attributes loaded from a text file containing the following fields:
	* category-id,attribute-id,datatype-id,issuer,value
	*/
	public class ConformancePIPEngine implements ConfigurableEngine {
	public static final String PROP_DESCRIPTION = ".description";
	public static final String PROP_FILE = ".file";

	private static final Log logger = LogFactory.getLog(ConformancePIPEngine.class);

	private String name;
	private String description;
	private Map<String, PIPResponse> cache = new HashMap<String, PIPResponse>();
	private List<Attribute> listAttributes = new ArrayList<Attribute>();
	private DataTypeFactory dataTypeFactory;

	public ConformancePIPEngine() {

	}

	protected DataTypeFactory getDataTypeFactory() throws FactoryException {
	if (this.dataTypeFactory == null) {
	this.dataTypeFactory = DataTypeFactory.newInstance();
	}
	return this.dataTypeFactory;
	}

	protected static String generateKey(PIPRequest pipRequest) {
	StringBuilder stringBuilder = new StringBuilder(pipRequest.getCategory().toString());
	stringBuilder.append('+');
	stringBuilder.append(pipRequest.getAttributeId().toString());
	stringBuilder.append('+');
	stringBuilder.append(pipRequest.getDataTypeId().toString());
	String issuer = pipRequest.getIssuer();
	if (issuer != null) {
	stringBuilder.append('+');
	stringBuilder.append(issuer);
	}
	return stringBuilder.toString();
	}

	protected void store(String[] fields) throws FactoryException {
	DataTypeFactory thisDataTypeFactory = this.getDataTypeFactory();
	Identifier identifierCategory = new IdentifierImpl(fields[0]);
	Identifier identifierAttribute = new IdentifierImpl(fields[1]);
	Identifier identifierDataType = new IdentifierImpl(fields[2]);
	String issuer = (fields.length == 5 ? fields[3] : null);
	String value = fields[fields.length - 1];

	DataType<?> dataType = thisDataTypeFactory.getDataType(identifierDataType);
	if (dataType == null) {
	logger.error("Unknown data type " + identifierDataType.stringValue());
	return;
	}

	AttributeValue<?> attributeValue = null;
	try {
	attributeValue = dataType.createAttributeValue(value);
	} catch (DataTypeException ex) {
	throw new FactoryException("DataTypeException creating AttributeValue", ex);
	}
	Attribute attribute = new StdMutableAttribute(identifierCategory, identifierAttribute,
	attributeValue, issuer, false);
	this.listAttributes.add(attribute);
	}

	public void loadAttributes(File fileAttributes) throws IOException, ParseException, FactoryException {
	if (fileAttributes != null) {
	if (!fileAttributes.exists()) {
	throw new FileNotFoundException("Attributes file " + fileAttributes.getAbsolutePath()
	+ " not found.");
	} else if (!fileAttributes.canRead()) {
	throw new IOException("Attributes file " + fileAttributes.getAbsolutePath()
	+ " is not readable.");
	}

	try (BufferedReader bufferedReader = new BufferedReader(
	new InputStreamReader(new FileInputStream(fileAttributes)))) {
	String line;
	while ((line = bufferedReader.readLine()) != null) {
	if (line.length() > 0) {
	String[] fields = line.split("[\|]", -1);
	if (fields.length < 4) {
	logger.warn("Not enough fields in record \"" + line + "\"");
	continue;
	}
	this.store(fields);

	}
	}
	}
	}
	}

	protected Attribute findAttribute(PIPRequest pipRequest) {
	Attribute attributeResult = null;
	Iterator<Attribute> iterAttributes = this.listAttributes.iterator();
	while ((attributeResult == null) && iterAttributes.hasNext()) {
	Attribute attributeTest = iterAttributes.next();
	if (pipRequest.getCategory().equals(attributeTest.getCategory())
	&& pipRequest.getAttributeId().equals(attributeTest.getAttributeId())
	&& (pipRequest.getIssuer() == null \|\| pipRequest.getIssuer()
	.equals(attributeTest.getIssuer()))) {
	attributeResult = attributeTest;
	}
	}
	return attributeResult;
	}

	@Override
	public PIPResponse getAttributes(PIPRequest pipRequest, PIPFinder pipFinder) throws PIPException {
	String pipRequestKey = generateKey(pipRequest);
	PIPResponse pipResponse = this.cache.get(pipRequestKey);
	if (pipResponse != null) {
	return pipResponse;
	}
	Attribute attributeMatch = this.findAttribute(pipRequest);
	if (attributeMatch == null) {
	return StdPIPResponse.PIP_RESPONSE_EMPTY;
	}
	/*
	* Iterate through the values and only return the ones that match the requested data type
	*/
	List<AttributeValue<?>> matchingValues = new ArrayList<AttributeValue<?>>();
	Iterator<AttributeValue<?>> iterAttributeValues = attributeMatch.getValues().iterator();
	while (iterAttributeValues.hasNext()) {
	AttributeValue<?> attributeValue = iterAttributeValues.next();
	if (pipRequest.getDataTypeId().equals(attributeValue.getDataTypeId())) {
	matchingValues.add(attributeValue);
	}
	}
	if (matchingValues.size() > 0) {
	Attribute attributeResponse = new StdMutableAttribute(attributeMatch.getCategory(),
	attributeMatch.getAttributeId(),
	matchingValues, attributeMatch.getIssuer(),
	false);
	pipResponse = new StdPIPResponse(attributeResponse);
	this.cache.put(pipRequestKey, pipResponse);
	}
	return pipResponse;
	}

	@Override
	public String getName() {
	return this.name;
	}

	@Override
	public String getDescription() {
	return this.description;
	}

	@Override
	public void configure(String id, Properties properties) throws PIPException {
	this.name = id;
	this.description = properties.getProperty(id + PROP_DESCRIPTION);
	if (this.description == null) {
	this.description = "PIPEngine for the Conformance tests that loads attributes from a CSV file";
	}
	String pipFile = properties.getProperty(id + PROP_FILE);
	if (pipFile != null) {
	try {
	this.loadAttributes(new File(pipFile));
	} catch (Exception ex) {
	logger.error("Exception loading PIP file " + pipFile, ex);
	throw new PIPException("Exception loading PIP file " + pipFile, ex);
	}
	}
	}

	@Override
	public Collection<PIPRequest> attributesRequired() {
	return Collections.emptyList();
	}

	@Override
	public Collection<PIPRequest> attributesProvided() {
	//
	// We could return everything in our list
	//
	return Collections.emptyList();
	}

	}