summaryrefslogtreecommitdiffstats
path: root/src/core/api/qwebenginewebauthuxrequest.h
blob: 111f52847ff61d9e4d970d3e5b91d1e5597788d9 (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
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#ifndef QWEBENGINEWEBAUTHUXREQUEST_H
#define QWEBENGINEWEBAUTHUXREQUEST_H

#include <QtWebEngineCore/qtwebenginecoreglobal.h>
#include <QtCore/qobject.h>

namespace QtWebEngineCore {
class AuthenticatorRequestDialogControllerPrivate;
}

QT_BEGIN_NAMESPACE

class QWebEngineWebAuthUxRequestPrivate;
struct QWebEngineWebAuthPinRequest;

class Q_WEBENGINECORE_EXPORT QWebEngineWebAuthUxRequest : public QObject
{
    Q_OBJECT

    Q_PROPERTY(QStringList userNames READ userNames CONSTANT FINAL)
    Q_PROPERTY(WebAuthUxState state READ state NOTIFY stateChanged FINAL)
    Q_PROPERTY(QString relyingPartyId READ relyingPartyId CONSTANT FINAL)
    Q_PROPERTY(QWebEngineWebAuthPinRequest pinRequest READ pinRequest CONSTANT FINAL)
    Q_PROPERTY(RequestFailureReason requestFailureReason READ requestFailureReason CONSTANT FINAL)
    Q_CLASSINFO("RegisterEnumClassesUnscoped", "false")
public:
    enum class WebAuthUxState {
        NotStarted,
        SelectAccount,
        CollectPin,
        FinishTokenCollection,
        RequestFailed,
        Cancelled,
        Completed,
    };
    Q_ENUM(WebAuthUxState)

    enum class PinEntryReason {
        Set,
        Change,
        Challenge,
    };
    Q_ENUM(PinEntryReason)

    enum class PinEntryError {
        NoError,
        InternalUvLocked,
        WrongPin,
        TooShort,
        InvalidCharacters,
        SameAsCurrentPin,
    };
    Q_ENUM(PinEntryError)

    enum class RequestFailureReason {
        Timeout,
        KeyNotRegistered,
        KeyAlreadyRegistered,
        SoftPinBlock,
        HardPinBlock,
        AuthenticatorRemovedDuringPinEntry,
        AuthenticatorMissingResidentKeys,
        AuthenticatorMissingUserVerification,
        AuthenticatorMissingLargeBlob,
        NoCommonAlgorithms,
        StorageFull,
        UserConsentDenied,
        WinUserCancelled,
    };
    Q_ENUM(RequestFailureReason)

    ~QWebEngineWebAuthUxRequest() override;

    QStringList userNames() const;
    QString relyingPartyId() const;
    QWebEngineWebAuthPinRequest pinRequest() const;
    WebAuthUxState state() const;
    RequestFailureReason requestFailureReason() const;

Q_SIGNALS:
    void stateChanged(QWebEngineWebAuthUxRequest::WebAuthUxState state);

public Q_SLOTS:
    void cancel();
    void retry();
    void setSelectedAccount(const QString &selectedAccount);
    void setPin(const QString &pin);

protected:
    explicit QWebEngineWebAuthUxRequest(QWebEngineWebAuthUxRequestPrivate *);

    std::unique_ptr<QWebEngineWebAuthUxRequestPrivate> d_ptr;
    friend class QtWebEngineCore::AuthenticatorRequestDialogControllerPrivate;
    Q_DECLARE_PRIVATE(QWebEngineWebAuthUxRequest)
};

struct QWebEngineWebAuthPinRequest
{
    Q_GADGET_EXPORT(Q_WEBENGINECORE_EXPORT)

    Q_PROPERTY(QWebEngineWebAuthUxRequest::PinEntryReason reason MEMBER reason CONSTANT FINAL)
    Q_PROPERTY(QWebEngineWebAuthUxRequest::PinEntryError error MEMBER error CONSTANT FINAL)
    Q_PROPERTY(qint32 minPinLength MEMBER minPinLength CONSTANT FINAL)
    Q_PROPERTY(int remainingAttempts MEMBER remainingAttempts CONSTANT FINAL)
public:
    QWebEngineWebAuthUxRequest::PinEntryReason reason;
    QWebEngineWebAuthUxRequest::PinEntryError error;
    qint32 minPinLength;
    int remainingAttempts;
};

QT_END_NAMESPACE

#endif // QWEBENGINEWEBAUTHUXREQUEST_H