-
Notifications
You must be signed in to change notification settings - Fork 125
/
authenticate.js
225 lines (194 loc) · 6.15 KB
/
authenticate.js
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
'use strict'
const open = require('open')
const path = require('path')
const fs = require('fs')
const { promisify } = require('util')
const { homedir } = require('os')
const randtoken = require('rand-token')
const websocket = require('websocket-stream')
const split2 = require('split2')
const { ReadableStreamBuffer } = require('stream-buffers')
const { URL } = require('url')
const pump = require('pump')
const jwt = require('jsonwebtoken')
const unlink = promisify(fs.unlink)
const readFile = promisify(fs.readFile)
const writeFile = promisify(fs.writeFile)
const credentialsPath = process.env.CLINIC_CREDENTIALS ||
path.join(homedir(), '.node-clinic-rc')
const CUSTOM_CLAIM_NAMESPACE = 'https://upload.clinicjs.org/'
const ASK_CLAIM_KEY = `${CUSTOM_CLAIM_NAMESPACE}askTermsAccepted`
/**
* Load the JWT for an Upload Server URL.
*/
async function loadToken (url) {
let tokens
try {
const data = await readFile(credentialsPath)
tokens = JSON.parse(data)
} catch (err) {}
return tokens && tokens[url]
}
/**
* Check that a JWT has not expired.
*/
function validateToken (token) {
const header = jwt.decode(token)
const now = Math.floor(Date.now() / 1000)
return header && header.exp > now
}
/**
* Check that a JWT has Ask terms accepted.
*/
function validateAskPermission (token) {
const header = jwt.decode(token)
return validateToken(token) && header[ASK_CLAIM_KEY]
}
/**
* Get the session data for an Upload Server URL.
*/
async function getSession (url) {
const token = await loadToken(url)
if (!token) return null
const header = jwt.decode(token)
if (!header) return null
const now = Math.floor(Date.now() / 1000)
if (header.exp <= now) return null
return header
}
/**
* Store the JWT for an Upload Server URL in the credentials file.
*/
async function saveToken (url, token) {
let tokens
try {
const data = await readFile(credentialsPath)
tokens = JSON.parse(data)
} catch (err) {}
// if it was empty or contained `null` for some reason
if (typeof tokens !== 'object' || !tokens) {
tokens = {}
}
tokens[url] = token
await writeFile(credentialsPath, JSON.stringify(tokens, null, 2))
}
/**
* Get the JWT token from the Upload server specified by the URL.
* - create a random tokens
* - open a websocket on the server
* - push the token through the websocket
* - Open the browser on `http://localhost:3000/auth/token/${cliToken}/(?ask=1)(&private=1)`
* - Get the JWT from the web websocket
*/
function authenticateViaBrowser (url, isAskFlow = false, isPrivate = false, clearSession = false) {
return new Promise((resolve, reject) => {
const cliToken = randtoken.generate(128)
const parsedURL = new URL(url)
/* istanbul ignore next */
parsedURL.protocol = url && url.toLowerCase().includes('https') ? 'wss:/' : 'ws:/'
const wsUrl = parsedURL.toString()
const ws = websocket(wsUrl)
const readBuffer = new ReadableStreamBuffer()
readBuffer.put(cliToken)
pump(readBuffer, ws, split2(), err => err ? reject(err) : /* istanbul ignore next */ null)
.on('data', (authToken) => {
let err
if (!authToken) {
err = new Error('Authentication failed. No token obtained.')
} else if (typeof authToken === 'string' && authToken.toLowerCase() === 'timeout') {
err = new Error('Authentication timed out.')
}
err ? reject(err) : resolve(authToken)
ws.destroy()
})
ws.once('connect', () => {
const cliLoginUrl = generateBrowserLoginUrl(url, cliToken, {
isAskFlow,
isPrivate,
clearSession
})
if (process.env.SSH_CLIENT || process.env.SSH_TTY) {
console.log('Authentication required. Please visit this URL to sign in:')
console.log(` ${cliLoginUrl}`)
return
}
console.log('Authentication required. Opening the login page in a browser...')
// Open the url in the default browser
open(cliLoginUrl, { url: true, wait: false }).then((child) => {
child.on('exit', (code) => {
if (code !== 0) {
console.log('Could not find a browser. Visit this URL to authenticate:')
console.log(` ${cliLoginUrl}`)
}
})
})
})
})
}
async function authenticate (url, opts = {}) {
const mockJWT = process.env.CLINIC_JWT
const mockFail = process.env.CLINIC_MOCK_AUTH_FAIL
if (mockJWT) {
// store it if we ALSO specified a credentials file,
// Normally, you shouldn't use both CLINIC_JWT and CLINIC_CREDENTIALS at the same time,
// but this is a useful case for our tests
if (process.env.CLINIC_CREDENTIALS) {
await saveToken(url, mockJWT)
}
return mockJWT
}
if (mockFail) {
throw new Error('Auth artificially failed')
}
// Use cached token if it's not expired
const existingJWT = await loadToken(url)
let clearSession = false
if (existingJWT && validateToken(existingJWT)) {
if (!opts.ask || validateAskPermission(existingJWT)) {
return existingJWT
} else if (opts.ask) {
clearSession = true
}
}
const newJWT = await authenticateViaBrowser(url, opts.ask, opts.private, clearSession)
await saveToken(url, newJWT)
return newJWT
}
async function getSessions () {
let tokens = {}
try {
const data = await readFile(credentialsPath)
tokens = JSON.parse(data)
} catch (err) {}
const sessions = {}
Object.keys(tokens).forEach((url) => {
sessions[url] = validateToken(tokens[url])
? jwt.decode(tokens[url])
: null
})
return sessions
}
function logout (url) {
return saveToken(url, undefined)
}
function removeSessions () {
return unlink(credentialsPath)
}
function generateBrowserLoginUrl (base, token, opts = {}) {
const url = new URL(`${base}/auth/token/${token}/`)
if (opts.isAskFlow) {
url.searchParams.append('ask', '1')
}
if (opts.isPrivate || opts.isAskFlow) {
url.searchParams.append('private', '1')
}
if (opts.clearSession) {
url.searchParams.append('clearSession', '1')
}
return url.toString()
}
module.exports = authenticate
module.exports.getSessions = getSessions
module.exports.getSession = getSession
module.exports.removeSessions = removeSessions
module.exports.logout = logout