-
Notifications
You must be signed in to change notification settings - Fork 0
/
oauth.go
325 lines (270 loc) · 9.45 KB
/
oauth.go
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
package controllers
import (
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/url"
"twreporter.org/go-api/globals"
"twreporter.org/go-api/models"
"twreporter.org/go-api/storage"
"twreporter.org/go-api/utils"
log "github.com/Sirupsen/logrus"
"github.com/gin-contrib/sessions"
"github.com/gin-gonic/gin"
"github.com/jinzhu/copier"
"golang.org/x/oauth2"
"golang.org/x/oauth2/facebook"
"golang.org/x/oauth2/google"
"gopkg.in/guregu/null.v3"
)
const defaultDestination = "https://www.twreporter.org/"
type basicInfo struct {
Email null.String `json:"email"`
Name null.String `json:"name"`
Gender string `json:"gender"`
}
type facebookOauthInfoRaw struct {
basicInfo
AId null.String `json:"id"`
FirstName null.String `json:"first_name"`
LastName null.String `json:"last_name"`
PictureObj struct {
Data struct {
URL null.String `json:"url"`
} `json:"data"`
} `json:"picture"`
}
// Picture is used by copier to copy PictureObj.Data.URL field to Picture field
func (info *facebookOauthInfoRaw) Picture() null.String {
return info.PictureObj.Data.URL
}
func (info *facebookOauthInfoRaw) Gender() null.String {
return utils.GetGender(info.basicInfo.Gender)
}
type googleOauthInfoRaw struct {
basicInfo
AId null.String `json:"sub"`
FirstName null.String `json:"given_name"`
LastName null.String `json:"family_name"`
Picture null.String `json:"picture"`
}
func (info *googleOauthInfoRaw) Gender() null.String {
return utils.GetGender(info.basicInfo.Gender)
}
// beginAuth uses sessions to store users'
// 1. state
// 2. destination(go to page)
// and redirect users to oauth server.
func beginAuth(c *gin.Context, conf *oauth2.Config) {
var state string
var err error
destination := c.Query("destination")
if destination == "" {
destination = defaultDestination
}
if state, err = utils.GenerateRandomString(32); err != nil {
state = "twreporter-oauth-state"
}
session := sessions.Default(c)
session.Set("state", state)
session.Set("destination", destination)
session.Save()
url := conf.AuthCodeURL(state)
c.Redirect(http.StatusTemporaryRedirect, url)
}
// getOauthUserInfo does the following three things
// 1. validate state
// 2. exchange code to token
// 3. get user info from oauth server by token
func getOauthUserInfo(c *gin.Context, conf *oauth2.Config, userInfoEndpoint string, oauthUser interface{}) error {
session := sessions.Default(c)
retrievedState := session.Get("state")
state := c.Query("state")
if state != retrievedState {
log.Warnf("expect state is %s, but actual state is %s", retrievedState, state)
return models.NewAppError("getOauthUserInfo", "oauth fails", "Invalid oauth state", 500)
}
code := c.Query("code")
token, err := conf.Exchange(oauth2.NoContext, code)
if err != nil {
return models.NewAppError("getOauthUserInfo", "oauth code exchange failed", err.Error(), http.StatusInternalServerError)
}
client := conf.Client(oauth2.NoContext, token)
response, err := client.Get(userInfoEndpoint)
if err != nil {
return models.NewAppError("getOauthUserInfo", "cannot get user info by using Google API", err.Error(), http.StatusInternalServerError)
}
defer response.Body.Close()
userInfo, err := ioutil.ReadAll(response.Body)
if err != nil {
return models.NewAppError("getOauthUserInfo", "error parsing user data", err.Error(), http.StatusInternalServerError)
}
if err = json.Unmarshal(userInfo, &oauthUser); err != nil {
return models.NewAppError("getOauthUserInfo", "can not unmarshal user data", err.Error(), http.StatusInternalServerError)
}
return nil
}
// In order to avoid from storing user info repeatedly,
// findOrCreateUser handles how to store oauth users in the storage.
func findOrCreateUser(oauthUser models.OAuthAccount, storage storage.MembershipStorage) (user models.User, err error) {
var appErr *models.AppError
// get the record from o_auth_accounts table
_, err = storage.GetOAuthData(oauthUser.AId, oauthUser.Type)
// oAuth account is not existed
// sign in by oauth for the first time
if err != nil {
appErr = appErrorTypeAssertion(err)
// return internal server error
if appErr.StatusCode != http.StatusNotFound {
return user, err
}
// email is provided in oAuth response
if oauthUser.Email.Valid {
// get the record from users table
user, err = storage.GetUserByEmail(oauthUser.Email.String)
// record is not existed in users table
if err != nil {
appErr = err.(*models.AppError)
// return internal server error
if appErr.StatusCode != http.StatusNotFound {
return user, err
}
// no record in users table with this email
// create a record in users table
// and create a record in o_auth_accounts table
if user, err = storage.InsertUserByOAuth(oauthUser); err != nil {
return user, err
}
} else {
// record existed in user table
// create record in o_auth_accounts table
// and connect it to the user record
oauthUser.UserID = user.ID
if err = storage.InsertOAuthAccount(oauthUser); err != nil {
return user, err
}
}
} else {
// email is not provided in oAuth response
// create a record in users table
// and also create a record in o_auth_accounts table
if user, err = storage.InsertUserByOAuth(oauthUser); err != nil {
return user, err
}
}
} else {
// user signed in before
if user, err = storage.GetUserDataByOAuth(oauthUser); err != nil {
return user, err
}
// update existing OAuth data
if _, err = storage.UpdateOAuthData(oauthUser); err != nil {
return user, err
}
}
return user, nil
}
// OAuth which stores storage connection and oauth config
type OAuth struct {
Storage storage.MembershipStorage
oauthConf *oauth2.Config
}
// InitGoogleConfig initiates facebook oauth config
func (o *OAuth) InitFacebookConfig() {
appsettings := globals.Conf.App
redirectURL := fmt.Sprintf("%s://%s:%s/v2/auth/facebook/callback", appsettings.Protocol, appsettings.Host, appsettings.Port)
o.oauthConf = &oauth2.Config{
ClientID: globals.Conf.Oauth.Facebook.ID,
ClientSecret: globals.Conf.Oauth.Facebook.Secret,
RedirectURL: redirectURL,
Scopes: []string{"public_profile", "email"},
Endpoint: facebook.Endpoint,
}
}
// InitGoogleConfig initiates google oauth config
func (o *OAuth) InitGoogleConfig() {
appsettings := globals.Conf.App
redirectURL := fmt.Sprintf("%s://%s:%s/v2/auth/google/callback", appsettings.Protocol, appsettings.Host, appsettings.Port)
o.oauthConf = &oauth2.Config{
ClientID: globals.Conf.Oauth.Google.ID,
ClientSecret: globals.Conf.Oauth.Google.Secret,
RedirectURL: redirectURL,
Scopes: []string{
"profile", // You have to select your own scope from here -> https://developers.google.com/identity/protocols/googlescopes#google_sign-in
"email",
"openid",
},
Endpoint: google.Endpoint,
}
}
// BeginAuth redirects user to the [facebook|google] authentication(login) page
func (o *OAuth) BeginOAuth(c *gin.Context) {
beginAuth(c, o.oauthConf)
return
}
// Authenticate handles [google|facebook] oauth of users and redirect them to specific URL they want
// with Set-Cookie response header which contains JWT
func (o *OAuth) Authenticate(c *gin.Context) {
var destination string
var err error
var matchUser models.User
var oauthType string
var oauthUser models.OAuthAccount
var retrievedDestination interface{}
var session sessions.Session
var token string
var userInfoEndpoint string
session = sessions.Default(c)
if retrievedDestination = session.Get("destination"); retrievedDestination != nil {
destination = retrievedDestination.(string)
}
if destination == "" {
destination = defaultDestination
}
if o.oauthConf.Endpoint == google.Endpoint {
var oauthInfo googleOauthInfoRaw
userInfoEndpoint = "https://www.googleapis.com/oauth2/v3/userinfo"
err = getOauthUserInfo(c, o.oauthConf, userInfoEndpoint, &oauthInfo)
copier.Copy(&oauthUser, &oauthInfo)
oauthType = globals.GoogleOAuth
} else {
var oauthInfo facebookOauthInfoRaw
userInfoEndpoint = "https://graph.facebook.com/v2.8/me?fields=id,name,email,picture,birthday,first_name,last_name,gender"
err = getOauthUserInfo(c, o.oauthConf, userInfoEndpoint, &oauthInfo)
copier.Copy(&oauthUser, &oauthInfo)
oauthType = globals.FacebookOAuth
}
if err != nil {
log.Errorf("oauth fails while getting user info from api, error message:\n%s", err.Error())
c.Redirect(http.StatusTemporaryRedirect, destination)
return
}
oauthUser.Type = oauthType
if matchUser, err = findOrCreateUser(oauthUser, o.Storage); err != nil {
log.Errorf("oauth fails due to database operation error:\n%s", err.Error())
c.Redirect(http.StatusTemporaryRedirect, destination)
return
}
if token, err = utils.RetrieveV2IDToken(matchUser.ID, matchUser.Email.ValueOrZero(), matchUser.FirstName.ValueOrZero(), matchUser.LastName.ValueOrZero(), idTokenExpiration); err != nil {
log.Errorf("oauth fails due to generate JWT error:\n%s", err.Error())
c.Redirect(http.StatusTemporaryRedirect, destination)
return
}
var u *url.URL
var secure = false
u, err = url.Parse(destination)
if u.Scheme == "https" {
secure = true
}
parameters := u.Query()
parameters.Add("login", oauthType)
u.RawQuery = parameters.Encode()
destination = u.String()
// hours to seconds
maxAge := idTokenExpiration
// set domain to .twreporter.org
// so each hostname of [www|support|tsai-tracker].twreporter.org will be applied
c.SetCookie("id_token", token, maxAge, "/", "."+globals.Conf.App.Domain, secure, true)
c.Redirect(http.StatusTemporaryRedirect, destination)
}