Rename DiscoverProviderRequest to SelectProviderRequest

Author: dmitrizagidulin

.gitignore

@@ -3,16 +3,16 @@ node_modules/
 *.swp
 .tern-port
 npm-debug.log
-config/account-template
-config/email-templates
-accounts
-profile
-inbox
-.acl
-config.json
-config/templates
-config/views
-settings
-.db/
+/config/account-template
+/config/email-templates
+/accounts
+/profile
+/inbox
+/.acl
+/config.json
+/config/templates
+/config/views
+/settings
+/.db
 .nyc_output
 coverage

default-views/auth/consent.hbs

@@ -5,7 +5,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>{{title}}</title>
   <!-- Bootstrap CSS and Theme for demo purposes -->
-  <link rel="stylesheet" href="/css/bootstrap-3.3.6.min.css">
+  <link rel="stylesheet" href="/common/css/bootstrap.min.css">
   <style>
     .title { margin-top: 2em; margin-bottom: 2em; }
     #authorize { margin-right: 2em; }

default-views/auth/select-provider.hbs

@@ -13,7 +13,7 @@
   </div>
 </div>
 <div class="container">
-  <form method="post" action="/api/auth/discover">
+  <form method="post" action="/api/auth/select-provider">
     <div class="form-group">
       <label for="webid">WebID or server URL:</label>
       <input type="text" class="form-control" name="webid" id="webid" placeholder="databox.me" />

lib/api/authn/webid-oidc.js

@@ -9,7 +9,7 @@ const util = require('../../utils')
 const error = require('../../http-error')
 const bodyParser = require('body-parser').urlencoded({ extended: false })
 
-const DiscoverProviderRequest = require('../../requests/discover-provider-request')
+const SelectProviderRequest = require('../../requests/select-provider-request')
 
 const { LoginByPasswordRequest } = require('../../requests/login-request')
 
