The TrustBuilder2. Framework for Trust. Negotiation

Transcription

1 The TrustBuilder2 Framework for Trust Negotiation Adam J. Lee and Kenneth J. Perano Copyright (c) 2007 Sandia Corporation

2 Overview Copyright (c) 2007 Sandia Corporation. Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains certain rights in this software. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the Sandia Corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Page 2 of 305

3 Package edu.uiuc.cs.trustbuilder2 Page 3 of 305

4 edu.uiuc.cs.trustbuilder2.constants edu.uiuc.cs.trustbuilder2 Class Constants java.lang.object +-edu.uiuc.cs.trustbuilder2.constants public class Constants extends Object This class serves as a common location for constants used by TrustBuilder2. The only exception is the "configfile" field of this class, which is not a constant. This field can be overwritten by the application to use a non-default config file location. Created: 1/15/2006 Field Summary public static public static final public static final public static final public static final public static final public static final configfile Path to the configuration file FALSE false Value: false INVALID_SESSION_ID An invalid session identifier Value: -1 NEW_SESSION_ID A flag indicating that this begins a new session Value: -2 SIG_MATERIAL_LENGTH How many bytes of signature material should each side donate? Value: 20 TB2_VERSION The TrustBuilder2 version number Value: 0.1 TRUE true Value: true Constructor Summary public Constants() Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait (continued on next page) Page 4 of 305

5 edu.uiuc.cs.trustbuilder2.constants Fields (continued from last page) INVALID_SESSION_ID public static final long INVALID_SESSION_ID An invalid session identifier Constant value: -1 NEW_SESSION_ID public static final long NEW_SESSION_ID A flag indicating that this begins a new session Constant value: -2 TB2_VERSION public static final double TB2_VERSION The TrustBuilder2 version number Constant value: 0.1 SIG_MATERIAL_LENGTH public static final int SIG_MATERIAL_LENGTH TRUE How many bytes of signature material should each side donate? Constant value: 20 public static final java.lang.string TRUE FALSE true Constant value: true public static final java.lang.string FALSE false Constant value: false configfile public static java.lang.string configfile Path to the configuration file Constructors Constants public Constants() Page 5 of 305

6 edu.uiuc.cs.trustbuilder2.invalidconfigurationexception edu.uiuc.cs.trustbuilder2 Class InvalidConfigurationException java.lang.object +-java.lang.throwable +-java.lang.exception +-edu.uiuc.cs.trustbuilder2.trustbuilderexception +-edu.uiuc.cs.trustbuilder2.invalidconfigurationexception All Implemented Interfaces: Serializable public class InvalidConfigurationException extends TrustBuilderException An exception thrown by TrustBuilder2 classes when they are constructed with unacceptable configurations. Constructor Summary public InvalidConfigurationException() Default constructor public InvalidConfigurationException(String msg) Creates an InvalidFormatException with the given message Methods inherited from class java.lang.throwable fillinstacktrace, getcause, getlocalizedmessage, getmessage, getstacktrace, initcause, printstacktrace, printstacktrace, printstacktrace, setstacktrace, tostring Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Constructors InvalidConfigurationException public InvalidConfigurationException() Default constructor InvalidConfigurationException public InvalidConfigurationException(String msg) Creates an InvalidFormatException with the given message (continued on next page) Page 6 of 305

7 edu.uiuc.cs.trustbuilder2.invalidconfigurationexception msg - A message related to this exception (continued from last page) Page 7 of 305

8 edu.uiuc.cs.trustbuilder2.invalidformatexception edu.uiuc.cs.trustbuilder2 Class InvalidFormatException java.lang.object +-java.lang.throwable +-java.lang.exception +-edu.uiuc.cs.trustbuilder2.trustbuilderexception +-edu.uiuc.cs.trustbuilder2.invalidformatexception All Implemented Interfaces: Serializable public class InvalidFormatException extends TrustBuilderException The InvalidFormatException is thrown whenever TrustBuilder processes a TrustMessage whose format is incorrect. Examples include: the continueflag flag is false, but there is no StatusBrick An InitBrick is sent with no signature material contribution Typically the rule with TrustBuilder2 is that invalid messages are grounds to terminate the session immediately, rather than sending an error response to the remote party. Hence, in these circumstances, an exception will be thrown. Created: 2/12/2006 Constructor Summary public InvalidFormatException() Default constructor public InvalidFormatException(String msg) Creates an InvalidFormatException with the given message Methods inherited from class java.lang.throwable fillinstacktrace, getcause, getlocalizedmessage, getmessage, getstacktrace, initcause, printstacktrace, printstacktrace, printstacktrace, setstacktrace, tostring Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Constructors InvalidFormatException public InvalidFormatException() Default constructor Page 8 of 305

9 edu.uiuc.cs.trustbuilder2.invalidformatexception InvalidFormatException public InvalidFormatException(String msg) Creates an InvalidFormatException with the given message msg - A message related to this exception Page 9 of 305

