✨ feat: Add custom fields & role assignment to OpenID strategy

[rubentalstra]

Summary

Closes: #4670 #4362 #4354

✨ feat: This Pull Request introduces comprehensive OpenID Connect (OIDC) support with enhanced user data handling and role assignment. Key changes include:

• Environment Configuration: Updated .env.example with new environment variables for OpenID integration.
• User Schema Enhancements: Modified userSchema.js to support additional fields for storing custom OpenID data.
• Data Mappers Implementation: Added openidDataMapper.js with provider-specific mappers for Microsoft, AWS Cognito, and Keycloak to effectively fetch and map custom OpenID data.
• OpenID Strategy Configuration: Enhanced openidStrategy.js to:
  • Utilize new data mappers for custom field extraction.
  • Enforce role-based access control, including dynamic system role assignment (admin vs. user) based on token-derived roles.
  • Manage user avatars by downloading and processing images based on OpenID data.
• Dependency Updates: Updated package.json and package-lock.json with the necessary libraries for full OpenID functionality.
• Type Definitions: Updated TypeScript types in types.ts to support custom OpenID data mappings.

Change Type

• New feature (non-breaking change which adds functionality)
• This change requires a documentation update

Testing

• Currently, only the Microsoft provider has been tested and is fully working.

Checklist

• My code adheres to this project's style guidelines
• I have performed a self-review of my own code
• I have commented any complex areas in my code
• I have updated documentation accordingly
• My changes do not introduce new warnings
• I have written tests demonstrating that my changes are effective or that my feature works
• Local unit tests pass with my changes
• A pull request for updating the documentation has been submitted

[geodanchev]

Hi @rubentalstra. I closed my pull request because you are right that we both want the same think. I went through the documentation as well and there you say that aws_cognito is available but I see only Microsoft implementation. Is there something I'm missing?

[rubentalstra]

Hi @geodanchev. it's all good. I can't test aws_cognito so I removed it from the code. but if there is someone who could test it then that would be great.

[geodanchev]

What about the documentation pull request

[rubentalstra]

still need to remove it 😉

[geodanchev]

the variable tokenBasedRoles can be set only once before the if (process.env.OPENID_CUSTOM_DATA) block if you refactor the code slightly. Currently, tokenBasedRoles is being set twice, once inside the if block and once outside of it. This redundancy can be avoided.

[geodanchev]

Can we have multiple adminRoles that at the end will make the user admin? Or it is not a good idea ?