pinentrydialog.h

/* pinentrydialog.h - A (not yet) secure Qt 4 dialog for PIN entry.
 * Copyright (C) 2002, 2008 Klarälvdalens Datakonsult AB (KDAB)
 * Copyright 2007 Ingo Klöcker
 * Copyright 2016 Intevation GmbH
 * Copyright (C) 2021, 2022 g10 Code GmbH
 *
 * Written by Steffen Hansen <steffen@klaralvdalens-datakonsult.se>.
 * Modified by Andre Heinecke <aheinecke@intevation.de>
 * Software engineering by Ingo Klöcker <dev@ingo-kloecker.de>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <https://www.gnu.org/licenses/>.
 * SPDX-License-Identifier: GPL-2.0+
 */
 
#ifndef __PINENTRYDIALOG_H__
#define __PINENTRYDIALOG_H__
 
#include <QAccessible>
#include <QDialog>
#include <QStyle>
#include <QTimer>
 
#include "core/function/SecureMemoryAllocator.h"
#include "pinentry.h"
 
class QIcon;
class QLabel;
class QPushButton;
class QLineEdit;
class PinLineEdit;
class QString;
class QProgressBar;
class QCheckBox;
class QAction;
 
QPixmap applicationIconPixmap(const QIcon &overlayIcon = {});
 
void raiseWindow(QWidget *w);
 
class PinEntryDialog : public QDialog {
  Q_OBJECT
 
  Q_PROPERTY(QString description READ description WRITE setDescription)
  Q_PROPERTY(QString error READ error WRITE setError)
  Q_PROPERTY(QString pin READ pin WRITE setPin)
  Q_PROPERTY(QString prompt READ prompt WRITE setPrompt)
 public:
  struct FormattedPassphraseOptions {
    bool formatPassphrase;
    QString hint;
  };
  struct ConstraintsOptions {
    bool enforce;
    QString shortHint;
    QString longHint;
    QString errorTitle;
  };
 
  explicit PinEntryDialog(QWidget *parent = 0, const char *name = 0,
                          int timeout = 0, bool modal = false,
                          bool enable_quality_bar = false,
                          const QString &repeatString = QString(),
                          const QString &visibiltyTT = QString(),
                          const QString &hideTT = QString());
 
  void setDescription(const QString &);
  QString description() const;
 
  void setError(const QString &);
  QString error() const;
 
  void setPin(const QString &);
  QString pin() const;
 
  QString repeatedPin() const;
  void setRepeatErrorText(const QString &);
 
  void setPrompt(const QString &);
  QString prompt() const;
 
  void setOkText(const QString &);
  void setCancelText(const QString &);
 
  void setQualityBar(const QString &);
  void setQualityBarTT(const QString &);
 
  void setGenpinLabel(const QString &);
  void setGenpinTT(const QString &);
 
  void setCapsLockHint(const QString &);
 
  void setFormattedPassphrase(const FormattedPassphraseOptions &options);
 
  void setConstraintsOptions(const ConstraintsOptions &options);
 
  void setPinentryInfo(struct pinentry);
 
  bool timedOut() const;
 
 protected Q_SLOTS:
  void updateQuality(const QString &);
  void slotTimeout();
  void textChanged(const QString &);
  void focusChanged(QWidget *old, QWidget *now);
  void toggleVisibility();
  void onBackspace();
  void generatePin();
  void toggleFormattedPassphrase();
 
 protected:
  void keyPressEvent(QKeyEvent *event) override;
  void keyReleaseEvent(QKeyEvent *event) override;
  void showEvent(QShowEvent *event) override;
 
 private Q_SLOTS:
  void cancelTimeout();
  void checkCapsLock();
  void onAccept();
 
 private:
  enum PassphraseCheckResult {
    PassphraseNotChecked = -1,
    PassphraseNotOk = 0,
    PassphraseOk
  };
 
  QLabel *_icon = nullptr;
  QLabel *_desc = nullptr;
  QLabel *_error = nullptr;
  QLabel *_prompt = nullptr;
  QLabel *_quality_bar_label = nullptr;
  QProgressBar *_quality_bar = nullptr;
  PinLineEdit *_edit = nullptr;
  PinLineEdit *mRepeat = nullptr;
  QLabel *mRepeatError = nullptr;
  QPushButton *_ok = nullptr;
  QPushButton *_cancel = nullptr;
  bool _grabbed = false;
  bool _have_quality_bar = false;
  bool _timed_out = false;
  bool _disable_echo_allowed = true;
  bool mEnforceConstraints = false;
  bool mFormatPassphrase = false;
 
  GpgFrontend::SecureUniquePtr<struct pinentry> _pinentry_info = nullptr;
  QTimer *_timer = nullptr;
  QString mVisibilityTT;
  QString mHideTT;
  QAction *mVisiActionEdit = nullptr;
  QPushButton *mGenerateButton = nullptr;
  QCheckBox *mVisiCB = nullptr;
  QLabel *mFormattedPassphraseHint = nullptr;
  QLabel *mFormattedPassphraseHintSpacer = nullptr;
  QLabel *mCapsLockHint = nullptr;
  QLabel *mConstraintsHint = nullptr;
  QString mConstraintsErrorTitle;
};
 
#endif  // __PINENTRYDIALOG_H__