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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
// THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
#pragma once
#include <Quotient/csapi/definitions/user_identifier.h>
#include <Quotient/csapi/definitions/wellknown/full.h>
#include <Quotient/jobs/basejob.h>
namespace Quotient {
//! \brief Get the supported login types to authenticate users
//!
//! Gets the homeserver's supported login types to authenticate users. Clients
//! should pick one of these and supply it as the `type` when logging in.
class QUOTIENT_API GetLoginFlowsJob : public BaseJob {
public:
// Inner data structures
struct QUOTIENT_API LoginFlow {
//! The login type. This is supplied as the `type` when
//! logging in.
QString type;
//! If `type` is `m.login.token`, an optional field to indicate
//! to the unauthenticated client that the homeserver supports
//! the [`POST /login/get_token`](/client-server-api/#post_matrixclientv1loginget_token)
//! endpoint. Note that supporting the endpoint does not
//! necessarily indicate that the user attempting to log in will
//! be able to generate such a token.
bool getLoginToken{ false };
bool delegatedOidcCompatibility{ false };
};
// Construction/destruction
explicit GetLoginFlowsJob();
//! \brief Construct a URL without creating a full-fledged job object
//!
//! This function can be used when a URL for GetLoginFlowsJob
//! is necessary but the job itself isn't.
static QUrl makeRequestUrl(const HomeserverData& hsData);
// Result properties
//! The homeserver's supported login types
QVector<LoginFlow> flows() const { return loadFromJson<QVector<LoginFlow>>("flows"_L1); }
};
inline auto collectResponse(const GetLoginFlowsJob* job) { return job->flows(); }
template <>
struct QUOTIENT_API JsonObjectConverter<GetLoginFlowsJob::LoginFlow> {
static void fillFrom(const QJsonObject& jo, GetLoginFlowsJob::LoginFlow& result)
{
fillFromJson(jo.value("type"_L1), result.type);
fillFromJson(jo.value("get_login_token"_L1), result.getLoginToken);
fillFromJson(jo.value("org.matrix.msc3824.delegated_oidc_compatibility"_L1),
result.delegatedOidcCompatibility);
}
};
//! \brief Authenticates the user.
//!
//! Authenticates the user, and issues an access token they can
//! use to authorize themself in subsequent requests.
//!
//! If the client does not supply a `device_id`, the server must
//! auto-generate one.
//!
//! The returned access token must be associated with the `device_id`
//! supplied by the client or generated by the server. The server may
//! invalidate any access token previously associated with that device. See
//! [Relationship between access tokens and
//! devices](/client-server-api/#relationship-between-access-tokens-and-devices).
class QUOTIENT_API LoginJob : public BaseJob {
public:
//! \param type
//! The login type being used.
//!
//! This must be a type returned in one of the flows of the
//! response of the [`GET /login`](/client-server-api/#get_matrixclientv3login)
//! endpoint, like `m.login.password` or `m.login.token`.
//!
//!
//! \param password
//! Required when `type` is `m.login.password`. The user's
//! password.
//!
//! \param token
//! Required when `type` is `m.login.token`. Part of Token-based login.
//!
//! \param deviceId
//! ID of the client device. If this does not correspond to a
//! known client device, a new device will be created. The given
//! device ID must not be the same as a
//! [cross-signing](/client-server-api/#cross-signing) key ID.
//! The server will auto-generate a device_id
//! if this is not specified.
//!
//! \param initialDeviceDisplayName
//! A display name to assign to the newly-created device. Ignored
//! if `device_id` corresponds to a known device.
//!
//! \param refreshToken
//! If true, the client supports refresh tokens.
explicit LoginJob(const QString& type,
const std::optional<UserIdentifier>& identifier = std::nullopt,
const QString& password = {}, const QString& token = {},
const QString& deviceId = {}, const QString& initialDeviceDisplayName = {},
std::optional<bool> refreshToken = std::nullopt);
// Result properties
//! The fully-qualified Matrix ID for the account.
QString userId() const { return loadFromJson<QString>("user_id"_L1); }
//! An access token for the account.
//! This access token can then be used to authorize other requests.
QString accessToken() const { return loadFromJson<QString>("access_token"_L1); }
//! A refresh token for the account. This token can be used to
//! obtain a new access token when it expires by calling the
//! `/refresh` endpoint.
QString refreshToken() const { return loadFromJson<QString>("refresh_token"_L1); }
//! The lifetime of the access token, in milliseconds. Once
//! the access token has expired a new access token can be
//! obtained by using the provided refresh token. If no
//! refresh token is provided, the client will need to re-log in
//! to obtain a new access token. If not given, the client can
//! assume that the access token will not expire.
std::optional<int> expiresInMs() const
{
return loadFromJson<std::optional<int>>("expires_in_ms"_L1);
}
//! ID of the logged-in device. Will be the same as the
//! corresponding parameter in the request, if one was specified.
QString deviceId() const { return loadFromJson<QString>("device_id"_L1); }
//! Optional client configuration provided by the server. If present,
//! clients SHOULD use the provided object to reconfigure themselves,
//! optionally validating the URLs within. This object takes the same
//! form as the one returned from .well-known autodiscovery.
std::optional<DiscoveryInformation> wellKnown() const
{
return loadFromJson<std::optional<DiscoveryInformation>>("well_known"_L1);
}
struct Response {
//! The fully-qualified Matrix ID for the account.
QString userId{};
//! An access token for the account.
//! This access token can then be used to authorize other requests.
QString accessToken{};
//! A refresh token for the account. This token can be used to
//! obtain a new access token when it expires by calling the
//! `/refresh` endpoint.
QString refreshToken{};
//! The lifetime of the access token, in milliseconds. Once
//! the access token has expired a new access token can be
//! obtained by using the provided refresh token. If no
//! refresh token is provided, the client will need to re-log in
//! to obtain a new access token. If not given, the client can
//! assume that the access token will not expire.
std::optional<int> expiresInMs{};
//! ID of the logged-in device. Will be the same as the
//! corresponding parameter in the request, if one was specified.
QString deviceId{};
//! Optional client configuration provided by the server. If present,
//! clients SHOULD use the provided object to reconfigure themselves,
//! optionally validating the URLs within. This object takes the same
//! form as the one returned from .well-known autodiscovery.
std::optional<DiscoveryInformation> wellKnown{};
};
};
template <std::derived_from<LoginJob> JobT>
constexpr inline auto doCollectResponse<JobT> = [](JobT* j) -> LoginJob::Response {
return { j->userId(), j->accessToken(), j->refreshToken(),
j->expiresInMs(), j->deviceId(), j->wellKnown() };
};
} // namespace Quotient
|
