aboutsummaryrefslogtreecommitdiffstats
path: root/format-common/src/main/kotlin/dev/msfjarvis/aps/data/passfile
diff options
context:
space:
mode:
authorHarsh Shandilya <me@msfjarvis.dev>2022-07-15 00:53:48 +0530
committerHarsh Shandilya <me@msfjarvis.dev>2022-07-15 01:13:47 +0530
commit549ee790d3e52bc62565ddf92e6a556e98b5195e (patch)
treed5758e5eb80093704e683c8da926838e18182588 /format-common/src/main/kotlin/dev/msfjarvis/aps/data/passfile
parent010c6e227c9cc27f4d01bc912311f977b2aeb3a7 (diff)
downloadHardenedPass-549ee790d3e52bc62565ddf92e6a556e98b5195e.tar.gz
HardenedPass-549ee790d3e52bc62565ddf92e6a556e98b5195e.zip
all: re-do package structure yet again
Diffstat (limited to 'format-common/src/main/kotlin/dev/msfjarvis/aps/data/passfile')
-rw-r--r--format-common/src/main/kotlin/dev/msfjarvis/aps/data/passfile/PasswordEntry.kt221
-rw-r--r--format-common/src/main/kotlin/dev/msfjarvis/aps/data/passfile/Totp.kt8
2 files changed, 0 insertions, 229 deletions
diff --git a/format-common/src/main/kotlin/dev/msfjarvis/aps/data/passfile/PasswordEntry.kt b/format-common/src/main/kotlin/dev/msfjarvis/aps/data/passfile/PasswordEntry.kt
deleted file mode 100644
index a0a85f3e..00000000
--- a/format-common/src/main/kotlin/dev/msfjarvis/aps/data/passfile/PasswordEntry.kt
+++ /dev/null
@@ -1,221 +0,0 @@
-/*
- * Copyright © 2014-2021 The Android Password Store Authors. All Rights Reserved.
- * SPDX-License-Identifier: GPL-3.0-only
- */
-
-package dev.msfjarvis.aps.data.passfile
-
-import com.github.michaelbull.result.mapBoth
-import dagger.assisted.Assisted
-import dagger.assisted.AssistedFactory
-import dagger.assisted.AssistedInject
-import dev.msfjarvis.aps.util.time.UserClock
-import dev.msfjarvis.aps.util.totp.Otp
-import dev.msfjarvis.aps.util.totp.TotpFinder
-import kotlin.collections.set
-import kotlin.coroutines.coroutineContext
-import kotlin.time.Duration.Companion.seconds
-import kotlin.time.ExperimentalTime
-import kotlinx.coroutines.awaitCancellation
-import kotlinx.coroutines.delay
-import kotlinx.coroutines.flow.Flow
-import kotlinx.coroutines.flow.flow
-import kotlinx.coroutines.isActive
-
-/** Represents a single entry in the password store. */
-@OptIn(ExperimentalTime::class)
-public class PasswordEntry
-@AssistedInject
-constructor(
- /** A time source used to calculate the TOTP */
- private val clock: UserClock,
- /** [TotpFinder] implementation to extract data from a TOTP URI */
- private val totpFinder: TotpFinder,
- /** The content of this entry, as an array of bytes. */
- @Assisted bytes: ByteArray,
-) {
-
- private val content = bytes.decodeToString()
-
- /** The password text for this entry. Can be null. */
- public val password: String?
-
- /** The username for this entry. Can be null. */
- public val username: String?
-
- /** A [String] to [String] [Map] of the extra content of this entry, in a key:value fashion. */
- public val extraContent: Map<String, String>
-
- /**
- * Direct [String] representation of the extra content of this entry, before any transforms are
- * applied. Only use this when the extra content is required in a formatting-preserving manner.
- */
- public val extraContentString: String
-
- /**
- * A [Flow] providing the current TOTP. It will start emitting only when collected. If this entry
- * does not have a TOTP secret, the flow will never emit. Users should call [hasTotp] before
- * collection to check if it is valid to collect this [Flow].
- */
- public val totp: Flow<Totp> = flow {
- if (totpSecret != null) {
- do {
- val otp = calculateTotp()
- emit(otp)
- delay(1000L)
- } while (coroutineContext.isActive)
- } else {
- awaitCancellation()
- }
- }
-
- /**
- * String representation of [extraContent] but with authentication related data such as TOTP URIs
- * and usernames stripped.
- */
- public val extraContentWithoutAuthData: String
- private val totpSecret: String?
-
- init {
- val (foundPassword, passContent) = findAndStripPassword(content.split("\n".toRegex()))
- password = foundPassword
- extraContentString = passContent.joinToString("\n")
- extraContentWithoutAuthData = generateExtraContentWithoutAuthData()
- extraContent = generateExtraContentPairs()
- username = findUsername()
- totpSecret = totpFinder.findSecret(content)
- }
-
- public fun hasTotp(): Boolean {
- return totpSecret != null
- }
-
- private fun findAndStripPassword(passContent: List<String>): Pair<String?, List<String>> {
- if (TotpFinder.TOTP_FIELDS.any { passContent[0].startsWith(it) }) return Pair(null, passContent)
- for (line in passContent) {
- for (prefix in PASSWORD_FIELDS) {
- if (line.startsWith(prefix, ignoreCase = true)) {
- return Pair(line.substring(prefix.length).trimStart(), passContent.minus(line))
- }
- }
- }
- return Pair(passContent[0], passContent.minus(passContent[0]))
- }
-
- private fun generateExtraContentWithoutAuthData(): String {
- var foundUsername = false
- return extraContentString
- .lineSequence()
- .filter { line ->
- return@filter when {
- USERNAME_FIELDS.any { prefix -> line.startsWith(prefix, ignoreCase = true) } &&
- !foundUsername -> {
- foundUsername = true
- false
- }
- TotpFinder.TOTP_FIELDS.any { prefix -> line.startsWith(prefix, ignoreCase = true) } -> {
- false
- }
- else -> {
- true
- }
- }
- }
- .joinToString(separator = "\n")
- }
-
- private fun generateExtraContentPairs(): Map<String, String> {
- fun MutableMap<String, String>.putOrAppend(key: String, value: String) {
- if (value.isEmpty()) return
- val existing = this[key]
- this[key] =
- if (existing == null) {
- value
- } else {
- "$existing\n$value"
- }
- }
-
- val items = mutableMapOf<String, String>()
- extraContentWithoutAuthData.lines().forEach { line ->
- // Split the line on ':' and save all the parts into an array
- // "ABC : DEF:GHI" --> ["ABC", "DEF", "GHI"]
- val splitArray = line.split(":")
- // Take the first element of the array. This will be the key for the key-value pair.
- // ["ABC ", " DEF", "GHI"] -> key = "ABC"
- val key = splitArray.first().trimEnd()
- // Remove the first element from the array and join the rest of the string again with
- // ':' as separator.
- // ["ABC ", " DEF", "GHI"] -> value = "DEF:GHI"
- val value = splitArray.drop(1).joinToString(":").trimStart()
-
- if (key.isNotEmpty() && value.isNotEmpty()) {
- // If both key and value are not empty, we can form a pair with this so add it to
- // the map.
- // key = "ABC", value = "DEF:GHI"
- items[key] = value
- } else {
- // If either key or value is empty, we were not able to form proper key-value pair.
- // So append the original line into an "EXTRA CONTENT" map entry
- items.putOrAppend(EXTRA_CONTENT, line)
- }
- }
-
- return items
- }
-
- private fun findUsername(): String? {
- extraContentString.splitToSequence("\n").forEach { line ->
- for (prefix in USERNAME_FIELDS) {
- if (line.startsWith(prefix, ignoreCase = true))
- return line.substring(prefix.length).trimStart()
- }
- }
- return null
- }
-
- private fun calculateTotp(): Totp {
- val digits = totpFinder.findDigits(content)
- val totpPeriod = totpFinder.findPeriod(content)
- val totpAlgorithm = totpFinder.findAlgorithm(content)
- val issuer = totpFinder.findIssuer(content)
- val millis = clock.millis()
- val remainingTime = (totpPeriod - ((millis / 1000) % totpPeriod)).seconds
- Otp.calculateCode(totpSecret!!, millis / (1000 * totpPeriod), totpAlgorithm, digits, issuer)
- .mapBoth(
- { code ->
- return Totp(code, remainingTime)
- },
- { throwable -> throw throwable }
- )
- }
-
- @AssistedFactory
- public interface Factory {
- public fun create(bytes: ByteArray): PasswordEntry
- }
-
- internal companion object {
-
- private const val EXTRA_CONTENT = "Extra Content"
- internal val USERNAME_FIELDS =
- arrayOf(
- "login:",
- "username:",
- "user:",
- "account:",
- "email:",
- "mail:",
- "name:",
- "handle:",
- "id:",
- "identity:",
- )
- internal val PASSWORD_FIELDS =
- arrayOf(
- "password:",
- "secret:",
- "pass:",
- )
- }
-}
diff --git a/format-common/src/main/kotlin/dev/msfjarvis/aps/data/passfile/Totp.kt b/format-common/src/main/kotlin/dev/msfjarvis/aps/data/passfile/Totp.kt
deleted file mode 100644
index a43cce6a..00000000
--- a/format-common/src/main/kotlin/dev/msfjarvis/aps/data/passfile/Totp.kt
+++ /dev/null
@@ -1,8 +0,0 @@
-package dev.msfjarvis.aps.data.passfile
-
-import kotlin.time.Duration
-import kotlin.time.ExperimentalTime
-
-/** Holder for a TOTP secret and the duration for which it is valid. */
-@OptIn(ExperimentalTime::class)
-public data class Totp(public val value: String, public val remainingTime: Duration)