From ce2e657108187a34416cfbfc0c5d2fc8bb9277f3 Mon Sep 17 00:00:00 2001 From: Harsh Shandilya Date: Thu, 10 Dec 2020 22:47:18 +0530 Subject: Better guidance for users to deal with host key changes (#1242) * Provide actionable guidance for host key mismatches Signed-off-by: Harsh Shandilya * Update changelog Signed-off-by: Harsh Shandilya * Hide host key clear button after use Signed-off-by: Harsh Shandilya --- CHANGELOG.md | 1 + .../dev/msfjarvis/aps/ui/git/base/BaseGitActivity.kt | 5 +++++ .../aps/ui/git/config/GitServerConfigActivity.kt | 6 ++++++ .../dev/msfjarvis/aps/util/settings/GitSettings.kt | 20 +++++++++++++++++++- app/src/main/res/layout/activity_git_clone.xml | 13 ++++++++++++- app/src/main/res/values/strings.xml | 2 ++ 6 files changed, 45 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3816a06a..6799816c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ All notable changes to this project will be documented in this file. - Decrypt screen would stay in memory infinitely, allowing passwords to be seen without re-auth - Git commits in the store would wrongly use the 'default' committer as opposed to the user's configured one - Connection attempts now use a reasonable 10 second timeout as opposed to the default of 30 seconds +- A change to the remote host key for a server would prevent the user from being able to connect to it ### Changed diff --git a/app/src/main/java/dev/msfjarvis/aps/ui/git/base/BaseGitActivity.kt b/app/src/main/java/dev/msfjarvis/aps/ui/git/base/BaseGitActivity.kt index 89455c90..558f60a2 100644 --- a/app/src/main/java/dev/msfjarvis/aps/ui/git/base/BaseGitActivity.kt +++ b/app/src/main/java/dev/msfjarvis/aps/ui/git/base/BaseGitActivity.kt @@ -29,6 +29,7 @@ import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.withContext import net.schmizz.sshj.common.DisconnectReason import net.schmizz.sshj.common.SSHException +import net.schmizz.sshj.transport.TransportException import net.schmizz.sshj.userauth.UserAuthException /** @@ -76,6 +77,10 @@ abstract class BaseGitActivity : ContinuationContainerActivity() { if (err.message?.contains("cannot open additional channels") == true) { GitSettings.useMultiplexing = false SSHException(DisconnectReason.TOO_MANY_CONNECTIONS, "The server does not support multiple Git operations per SSH session. Please try again, a slower fallback mode will be used.") + } else if (err is TransportException && err.disconnectReason == DisconnectReason.HOST_KEY_NOT_VERIFIABLE) { + SSHException(DisconnectReason.HOST_KEY_NOT_VERIFIABLE, + "WARNING: The remote host key has changed. If this is expected, please go to Git server settings and clear the saved host key." + ) } else { err } diff --git a/app/src/main/java/dev/msfjarvis/aps/ui/git/config/GitServerConfigActivity.kt b/app/src/main/java/dev/msfjarvis/aps/ui/git/config/GitServerConfigActivity.kt index a0750eeb..9826593c 100644 --- a/app/src/main/java/dev/msfjarvis/aps/ui/git/config/GitServerConfigActivity.kt +++ b/app/src/main/java/dev/msfjarvis/aps/ui/git/config/GitServerConfigActivity.kt @@ -84,6 +84,12 @@ class GitServerConfigActivity : BaseGitActivity() { setAuthModes(text.startsWith("http://") || text.startsWith("https://")) } + binding.clearHostKeyButton.isVisible = GitSettings.hasSavedHostKey() + binding.clearHostKeyButton.setOnClickListener { + GitSettings.clearSavedHostKey() + Snackbar.make(binding.root, getString(R.string.clear_saved_host_key_success), Snackbar.LENGTH_LONG).show() + it.isVisible = false + } binding.saveButton.setOnClickListener { val newUrl = binding.serverUrl.text.toString().trim() // If url is of type john_doe@example.org:12435/path/to/repo, then not adding `ssh://` diff --git a/app/src/main/java/dev/msfjarvis/aps/util/settings/GitSettings.kt b/app/src/main/java/dev/msfjarvis/aps/util/settings/GitSettings.kt index 864cbf81..82af814b 100644 --- a/app/src/main/java/dev/msfjarvis/aps/util/settings/GitSettings.kt +++ b/app/src/main/java/dev/msfjarvis/aps/util/settings/GitSettings.kt @@ -55,6 +55,7 @@ object GitSettings { private val settings by lazy(LazyThreadSafetyMode.PUBLICATION) { Application.instance.sharedPrefs } private val encryptedSettings by lazy(LazyThreadSafetyMode.PUBLICATION) { Application.instance.getEncryptedGitPrefs() } private val proxySettings by lazy(LazyThreadSafetyMode.PUBLICATION) { Application.instance.getEncryptedProxyPrefs() } + private val hostKeyPath by lazy(LazyThreadSafetyMode.NONE) { "${Application.instance.filesDir}/.host_key" } var authMode get() = AuthMode.fromString(settings.getString(PreferenceKeys.GIT_REMOTE_AUTH)) @@ -63,6 +64,7 @@ object GitSettings { putString(PreferenceKeys.GIT_REMOTE_AUTH, value.pref) } } + var url get() = settings.getString(PreferenceKeys.GIT_REMOTE_URL) private set(value) { @@ -78,8 +80,9 @@ object GitSettings { // should be deleted/reset. useMultiplexing = true encryptedSettings.edit { remove(PreferenceKeys.HTTPS_PASSWORD) } - File("${Application.instance.filesDir}/.host_key").delete() + clearSavedHostKey() } + var authorName get() = settings.getString(PreferenceKeys.GIT_CONFIG_AUTHOR_NAME) ?: "" set(value) { @@ -87,6 +90,7 @@ object GitSettings { putString(PreferenceKeys.GIT_CONFIG_AUTHOR_NAME, value) } } + var authorEmail get() = settings.getString(PreferenceKeys.GIT_CONFIG_AUTHOR_EMAIL) ?: "" set(value) { @@ -94,6 +98,7 @@ object GitSettings { putString(PreferenceKeys.GIT_CONFIG_AUTHOR_EMAIL, value) } } + var branch get() = settings.getString(PreferenceKeys.GIT_BRANCH_NAME) ?: DEFAULT_BRANCH private set(value) { @@ -101,6 +106,7 @@ object GitSettings { putString(PreferenceKeys.GIT_BRANCH_NAME, value) } } + var useMultiplexing get() = settings.getBoolean(PreferenceKeys.GIT_REMOTE_USE_MULTIPLEXING, true) set(value) { @@ -178,4 +184,16 @@ object GitSettings { branch = newBranch return UpdateConnectionSettingsResult.Valid } + + /** + * Deletes a previously saved SSH host key + */ + fun clearSavedHostKey() { + File(hostKeyPath).delete() + } + + /** + * Returns true if a host key was previously saved + */ + fun hasSavedHostKey(): Boolean = File(hostKeyPath).exists() } diff --git a/app/src/main/res/layout/activity_git_clone.xml b/app/src/main/res/layout/activity_git_clone.xml index 1e59b462..04b8338c 100644 --- a/app/src/main/res/layout/activity_git_clone.xml +++ b/app/src/main/res/layout/activity_git_clone.xml @@ -11,7 +11,7 @@ android:background="?android:attr/windowBackground" android:padding="@dimen/activity_horizontal_margin" tools:background="@color/white" - tools:context="dev.msfjarvis.aps.git.GitServerConfigActivity"> + tools:context="dev.msfjarvis.aps.ui.git.config.GitServerConfigActivity"> + + diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml index 03a1689e..a57d0454 100644 --- a/app/src/main/res/values/strings.xml +++ b/app/src/main/res/values/strings.xml @@ -398,5 +398,7 @@ HTTP(S) proxy settings Invalid URL Fill and save passwords (saving requires that no accessibility services are enabled) + Clear saved host key + Successfully cleared saved host key! -- cgit v1.2.3