10 edu.uiuc.cs.trustbuilder2.trustbuilder2 edu.uiuc.cs.trustbuilder2 Class TrustBuilder2 java.lang.object +-edu.uiuc.cs.trustbuilder2.trustbuilder2 All Implemented Interfaces: TrustBuilder2Interface public class TrustBuilder2 extends Object implements TrustBuilder2Interface The main TrustBuilder2 object. This object is responsible for carrying out all steps of the trust negotiation process. For instance, a TrustBuilder2 object (aka "agent") is responsible for managing the state associated with each active negotiation, managing which plug-ins are detected and supported, and organizing the strategies, policy engines, and compliance checkers supported by the local installation. Created: 1/29/2006 Field Summary public static final public static final public static final public static final KEY_CONFIGURATION Properties key used to load up Configurations KEY_TB2_LOG Properties key for the logging configuration information KEY_TB2_ROOT Properties key for the TB2 root directory KEY_TB2_SECURE_RANDOM Properties key specifying the type of SecureRandom object to use Constructor Summary public Method Summary boolean TrustBuilder2(String configfile) TrustBuilder2 constructor. finishsessionestablishment(trustmessage message) This method is called by the initiator of a TrustNegotiation after receiving a response TrustMessage from the responder. TrustMessage TrustMessage int generateinitmessage() This method is called to generate a new InitMessage to be sent to a remote party. generateresourcerequest(long localsessionid, String resourceid) Generates a TrustMessage requesting access to the provided resource ID within the context of the provided session. getactivesessioncount() Returns a count of the number of active sessions being managed by this TrustBuilder2 object. Page 10 of 305

11 edu.uiuc.cs.trustbuilder2.trustbuilder2 Session TrustMessage TrustMessage getsession(long sessionid) Returns the Session object associated with a given session id if it exists negotiate(trustmessage message) Main trust negotiation method. processinitmessage(trustmessage message) Given an input TrustMessage containing only an InitBrick, generate a return TrustMessage to send back to the other party. Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Methods inherited from interface edu.uiuc.cs.trustbuilder2.trustbuilder2interface finishsessionestablishment, generateinitmessage, getactivesessioncount, negotiate, processinitmessage Fields KEY_TB2_ROOT public static final java.lang.string KEY_TB2_ROOT Properties key for the TB2 root directory KEY_TB2_LOG public static final java.lang.string KEY_TB2_LOG Properties key for the logging configuration information KEY_TB2_SECURE_RANDOM public static final java.lang.string KEY_TB2_SECURE_RANDOM Properties key specifying the type of SecureRandom object to use KEY_CONFIGURATION public static final java.lang.string KEY_CONFIGURATION Properties key used to load up Configurations Constructors TrustBuilder2 public TrustBuilder2(String configfile) TrustBuilder2 constructor. To be properly initialized, TrustBuilder2 requires a properties file that specifies the supported components and identifies which plugins should be loaded. (continued on next page) Page 11 of 305

12 edu.uiuc.cs.trustbuilder2.trustbuilder2 Methods (continued from last page) configfile - The configuration file to use for this TB2 instance generateinitmessage public TrustMessage generateinitmessage() throws StateException This method is called to generate a new InitMessage to be sent to a remote party. Internally, this triggers the creation of state management objects (e.g., a Session object) for this negotiation session. This method returns a TrustMessage which contains an InitBrick that should be passed to the remote party with whom a trust negotiation will take place. A TrustMessage containing an InitBrick that should be sent to the remote negotiation party. Throws: StateException - if we're out of session id numbers processinitmessage public TrustMessage processinitmessage(trustmessage message) throws InvalidFormatException Given an input TrustMessage containing only an InitBrick, generate a return TrustMessage to send back to the other party. This method is called by the responder in a negotiation after they receive an initial InitBrick. message - The TrustMessage containing the InitBrick A TrustMessage containing a response InitBrick Throws: InvalidFormatException - if the InitBrick is either not present or improperly formatted. finishsessionestablishment public boolean finishsessionestablishment(trustmessage message) This method is called by the initiator of a TrustNegotiation after receiving a response TrustMessage from the responder. This method finalizes the Session parameters based on the InitBrick returned by the negotiation responder. If this method returns true, the initator can then initiate a trust negotiation with the remote party. Any error conditions caught during this process are the fault of the remote party and thus no resonse TrustMessage needs to be sent, we simply close the connection. message - the TrustMessage returned by the remote party true if the session established correctly, false otherwise generateresourcerequest public TrustMessage generateresourcerequest(long localsessionid, String resourceid) Generates a TrustMessage requesting access to the provided resource ID within the context of the provided session. (continued on next page) Page 12 of 305

13 edu.uiuc.cs.trustbuilder2.trustbuilder2 (continued from last page) localsessionid - The local ID for the Session in which this request will take place resourceid - The resource to request access to A TrustMessage that begins a negotiation for the requested resource negotiate public TrustMessage negotiate(trustmessage message) throws InvalidFormatException, StrategyException Main trust negotiation method. This method takes a TrustMessage from the remote party, processes the TrustBricks contained in that message and generates a response. message - The TrustMessage object sent by the remote party. A response TrustMessage object that is to be sent to the remote party. Throws: InvalidFormatException - if the TrustMessage is improperly formatted StrategyException - if the strategy module encounters an unrecoverable error getactivesessioncount public int getactivesessioncount() Returns a count of the number of active sessions being managed by this TrustBuilder2 object. The number of active sessions managed by this TrustBuilder2 object getsession public Session getsession(long sessionid) Returns the Session object associated with a given session id if it exists sessionid - The session id whose Session object we want The Session object associated with sessionid Page 13 of 305

