aboutsummaryrefslogtreecommitdiffstats
path: root/app/src/main/java/dev/msfjarvis/aps/util/autofill/AutofillPreferences.kt
blob: aa70bacb74ef408df60e679ce00c985e6f59b56f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/*
 * Copyright © 2014-2020 The Android Password Store Authors. All Rights Reserved.
 * SPDX-License-Identifier: GPL-3.0-only
 */
package dev.msfjarvis.aps.util.autofill

import android.content.Context
import android.os.Build
import androidx.annotation.RequiresApi
import com.github.androidpasswordstore.autofillparser.Credentials
import dev.msfjarvis.aps.data.password.PasswordEntry
import dev.msfjarvis.aps.util.extensions.sharedPrefs
import dev.msfjarvis.aps.util.services.getDefaultUsername
import java.io.File
import java.nio.file.Paths

enum class DirectoryStructure(val value: String) {
    EncryptedUsername("encrypted_username"),
    FileBased("file"),
    DirectoryBased("directory");

    /**
     * Returns the username associated to [file], following the convention of the current
     * [DirectoryStructure].
     *
     * Examples:
     *   - * --> null (EncryptedUsername)
     *   - work/example.org/john@doe.org.gpg --> john@doe.org (FileBased)
     *   - work/example.org/john@doe.org/password.gpg --> john@doe.org (DirectoryBased)
     *   - Temporary PIN.gpg --> Temporary PIN (DirectoryBased, fallback)
     */
    fun getUsernameFor(file: File): String? = when (this) {
        EncryptedUsername -> null
        FileBased -> file.nameWithoutExtension
        DirectoryBased -> file.parentFile?.name ?: file.nameWithoutExtension
    }

    /**
     * Returns the origin identifier associated to [file], following the convention of the current
     * [DirectoryStructure].
     *
     * At least one of [DirectoryStructure.getIdentifierFor] and
     * [DirectoryStructure.getAccountPartFor] will always return a non-null result.
     *
     * Examples:
     *   - work/example.org.gpg --> example.org (EncryptedUsername)
     *   - work/example.org/john@doe.org.gpg --> example.org (FileBased)
     *   - example.org.gpg --> example.org (FileBased, fallback)
     *   - work/example.org/john@doe.org/password.gpg --> example.org (DirectoryBased)
     *   - Temporary PIN.gpg --> null (DirectoryBased)
     */
    fun getIdentifierFor(file: File): String? = when (this) {
        EncryptedUsername -> file.nameWithoutExtension
        FileBased -> file.parentFile?.name ?: file.nameWithoutExtension
        DirectoryBased -> file.parentFile?.parent
    }

    /**
     * Returns the path components of [file] until right before the component that contains the
     * origin identifier according to the current [DirectoryStructure].
     *
     * Examples:
     *   - work/example.org.gpg --> work (EncryptedUsername)
     *   - work/example.org/john@doe.org.gpg --> work (FileBased)
     *   - example.org/john@doe.org.gpg --> null (FileBased)
     *   - john@doe.org.gpg --> null (FileBased)
     *   - work/example.org/john@doe.org/password.gpg --> work (DirectoryBased)
     *   - example.org/john@doe.org/password.gpg --> null (DirectoryBased)
     */
    fun getPathToIdentifierFor(file: File): String? = when (this) {
        EncryptedUsername -> file.parent
        FileBased -> file.parentFile?.parent
        DirectoryBased -> file.parentFile?.parentFile?.parent
    }

    /**
     * Returns the path component of [file] following the origin identifier according to the current
     * [DirectoryStructure] (without file extension).
     *
     * At least one of [DirectoryStructure.getIdentifierFor] and
     * [DirectoryStructure.getAccountPartFor] will always return a non-null result.
     *
     * Examples:
     *   - * --> null (EncryptedUsername)
     *   - work/example.org/john@doe.org.gpg --> john@doe.org (FileBased)
     *   - example.org.gpg --> null (FileBased, fallback)
     *   - work/example.org/john@doe.org/password.gpg --> john@doe.org/password (DirectoryBased)
     *   - Temporary PIN.gpg --> Temporary PIN (DirectoryBased, fallback)
     */
    fun getAccountPartFor(file: File): String? = when (this) {
        EncryptedUsername -> null
        FileBased -> file.nameWithoutExtension.takeIf { file.parentFile != null }
        DirectoryBased -> file.parentFile?.let { parentFile ->
            "${parentFile.name}/${file.nameWithoutExtension}"
        } ?: file.nameWithoutExtension
    }

    @RequiresApi(Build.VERSION_CODES.O)
    fun getSaveFolderName(sanitizedIdentifier: String, username: String?) = when (this) {
        EncryptedUsername -> "/"
        FileBased -> sanitizedIdentifier
        DirectoryBased -> Paths.get(sanitizedIdentifier, username ?: "username").toString()
    }

    fun getSaveFileName(username: String?, identifier: String) = when (this) {
        EncryptedUsername -> identifier
        FileBased -> username
        DirectoryBased -> "password"
    }

    companion object {

        const val PREFERENCE = "oreo_autofill_directory_structure"
        private val DEFAULT = FileBased

        private val reverseMap = values().associateBy { it.value }
        fun fromValue(value: String?) = if (value != null) reverseMap[value] ?: DEFAULT else DEFAULT
    }
}

object AutofillPreferences {

    fun directoryStructure(context: Context): DirectoryStructure {
        val value = context.sharedPrefs.getString(DirectoryStructure.PREFERENCE, null)
        return DirectoryStructure.fromValue(value)
    }

    fun credentialsFromStoreEntry(
        context: Context,
        file: File,
        entry: PasswordEntry,
        directoryStructure: DirectoryStructure
    ): Credentials {
        // Always give priority to a username stored in the encrypted extras
        val username = entry.username
            ?: directoryStructure.getUsernameFor(file)
            ?: context.getDefaultUsername()
        return Credentials(username, entry.password, entry.calculateTotpCode())
    }
}