Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SSH Agent: Reset settings when KeeAgent.settings is removed #4595

Merged
merged 1 commit into from
May 23, 2020
+60 −24
Merged

SSH Agent: Reset settings when KeeAgent.settings is removed #4595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/gui/DatabaseWidget.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1758,7 +1758,7 @@ bool DatabaseWidget::currentEntryHasSshKey()
return false;
}

return KeeAgentSettings::inEntry(currentEntry);
return KeeAgentSettings::inEntryAttachments(currentEntry->attachments());
}
#endif

Expand Down
29 changes: 19 additions & 10 deletions src/gui/entry/EditEntryWidget.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,22 +532,24 @@ void EditEntryWidget::setupSSHAgent()
addPage(tr("SSH Agent"), Resources::instance()->icon("utilities-terminal"), m_sshAgentWidget);
}

void EditEntryWidget::updateSSHAgent()
void EditEntryWidget::setSSHAgentSettings()
{
KeeAgentSettings settings;
settings.fromEntry(m_entry);

m_sshAgentUi->addKeyToAgentCheckBox->setChecked(settings.addAtDatabaseOpen());
m_sshAgentUi->removeKeyFromAgentCheckBox->setChecked(settings.removeAtDatabaseClose());
m_sshAgentUi->requireUserConfirmationCheckBox->setChecked(settings.useConfirmConstraintWhenAdding());
m_sshAgentUi->lifetimeCheckBox->setChecked(settings.useLifetimeConstraintWhenAdding());
m_sshAgentUi->lifetimeSpinBox->setValue(settings.lifetimeConstraintDuration());
m_sshAgentUi->addKeyToAgentCheckBox->setChecked(m_sshAgentSettings.addAtDatabaseOpen());
m_sshAgentUi->removeKeyFromAgentCheckBox->setChecked(m_sshAgentSettings.removeAtDatabaseClose());
m_sshAgentUi->requireUserConfirmationCheckBox->setChecked(m_sshAgentSettings.useConfirmConstraintWhenAdding());
m_sshAgentUi->lifetimeCheckBox->setChecked(m_sshAgentSettings.useLifetimeConstraintWhenAdding());
m_sshAgentUi->lifetimeSpinBox->setValue(m_sshAgentSettings.lifetimeConstraintDuration());
m_sshAgentUi->attachmentComboBox->clear();
m_sshAgentUi->addToAgentButton->setEnabled(false);
m_sshAgentUi->removeFromAgentButton->setEnabled(false);
m_sshAgentUi->copyToClipboardButton->setEnabled(false);
}

m_sshAgentSettings = settings;
void EditEntryWidget::updateSSHAgent()
{
m_sshAgentSettings.reset();
m_sshAgentSettings.fromEntry(m_entry);
setSSHAgentSettings();

updateSSHAgentAttachments();
}
Expand All @@ -560,6 +562,13 @@ void EditEntryWidget::updateSSHAgentAttachment()

void EditEntryWidget::updateSSHAgentAttachments()
{
// detect if KeeAgent.settings was removed by hand and reset settings
if (m_entry && KeeAgentSettings::inEntryAttachments(m_entry->attachments())
&& !KeeAgentSettings::inEntryAttachments(m_advancedUi->attachmentsWidget->entryAttachments())) {
m_sshAgentSettings.reset();
setSSHAgentSettings();
}

m_sshAgentUi->attachmentComboBox->clear();
m_sshAgentUi->attachmentComboBox->addItem("");

Expand Down
1 change: 1 addition & 0 deletions src/gui/entry/EditEntryWidget.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ private slots:
void pickColor();
#ifdef WITH_XC_SSHAGENT
void toKeeAgentSettings(KeeAgentSettings& settings) const;
void setSSHAgentSettings();
void updateSSHAgent();
void updateSSHAgentAttachment();
void updateSSHAgentAttachments();
Expand Down
32 changes: 28 additions & 4 deletions src/sshagent/KeeAgentSettings.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@
#include "KeeAgentSettings.h"
#include "core/Tools.h"

KeeAgentSettings::KeeAgentSettings()
{
reset();
}

bool KeeAgentSettings::operator==(const KeeAgentSettings& other) const
{
// clang-format off
Expand Down Expand Up @@ -50,6 +55,25 @@ bool KeeAgentSettings::isDefault() const
return (*this == defaultSettings);
}

/**
* Reset this instance to default settings
*/
void KeeAgentSettings::reset()
{
m_allowUseOfSshKey = false;
m_addAtDatabaseOpen = false;
m_removeAtDatabaseClose = false;
m_useConfirmConstraintWhenAdding = false;
m_useLifetimeConstraintWhenAdding = false;
m_lifetimeConstraintDuration = 600;

m_selectedType = QStringLiteral("file");
m_attachmentName.clear();
m_saveAttachmentToTempFile = false;
m_fileName.clear();
m_error.clear();
}

/**
* Get last error as a QString.
*
Expand Down Expand Up @@ -300,14 +324,14 @@ QByteArray KeeAgentSettings::toXml() const
}

/**
* Check if an entry has KeeAgent settings configured
* Check if entry attachments have KeeAgent settings configured
*
* @param entry Entry to check the attachment
* @param attachments EntryAttachments to check the key
* @return true if XML document exists
*/
bool KeeAgentSettings::inEntry(const Entry* entry)
bool KeeAgentSettings::inEntryAttachments(const EntryAttachments* attachments)
{
return entry->attachments()->hasKey("KeeAgent.settings");
return attachments->hasKey("KeeAgent.settings");
}

/**
Expand Down
20 changes: 11 additions & 9 deletions src/sshagent/KeeAgentSettings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,16 @@
class KeeAgentSettings
{
public:
KeeAgentSettings();
bool operator==(const KeeAgentSettings& other) const;
bool operator!=(const KeeAgentSettings& other) const;
bool isDefault() const;
void reset();

bool fromXml(const QByteArray& ba);
QByteArray toXml() const;

static bool inEntry(const Entry* entry);
static bool inEntryAttachments(const EntryAttachments* attachments);
bool fromEntry(const Entry* entry);
void toEntry(Entry* entry) const;
bool keyConfigured() const;
Expand Down Expand Up @@ -77,17 +79,17 @@ class KeeAgentSettings
bool readBool(QXmlStreamReader& reader);
int readInt(QXmlStreamReader& reader);

bool m_allowUseOfSshKey = false;
bool m_addAtDatabaseOpen = false;
bool m_removeAtDatabaseClose = false;
bool m_useConfirmConstraintWhenAdding = false;
bool m_useLifetimeConstraintWhenAdding = false;
int m_lifetimeConstraintDuration = 600;
bool m_allowUseOfSshKey;
bool m_addAtDatabaseOpen;
bool m_removeAtDatabaseClose;
bool m_useConfirmConstraintWhenAdding;
bool m_useLifetimeConstraintWhenAdding;
int m_lifetimeConstraintDuration;

// location
QString m_selectedType = QString("file");
QString m_selectedType;
QString m_attachmentName;
bool m_saveAttachmentToTempFile = false;
bool m_saveAttachmentToTempFile;
QString m_fileName;
QString m_error;
};
Expand Down