diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..73f69e0 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml +# Editor-based HTTP Client requests +/httpRequests/ diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml new file mode 100644 index 0000000..1bec35e --- /dev/null +++ b/.idea/codeStyles/Project.xml @@ -0,0 +1,10 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml new file mode 100644 index 0000000..79ee123 --- /dev/null +++ b/.idea/codeStyles/codeStyleConfig.xml @@ -0,0 +1,5 @@ + + + + \ No newline at end of file diff --git a/.idea/compiler.xml b/.idea/compiler.xml new file mode 100644 index 0000000..61a9130 --- /dev/null +++ b/.idea/compiler.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/jarRepositories.xml b/.idea/jarRepositories.xml new file mode 100644 index 0000000..b3e9cbd --- /dev/null +++ b/.idea/jarRepositories.xml @@ -0,0 +1,25 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..2266f6b --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..635caa8 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,33 @@ +plugins { + java + kotlin("jvm") version "1.3.72" + id("io.gitlab.arturbosch.detekt") version "1.9.1" + +} + +group = "it.unisannio.assd.untori" +version = "0.0.1-alpha" + +repositories { + mavenCentral() + jcenter() +} + +dependencies { + implementation(kotlin("stdlib-jdk8")) + testCompile("junit", "junit", "4.12") + implementation ("cafe.cryptography:ed25519-elisabeth:0.1.0") + detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:1.9.1") +} + +configure { + sourceCompatibility = JavaVersion.VERSION_1_8 +} +tasks { + compileKotlin { + kotlinOptions.jvmTarget = "1.8" + } + compileTestKotlin { + kotlinOptions.jvmTarget = "1.8" + } +} \ No newline at end of file diff --git a/config/detekt/detekt.yml b/config/detekt/detekt.yml new file mode 100644 index 0000000..f1e1708 --- /dev/null +++ b/config/detekt/detekt.yml @@ -0,0 +1,629 @@ +build: + maxIssues: 5 + excludeCorrectable: false + weights: + # complexity: 2 + # LongParameterList: 1 + # style: 1 + # comments: 1 + +config: + validation: true + # when writing own rules with new properties, exclude the property path e.g.: 'my_rule_set,.*>.*>[my_property]' + excludes: '' + +processors: + active: true + exclude: + - 'DetektProgressListener' + # - 'FunctionCountProcessor' + # - 'PropertyCountProcessor' + # - 'ClassCountProcessor' + # - 'PackageCountProcessor' + # - 'KtFileCountProcessor' + +console-reports: + active: true + exclude: + - 'ProjectStatisticsReport' + - 'ComplexityReport' + - 'NotificationReport' + # - 'FindingsReport' + - 'FileBasedFindingsReport' + +comments: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + AbsentOrWrongFileLicense: + active: false + licenseTemplateFile: 'license.template' + CommentOverPrivateFunction: + active: false + CommentOverPrivateProperty: + active: false + EndOfSentenceFormat: + active: false + endOfSentenceFormat: '([.?!][ \t\n\r\f<])|([.?!:]$)' + UndocumentedPublicClass: + active: false + searchInNestedClass: true + searchInInnerClass: true + searchInInnerObject: true + searchInInnerInterface: true + UndocumentedPublicFunction: + active: false + UndocumentedPublicProperty: + active: false + +complexity: + active: true + ComplexCondition: + active: true + threshold: 4 + ComplexInterface: + active: false + threshold: 10 + includeStaticDeclarations: false + includePrivateDeclarations: false + ComplexMethod: + active: true + threshold: 15 + ignoreSingleWhenExpression: false + ignoreSimpleWhenEntries: false + ignoreNestingFunctions: false + nestingFunctions: [run, let, apply, with, also, use, forEach, isNotNull, ifNull] + LabeledExpression: + active: false + ignoredLabels: [] + LargeClass: + active: true + threshold: 600 + LongMethod: + active: true + threshold: 60 + LongParameterList: + active: true + functionThreshold: 6 + constructorThreshold: 7 + ignoreDefaultParameters: false + ignoreDataClasses: true + ignoreAnnotated: [] + MethodOverloading: + active: false + threshold: 6 + NestedBlockDepth: + active: true + threshold: 4 + StringLiteralDuplication: + active: false + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + threshold: 3 + ignoreAnnotation: true + excludeStringsWithLessThan5Characters: true + ignoreStringsRegex: '$^' + TooManyFunctions: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + thresholdInFiles: 11 + thresholdInClasses: 11 + thresholdInInterfaces: 11 + thresholdInObjects: 11 + thresholdInEnums: 11 + ignoreDeprecated: false + ignorePrivate: false + ignoreOverridden: false + +coroutines: + active: true + GlobalCoroutineUsage: + active: false + RedundantSuspendModifier: + active: false + +empty-blocks: + active: true + EmptyCatchBlock: + active: true + allowedExceptionNameRegex: '_|(ignore|expected).*' + EmptyClassBlock: + active: true + EmptyDefaultConstructor: + active: true + EmptyDoWhileBlock: + active: true + EmptyElseBlock: + active: true + EmptyFinallyBlock: + active: true + EmptyForBlock: + active: true + EmptyFunctionBlock: + active: true + ignoreOverridden: false + EmptyIfBlock: + active: true + EmptyInitBlock: + active: true + EmptyKtFile: + active: true + EmptySecondaryConstructor: + active: true + EmptyTryBlock: + active: true + EmptyWhenBlock: + active: true + EmptyWhileBlock: + active: true + +exceptions: + active: true + ExceptionRaisedInUnexpectedLocation: + active: false + methodNames: [toString, hashCode, equals, finalize] + InstanceOfCheckForException: + active: false + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + NotImplementedDeclaration: + active: false + PrintStackTrace: + active: false + RethrowCaughtException: + active: false + ReturnFromFinally: + active: false + ignoreLabeled: false + SwallowedException: + active: false + ignoredExceptionTypes: + - InterruptedException + - NumberFormatException + - ParseException + - MalformedURLException + allowedExceptionNameRegex: '_|(ignore|expected).*' + ThrowingExceptionFromFinally: + active: false + ThrowingExceptionInMain: + active: false + ThrowingExceptionsWithoutMessageOrCause: + active: false + exceptions: + - IllegalArgumentException + - IllegalStateException + - IOException + ThrowingNewInstanceOfSameException: + active: false + TooGenericExceptionCaught: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + exceptionNames: + - ArrayIndexOutOfBoundsException + - Error + - Exception + - IllegalMonitorStateException + - NullPointerException + - IndexOutOfBoundsException + - RuntimeException + - Throwable + allowedExceptionNameRegex: '_|(ignore|expected).*' + TooGenericExceptionThrown: + active: true + exceptionNames: + - Error + - Exception + - Throwable + - RuntimeException + +formatting: + active: true + android: false + autoCorrect: true + AnnotationOnSeparateLine: + active: false + autoCorrect: true + ChainWrapping: + active: true + autoCorrect: true + CommentSpacing: + active: true + autoCorrect: true + EnumEntryNameCase: + active: false + autoCorrect: true + Filename: + active: true + FinalNewline: + active: true + autoCorrect: true + insertFinalNewLine: true + ImportOrdering: + active: false + autoCorrect: true + Indentation: + active: false + autoCorrect: true + indentSize: 4 + continuationIndentSize: 4 + MaximumLineLength: + active: true + maxLineLength: 120 + ModifierOrdering: + active: true + autoCorrect: true + MultiLineIfElse: + active: true + autoCorrect: true + NoBlankLineBeforeRbrace: + active: true + autoCorrect: true + NoConsecutiveBlankLines: + active: true + autoCorrect: true + NoEmptyClassBody: + active: true + autoCorrect: true + NoEmptyFirstLineInMethodBlock: + active: false + autoCorrect: true + NoLineBreakAfterElse: + active: true + autoCorrect: true + NoLineBreakBeforeAssignment: + active: true + autoCorrect: true + NoMultipleSpaces: + active: true + autoCorrect: true + NoSemicolons: + active: true + autoCorrect: true + NoTrailingSpaces: + active: true + autoCorrect: true + NoUnitReturn: + active: true + autoCorrect: true + NoUnusedImports: + active: true + autoCorrect: true + NoWildcardImports: + active: true + PackageName: + active: true + autoCorrect: true + ParameterListWrapping: + active: true + autoCorrect: true + indentSize: 4 + SpacingAroundColon: + active: true + autoCorrect: true + SpacingAroundComma: + active: true + autoCorrect: true + SpacingAroundCurly: + active: true + autoCorrect: true + SpacingAroundDot: + active: true + autoCorrect: true + SpacingAroundKeyword: + active: true + autoCorrect: true + SpacingAroundOperators: + active: true + autoCorrect: true + SpacingAroundParens: + active: true + autoCorrect: true + SpacingAroundRangeOperator: + active: true + autoCorrect: true + StringTemplate: + active: true + autoCorrect: true + +naming: + active: true + ClassNaming: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + classPattern: '[A-Z][a-zA-Z0-9]*' + ConstructorParameterNaming: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + parameterPattern: '[a-z][A-Za-z0-9]*' + privateParameterPattern: '[a-z][A-Za-z0-9]*' + excludeClassPattern: '$^' + ignoreOverridden: true + EnumNaming: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + enumEntryPattern: '[A-Z][_a-zA-Z0-9]*' + ForbiddenClassName: + active: false + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + forbiddenName: [] + FunctionMaxLength: + active: false + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + maximumFunctionNameLength: 30 + FunctionMinLength: + active: false + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + minimumFunctionNameLength: 3 + FunctionNaming: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + functionPattern: '([a-z][a-zA-Z0-9]*)|(`.*`)' + excludeClassPattern: '$^' + ignoreOverridden: true + FunctionParameterNaming: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + parameterPattern: '[a-z][A-Za-z0-9]*' + excludeClassPattern: '$^' + ignoreOverridden: true + InvalidPackageDeclaration: + active: false + rootPackage: '' + MatchingDeclarationName: + active: true + mustBeFirst: true + MemberNameEqualsClassName: + active: true + ignoreOverridden: true + ObjectPropertyNaming: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + constantPattern: '[A-Za-z][_A-Za-z0-9]*' + propertyPattern: '[A-Za-z][_A-Za-z0-9]*' + privatePropertyPattern: '(_)?[A-Za-z][_A-Za-z0-9]*' + PackageNaming: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + packagePattern: '[a-z]+(\.[a-z][A-Za-z0-9]*)*' + TopLevelPropertyNaming: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + constantPattern: '[A-Z][_A-Z0-9]*' + propertyPattern: '[A-Za-z][_A-Za-z0-9]*' + privatePropertyPattern: '_?[A-Za-z][_A-Za-z0-9]*' + VariableMaxLength: + active: false + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + maximumVariableNameLength: 64 + VariableMinLength: + active: false + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + minimumVariableNameLength: 1 + VariableNaming: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + variablePattern: '[a-z][A-Za-z0-9]*' + privateVariablePattern: '(_)?[a-z][A-Za-z0-9]*' + excludeClassPattern: '$^' + ignoreOverridden: true + +performance: + active: true + ArrayPrimitive: + active: true + ForEachOnRange: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + SpreadOperator: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + UnnecessaryTemporaryInstantiation: + active: true + +potential-bugs: + active: true + Deprecation: + active: false + DuplicateCaseInWhenExpression: + active: true + EqualsAlwaysReturnsTrueOrFalse: + active: true + EqualsWithHashCodeExist: + active: true + ExplicitGarbageCollectionCall: + active: true + HasPlatformType: + active: false + ImplicitDefaultLocale: + active: false + InvalidRange: + active: true + IteratorHasNextCallsNextMethod: + active: true + IteratorNotThrowingNoSuchElementException: + active: true + LateinitUsage: + active: false + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + excludeAnnotatedProperties: [] + ignoreOnClassesPattern: '' + MapGetWithNotNullAssertionOperator: + active: false + MissingWhenCase: + active: true + RedundantElseInWhen: + active: true + UnconditionalJumpStatementInLoop: + active: false + UnnecessaryNotNullOperator: + active: false + UnnecessarySafeCall: + active: false + UnreachableCode: + active: true + UnsafeCallOnNullableType: + active: true + UnsafeCast: + active: false + UselessPostfixExpression: + active: false + WrongEqualsTypeParameter: + active: true + +style: + active: true + CollapsibleIfStatements: + active: false + DataClassContainsFunctions: + active: false + conversionFunctionPrefix: 'to' + DataClassShouldBeImmutable: + active: false + EqualsNullCall: + active: true + EqualsOnSignatureLine: + active: false + ExplicitCollectionElementAccessMethod: + active: false + ExplicitItLambdaParameter: + active: false + ExpressionBodySyntax: + active: false + includeLineWrapping: false + ForbiddenComment: + active: true + values: ['TODO:', 'FIXME:', 'STOPSHIP:'] + allowedPatterns: '' + ForbiddenImport: + active: false + imports: [] + forbiddenPatterns: '' + ForbiddenMethodCall: + active: false + methods: [] + ForbiddenPublicDataClass: + active: false + ignorePackages: ['*.internal', '*.internal.*'] + ForbiddenVoid: + active: false + ignoreOverridden: false + ignoreUsageInGenerics: false + FunctionOnlyReturningConstant: + active: true + ignoreOverridableFunction: true + excludedFunctions: 'describeContents' + excludeAnnotatedFunction: ['dagger.Provides'] + LibraryCodeMustSpecifyReturnType: + active: true + LoopWithTooManyJumpStatements: + active: true + maxJumpCount: 1 + MagicNumber: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + ignoreNumbers: ['-1', '0', '1', '2', '4', '8', '16', '32'] + ignoreHashCodeFunction: true + ignorePropertyDeclaration: false + ignoreLocalVariableDeclaration: false + ignoreConstantDeclaration: true + ignoreCompanionObjectPropertyDeclaration: true + ignoreAnnotation: false + ignoreNamedArgument: true + ignoreEnums: false + ignoreRanges: false + MandatoryBracesIfStatements: + active: false + MandatoryBracesLoops: + active: false + MaxLineLength: + active: true + maxLineLength: 120 + excludePackageStatements: true + excludeImportStatements: true + excludeCommentStatements: false + MayBeConst: + active: true + ModifierOrder: + active: true + NestedClassesVisibility: + active: false + NewLineAtEndOfFile: + active: true + NoTabs: + active: false + OptionalAbstractKeyword: + active: true + OptionalUnit: + active: false + OptionalWhenBraces: + active: false + PreferToOverPairSyntax: + active: false + ProtectedMemberInFinalClass: + active: true + RedundantExplicitType: + active: false + RedundantVisibilityModifierRule: + active: false + ReturnCount: + active: true + max: 2 + excludedFunctions: 'equals' + excludeLabeled: false + excludeReturnFromLambda: true + excludeGuardClauses: false + SafeCast: + active: true + SerialVersionUIDInSerializableClass: + active: false + SpacingBetweenPackageAndImports: + active: false + ThrowsCount: + active: true + max: 2 + TrailingWhitespace: + active: false + UnderscoresInNumericLiterals: + active: false + acceptableDecimalLength: 5 + UnnecessaryAbstractClass: + active: true + excludeAnnotatedClasses: ['dagger.Module'] + UnnecessaryAnnotationUseSiteTarget: + active: false + UnnecessaryApply: + active: false + UnnecessaryInheritance: + active: true + UnnecessaryLet: + active: false + UnnecessaryParentheses: + active: false + UntilInsteadOfRangeTo: + active: false + UnusedImports: + active: false + UnusedPrivateClass: + active: true + UnusedPrivateMember: + active: false + allowedNames: '(_|ignored|expected|serialVersionUID)' + UseArrayLiteralsInAnnotations: + active: false + UseCheckOrError: + active: false + UseDataClass: + active: false + excludeAnnotatedClasses: [] + allowVars: false + UseIfInsteadOfWhen: + active: false + UseRequire: + active: false + UselessCallOnNotNull: + active: true + UtilityClassWithPublicConstructor: + active: true + VarCouldBeVal: + active: false + WildcardImport: + active: true + excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**'] + excludeImports: ['java.util.*', 'kotlinx.android.synthetic.*'] diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..29e08e8 --- /dev/null +++ b/gradle.properties @@ -0,0 +1 @@ +kotlin.code.style=official \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..f3d88b1 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..1b16c34 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.1.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..2fe81a7 --- /dev/null +++ b/gradlew @@ -0,0 +1,183 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..24467a1 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,100 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..643d110 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,2 @@ +rootProject.name = "tkn" + diff --git a/src/main/kotlin/it/unisannio/assd/tkn/Const.kt b/src/main/kotlin/it/unisannio/assd/tkn/Const.kt new file mode 100644 index 0000000..75b6cfd --- /dev/null +++ b/src/main/kotlin/it/unisannio/assd/tkn/Const.kt @@ -0,0 +1,13 @@ +package it.unisannio.assd.tkn + +object Const { + private const val H_TCK_DOMAIN_SEPARATOR_STRING = "H_TCK" + val H_TCK_DOMAIN_SEPARATOR = H_TCK_DOMAIN_SEPARATOR_STRING + .toByteArray(Charsets.UTF_8) + + private const val H_TCN_DOMAIN_SEPARATOR_STRING = "H_TCN" + val H_TCN_DOMAIN_SEPARATOR = H_TCN_DOMAIN_SEPARATOR_STRING + .toByteArray(Charsets.UTF_8) + + const val REPORT_SIZE = 70 +} diff --git a/src/main/kotlin/it/unisannio/assd/tkn/Extensions.kt b/src/main/kotlin/it/unisannio/assd/tkn/Extensions.kt new file mode 100644 index 0000000..f41ec75 --- /dev/null +++ b/src/main/kotlin/it/unisannio/assd/tkn/Extensions.kt @@ -0,0 +1,30 @@ +package it.unisannio.assd.tkn + +import java.math.BigInteger +import java.nio.ByteBuffer +import java.nio.ByteOrder + +fun Short.toLeByteArray(): ByteArray { + val buffer = ByteBuffer + .allocate(2).apply { + order(ByteOrder.LITTLE_ENDIAN) + putShort(this@toLeByteArray) + } + + return buffer.array() +} + +fun ByteArray.toHexString(): String { + val builder = StringBuilder() + this.map { String.format("%02x", it) } + .forEach { builder.append(it) } + return builder.toString() +} + +fun String.toHexByteArray(): ByteArray = BigInteger(this, 16).toByteArray() + +fun ByteBuffer.read(n: Int): ByteArray { + val bytes = ByteArray(n) + this.get(bytes) + return bytes +} diff --git a/src/main/kotlin/it/unisannio/assd/tkn/key/ReportAuthorizationKey.kt b/src/main/kotlin/it/unisannio/assd/tkn/key/ReportAuthorizationKey.kt new file mode 100644 index 0000000..0bad1d7 --- /dev/null +++ b/src/main/kotlin/it/unisannio/assd/tkn/key/ReportAuthorizationKey.kt @@ -0,0 +1,51 @@ +package it.unisannio.assd.tkn.key + +import cafe.cryptography.ed25519.Ed25519PrivateKey +import cafe.cryptography.ed25519.Ed25519PublicKey +import it.unisannio.assd.tkn.Const +import it.unisannio.assd.tkn.toHexByteArray +import java.security.MessageDigest +import java.security.SecureRandom + +class ReportAuthorizationKey private constructor(private val key: Ed25519PrivateKey) { + + fun deriveVerificationKey(): ReportVerificationKey = + ReportVerificationKey.createFromAuthorizationKey(this) + + fun baseTemporaryContactKey(): TemporaryContactKey { + val hmac = MessageDigest.getInstance("SHA-256").apply { + update(Const.H_TCK_DOMAIN_SEPARATOR) + update(key.toByteArray()) + } + + return TemporaryContactKey.createFromByteArray( + hmac.digest(), + 0 + ) + } + + fun sign(message: ByteArray, rvk: ReportVerificationKey): ByteArray = key.expand() + .sign( + message, + Ed25519PublicKey.fromByteArray(rvk.toByteArray()) + ).toByteArray() + + fun toByteArray(): ByteArray = key.toByteArray() + + companion object { + fun createFromByteArray(bytes: ByteArray): ReportAuthorizationKey = + ReportAuthorizationKey( + Ed25519PrivateKey.fromByteArray(bytes) + ) + + fun createFromHexString(hexString: String): ReportAuthorizationKey = + ReportAuthorizationKey( + Ed25519PrivateKey.fromByteArray(hexString.toHexByteArray()) + ) + + fun createFromSecureRandom(random: SecureRandom): ReportAuthorizationKey = + ReportAuthorizationKey( + Ed25519PrivateKey.generate(random) + ) + } +} diff --git a/src/main/kotlin/it/unisannio/assd/tkn/key/ReportVerificationKey.kt b/src/main/kotlin/it/unisannio/assd/tkn/key/ReportVerificationKey.kt new file mode 100644 index 0000000..4614da9 --- /dev/null +++ b/src/main/kotlin/it/unisannio/assd/tkn/key/ReportVerificationKey.kt @@ -0,0 +1,36 @@ +package it.unisannio.assd.tkn.key + +import cafe.cryptography.ed25519.Ed25519PrivateKey +import cafe.cryptography.ed25519.Ed25519PublicKey +import cafe.cryptography.ed25519.Ed25519Signature +import it.unisannio.assd.tkn.toHexString + +class ReportVerificationKey private constructor(private val key: Ed25519PublicKey) { + fun contactNumbersBetween( + tck: TemporaryContactKey, + from: Short, + until: Short + ) = tck.contactNumbersBetween(this, from, until) + + fun verify(message: ByteArray, sign: ByteArray): Boolean = key.verify( + message, + Ed25519Signature.fromByteArray(sign) + ) + + fun toByteArray(): ByteArray = key.toByteArray() + + fun toHexString() = toByteArray().toHexString() + + companion object { + fun createFromAuthorizationKey(authorizationKey: ReportAuthorizationKey) = + ReportVerificationKey( + Ed25519PrivateKey.fromByteArray(authorizationKey.toByteArray()) + .derivePublic() + ) + + fun createFromByteArray(bytes: ByteArray): ReportVerificationKey = + ReportVerificationKey( + Ed25519PublicKey.fromByteArray(bytes) + ) + } +} diff --git a/src/main/kotlin/it/unisannio/assd/tkn/key/TemporaryContactKey.kt b/src/main/kotlin/it/unisannio/assd/tkn/key/TemporaryContactKey.kt new file mode 100644 index 0000000..d68adc3 --- /dev/null +++ b/src/main/kotlin/it/unisannio/assd/tkn/key/TemporaryContactKey.kt @@ -0,0 +1,75 @@ +package it.unisannio.assd.tkn.key + +import it.unisannio.assd.tkn.Const +import it.unisannio.assd.tkn.report.Memo +import it.unisannio.assd.tkn.report.Report +import it.unisannio.assd.tkn.toHexString +import it.unisannio.assd.tkn.toLeByteArray +import java.security.MessageDigest + +class TemporaryContactKey private constructor( + private val key: ByteArray, + private val index: Short +) { + fun nextTemporaryContactKey(rvk: ReportVerificationKey): TemporaryContactKey { + val hmac = MessageDigest.getInstance("SHA-256").apply { + update(Const.H_TCK_DOMAIN_SEPARATOR) + update(rvk.toByteArray()) + update(key) + } + + return TemporaryContactKey( + hmac.digest(), + index.inc() + ) + } + + fun deriveTemporaryContactNumber(): TemporaryContactNumber { + val hmac = MessageDigest.getInstance("SHA-256").apply { + update(Const.H_TCN_DOMAIN_SEPARATOR) + update(index.toLeByteArray()) + update(key) + } + + return TemporaryContactNumber( + hmac.digest().sliceArray(0 until 16), + index + ) + } + + fun contactNumbersBetween( + rvk: ReportVerificationKey, + from: Short, + until: Short + ): List { + val numbers = mutableListOf() + var lastKey = this + + for (i in from until until) { + lastKey = lastKey.nextTemporaryContactKey(rvk) + numbers.add(lastKey.deriveTemporaryContactNumber()) + } + + return numbers + } + + fun generateReport(rvk: ReportVerificationKey, until: Short, memo: Memo): Report = Report.createReport( + rvk, + this, + index.inc(), + until, + memo + ) + + fun toByteArray() = key + + fun toHexString() = key.toHexString() + + companion object { + fun createFromByteArray(bytes: ByteArray, index: Short): TemporaryContactKey = + TemporaryContactKey( + bytes, + index + ) + } +} diff --git a/src/main/kotlin/it/unisannio/assd/tkn/key/TemporaryContactNumber.kt b/src/main/kotlin/it/unisannio/assd/tkn/key/TemporaryContactNumber.kt new file mode 100644 index 0000000..3436730 --- /dev/null +++ b/src/main/kotlin/it/unisannio/assd/tkn/key/TemporaryContactNumber.kt @@ -0,0 +1,21 @@ +package it.unisannio.assd.tkn.key + +import it.unisannio.assd.tkn.toHexString +import java.nio.ByteBuffer +import java.util.* + +class TemporaryContactNumber( + private val number: ByteArray, + private val index: Short +) { + fun toHexString() = number.toHexString() + + fun toUUID(): UUID { + val byteBuffer = ByteBuffer.wrap(number) + val high = byteBuffer.long + val low = byteBuffer.long + return UUID(high, low) + } + + fun toByteArray() = number +} diff --git a/src/main/kotlin/it/unisannio/assd/tkn/report/Memo.kt b/src/main/kotlin/it/unisannio/assd/tkn/report/Memo.kt new file mode 100644 index 0000000..fabcb90 --- /dev/null +++ b/src/main/kotlin/it/unisannio/assd/tkn/report/Memo.kt @@ -0,0 +1,5 @@ +package it.unisannio.assd.tkn.report + +// TODO + +typealias Memo = String diff --git a/src/main/kotlin/it/unisannio/assd/tkn/report/Report.kt b/src/main/kotlin/it/unisannio/assd/tkn/report/Report.kt new file mode 100644 index 0000000..bf3f886 --- /dev/null +++ b/src/main/kotlin/it/unisannio/assd/tkn/report/Report.kt @@ -0,0 +1,89 @@ +package it.unisannio.assd.tkn.report + +import it.unisannio.assd.tkn.Const +import it.unisannio.assd.tkn.key.ReportAuthorizationKey +import it.unisannio.assd.tkn.key.ReportVerificationKey +import it.unisannio.assd.tkn.key.TemporaryContactKey +import it.unisannio.assd.tkn.read +import it.unisannio.assd.tkn.toHexString +import java.nio.ByteBuffer +import java.nio.ByteOrder + +class Report private constructor(private val report: ByteArray) { + private val reportData by lazy { + readReportDataFromByteArray(report) + } + + fun signWith(rak: ReportAuthorizationKey): SignedReport = + SignedReport.createFromReport( + this, + rak + ) + + fun getVerificationKey(): ReportVerificationKey = reportData.rvk + + fun toReportData(): ReportData = reportData + + fun toByteArray() = report + + fun toHexString() = report.toHexString() + + companion object { + fun createReport( + rvk: ReportVerificationKey, + tck: TemporaryContactKey, + from: Short, + until: Short, + memo: Memo + ): Report { + val memoData = memo.toByteArray() + val buffer = ByteBuffer.allocate(Const.REPORT_SIZE + memoData.size).apply { + order(ByteOrder.LITTLE_ENDIAN) + put(rvk.toByteArray()) + put(tck.toByteArray()) + putShort(from) + putShort(until) + put(0) // TODO + put(memoData.size.toByte()) + put(memoData) + } + + return Report(buffer.array()) + } + + fun createReport(reportData: ReportData): Report = + createReport( + reportData.rvk, + reportData.tck, + reportData.from, + reportData.until, + reportData.memo + ) + + fun readReportFromByteArray(bytes: ByteArray): Report = + createReport( + readReportDataFromByteArray(bytes) + ) + + fun readReportDataFromByteArray(bytes: ByteArray): ReportData { + val buffer = ByteBuffer.wrap(bytes).apply { + order(ByteOrder.LITTLE_ENDIAN) + } + + val rvk = ReportVerificationKey.createFromByteArray(buffer.read(32)) + val tckBytes = buffer.read(32) + val from = buffer.short + val until = buffer.short + val memoType = buffer.get() + val memoData = String(buffer.read(buffer.get().toInt())) + + return ReportData( + rvk, + TemporaryContactKey.createFromByteArray(tckBytes, from.dec()), + from, + until, + memoData + ) + } + } +} diff --git a/src/main/kotlin/it/unisannio/assd/tkn/report/ReportData.kt b/src/main/kotlin/it/unisannio/assd/tkn/report/ReportData.kt new file mode 100644 index 0000000..f3dc4b9 --- /dev/null +++ b/src/main/kotlin/it/unisannio/assd/tkn/report/ReportData.kt @@ -0,0 +1,12 @@ +package it.unisannio.assd.tkn.report + +import it.unisannio.assd.tkn.key.ReportVerificationKey +import it.unisannio.assd.tkn.key.TemporaryContactKey + +data class ReportData( + val rvk: ReportVerificationKey, + val tck: TemporaryContactKey, + val from: Short, + val until: Short, + val memo: Memo +) diff --git a/src/main/kotlin/it/unisannio/assd/tkn/report/SignedReport.kt b/src/main/kotlin/it/unisannio/assd/tkn/report/SignedReport.kt new file mode 100644 index 0000000..ee6a0df --- /dev/null +++ b/src/main/kotlin/it/unisannio/assd/tkn/report/SignedReport.kt @@ -0,0 +1,51 @@ +package it.unisannio.assd.tkn.report + +import it.unisannio.assd.tkn.key.ReportAuthorizationKey +import it.unisannio.assd.tkn.read +import it.unisannio.assd.tkn.toHexString +import java.nio.ByteBuffer +import java.nio.ByteOrder + +class SignedReport private constructor( + val report: Report, + private val sign: ByteArray +) { + fun verify(): Boolean = report.getVerificationKey() + .verify(report.toByteArray(), sign) + + fun toByteArray(): ByteArray { + val reportBytes = report.toByteArray() + val buffer = ByteBuffer.allocate(reportBytes.size + sign.size).apply { + put(reportBytes) + put(sign) + } + + return buffer.array() + } + + fun toHexString(): String = toByteArray().toHexString() + + companion object { + fun createFromReport( + report: Report, + rak: ReportAuthorizationKey + ): SignedReport = + SignedReport( + report, + rak.sign(report.toByteArray(), report.getVerificationKey()) + ) + + fun readFromByteArray(bytes: ByteArray): SignedReport { + val report = Report.readReportFromByteArray(bytes) + + val buffer = ByteBuffer.wrap(bytes).apply { + order(ByteOrder.LITTLE_ENDIAN) + read(report.toByteArray().size) + } + + val sign = buffer.read(buffer.remaining()) + + return SignedReport(report, sign) + } + } +}