14 edu.uiuc.cs.trustbuilder2.trustbuilder2interface edu.uiuc.cs.trustbuilder2 Interface TrustBuilder2Interface All Known Implementing Classes: TrustBuilder2 public interface TrustBuilder2Interface extends Interface implemented by the TrustBuilder2 agent process. Created: 1/10/2006 Method Summary boolean TrustMessage int TrustMessage TrustMessage finishsessionestablishment(trustmessage inmessage) This method is called by the initiator of a TrustNegotiation after receiving a response TrustMessage from the responder. generateinitmessage() This method is called to generate a new InitMessage to be sent to a remote party. getactivesessioncount() Returns a count of the number of active sessions being managed by this TrustBuilder2 object. negotiate(trustmessage inmessage) Main trust negotiation method. processinitmessage(trustmessage inmessage) Given an input TrustMessage containing only an InitBrick, generate a return TrustMessage to send back to the other party. Methods generateinitmessage public TrustMessage generateinitmessage() throws StateException This method is called to generate a new InitMessage to be sent to a remote party. Internally, this triggers the creation of state management objects (e.g., a Session object) for this negotiation session. This method returns a TrustMessage which contains an InitBrick that should be passed to the remote party with whom a trust negotiation will take place. A TrustMessage containing an InitBrick that should be sent to the remote negotiation party. Throws: StateException - if we're out of session id numbers processinitmessage public TrustMessage processinitmessage(trustmessage inmessage) throws InvalidFormatException Page 14 of 305

15 edu.uiuc.cs.trustbuilder2.trustbuilder2interface (continued from last page) Given an input TrustMessage containing only an InitBrick, generate a return TrustMessage to send back to the other party. This method is called by the responder in a negotiation after they receive an initial InitBrick. inmessage - The TrustMessage containing the InitBrick A TrustMessage containing a response InitBrick Throws: InvalidFormatException - if the InitBrick is either not present or improperly formatted. finishsessionestablishment public boolean finishsessionestablishment(trustmessage inmessage) This method is called by the initiator of a TrustNegotiation after receiving a response TrustMessage from the responder. This method finalizes the Session parameters based on the InitBrick returned by the negotiation responder. If this method returns true, the initator can then initiate a trust negotiation with the remote party. Any error conditions caught during this process are the fault of the remote party and thus no resonse TrustMessage needs to be sent, we simply close the connection. inmessage - the TrustMessage returned by the remote party true if the session established correctly, false otherwise negotiate public TrustMessage negotiate(trustmessage inmessage) throws InvalidFormatException, StrategyException Main trust negotiation method. This method takes a TrustMessage from the remote party, processes the TrustBricks contained in that message and generates a response. inmessage - The TrustMessage object sent by the remote party. A responsee TrustMessage object that is to be sent to the remote party. Throws: InvalidFormatException - if the TrustMessage is improperly formatted StrategyException - if the strategy module encounters an irrecoverable error getactivesessioncount public int getactivesessioncount() Returns a count of the number of active sessions being managed by this TrustBuilder2 object. The number of active sessions managed by this TrustBuilder2 object Page 15 of 305

16 edu.uiuc.cs.trustbuilder2.trustbuilderexception edu.uiuc.cs.trustbuilder2 Class TrustBuilderException java.lang.object +-java.lang.throwable +-java.lang.exception +-edu.uiuc.cs.trustbuilder2.trustbuilderexception All Implemented Interfaces: Serializable Direct Known Subclasses: CredentialException, StrategyException, StateException, QueryException, InvalidLoaderFileException, ComplianceCheckerException, InvalidConfigurationException, InvalidFormatException public class TrustBuilderException extends Exception Generic TrustBuilder exception Created: 2/5/2006 Constructor Summary public TrustBuilderException() Default constructor. public TrustBuilderException(String message) Constructs a new TrustBuilderException with the specified message. Methods inherited from class java.lang.throwable fillinstacktrace, getcause, getlocalizedmessage, getmessage, getstacktrace, initcause, printstacktrace, printstacktrace, printstacktrace, setstacktrace, tostring Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Constructors TrustBuilderException public TrustBuilderException() Default constructor. TrustBuilderException public TrustBuilderException(String message) Constructs a new TrustBuilderException with the specified message. Page 16 of 305

17 edu.uiuc.cs.trustbuilder2.trustbuilderexception (continued from last page) message - The message encapsulated in this Exception Page 17 of 305

18 Package edu.uiuc.cs.trustbuilder2.compliance Page 18 of 305

19 edu.uiuc.cs.trustbuilder2.compliance.compliancecheckerexception edu.uiuc.cs.trustbuilder2.compliance Class ComplianceCheckerException java.lang.object +-java.lang.throwable +-java.lang.exception +-edu.uiuc.cs.trustbuilder2.trustbuilderexception +-edu.uiuc.cs.trustbuilder2.compliance.compliancecheckerexception All Implemented Interfaces: Serializable public class ComplianceCheckerException extends TrustBuilderException Exception class thrown by compliance checkers Constructor Summary public ComplianceCheckerException() Default constructor. public ComplianceCheckerException(String message) Constructs a new ComplianceCheckerxception with the specified message. Methods inherited from class java.lang.throwable fillinstacktrace, getcause, getlocalizedmessage, getmessage, getstacktrace, initcause, printstacktrace, printstacktrace, printstacktrace, setstacktrace, tostring Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Constructors ComplianceCheckerException public ComplianceCheckerException() Default constructor. ComplianceCheckerException public ComplianceCheckerException(String message) Constructs a new ComplianceCheckerxception with the specified message. Page 19 of 305

