icsLang is a MAL-based Domain Specific Language (DSL) that models the Industrial Control Systems (ICS) related assets and possible cyberattacks.
This project has the following structure:
- The file
pom.xml
is the Maven configuration file of the project. - The directory
src/main/mal
contains the MAL specificationicsLang.mal
, which is the MAL specification of icsLang. - The directory
src/main/resources/icons
contains SVG icons for the assets in icsLang. - The directory
src/test/java/org/mal_lang/icslang/test
contains the unit tests of icsLang.
Apache Maven is a build tool and dependency management tool for Java projects. You can read more about Maven at https://en.wikipedia.org/wiki/Apache_Maven. Follow the instructions at https://maven.apache.org/download.cgi to download Maven, and follow the instructions at https://maven.apache.org/install.html to install Maven.
The
MAL compiler
compiles MAL specifications (.mal
files) into different formats,
using different backends. The reference backend generates Java code
that is suitable for testing purposes and evaluating your language.
The securiCAD backend generates a .jar
file that can be used with
foreseeti's products, including
securiCAD, which is a tool
that can be used to graphically create models using your language and
to simulate attacks on those models.
To compile icsLang with the reference backend of the MAL compiler
and then run the unit tests, execute the following command from the
icsLang
directory:
mvn test
This will invoke the MAL compiler's reference backend to generate
.java
files under target/generated-test-sources
. These .java
files and the unit tests in src/test/java
will then be compiled
into .class
files under target/test-classes
. The unit tests will
then finally be executed.
To only compile icsLang into .java
files, execute the following
command:
mvn generate-test-sources
To compile icsLang into .java
files and then compile these
.java
files and the unit tests in src/test/java
into .class
files, execute the following command:
mvn test-compile
To run a specific test class, execute the following command:
mvn test -Dtest=TesticsLang
Where TesticsLang
is the test class.
To run a specific test method in a test class, execute the following command:
mvn test -Dtest=TesticsLang#testNoPassword
Where TesticsLang
is the test class and testNoPassword
is the
test method.
To build a securiCAD compatible .jar
file, you need access to
foreseeti's maven repository. To request access, please contact
[email protected]. When you have received your credentials, you
can store them in a file ~/.aws/credentials
(%UserProfile%\.aws\credentials
on windows). For example:
[default]
aws_access_key_id=AKIAIOSFODNN7EXAMPLE
aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
To compile icsLang with the securiCAD backend of the MAL compiler, execute the following command:
mvn package -PsecuriCAD
The resulting .jar
file will be located in
target/icsLang-1.0.0.jar
.
If you don't want to run the unit tests when building a securiCAD
compatible .jar
file, execute the following command:
mvn clean package -PsecuriCAD -Dmaven.test.skip=true
Copyright © 2020 icsLang contributors
All files distributed in the icsLang project are licensed under the Apache License, Version 2.0, except for the following files:
File | License |
---|---|
Host.svg |
"Computer" icon by ✦ Shmidt Sergey ✦ from the Noun Project is licensed under CC BY 3.0. |
Network.svg |
"Network" icon by ✦ Shmidt Sergey ✦ from the Noun Project is licensed under CC BY 3.0. |
Password.svg |
"Lock" icon by ✦ Shmidt Sergey ✦ from the Noun Project is licensed under CC BY 3.0. |
User.svg |
"User" icon by ✦ Shmidt Sergey ✦ from the Noun Project is licensed under CC BY 3.0. |
See LICENSE
and NOTICE
for details.
This is a project run by the Software Systems Architecture and Security reseach group within the Division of Network and Systems Engineering at the Department of Computer Science at the School of Electrical Engineering and Computer Science @ KTH university.
For more of our projects, see the SSAS page at github.com.