Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(ids-api): Default scopes for clients #16476

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+73 −4
Open

feat(ids-api): Default scopes for clients #16476

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a4df4d0
Adds migration for inserting default scopes to existing clients
magnearun Oct 18, 2024
17df3b8
Adds phone, address and email as default scopes when creating clients
magnearun Oct 18, 2024
8e3a9d0
Merge branch 'main' into feat/default-scopes
magnearun Oct 18, 2024
a2ea02c
Merge branch 'main' into feat/default-scopes
magnearun Oct 18, 2024
6431c0b
chore: nx format:write update dirty files
andes-it Oct 18, 2024
1c78899
Merge branch 'main' into feat/default-scopes
magnearun Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions ...uth-api-lib/migrations/20241018150418-add-default-scopes-to-client-allowed-scope-table.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
'use strict';

module.exports = {
async up (queryInterface, Sequelize) {
const clients = await queryInterface.sequelize.query(`SELECT "client_id" FROM "client" WHERE "client_type" IN ('web', 'native', 'spa');`, { type: queryInterface.sequelize.QueryTypes.SELECT });
const clientIds = clients.map(client => client.client_id);

if (!clientIds.length) {
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider using parameterized query for better security

While the current query is not directly vulnerable to SQL injection (as it doesn't use user input), it's a good practice to use parameterized queries consistently. Consider refactoring to use query parameters.

Here's a suggested refactoring:

const clients = await queryInterface.sequelize.query(
  'SELECT "client_id" FROM "client" WHERE "client_type" IN (:clientTypes);',
  {
    type: queryInterface.sequelize.QueryTypes.SELECT,
    replacements: { clientTypes: ['web', 'native', 'spa'] }
  }
);

This approach is more secure and consistent with best practices for database queries.


const existingScopes = await queryInterface.sequelize.query( `SELECT "client_id", "scope_name" FROM "client_allowed_scope" WHERE "client_id" IN (:clientIds);`,
{ type: queryInterface.sequelize.QueryTypes.SELECT, replacements: { clientIds } });

const existingScopesLookup = new Set(
existingScopes.map(scope => `${scope.client_id}-${scope.scope_name}`)
);

const rows = [];
const defaultScopes = ['email', 'address', 'phone']
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider extracting default scopes to a constant

For better maintainability and potential reuse, consider extracting the default scopes array to a constant at the module level.

Apply this change at the top of the file:

const DEFAULT_SCOPES = ['email', 'address', 'phone'];

module.exports = {
  async up(queryInterface, Sequelize) {
    // ... existing code ...
    
    // Replace line 28 with:
    const defaultScopes = DEFAULT_SCOPES;
    
    // ... rest of the code ...
  },
  // ... down method ...
};

This change improves code readability and makes it easier to update default scopes in the future if needed.


for (const clientId of clientIds) {
rows.push(...defaultScopes.filter((scope => {
return !existingScopesLookup.has(`${clientId}-${scope}`);
})).map(scope => ({ client_id: clientId, scope_name: scope })));
}

if (!rows.length) {
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider extracting default scopes to a constant

The default scopes array is defined within the method. For better maintainability and potential reuse, consider extracting it to a constant at the module level.

Apply this change at the top of the file:

const DEFAULT_SCOPES = ['email', 'address', 'phone'];

module.exports = {
  async up(queryInterface, Sequelize) {
    // ... existing code ...
    
    // Replace line 20 with:
    // const defaultScopes = DEFAULT_SCOPES;
    
    // ... rest of the code ...
  },
  // ... down method ...
};

This change improves code readability and makes it easier to update default scopes in the future if needed.


await queryInterface.bulkInsert('client_allowed_scope', rows);
},

async down (queryInterface, Sequelize) {
/**
* There is no need to go back
*
*/
}
};
13 changes: 11 additions & 2 deletions libs/auth-api-lib/src/lib/clients/admin/admin-clients.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -631,10 +631,19 @@ export class AdminClientsService {
switch (client.clientType) {
case ClientType.web:
case ClientType.native:
scopes.push({
scopes.push(...[{
clientId: client.clientId,
scopeName: 'profile',
})
}, {
clientId: client.clientId,
scopeName: 'email',
}, {
clientId: client.clientId,
scopeName: 'phone',
}, {
clientId: client.clientId,
scopeName: 'address',
}])
}

return scopes
Expand Down
Loading