├── .dockerignore ├── settings.gradle ├── .gitignore ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── src ├── test │ ├── fixtures │ │ ├── visitor │ │ │ ├── Main.hp │ │ │ └── Privacy.hp │ │ ├── wrong-name │ │ │ ├── Main.hp │ │ │ └── WrongName.hp │ │ └── YAML │ │ │ ├── Main.hp │ │ │ ├── WrongNames.hp │ │ │ ├── WrongOrder.hp │ │ │ └── Expected.yaml │ └── kotlin │ │ ├── unit │ │ ├── hapi │ │ │ ├── DataVisitorTest.kt │ │ │ ├── IRVisitorTest.kt │ │ │ └── ParsingTest.kt │ │ └── tasks │ │ │ └── YAMLTest.kt │ │ ├── helpers │ │ └── Helpers.kt │ │ └── integration │ │ └── EvaluationTest.kt └── main │ ├── kotlin │ ├── utils │ │ ├── DataMapOrderChecker.kt │ │ ├── Utils.kt │ │ └── Result.kt │ ├── hapi │ │ ├── error │ │ │ ├── HapiErrorListener.kt │ │ │ └── HapiRuntimeException.kt │ │ ├── Eval.kt │ │ ├── Lattice.kt │ │ ├── DataVisitor.kt │ │ ├── IR.kt │ │ └── IRVisitor.kt │ └── tasks │ │ ├── Print.kt │ │ └── YAML.kt │ └── antlr │ └── Hapi.g4 ├── .travis.yml ├── Dockerfile ├── README.md ├── gradlew.bat ├── gradlew └── LICENSE /.dockerignore: -------------------------------------------------------------------------------- 1 | Dockerfile -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = "hapi" -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode 2 | 3 | /build 4 | .gradle 5 | **/.antlr -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lac-dcc/hapi/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /src/test/fixtures/visitor/Main.hp: -------------------------------------------------------------------------------- 1 | import Privacy; 2 | 3 | main = 4 | DENY 5 | EXCEPT { 6 | Privacy::analystActions 7 | }; -------------------------------------------------------------------------------- /src/test/fixtures/wrong-name/Main.hp: -------------------------------------------------------------------------------- 1 | import WrongName; 2 | 3 | main = 4 | ALLOW 5 | EXCEPT { 6 | WrongName::bob 7 | }; -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | 3 | os: linux 4 | dist: trusty 5 | jdk: oraclejdk8 6 | 7 | before_install: 8 | - chmod +x gradlew 9 | - chmod +x gradle/wrapper/gradle-wrapper.jar 10 | script: 11 | - ./gradlew build -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /src/test/fixtures/YAML/Main.hp: -------------------------------------------------------------------------------- 1 | data Actors = Analyst(Alice, Bob); 2 | data Actions = Reads, Updates, Deletes; 3 | data Resources = res1, res2, res3; 4 | 5 | main = 6 | DENY 7 | EXCEPT { 8 | ALLOW { 9 | Actors: Analyst 10 | Actions 11 | Resources 12 | } 13 | }; 14 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM gradle:5.6.2-jdk8 AS build 2 | COPY --chown=gradle:gradle . /home/gradle/src 3 | WORKDIR /home/gradle/src 4 | RUN gradle build --no-daemon 5 | 6 | FROM openjdk:8-jre-slim 7 | RUN mkdir /app 8 | COPY --from=build /home/gradle/src/build/libs/ /app/ 9 | ENTRYPOINT ["java","-jar","/app/hapi.jar"] -------------------------------------------------------------------------------- /src/test/fixtures/YAML/WrongNames.hp: -------------------------------------------------------------------------------- 1 | data Actors = Analyst(Alice, Bob); 2 | data Actions = Reads, Updates, Deletes; 3 | data Resource = res1, res2, res3; 4 | 5 | main = 6 | DENY 7 | EXCEPT { 8 | ALLOW { 9 | Actors: Analyst 10 | Actions 11 | Resource 12 | } 13 | }; 14 | -------------------------------------------------------------------------------- /src/test/fixtures/YAML/WrongOrder.hp: -------------------------------------------------------------------------------- 1 | data Actors = Analyst(Alice, Bob); 2 | data Resources = res1, res2, res3; 3 | data Actions = Reads, Updates, Deletes; 4 | 5 | main = 6 | DENY 7 | EXCEPT { 8 | ALLOW { 9 | Actors: Analyst 10 | Resources 11 | Actions 12 | } 13 | }; 14 | -------------------------------------------------------------------------------- /src/test/fixtures/YAML/Expected.yaml: -------------------------------------------------------------------------------- 1 | data: [res3, res2, res1] 2 | rules: 3 | - identities: 4 | users: Bob 5 | Deletes: 6 | data: [res3, res2, res1] 7 | Updates: 8 | data: [res3, res2, res1] 9 | Reads: 10 | data: [res3, res2, res1] 11 | - identities: 12 | users: Alice 13 | Deletes: 14 | data: [res3, res2, res1] 15 | Updates: 16 | data: [res3, res2, res1] 17 | Reads: 18 | data: [res3, res2, res1] 19 | -------------------------------------------------------------------------------- /src/test/fixtures/wrong-name/WrongName.hp: -------------------------------------------------------------------------------- 1 | export NameWrong where 2 | 3 | data Actors = 4 | Looker(Analyst), 5 | Analyst(Alice, Bob), 6 | Intern(Bob, Jeff), 7 | Alice, Bob, Jeff; 8 | 9 | data Actions = Reads, Deletes, Updates; 10 | 11 | data Resources = 12 | Claims(Finance), 13 | Finance(Customers, Companies), 14 | Customers(CCN), Companies(EMAIL, SSN), 15 | CCN, EMAIL, SSN; 16 | 17 | bob = DENY { 18 | Actors: Bob 19 | Resources: EMAIL 20 | Actions: Deletes 21 | }; -------------------------------------------------------------------------------- /src/main/kotlin/utils/DataMapOrderChecker.kt: -------------------------------------------------------------------------------- 1 | package utils 2 | 3 | import hapi.* 4 | 5 | class DataMapOrderError(message: String) : Exception(message) 6 | 7 | /* Checks that the datamap provided has exactly three keys, in the 8 | * following order: ("Actors", "Actions", "Resources"). 9 | */ 10 | class DataMapOrderChecker(datamap: DataMap) { 11 | init { 12 | val dmKeys = datamap.keys.toList() 13 | val expectedDmKeys = listOf("Actors", "Actions", "Resources") 14 | 15 | if (dmKeys != expectedDmKeys) { 16 | throw DataMapOrderError("Expected data statements for ${expectedDmKeys.toString()}" + 17 | ", got ${dmKeys.toString()}") 18 | } 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /src/main/kotlin/hapi/error/HapiErrorListener.kt: -------------------------------------------------------------------------------- 1 | package hapi.error 2 | 3 | import org.antlr.v4.runtime.* 4 | import org.antlr.v4.runtime.tree.ParseTree 5 | import org.antlr.v4.runtime.misc.ParseCancellationException 6 | 7 | /* 8 | create a decision map to manipulate errors that occurs on each Token in Hapi.g4 9 | */ 10 | 11 | class HapiErrorListener(): BaseErrorListener() { 12 | override fun syntaxError( 13 | recognizer: Recognizer<*, *>?, offendingSymbol: Any?, line: Int, 14 | charPositionInLine: Int, message: String, e: RecognitionException?){ 15 | val errorMessage = "line " + line + ":" + charPositionInLine + " " + message 16 | System.out.println(errorMessage) 17 | throw ParseCancellationException(errorMessage) 18 | } 19 | } -------------------------------------------------------------------------------- /src/main/kotlin/utils/Utils.kt: -------------------------------------------------------------------------------- 1 | package utils 2 | 3 | import java.io.File 4 | 5 | fun changeExtension(file: String, extension: String): String { 6 | return file.replaceAfterLast(".", extension) 7 | } 8 | 9 | fun changeFileName(file: String, name: String): String{ 10 | return file.replaceAfterLast("/", name) + "." + file.substringAfterLast(".") 11 | } 12 | 13 | fun getFileName(file: String): String { 14 | return File(file).nameWithoutExtension 15 | } 16 | 17 | fun getDirName(file: String): String { 18 | return file.split("/").dropLast(1).joinToString("/") 19 | } 20 | 21 | fun relativePath(p1: String, p2: String): String { 22 | return getDirName(p1) + "/" + p2; 23 | } 24 | 25 | fun filePathInDir(file: String, dir: String): String { 26 | return dir + "/" + file; 27 | } -------------------------------------------------------------------------------- /src/main/kotlin/utils/Result.kt: -------------------------------------------------------------------------------- 1 | package utils 2 | 3 | class ResultException(message: String) : Exception(message) 4 | 5 | sealed class Result 6 | 7 | class Ok(val value: T): Result() 8 | 9 | class Err(val error: E): Result() 10 | 11 | fun Result.map(transform: (T) -> U): Result = 12 | when (this) { 13 | is Ok -> Ok(transform(value)) 14 | is Err -> this 15 | } 16 | 17 | fun Result.andThen(transform: (T) -> Result): Result = 18 | when (this) { 19 | is Ok -> transform(value) 20 | is Err -> this 21 | } 22 | 23 | fun Result.unwrap(): T = 24 | when (this) { 25 | is Ok -> value 26 | is Err -> throw ResultException(error.toString()) 27 | } -------------------------------------------------------------------------------- /src/main/kotlin/tasks/Print.kt: -------------------------------------------------------------------------------- 1 | package tasks 2 | 3 | import java.io.File 4 | 5 | import org.antlr.v4.runtime.* 6 | import org.antlr.v4.runtime.tree.ParseTree 7 | 8 | import java.io.FileInputStream 9 | import java.io.InputStream 10 | 11 | import HapiLexer 12 | import HapiParser 13 | 14 | import hapi.* 15 | import utils.* 16 | 17 | fun usage() { 18 | println("usage: ./program "); 19 | } 20 | 21 | fun main(args: Array) { 22 | 23 | if (args.size < 1){ 24 | return usage(); 25 | } 26 | 27 | val file = args[0] 28 | 29 | File(file).let { 30 | val root = getDirName(file) 31 | val source = it.readText() 32 | val datamap = evalDataMap(source, root) 33 | val ast = evalIR(source, root, datamap) as IRNode 34 | println(ast.ir); 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/test/fixtures/visitor/Privacy.hp: -------------------------------------------------------------------------------- 1 | export Privacy where 2 | 3 | data Actors = 4 | Looker(Analyst), 5 | Analyst(Alice, Bob), 6 | Intern(Bob, Jeff), 7 | Alice, Bob, Jeff; 8 | 9 | data Actions = Reads, Deletes, Updates; 10 | 11 | data Resources = 12 | Claims(Finance), 13 | Finance(Customers, Companies), 14 | Customers(CCN), Companies(EMAIL, SSN), 15 | CCN, EMAIL, SSN; 16 | 17 | bobAllButSSN = DENY { 18 | Actors: Bob 19 | Resources: EMAIL, CCN 20 | Actions: Deletes, Updates, Reads 21 | }; 22 | 23 | analystActions = 24 | ALLOW { 25 | Actors: Analyst 26 | Resources 27 | Actions 28 | } 29 | EXCEPT { 30 | DENY { 31 | Actors: Alice 32 | Resources: EMAIL 33 | Actions: Updates 34 | } 35 | bobAllButSSN 36 | }; -------------------------------------------------------------------------------- /src/main/kotlin/hapi/error/HapiRuntimeException.kt: -------------------------------------------------------------------------------- 1 | package hapi.error 2 | 3 | import java.lang.RuntimeException 4 | import org.antlr.v4.runtime.tree.TerminalNode 5 | import org.antlr.v4.runtime.Token 6 | 7 | class HapiRuntimeException(override val message: String): RuntimeException(message){ 8 | 9 | companion object { 10 | operator fun invoke(token:TerminalNode , message: String): HapiRuntimeException { 11 | return HapiRuntimeException(token.getSymbol(), message) 12 | } 13 | 14 | operator fun invoke(token:Token , message: String): HapiRuntimeException { 15 | val charPosition = token.getCharPositionInLine() 16 | val line = token.getLine() 17 | val msg = "line " + line + ":" + charPosition + " " + message 18 | System.out.println(msg) 19 | return HapiRuntimeException(msg) 20 | } 21 | } 22 | } -------------------------------------------------------------------------------- /src/test/kotlin/unit/hapi/DataVisitorTest.kt: -------------------------------------------------------------------------------- 1 | import kotlin.test.* 2 | import org.assertj.core.api.Assertions.assertThat 3 | import org.junit.jupiter.api.DisplayName 4 | import org.junit.jupiter.api.Test 5 | 6 | import org.antlr.v4.runtime.* 7 | import org.antlr.v4.runtime.tree.ParseTree 8 | 9 | import hapi.* 10 | 11 | class DataVisitorTest { 12 | 13 | @Test 14 | @DisplayName("Should generate the correct DataMap") 15 | fun shouldGenerateTheCorrectDataMap() { 16 | val program = 17 | """ 18 | data Actors = 19 | Looker(Analyst), 20 | Analyst(Alice, Bob), 21 | Intern(Bob, Jeff), 22 | Alice, Bob, Jeff; 23 | """ 24 | val expected = "{Actors={⊤=[Looker, Intern], Looker=[Analyst], Analyst=[Alice, Bob], Alice=[], Bob=[], Intern=[Bob, Jeff], Jeff=[]}}" 25 | 26 | evalDataMap(program, "").let { 27 | assertThat(it.toString()).isEqualTo(expected) 28 | } 29 | } 30 | } -------------------------------------------------------------------------------- /src/main/kotlin/hapi/Eval.kt: -------------------------------------------------------------------------------- 1 | package hapi 2 | 3 | import hapi.error.HapiErrorListener 4 | import org.antlr.v4.runtime.* 5 | import org.antlr.v4.runtime.tree.ParseTree 6 | import org.antlr.v4.runtime.misc.ParseCancellationException 7 | 8 | import java.io.InputStream 9 | 10 | import HapiLexer 11 | import HapiParser 12 | 13 | fun tokenize(source: String): CommonTokenStream = 14 | CharStreams.fromString(source).let { 15 | val lexer = HapiLexer(it).apply { 16 | removeErrorListeners() 17 | addErrorListener(HapiErrorListener()) 18 | } 19 | CommonTokenStream(lexer) 20 | } 21 | 22 | fun parse(tokens: CommonTokenStream): HapiParser.ProgramContext = 23 | HapiParser(tokens).apply { 24 | removeErrorListeners() 25 | addErrorListener(HapiErrorListener()) 26 | }.program() 27 | 28 | fun evalDataMap(source: String, root: String): DataMap = 29 | parse(tokenize(source)).let { 30 | val eval = DataVisitor(root) 31 | eval.visit(it) 32 | } 33 | 34 | fun evalIR(source: String, root: String, datamap: DataMap): ASTNode = 35 | parse(tokenize(source)).let { 36 | val eval = IRVisitor(root, datamap) 37 | eval.visit(it) 38 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Project Hapi 2 | 3 | ## H​ierarchical Access Policy Implementation 4 | 5 | This project aims to implement a domain specific language to define access policies. Considering actors (A) and resources (R), we want to be able to ensure: 6 | - **Totality**: either A accesses R or it does not 7 | - **Uniqueness**: R cannot be both accessible and forbidden to A 8 | 9 | By hierarchical, we mean that policies specified for an actor can be projected into another actor, and extended in this new setting. 10 | 11 | ## Usage 12 | 13 | Suppose you have a Hapi project under the folder `` and then you want to run the file `/.hp`: 14 | 15 | - **With Docker** 16 | 17 | ``` 18 | docker build -t hapi_image . 19 | docker run -v :/data --rm hapi_image "/data/.hp" 20 | ``` 21 | 22 | - **Without Docker** 23 | 24 | ``` 25 | gradle run --args="/.hp" 26 | ``` 27 | 28 | In both ways the YAML translation will be generated at `/.yaml`. 29 | 30 | ## Examples 31 | 32 | @TODO 33 | 34 | ## License 35 | 36 | This project is licensed under the [GPLv3 license](LICENSE). -------------------------------------------------------------------------------- /src/test/kotlin/helpers/Helpers.kt: -------------------------------------------------------------------------------- 1 | package helpers 2 | 3 | import java.io.File 4 | 5 | import hapi.* 6 | import tasks.YAMLGenerator 7 | import utils.* 8 | 9 | fun irFromFile(file: String) : IR = 10 | File(file).let { 11 | val root = getDirName(file) 12 | val source = it.readText() 13 | val datamap = evalDataMap(source, root) 14 | val ast = evalIR(source, root, datamap) as IRNode 15 | ast.ir 16 | } 17 | 18 | fun irFromString(source: String) : IR = 19 | run { 20 | val datamap = evalDataMap(source, "") 21 | val ast = evalIR(source, "", datamap) as IRNode 22 | ast.ir 23 | } 24 | 25 | /* Generates YAML translation of Hapi program from "file" 26 | * Returns the resulting translation's file path 27 | */ 28 | fun yamlFromFile(file: String) : String = 29 | File(file).let { 30 | val root = getDirName(file) 31 | val source = it.readText() 32 | val datamap = evalDataMap(source, root) 33 | val ast = evalIR(source, root, datamap) as IRNode 34 | 35 | val outputFile = changeExtension(file, "yaml") 36 | 37 | val yamlGenerator = YAMLGenerator() 38 | yamlGenerator.generate(ast.ir, datamap, outputFile) 39 | 40 | outputFile 41 | } 42 | -------------------------------------------------------------------------------- /src/main/kotlin/tasks/YAML.kt: -------------------------------------------------------------------------------- 1 | package tasks; 2 | 3 | import java.io.File 4 | 5 | import hapi.* 6 | import utils.* 7 | 8 | class YAMLGenerator { 9 | 10 | fun generate(ir: IR, datamap: DataMap, filename: String) { 11 | DataMapOrderChecker(datamap) // Check that datamap has right keys 12 | 13 | val file = File(filename); 14 | 15 | file.bufferedWriter().use { out -> 16 | val resources = datamap["Resources"]!!; 17 | out.write("data: ${resources.atoms(resources.TOP).unwrap()}\n"); 18 | 19 | out.write("rules:\n"); 20 | 21 | (ir as NonTerminal).nonTerminal.forEach { (actor, actions) -> 22 | out.write(" - identities:\n"); 23 | out.write(" users: ${actor}\n"); 24 | (actions as NonTerminal).nonTerminal.forEach { (action, resources) -> 25 | 26 | out.write(" ${action}:\n"); 27 | out.write(" data: ${resources as Terminal}\n"); 28 | } 29 | } 30 | } 31 | } 32 | } 33 | 34 | fun main(args: Array) { 35 | 36 | if (args.size < 1){ 37 | return usage(); 38 | } 39 | 40 | val file = args[0] 41 | 42 | File(file).let { 43 | val root = getDirName(file) 44 | val source = it.readText() 45 | 46 | val datamap = evalDataMap(source, root) 47 | 48 | val ast = evalIR(source, root, datamap) as IRNode 49 | 50 | val outputFile = changeExtension(file, "yaml") 51 | 52 | val yamlGenerator = YAMLGenerator(); 53 | yamlGenerator.generate(ast.ir, datamap, outputFile); 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /src/main/antlr/Hapi.g4: -------------------------------------------------------------------------------- 1 | grammar Hapi; 2 | 3 | program 4 | : library 5 | | executable 6 | ; 7 | 8 | library: exportStmt (stmt ';')+ ; 9 | 10 | executable: (stmt ';')+ ; 11 | 12 | stmt 13 | : letStmt 14 | | dataStmt 15 | | importStmt 16 | ; 17 | 18 | exportStmt: EXPORT ID WHERE ; 19 | 20 | importStmt: IMPORT ID ; 21 | 22 | dataStmt: DATA ID '=' dataElem (',' dataElem)* ; 23 | 24 | letStmt: ID '=' policyExpr ; 25 | 26 | policyExpr 27 | : allowExpr 28 | | denyExpr 29 | | allowAllExceptExpr 30 | | denyAllExceptExpr 31 | ; 32 | 33 | denyExpr 34 | : DENY attributeExpr 35 | | denyExceptExpr 36 | | literalExpr 37 | ; 38 | 39 | denyExceptExpr: DENY attributeExpr EXCEPT '{' allowExpr+ '}'; 40 | denyAllExceptExpr: DENY EXCEPT '{' allowExpr+ '}'; 41 | 42 | allowExpr 43 | : ALLOW attributeExpr 44 | | allowExceptExpr 45 | | literalExpr 46 | ; 47 | 48 | allowExceptExpr: ALLOW attributeExpr EXCEPT '{' denyExpr+ '}'; 49 | allowAllExceptExpr: ALLOW EXCEPT '{' denyExpr+ '}'; 50 | 51 | attributeExpr: '{' attribute+ '}' ; 52 | 53 | literalExpr: ID ('::' ID)? ; 54 | 55 | attribute 56 | : ID 57 | | ID ':' value (',' value)* 58 | ; 59 | 60 | dataElem 61 | : ID 62 | | ID '(' value (',' value)* ')' 63 | ; 64 | 65 | value: ID; 66 | 67 | DENY: 'DENY' ; 68 | EXCEPT: 'EXCEPT' ; 69 | ALLOW: 'ALLOW' ; 70 | IMPORT: 'import' ; 71 | EXPORT: 'export' ; 72 | WHERE: 'where' ; 73 | DATA: 'data' ; 74 | ID: [a-zA-Z0-9]+ ; 75 | 76 | 77 | 78 | SKIP_ 79 | : ( NL | SPACES | COMMENT ) -> skip 80 | ; 81 | 82 | fragment NL 83 | : ( '\r'? '\n' ) SPACES? 84 | ; 85 | 86 | fragment SPACES 87 | : [ \t]+ 88 | ; 89 | 90 | fragment COMMENT 91 | : '//' ~[\r\n\f]* 92 | ; -------------------------------------------------------------------------------- /src/main/kotlin/hapi/Lattice.kt: -------------------------------------------------------------------------------- 1 | package hapi 2 | 3 | import java.util.Stack 4 | 5 | import utils.* 6 | 7 | class Lattice() { 8 | val TOP = "⊤" 9 | val BOTTOM = "⊥" 10 | var adj: MutableMap> = mutableMapOf(this.TOP to mutableSetOf()) 11 | 12 | override fun toString(): String { 13 | return this.adj.toString() 14 | } 15 | } 16 | 17 | fun Lattice.append(parent: String, elem: String) = 18 | this.adj[parent].let{ 19 | if (it != null){ 20 | 21 | if (!this.adj.containsKey(elem)) 22 | this.adj.put(elem, mutableSetOf()) 23 | 24 | it.add(elem) 25 | } 26 | } 27 | 28 | fun Lattice.contains(elem: String): Boolean = 29 | run { 30 | var found = false 31 | this.dfs(TOP, {node, _ -> found = found || elem == node}) 32 | found 33 | } 34 | 35 | fun Lattice.dfs(label: String, closure: (String, MutableSet?) -> Unit) = 36 | run { 37 | val stack = Stack() 38 | val visited = mutableSetOf() 39 | 40 | stack.push(label) 41 | 42 | while(!stack.empty()){ 43 | val elem = stack.pop() 44 | closure(elem, this.adj[elem]!!) 45 | visited.add(elem) 46 | 47 | this.adj[elem]!!.forEach({ 48 | if(!visited.contains(it)) 49 | stack.add(it) 50 | }) 51 | } 52 | } 53 | 54 | fun Lattice.atoms(label: String): Result, String> = 55 | run { 56 | if (!this.adj.containsKey(label)) 57 | return Err("undefined value ${label}") 58 | 59 | val atoms: MutableSet = mutableSetOf() 60 | dfs(label, { 61 | node, neigh -> 62 | if(neigh.isNullOrEmpty()) 63 | atoms.add(node) 64 | }) 65 | 66 | Ok(atoms) 67 | } -------------------------------------------------------------------------------- /src/main/kotlin/hapi/DataVisitor.kt: -------------------------------------------------------------------------------- 1 | package hapi 2 | 3 | import java.io.File 4 | import java.io.FileNotFoundException 5 | 6 | import utils.* 7 | import hapi.error.* 8 | 9 | import HapiParser 10 | import HapiBaseVisitor 11 | 12 | typealias DataMap = Map 13 | 14 | class DataVisitor(val root: String) : HapiBaseVisitor() { 15 | 16 | override fun visitExecutable(ctx: HapiParser.ExecutableContext): DataMap { 17 | return ctx.stmt().fold(mapOf(), { 18 | datamap, stmt -> visit(stmt).let { if(it != null) datamap + it else datamap} 19 | }) 20 | } 21 | 22 | override fun visitLibrary(ctx: HapiParser.LibraryContext ): DataMap { 23 | return ctx.stmt().fold(mapOf(), { 24 | datamap, stmt -> visit(stmt).let { if(it != null) datamap + it else datamap} 25 | }) 26 | } 27 | 28 | override fun visitImportStmt(ctx: HapiParser.ImportStmtContext): DataMap { 29 | val module = this.root + "/" + ctx.ID().toString() + ".hp" 30 | return File(module).let { 31 | if (!it.exists()){ 32 | val message = "Module '${ctx.ID()}' does not exist" 33 | throw HapiRuntimeException(ctx.ID(), message) 34 | } 35 | evalDataMap(it.readText(), this.root) 36 | } 37 | } 38 | 39 | override fun visitDataStmt(ctx: HapiParser.DataStmtContext): DataMap { 40 | val lattice = Lattice(); 41 | val id = ctx.ID().toString() 42 | 43 | for (elem in ctx.dataElem()) { 44 | val parent = elem.ID().toString() 45 | 46 | if (!lattice.contains(parent)) 47 | lattice.append(lattice.TOP, parent) 48 | 49 | val children = elem.value() 50 | 51 | if (children != null) 52 | for (child in children) 53 | lattice.append(parent, child.ID().toString()) 54 | } 55 | 56 | return mapOf(id to lattice) 57 | } 58 | } -------------------------------------------------------------------------------- /src/test/kotlin/unit/tasks/YAMLTest.kt: -------------------------------------------------------------------------------- 1 | import kotlin.test.* 2 | import org.assertj.core.api.Assertions.assertThat 3 | import org.junit.jupiter.api.DisplayName 4 | import org.junit.jupiter.api.Test 5 | 6 | import java.io.File 7 | 8 | import helpers.* 9 | import utils.DataMapOrderError 10 | 11 | class YAMLTest { 12 | 13 | @Test 14 | @DisplayName("Should generate the correct YAML") 15 | fun shouldGenerateCorrectYAML() { 16 | val hapiFile = "src/test/fixtures/YAML/Main.hp" 17 | val outputFile = File(yamlFromFile(hapiFile)) 18 | 19 | val expectedFile = "src/test/fixtures/YAML/Expected.yaml" 20 | val expectedOutput = File(expectedFile).readText() 21 | 22 | assertThat(outputFile.readText()).isEqualTo(expectedOutput) 23 | 24 | outputFile.delete() 25 | } 26 | 27 | @Test 28 | @DisplayName("Invalid DataMap names for YAML") 29 | fun invalidDataMapWrongNames() { 30 | val hapiFile = "src/test/fixtures/YAML/WrongNames.hp" 31 | 32 | val error = assertFailsWith { 33 | yamlFromFile(hapiFile) 34 | } 35 | 36 | val expectedMessage = 37 | "Expected data statements for [Actors, Actions, Resources]," + 38 | " got [Actors, Actions, Resource]" 39 | 40 | assertThat(error.message).isEqualTo(expectedMessage) 41 | } 42 | 43 | @Test 44 | @DisplayName("Invalid DataMap order for YAML") 45 | fun invalidDataMapWrongOrder() { 46 | val hapiFile = "src/test/fixtures/YAML/WrongOrder.hp" 47 | 48 | val error = assertFailsWith { 49 | yamlFromFile(hapiFile) 50 | } 51 | 52 | val expectedMessage = 53 | "Expected data statements for [Actors, Actions, Resources]," + 54 | " got [Actors, Resources, Actions]" 55 | 56 | assertThat(error.message).isEqualTo(expectedMessage) 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /src/test/kotlin/unit/hapi/IRVisitorTest.kt: -------------------------------------------------------------------------------- 1 | import kotlin.test.* 2 | import org.assertj.core.api.Assertions.assertThat 3 | import org.junit.jupiter.api.DisplayName 4 | import org.junit.jupiter.api.Test 5 | 6 | import org.antlr.v4.runtime.* 7 | import org.antlr.v4.runtime.tree.ParseTree 8 | 9 | import helpers.* 10 | 11 | class IRVisitorTest { 12 | 13 | @Test 14 | @DisplayName("Should generate the correct IR") 15 | fun shouldGenerateTheCorrectIR() { 16 | val file = "src/test/fixtures/visitor/Main.hp" 17 | 18 | val expected = "{Bob={Updates=[SSN], Deletes=[SSN], Reads=[SSN]}, Alice={Updates=[SSN, CCN], Deletes=[SSN, EMAIL, CCN], Reads=[SSN, EMAIL, CCN]}}" 19 | 20 | val ir = irFromFile(file) 21 | 22 | assertThat(ir.toString()).isEqualTo(expected) 23 | } 24 | 25 | @Test 26 | @DisplayName("Should receive name error when exporting a module different of filename") 27 | fun shouldReceiveWrongNameError() { 28 | val file = "src/test/fixtures/wrong-name/Main.hp" 29 | 30 | val exception = assertFailsWith { irFromFile(file) } 31 | assertEquals("line 6:4 undefined name: WrongName::bob", exception.message) 32 | } 33 | 34 | @Test 35 | @DisplayName("Should throw error when using literal expressions of wrong type") 36 | fun shouldThrowErrorOnWrongLiteral() { 37 | val programs = listOf( 38 | """ 39 | data Prop = P1; 40 | 41 | denyP1 = DENY { 42 | Prop: P1 43 | }; 44 | main = 45 | DENY 46 | EXCEPT { 47 | denyP1 // use deny where allow is expected 48 | }; 49 | """, 50 | """ 51 | data Prop = P1; 52 | 53 | allowP1 = ALLOW { 54 | Prop: P1 55 | }; 56 | main = 57 | ALLOW 58 | EXCEPT { 59 | allowP1 // use allow where deny is expected 60 | }; 61 | """, 62 | """ 63 | data Prop = P1, P2; 64 | 65 | allowP2 = ALLOW { 66 | Prop: P2 67 | }; 68 | denyP1 = DENY { 69 | Prop: P1 70 | }; 71 | main = 72 | DENY 73 | EXCEPT { 74 | allowP2 75 | denyP1 // use deny where allow is expected 76 | allowP2 77 | }; 78 | """ 79 | ) 80 | val messages = listOf( 81 | "line 10:10 denyP1 is a DENY expression, expected ALLOW", 82 | "line 10:10 allowP1 is an ALLOW expression, expected DENY", 83 | "line 14:10 denyP1 is a DENY expression, expected ALLOW" 84 | ) 85 | for (i in 0 until programs.size){ 86 | val exception = assertFailsWith{ irFromString(programs.get(i)) } 87 | assertEquals(messages.get(i), exception.message) 88 | } 89 | } 90 | } -------------------------------------------------------------------------------- /src/test/kotlin/unit/hapi/ParsingTest.kt: -------------------------------------------------------------------------------- 1 | import kotlin.test.* 2 | import org.junit.jupiter.api.DisplayName 3 | import org.junit.jupiter.api.Test 4 | 5 | import org.antlr.v4.runtime.* 6 | import org.antlr.v4.runtime.tree.ParseTree 7 | import org.antlr.v4.runtime.misc.ParseCancellationException 8 | 9 | import hapi.* 10 | 11 | class ParsingTest { 12 | 13 | @Test 14 | @DisplayName("Should parse infinitely nested clauses") 15 | fun shouldParseInfinitelyNestedClauses(){ 16 | val program = 17 | """ 18 | data Prop = P1(P2), P2(P3, P4), P3, P4; 19 | main = 20 | DENY 21 | EXCEPT { 22 | ALLOW { 23 | Prop: P1 24 | } EXCEPT { 25 | DENY { 26 | Prop: P2 27 | } EXCEPT { 28 | ALLOW { 29 | Prop: P3 30 | } 31 | ALLOW { 32 | Prop: P4 33 | } 34 | } 35 | } 36 | }; 37 | """ 38 | assertNotNull(parse(tokenize(program))) 39 | } 40 | 41 | @Test 42 | @DisplayName("Should throw ParseCancellationException on syntax error") 43 | fun shouldThrowParseCancellationExceptionOnSyntaxError(){ 44 | val program = 45 | """ 46 | data Prop = P1(P2), P2(P3, P4), P3, P4; 47 | main = 48 | DENY 49 | EXCEPT { 50 | INVALID { // this is a syntax error 51 | Prop: P4 52 | } 53 | }; 54 | """ 55 | val error = "line 6:10 mismatched input 'INVALID' expecting 'ALLOW'" 56 | assertFailsWith(error) { parse(tokenize(program)) } 57 | } 58 | @Test 59 | @DisplayName("Should parse valid attribute expressions") 60 | fun shouldParseValidAttributeExpression(){ 61 | val program = 62 | """ 63 | data Prop = P1; 64 | 65 | denyP1 = DENY { 66 | Prop: P1 67 | }; 68 | main = 69 | ALLOW 70 | EXCEPT { 71 | denyP1 72 | }; 73 | """ 74 | assertNotNull(parse(tokenize(program))) 75 | } 76 | 77 | @Test 78 | @DisplayName("Invalid import statement - missing comma") 79 | fun invalidSyntaxMissingComma(){ 80 | val program = 81 | """ 82 | import somemodule 83 | 84 | data Prop = P1; 85 | 86 | denyP1 = DENY { 87 | Prop: P1 88 | }; 89 | main = 90 | ALLOW 91 | EXCEPT { 92 | denyP1 93 | }; 94 | """ 95 | val error = "line 4:6 missing ';' at 'data'" 96 | val e1 = assertFailsWith{parse(tokenize(program))} 97 | assertEquals(error, e1.message) 98 | } 99 | 100 | @Test 101 | @DisplayName("Invalid EXCEPT - missing curly braces") 102 | fun invalidSyntaxMissingBraces(){ 103 | val program = 104 | """ 105 | data Prop = P1; 106 | main = 107 | ALLOW 108 | EXCEPT 109 | denyP1 110 | }; 111 | """ 112 | val error = "line 6:10 missing '{' at 'denyP1'" 113 | val e1 = assertFailsWith{parse(tokenize(program))} 114 | assertEquals(error, e1.message) 115 | } 116 | } -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto init 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto init 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :init 68 | @rem Get command-line arguments, handling Windows variants 69 | 70 | if not "%OS%" == "Windows_NT" goto win9xME_args 71 | 72 | :win9xME_args 73 | @rem Slurp the command line arguments. 74 | set CMD_LINE_ARGS= 75 | set _SKIP=2 76 | 77 | :win9xME_args_slurp 78 | if "x%~1" == "x" goto execute 79 | 80 | set CMD_LINE_ARGS=%* 81 | 82 | :execute 83 | @rem Setup the command line 84 | 85 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 86 | 87 | 88 | @rem Execute Gradle 89 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 90 | 91 | :end 92 | @rem End local scope for the variables with windows NT shell 93 | if "%ERRORLEVEL%"=="0" goto mainEnd 94 | 95 | :fail 96 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 97 | rem the _cmd.exe /c_ return code! 98 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 99 | exit /b 1 100 | 101 | :mainEnd 102 | if "%OS%"=="Windows_NT" endlocal 103 | 104 | :omega 105 | -------------------------------------------------------------------------------- /src/test/kotlin/integration/EvaluationTest.kt: -------------------------------------------------------------------------------- 1 | import kotlin.test.* 2 | import org.assertj.core.api.Assertions.assertThat 3 | import org.junit.jupiter.api.DisplayName 4 | import org.junit.jupiter.api.Test 5 | 6 | import org.antlr.v4.runtime.* 7 | import org.antlr.v4.runtime.tree.ParseTree 8 | 9 | import hapi.* 10 | import helpers.* 11 | 12 | class EvaluationTest { 13 | 14 | @Test 15 | @DisplayName("Should evaluate to the correct IR even when defining Lattices after uses") 16 | fun shouldEvaluateCorrectly() { 17 | val program = 18 | """ 19 | main = 20 | DENY 21 | EXCEPT { 22 | ALLOW { 23 | Prop: P1 24 | } 25 | }; 26 | 27 | data Prop = P1, P2; 28 | """ 29 | val expected = "[P1]" 30 | 31 | val ir = irFromString(program) 32 | 33 | assertThat(ir.toString()).isEqualTo(expected) 34 | } 35 | 36 | @Test 37 | @DisplayName("Should consider the order of the definition of lattices when generating the IR") 38 | fun shouldConsiderOrder() { 39 | val program = 40 | """ 41 | data P = P1; 42 | data K = K1; 43 | data E = E1; 44 | 45 | main = 46 | DENY 47 | EXCEPT { 48 | ALLOW { 49 | P: P1 50 | K: K1 51 | E: E1 52 | } 53 | }; 54 | 55 | """ 56 | val expected = "{P1={K1=[E1]}}" 57 | 58 | val ir = irFromString(program) 59 | 60 | assertThat(ir.toString()).isEqualTo(expected) 61 | } 62 | 63 | @Test 64 | @DisplayName("Should have bottom element when attribute not specified in clause") 65 | fun shouldHaveBottomElement() { 66 | val program = { attr: String -> 67 | """ 68 | data P = P1; 69 | data K = K1; 70 | data E = E1; 71 | 72 | main = 73 | DENY 74 | EXCEPT { 75 | ALLOW { 76 | P: P1 77 | ${attr} 78 | } 79 | }; 80 | 81 | """ 82 | } 83 | val e1 = "{P1={K1=[⊥]}}" 84 | val e2 = "{P1={⊥=[E1]}}" 85 | 86 | val ir1 = irFromString(program("K: K1")) 87 | val ir2 = irFromString(program("E: E1")) 88 | 89 | assertThat(ir1.toString()).isEqualTo(e1) 90 | assertThat(ir2.toString()).isEqualTo(e2) 91 | } 92 | 93 | @Test 94 | @DisplayName("Should throw undefined value and attribute error") 95 | fun shouldThrowUndefinedError() { 96 | val program = { attr: String -> 97 | """ 98 | data P = P1; 99 | data K = K1; 100 | 101 | main = 102 | DENY 103 | EXCEPT { 104 | ALLOW { 105 | P: P1 106 | ${attr} 107 | } 108 | }; 109 | """ 110 | } 111 | 112 | val e1 = assertFailsWith{ irFromString(program("K: K2")) } 113 | assertEquals("line 10:12 undefined value K2", e1.message) 114 | 115 | val e2 = assertFailsWith{ irFromString(program("L: L1")) } 116 | assertEquals("line 10:12 Undefined attribute \"L\"", e2.message) 117 | } 118 | 119 | @Test 120 | @DisplayName("Non existent module") 121 | fun nonExistentModule() { 122 | val program = 123 | """ 124 | import inexistentModule; 125 | data P = P1; 126 | 127 | main = 128 | DENY 129 | EXCEPT { 130 | ALLOW { 131 | P: P1 132 | } 133 | }; 134 | """ 135 | 136 | val e1 = assertFailsWith{irFromString(program)} 137 | assertEquals("line 2:13 Module 'inexistentModule' does not exist", e1.message) 138 | } 139 | } 140 | -------------------------------------------------------------------------------- /src/main/kotlin/hapi/IR.kt: -------------------------------------------------------------------------------- 1 | package hapi 2 | 3 | import utils.* 4 | 5 | enum class IRType { 6 | ALLOW { 7 | override fun complement() = DENY 8 | }, 9 | DENY { 10 | override fun complement() = ALLOW 11 | }; 12 | 13 | abstract fun complement(): IRType 14 | } 15 | 16 | sealed class IR (val type: IRType) { 17 | companion object {} 18 | abstract override fun toString(): String 19 | abstract fun empty(): Boolean 20 | } 21 | 22 | class Terminal (val terminal: Set, type: IRType): IR (type) { 23 | override fun toString(): String = this.terminal.toString() 24 | override fun empty(): Boolean = this.terminal.isEmpty() 25 | } 26 | 27 | class NonTerminal(val nonTerminal: Map, type: IRType) : IR (type) { 28 | override fun toString(): String = this.nonTerminal.toString() 29 | override fun empty(): Boolean = this.nonTerminal.isEmpty() 30 | } 31 | 32 | fun IR.minus(otherIR: IR): Result = 33 | when { 34 | this is Terminal && otherIR is Terminal -> this.minus(otherIR) 35 | this is NonTerminal && otherIR is NonTerminal -> this.minus(otherIR) 36 | else -> Err("Can't subtract IRs of different nesting levels") 37 | } 38 | 39 | fun IR.plus(otherIR: IR): Result = 40 | when { 41 | this is Terminal && otherIR is Terminal -> this.plus(otherIR) 42 | this is NonTerminal && otherIR is NonTerminal -> this.plus(otherIR) 43 | else -> Err("Can't sum IRs of different nesting levels") 44 | } 45 | 46 | fun IR.Companion.from(attrs: Map>, type: IRType, keys: List): IR = 47 | when (keys.size) { 48 | 1 -> Terminal(attrs[keys[0]]!!, type) 49 | else -> NonTerminal( 50 | attrs[keys[0]]!!.associateWith({ 51 | IR.from(attrs, type, keys.drop(1)) 52 | }), type 53 | ) 54 | } 55 | 56 | fun Terminal.minus(other: Terminal): Result = 57 | if (this.type == other.type) 58 | Err("expected type " + this.type.complement() + " got " + this.type) 59 | else 60 | Ok(Terminal(this.terminal.subtract(other.terminal), this.type)) 61 | 62 | // @TODO: a better name 63 | fun subtract(nt1: Map, nt2: Map, k: String): Result, String> = 64 | nt1[k]!!.minus(nt2[k]!!).let { 65 | when (it) { 66 | is Ok<*> -> Ok( 67 | if (it.unwrap().empty()) 68 | nt1 - k 69 | else 70 | nt1 + Pair(k, it.unwrap()) 71 | ) 72 | is Err<*> -> it as Result, String> 73 | } 74 | } 75 | 76 | fun NonTerminal.minus(other: NonTerminal): Result = 77 | if (this.type == other.type) 78 | Err("expected type " + this.type.complement() + " got " + this.type) 79 | else 80 | this.nonTerminal.keys.fold(Ok(this) as Result, { acc, k -> 81 | when { 82 | acc is Ok<*> && other.nonTerminal.containsKey(k) -> 83 | subtract(acc.unwrap().nonTerminal, other.nonTerminal, k).map{ NonTerminal(it, this.type) } 84 | else -> acc 85 | } 86 | }) 87 | 88 | fun Terminal.plus(other: Terminal): Result = 89 | if (this.type != other.type) 90 | Err("expected type " + this.type + " got " + other.type) 91 | else 92 | Ok(Terminal(this.terminal.union(other.terminal), this.type)) 93 | 94 | // @TODO: a better name 95 | fun sum(nt1: Map, nt2: Map, k: String): Result, String> = 96 | nt1[k]!!.plus(nt2[k]!!).let{ 97 | when (it){ 98 | is Ok<*> -> Ok( 99 | if (nt1.containsKey(k)) 100 | nt1 + Pair(k, it.unwrap()) 101 | else 102 | nt1 + Pair(k, nt2[k]!!) 103 | ) 104 | is Err<*> -> it as Result, String> 105 | } 106 | 107 | } 108 | 109 | fun NonTerminal.plus(other: NonTerminal): Result = 110 | if (this.type != other.type) 111 | Err("expected type " + this.type + " got " + other.type) 112 | else 113 | other.nonTerminal.keys.fold(Ok(this) as Result, { acc, k -> 114 | when { 115 | acc is Ok<*> -> 116 | if (acc.unwrap().nonTerminal.containsKey(k)){ 117 | sum(acc.unwrap().nonTerminal, other.nonTerminal, k).map{ NonTerminal(it, this.type) } 118 | } else { 119 | Ok(NonTerminal(acc.unwrap().nonTerminal + Pair(k, other.nonTerminal[k]!!), this.type)) 120 | } 121 | else -> acc 122 | } 123 | }) -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> \(.*\)$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | 86 | # Determine the Java command to use to start the JVM. 87 | if [ -n "$JAVA_HOME" ] ; then 88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 89 | # IBM's JDK on AIX uses strange locations for the executables 90 | JAVACMD="$JAVA_HOME/jre/sh/java" 91 | else 92 | JAVACMD="$JAVA_HOME/bin/java" 93 | fi 94 | if [ ! -x "$JAVACMD" ] ; then 95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 96 | 97 | Please set the JAVA_HOME variable in your environment to match the 98 | location of your Java installation." 99 | fi 100 | else 101 | JAVACMD="java" 102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 103 | 104 | Please set the JAVA_HOME variable in your environment to match the 105 | location of your Java installation." 106 | fi 107 | 108 | # Increase the maximum file descriptors if we can. 109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 110 | MAX_FD_LIMIT=`ulimit -H -n` 111 | if [ $? -eq 0 ] ; then 112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 113 | MAX_FD="$MAX_FD_LIMIT" 114 | fi 115 | ulimit -n $MAX_FD 116 | if [ $? -ne 0 ] ; then 117 | warn "Could not set maximum file descriptor limit: $MAX_FD" 118 | fi 119 | else 120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 121 | fi 122 | fi 123 | 124 | # For Darwin, add options to specify how the application appears in the dock 125 | if $darwin; then 126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 127 | fi 128 | 129 | # For Cygwin or MSYS, switch paths to Windows format before running java 130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then 131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 133 | 134 | JAVACMD=`cygpath --unix "$JAVACMD"` 135 | 136 | # We build the pattern for arguments to be converted via cygpath 137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 138 | SEP="" 139 | for dir in $ROOTDIRSRAW ; do 140 | ROOTDIRS="$ROOTDIRS$SEP$dir" 141 | SEP="|" 142 | done 143 | OURCYGPATTERN="(^($ROOTDIRS))" 144 | # Add a user-defined pattern to the cygpath arguments 145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 147 | fi 148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 149 | i=0 150 | for arg in "$@" ; do 151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 153 | 154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 156 | else 157 | eval `echo args$i`="\"$arg\"" 158 | fi 159 | i=`expr $i + 1` 160 | done 161 | case $i in 162 | 0) set -- ;; 163 | 1) set -- "$args0" ;; 164 | 2) set -- "$args0" "$args1" ;; 165 | 3) set -- "$args0" "$args1" "$args2" ;; 166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;; 167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 172 | esac 173 | fi 174 | 175 | # Escape application args 176 | save () { 177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 178 | echo " " 179 | } 180 | APP_ARGS=`save "$@"` 181 | 182 | # Collect all arguments for the java command, following the shell quoting and substitution rules 183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 184 | 185 | exec "$JAVACMD" "$@" 186 | -------------------------------------------------------------------------------- /src/main/kotlin/hapi/IRVisitor.kt: -------------------------------------------------------------------------------- 1 | package hapi 2 | 3 | import java.io.File 4 | 5 | import utils.* 6 | import hapi.error.* 7 | 8 | import HapiBaseVisitor 9 | import HapiParser 10 | 11 | const val entryPoint = "main" 12 | 13 | typealias Environment = HashMap 14 | 15 | sealed class ASTNode {} 16 | data class EnvNode (val env: Environment): ASTNode() {} 17 | data class IRNode (val ir: IR): ASTNode() {} 18 | 19 | class IRVisitor( 20 | val root: String, 21 | val datamap: DataMap 22 | ) : HapiBaseVisitor() { 23 | 24 | val env: Environment = hashMapOf() 25 | var namespace = "Main" 26 | 27 | fun attrsFrom(ctxs: List): Map> { 28 | return this.datamap.keys.associateWith({ 29 | attr -> 30 | val ctx = ctxs.firstOrNull{ it.ID().toString() == attr } 31 | if (ctx != null) 32 | if (ctx.value().isEmpty()) // attribute has no value -> top of the lattice 33 | datamap[attr]!!.atoms(datamap[attr]!!.TOP).unwrap() 34 | else 35 | try { 36 | ctx.value().flatMap{datamap[attr]!!.atoms(it.ID().toString()).unwrap()}.toSet() 37 | } catch (e:Exception){ 38 | throw HapiRuntimeException(ctx.ID(), (e.message!!)) 39 | } 40 | else // clausule has no such attribute -> empty set 41 | setOf(datamap[attr]!!.BOTTOM) 42 | }) 43 | } 44 | 45 | override fun visitExecutable(ctx: HapiParser.ExecutableContext): ASTNode { 46 | for (stmt in ctx.stmt()) 47 | visit(stmt).let { 48 | if (it != null) 49 | this.env.putAll((it as EnvNode).env) 50 | } 51 | 52 | val main = this.env.get(this.namespace + "::" + entryPoint) 53 | if (main != null) 54 | return IRNode(main) 55 | else 56 | throw HapiRuntimeException("no entry point 'main' provided") 57 | } 58 | 59 | override fun visitLibrary(ctx: HapiParser.LibraryContext ): ASTNode { 60 | this.namespace = ctx.exportStmt().ID().toString() 61 | 62 | for (stmt in ctx.stmt()) 63 | visit(stmt).let { 64 | if (it != null) 65 | this.env.putAll((it as EnvNode).env) 66 | } 67 | 68 | return EnvNode(this.env) 69 | } 70 | 71 | override fun visitImportStmt(ctx: HapiParser.ImportStmtContext): ASTNode { 72 | val module = this.root + "/" + ctx.ID().toString() + ".hp" 73 | 74 | return File(module).let { 75 | val ast = evalIR(it.readText(), this.root, this.datamap) 76 | 77 | when (ast) { 78 | is EnvNode -> ast 79 | else -> throw HapiRuntimeException(ctx.ID(), 80 | "can't import an executable file") 81 | } 82 | } 83 | } 84 | 85 | override fun visitLetStmt(ctx: HapiParser.LetStmtContext): ASTNode { 86 | val id = ctx.ID().toString() 87 | val key = this.namespace + "::" + id 88 | val ir = (visit(ctx.policyExpr()) as IRNode).ir 89 | val env: Environment = hashMapOf(key to ir) 90 | return EnvNode(env) 91 | } 92 | 93 | fun inferTypeFrom(ruleIndex: Int): IRType { 94 | if (ruleIndex == HapiParser.RULE_allowExpr || ruleIndex == HapiParser.RULE_allowExceptExpr) 95 | return IRType.ALLOW 96 | else 97 | return IRType.DENY 98 | } 99 | 100 | override fun visitAttributeExpr(ctx: HapiParser.AttributeExprContext): ASTNode { 101 | 102 | ctx.attribute().forEach { 103 | if (!this.datamap.containsKey(it.ID().toString())){ 104 | val message = "Undefined attribute \"${it.ID()}\"" 105 | throw HapiRuntimeException(it.ID(), message) 106 | } 107 | } 108 | 109 | val type = inferTypeFrom(ctx.getParent().getRuleIndex()) 110 | return IRNode(IR.from(attrsFrom(ctx.attribute()), type, this.datamap.keys.toList())) 111 | } 112 | 113 | override fun visitLiteralExpr(ctx: HapiParser.LiteralExprContext): ASTNode { 114 | var literal = ctx.ID().map {e -> e.toString()}.toMutableList() 115 | if (literal.size == 1) 116 | literal.add(0, this.namespace) 117 | 118 | val name = literal.joinToString(separator="::") 119 | val ir = this.env.get(name) 120 | 121 | if (ir != null) 122 | return IRNode(ir) 123 | else 124 | throw HapiRuntimeException(ctx.ID().component1(), "undefined name: ${name}") 125 | } 126 | 127 | override fun visitDenyExceptExpr(ctx: HapiParser.DenyExceptExprContext): ASTNode { 128 | val denyAttr = visit(ctx.attributeExpr()) 129 | val denyAttrIR = (denyAttr as IRNode).ir 130 | 131 | val ir = ctx.allowExpr() 132 | .map{ 133 | val result = (visit(it) as IRNode).ir 134 | if(result.type != IRType.ALLOW) 135 | throw HapiRuntimeException(it.getStart(), 136 | "${it.getStart().getText()} is a DENY expression, expected ALLOW") 137 | else 138 | result 139 | }.fold(denyAttrIR, { acc, ir -> acc.minus(ir).unwrap() }) 140 | return IRNode(ir) 141 | } 142 | 143 | override fun visitDenyAllExceptExpr(ctx: HapiParser.DenyAllExceptExprContext): ASTNode { 144 | 145 | val top = this.datamap.mapValues { setOf() } 146 | val topIR = IR.from(top, IRType.ALLOW, this.datamap.keys.toList()) 147 | 148 | val ir = ctx.allowExpr() 149 | .map{ 150 | val result = (visit(it) as IRNode).ir 151 | if(result.type != IRType.ALLOW) 152 | throw HapiRuntimeException(it.getStart(), 153 | "${it.getStart().getText()} is a DENY expression, expected ALLOW") 154 | else 155 | result 156 | }.fold(topIR, { acc, ir -> acc.plus(ir).unwrap()}) 157 | return IRNode(ir) 158 | } 159 | 160 | override fun visitAllowExceptExpr(ctx: HapiParser.AllowExceptExprContext): ASTNode { 161 | 162 | val allowAttr = visit(ctx.attributeExpr()) 163 | val allowAttrIR = (allowAttr as IRNode).ir 164 | 165 | val ir = ctx.denyExpr() 166 | .map{ 167 | val result = (visit(it) as IRNode).ir 168 | if(result.type != IRType.DENY) 169 | throw HapiRuntimeException(it.getStart(), 170 | "${it.getStart().getText()} is an ALLOW expression, expected DENY") 171 | else 172 | result 173 | }.fold(allowAttrIR, { acc, ir -> acc.minus(ir).unwrap()}) 174 | return IRNode(ir) 175 | } 176 | 177 | override fun visitAllowAllExceptExpr(ctx: HapiParser.AllowAllExceptExprContext): ASTNode { 178 | 179 | val top = this.datamap.mapValues { (_, lattice) -> lattice.atoms(lattice.TOP).unwrap()} 180 | val topIR = IR.from(top, IRType.ALLOW, this.datamap.keys.toList()) 181 | 182 | val ir = ctx.denyExpr() 183 | .map{ 184 | val result = (visit(it) as IRNode).ir 185 | if(result.type != IRType.DENY) 186 | throw HapiRuntimeException(it.getStart(), 187 | "${it.getStart().getText()} is an ALLOW expression, expected DENY") 188 | else 189 | result 190 | }.fold(topIR, { acc, ir -> acc.minus(ir).unwrap() }) 191 | return IRNode(ir) 192 | } 193 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------