1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 window.SessionDB = function() {
10 loadFromLocalStorage: function() {
12 return JSON.parse(window.localStorage.getItem('sessions')) || {}
17 var all = db.loadFromLocalStorage()
18 if (window.defaultSession) {
19 window.defaultSession.isFromRails = true
20 all[window.defaultSession.user.uuid.slice(0, 5)] = window.defaultSession
24 loadActive: function() {
25 var sessions = db.loadAll()
26 Object.keys(sessions).forEach(function(key) {
27 if (!sessions[key].token || !sessions[key].user.is_active)
32 loadLocal: function() {
33 var sessions = db.loadActive()
35 Object.values(sessions).forEach(function(session) {
36 if (session.isFromRails) {
43 save: function(k, v) {
44 var sessions = db.loadAll()
46 Object.keys(sessions).forEach(function(key) {
47 if (sessions[key].isFromRails)
50 window.localStorage.setItem('sessions', JSON.stringify(sessions))
53 var sessions = db.loadAll()
55 window.localStorage.setItem('sessions', JSON.stringify(sessions))
57 findAPI: function(url) {
58 // Given a Workbench or API host or URL, return a promise
59 // for the corresponding API server's base URL. Typical
61 // sessionDB.findAPI('https://workbench.example/foo').then(sessionDB.login)
62 if (url.indexOf('://') < 0)
63 url = 'https://' + url
65 return m.request(url.origin + '/discovery/v1/apis/arvados/v1/rest').then(function() {
66 return url.origin + '/'
67 }).catch(function(err) {
68 // If url is a Workbench site (and isn't too old),
69 // /status.json will tell us its API host.
70 return m.request(url.origin + '/status.json').then(function(resp) {
72 throw 'no apiBaseURL in status response'
73 return resp.apiBaseURL
77 login: function(baseURL, fallbackLogin = true) {
78 // Initiate login procedure with given API base URL (e.g.,
79 // "http://api.example/").
81 // Any page that has a button that invokes login() must
82 // also call checkForNewToken() on (at least) its first
83 // render. Otherwise, the login procedure can't be
85 var session = db.loadLocal()
86 var uuidPrefix = session.user.owner_uuid.slice(0, 5)
87 var apiHostname = new URL(session.baseURL).hostname
88 m.request(baseURL+'discovery/v1/apis/arvados/v1/rest').then(function(dd) {
89 if (uuidPrefix in dd.remoteHosts ||
90 (dd.remoteHostsViaDNS && apiHostname.indexOf('arvadosapi.com') >= 0)) {
91 // Federated identity login via salted token
92 db.saltedToken(dd.uuidPrefix).then(function(token) {
93 m.request(baseURL+'arvados/v1/users/current', {
95 authorization: 'Bearer '+token,
97 }).then(function(user) {
103 db.save(user.owner_uuid.slice(0, 5), remoteSession)
106 } else if (fallbackLogin) {
108 document.location = baseURL + 'login?return_to=' + encodeURIComponent(document.location.href.replace(/\?.*/, '')+'?baseURL='+encodeURIComponent(baseURL))
113 logout: function(k) {
114 // Forget the token, but leave the other info in the db so
115 // the user can log in again without providing the login
117 var sessions = db.loadAll()
118 delete sessions[k].token
119 db.save(k, sessions[k])
121 saltedToken: function(uuid_prefix) {
122 // Takes a cluster UUID prefix and returns a salted token to allow
123 // log into said cluster using federated identity.
124 var session = db.loadLocal()
125 return db.tokenUUID().then(function(token_uuid){
126 var shaObj = new jsSHA("SHA-1", "TEXT")
127 shaObj.setHMACKey(session.token, "TEXT")
128 shaObj.update(uuid_prefix)
129 var hmac = shaObj.getHMAC("HEX")
130 return 'v2/' + token_uuid + '/' + hmac
133 checkForNewToken: function() {
134 // If there's a token and baseURL in the location bar (i.e.,
135 // we just landed here after a successful login), save it and
136 // scrub the location bar.
137 if (document.location.search[0] != '?')
140 document.location.search.slice(1).split('&').map(function(kv) {
141 var e = kv.indexOf('=')
144 params[decodeURIComponent(kv.slice(0, e))] = decodeURIComponent(kv.slice(e+1))
146 if (!params.baseURL || !params.api_token)
147 // Have a query string, but it's not a login callback.
149 params.token = params.api_token
150 delete params.api_token
151 db.save(params.baseURL, params)
152 history.replaceState({}, '', document.location.origin + document.location.pathname)
154 fillMissingUUIDs: function() {
155 var sessions = db.loadAll()
156 Object.keys(sessions).map(function(key) {
157 if (key.indexOf('://') < 0)
159 // key is the baseURL placeholder. We need to get our user
160 // record to find out the cluster's real uuid prefix.
161 var session = sessions[key]
162 m.request(session.baseURL+'arvados/v1/users/current', {
164 authorization: 'OAuth2 '+session.token,
166 }).then(function(user) {
168 db.save(user.owner_uuid.slice(0, 5), session)
173 // Return the Workbench base URL advertised by the session's
174 // API server, or a reasonable guess, or (if neither strategy
176 workbenchBaseURL: function(session) {
177 var dd = db.discoveryDoc(session)()
179 // Don't fall back to guessing until we receive the discovery doc
182 return dd.workbenchUrl
183 // Guess workbench.{apihostport} is a Workbench... unless
184 // the host part of apihostport is an IPv4 or [IPv6]
186 if (!session.baseURL.match('://(\\[|\\d+\\.\\d+\\.\\d+\\.\\d+[:/])')) {
187 var wbUrl = session.baseURL.replace('://', '://workbench.')
188 // Remove the trailing slash, if it's there.
189 return wbUrl.slice(-1) == '/' ? wbUrl.slice(0, -1) : wbUrl
193 // Return a m.stream that will get fulfilled with the
194 // discovery doc from a session's API server.
195 discoveryDoc: function(session) {
196 var cache = db.discoveryCache[session.baseURL]
198 db.discoveryCache[session.baseURL] = cache = m.stream()
199 m.request(session.baseURL+'discovery/v1/apis/arvados/v1/rest').then(cache)
203 // Return a promise with the local session token's UUID from the API server.
204 tokenUUID: function() {
205 var cache = db.tokenUUIDCache
207 var session = db.loadLocal()
208 return db.request(session, '/arvados/v1/api_client_authorizations', {
210 filters: JSON.stringify([['api_token', '=', session.token]]),
212 }).then(function(resp) {
213 var uuid = resp.items[0].uuid
214 db.tokenUUIDCache = uuid
218 return new Promise(function(resolve, reject) {
223 request: function(session, path, opts) {
225 opts.headers = opts.headers || {}
226 opts.headers.authorization = 'OAuth2 '+ session.token
227 return m.request(session.baseURL + path, opts)
229 // Check non-federated remote active sessions if they should be migrated to
231 migrateNonFederatedSessions: function() {
232 var sessions = db.loadActive()
233 Object.keys(sessions).map(function(uuidPrefix) {
234 session = sessions[uuidPrefix]
235 if (!session.isFromRails && session.token && session.token.indexOf('v2/') < 0) {
236 // Only try the federated login
237 db.login(session.baseURL, false)
241 // If remoteHosts is listed on the local API discovery doc, try to add any
242 // listed remote without an active session.
243 autoLoadRemoteHosts: function() {
244 var activeSessions = db.loadActive()
245 var doc = db.discoveryDoc(db.loadLocal())
246 doc.map(function(d) {
247 // NOTE: the below line is to simulate that 9tee4 is included as a remote host
248 // the current test cluster
249 // d.remoteHosts = {"9tee4":"9tee4.arvadosapi.com"}
250 Object.keys(d.remoteHosts).map(function(uuidPrefix) {
251 if (!(uuidPrefix in Object.keys(activeSessions))) {
252 db.findAPI(d.remoteHosts[uuidPrefix]).then(function(baseURL) {
253 db.login(baseURL, false)