20 edu.uiuc.cs.trustbuilder2.compliance.compliancecheckerexception (continued from last page) message - The message encapsulated in this Exception Page 20 of 305

21 edu.uiuc.cs.trustbuilder2.compliance.compliancecheckerinterface edu.uiuc.cs.trustbuilder2.compliance Interface ComplianceCheckerInterface All Superinterfaces: ConfigurablePlugin, Plugin All Known Implementing Classes: JessComplianceChecker, ComplianceCheckerMediator public interface ComplianceCheckerInterface extends ConfigurablePlugin The interface followed by compliance checkers used by the TrustBuilder2 runtime system. In general, a compliance checker will take as arguments a policy and a set of credentials and return either true (if the credentials can satisfy the given policy) or false (if they cannot). If the policy is determined to be satisfied, then the compliance checker will return either a set of satisfying credentials used (if it is a Type 2 compliance checker) or all possible satisfying sets of credentials that could be used to satisfy the policy (if it is a type 3 compliance checker). For more information on compliance checker types, see: Bryan Smith, Kent E. Seamons, and Michael D. Jones, "Responding to Policies at Runtime in TrustBuilder," 5th International Workshop on Policies in Distributed Systems (POLICY 2004), June Field Summary public static final public static final public static final TYPE_2 Type 2 compliance checkers return only one satisfying set Value: 2 TYPE_3 Type 3 compliance checkers return the set of all satisfying sets Value: 3 TYPE_ERROR This indicates that the compliance checker is no configured properly Value: -1 Method Summary int List Decision getcompliancecheckertype() This method returns a type code indicating which type of compliance checker the implementing class is configured as. getsupportedpolicyclasses() Returns a List of the currently supported policy types. makedecision(session sess, AbstractPolicyBrick policy, Collection chains, Collection claims) This method takes a policy and a set of credentials and returns a decision indicating whether (some subset of) the given credentials satisfy the provided policy. Methods inherited from interface edu.uiuc.cs.trustbuilder2.plugins.configurableplugin configure Methods inherited from interface edu.uiuc.cs.trustbuilder2.plugins.plugin getname Page 21 of 305

22 edu.uiuc.cs.trustbuilder2.compliance.compliancecheckerinterface Fields TYPE_ERROR public static final int TYPE_ERROR This indicates that the compliance checker is no configured properly Constant value: -1 TYPE_2 public static final int TYPE_2 Type 2 compliance checkers return only one satisfying set Constant value: 2 TYPE_3 public static final int TYPE_3 Type 3 compliance checkers return the set of all satisfying sets Constant value: 3 Methods getcompliancecheckertype public int getcompliancecheckertype() This method returns a type code indicating which type of compliance checker the implementing class is configured as. The code TYPE_2 indicates that the implementing class is configured as a type 2 compliance checker and thus returns only one satisfying set of credentials with each decision. The code TYPE_3 indicates that the compliance checker is configured as a type 3 checker and will return a set of all possible satisfying sets for a given access decision. TYPE_ERROR is returned if the implementing class is not properly configured. ComplianceCheckerInterface.TYPE_2, ComplianceCheckerInterface.TYPE_3, or ComplianceCheckerInterface.TYPE_ERROR, as described above makedecision public Decision makedecision(session sess, AbstractPolicyBrick policy, Collection chains, Collection claims) throws ComplianceCheckerException This method takes a policy and a set of credentials and returns a decision indicating whether (some subset of) the given credentials satisfy the provided policy. sess - The session that this decision will be made in policy - The policy to attempt to satisfy chains - A collection of credential chains used to attempt to satisfy the above policy A Decision object reflecting the compliance checker's decision. Page 22 of 305

23 edu.uiuc.cs.trustbuilder2.compliance.compliancecheckerinterface (continued from last page) Throws: ComplianceCheckerException - On error during compliance checking IllegalArgumentException - If any argument is incorrect getsupportedpolicyclasses public List getsupportedpolicyclasses() Returns a List of the currently supported policy types. A List of the currently supported policy types Page 23 of 305

24 edu.uiuc.cs.trustbuilder2.compliance.compliancecheckermediator edu.uiuc.cs.trustbuilder2.compliance Class ComplianceCheckerMediator java.lang.object +-edu.uiuc.cs.trustbuilder2.plugins.abstractmediator +-edu.uiuc.cs.trustbuilder2.compliance.compliancecheckermediator All Implemented Interfaces: ComplianceCheckerInterface, MediatorInterface public final class ComplianceCheckerMediator extends AbstractMediator implements MediatorInterface, ComplianceCheckerInterface Mediates access to all compliance checkers supported by TrustBuilder2. This mediator allows for "call" plugins to be registered to interpose between the rest of the TrustBuilder2 system and calls to the supported compliance checkers. Also allows for "return" plugins to catch any returns from these compliance checkers and process them before passing them back to the rest of the TrustBuilder2 system. Field Summary public static final public static final public static final public static final public static final KEY_CALL_ENABLED Properties key determining whether call plugins are enabled KEY_CC_LOAD Properties key determining which compliance checkers to load on startup KEY_PLUGIN_LOAD Properties key determining which plugins to load on startup KEY_RETURN_ENABLED Properties key determining whether return plugins are enabled NAME Name used for compatibility with Plugin interface Value: ComplianceCheckerMediator Fields inherited from class edu.uiuc.cs.trustbuilder2.plugins.abstractmediator callplugins, logger, properties, returnplugins, usecallplugins, usereturnplugins Fields inherited from interface edu.uiuc.cs.trustbuilder2.compliance.compliancecheckerinterface TYPE_2, TYPE_3, TYPE_ERROR Constructor Summary public ComplianceCheckerMediator(Properties prop) Constructor. Method Summary Page 24 of 305

