Implement User and Role Management with GitHub IDs

[shah]

We need to implement a user and role management system for our custom application using GitHub IDs. The system should read a configuration file (oauth2-github-authz.yml) stored in a private GitHub repository and use this file to manage user access and roles within a Spring Boot 3.3 application. Authentication (AuthN) will be handled by GitHub, while authorization (AuthZ) will be managed using Spring Authorization.

• [x] Integrate User Profile picture in UI.
• [x] Read user and role information from a YAML file in a private GitHub repository.
• [x] Handle authentication using GitHub OAuth.
• [x] Manage authorization using Spring Authorization.
• [x] Disable login requirements and simulate a specific user and role in a local environment.

Consider the following dependencies for the pom.xml file:

• GitHub API: org.kohsuke:github-api
• Jackson YAML: com.fasterxml.jackson.dataformat:jackson-dataformat-yaml
• Spring OAuth2 Client: org.springframework.boot:spring-boot-starter-oauth2-client
• Spring Security: org.springframework.boot:spring-boot-starter-security
• Spring OAuth2 Resource Server: org.springframework.security:spring-security-oauth2-resource-server

Instructions

1. Create Configuration File

   • Create a YAML file named oauth2-github-authz.yml in the private GitHub repository (github.com/tech-by-design/infrastructure-prime).

   • Structure the file as follows:

     users:
     - gitHubId: johndoe
       name: John Doe
       tenantId: tenant123
       resources:
         sudomain1.techbd.org:
           roles:
              - ADMIN
              - USER
         sudomain2.techbd.org:
           roles:
              - USER
     - gitHubId: janesmith
       name: Jane Smith
       tenantId: tenant456
       resources:
         sudomain1.techbd.org:
           roles:
              - ADMIN
              - USER
         sudomain2.techbd.org:
           roles:
              - USER
     - gitHubId: bobjohnson
       name: Bob Johnson
       tenantId: tenant789
       resources:
         sudomain1.techbd.org:
           roles:
              - DEVELOPER
         sudomain2.techbd.org:
           roles:
              - ADMIN

2. Read YAML File from GitHub

   • Use the GitHub API to access the YAML file from the repository.
   • Use Jackson to parse the YAML content. Refer to the Jackson Dataformat YAML documentation for details on how to configure and use Jackson for YAML parsing.

3. Implement GitHub File Reader

   • Create a Java class to read the file content and parse the YAML data. Use the GitHub API to authenticate and fetch the file.
   • Use Jackson to map the YAML data to a Java object. Follow the Jackson Documentation for detailed instructions on how to configure and use the library.

4. Configure Spring Security

   • Set up Spring Security to use GitHub OAuth for authentication. Follow the Spring Security OAuth2 Client Documentation for detailed configuration steps.
   • Configure Spring Security to use JWT for resource server authentication. Refer to the Spring Security OAuth2 Resource Server Documentation.

5. Local Environment Configuration

   • Modify the Spring Security configuration to disable login requirements and simulate a specific user and role when running in a local environment. Check the Spring Boot Profiles Documentation for instructions on how to manage different profiles.
   • Create a configuration class to define user details for the local environment.

6. Service to Manage Users and Roles

   • Create a service to load and manage user data. Use the service to read the YAML file from GitHub and map the data to Java objects.
   • Implement methods to fetch user details based on roles.

References and Useful Links

• GitHub API for Java
• Jackson Dataformat YAML
• Spring Security OAuth2 Client Documentation
• Spring Security OAuth2 Resource Server Documentation
• Spring Boot Profiles Documentation
• Spring Security Documentation
• Spring Boot Documentation

Additional Notes

• Use only environment variables for handling and securing sensitive information, such as GitHub tokens and configuration files.

[shah]

@razakpm please see if this file is required and, if not, remove it and perform any other cleanup: hub-prime/src/main/java/org/techbd/service/http/NoAuthSecurityConfig.java.

[razakpm]

@shah NoAuthSecurityConfig.java is useful for testing locally because it disables the login requirements. I didn't use the existing profile like sandbox because it's necessary to test authentication in the sandbox environment too. Instead, I used a profile called localopen that allows developers to test the application quickly without authentication. I didn't set any default user or role since it's not confirmed yet, so I didn't complete the last task in this requirement. Also, the new update (reading roles based on resources is still pending in this issue).

[razakpm]

Added NoAuthSecurityConfig.java to test locally without Authentication, currently no default role.

[shah]

We should switch to using the GitHub Java SDK to access APIs instead of using our own custom HTTP calls.