From 8c71afc25093b774a559e41ae9e5dd93e8d0470b Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Sun, 9 Jul 2023 13:01:13 +0200 Subject: [PATCH] Rename classes --- .../cli/subcommands/AuthenticateCmdTest.kt | 8 +- .../kotlin/org/pgpainless/wot/WebOfTrust.kt | 10 +- .../wot/util/CertificationFactory.kt | 24 ++-- .../test/kotlin/org/pgpainless/wot/PGPDSL.kt | 10 +- .../org/pgpainless/wot/WebOfTrustTest.kt | 8 +- .../wot/dijkstra/sq/CertificationSet.kt | 115 --------------- .../org/pgpainless/wot/dijkstra/sq/Edge.kt | 114 +++++++++++++++ .../sq/{Certification.kt => EdgeComponent.kt} | 32 ++--- .../org/pgpainless/wot/dijkstra/sq/Network.kt | 38 ++--- .../dijkstra/sq/{CertSynopsis.kt => Node.kt} | 4 +- .../org/pgpainless/wot/dijkstra/sq/Path.kt | 42 +++--- .../wot/dijkstra/CertificationSetTest.kt | 133 ------------------ ...tificationTest.kt => EdgeComponentTest.kt} | 26 ++-- .../org/pgpainless/wot/dijkstra/EdgeTest.kt | 133 ++++++++++++++++++ .../org/pgpainless/wot/dijkstra/NetworkDSL.kt | 88 ++++++------ .../{CertSynopsisTest.kt => NodeTest.kt} | 8 +- .../org/pgpainless/wot/dijkstra/PathTest.kt | 25 ++-- .../org/pgpainless/wot/dijkstra/PathsTest.kt | 9 +- 18 files changed, 412 insertions(+), 415 deletions(-) delete mode 100644 wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/CertificationSet.kt create mode 100644 wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Edge.kt rename wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/{Certification.kt => EdgeComponent.kt} (66%) rename wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/{CertSynopsis.kt => Node.kt} (89%) delete mode 100644 wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/CertificationSetTest.kt rename wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/{CertificationTest.kt => EdgeComponentTest.kt} (60%) create mode 100644 wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/EdgeTest.kt rename wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/{CertSynopsisTest.kt => NodeTest.kt} (75%) diff --git a/pgpainless-wot-cli/src/test/kotlin/org/pgpainless/wot/cli/subcommands/AuthenticateCmdTest.kt b/pgpainless-wot-cli/src/test/kotlin/org/pgpainless/wot/cli/subcommands/AuthenticateCmdTest.kt index e1e4072c..cb1310d8 100644 --- a/pgpainless-wot-cli/src/test/kotlin/org/pgpainless/wot/cli/subcommands/AuthenticateCmdTest.kt +++ b/pgpainless-wot-cli/src/test/kotlin/org/pgpainless/wot/cli/subcommands/AuthenticateCmdTest.kt @@ -13,7 +13,7 @@ class AuthenticateCmdTest { val dateFormat = SimpleDateFormat("yyyy-MM-dd") val cmd = AuthenticateCmd() val paths = Paths() - val neal = CertSynopsis( + val neal = Node( Fingerprint("F7173B3C7C685CD9ECC4191B74E445BA0E15C957"), null, RevocationState.notRevoked(), @@ -21,7 +21,7 @@ class AuthenticateCmdTest { Pair("Neal H. Walfield (Code Signing Key) ", RevocationState.notRevoked()) ) ) - val justus = CertSynopsis( + val justus = Node( Fingerprint("CBCD8F030588653EEDD7E2659B7DD433F254904A"), null, RevocationState.notRevoked(), @@ -29,7 +29,7 @@ class AuthenticateCmdTest { Pair("Justus Winter ", RevocationState.notRevoked()) ) ) - val certification = Certification( + val edgeComponent = EdgeComponent( neal, justus, "Justus Winter ", @@ -39,7 +39,7 @@ class AuthenticateCmdTest { 120, Depth.limited(0), RegexSet.wildcard()) - paths.add(Path(neal, mutableListOf(certification), Depth.auto(0)), 120) + paths.add(Path(neal, mutableListOf(edgeComponent), Depth.auto(0)), 120) val testResult = AuthenticateAPI.Result( Fingerprint("CBCD8F030588653EEDD7E2659B7DD433F254904A"), "Justus Winter ", diff --git a/pgpainless-wot/src/main/kotlin/org/pgpainless/wot/WebOfTrust.kt b/pgpainless-wot/src/main/kotlin/org/pgpainless/wot/WebOfTrust.kt index 48905f54..1f6dbfea 100644 --- a/pgpainless-wot/src/main/kotlin/org/pgpainless/wot/WebOfTrust.kt +++ b/pgpainless-wot/src/main/kotlin/org/pgpainless/wot/WebOfTrust.kt @@ -95,7 +95,7 @@ class WebOfTrust(private val certificateStore: PGPCertificateStore) { private val byKeyId: MutableMap> = HashMap() // nodes keyed by fingerprint - private val nodeMap: MutableMap = HashMap() + private val nodeMap: MutableMap = HashMap() init { validatedCertificates.forEach { indexAsNode(it) } @@ -131,7 +131,7 @@ class WebOfTrust(private val certificateStore: PGPCertificateStore) { // map user-ids to revocation states val userIds = cert.userIds.associateWith { RevocationState(cert.getUserIdRevocation(it)) } - val node = CertSynopsis(certFingerprint, + val node = Node(certFingerprint, expirationDate, RevocationState(cert.revocationSelfSignature), userIds) @@ -158,7 +158,7 @@ class WebOfTrust(private val certificateStore: PGPCertificateStore) { processDelegation(targetPrimaryKey, target, delegation) } - // Certification Signatures by X on Y over user-ID U + // EdgeComponent Signatures by X on Y over user-ID U val userIds = targetPrimaryKey.userIDs while (userIds.hasNext()) { val userId = userIds.next() @@ -180,7 +180,7 @@ class WebOfTrust(private val certificateStore: PGPCertificateStore) { * @param delegation delegation signature */ private fun processDelegation(targetPrimaryKey: PGPPublicKey, - target: CertSynopsis, + target: Node, delegation: PGPSignature) { // There might be more than one cert with a subkey of matching key-id val issuerCandidates = byKeyId[delegation.keyID] @@ -217,7 +217,7 @@ class WebOfTrust(private val certificateStore: PGPCertificateStore) { * @param certification certification signature */ private fun processCertificationOnUserId(targetPrimaryKey: PGPPublicKey, - target: CertSynopsis, + target: Node, userId: String, certification: PGPSignature) { // There might be more than one cert with a subkey of matching key-id diff --git a/pgpainless-wot/src/main/kotlin/org/pgpainless/wot/util/CertificationFactory.kt b/pgpainless-wot/src/main/kotlin/org/pgpainless/wot/util/CertificationFactory.kt index 944f95c4..7bad1869 100644 --- a/pgpainless-wot/src/main/kotlin/org/pgpainless/wot/util/CertificationFactory.kt +++ b/pgpainless-wot/src/main/kotlin/org/pgpainless/wot/util/CertificationFactory.kt @@ -6,8 +6,8 @@ package org.pgpainless.wot.util import org.bouncycastle.openpgp.PGPSignature import org.pgpainless.signature.subpackets.SignatureSubpacketsUtil -import org.pgpainless.wot.dijkstra.sq.CertSynopsis -import org.pgpainless.wot.dijkstra.sq.Certification +import org.pgpainless.wot.dijkstra.sq.Node +import org.pgpainless.wot.dijkstra.sq.EdgeComponent import org.pgpainless.wot.dijkstra.sq.Depth import org.pgpainless.wot.dijkstra.sq.RegexSet import org.pgpainless.wot.dijkstra.sq.RegexSet.Companion.fromExpressionList @@ -16,26 +16,26 @@ class CertificationFactory { companion object { @JvmStatic - fun fromDelegation(issuer: CertSynopsis, - target: CertSynopsis, - signature: PGPSignature): Certification { + fun fromDelegation(issuer: Node, + target: Node, + signature: PGPSignature): EdgeComponent { return fromSignature(issuer, target, null, signature) } @JvmStatic - fun fromCertification(issuer: CertSynopsis, - target: CertSynopsis, + fun fromCertification(issuer: Node, + target: Node, targetUserId: String, - signature: PGPSignature): Certification { + signature: PGPSignature): EdgeComponent { return fromSignature(issuer, target, targetUserId, signature) } @JvmStatic - fun fromSignature(issuer: CertSynopsis, - target: CertSynopsis, + fun fromSignature(issuer: Node, + target: Node, targetUserId: String?, - signature: PGPSignature): Certification { - return Certification( + signature: PGPSignature): EdgeComponent { + return EdgeComponent( issuer, target, targetUserId, diff --git a/pgpainless-wot/src/test/kotlin/org/pgpainless/wot/PGPDSL.kt b/pgpainless-wot/src/test/kotlin/org/pgpainless/wot/PGPDSL.kt index d25f59a9..73547ef6 100644 --- a/pgpainless-wot/src/test/kotlin/org/pgpainless/wot/PGPDSL.kt +++ b/pgpainless-wot/src/test/kotlin/org/pgpainless/wot/PGPDSL.kt @@ -5,18 +5,18 @@ import org.bouncycastle.openpgp.PGPSignature import org.pgpainless.algorithm.RevocationStateType import org.pgpainless.key.OpenPgpFingerprint import org.pgpainless.key.info.KeyRingInfo -import org.pgpainless.wot.dijkstra.sq.CertSynopsis +import org.pgpainless.wot.dijkstra.sq.Node import org.pgpainless.wot.dijkstra.sq.Fingerprint import org.pgpainless.wot.dijkstra.sq.RevocationState interface PGPDSL { - fun CertSynopsis(certificate: PGPPublicKeyRing): CertSynopsis { - return CertSynopsis(Fingerprint(certificate), ) + fun CertSynopsis(certificate: PGPPublicKeyRing): Node { + return Node(Fingerprint(certificate), ) } - fun CertSynopsis(validatedCert: KeyRingInfo): CertSynopsis { - return CertSynopsis( + fun CertSynopsis(validatedCert: KeyRingInfo): Node { + return Node( Fingerprint(validatedCert.fingerprint), validatedCert.primaryKeyExpirationDate, RevocationState(validatedCert.revocationState), diff --git a/pgpainless-wot/src/test/kotlin/org/pgpainless/wot/WebOfTrustTest.kt b/pgpainless-wot/src/test/kotlin/org/pgpainless/wot/WebOfTrustTest.kt index b2917dfd..426a1d70 100644 --- a/pgpainless-wot/src/test/kotlin/org/pgpainless/wot/WebOfTrustTest.kt +++ b/pgpainless-wot/src/test/kotlin/org/pgpainless/wot/WebOfTrustTest.kt @@ -7,7 +7,7 @@ package org.pgpainless.wot import org.bouncycastle.openpgp.PGPPublicKeyRing import org.pgpainless.key.OpenPgpFingerprint -import org.pgpainless.wot.dijkstra.sq.CertificationSet +import org.pgpainless.wot.dijkstra.sq.Edge import org.pgpainless.wot.dijkstra.sq.Fingerprint import org.pgpainless.wot.dijkstra.sq.Network import org.pgpainless.wot.testfixtures.TestCertificateStores @@ -94,7 +94,7 @@ class WebOfTrustTest { private fun assertHasIssuerAndTarget( - certifications: CertificationSet, + certifications: Edge, issuer: Fingerprint, target: Fingerprint) { assertEquals(issuer, certifications.issuer.fingerprint) @@ -119,12 +119,12 @@ class WebOfTrustTest { assertNull(reverseEdge, "Expected no reverse edge on $target from $issuer but got $reverseEdge") } - private fun getEdgeFromTo(network: Network, issuer: Fingerprint, target: Fingerprint): CertificationSet? { + private fun getEdgeFromTo(network: Network, issuer: Fingerprint, target: Fingerprint): Edge? { val edges = network.edges[issuer] ?: return null return edges.find { target == it.target.fingerprint } } - private fun getReverseEdgeFromTo(network: Network, issuer: Fingerprint, target: Fingerprint): CertificationSet? { + private fun getReverseEdgeFromTo(network: Network, issuer: Fingerprint, target: Fingerprint): Edge? { val revEdges = network.reverseEdges[target] ?: return null return revEdges.find { issuer == it.issuer.fingerprint } } diff --git a/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/CertificationSet.kt b/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/CertificationSet.kt deleted file mode 100644 index 47c55b6a..00000000 --- a/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/CertificationSet.kt +++ /dev/null @@ -1,115 +0,0 @@ -// SPDX-FileCopyrightText: 2023 Paul Schaub -// -// SPDX-License-Identifier: Apache-2.0 - -package org.pgpainless.wot.dijkstra.sq - -/** - * A [CertificationSet] is a set of [Certifications][Certification] made by the same issuer, on the same - * target certificate. - * In some sense, a [CertificationSet] can be considered an edge in the web of trust. - * - * @param issuer synopsis of the certificate that issued the [Certifications][Certification] - * @param target synopsis of the certificate that is targeted by the [Certifications][Certification] - * @param certifications [Map] keyed by user-ids, whose values are [Lists][List] of - * [Certifications][Certification] that are calculated over the key user-id. Note, that the key can also be null for - * [Certifications][Certification] over the targets primary key. - */ -class CertificationSet( - val issuer: CertSynopsis, - val target: CertSynopsis, - certifications: Map>) { - - init { - certifications.forEach { (_, certifications) -> - certifications.forEach { - add(it) - } - } - } - - private val _certifications: MutableMap> = mutableMapOf() - val certifications: Map> - get() = _certifications.toMutableMap() - - companion object { - - /** - * Create an empty [CertificationSet]. - * - * @param issuer the certificate that issued the [Certifications][Certification]. - * @param target the certificate that is targeted by the [Certifications][Certification]. - */ - @JvmStatic - fun empty(issuer: CertSynopsis, target: CertSynopsis): CertificationSet { - return CertificationSet(issuer, target, HashMap()) - } - - /** - * Create a [CertificationSet] from a single [Certification]. - * - * @param certification certification - */ - @JvmStatic - fun fromCertification(certification: Certification): CertificationSet { - val set = empty(certification.issuer, certification.target) - set.add(certification) - return set - } - } - - /** - * Merge the given [CertificationSet] into this. - * This method copies all [Certifications][Certification] from the other [CertificationSet] into [certifications]. - * - * @param other [CertificationSet] with the same issuer fingerprint and target fingerprint as this object. - */ - fun merge(other: CertificationSet) { - if (other == this) { - return - } - - require(issuer.fingerprint == other.issuer.fingerprint) { "Issuer fingerprint mismatch." } - require(target.fingerprint == other.target.fingerprint) { "Target fingerprint mismatch." } - - for (userId in other.certifications.keys) { - for (certification in other.certifications[userId]!!) { - add(certification) - } - } - } - - /** - * Add a single [Certification] into this objects [certifications]. - * Adding multiple [Certifications][Certification] for the same datum, but with different creation times results in - * only the most recent [Certification(s)][Certification] to be preserved. - * - * @param certification [Certification] with the same issuer fingerprint and target fingerprint as this object. - */ - fun add(certification: Certification) { - require(issuer.fingerprint == certification.issuer.fingerprint) { "Issuer fingerprint mismatch." } - require(target.fingerprint == certification.target.fingerprint) { "Target fingerprint mismatch." } - - val certificationsForUserId = _certifications.getOrPut(certification.userId) { mutableListOf() } - if (certificationsForUserId.isEmpty()) { - certificationsForUserId.add(certification) - return - } - - val existing = certificationsForUserId[0] - // if existing is older than this certification - if (existing.creationTime.before(certification.creationTime)) { - // throw away older certifications - certificationsForUserId.clear() - } - // If this certification is newest (or equally old!) - if (!existing.creationTime.after(certification.creationTime)) { - certificationsForUserId.add(certification) - } - // else this certification is older, so don't add it - } - - override fun toString(): String { - return certifications.map { it.value }.flatten().joinToString("\n") - } -} \ No newline at end of file diff --git a/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Edge.kt b/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Edge.kt new file mode 100644 index 00000000..5b75cffa --- /dev/null +++ b/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Edge.kt @@ -0,0 +1,114 @@ +// SPDX-FileCopyrightText: 2023 Paul Schaub +// +// SPDX-License-Identifier: Apache-2.0 + +package org.pgpainless.wot.dijkstra.sq + +/** + * An [Edge] is a set of [components][EdgeComponent] made by the same issuer, on the same + * target. + * + * @param issuer origin node + * @param target target node + * @param components [Map] keyed by datum, whose values are [Lists][List] of + * [EdgeComponents][EdgeComponent] that are calculated over the key datum. + * Note, that the key can also be null for [EdgeComponents][EdgeComponent] over the targets primary key. + */ +class Edge( + val issuer: Node, + val target: Node, + components: Map>) { + + init { + components.forEach { (_, certifications) -> + certifications.forEach { + add(it) + } + } + } + + private val _components: MutableMap> = mutableMapOf() + val components: Map> + get() = _components.toMutableMap() + + companion object { + + /** + * Create an empty [Edge] with no [components][EdgeComponent]. + * + * @param issuer the certificate that issued the [EdgeComponents][EdgeComponent]. + * @param target the certificate that is targeted by the [EdgeComponents][EdgeComponent]. + */ + @JvmStatic + fun empty(issuer: Node, target: Node): Edge { + return Edge(issuer, target, HashMap()) + } + + /** + * Create a [Edge] from a single [EdgeComponent]. + * + * @param certification certification + */ + @JvmStatic + fun fromCertification(certification: EdgeComponent): Edge { + val set = empty(certification.issuer, certification.target) + set.add(certification) + return set + } + } + + /** + * Merge the given [Edge] into this. + * This method copies all [EdgeComponents][EdgeComponent] from the other [Edge] into [components]. + * + * @param other [Edge] with the same issuer fingerprint and target fingerprint as this object. + */ + fun merge(other: Edge) { + if (other == this) { + return + } + + require(issuer.fingerprint == other.issuer.fingerprint) { "Issuer fingerprint mismatch." } + require(target.fingerprint == other.target.fingerprint) { "Target fingerprint mismatch." } + + for (userId in other.components.keys) { + for (certification in other.components[userId]!!) { + add(certification) + } + } + } + + /** + * Add a single [EdgeComponent] into this objects [components]. + * Adding multiple [EdgeComponents][EdgeComponent] for the same datum, but with different creation times results in + * only the most recent [EdgeComponent(s)][EdgeComponent] to be preserved. + * + * @param component [EdgeComponent] with the same issuer fingerprint and target fingerprint as this object. + */ + fun add(component: EdgeComponent) { + require(issuer.fingerprint == component.issuer.fingerprint) { "Issuer fingerprint mismatch." } + require(target.fingerprint == component.target.fingerprint) { "Target fingerprint mismatch." } + + val certificationsForUserId = _components.getOrPut(component.userId) { mutableListOf() } + if (certificationsForUserId.isEmpty()) { + certificationsForUserId.add(component) + return + } + + val existing = certificationsForUserId[0] + // if existing is older than this component + if (existing.creationTime.before(component.creationTime)) { + // throw away older certifications + certificationsForUserId.clear() + } + // If this component is newest (or equally old!) + if (!existing.creationTime.after(component.creationTime)) { + certificationsForUserId.add(component) + } + // else this component is older, so don't add it + } + + override fun toString(): String { + return components.map { it.value }.flatten().joinToString("\n") + } +} \ No newline at end of file diff --git a/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Certification.kt b/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/EdgeComponent.kt similarity index 66% rename from wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Certification.kt rename to wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/EdgeComponent.kt index 259ab703..e1ca6abd 100644 --- a/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Certification.kt +++ b/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/EdgeComponent.kt @@ -7,22 +7,22 @@ package org.pgpainless.wot.dijkstra.sq import java.util.* /** - * A [Certification] is a signature issued by one certificate over a datum on another target certificate. + * An [EdgeComponent] is a signature issued by one certificate over a datum on another target certificate. * Such a datum could be either a user-id, or the primary key of the target certificate. * - * @param issuer synopsis of the certificate that issued the [Certification] - * @param target synopsis of the certificate that is target of this [Certification] - * @param userId optional user-id. If this is null, the [Certification] is made over the primary key of the target. - * @param creationTime creation time of the [Certification] - * @param expirationTime optional expiration time of the [Certification] + * @param issuer certificate that issued the [EdgeComponent] + * @param target certificate that is target of this [EdgeComponent] + * @param userId optional user-id. If this is null, the [EdgeComponent] is made over the primary key of the target. + * @param creationTime creation time of the [EdgeComponent] + * @param expirationTime optional expiration time of the [EdgeComponent] * @param exportable if false, the certification is marked as "not exportable" * @param trustAmount amount of trust the issuer places in the binding * @param trustDepth degree to which the issuer trusts the target as trusted introducer * @param regexes regular expressions for user-ids which the target is allowed to introduce */ -data class Certification( - val issuer: CertSynopsis, - val target: CertSynopsis, +data class EdgeComponent( + val issuer: Node, + val target: Node, val userId: String?, val creationTime: Date, val expirationTime: Date?, @@ -33,17 +33,17 @@ data class Certification( ) { /** - * Construct a [Certification] with default values. The result is non-expiring, will be exportable and has a + * Construct a [EdgeComponent] with default values. The result is non-expiring, will be exportable and has a * trust amount of 120, a depth of 0 and a wildcard regex. * - * @param issuer synopsis of the certificate that issued the [Certification] - * @param target synopsis of the certificate that is target of this [Certification] - * @param targetUserId optional user-id. If this is null, the [Certification] is made over the primary key of the target. - * @param creationTime creation time of the [Certification] + * @param issuer synopsis of the certificate that issued the [EdgeComponent] + * @param target synopsis of the certificate that is target of this [EdgeComponent] + * @param targetUserId optional user-id. If this is null, the [EdgeComponent] is made over the primary key of the target. + * @param creationTime creation time of the [EdgeComponent] */ constructor( - issuer: CertSynopsis, - target: CertSynopsis, + issuer: Node, + target: Node, targetUserId: String? = null, creationTime: Date) : this(issuer, target, targetUserId, creationTime, null, true, 120, Depth.limited(0), RegexSet.wildcard()) diff --git a/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Network.kt b/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Network.kt index 284b24b9..69ddf0e0 100644 --- a/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Network.kt +++ b/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Network.kt @@ -6,19 +6,19 @@ package org.pgpainless.wot.dijkstra.sq /** * A network consists of nodes, and edges between them. - * For the Web of Trust, nodes consist of [CertSynopses][CertSynopsis], while the edges between the nodes are - * [CertificationSets][CertificationSet]. + * For the Web of Trust, a [Node] is a certificate, while the [Edges][Edge] between them are sets of signatures + * ([EdgeComponent]). * * @constructor creates a new network - * @param nodes contains a [Map] of [CertSynopsis] keyed by their [Fingerprint] - * @param edges [Map] keyed by the [fingerprint][Fingerprint] of an issuer, whose values are [Lists][List] containing all edges originating from the issuer. - * @param reverseEdges [Map] keyed by the [fingerprint][Fingerprint] of a target, whose values are [Lists][List] containing all edges pointing to the target + * @param nodes contains a [Map] of [Node] keyed by their [Fingerprint] + * @param edges [Edges][Edges] keyed by origin + * @param reverseEdges [Edges][Edge] keyed by target * @param referenceTime reference time at which the [Network] was built */ class Network( - val nodes: Map, - val edges: Map>, - val reverseEdges: Map>, + val nodes: Map, + val edges: Map>, + val reverseEdges: Map>, val referenceTime: ReferenceTime) { companion object { @@ -34,7 +34,7 @@ class Network( } /** - * The total number of edges on the network. + * The total number of [Edges][Edge] on the network. * * @return number of edges */ @@ -44,13 +44,13 @@ class Network( } /** - * The total number of signatures the network comprises. + * The total number of signatures ([EdgeComponents][EdgeComponent]) the network comprises. */ val numberOfSignatures: Int get() { return edges.values .flatten() - .flatMap { it.certifications.values } + .flatMap { it.components.values } .sumOf { it.size } } @@ -67,22 +67,22 @@ class Network( } class Builder internal constructor() { - val nodes: MutableMap = mutableMapOf() - private val protoEdges: MutableMap, CertificationSet> = mutableMapOf() + val nodes: MutableMap = mutableMapOf() + private val protoEdges: MutableMap, Edge> = mutableMapOf() private var referenceTime: ReferenceTime = ReferenceTime.now() - fun addNode(node: CertSynopsis): Builder { + fun addNode(node: Node): Builder { nodes[node.fingerprint] = node return this } - fun getNode(fingerprint: Fingerprint): CertSynopsis? { + fun getNode(fingerprint: Fingerprint): Node? { return nodes[fingerprint] } - fun addEdge(edge: Certification): Builder { + fun addEdge(edge: EdgeComponent): Builder { protoEdges.getOrPut(Pair(edge.issuer.fingerprint, edge.target.fingerprint)) { - CertificationSet.empty(edge.issuer, edge.target) + Edge.empty(edge.issuer, edge.target) }.add(edge) return this } @@ -93,8 +93,8 @@ class Network( } fun build(): Network { - val edges = mutableMapOf>() - val revEdges = mutableMapOf>() + val edges = mutableMapOf>() + val revEdges = mutableMapOf>() protoEdges.forEach { (pair, certificationSet) -> edges.getOrPut(pair.first) { diff --git a/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/CertSynopsis.kt b/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Node.kt similarity index 89% rename from wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/CertSynopsis.kt rename to wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Node.kt index ad3a1614..662ba134 100644 --- a/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/CertSynopsis.kt +++ b/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Node.kt @@ -7,14 +7,14 @@ package org.pgpainless.wot.dijkstra.sq import java.util.* /** - * A [CertSynopsis] is a proxy object containing information about a certificate. + * A [Node] is a proxy object containing information about a certificate. * * @param fingerprint [Fingerprint] of the certificate * @param expirationTime optional expiration time of the certificate * @param revocationState [RevocationState] denoting whether the certificate is revoked or not * @param userIds [Map] of user-ids on the certificate, along with their revocation states */ -data class CertSynopsis( +data class Node( val fingerprint: Fingerprint, val expirationTime: Date? = null, val revocationState: RevocationState = RevocationState.notRevoked(), diff --git a/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Path.kt b/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Path.kt index a87b188e..fd2429a5 100644 --- a/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Path.kt +++ b/wot-dijkstra/src/main/kotlin/org/pgpainless/wot/dijkstra/sq/Path.kt @@ -7,7 +7,7 @@ package org.pgpainless.wot.dijkstra.sq import kotlin.math.min /** - * A [Path] comprises a root [CertSynopsis], a list of edges ([Certifications][Certification]), as well as a + * A [Path] comprises a root [Node], a list of edges ([EdgeComponents][EdgeComponent]), as well as a * residual depth. * * @param root root of the path @@ -15,8 +15,8 @@ import kotlin.math.min * @param residualDepth residual depth that is decreased each time another edge is appended */ class Path( - val root: CertSynopsis, - private val edges: MutableList, + val root: Node, + private val edges: MutableList, var residualDepth: Depth ) { @@ -26,14 +26,14 @@ class Path( * * @param root trust root */ - constructor(root: CertSynopsis) : this( - root, mutableListOf(), Depth.unconstrained()) + constructor(root: Node) : this( + root, mutableListOf(), Depth.unconstrained()) /** * Current target of the path. * This corresponds to the target of the last entry in the edge list. */ - val target: CertSynopsis + val target: Node get() { return if (edges.isEmpty()) { root @@ -43,12 +43,12 @@ class Path( } /** - * List of [CertSynopses][CertSynopsis] (nodes) of the path. + * List of [Nodes][Node] (nodes) of the path. * The first entry is the [root]. The other entries are the targets of the edges. */ - val certificates: List + val certificates: List get() { - val certs: MutableList = mutableListOf(root) + val certs: MutableList = mutableListOf(root) for (certification in edges) { certs.add(certification.target) } @@ -65,7 +65,7 @@ class Path( /** * List of edges. */ - val certifications: List + val certifications: List get() = edges.toList() /** @@ -88,37 +88,37 @@ class Path( * * @throws IllegalArgumentException if the target at the end of the path is not equal to the issuer of the edge. * @throws IllegalArgumentException if the path runs out of residual depth - * @throws IllegalArgumentException if the addition of the [Certification] would result in a cyclic path + * @throws IllegalArgumentException if the addition of the [EdgeComponent] would result in a cyclic path */ - fun append(certification: Certification) { - require(target.fingerprint == certification.issuer.fingerprint) { - "Cannot append certification to path: Path's tail is not issuer of the certification." + fun append(nComponent: EdgeComponent) { + require(target.fingerprint == nComponent.issuer.fingerprint) { + "Cannot append edge to path: Path's tail is not issuer of the edge." } require(residualDepth.isUnconstrained() || residualDepth.limit!! > 0) { "Not enough depth." } // root is c's target -> illegal cycle - var cyclic = root.fingerprint == certification.target.fingerprint - for ((i, edge) in edges.withIndex()) { + var cyclic = root.fingerprint == nComponent.target.fingerprint + for ((i, component) in edges.withIndex()) { if (cyclic) { break } // existing edge points to c's target -> illegal cycle - if (edge.target.fingerprint == certification.target.fingerprint) { + if (nComponent.target.fingerprint == component.target.fingerprint) { cyclic = if (edges.lastIndex != i) { // Cycle in the middle of the ~~street~~ path true } else { // Not a cycle, if we point to a different user-id - edge.userId == certification.userId + nComponent.userId == component.userId } } } - require(!cyclic) { "Adding the certification to the path would create a cycle." } + require(!cyclic) { "Adding the edge to the path would create a cycle." } - residualDepth = certification.trustDepth.min(residualDepth.decrease(1)) - edges.add(certification) + residualDepth = nComponent.trustDepth.min(residualDepth.decrease(1)) + edges.add(nComponent) } override fun toString(): String { diff --git a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/CertificationSetTest.kt b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/CertificationSetTest.kt deleted file mode 100644 index 2a14ea67..00000000 --- a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/CertificationSetTest.kt +++ /dev/null @@ -1,133 +0,0 @@ -// SPDX-FileCopyrightText: 2023 Paul Schaub -// -// SPDX-License-Identifier: Apache-2.0 - -package org.pgpainless.wot.dijkstra - -import org.junit.jupiter.api.Test -import org.junit.jupiter.api.assertThrows -import org.pgpainless.wot.dijkstra.sq.* -import java.util.* -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -class CertificationSetTest { - - private val alice = CertSynopsis(Fingerprint("A"), null, RevocationState.notRevoked(), mapOf()) - private val bob = CertSynopsis(Fingerprint("B"), null, RevocationState.notRevoked(), mapOf()) - private val charlie = CertSynopsis(Fingerprint("C"), null, RevocationState.notRevoked(), mapOf()) - - private val aliceSignsBob = Certification(alice, bob, null, Date()) - private val aliceSignsBobUserId = Certification(alice, bob, "Bob ", Date()) - private val aliceSignsCharlie = Certification(alice, charlie, null, Date()) - private val charlieSignsBob = Certification(charlie, bob, null, Date()) - - @Test - fun `verify that properties of an empty CertificationSet are also empty`() { - val empty = CertificationSet.empty(alice, bob) - assert(empty.certifications.isEmpty()) - assertEquals(alice, empty.issuer) - assertEquals(bob, empty.target) - } - - @Test - fun `verify that add()ing Certification objects works if issuer and target match that of the CertificationSet`() { - val set = CertificationSet.empty(alice, bob) - - set.add(aliceSignsBob) - assertTrue { - set.certifications.values.any { - it.contains(aliceSignsBob) - } - } - set.add(aliceSignsBobUserId) - assertTrue { - set.certifications["Bob "]!!.contains(aliceSignsBobUserId) - } - } - - @Test - fun `verify that add()ing another Certification object fails if the issuer mismatches`() { - val set = CertificationSet.empty(alice, bob) - assertThrows { set.add(charlieSignsBob) } - } - - @Test - fun `verify that add()ing another Certification object fails if the target mismatches`() { - val set = CertificationSet.empty(alice, bob) - assertThrows { set.add(aliceSignsCharlie) } - } - - @Test - fun `verify that merge()ing another CertificationSet works if issuer and target match that of the CertificationSet`() { - val set = CertificationSet.fromCertification(aliceSignsBob) - val others = CertificationSet.fromCertification(aliceSignsBobUserId) - - set.merge(others) - assertEquals(2, set.certifications.size) - assertTrue { set.certifications[null]!!.contains(aliceSignsBob) } - assertTrue { set.certifications["Bob "]!!.contains(aliceSignsBobUserId) } - } - - @Test - fun `verify that merge()ing another CertificationSet with mismatched issuer fails`() { - val set = CertificationSet.fromCertification(aliceSignsBob) - val issuerMismatch = CertificationSet.fromCertification(charlieSignsBob) - - assertThrows { set.merge(issuerMismatch) } - } - - @Test - fun `verify that merge()ing another CertificationSet with mismatched target fails`() { - val set = CertificationSet.fromCertification(aliceSignsBob) - val targetMismatch = CertificationSet.fromCertification(aliceSignsCharlie) - - assertThrows { set.merge(targetMismatch) } - } - - @Test - fun `verify that merge()ing a CertificationSet with itself is idempotent`() { - val set = CertificationSet.fromCertification(aliceSignsBob) - assertEquals(1, set.certifications.size) - set.merge(set) - assertEquals(1, set.certifications.size) - } - - @Test - fun `verify that toString() of an empty CertificationSet is the empty string`() { - val empty = CertificationSet.empty(alice, bob) - assertEquals("", empty.toString()) - } - - @Test - fun `verify that toString() of a CertificationSet with two Certifications matches our expectations`() { - val twoCerts = CertificationSet.fromCertification(aliceSignsBob) - twoCerts.add(aliceSignsBobUserId) - - assertEquals("A certifies binding: null <-> B [120]\n" + - "A certifies binding: Bob <-> B [120]", twoCerts.toString()) - } - - @Test - fun `verify that for multiple Certifications over the same datum, only the most recent certifications are preserved`() { - val now = Date() - val fiveSecondsBefore = Date(now.time - 5000) - val old = Certification(alice, bob, "Bob ", fiveSecondsBefore) - val new = Certification(alice, bob, "Bob ", now) - val new2 = Certification(alice, bob, "Bob ", now, null, true, 44, Depth.auto(10), RegexSet.wildcard()) - - var set = CertificationSet(alice, bob, mapOf()) - set.add(old) - - assertEquals(listOf(old), set.certifications["Bob "]) - - set.add(new) - assertEquals(listOf(new), set.certifications["Bob "]) - - set.add(new2) - assertEquals(listOf(new, new2), set.certifications["Bob "]) - - set.add(old) - assertEquals(listOf(new, new2), set.certifications["Bob "]) - } -} \ No newline at end of file diff --git a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/CertificationTest.kt b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/EdgeComponentTest.kt similarity index 60% rename from wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/CertificationTest.kt rename to wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/EdgeComponentTest.kt index 56be10d9..06d2a519 100644 --- a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/CertificationTest.kt +++ b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/EdgeComponentTest.kt @@ -1,48 +1,48 @@ package org.pgpainless.wot.dijkstra import org.junit.jupiter.api.Test -import org.pgpainless.wot.dijkstra.sq.CertSynopsis -import org.pgpainless.wot.dijkstra.sq.Certification +import org.pgpainless.wot.dijkstra.sq.Node +import org.pgpainless.wot.dijkstra.sq.EdgeComponent import org.pgpainless.wot.dijkstra.sq.Fingerprint import org.pgpainless.wot.dijkstra.sq.RevocationState import java.util.* import kotlin.test.assertEquals -class CertificationTest { +class EdgeComponentTest { - private val alice = CertSynopsis( + private val alice = Node( Fingerprint("A"), null, RevocationState.notRevoked(), mapOf(Pair("Alice ", RevocationState.notRevoked()))) - private val bob = CertSynopsis( + private val bob = Node( Fingerprint("B"), null, RevocationState.notRevoked(), mapOf(Pair("Bob ", RevocationState.notRevoked()))) - private val charlie = CertSynopsis( + private val charlie = Node( Fingerprint("C"), null, RevocationState.notRevoked(), mapOf()) @Test - fun `verify result of toString() on certification`() { - val certification = Certification(alice, bob, "Bob ", Date()) + fun `verify result of toString() on certification signature`() { + val edgeComponent = EdgeComponent(alice, bob, "Bob ", Date()) assertEquals("A certifies binding: Bob <-> B [120]", - certification.toString()) + edgeComponent.toString()) } @Test - fun `verify result of toString() on delegation`() { - val delegation = Certification(alice, bob, null, Date()) + fun `verify result of toString() on delegation signature`() { + val delegation = EdgeComponent(alice, bob, null, Date()) assertEquals("A certifies binding: null <-> B [120]", delegation.toString()) } @Test - fun `verify result of toString() on delegation with userId-less issuer`() { - val delegation = Certification(charlie, bob, null, Date()) + fun `verify result of toString() on delegation signature with userId-less issuer`() { + val delegation = EdgeComponent(charlie, bob, null, Date()) assertEquals("C certifies binding: null <-> B [120]", delegation.toString()) } diff --git a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/EdgeTest.kt b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/EdgeTest.kt new file mode 100644 index 00000000..da4b1946 --- /dev/null +++ b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/EdgeTest.kt @@ -0,0 +1,133 @@ +// SPDX-FileCopyrightText: 2023 Paul Schaub +// +// SPDX-License-Identifier: Apache-2.0 + +package org.pgpainless.wot.dijkstra + +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.assertThrows +import org.pgpainless.wot.dijkstra.sq.* +import java.util.* +import kotlin.test.assertEquals +import kotlin.test.assertTrue + +class EdgeTest { + + private val alice = Node(Fingerprint("A"), null, RevocationState.notRevoked(), mapOf()) + private val bob = Node(Fingerprint("B"), null, RevocationState.notRevoked(), mapOf()) + private val charlie = Node(Fingerprint("C"), null, RevocationState.notRevoked(), mapOf()) + + private val aliceSignsBob = EdgeComponent(alice, bob, null, Date()) + private val aliceSignsBobUserId = EdgeComponent(alice, bob, "Bob ", Date()) + private val aliceSignsCharlie = EdgeComponent(alice, charlie, null, Date()) + private val charlieSignsBob = EdgeComponent(charlie, bob, null, Date()) + + @Test + fun `verify that properties of an empty edge are also empty`() { + val empty = Edge.empty(alice, bob) + assert(empty.components.isEmpty()) + assertEquals(alice, empty.issuer) + assertEquals(bob, empty.target) + } + + @Test + fun `verify that add()ing edge components works if issuer and target match that of the edge`() { + val set = Edge.empty(alice, bob) + + set.add(aliceSignsBob) + assertTrue { + set.components.values.any { + it.contains(aliceSignsBob) + } + } + set.add(aliceSignsBobUserId) + assertTrue { + set.components["Bob "]!!.contains(aliceSignsBobUserId) + } + } + + @Test + fun `verify that add()ing another component fails if the issuer mismatches`() { + val set = Edge.empty(alice, bob) + assertThrows { set.add(charlieSignsBob) } + } + + @Test + fun `verify that add()ing another component fails if the target mismatches`() { + val set = Edge.empty(alice, bob) + assertThrows { set.add(aliceSignsCharlie) } + } + + @Test + fun `verify that merge()ing another edge works if issuer and target match that of the edge`() { + val set = Edge.fromCertification(aliceSignsBob) + val others = Edge.fromCertification(aliceSignsBobUserId) + + set.merge(others) + assertEquals(2, set.components.size) + assertTrue { set.components[null]!!.contains(aliceSignsBob) } + assertTrue { set.components["Bob "]!!.contains(aliceSignsBobUserId) } + } + + @Test + fun `verify that merge()ing another edge with mismatched issuer fails`() { + val set = Edge.fromCertification(aliceSignsBob) + val issuerMismatch = Edge.fromCertification(charlieSignsBob) + + assertThrows { set.merge(issuerMismatch) } + } + + @Test + fun `verify that merge()ing another edge with mismatched target fails`() { + val set = Edge.fromCertification(aliceSignsBob) + val targetMismatch = Edge.fromCertification(aliceSignsCharlie) + + assertThrows { set.merge(targetMismatch) } + } + + @Test + fun `verify that merge()ing an edge with itself is idempotent`() { + val set = Edge.fromCertification(aliceSignsBob) + assertEquals(1, set.components.size) + set.merge(set) + assertEquals(1, set.components.size) + } + + @Test + fun `verify that toString() of an empty edge is the empty string`() { + val empty = Edge.empty(alice, bob) + assertEquals("", empty.toString()) + } + + @Test + fun `verify that toString() of a edge with two components matches our expectations`() { + val twoCerts = Edge.fromCertification(aliceSignsBob) + twoCerts.add(aliceSignsBobUserId) + + assertEquals("A certifies binding: null <-> B [120]\n" + + "A certifies binding: Bob <-> B [120]", twoCerts.toString()) + } + + @Test + fun `verify that for multiple components over the same datum, only the most recent components are preserved`() { + val now = Date() + val fiveSecondsBefore = Date(now.time - 5000) + val old = EdgeComponent(alice, bob, "Bob ", fiveSecondsBefore) + val new = EdgeComponent(alice, bob, "Bob ", now) + val new2 = EdgeComponent(alice, bob, "Bob ", now, null, true, 44, Depth.auto(10), RegexSet.wildcard()) + + var set = Edge(alice, bob, mapOf()) + set.add(old) + + assertEquals(listOf(old), set.components["Bob "]) + + set.add(new) + assertEquals(listOf(new), set.components["Bob "]) + + set.add(new2) + assertEquals(listOf(new, new2), set.components["Bob "]) + + set.add(old) + assertEquals(listOf(new, new2), set.components["Bob "]) + } +} \ No newline at end of file diff --git a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/NetworkDSL.kt b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/NetworkDSL.kt index 4b36bc35..fb52748a 100644 --- a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/NetworkDSL.kt +++ b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/NetworkDSL.kt @@ -13,52 +13,52 @@ import java.util.* interface NetworkDSL { /** - * Create [CertSynopsis] from [String] fingerprint. + * Create [Node] from [String] fingerprint. */ - fun CertSynopsis(fingerprint: String): CertSynopsis = - CertSynopsis(Fingerprint(fingerprint), null, RevocationState.notRevoked(), mapOf()) + fun Node(fingerprint: String): Node = + Node(Fingerprint(fingerprint), null, RevocationState.notRevoked(), mapOf()) /** - * Create [CertSynopsis] from [String] fingerprint and non-revoked [userId]. + * Create [Node] from [String] fingerprint and non-revoked [userId]. */ - fun CertSynopsis(fingerprint: String, userId: String): CertSynopsis = CertSynopsis( + fun Node(fingerprint: String, userId: String): Node = Node( Fingerprint(fingerprint), null, RevocationState.notRevoked(), mapOf(userId to RevocationState.notRevoked())) - fun CertSynopsis(original: CertSynopsis, userId: String): CertSynopsis = CertSynopsis( + fun Node(original: Node, userId: String): Node = Node( original.fingerprint, original.expirationTime, original.revocationState, original.userIds.plus(userId to RevocationState.notRevoked()) ) /** - * Create [Certification] from two [CertSynopsis] nodes. + * Create [EdgeComponent] from two [Node] nodes. */ - fun Certification(issuer: CertSynopsis, target: CertSynopsis): Certification = - Certification(issuer, target, null, Date()) + fun EdgeComponent(issuer: Node, target: Node): EdgeComponent = + EdgeComponent(issuer, target, null, Date()) /** - * Create [Certification] from two [CertSynopsis] nodes and a target [userId]. + * Create [EdgeComponent] from two [Node] nodes and a target [userId]. */ - fun Certification(issuer: CertSynopsis, target: CertSynopsis, userId: String): Certification = - Certification(issuer, target, userId, Date()) + fun EdgeComponent(issuer: Node, target: Node, userId: String): EdgeComponent = + EdgeComponent(issuer, target, userId, Date()) - fun Certification(issuer: CertSynopsis, target: CertSynopsis, amount: Int, depth: Depth): Certification = - Certification(issuer, target, null, Date(), null, true, amount, depth, RegexSet.wildcard()) + fun EdgeComponent(issuer: Node, target: Node, amount: Int, depth: Depth): EdgeComponent = + EdgeComponent(issuer, target, null, Date(), null, true, amount, depth, RegexSet.wildcard()) /** - * Add a single [CertSynopsis] built from a [String] fingerprint to the builder. + * Add a single [Node] built from a [String] fingerprint to the builder. */ fun Network.Builder.addNode(fingerprint: String): Network.Builder { - return addNode(CertSynopsis(fingerprint)) + return addNode(Node(fingerprint)) } /** - * Add a single [CertSynopsis] built from a [String] fingerprint and [userId] to the builder. + * Add a single [Node] built from a [String] fingerprint and [userId] to the builder. */ fun Network.Builder.addNode(fingerprint: String, userId: String): Network.Builder { - return addNode(CertSynopsis(fingerprint, userId)) + return addNode(Node(fingerprint, userId)) } /** - * Add multiple [CertSynopsis] nodes built from [String] fingerprints to the builder. + * Add multiple [Node] nodes built from [String] fingerprints to the builder. */ fun Network.Builder.addNodes(vararg fingerprints: String) { for (fingerprint in fingerprints) { @@ -67,25 +67,25 @@ interface NetworkDSL { } /** - * Add an edge between the [CertSynopsis] with fingerprint [issuer] and - * the [CertSynopsis] with fingerprint [target]. + * Add an edge between the [Node] with fingerprint [issuer] and + * the [Node] with fingerprint [target]. * If either the issuer or target node doesn't exist, throw an [IllegalArgumentException]. */ fun Network.Builder.addEdge(issuer: String, target: String): Network.Builder { val issuerNode = nodes[Fingerprint(issuer)]!! val targetNode = nodes[Fingerprint(target)]!! - return addEdge(Certification(issuerNode, targetNode)) + return addEdge(EdgeComponent(issuerNode, targetNode)) } /** - * Add an edge for [userId] between the [CertSynopsis] with fingerprint [issuer] and - * the [CertSynopsis] with fingerprint [target]. + * Add an edge for [userId] between the [Node] with fingerprint [issuer] and + * the [Node] with fingerprint [target]. * If either the issuer or target node doesn't exist, throw an [IllegalArgumentException]. */ fun Network.Builder.addEdge(issuer: String, target: String, userId: String): Network.Builder { val issuerNode = nodes[Fingerprint(issuer)]!! val targetNode = nodes[Fingerprint(target)]!! - return addEdge(Certification(issuerNode, targetNode, userId)) + return addEdge(EdgeComponent(issuerNode, targetNode, userId)) } /** @@ -93,9 +93,9 @@ interface NetworkDSL { * a new node for them to the builder. */ fun Network.Builder.buildEdge(issuer: String, target: String): Network.Builder { - val issuerNode = nodes.getOrPut(Fingerprint(issuer)) { CertSynopsis(issuer) } - val targetNode = nodes.getOrPut(Fingerprint(target)) { CertSynopsis(target) } - return addEdge(Certification(issuerNode, targetNode)) + val issuerNode = nodes.getOrPut(Fingerprint(issuer)) { Node(issuer) } + val targetNode = nodes.getOrPut(Fingerprint(target)) { Node(target) } + return addEdge(EdgeComponent(issuerNode, targetNode)) } /** @@ -105,21 +105,21 @@ interface NetworkDSL { * the [userId] inserted. */ fun Network.Builder.buildEdge(issuer: String, target: String, userId: String): Network.Builder { - val issuerNode = nodes.getOrPut(Fingerprint(issuer)) { CertSynopsis(issuer)} - val targetNode = CertSynopsis(nodes.getOrPut(Fingerprint(target)) { CertSynopsis(target, userId) }, userId) - return addEdge(Certification(issuerNode, targetNode, userId)) + val issuerNode = nodes.getOrPut(Fingerprint(issuer)) { Node(issuer)} + val targetNode = Node(nodes.getOrPut(Fingerprint(target)) { Node(target, userId) }, userId) + return addEdge(EdgeComponent(issuerNode, targetNode, userId)) } fun Network.Builder.buildEdge(issuer: String, target: String, amount: Int, depth: Int): Network.Builder { - val issuerNode = nodes.getOrPut(Fingerprint(issuer)) { CertSynopsis(issuer) } - val targetNode = nodes.getOrPut(Fingerprint(target)) { CertSynopsis(target) } - return addEdge(Certification(issuerNode, targetNode, null, Date(), null, true, amount, Depth.auto(depth), RegexSet.wildcard())) + val issuerNode = nodes.getOrPut(Fingerprint(issuer)) { Node(issuer) } + val targetNode = nodes.getOrPut(Fingerprint(target)) { Node(target) } + return addEdge(EdgeComponent(issuerNode, targetNode, null, Date(), null, true, amount, Depth.auto(depth), RegexSet.wildcard())) } fun Network.Builder.buildEdge(issuer: String, target: String, amount: Int, depth: Int, regexSet: RegexSet): Network.Builder { - val issuerNode = nodes.getOrPut(Fingerprint(issuer)) { CertSynopsis(issuer) } - val targetNode = nodes.getOrPut(Fingerprint(target)) { CertSynopsis(target) } - return addEdge(Certification(issuerNode, targetNode, null, Date(), null, true, amount, Depth.auto(depth), regexSet)) + val issuerNode = nodes.getOrPut(Fingerprint(issuer)) { Node(issuer) } + val targetNode = nodes.getOrPut(Fingerprint(target)) { Node(target) } + return addEdge(EdgeComponent(issuerNode, targetNode, null, Date(), null, true, amount, Depth.auto(depth), regexSet)) } /** @@ -129,27 +129,27 @@ interface NetworkDSL { return setReferenceTime(ReferenceTime.now()) } - fun Network.getEdgesFor(issuer: Fingerprint, target: Fingerprint): CertificationSet? { + fun Network.getEdgesFor(issuer: Fingerprint, target: Fingerprint): Edge? { return edges[issuer]?.find { it.target.fingerprint == target } } - fun Network.getEdgesFor(issuer: String, target: String): CertificationSet? { + fun Network.getEdgesFor(issuer: String, target: String): Edge? { return getEdgesFor(Fingerprint(issuer), Fingerprint(target)) } - fun Network.getEdgeFor(issuer: Fingerprint, target: Fingerprint): List? { + fun Network.getEdgeFor(issuer: Fingerprint, target: Fingerprint): List? { return getEdgeFor(issuer, target, null) } - fun Network.getEdgeFor(issuer: Fingerprint, target: Fingerprint, userId: String?): List? { - return getEdgesFor(issuer, target)?.certifications?.get(userId) + fun Network.getEdgeFor(issuer: Fingerprint, target: Fingerprint, userId: String?): List? { + return getEdgesFor(issuer, target)?.components?.get(userId) } - fun Network.getEdgeFor(issuer: String, target: String): List? { + fun Network.getEdgeFor(issuer: String, target: String): List? { return getEdgeFor(issuer, target, null) } - fun Network.getEdgeFor(issuer: String, target: String, userId: String?): List? { + fun Network.getEdgeFor(issuer: String, target: String, userId: String?): List? { return getEdgeFor(Fingerprint(issuer), Fingerprint(target), userId) } diff --git a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/CertSynopsisTest.kt b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/NodeTest.kt similarity index 75% rename from wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/CertSynopsisTest.kt rename to wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/NodeTest.kt index ebbc6b2b..dcda67fb 100644 --- a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/CertSynopsisTest.kt +++ b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/NodeTest.kt @@ -7,23 +7,23 @@ package org.pgpainless.wot.dijkstra import org.junit.jupiter.api.Test import kotlin.test.assertEquals -class CertSynopsisTest: NetworkDSL { +class NodeTest: NetworkDSL { @Test fun `Fingerprint 'A' toString`() { - val node = CertSynopsis("A") + val node = Node("A") assertEquals("A", node.toString()) } @Test fun `Fingerprint 'a' toString`() { - val node = CertSynopsis("a") + val node = Node("a") assertEquals("A", node.toString()) } @Test fun `Fingerprint 'A' and UserID toString`() { - val node = CertSynopsis("A", "Alice ") + val node = Node("A", "Alice ") assertEquals("A (Alice )", node.toString()) } } \ No newline at end of file diff --git a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/PathTest.kt b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/PathTest.kt index e32f5574..3b2188db 100644 --- a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/PathTest.kt +++ b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/PathTest.kt @@ -3,26 +3,25 @@ package org.pgpainless.wot.dijkstra import org.junit.jupiter.api.Test import org.junit.jupiter.api.assertThrows import org.pgpainless.wot.dijkstra.sq.* -import java.util.* import kotlin.test.assertEquals import kotlin.test.assertTrue class PathTest: NetworkDSL { - private val root = CertSynopsis("aabbccddeeAABBCCDDEEaabbccddeeAABBCCDDEE") - private val alice = CertSynopsis("0000000000000000000000000000000000000000") - private val bob = CertSynopsis("1111111111111111111111111111111111111111") + private val root = Node("aabbccddeeAABBCCDDEEaabbccddeeAABBCCDDEE") + private val alice = Node("0000000000000000000000000000000000000000") + private val bob = Node("1111111111111111111111111111111111111111") // Root -(255, 255)-> Alice - private val root_alice__fully_trusted = Certification(root, alice, 255, Depth.unconstrained()) + private val root_alice__fully_trusted = EdgeComponent(root, alice, 255, Depth.unconstrained()) // Root -(60,0)-> Alice - private val root_alice__marginally_trusted = Certification(root, alice, 60, Depth.limited(0)) + private val root_alice__marginally_trusted = EdgeComponent(root, alice, 60, Depth.limited(0)) // Alice -(255,255)-> Root - private val alice_root = Certification(alice, root, 255, Depth.unconstrained()) + private val alice_root = EdgeComponent(alice, root, 255, Depth.unconstrained()) // Alice -(120, 1)-> Bob - private val alice_bob = Certification(alice, bob) + private val alice_bob = EdgeComponent(alice, bob) // Root -> Root - private val root_root = Certification(root, root, 120, Depth.limited(1)) + private val root_root = EdgeComponent(root, root, 120, Depth.limited(1)) @Test fun `verify that an empty Path is properly initialized`() { @@ -35,7 +34,7 @@ class PathTest: NetworkDSL { } @Test - fun `verify that append()ing multiple Certifications properly changes the trust amount of the Path`() { + fun `verify that append()ing multiple components properly changes the trust amount of the Path`() { val path = Path(root) assertEquals(1, path.length) assertEquals(120, path.amount) // default amount of an empty path @@ -56,7 +55,7 @@ class PathTest: NetworkDSL { } @Test - fun `verify that append()ing a Certification whose issuer mismatches the target of the Path fails`() { + fun `verify that append()ing a component whose issuer mismatches the target of the Path fails`() { val path = Path(root) assertEquals(listOf(root), path.certificates) assertEquals(1, path.length) @@ -64,7 +63,7 @@ class PathTest: NetworkDSL { } @Test - fun `verify that append()ing a Certification fails if it exceeds the Path's depth`() { + fun `verify that append()ing a component fails if it exceeds the Path's depth`() { val path = Path(root) path.append(root_alice__marginally_trusted) assertEquals(60, path.amount) @@ -76,7 +75,7 @@ class PathTest: NetworkDSL { } @Test - fun `verify that append()ing a Certification fails of the result would contain cycles`() { + fun `verify that append()ing a component fails of the result would contain cycles`() { val path = Path(root) path.append(root_alice__fully_trusted) assertThrows { diff --git a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/PathsTest.kt b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/PathsTest.kt index 067aa066..0f2b3993 100644 --- a/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/PathsTest.kt +++ b/wot-dijkstra/src/test/kotlin/org/pgpainless/wot/dijkstra/PathsTest.kt @@ -3,16 +3,15 @@ package org.pgpainless.wot.dijkstra import org.junit.jupiter.api.Test import org.junit.jupiter.api.assertThrows import org.pgpainless.wot.dijkstra.sq.* -import java.util.* import kotlin.test.assertEquals class PathsTest: NetworkDSL { - private val alice = CertSynopsis("0000000000000000000000000000000000000000") - private val bob = CertSynopsis("1111111111111111111111111111111111111111") + private val alice = Node("0000000000000000000000000000000000000000") + private val bob = Node("1111111111111111111111111111111111111111") - private val alice_bob_1 = Certification(alice, bob, 140, Depth.unconstrained()) - private val alice_bob_2 = Certification(alice, bob, 160, Depth.limited(1)) + private val alice_bob_1 = EdgeComponent(alice, bob, 140, Depth.unconstrained()) + private val alice_bob_2 = EdgeComponent(alice, bob, 160, Depth.limited(1)) @Test fun `verify that an empty Paths object has an amount of zero`() {