1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 window.SessionDB = function(rhosts) {
8 remoteHosts: rhosts || [],
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)
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) {
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 document.location = baseURL + 'login?return_to=' + encodeURIComponent(document.location.href.replace(/\?.*/, '')+'?baseURL='+encodeURIComponent(baseURL)) + '&api_token='+encodeURIComponent(token)
97 document.location = baseURL + 'login?return_to=' + encodeURIComponent(document.location.href.replace(/\?.*/, '')+'?baseURL='+encodeURIComponent(baseURL))
102 logout: function(k) {
103 // Forget the token, but leave the other info in the db so
104 // the user can log in again without providing the login
106 var sessions = db.loadAll()
107 delete sessions[k].token
108 db.save(k, sessions[k])
110 saltedToken: function(uuid_prefix) {
111 // Takes a cluster UUID prefix and returns a salted token to allow
112 // log into said cluster using federated identity.
113 var session = db.loadLocal()
114 return db.request(session, '/arvados/v1/api_client_authorizations', {
116 filters: JSON.stringify([['api_token', '=', session.token]]),
118 }).then(function(resp) {
119 if (resp.items.length == 1) {
120 var token_uuid = resp.items[0].uuid
121 if (token_uuid.length !== '') {
122 var shaObj = new jsSHA("SHA-1", "TEXT")
123 shaObj.setHMACKey(session.token, "TEXT")
124 shaObj.update(uuid_prefix)
125 var hmac = shaObj.getHMAC("HEX")
126 return 'v2/' + token_uuid + '/' + hmac
127 } else { return null }
129 }).catch(function(err) { return null })
131 checkForNewToken: function() {
132 // If there's a token and baseURL in the location bar (i.e.,
133 // we just landed here after a successful login), save it and
134 // scrub the location bar.
135 if (document.location.search[0] != '?')
138 document.location.search.slice(1).split('&').map(function(kv) {
139 var e = kv.indexOf('=')
142 params[decodeURIComponent(kv.slice(0, e))] = decodeURIComponent(kv.slice(e+1))
144 if (!params.baseURL || !params.api_token)
145 // Have a query string, but it's not a login callback.
147 params.token = params.api_token
148 delete params.api_token
149 db.save(params.baseURL, params)
150 history.replaceState({}, '', document.location.origin + document.location.pathname)
152 fillMissingUUIDs: function() {
153 var sessions = db.loadAll()
154 Object.keys(sessions).map(function(key) {
155 if (key.indexOf('://') < 0)
157 // key is the baseURL placeholder. We need to get our user
158 // record to find out the cluster's real uuid prefix.
159 var session = sessions[key]
160 m.request(session.baseURL+'arvados/v1/users/current', {
162 authorization: 'OAuth2 '+session.token,
164 }).then(function(user) {
166 db.save(user.owner_uuid.slice(0, 5), session)
171 // Return the Workbench base URL advertised by the session's
172 // API server, or a reasonable guess, or (if neither strategy
174 workbenchBaseURL: function(session) {
175 var dd = db.discoveryDoc(session)()
177 // Don't fall back to guessing until we receive the discovery doc
180 return dd.workbenchUrl
181 // Guess workbench.{apihostport} is a Workbench... unless
182 // the host part of apihostport is an IPv4 or [IPv6]
184 if (!session.baseURL.match('://(\\[|\\d+\\.\\d+\\.\\d+\\.\\d+[:/])')) {
185 var wbUrl = session.baseURL.replace('://', '://workbench.')
186 // Remove the trailing slash, if it's there.
187 return wbUrl.slice(-1) == '/' ? wbUrl.slice(0, -1) : wbUrl
191 // Return a m.stream that will get fulfilled with the
192 // discovery doc from a session's API server.
193 discoveryDoc: function(session) {
194 var cache = db.discoveryCache[session.baseURL]
196 db.discoveryCache[session.baseURL] = cache = m.stream()
197 m.request(session.baseURL+'discovery/v1/apis/arvados/v1/rest').then(cache)
201 request: function(session, path, opts) {
203 opts.headers = opts.headers || {}
204 opts.headers.authorization = 'OAuth2 '+ session.token
205 return m.request(session.baseURL + path, opts)