-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,31 @@ | ||
# CryptSL | ||
# CrySL (formerly CryptSL) | ||
|
||
CrySL is a domain-specific language that allows to specify the correct usage of cryptographic APIs. | ||
CrySL is a domain-specific language that allows to specify the correct usage of APIs. Example specifications for the JavaCryptographicArchitecture (JCA), BouncyCastle and Tink can be found [here](https://github.com/CROSSINGTUD/Crypto-API-Rules). | ||
|
||
## Parsing CrySL files | ||
We implemented a parser that reads a set of `.crysl` files and parses them into Java objects. Include the following dependency in your project (replace `x.y.z` with the latest version): | ||
|
||
```xml | ||
<dependency> | ||
<groupId>de.darmstadt.tu.crossing.CrySL</groupId> | ||
<artifactId>CrySLParser</artifactId> | ||
<version>x.y.z</version> | ||
</dependency> | ||
``` | ||
|
||
In your program, you can import the `crysl.CrySLParser` and read a set of `.crysl` files from a directory or a `.zip` file: | ||
|
||
```java | ||
CrySLParser parser = new CrySLParser(); | ||
Collection<CrySLRule> rules = parser.parseRulesFromPath("path/to/directory_or_zip_file"); | ||
|
||
System.out.println("Found " + rules.size() + " for classes:"); | ||
for (CrySLRule rule : rules) { | ||
System.out.println(rule.getClassName()); | ||
} | ||
``` | ||
|
||
## Publications | ||
Paper: https://ieeexplore.ieee.org/document/8880510 | ||
|
||
_More information can be found under the following [link](https://www.eclipse.org/cognicrypt/documentation/crysl/)._ |