/
storage.go
264 lines (227 loc) · 6.92 KB
/
storage.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
// Oauthtokens provides functions that store and retrieve tokens from the golang.org/oauth2 package.
// This package borrows from the Redis storage config created by Aaron Torres.
// https://gist.github.com/agtorre/350c5b4ce0ccebc5ac0f
package oauthpersist
import (
"database/sql"
"encoding/csv"
"errors"
"fmt"
"golang.org/x/net/context"
"golang.org/x/oauth2"
"net/http"
"os"
"path"
"time"
)
// Config combines an oauth2.Config pointer with a TokenStorage interface.
type Config struct {
*oauth2.Config
// Storage stores and retrieves tokens
Storage TokenStorage
}
// Exchange is a wrapper function for oauth2.Config.Exchange.
// Underneath the hood it calls TokenStorage.StoreToken when a valid token is exchanged.
func (c *Config) Exchange(ctx context.Context, code string) (*oauth2.Token, error) {
token, err := c.Config.Exchange(ctx, code)
if err != nil {
return nil, err
}
if err := c.Storage.StoreToken(token); err != nil {
return nil, err
}
return token, nil
}
// Client is a wrapper function for oauth2.Config.Client
func (c *Config) Client(ctx context.Context, t *oauth2.Token) *http.Client {
return oauth2.NewClient(ctx, c.TokenSource(ctx, t))
}
// TokenSource returns a ReuseTokenSource.
func (c *Config) TokenSource(ctx context.Context, t *oauth2.Token) oauth2.TokenSource {
tts := &TokenStorageSource{
source: c.Config.TokenSource(ctx, t),
config: c,
}
return oauth2.ReuseTokenSource(t, tts)
}
// TokenStorage is an interface designed to store tokens
// in a persistence layer and to recreate tokens from that persisted data.
type TokenStorage interface {
// StoreToken attempts to persist a token for future retrieval.
// If persistence is not successful it returns an error.
StoreToken(token *oauth2.Token) error
// RestoreToken returns a token from persisted data.
RestoreToken() (*oauth2.Token, error)
}
type TokenStorageSource struct {
source oauth2.TokenSource
config *Config
}
func (t *TokenStorageSource) Token() (*oauth2.Token, error) {
token, err := t.source.Token()
if err != nil {
return nil, err
}
if err := t.config.Storage.StoreToken(token); err != nil {
return nil, err
}
return token, nil
}
// FileTokenStorage stores tokens in csv files
type FileTokenStorage struct {
// StoragePath is the folder path where the token file will be stored.
StoragePath string
// TokenId is a unique identifier for a token, usually a user id.
TokenId interface{}
}
// FileTokenStorage.StoreToken saves a token as a csv file
func (store *FileTokenStorage) StoreToken(token *oauth2.Token) error {
if store.StoragePath == "" {
return errors.New("Cannot store token: StoragePath not set.")
}
tokenIdStr := fmt.Sprint(store.TokenId)
if store.TokenId == nil || tokenIdStr == "" {
return errors.New("Cannot store token: TokenId not set.")
}
filename := path.Join(store.StoragePath, tokenIdStr+".csv")
f, err := os.Create(filename)
if err != nil {
return err
}
record := []string{token.AccessToken, token.RefreshToken, token.Expiry.String(), token.TokenType}
w := csv.NewWriter(f)
if err = w.Write(record); err != nil {
return err
}
w.Flush()
if err := w.Error(); err != nil {
return err
}
return nil
}
// FileTokenStorage.RestoreToken returns an oauth2.Token from a file.
func (store *FileTokenStorage) RestoreToken() (*oauth2.Token, error) {
if store.StoragePath == "" {
return nil, errors.New("Cannot restore token: StoragePath not set.")
}
tokenIdStr := fmt.Sprint(store.TokenId)
if store.TokenId == nil || tokenIdStr == "" {
return nil, errors.New("Cannot restore token: TokenId not set.")
}
filename := path.Join(store.StoragePath, tokenIdStr+".csv")
f, err := os.Open(filename)
if err != nil {
return nil, err
}
defer f.Close()
r := csv.NewReader(f)
record, err := r.Read()
if err != nil {
return nil, err
}
if len(record) < 4 {
return nil, errors.New("Cannot restore token: File does not contain all fields.")
}
expiry, err := time.Parse("2006-01-02 15:04:05.999999999 -0700 MST", record[2])
if err != nil {
return nil, err
}
token := &oauth2.Token{
AccessToken: record[0],
RefreshToken: record[1],
Expiry: expiry,
TokenType: record[3],
}
return token, nil
}
// FileTokenStorage.RestoreToken returns an oauth2.Token from a file.
func (store *FileTokenStorage) DeleteToken() error {
if store.StoragePath == "" {
return errors.New("Cannot delete token: StoragePath not set.")
}
tokenIdStr := fmt.Sprint(store.TokenId)
if store.TokenId == nil || tokenIdStr == "" {
return errors.New("Cannot delete token: TokenId not set.")
}
filename := path.Join(store.StoragePath, tokenIdStr+".csv")
return os.Remove(filename)
}
// SQLTokenStorage stores tokens in using an sql.DB files
type SQLTokenStorage struct {
// Database which will store the token.
// Assumed to have a table named oauth2_tokens with the following fields:
// - id
// - access_token
// - refresh_token
// - expiry
// - token_type
*sql.DB
// Unique identifier for a token, usually a user id.
// Required for ReadToken and DestroyToken. If nil for StoreToken, auto-generation assumed.
ID interface{}
// todo add table prefix.
}
// SQLTokenStorage.StoreToken saves a token into an SQL DB
func (store *SQLTokenStorage) StoreToken(token *oauth2.Token) error {
// If nil assume auto-increment.
if store.ID == nil {
res, err := store.DB.Exec(
"INSERT INTO oauth2_tokens (access_token, refresh_token, expiry, token_type) "+
"VALUES($1, $2, $3, $4)",
token.AccessToken,
token.RefreshToken,
token.Expiry,
token.TokenType,
)
if err != nil {
return err
}
id, err := res.LastInsertId()
if err != nil {
return err
}
store.ID = id
return err
}
_, err := store.DB.Exec(
"INSERT OR REPLACE INTO oauth2_tokens (id, access_token, refresh_token, expiry, token_type) "+
"VALUES($1, $2, $3, $4, $5)",
store.ID,
token.AccessToken,
token.RefreshToken,
token.Expiry,
token.TokenType,
)
return err
}
// SQLTokenStorage.RestoreToken returns an oauth2.Token from a DB.
func (store *SQLTokenStorage) RestoreToken() (*oauth2.Token, error) {
if store.ID == nil {
return nil, fmt.Errorf("SQLTokenStorage.RestoreToken requires the SQLTokenStorage.TokenID to be set.")
}
row := store.DB.QueryRow("SELECT access_token, refresh_token, expiry, token_type "+
"FROM oauth2_tokens WHERE id = $1", store.ID)
var accessToken string
var refreshToken string
var expiry time.Time
var tokenType string
err := row.Scan(&accessToken, &refreshToken, &expiry, &tokenType)
if err != nil {
return nil, err
}
token := &oauth2.Token{
AccessToken: accessToken,
RefreshToken: refreshToken,
Expiry: expiry,
TokenType: tokenType,
}
return token, nil
}
// SQLTokenStorage.DeleteToken returns an oauth2.Token from a file.
func (store *SQLTokenStorage) DeleteToken() error {
if store.ID == nil {
return fmt.Errorf("SQLTokenStorage.DeleteToken requires the SQLTokenStorage.TokenID to be set.")
}
_, err := store.DB.Exec("DELETE FROM oauth2_tokens WHERE id = $1", store.ID)
return err
}