@@ -35,10 +35,10 @@ function middleware (oidc) {
   const router = express.Router('/')
 
   // User-facing Authentication API
-  router.get('/api/auth/discover', (req, res) => {
-    res.render('auth/select-provider')
+  router.get('/api/auth/select-provider', (req, res) => {
+    res.render('auth/select-provider', {})
   })
-  router.post('/api/auth/discover', bodyParser, discoverProvider)
+  router.post('/api/auth/select-provider', bodyParser, selectProvider)
 
   router.post(['/login', '/signin'], bodyParser, login)
 
@@ -70,8 +70,8 @@ function middleware (oidc) {
   return router
 }
 
-function discoverProvider (req, res, next) {
-  return DiscoverProviderRequest.handle(req, res)
+function selectProvider (req, res, next) {
+  return SelectProviderRequest.handle(req, res)
     .catch(error => {
       error.status = error.status || 400
       next(error)
@@ -151,7 +151,7 @@ function resumeUserFlow (req, res) {
 
 module.exports = {
   middleware,
-  discoverProvider,
+  selectProvider,
   login,
   extractWebId,
   authCodeFlowCallback,

lib/create-app.js

@@ -210,7 +210,7 @@ function initAuthentication (argv, app) {
       app.use('/', express.static(path.join(__dirname, '../static/oidc')))
 
       // Initialize the WebId-OIDC authentication routes/api, including:
-      // user-facing Solid endpoints (/login, /logout, /api/auth/discover)
+      // user-facing Solid endpoints (/login, /logout, /api/auth/select-provider)
       // and OIDC-specific ones
       app.use('/', API.oidc.middleware(oidc))
 

lib/handlers/error-pages.js

@@ -66,7 +66,7 @@ function redirectToLogin (req, res) {
   var currentUrl = util.fullUrlForReq(req)
   req.session.returnToUrl = currentUrl
   let locals = req.app.locals
-  let loginUrl = locals.host.serverUri + '/api/auth/discover?returnToUrl=' +
+  let loginUrl = locals.host.serverUri + '/api/auth/select-provider?returnToUrl=' +
       currentUrl
   debug('Redirecting to login: ' + loginUrl)
 

lib/models/oidc-manager.js

@@ -32,6 +32,7 @@ function fromServerConfig (argv) {
   let postLogoutUri = url.resolve(providerUri, '/goodbye')
 
   let options = {
+    debug,
     providerUri,
     dbPath: argv.dbPath || './db/oidc',
     authCallbackUri,

lib/requests/discover-provider-request.js lib/requests/select-provider-request.jslib/requests/discover-provider-request.js renamed to lib/requests/select-provider-request.js

@@ -4,7 +4,7 @@ const validUrl = require('valid-url')
 const fetch = require('node-fetch')
 const li = require('li')
 
-class DiscoverProviderRequest {
+class SelectProviderRequest {
   /**
    * @constructor
    *
@@ -47,19 +47,19 @@ class DiscoverProviderRequest {
 
   /**
    * Factory method, creates and returns an initialized and validated instance
-   * of DiscoverProviderRequest from a submitted POST form.
+   * of SelectProviderRequest from a submitted POST form.
    *
    * @param [req] {HttpRequest}
    * @param [req.body.webid] {string}
    * @param [res] {HttpResponse}
    *
    * @throws {TypeError} HTTP 400 if required parameters are missing
    *
-   * @return {DiscoverProviderRequest}
+   * @return {SelectProviderRequest}
    */
   static fromParams (req = {}, res = {}) {
     let body = req.body || {}
-    let webId = DiscoverProviderRequest.normalizeUri(body.webid)
+    let webId = SelectProviderRequest.normalizeUri(body.webid)
 
     let oidcManager
     if (req.app && req.app.locals) {
@@ -68,7 +68,7 @@ class DiscoverProviderRequest {
 
     let options = { webId, oidcManager, response: res, session: req.session }
 
-    let request = new DiscoverProviderRequest(options)
+    let request = new SelectProviderRequest(options)
     request.validate()
 
     return request
@@ -95,11 +95,11 @@ class DiscoverProviderRequest {
   }
 
   /**
-   * Handles the Discover Provider request. Usage:
+   * Handles the Select Provider request. Usage:
    *
    *   ```
-   *   app.post('/api/auth/discover', bodyParser, (req, res, next) => {
-   *     return DiscoverProviderRequest.handle(req, res)
+   *   app.post('/api/auth/select-provider', bodyParser, (req, res, next) => {
+   *     return SelectProviderRequest.handle(req, res)
    *       .catch(next)
    *   })
    *   ```
@@ -113,12 +113,12 @@ class DiscoverProviderRequest {
     let request
 
     try {
-      request = DiscoverProviderRequest.fromParams(req, res)
+      request = SelectProviderRequest.fromParams(req, res)
     } catch (error) {
       return Promise.reject(error)
     }
 
-    return request.discoverProvider()
+    return request.selectProvider()
   }
 
   /**
@@ -130,7 +130,7 @@ class DiscoverProviderRequest {
    *
    * @return {Promise}
    */
-  discoverProvider () {
+  selectProvider () {
     return this.fetchProviderUri()
       .then(this.authUrlFor.bind(this))
       .then(authUrl => {
@@ -227,4 +227,4 @@ class DiscoverProviderRequest {
   }
 }
 
-module.exports = DiscoverProviderRequest
+module.exports = SelectProviderRequest

test/integration/authentication-oidc.js

@@ -15,13 +15,16 @@ describe('Authentication API (OIDC)', () => {
 
   let aliceServerUri = 'https://localhost:7000'
   let aliceWebId = 'https://localhost:7000/profile/card#me'
-  let aliceDbPath = path.join(__dirname, '../resources/db/alice')
+  let configPath = path.join(__dirname, '../../config')
+  let aliceDbPath = path.join(__dirname,
+    '../resources/accounts-scenario/alice/db/oidc')
   let userStorePath = path.join(aliceDbPath, 'users')
   let aliceUserStore = UserStore.from({ path: userStorePath, saltRounds: 1 })
   aliceUserStore.initCollections()
 
   let bobServerUri = 'https://localhost:7001'
-  let bobDbPath = path.join(__dirname, '../resources/db/bob')
+  let bobDbPath = path.join(__dirname,
+    '../resources/accounts-scenario/bob/db/oidc')
 
   const serverConfig = {
     sslKey: path.join(__dirname, '../keys/key.pem'),
@@ -30,7 +33,8 @@ describe('Authentication API (OIDC)', () => {
     dataBrowser: false,
     fileBrowser: false,
     webid: true,
-    idp: false
+    idp: false,
+    configPath
   }
 
   const alicePod = Solid.createServer(
@@ -67,25 +71,23 @@ describe('Authentication API (OIDC)', () => {
   after(() => {
     if (aliceServer) aliceServer.close()
     if (bobServer) bobServer.close()
-    // fs.removeSync(aliceDbPath)
-    // fs.removeSync(bobDbPath)
   })
 
-  describe('Provider Discovery (POST /api/auth/discover)', () => {
+  describe('Provider Discovery (POST /api/auth/select-provider)', () => {
     it('form should load on a get', done => {
-      alice.get('/api/auth/discover')
+      alice.get('/api/auth/select-provider')
         .expect(200)
         .expect((res) => { res.text.match(/Provider Discovery/) })
         .end(done)
     })
 
     it('should complain if WebID URI is missing', (done) => {
-      alice.post('/api/auth/discover')
+      alice.post('/api/auth/select-provider')
         .expect(400, done)
     })
 
     it('should prepend https:// to webid, if necessary', (done) => {
-      alice.post('/api/auth/discover')
+      alice.post('/api/auth/select-provider')
         .type('form')
         .send({ webid: 'localhost:7000' })
         .expect(302, done)
@@ -95,14 +97,14 @@ describe('Authentication API (OIDC)', () => {
       // Fake provider, replies with 200 and no Link headers
       nock('https://amazingwebsite.tld').intercept('/', 'OPTIONS').reply(204)
 
-      alice.post('/api/auth/discover')
+      alice.post('/api/auth/select-provider')
         .send('webid=https://amazingwebsite.tld/')
         .expect(400)
         .end(done)
     })
 
     it('should redirect user to discovered provider if valid uri', (done) => {
-      bob.post('/api/auth/discover')
+      bob.post('/api/auth/select-provider')
         .send('webid=' + aliceServerUri)
         .expect(302)
         .end((err, res) => {
@@ -126,7 +128,7 @@ describe('Authentication API (OIDC)', () => {
     })
 
     afterEach(() => {
-      fs.removeSync(aliceDbPath)
+      fs.removeSync(path.join(aliceDbPath, 'users/*'))
     })
 
     it('should login and be redirected to /authorize', (done) => {
@@ -175,15 +177,15 @@ describe('Authentication API (OIDC)', () => {
         .end((err, res) => {
           if (err) return done(err)
           let redirectString = 'http-equiv="refresh" ' +
-            `content="0; url=${bobServerUri}/api/auth/discover`
+            `content="0; url=${bobServerUri}/api/auth/select-provider`
           expect(res.text).to.match(new RegExp(redirectString))
           done()
         })
     })
 
     // Step 2: Alice enters her WebID URI to the Provider Discovery endpoint
     it('Enter webId -> redirect to provider login', (done) => {
-      bob.post('/api/auth/discover')
+      bob.post('/api/auth/select-provider')
         .send('webid=' + aliceServerUri)
         .expect(302)
         .end((err, res) => {

test/unit/discover-provider-request.js test/unit/select-provider-request.jstest/unit/discover-provider-request.js renamed to test/unit/select-provider-request.js

@@ -4,30 +4,30 @@ const chai = require('chai')
 const expect = chai.expect
 const HttpMocks = require('node-mocks-http')
 
-const DiscoverProviderRequest = require('../../lib/requests/discover-provider-request')
+const SelectProviderRequest = require('../../lib/requests/select-provider-request')
 
-describe('DiscoverProviderRequest', () => {
+describe('SelectProviderRequest', () => {
   describe('normalizeWebId()', () => {
     it('should prepend https:// if one is missing', () => {
-      let result = DiscoverProviderRequest.normalizeUri('localhost:8443')
+      let result = SelectProviderRequest.normalizeUri('localhost:8443')
       expect(result).to.equal('https://localhost:8443')
     })
 
     it('should return null if given a null uri', () => {
-      let result = DiscoverProviderRequest.normalizeUri(null)
+      let result = SelectProviderRequest.normalizeUri(null)
       expect(result).to.be.null
     })
 
     it('should return a valid uri unchanged', () => {
-      let result = DiscoverProviderRequest.normalizeUri('https://alice.example.com')
+      let result = SelectProviderRequest.normalizeUri('https://alice.example.com')
       expect(result).to.equal('https://alice.example.com')
     })
   })
 
   describe('fromParams()', () => {
     let res = HttpMocks.createResponse()
 
-    it('should initialize a DiscoverProviderRequest instance', () => {
+    it('should initialize a SelectProviderRequest instance', () => {
       let aliceWebId = 'https://alice.example.com'
       let oidcManager = {}
       let session = {}
@@ -37,7 +37,7 @@ describe('DiscoverProviderRequest', () => {
         app: { locals: { oidc: oidcManager } }
       }
 
-      let request = DiscoverProviderRequest.fromParams(req, res)
+      let request = SelectProviderRequest.fromParams(req, res)
       expect(request.webId).to.equal(aliceWebId)
       expect(request.response).to.equal(res)
       expect(request.oidcManager).to.equal(oidcManager)
@@ -52,7 +52,7 @@ describe('DiscoverProviderRequest', () => {
       }
 
       try {
-        DiscoverProviderRequest.fromParams(req, res)
+        SelectProviderRequest.fromParams(req, res)
       } catch (error) {
         expect(error.statusCode).to.equal(500)
         done()
@@ -63,7 +63,7 @@ describe('DiscoverProviderRequest', () => {
       let req = {}
 
       try {
-        DiscoverProviderRequest.fromParams(req, res)
+        SelectProviderRequest.fromParams(req, res)
       } catch (error) {
         expect(error.statusCode).to.equal(400)
         done()
@@ -79,7 +79,7 @@ describe('DiscoverProviderRequest', () => {
         app: { locals: { oidc: oidcManager } }
       }
 
-      let request = DiscoverProviderRequest.fromParams(req, res)
+      let request = SelectProviderRequest.fromParams(req, res)
       expect(request.webId).to.equal('https://alice.example.com')
     })
   })