25 edu.uiuc.cs.trustbuilder2.compliance.compliancecheckermediator boolean ArrayList int ArrayList int String List configure(properties prop) Loads options from the TB2 properties file. getcompliancecheckerclasses() Returns an ArrayList of Strings containing the class names of the currently registered compliance checkers. getcompliancecheckercount() Returns a count of the currently registered compliance checkers getcompliancecheckernames() Gets the "pretty" names of all registered compliance checkers. getcompliancecheckertype() This needs to be implemented since the ComplianceCheckerMediator implements the ComplianceCheckerInterface interface. getname() Gets the name of this module. getsupportedpolicyclasses() Decision boolean boolean boolean makedecision(session sess, AbstractPolicyBrick policy, Collection chains, Collection claims) This method takes a policy and a set of credentials and returns a decision indicating whether (some subset of) the given credentials satisfy the provided policy. registercompliancechecker(string classname) Registers the compliance checker implemented by classname registerplugin(string classname) Registers an instance of the plugin specified by classname. unregistercompliancechecker(string classname) Unregisters the ComplianceChecker implemented by classname Methods inherited from class edu.uiuc.cs.trustbuilder2.plugins.abstractmediator getcallpluginclasses, getcallplugincount, getcallpluginnames, getcallpluginstatus, getpluginclasses, getplugincount, getpluginnames, getreturnpluginclasses, getreturnplugincount, getreturnpluginnames, getreturnpluginstatus, setcallpluginstatus, setreturnpluginstatus, unregisterplugin Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Methods inherited from interface edu.uiuc.cs.trustbuilder2.plugins.mediatorinterface getcallpluginclasses, getcallplugincount, getcallpluginnames, getcallpluginstatus, getpluginclasses, getplugincount, getpluginnames, getreturnpluginclasses, getreturnplugincount, getreturnpluginnames, getreturnpluginstatus, registerplugin, setcallpluginstatus, setreturnpluginstatus, unregisterplugin Methods inherited from interface edu.uiuc.cs.trustbuilder2.compliance.compliancecheckerinterface getcompliancecheckertype, getsupportedpolicyclasses, makedecision Page 25 of 305

26 edu.uiuc.cs.trustbuilder2.compliance.compliancecheckermediator Methods inherited from interface edu.uiuc.cs.trustbuilder2.plugins.configurableplugin configure Methods inherited from interface edu.uiuc.cs.trustbuilder2.plugins.plugin getname Fields NAME public static final java.lang.string NAME Name used for compatibility with Plugin interface Constant value: ComplianceCheckerMediator KEY_CALL_ENABLED public static final java.lang.string KEY_CALL_ENABLED Properties key determining whether call plugins are enabled KEY_RETURN_ENABLED public static final java.lang.string KEY_RETURN_ENABLED Properties key determining whether return plugins are enabled KEY_PLUGIN_LOAD public static final java.lang.string KEY_PLUGIN_LOAD Properties key determining which plugins to load on startup KEY_CC_LOAD public static final java.lang.string KEY_CC_LOAD Properties key determining which compliance checkers to load on startup Constructors ComplianceCheckerMediator public ComplianceCheckerMediator(Properties prop) Constructor. This takes a properties file as a parameter and configures the ComplianceCheckerMediator accordingly. prop - The Properties object to configure from Methods Page 26 of 305

27 edu.uiuc.cs.trustbuilder2.compliance.compliancecheckermediator (continued from last page) configure public boolean configure(properties prop) Loads options from the TB2 properties file. This method is has public access only to conform with the ComplianceCheckerInterface interface. It is called from the ComplianceCheckerMediator constructor; subsequent calls will have no effect on the configuration. prop - The properties file to use true on success, false on error of if already configured registerplugin public boolean registerplugin(string classname) Registers an instance of the plugin specified by classname. The implementing class determines whether or not the class to register is a call plugin or a return plugin (or both) based on the interfaces that the plugin implements. classname - The class name of a plugin instance to try to register. true if the plugin was registered, false on error. registercompliancechecker public boolean registercompliancechecker(string classname) Registers the compliance checker implemented by classname classname - The class name of the compliance checker to register true on success, false otherwise unregistercompliancechecker public boolean unregistercompliancechecker(string classname) Unregisters the ComplianceChecker implemented by classname classname - The class name of the ComplianceChecker to unregister true on success, false on error getcompliancecheckercount public int getcompliancecheckercount() Returns a count of the currently registered compliance checkers Page 27 of 305

28 edu.uiuc.cs.trustbuilder2.compliance.compliancecheckermediator (continued from last page) A count of the currently registered compliance checkers getcompliancecheckerclasses public ArrayList getcompliancecheckerclasses() Returns an ArrayList of Strings containing the class names of the currently registered compliance checkers. An ArrayList of Strings containing the class names of the currently registered compliance checkers getcompliancecheckernames public ArrayList getcompliancecheckernames() Gets the "pretty" names of all registered compliance checkers. The "pretty" names of all registered compliance checkers getname public String getname() Gets the name of this module. Implemented for compatibility with the Plugin interface. The String "ComplianceCheckerMediator" getcompliancecheckertype public int getcompliancecheckertype() This needs to be implemented since the ComplianceCheckerMediator implements the ComplianceCheckerInterface interface. The code TYPE_ERROR is always returned since this mediator is not really a compliance checker. The TYPE_ERROR compliance checker type code makedecision public Decision makedecision(session sess, AbstractPolicyBrick policy, Collection chains, Collection claims) This method takes a policy and a set of credentials and returns a decision indicating whether (some subset of) the given credentials satisfy the provided policy. sess - The session that this decision will be made in policy - The policy to attempt to satisfy chains - A collection of credential chains used to attempt to satisfy the above policy A Decision object reflecting the compliance checker's decision. Page 28 of 305

