Ditto 3.0.0-alpha1
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 Authenticator;
13class LoginProvider;
14
15class OfflinePlaygroundIdentity;
16class OnlineWithAuthenticationIdentity;
17class OnlinePlaygroundIdentity;
18class SharedKeyIdentity;
19class ManualIdentity;
20
24enum class IdentityType {
25 OFFLINE_PLAYGROUND,
26 ONLINE_WITH_AUTHENTICATION,
27 ONLINE_PLAYGROUND,
28 SHARED_KEY,
29 MANUAL,
30};
31
53class Identity {
54 friend class Ditto;
55 friend class ManualIdentity;
56 friend class OfflinePlaygroundIdentity;
58 friend class OnlinePlaygroundIdentity;
59 friend class SharedKeyIdentity;
60 friend class Sync;
61
62public:
63 IdentityType type;
64 virtual ~Identity(){};
65
77 static std::shared_ptr<OfflinePlaygroundIdentity>
78 OfflinePlayground(std::string app_id = "", uint64_t site_id = 0);
79
91 static std::shared_ptr<OnlineWithAuthenticationIdentity>
92 OnlineWithAuthentication(std::string app_id,
93 std::shared_ptr<AuthenticationCallback> callback,
94 bool enable_ditto_cloud_sync = true,
95 std::string custom_auth_url = "");
96
110 static std::shared_ptr<OnlinePlaygroundIdentity>
111 OnlinePlayground(std::string app_id, std::string token,
112 bool enable_ditto_cloud_sync = true);
113
124 static std::shared_ptr<SharedKeyIdentity>
125 SharedKey(std::string app_id, std::string shared_key, uint64_t site_id = 0);
126
133 static std::shared_ptr<ManualIdentity> Manual(std::string certificate_config);
134
135private:
136 virtual std::string get_app_id() const final;
137 virtual std::shared_ptr<Authenticator> get_authenticator() const;
138 virtual bool get_enable_ditto_cloud_sync() const;
139 virtual bool requires_offline_license_token() const;
146 virtual std::shared_ptr<CAuthClient_t>
147 authenticate(std::string persistence_dir = "") = 0;
148
149 std::shared_ptr<CAuthClient_t> auth_client;
150};
151
158 friend class Identity;
159
160public:
164 uint64_t site_id;
165
166private:
167 OfflinePlaygroundIdentity(std::string app_id, uint64_t site_id);
168
169 std::string app_id;
170 std::shared_ptr<CAuthClient_t> authenticate(std::string persistence_dir = "");
171 bool requires_offline_license_token() const;
172};
173
195 friend class Identity;
196
197public:
202
207 std::string custom_auth_url;
208
209private:
211 std::string app_id, std::shared_ptr<AuthenticationCallback> callback,
212 bool enable_ditto_cloud_sync, std::string custom_auth_url);
213
214 std::string app_id;
215 bool get_enable_ditto_cloud_sync() const;
216 std::shared_ptr<Authenticator> get_authenticator() const;
217 std::shared_ptr<CAuthClient_t> authenticate(std::string persistence_dir = "");
218 std::shared_ptr<Authenticator> authenticator;
219 std::shared_ptr<LoginProvider> login_provider;
220 std::shared_ptr<AuthenticationCallback> callback;
221 bool requires_offline_license_token() const;
222};
223
230 friend class Identity;
231
232public:
237 std::string token;
238
243
244private:
245 OnlinePlaygroundIdentity(std::string app_id, std::string token,
247
248 std::string app_id;
249 std::string get_token() const;
250 bool get_enable_ditto_cloud_sync() const;
251 bool requires_offline_license_token() const;
252 std::shared_ptr<Authenticator> get_authenticator() const;
253 std::shared_ptr<CAuthClient_t> authenticate(std::string persistence_dir = "");
254 std::shared_ptr<Authenticator> authenticator;
255};
256
264 friend class Identity;
265
266public:
270 std::string shared_key;
271
275 uint64_t site_id;
276
277private:
278 SharedKeyIdentity(std::string app_id, std::string shared_key,
279 uint64_t site_id);
280
281 std::string app_id;
282 bool requires_offline_license_token() const;
283 std::shared_ptr<CAuthClient_t> authenticate(std::string persistence_dir = "");
284};
285
290class ManualIdentity : public Identity {
291 friend class Identity;
292
293public:
299
300private:
301 std::shared_ptr<CAuthClient_t> authenticate(std::string persistence_dir = "");
302 explicit ManualIdentity(std::string certificate_config);
303 bool requires_offline_license_token() const;
304};
305
306} // namespace ditto
307
308#endif
The entrypoint to the Ditto SDK.
Definition: Ditto.hpp:27
The various identity configurations that you can use when initializing a Ditto instance.
Definition: Identity.hpp:53
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:51
static std::shared_ptr< OfflinePlaygroundIdentity > OfflinePlayground(std::string app_id="", uint64_t site_id=0)
Construct a new OfflinePlaygroundIdentity.
Definition: Identity.cpp:36
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:58
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:42
static std::shared_ptr< ManualIdentity > Manual(std::string certificate_config)
Construct a new ManualIdentity.
Definition: Identity.cpp:65
A manually-provided certificate identity. This accepts a base64-encoded bundle.
Definition: Identity.hpp:290
std::string certificate_config
Definition: Identity.hpp:298
Develop peer-to-peer apps with no cloud connection. This mode offers no security and must only be use...
Definition: Identity.hpp:157
uint64_t site_id
Definition: Identity.hpp:164
Test a Ditto Cloud app with weak shared token authentication ("Playground mode"). This is not secure ...
Definition: Identity.hpp:229
std::string token
Definition: Identity.hpp:237
bool enable_ditto_cloud_sync
Definition: Identity.hpp:242
Run Ditto in secure production mode, logging on to Ditto Cloud or on on-premises authentication serve...
Definition: Identity.hpp:194
std::string custom_auth_url
Definition: Identity.hpp:207
bool enable_ditto_cloud_sync
Definition: Identity.hpp:201
A mode where any device is trusted provided they know the secret key. This is a simplistic authentica...
Definition: Identity.hpp:263
std::string shared_key
Definition: Identity.hpp:270
uint64_t site_id
Definition: Identity.hpp:275