screwdriver-api 6.0.12 → 6.0.13

package/lib/server.js

@@ -201,7 +201,7 @@ module.exports = async config => {
         server.app.buildFactory.apiUri = server.info.uri;
         server.app.buildFactory.tokenGen = (buildId, metadata, scmContext, expiresIn, scope = ['temporal']) =>
             server.plugins.auth.generateToken(
-                server.plugins.auth.generateProfile(buildId, null, scmContext, scope, metadata),
+                server.plugins.auth.generateProfile({ username: buildId, scmContext, scope, metadata }),
                 expiresIn
             );
         server.app.buildFactory.executor.tokenGen = server.app.buildFactory.tokenGen;
@@ -209,7 +209,7 @@ module.exports = async config => {
         server.app.jobFactory.apiUri = server.info.uri;
         server.app.jobFactory.tokenGen = (username, metadata, scmContext, scope = ['user']) =>
             server.plugins.auth.generateToken(
-                server.plugins.auth.generateProfile(username, null, scmContext, scope, metadata)
+                server.plugins.auth.generateProfile({ username, scmContext, scope, metadata })
             );
         server.app.jobFactory.executor.userTokenGen = server.app.jobFactory.tokenGen;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "6.0.12",
+  "version": "6.0.13",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {

package/plugins/auth/index.js

@@ -97,14 +97,16 @@ const authPlugin = {
         /**
          * Generates a profile for storage in cookie and jwt
          * @method generateProfile
-         * @param  {String}        username   Username of the person
-         * @param  {String}        scmUserId  User ID in the SCM
-         * @param  {String}        scmContext Scm to which the person logged in belongs
-         * @param  {Array}         scope      Scope for this profile (usually build or user)
-         * @param  {Object}        metadata   Additonal information to tag along with the login
-         * @return {Object}                   The profile to be stored in jwt and/or cookie
+         * @param  {Object}   config            Configuration object
+         * @param  {String}   config.username   Username of the person
+         * @param  {String}   config.scmUserId  User ID in the SCM
+         * @param  {String}   config.scmContext Scm to which the person logged in belongs
+         * @param  {Array}    config.scope      Scope for this profile (usually build or user)
+         * @param  {Object}   config.metadata   Additional information to tag along with the login
+         * @return {Object}                     The profile to be stored in jwt and/or cookie
          */
-        server.expose('generateProfile', (username, scmUserId, scmContext, scope, metadata) => {
+        server.expose('generateProfile', config => {
+            const { username, scmUserId, scmContext, scope, metadata } = config;
             const profile = { username, scmContext, scope, ...(metadata || {}) };
 
             if (pluginOptions.jwtEnvironment) {

package/plugins/auth/login.js

@@ -32,13 +32,11 @@ function addGuestRoute(config) {
                     }
 
                     const username = `guest/${uuidv4()}`;
-                    const profile = request.server.plugins.auth.generateProfile(
+                    const profile = request.server.plugins.auth.generateProfile({
                         username,
-                        null,
-                        null,
-                        ['user', 'guest'],
-                        {}
-                    );
+                        scope: ['user', 'guest'],
+                        metadata: {}
+                    });
 
                     // Log that the user has authenticated
                     request.log(['auth'], `${username} has logged in`);
@@ -89,13 +87,13 @@ function addOAuthRoutes(config) {
                 const accessToken = request.auth.credentials.token;
                 const { username, id: scmUserId } = request.auth.credentials.profile;
 
-                const profile = request.server.plugins.auth.generateProfile(
+                const profile = request.server.plugins.auth.generateProfile({
                     username,
                     scmUserId,
                     scmContext,
-                    ['user'],
-                    {}
-                );
+                    scope: ['user'],
+                    metadata: {}
+                });
                 const scmDisplayName = await userFactory.scm.getDisplayName({ scmContext });
                 const userDisplayName = config.authCheckById
                     ? `${scmDisplayName}:${username}:${scmUserId}`

package/plugins/auth/token.js

@@ -39,12 +39,11 @@ module.exports = () => ({
                 const job = await jobFactory.get(build.jobId);
                 const pipeline = pipelineFactory.get(job.pipelineId);
 
-                profile = request.server.plugins.auth.generateProfile(
-                    request.params.buildId,
-                    null,
-                    pipeline.scmContext,
-                    ['build', 'impersonated']
-                );
+                profile = request.server.plugins.auth.generateProfile({
+                    username: request.params.buildId,
+                    scmContext: pipeline.scmContext,
+                    scope: ['build', 'impersonated']
+                });
                 profile.token = request.server.plugins.auth.generateToken(profile);
 
                 request.cookieAuth.set(profile);

package/plugins/builds/token.js

@@ -54,13 +54,12 @@ module.exports = () => ({
                     }
 
                     const token = request.server.plugins.auth.generateToken(
-                        request.server.plugins.auth.generateProfile(
-                            profile.username,
-                            null,
-                            profile.scmContext,
-                            ['build'],
-                            jwtInfo
-                        ),
+                        request.server.plugins.auth.generateProfile({
+                            username: profile.username,
+                            scmContext: profile.scmContext,
+                            scope: ['build'],
+                            metadata: jwtInfo
+                        }),
                         parseInt(buildTimeout, 10)
                     );
 

package/plugins/pipelines/caches/request.js

@@ -36,7 +36,12 @@ async function invoke(request) {
     const { username, scmContext } = auth.credentials;
 
     const token = request.server.plugins.auth.generateToken(
-        request.server.plugins.auth.generateProfile(username, null, scmContext, ['sdapi'], { pipelineId })
+        request.server.plugins.auth.generateProfile({
+            username,
+            scmContext,
+            scope: ['sdapi'],
+            metadata: { pipelineId }
+        })
     );
 
     const options = {