29 edu.uiuc.cs.trustbuilder2.compliance.compliancecheckermediator getsupportedpolicyclasses public List getsupportedpolicyclasses() (continued from last page) Page 29 of 305

30 edu.uiuc.cs.trustbuilder2.compliance.decision edu.uiuc.cs.trustbuilder2.compliance Class Decision java.lang.object +-edu.uiuc.cs.trustbuilder2.compliance.decision public class Decision extends Object This represents the decision returned by a compliance checker. Constructor Summary public Decision() Default constructor public public Decision(List satisfyingsets, int cc_type) This constructor creates a Decision object that indicates that the policy was satisfied by the collection of credentials presented. Decision(AbstractPolicyBrick justification, int cc_type) This constructor creates a Decision object that indicates that the policy was not satisfied by the provided credential set. Method Summary AbstractPolicyBrick getjustification() Returns the PolicyBrick justification for the "unsatisfaction" of the policy boolean List int void void void void getsatisfied() Accesses the compliance checker's opinion on whether the provided policy was satisfied by the provided credentials. getsatisfyingsets() Returns the set of satisfying sets of credentials indicated by the compliance checker. gettype() Returns a code indicating the "type" setting of the compliance checker when this Decision was created. setjustification(abstractpolicybrick justif) Sets the policy justification for the unsatisfaction of the policy setsatisfied(boolean sat) Sets whether the policy was determined to be satisified. setsatisfyingsets(list sets) Sets the set of satisfying credential sets. settype(int type) Sets the type setting of the compliance checker used to generate this Decision. Methods inherited from class java.lang.object Page 30 of 305

31 edu.uiuc.cs.trustbuilder2.compliance.decision clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Constructors Decision public Decision() Decision Default constructor public Decision(List satisfyingsets, int cc_type) This constructor creates a Decision object that indicates that the policy was satisfied by the collection of credentials presented. The justification field of this Decision is set to null. satisfyingsets - The set of satisfying sets of credentials and claims detected by the compliance checker cc_type - The "type" of the compliance checker (TYPE_2 or TYPE_3) Decision public Decision(AbstractPolicyBrick justification, int cc_type) This constructor creates a Decision object that indicates that the policy was not satisfied by the provided credential set. The satisfyingsets field of this Decision is set to null. justification - A PolicyBrick indicating why the policy was unsatisfied. cc_type - The "type" of the compliance checker (TYPE_2 or TYPE_3) Methods getsatisfied public boolean getsatisfied() Accesses the compliance checker's opinion on whether the provided policy was satisfied by the provided credentials. true if the policy was satisfied, false otherwise setsatisfied public void setsatisfied(boolean sat) Sets whether the policy was determined to be satisified. sat - The satisfaction state to set Page 31 of 305

32 edu.uiuc.cs.trustbuilder2.compliance.decision getsatisfyingsets public List getsatisfyingsets() (continued from last page) Returns the set of satisfying sets of credentials indicated by the compliance checker. If the compliance checker is a Type 2 checker, then this will contain at most one satisfying set of credentials. If it's a type 3 compliance checker, then it will contain *all* satisfying sets of credentials. This method returns null if getsatisfied() returns false. The set of satisfying credential sets indicated by the compliance checker if getsatisfied() returns true. Null if getsatisfied() returns false. setsatisfyingsets public void setsatisfyingsets(list sets) Sets the set of satisfying credential sets. sets - The set of satisfying credential sets gettype public int gettype() settype Returns a code indicating the "type" setting of the compliance checker when this Decision was created. TYPE_2 if the compliance checker was configured as a type 2 checker or TYPE_3 if it was configured as a type 3 checker. public final void settype(int type) Sets the type setting of the compliance checker used to generate this Decision. If type is not TYPE_2 or TYPE_3, the code will be set to TYPE_ERROR. type - The type code to set getjustification public AbstractPolicyBrick getjustification() Returns the PolicyBrick justification for the "unsatisfaction" of the policy A PolicyBrick justification for the "unsatisfaction" of the policy setjustification public void setjustification(abstractpolicybrick justif) Sets the policy justification for the unsatisfaction of the policy justif - The justification Page 32 of 305

33 edu.uiuc.cs.trustbuilder2.compliance.satisfyingset edu.uiuc.cs.trustbuilder2.compliance Class SatisfyingSet java.lang.object +-edu.uiuc.cs.trustbuilder2.compliance.satisfyingset public class SatisfyingSet extends Object Class used to represent a single satisfying set of credentials and claims. Compliance checkers requiring other information in their satisfying sets should extend this class. Constructor Summary public SatisfyingSet(List credentials, List claims) Initializes a satisfying set with the credentials and claims that it contains. Method Summary List List getclaims() Returns the claims associated with this satisfying set. getcredentials() Returns the credentials associated with this satisfying set. Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Constructors SatisfyingSet public SatisfyingSet(List credentials, List claims) Initializes a satisfying set with the credentials and claims that it contains. credentials - The set of credentials in this satisfying set claims - The set of claims in this satisfying set Methods getcredentials public List getcredentials() Returns the credentials associated with this satisfying set. Page 33 of 305

