forked from markbates/goth
/
linkedin.go
278 lines (236 loc) · 7.62 KB
/
linkedin.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
// Package linkedin implements the OAuth2 protocol for authenticating users through Linkedin.
package linkedin
import (
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"github.com/chenarmy/goth"
"golang.org/x/oauth2"
)
// more details about linkedin fields:
// User Profile and Email Address - https://docs.microsoft.com/en-gb/linkedin/consumer/integrations/self-serve/sign-in-with-linkedin
// User Avatar - https://docs.microsoft.com/en-gb/linkedin/shared/references/v2/digital-media-asset
const (
authURL string = "https://www.linkedin.com/oauth/v2/authorization"
tokenURL string = "https://www.linkedin.com/oauth/v2/accessToken"
//userEndpoint requires scope "r_liteprofile"
userEndpoint string = "//api.linkedin.com/v2/me?projection=(id,firstName,lastName,profilePicture(displayImage~:playableStreams))"
//emailEndpoint requires scope "r_emailaddress"
emailEndpoint string = "//api.linkedin.com/v2/emailAddress?q=members&projection=(elements*(handle~))"
)
// New creates a new linkedin provider, and sets up important connection details.
// You should always call `linkedin.New` to get a new Provider. Never try to create
// one manually.
func New(clientKey, secret, callbackURL string, scopes ...string) *Provider {
p := &Provider{
ClientKey: clientKey,
Secret: secret,
CallbackURL: callbackURL,
providerName: "linkedin",
}
p.config = newConfig(p, scopes)
return p
}
// Provider is the implementation of `goth.Provider` for accessing Linkedin.
type Provider struct {
ClientKey string
Secret string
CallbackURL string
HTTPClient *http.Client
config *oauth2.Config
providerName string
}
// Name is the name used to retrieve this provider later.
func (p *Provider) Name() string {
return p.providerName
}
// SetName is to update the name of the provider (needed in case of multiple providers of 1 type)
func (p *Provider) SetName(name string) {
p.providerName = name
}
// Client returns an HTTPClientWithFallback
func (p *Provider) Client() *http.Client {
return goth.HTTPClientWithFallBack(p.HTTPClient)
}
// Debug is a no-op for the linkedin package.
func (p *Provider) Debug(debug bool) {}
// BeginAuth asks Linkedin for an authentication end-point.
func (p *Provider) BeginAuth(state string) (goth.Session, error) {
url := p.config.AuthCodeURL(state)
session := &Session{
AuthURL: url,
}
return session, nil
}
// FetchUser will go to Linkedin and access basic information about the user.
func (p *Provider) FetchUser(session goth.Session) (goth.User, error) {
s := session.(*Session)
user := goth.User{
AccessToken: s.AccessToken,
Provider: p.Name(),
ExpiresAt: s.ExpiresAt,
}
if user.AccessToken == "" {
// data is not yet retrieved since accessToken is still empty
return user, fmt.Errorf("%s cannot get user information without accessToken", p.providerName)
}
// create request for user r_liteprofile
req, err := http.NewRequest("GET", "", nil)
if err != nil {
return user, err
}
// add url as opaque to avoid escaping of "("
req.URL = &url.URL{
Scheme: "https",
Host: "api.linkedin.com",
Opaque: userEndpoint,
}
req.Header.Set("Authorization", "Bearer "+s.AccessToken)
resp, err := p.Client().Do(req)
if err != nil {
return user, err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return user, fmt.Errorf("%s responded with a %d trying to fetch user profile", p.providerName, resp.StatusCode)
}
// read r_liteprofile information
err = userFromReader(resp.Body, &user)
if err != nil {
return user, err
}
// create request for user r_emailaddress
reqEmail, err := http.NewRequest("GET", "", nil)
if err != nil {
return user, err
}
// add url as opaque to avoid escaping of "("
reqEmail.URL = &url.URL{
Scheme: "https",
Host: "api.linkedin.com",
Opaque: emailEndpoint,
}
reqEmail.Header.Set("Authorization", "Bearer "+s.AccessToken)
respEmail, err := p.Client().Do(reqEmail)
if err != nil {
return user, err
}
defer respEmail.Body.Close()
if respEmail.StatusCode != http.StatusOK {
return user, fmt.Errorf("%s responded with a %d trying to fetch user email", p.providerName, respEmail.StatusCode)
}
// read r_emailaddress information
err = emailFromReader(respEmail.Body, &user)
return user, err
}
func userFromReader(reader io.Reader, user *goth.User) error {
u := struct {
ID string `json:"id"`
FirstName struct {
PreferredLocale struct {
Country string `json:"country"`
Language string `json:"language"`
} `json:"preferredLocale"`
Localized map[string]string `json:"localized"`
} `json:"firstName"`
LastName struct {
Localized map[string]string
PreferredLocale struct {
Country string `json:"country"`
Language string `json:"language"`
} `json:"preferredLocale"`
} `json:"lastName"`
ProfilePicture struct {
DisplayImage struct {
Elements []struct {
AuthorizationMethod string `json:"authorizationMethod"`
Identifiers []struct {
Identifier string `json:"identifier"`
IdentifierType string `json:"identifierType"`
} `json:"identifiers"`
} `json:"elements"`
} `json:"displayImage~"`
} `json:"profilePicture"`
}{}
err := json.NewDecoder(reader).Decode(&u)
if err != nil {
return err
}
user.FirstName = u.FirstName.Localized[u.FirstName.PreferredLocale.Language+"_"+u.FirstName.PreferredLocale.Country]
user.LastName = u.LastName.Localized[u.LastName.PreferredLocale.Language+"_"+u.LastName.PreferredLocale.Country]
user.Name = user.FirstName + " " + user.LastName
user.NickName = user.FirstName
user.UserID = u.ID
avatarURL := ""
// loop all displayimage elements
for _, element := range u.ProfilePicture.DisplayImage.Elements {
// only retrieve data where the authorization method allows public (unauthorized) access
if element.AuthorizationMethod == "PUBLIC" {
for _, identifier := range element.Identifiers {
// check to ensure the identifer type is a url linking to the image
if identifier.IdentifierType == "EXTERNAL_URL" {
avatarURL = identifier.Identifier
// we only need the first image url
break
}
}
}
// if we have a valid image, exit the loop as we only support a single avatar image
if len(avatarURL) > 0 {
break
}
}
user.AvatarURL = avatarURL
return err
}
func emailFromReader(reader io.Reader, user *goth.User) error {
e := struct {
Elements []struct {
Handle struct {
EmailAddress string `json:"emailAddress"`
} `json:"handle~"`
} `json:"elements"`
}{}
err := json.NewDecoder(reader).Decode(&e)
if err != nil {
return err
}
if len(e.Elements) > 0 {
user.Email = e.Elements[0].Handle.EmailAddress
}
if len(user.Email) == 0 {
return errors.New("Unable to retrieve email address")
}
return err
}
func newConfig(provider *Provider, scopes []string) *oauth2.Config {
c := &oauth2.Config{
ClientID: provider.ClientKey,
ClientSecret: provider.Secret,
RedirectURL: provider.CallbackURL,
Endpoint: oauth2.Endpoint{
AuthURL: authURL,
TokenURL: tokenURL,
},
Scopes: []string{},
}
if len(scopes) == 0 {
// add helper as new API requires the scope to be specified and these are the minimum to retrieve profile information and user's email address
scopes = append(scopes, "r_liteprofile", "r_emailaddress")
}
for _, scope := range scopes {
c.Scopes = append(c.Scopes, scope)
}
return c
}
//RefreshToken refresh token is not provided by linkedin
func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error) {
return nil, errors.New("Refresh token is not provided by linkedin")
}
//RefreshTokenAvailable refresh token is not provided by linkedin
func (p *Provider) RefreshTokenAvailable() bool {
return false
}