diff --git a/README.md b/README.md index 101d803..645139f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # SecureBPMN + [SecureBPMN](https://www.brucker.ch/projects/securebpmn/index.en.html) is a domain-specific modeling language that allows to model security aspects (e.g., access control, separation of duty, @@ -13,15 +14,19 @@ on the level of SecureBPMN models as well as refinement properties between the model and the actual implementation. ## Installation + ### SecureBPMN Designer + #### Prerequisites + * Eclipse Helios * SATMC (http://www.ai-lab.it/satmc/), version 3.3.x (for the formal analysis of secure business processes) #### Preparing the Eclipse environment -* First, install the GenericBreakGlass-XACML into your local - maven repository: + +First, install the GenericBreakGlass-XACML into your local +maven repository: ``` cd GenericBreakGlass-XACML/src/eu.aniketos.securebpmn.xacml.parent mvn clean eclipse:clean @@ -29,17 +34,20 @@ mvn eclipse:eclipse mvn install cd .. ``` -* To initialize the Eclipse project structure, please do + +To initialize the Eclipse project structure, please do ``` cd designer/src//org.activiti.designer.parent mvn clean eclipse:clean mvn eclipse:eclipse cd .. ``` -* After this, all projects can be imported into a fresh Eclipse - workspace using `File -> Import -> Existing Projects into Workspace`. + +After this, all projects can be imported into a fresh Eclipse +workspace using `File -> Import -> Existing Projects into Workspace`. #### Generate Model Classes + 1. Open the folder `model` in the project `org.activiti.designer.model` 2. Open `BPMN20.genmodel` 3. Select the top level node (`bpmn2`) @@ -50,11 +58,14 @@ cd .. 6. Select `Generator -> Generate all` from the top-level menu #### Start Eclipse Application + Select the project `org.activiti.designer.eclipse` and select `Run as -> Eclipse application` in the context menu (right click). ### SecureBPMN Runtime + #### Prerequisites + Java 6 must be installed and executable: ``` export JAVA_HOME= @@ -65,10 +76,12 @@ Moreover, the xalan libraries must be installed: cd runtime/src/userguide ant install.xalan.libs ``` + ### Building the SecureBPMN Runtime -* If you did not install GenericBreakGlass-XACML into your local - maven repository as part of the installation of the SecureBPMN - Designer: + +If you did not install GenericBreakGlass-XACML into your local +maven repository as part of the installation of the SecureBPMN +Designer: ``` cd GenericBreakGlass-XACML/src/eu.aniketos.securebpmn.xacml.parent mvn clean eclipse:clean @@ -76,37 +89,45 @@ mvn eclipse:eclipse mvn install cd .. ``` -* Compile the SecureBPMN runtime: + +Compile the SecureBPMN runtime: ``` cd runtime/src/distro ant clean distro ``` + If ``ant `clean distro``` is not able to download tomcat, please download `apache-tomcat-6.0.32.zip` and copy it into `runtime/src/distro/target`. ### Executing the SecureBPMN Runtime + ``` cd runtime/src/distro/target/activiti-5.8/setup/ ant demo.start ``` + And open `http://localhost:8080/activiti-explorer` in a web browser. Note that `and demo.stop` will stop the demo and `ant demo.clean` will reset the demo setup. ## Team + Main developer: [Achim D. Brucker](http://www.brucker.ch/) ### Contributors + * Jan Alexander * Matthias Klink * Helmut Petritsch * Raj Ruparel ## Publications + Related publications are listed on the [SecureBPMN website](https://www.brucker.ch/projects/securebpmn/index.en.html). The core publications are: + * Achim D. Brucker. [Integrating Security Aspects into Business Process Models](http://www.brucker.ch/bibliography/download/2013/brucker-securebpmn-2013.pdf). In it - Information Technology, 55 (6), pages 239-246, 2013.