34 edu.uiuc.cs.trustbuilder2.compliance.satisfyingset The credentials associated with this satisfying set. (continued from last page) getclaims public List getclaims() Returns the claims associated with this satisfying set. The claims associated with this satisfying set. Page 34 of 305

35 Package edu.uiuc.cs.trustbuilder2.compliance.je ss Page 35 of 305

36 edu.uiuc.cs.trustbuilder2.compliance.jess.jesscompliancechecker edu.uiuc.cs.trustbuilder2.compliance.jess Class JessComplianceChecker java.lang.object +-edu.uiuc.cs.trustbuilder2.compliance.jess.jesscompliancechecker All Implemented Interfaces: ComplianceCheckerInterface public final class JessComplianceChecker extends Object implements ComplianceCheckerInterface This class is a compliance checker based on a policy language derived from the Jess expert system. For a better explanation of the syntax of this language, please see the user's manual distributed with TrustBuilder2. Note that this compliance checker can be made more efficient, as it currently does not maintain any state. At each invocation of the makedecision() method, a new Rete engine is created, populated with the credentials and claims passed into this method, the necessary policies are loaded and decisions are made. In the future, we plan to implement a more efficient version of this class that maintains various levels of state within the Session object. Field Summary public static final public static final public static final KEY_DEFNS Key that loads base definitions file logger The logger for this class NAME The name of this compliance checker Value: Jess compliance checker Fields inherited from interface edu.uiuc.cs.trustbuilder2.compliance.compliancecheckerinterface TYPE_2, TYPE_3, TYPE_ERROR Constructor Summary public Method Summary JessComplianceChecker() Default constructor. boolean configure(properties prop) int String getcompliancecheckertype() Gets the "type" of this compliance checker. getname() List getsupportedpolicyclasses() Page 36 of 305

37 edu.uiuc.cs.trustbuilder2.compliance.jess.jesscompliancechecker Decision makedecision(session sess, AbstractPolicyBrick policy, Collection chains, Collection claims) This method takes a policy and a set of credentials and returns a decision indicating whether (some subset of) the given credentials satisfy the provided policy. Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Methods inherited from interface edu.uiuc.cs.trustbuilder2.compliance.compliancecheckerinterface getcompliancecheckertype, getsupportedpolicyclasses, makedecision Methods inherited from interface edu.uiuc.cs.trustbuilder2.plugins.configurableplugin configure Methods inherited from interface edu.uiuc.cs.trustbuilder2.plugins.plugin getname Fields NAME public static final java.lang.string NAME The name of this compliance checker Constant value: Jess compliance checker KEY_DEFNS public static final java.lang.string KEY_DEFNS logger Key that loads base definitions file public static final java.util.logging.logger logger The logger for this class Constructors JessComplianceChecker public JessComplianceChecker() Default constructor. Methods Page 37 of 305

38 edu.uiuc.cs.trustbuilder2.compliance.jess.jesscompliancechecker (continued from last page) configure public boolean configure(properties prop) getname public String getname() getcompliancecheckertype public int getcompliancecheckertype() Gets the "type" of this compliance checker. The Jess compliance checker is a type 3 checker, in that it returns all satisfying sets of credentials to the strategy module. ComplianceCheckerInterface.TYPE_3 getsupportedpolicyclasses public List getsupportedpolicyclasses() makedecision public Decision makedecision(session sess, AbstractPolicyBrick policy, Collection chains, Collection claims) throws ComplianceCheckerException This method takes a policy and a set of credentials and returns a decision indicating whether (some subset of) the given credentials satisfy the provided policy. In this compliance checker, the Jess rule-based system is used as the policy substrate. Policies are collections of Jess rules that will be inserted into a Jess engine containing representations of the credentials and claims passed into this compliance checker. This is a type 3 checker, as Jess has been configured to indicate all possible satisfying sets of credentials. sess - The session that this decision will be made in policy - The policy to attempt to satisfy chains - A collection of credential chains used to attempt to satisfy the above policy A Decision object reflecting the compliance checker's decision. Throws: ComplianceCheckerException - On error during compliance checking IllegalArgumentException - If any argument is incorrect Page 38 of 305

39 edu.uiuc.cs.trustbuilder2.compliance.jess.jesspolicybrick edu.uiuc.cs.trustbuilder2.compliance.jess Class JessPolicyBrick java.lang.object +-edu.uiuc.cs.trustbuilder2.messages.trustbrick +-edu.uiuc.cs.trustbuilder2.messages.resourcebrick +-edu.uiuc.cs.trustbuilder2.messages.abstractpolicybrick +-edu.uiuc.cs.trustbuilder2.compliance.jess.jesspolicybrick All Implemented Interfaces: Serializable public class JessPolicyBrick extends AbstractPolicyBrick This subclass of PolicyBrick is used to represent policies written in our policy language derived from Jess. Constructor Summary public JessPolicyBrick(String policy, String rid) Creates a Jess policy object using the policy string provided directly. public public public JessPolicyBrick(String policy, String rid, String pid) Creates a Jess policy object using the policy string provided directly. JessPolicyBrick(File policy, String rid) Abbreviated constructor that doesn't assign a release policy to this JessPolicyBrick. JessPolicyBrick(File policy, String rid, String pid) Given a File containing a set of Jess rules of the appropriate form, a resource identifier, and the resource identifier of the policy protecting access to this resource, create a JessPolicyBrick. Method Summary String getasciipolicy() String tostring() Methods inherited from class edu.uiuc.cs.trustbuilder2.messages.abstractpolicybrick getasciipolicy Methods inherited from class edu.uiuc.cs.trustbuilder2.messages.resourcebrick equals, getidentifier, getpolicyid, hashcode, setpolicyid Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Page 39 of 305

