Bitcoin Core  24.99.0
P2P Digital Currency
askpassphrasedialog.cpp
Go to the documentation of this file.
1 // Copyright (c) 2011-2021 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #if defined(HAVE_CONFIG_H)
7 #endif
8 
10 #include <qt/forms/ui_askpassphrasedialog.h>
11 
12 #include <qt/guiconstants.h>
13 #include <qt/guiutil.h>
14 #include <qt/walletmodel.h>
15 
17 
18 #include <QKeyEvent>
19 #include <QMessageBox>
20 #include <QPushButton>
21 
22 AskPassphraseDialog::AskPassphraseDialog(Mode _mode, QWidget *parent, SecureString* passphrase_out) :
23  QDialog(parent, GUIUtil::dialog_flags),
24  ui(new Ui::AskPassphraseDialog),
25  mode(_mode),
26  m_passphrase_out(passphrase_out)
27 {
28  ui->setupUi(this);
29 
30  ui->passEdit1->setMinimumSize(ui->passEdit1->sizeHint());
31  ui->passEdit2->setMinimumSize(ui->passEdit2->sizeHint());
32  ui->passEdit3->setMinimumSize(ui->passEdit3->sizeHint());
33 
34  ui->passEdit1->setMaxLength(MAX_PASSPHRASE_SIZE);
35  ui->passEdit2->setMaxLength(MAX_PASSPHRASE_SIZE);
36  ui->passEdit3->setMaxLength(MAX_PASSPHRASE_SIZE);
37 
38  // Setup Caps Lock detection.
39  ui->passEdit1->installEventFilter(this);
40  ui->passEdit2->installEventFilter(this);
41  ui->passEdit3->installEventFilter(this);
42 
43  switch(mode)
44  {
45  case Encrypt: // Ask passphrase x2
46  ui->warningLabel->setText(tr("Enter the new passphrase for the wallet.<br/>Please use a passphrase of <b>ten or more random characters</b>, or <b>eight or more words</b>."));
47  ui->passLabel1->hide();
48  ui->passEdit1->hide();
49  setWindowTitle(tr("Encrypt wallet"));
50  break;
51  case Unlock: // Ask passphrase
52  ui->warningLabel->setText(tr("This operation needs your wallet passphrase to unlock the wallet."));
53  ui->passLabel2->hide();
54  ui->passEdit2->hide();
55  ui->passLabel3->hide();
56  ui->passEdit3->hide();
57  setWindowTitle(tr("Unlock wallet"));
58  break;
59  case ChangePass: // Ask old passphrase + new passphrase x2
60  setWindowTitle(tr("Change passphrase"));
61  ui->warningLabel->setText(tr("Enter the old passphrase and new passphrase for the wallet."));
62  break;
63  }
64  textChanged();
65  connect(ui->toggleShowPasswordButton, &QPushButton::toggled, this, &AskPassphraseDialog::toggleShowPassword);
66  connect(ui->passEdit1, &QLineEdit::textChanged, this, &AskPassphraseDialog::textChanged);
67  connect(ui->passEdit2, &QLineEdit::textChanged, this, &AskPassphraseDialog::textChanged);
68  connect(ui->passEdit3, &QLineEdit::textChanged, this, &AskPassphraseDialog::textChanged);
69 
71 }
72 
74 {
76  delete ui;
77 }
78 
80 {
81  this->model = _model;
82 }
83 
85 {
86  SecureString oldpass, newpass1, newpass2;
87  if (!model && mode != Encrypt)
88  return;
89  oldpass.reserve(MAX_PASSPHRASE_SIZE);
90  newpass1.reserve(MAX_PASSPHRASE_SIZE);
91  newpass2.reserve(MAX_PASSPHRASE_SIZE);
92  // TODO: get rid of this .c_str() by implementing SecureString::operator=(std::string)
93  // Alternately, find a way to make this input mlock()'d to begin with.
94  oldpass.assign(ui->passEdit1->text().toStdString().c_str());
95  newpass1.assign(ui->passEdit2->text().toStdString().c_str());
96  newpass2.assign(ui->passEdit3->text().toStdString().c_str());
97 
99 
100  switch(mode)
101  {
102  case Encrypt: {
103  if(newpass1.empty() || newpass2.empty())
104  {
105  // Cannot encrypt with empty passphrase
106  break;
107  }
108  QMessageBox::StandardButton retval = QMessageBox::question(this, tr("Confirm wallet encryption"),
109  tr("Warning: If you encrypt your wallet and lose your passphrase, you will <b>LOSE ALL OF YOUR BITCOINS</b>!") + "<br><br>" + tr("Are you sure you wish to encrypt your wallet?"),
110  QMessageBox::Yes|QMessageBox::Cancel,
111  QMessageBox::Cancel);
112  if(retval == QMessageBox::Yes)
113  {
114  if(newpass1 == newpass2)
115  {
116  QString encryption_reminder = tr("Remember that encrypting your wallet cannot fully protect "
117  "your bitcoins from being stolen by malware infecting your computer.");
118  if (m_passphrase_out) {
119  m_passphrase_out->assign(newpass1);
120  QMessageBox::warning(this, tr("Wallet to be encrypted"),
121  "<qt>" +
122  tr("Your wallet is about to be encrypted. ") + encryption_reminder +
123  "</b></qt>");
124  } else {
125  assert(model != nullptr);
126  if (model->setWalletEncrypted(newpass1)) {
127  QMessageBox::warning(this, tr("Wallet encrypted"),
128  "<qt>" +
129  tr("Your wallet is now encrypted. ") + encryption_reminder +
130  "<br><br><b>" +
131  tr("IMPORTANT: Any previous backups you have made of your wallet file "
132  "should be replaced with the newly generated, encrypted wallet file. "
133  "For security reasons, previous backups of the unencrypted wallet file "
134  "will become useless as soon as you start using the new, encrypted wallet.") +
135  "</b></qt>");
136  } else {
137  QMessageBox::critical(this, tr("Wallet encryption failed"),
138  tr("Wallet encryption failed due to an internal error. Your wallet was not encrypted."));
139  }
140  }
141  QDialog::accept(); // Success
142  }
143  else
144  {
145  QMessageBox::critical(this, tr("Wallet encryption failed"),
146  tr("The supplied passphrases do not match."));
147  }
148  }
149  else
150  {
151  QDialog::reject(); // Cancelled
152  }
153  } break;
154  case Unlock:
155  try {
156  if (!model->setWalletLocked(false, oldpass)) {
157  QMessageBox::critical(this, tr("Wallet unlock failed"),
158  tr("The passphrase entered for the wallet decryption was incorrect."));
159  } else {
160  QDialog::accept(); // Success
161  }
162  } catch (const std::runtime_error& e) {
163  QMessageBox::critical(this, tr("Wallet unlock failed"), e.what());
164  }
165  break;
166  case ChangePass:
167  if(newpass1 == newpass2)
168  {
169  if(model->changePassphrase(oldpass, newpass1))
170  {
171  QMessageBox::information(this, tr("Wallet encrypted"),
172  tr("Wallet passphrase was successfully changed."));
173  QDialog::accept(); // Success
174  }
175  else
176  {
177  QMessageBox::critical(this, tr("Wallet encryption failed"),
178  tr("The passphrase entered for the wallet decryption was incorrect."));
179  }
180  }
181  else
182  {
183  QMessageBox::critical(this, tr("Wallet encryption failed"),
184  tr("The supplied passphrases do not match."));
185  }
186  break;
187  }
188 }
189 
191 {
192  // Validate input, set Ok button to enabled when acceptable
193  bool acceptable = false;
194  switch(mode)
195  {
196  case Encrypt: // New passphrase x2
197  acceptable = !ui->passEdit2->text().isEmpty() && !ui->passEdit3->text().isEmpty();
198  break;
199  case Unlock: // Old passphrase x1
200  acceptable = !ui->passEdit1->text().isEmpty();
201  break;
202  case ChangePass: // Old passphrase x1, new passphrase x2
203  acceptable = !ui->passEdit1->text().isEmpty() && !ui->passEdit2->text().isEmpty() && !ui->passEdit3->text().isEmpty();
204  break;
205  }
206  ui->buttonBox->button(QDialogButtonBox::Ok)->setEnabled(acceptable);
207 }
208 
209 bool AskPassphraseDialog::event(QEvent *event)
210 {
211  // Detect Caps Lock key press.
212  if (event->type() == QEvent::KeyPress) {
213  QKeyEvent *ke = static_cast<QKeyEvent *>(event);
214  if (ke->key() == Qt::Key_CapsLock) {
215  fCapsLock = !fCapsLock;
216  }
217  if (fCapsLock) {
218  ui->capsLabel->setText(tr("Warning: The Caps Lock key is on!"));
219  } else {
220  ui->capsLabel->clear();
221  }
222  }
223  return QWidget::event(event);
224 }
225 
227 {
228  ui->toggleShowPasswordButton->setDown(show);
229  const auto mode = show ? QLineEdit::Normal : QLineEdit::Password;
230  ui->passEdit1->setEchoMode(mode);
231  ui->passEdit2->setEchoMode(mode);
232  ui->passEdit3->setEchoMode(mode);
233 }
234 
235 bool AskPassphraseDialog::eventFilter(QObject *object, QEvent *event)
236 {
237  /* Detect Caps Lock.
238  * There is no good OS-independent way to check a key state in Qt, but we
239  * can detect Caps Lock by checking for the following condition:
240  * Shift key is down and the result is a lower case character, or
241  * Shift key is not down and the result is an upper case character.
242  */
243  if (event->type() == QEvent::KeyPress) {
244  QKeyEvent *ke = static_cast<QKeyEvent *>(event);
245  QString str = ke->text();
246  if (str.length() != 0) {
247  const QChar *psz = str.unicode();
248  bool fShift = (ke->modifiers() & Qt::ShiftModifier) != 0;
249  if ((fShift && *psz >= 'a' && *psz <= 'z') || (!fShift && *psz >= 'A' && *psz <= 'Z')) {
250  fCapsLock = true;
251  ui->capsLabel->setText(tr("Warning: The Caps Lock key is on!"));
252  } else if (psz->isLetter()) {
253  fCapsLock = false;
254  ui->capsLabel->clear();
255  }
256  }
257  }
258  return QDialog::eventFilter(object, event);
259 }
260 
261 static void SecureClearQLineEdit(QLineEdit* edit)
262 {
263  // Attempt to overwrite text so that they do not linger around in memory
264  edit->setText(QString(" ").repeated(edit->text().size()));
265  edit->clear();
266 }
267 
269 {
270  SecureClearQLineEdit(ui->passEdit1);
271  SecureClearQLineEdit(ui->passEdit2);
272  SecureClearQLineEdit(ui->passEdit3);
273 }
static void SecureClearQLineEdit(QLineEdit *edit)
Multifunctional dialog to ask for passphrases.
SecureString * m_passphrase_out
AskPassphraseDialog(Mode mode, QWidget *parent, SecureString *passphrase_out=nullptr)
void setModel(WalletModel *model)
bool eventFilter(QObject *object, QEvent *event) override
bool event(QEvent *event) override
@ Unlock
Ask passphrase and unlock.
@ Encrypt
Ask passphrase twice and encrypt.
@ ChangePass
Ask old passphrase + new passphrase twice.
Ui::AskPassphraseDialog * ui
Interface to Bitcoin wallet from Qt view code.
Definition: walletmodel.h:53
bool setWalletEncrypted(const SecureString &passphrase)
bool changePassphrase(const SecureString &oldPass, const SecureString &newPass)
bool setWalletLocked(bool locked, const SecureString &passPhrase=SecureString())
static const int MAX_PASSPHRASE_SIZE
Definition: guiconstants.h:20
Utility functions used by the Bitcoin Qt UI.
Definition: bitcoingui.h:60
void handleCloseWindowShortcut(QWidget *w)
Definition: guiutil.cpp:415
constexpr auto dialog_flags
Definition: guiutil.h:60
std::basic_string< char, std::char_traits< char >, secure_allocator< char > > SecureString
Definition: secure.h:59
assert(!tx.IsCoinBase())