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
|
#pragma once
#include "base/exception.hpp"
#include "std/string.hpp"
#include "std/utility.hpp"
namespace osm
{
using TKeySecret = pair<string /*key*/, string /*secret*/>;
using TRequestToken = TKeySecret;
/// All methods that interact with the OSM server are blocking and not asynchronous.
class OsmOAuth
{
public:
/// Do not use enum class here for easier matching with error_code().
enum HTTP : int
{
OK = 200,
Found = 302,
BadXML = 400,
BadAuth = 401,
Redacted = 403,
NotFound = 404,
WrongMethod = 405,
Conflict = 409,
Gone = 410,
// Most often it means bad reference to another object.
PreconditionFailed = 412,
URITooLong = 414,
TooMuchData = 509
};
/// A pair of <http error code, response contents>.
using Response = std::pair<int, string>;
/// A pair of <url, key-secret>.
using TUrlRequestToken = std::pair<string, TRequestToken>;
DECLARE_EXCEPTION(OsmOAuthException, RootException);
DECLARE_EXCEPTION(NetworkError, OsmOAuthException);
DECLARE_EXCEPTION(UnexpectedRedirect, OsmOAuthException);
DECLARE_EXCEPTION(UnsupportedApiRequestMethod, OsmOAuthException);
DECLARE_EXCEPTION(InvalidKeySecret, OsmOAuthException);
DECLARE_EXCEPTION(FetchSessionIdError, OsmOAuthException);
DECLARE_EXCEPTION(LogoutUserError, OsmOAuthException);
DECLARE_EXCEPTION(LoginUserPasswordServerError, OsmOAuthException);
DECLARE_EXCEPTION(LoginUserPasswordFailed, OsmOAuthException);
DECLARE_EXCEPTION(LoginSocialServerError, OsmOAuthException);
DECLARE_EXCEPTION(LoginSocialFailed, OsmOAuthException);
DECLARE_EXCEPTION(SendAuthRequestError, OsmOAuthException);
DECLARE_EXCEPTION(FetchRequestTokenServerError, OsmOAuthException);
DECLARE_EXCEPTION(FinishAuthorizationServerError, OsmOAuthException);
DECLARE_EXCEPTION(ResetPasswordServerError, OsmOAuthException);
static bool IsValid(TKeySecret const & ks) noexcept;
static bool IsValid(TUrlRequestToken const & urt) noexcept;
/// The constructor. Simply stores a lot of strings in fields.
OsmOAuth(string const & consumerKey, string const & consumerSecret,
string const & baseUrl, string const & apiUrl) noexcept;
/// Should be used everywhere in production code instead of servers below.
static OsmOAuth ServerAuth() noexcept;
static OsmOAuth ServerAuth(TKeySecret const & userKeySecret) noexcept;
/// Ilya Zverev's test server.
static OsmOAuth IZServerAuth() noexcept;
/// master.apis.dev.openstreetmap.org
static OsmOAuth DevServerAuth() noexcept;
/// api.openstreetmap.org
static OsmOAuth ProductionServerAuth() noexcept;
void SetKeySecret(TKeySecret const & keySecret) noexcept;
TKeySecret const & GetKeySecret() const noexcept;
bool IsAuthorized() const noexcept;
/// @returns false if login and/or password are invalid.
bool AuthorizePassword(string const & login, string const & password);
/// @returns false if Facebook credentials are invalid.
bool AuthorizeFacebook(string const & facebookToken);
/// @returns false if Google credentials are invalid.
bool AuthorizeGoogle(string const & googleToken);
/// @returns false if email has not been registered on a server.
bool ResetPassword(string const & email) const;
/// Throws in case of network errors.
/// @param[method] The API method, must start with a forward slash.
Response Request(string const & method, string const & httpMethod = "GET", string const & body = "") const;
/// Tokenless GET request, for convenience.
/// @param[api] If false, request is made to m_baseUrl.
Response DirectRequest(string const & method, bool api = true) const;
/// @name Methods for WebView-based authentication.
//@{
TUrlRequestToken GetFacebookOAuthURL() const;
TUrlRequestToken GetGoogleOAuthURL() const;
TKeySecret FinishAuthorization(TRequestToken const & requestToken, string const & verifier) const;
//AuthResult FinishAuthorization(TKeySecret const & requestToken, string const & verifier);
string GetRegistrationURL() const noexcept { return m_baseUrl + "/user/new"; }
string GetResetPasswordURL() const noexcept { return m_baseUrl + "/user/forgot-password"; }
//@}
private:
struct SessionID
{
string m_cookies;
string m_token;
};
/// Key and secret for application.
TKeySecret const m_consumerKeySecret;
string const m_baseUrl;
string const m_apiUrl;
/// Key and secret to sign every OAuth request.
TKeySecret m_tokenKeySecret;
SessionID FetchSessionId(string const & subUrl = "/login") const;
/// Log a user out.
void LogoutUser(SessionID const & sid) const;
/// Signs a user id using login and password.
/// @returns false if login or password are invalid.
bool LoginUserPassword(string const & login, string const & password, SessionID const & sid) const;
/// Signs a user in using Facebook token.
/// @returns false if the social token is invalid.
bool LoginSocial(string const & callbackPart, string const & socialToken, SessionID const & sid) const;
/// @returns non-empty string with oauth_verifier value.
string SendAuthRequest(string const & requestTokenKey, SessionID const & sid) const;
/// @returns valid key and secret or throws otherwise.
TRequestToken FetchRequestToken() const;
TKeySecret FetchAccessToken(SessionID const & sid) const;
//AuthResult FetchAccessToken(SessionID const & sid);
};
string DebugPrint(OsmOAuth::Response const & code);
} // namespace osm
|