40 edu.uiuc.cs.trustbuilder2.compliance.jess.jesspolicybrick Constructors JessPolicyBrick public JessPolicyBrick(String policy, String rid) Creates a Jess policy object using the policy string provided directly. Note that no error checking is done on this policy. policy - The policy rid - The resource ID for this policy Throws: IllegalArgumentException - if the resource id is null or contains whitespace JessPolicyBrick public JessPolicyBrick(String policy, String rid, String pid) Creates a Jess policy object using the policy string provided directly. Note that no error checking is done on this policy. policy - The policy rid - The resource ID for this policy pid - The policy ID for this policy Throws: IllegalArgumentException - if the resource id is null or contains whitespace JessPolicyBrick public JessPolicyBrick(File policy, String rid) Abbreviated constructor that doesn't assign a release policy to this JessPolicyBrick. policy - A File containing the rules defining this policy rid - The resource id of this JessPolicyBrick Throws: IllegalArgumentException - If the policy files doesn't exist, rid is null, or rid contains whitespace See Also: JessPolicyBrick(File, String, String) JessPolicyBrick public JessPolicyBrick(File policy, String rid, String pid) Given a File containing a set of Jess rules of the appropriate form, a resource identifier, and the resource identifier of the policy protecting access to this resource, create a JessPolicyBrick. Page 40 of 305

41 edu.uiuc.cs.trustbuilder2.compliance.jess.jesspolicybrick (continued from last page) policy - A File containing the rules defining this policy rid - The resource id of this JessPolicyBrick pid - The resource id of the policy protecting the release of this JessPolicyBrick Throws: IllegalArgumentException - If policy file doesn't exist, rid is null, or if either id contains whitespace Methods getasciipolicy public String getasciipolicy() tostring This method returns an ASCII version of this policy. public String tostring() Page 41 of 305

42 Package edu.uiuc.cs.trustbuilder2.iomanipulati on Page 42 of 305

43 edu.uiuc.cs.trustbuilder2.iomanipulation.iomanipulationmodule edu.uiuc.cs.trustbuilder2.iomanipulation Class IOManipulationModule java.lang.object +-edu.uiuc.cs.trustbuilder2.iomanipulation.iomanipulationmodule All Implemented Interfaces: IOManipulatorInterface public final class IOManipulationModule extends Object implements IOManipulatorInterface The IOManipulationModule processes incoming and outgoing TrustMessage objects prior to the "decision points" in TrustBuilder2. For instance, this is the point at which visualizations and obligations enforcements will take place. Created: 2/22/2006 Field Summary public static final public static final public static final KEY_ENABLED Properties key describing the enabled state of the IOManipulationModule Value: edu.uiuc.cs.trustbuilder2.iomanipulation.iomanipulationmodule.enabled KEY_LOAD Properties key describing the IOManipulators to load by default Value: edu.uiuc.cs.trustbuilder2.iomanipulation.iomanipulationmodule.load NAME The name of this IOManipulator Value: IOManipulationModule Constructor Summary public Method Summary boolean IOManipulationModule(Properties prop) Constructor that configures this IOManipulationModule based on the supplied Properties object. configure(properties prop) Configures the IOManipulationModule ArrayList int ArrayList getmanipulatorclasses() Returns an ArrayList containing the classnames of all registered IOManipulators getmanipulatorcount() Returns the number of currently registered IOManipulators getmanipulatornames() Returns an ArrayList containing the names of all registered IOManipulators Page 43 of 305

44 edu.uiuc.cs.trustbuilder2.iomanipulation.iomanipulationmodule String boolean TrustMessage TrustMessage boolean boolean getname() Returns the name "IOManipulationModule" isenabled() Checks whether the IOManipulationModule is enabled processincoming(trustmessage message) Runs an incoming TrustMessage through each registered IOManipulator. processoutgoing(trustmessage message) Runs an outgoing TrustMessage through the chain of IOManipulators. registermanipulator(string classname) Registers a new IOManipulator unregistermanipulator(string classname) Unregisters all IOManipulators implemented by the specified class Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Methods inherited from interface edu.uiuc.cs.trustbuilder2.iomanipulation.iomanipulatorinterface processincoming, processoutgoing Methods inherited from interface edu.uiuc.cs.trustbuilder2.plugins.configurableplugin configure Methods inherited from interface edu.uiuc.cs.trustbuilder2.plugins.plugin getname Fields NAME public static final java.lang.string NAME The name of this IOManipulator Constant value: IOManipulationModule KEY_ENABLED public static final java.lang.string KEY_ENABLED Properties key describing the enabled state of the IOManipulationModule Constant value: edu.uiuc.cs.trustbuilder2.iomanipulation.iomanipulationmodule.enabled KEY_LOAD public static final java.lang.string KEY_LOAD Page 44 of 305