Oauth2 Providers list

Author: R-Sandor

server/src/main/java/dev/findfirst/users/controller/UserController.java

@@ -27,6 +27,7 @@
 import dev.findfirst.users.exceptions.NoUserFoundException;
 import dev.findfirst.users.exceptions.TokenExpiredException;
 import dev.findfirst.users.exceptions.UserNameTakenException;
+import dev.findfirst.users.model.oauth2.Oauth2Source;
 import dev.findfirst.users.model.user.SigninTokens;
 import dev.findfirst.users.model.user.TokenPassword;
 import dev.findfirst.users.model.user.User;
@@ -87,14 +88,28 @@ public ResponseEntity<User> userInfo() throws NoUserFoundException {
   }
 
   @GetMapping("/oauth2Providers")
-  public ResponseEntity<List<String>> oauth2Providers() {
-    List<String> listOfAuth2Providers = new ArrayList<>();
+  public ResponseEntity<List<Oauth2Source>> oauth2Providers() {
+    List<Oauth2Source> listOfAuth2Providers = new ArrayList<>();
     if (oauth2Providers == null) {
       return ResponseEntity.ofNullable(listOfAuth2Providers);
     }
     oauth2Providers.iterator().forEachRemaining(provider -> {
-      log.debug(provider.getProviderDetails().getTokenUri());
-      listOfAuth2Providers.add(provider.getRegistrationId());
+      var tknUri = provider.getProviderDetails().getTokenUri();
+      log.debug("Token URI {}", tknUri);
+      // skip http(s)://
+      var noProto = "";
+      if (tknUri.contains("https://")) {
+        noProto = tknUri.substring(8);
+      } else {
+        log.debug("provider without https {}", tknUri);
+        // do we really want to trust anything that isn't https?
+        return;
+      }
+      var domain = noProto.indexOf("/");
+      var faviconURI = "https://" + noProto.substring(0, domain) + "/favicon.ico";
+
+      log.debug("Favicon URI {}", faviconURI);
+      listOfAuth2Providers.add(new Oauth2Source(provider.getClientName(), faviconURI));
     });
     return ResponseEntity.ofNullable(listOfAuth2Providers);
   }
@@ -200,8 +215,7 @@ public ResponseEntity<String> refreshToken(
   public ResponseEntity<String> uploadProfilePicture(
       @Valid @RequestParam("file") @FileSize MultipartFile file) throws NoUserFoundException {
     log.debug("Attempting to add user profile picture");
-    User user =
-        userService.getUserById(uContext.getUserId()).orElseThrow(NoUserFoundException::new);
+    User user = userService.getUserById(uContext.getUserId()).orElseThrow(NoUserFoundException::new);
 
     // File type validation
     String contentType = file.getContentType();

server/src/main/java/dev/findfirst/users/model/oauth2/Oauth2Source.java

@@ -0,0 +1,5 @@
+package dev.findfirst.users.model.oauth2;
+
+public record Oauth2Source(String provider, String iconUrl) {
+
+}

server/src/test/java/dev/findfirst/users/controller/UserControllerTest.java

@@ -17,6 +17,7 @@
 import dev.findfirst.security.userauth.models.TokenRefreshResponse;
 import dev.findfirst.security.userauth.models.payload.request.SignupRequest;
 import dev.findfirst.users.model.MailHogMessage;
+import dev.findfirst.users.model.oauth2.Oauth2Source;
 import dev.findfirst.users.model.user.TokenPassword;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -49,9 +50,9 @@
 @IntegrationTest
 @MockTypesense
 @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
-@TestPropertySource(locations = "classpath:application-test.yml",
-    properties = {"spring.security.oauth2.client.registration.github.client-secret=secret-oauth",
-        "spring.security.oauth2.client.registration.github.client-id=test-id"})
+@TestPropertySource(locations = "classpath:application-test.yml", properties = {
+    "spring.security.oauth2.client.registration.github.client-secret=secret-oauth",
+    "spring.security.oauth2.client.registration.github.client-id=test-id" })
 class UserControllerTest {
 
   TestRestTemplate restTemplate = new TestRestTemplate();
@@ -72,8 +73,8 @@ class UserControllerTest {
   static PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:16.2-alpine3.19");
 
   @Container
-  public static GenericContainer<?> mailhog =
-      new GenericContainer<>(DockerImageName.parse("mailhog/mailhog:latest")).withExposedPorts(1025,
+  public static GenericContainer<?> mailhog = new GenericContainer<>(DockerImageName.parse("mailhog/mailhog:latest"))
+      .withExposedPorts(1025,
           8025);
 
   @TestConfiguration
@@ -99,7 +100,8 @@ public JavaMailSender javaMailSender() {
   private String userUrl = "/user";
 
   /**
-   * Tests that a user should be able to sign up. After signing up another user should not be able
+   * Tests that a user should be able to sign up. After signing up another user
+   * should not be able
    * use the same username or email.
    */
   @Test
@@ -116,7 +118,8 @@ void userSignup() {
   }
 
   /**
-   * Create a user, gets the registration token from the email. Uses the token to complete
+   * Create a user, gets the registration token from the email. Uses the token to
+   * complete
    * registration.
    */
   @Test
@@ -245,9 +248,10 @@ void testRemoveUserPhoto_Success() throws Exception {
 
   @Test
   void getAllProivders() {
-    var response = restTemplate.getForEntity("/user/oauth2Providers", String[].class);
+    var response = restTemplate.getForEntity("/user/oauth2Providers", Oauth2Source[].class);
 
-    assertArrayEquals(new String[] {"github"}, response.getBody());
+    assertArrayEquals(new Oauth2Source[] { new Oauth2Source("GitHub", "https://github.com/favicon.ico") },
+        response.getBody());
 
   }
 }