Ditto 4.7.4
Loading...
Searching...
No Matches
Identity.hpp
1#ifndef _DITTO_IDENTITY_
2#define _DITTO_IDENTITY_
3
4#include "AuthenticationCallback.hpp"
5#include "Helpers.hpp"
6#include "dittoffi.hpp"
7
8#include <memory>
9#include <string>
10
11namespace ditto {
12class OfflinePlaygroundIdentity;
13class OnlineWithAuthenticationIdentity;
14class OnlinePlaygroundIdentity;
15class SharedKeyIdentity;
16class ManualIdentity;
17
21enum class IdentityType {
22 OFFLINE_PLAYGROUND,
23 ONLINE_WITH_AUTHENTICATION,
24 ONLINE_PLAYGROUND,
25 SHARED_KEY,
26 MANUAL,
27};
28
32std::string default_auth_url(std::string app_id);
33
55class Identity {
56 friend class Ditto;
57 friend class ManualIdentity;
58 friend class OfflinePlaygroundIdentity;
60 friend class OnlinePlaygroundIdentity;
61 friend class SharedKeyIdentity;
62 friend class TransportSync;
63
64public:
65 IdentityType type;
66 virtual ~Identity();
67
79 static std::shared_ptr<OfflinePlaygroundIdentity>
80 OfflinePlayground(std::string app_id = "", uint64_t site_id = 0);
81
93 static std::shared_ptr<OnlineWithAuthenticationIdentity>
94 OnlineWithAuthentication(std::string app_id,
95 std::shared_ptr<AuthenticationCallback> callback,
96 bool enable_ditto_cloud_sync = true,
97 std::string custom_auth_url = "");
98
112 static std::shared_ptr<OnlinePlaygroundIdentity>
113 OnlinePlayground(std::string app_id, std::string token,
114 bool enable_ditto_cloud_sync = true);
115
126 static std::shared_ptr<SharedKeyIdentity>
127 SharedKey(std::string app_id, std::string shared_key, uint64_t site_id = 0);
128
135 static std::shared_ptr<ManualIdentity> Manual(std::string certificate_config);
136
137private:
138 virtual std::string get_app_id() const;
139 virtual bool get_enable_ditto_cloud_sync() const;
140 virtual bool requires_offline_license_token() const;
141
145 virtual CIdentityConfig_t *build_identity_config() = 0;
146};
147
154 friend class Identity;
155
156public:
160 uint64_t site_id;
161
162private:
163 OfflinePlaygroundIdentity(std::string app_id, uint64_t site_id);
164
165 std::string app_id;
166 std::string get_app_id() const;
167 bool requires_offline_license_token() const;
168 CIdentityConfig_t *build_identity_config();
169};
170
192 friend class Ditto;
193 friend class Identity;
194
195public:
200
205 std::string custom_auth_url;
206
207private:
209 std::string app_id, std::shared_ptr<AuthenticationCallback> callback,
210 bool enable_ditto_cloud_sync, std::string custom_auth_url);
211
212 std::string app_id;
213 std::shared_ptr<AuthenticationCallback> callback;
214 std::string get_app_id() const;
215 bool get_enable_ditto_cloud_sync() const;
216 bool requires_offline_license_token() const;
217 CIdentityConfig_t *build_identity_config();
218};
219
226 friend class Identity;
227
228public:
233 std::string token;
234
239
240private:
241 OnlinePlaygroundIdentity(std::string app_id, std::string token,
243
244 std::string app_id;
245 std::string get_app_id() const;
246 std::string get_token() const;
247 bool get_enable_ditto_cloud_sync() const;
248 bool requires_offline_license_token() const;
249 CIdentityConfig_t *build_identity_config();
250};
251
259 friend class Identity;
260
261public:
265 std::string shared_key;
266
270 uint64_t site_id;
271
272private:
273 SharedKeyIdentity(std::string app_id, std::string shared_key,
274 uint64_t site_id);
275
276 std::string app_id;
277 std::string get_app_id() const;
278 bool requires_offline_license_token() const;
279 CIdentityConfig_t *build_identity_config();
280};
281
286class ManualIdentity : public Identity {
287 friend class Identity;
288
289public:
295
296private:
297 explicit ManualIdentity(std::string certificate_config);
298 bool requires_offline_license_token() const;
299 CIdentityConfig_t *build_identity_config();
300};
301
302} // namespace ditto
303
304#endif
The entrypoint to the Ditto SDK.
Definition Ditto.hpp:32
The various identity configurations that you can use when initializing a Ditto instance.
Definition Identity.hpp:55
static std::shared_ptr< OnlinePlaygroundIdentity > OnlinePlayground(std::string app_id, std::string token, bool enable_ditto_cloud_sync=true)
Construct a new OnlinePlaygroundIdentity.
Definition Identity.cpp:40
static std::shared_ptr< OfflinePlaygroundIdentity > OfflinePlayground(std::string app_id="", uint64_t site_id=0)
Construct a new OfflinePlaygroundIdentity.
Definition Identity.cpp:25
static std::shared_ptr< SharedKeyIdentity > SharedKey(std::string app_id, std::string shared_key, uint64_t site_id=0)
Construct a new SharedKeyIdentity.
Definition Identity.cpp:47
static std::shared_ptr< OnlineWithAuthenticationIdentity > OnlineWithAuthentication(std::string app_id, std::shared_ptr< AuthenticationCallback > callback, bool enable_ditto_cloud_sync=true, std::string custom_auth_url="")
Construct a new OnlineWithAuthenticationIdentity.
Definition Identity.cpp:31
static std::shared_ptr< ManualIdentity > Manual(std::string certificate_config)
Construct a new ManualIdentity.
Definition Identity.cpp:54
A manually-provided certificate identity. This accepts a base64-encoded bundle.
Definition Identity.hpp:286
std::string certificate_config
Definition Identity.hpp:294
Develop peer-to-peer apps with no cloud connection. This mode offers no security and must only be use...
Definition Identity.hpp:153
uint64_t site_id
Definition Identity.hpp:160
Test a Ditto Cloud app with weak shared token authentication ("Playground mode"). This is not secure ...
Definition Identity.hpp:225
std::string token
Definition Identity.hpp:233
bool enable_ditto_cloud_sync
Definition Identity.hpp:238
Run Ditto in secure production mode, logging on to Ditto Cloud or on on-premises authentication serve...
Definition Identity.hpp:191
std::string custom_auth_url
Definition Identity.hpp:205
bool enable_ditto_cloud_sync
Definition Identity.hpp:199
A mode where any device is trusted provided they know the secret key. This is a simplistic authentica...
Definition Identity.hpp:258
std::string shared_key
Definition Identity.hpp:265
uint64_t site_id
Definition Identity.hpp:270