Feature/ssh/show ssh fingerprints 2

src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/ssh/HashUtils.java

@@ -10,4 +10,8 @@ public class HashUtils {
     public static String getSha512Fingerprint(PublicKey key) {
         return KeyUtils.getFingerPrint(BuiltinDigests.sha512.create(), key);
     }
+
+    public static String getSha256Fingerprint(PublicKey key) {
+        return KeyUtils.getFingerPrint(BuiltinDigests.sha256.create(), key);
+    }
 }

src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/ssh/SshFingerprintsProviderService.java

@@ -0,0 +1,50 @@
+package de.tum.cit.aet.artemis.programming.service.localvc.ssh;
+
+import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_LOCALVC;
+
+import java.io.IOException;
+import java.security.GeneralSecurityException;
+import java.util.HashMap;
+import java.util.Map;
+
+import jakarta.ws.rs.BadRequestException;
+
+import org.apache.sshd.common.keyprovider.KeyPairProvider;
+import org.apache.sshd.server.SshServer;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Service;
+
+/**
+ * Service responsible for providing SSH fingerprints of the SSH server running in Artemis.
+ */
+@Profile(PROFILE_LOCALVC)
+@Service
+public class SshFingerprintsProviderService {
+
+    private static final Logger log = LoggerFactory.getLogger(SshFingerprintsProviderService.class);
+
+    private final SshServer sshServer;
+
+    public SshFingerprintsProviderService(SshServer sshServer) {
+        this.sshServer = sshServer;
+    }
+
+    public Map<String, String> getSshFingerPrints() {
+        Map<String, String> fingerprints = new HashMap<>();
+        KeyPairProvider keyPairProvider = sshServer.getKeyPairProvider();
+        if (keyPairProvider != null) {
+            try {
+                keyPairProvider.loadKeys(null).iterator()
+                        .forEachRemaining(keyPair -> fingerprints.put(keyPair.getPublic().getAlgorithm(), HashUtils.getSha256Fingerprint(keyPair.getPublic())));
+
+            }
+            catch (IOException | GeneralSecurityException e) {
+                log.info("Could not load keys from the ssh server while trying to get SSH key fingerprints", e);
+                throw new BadRequestException("Could not load keys from the ssh server");
+            }
+        }
+        return fingerprints;
+    }
+}

src/main/java/de/tum/cit/aet/artemis/programming/web/localvc/ssh/SshFingerprintsProviderResource.java

@@ -0,0 +1,44 @@
+package de.tum.cit.aet.artemis.programming.web.localvc.ssh;
+
+import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_LOCALVC;
+
+import java.util.Map;
+
+import org.springframework.context.annotation.Profile;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import de.tum.cit.aet.artemis.core.security.annotations.EnforceAtLeastStudent;
+import de.tum.cit.aet.artemis.core.service.feature.Feature;
+import de.tum.cit.aet.artemis.core.service.feature.FeatureToggle;
+import de.tum.cit.aet.artemis.programming.service.localvc.ssh.SshFingerprintsProviderService;
+
+/**
+ * REST controller for managing.
+ */
+@Profile(PROFILE_LOCALVC)
+@RestController
+@RequestMapping("api/")
+public class SshFingerprintsProviderResource {
+
+    SshFingerprintsProviderService sshFingerprintsProviderService;
+
+    public SshFingerprintsProviderResource(SshFingerprintsProviderService sshFingerprintsProviderService) {
+        this.sshFingerprintsProviderService = sshFingerprintsProviderService;
+    }
+
+    /**
+     * GET /ssh-fingerprints
+     *
+     * @return the SSH fingerprints for the keys a user uses
+     */
+    @GetMapping(value = "ssh-fingerprints", produces = MediaType.APPLICATION_JSON_VALUE)
+    @EnforceAtLeastStudent
+    @FeatureToggle(Feature.Exports)
+    public ResponseEntity<Map<String, String>> getSshFingerprints() {
+        return ResponseEntity.ok().body(sshFingerprintsProviderService.getSshFingerPrints());
+    }
+}

src/main/webapp/app/shared/user-settings/ssh-settings/fingerprints/ssh-user-settings-fingerprints.component.html

@@ -0,0 +1,67 @@
+<h1 jhiTranslate="artemisApp.userSettings.sshSettingsPage.sshFingerprints"></h1>
+
+<div class="list-group d-block">
+    <!-- Viewing existing key and creating a new key -->
+    <div class="list-group-item">
+        <div class="d-flex flex-wrap">
+            <p class="font-medium">
+                <span class="mt-4" jhiTranslate="artemisApp.userSettings.sshSettingsPage.fingerprintsExplanation"> </span>
+                <jhi-documentation-link [documentationType]="documentationType" [displayString]="'artemisApp.userSettings.sshSettingsPage.fingerprintsLearnMore'">
+                </jhi-documentation-link>
+            </p>
+        </div>
+
+        @if (sshFingerprints && sshFingerprints['RSA']) {
+            <div class="row small-text">
+                <div class="column left">
+                    {{ 'RSA' }}
+                </div>
+                <div class="column right">
+                    {{ sshFingerprints['RSA'] }}
+                </div>
+            </div>
+        }
+
+        @if (sshFingerprints && sshFingerprints['EdDSA']) {
+            <div class="row small-text">
+                <div class="column left">
+                    {{ 'ED25519' }}
+                </div>
+                <div class="column right">
+                    {{ sshFingerprints['EdDSA'] }}
+                </div>
+            </div>
+        }
+
+        @if (sshFingerprints && sshFingerprints['ECDSA']) {
+            <div class="row">
+                <div class="column left">
+                    {{ 'ECDSA' }}
+                </div>
+                <div class="column right">
+                    {{ sshFingerprints['ECDSA'] }}
+                </div>
+            </div>
+        }
+
+        @if (sshFingerprints && sshFingerprints['EC']) {
+            <div class="row">
+                <div class="column left">
+                    {{ 'ECDSA' }}
+                </div>
+                <div class="column right">
+                    {{ sshFingerprints['EC'] }}
+                </div>
+            </div>
+        }
+
+        <div class="d-flex justify-content-between align-items-center mt-4">
+            <div></div>
+            <div>
+                <a class="btn rounded-btn btn-primary btn-sm" [routerLink]="['..']">
+                    <span class="jhi-btn__title" style="font-size: small" jhiTranslate="artemisApp.userSettings.sshSettingsPage.back"></span>
+                </a>
+            </div>
+        </div>
+    </div>
+</div>

src/main/webapp/app/shared/user-settings/ssh-settings/fingerprints/ssh-user-settings-fingerprints.component.scss

@@ -0,0 +1,12 @@
+.column {
+    float: left;
+    padding: 10px;
+}
+
+.left {
+    width: 15%;
+}
+
+.right {
+    width: 85%;
+}

src/main/webapp/app/shared/user-settings/ssh-settings/fingerprints/ssh-user-settings-fingerprints.component.ts

@@ -0,0 +1,24 @@
+import { Component, OnInit, inject } from '@angular/core';
+import { ButtonSize, ButtonType } from 'app/shared/components/button.component';
+import { DocumentationType } from 'app/shared/components/documentation-button/documentation-button.component';
+import { SshUserSettingsFingerprintsService } from 'app/shared/user-settings/ssh-settings/fingerprints/ssh-user-settings-fingerprints.service';
+
+@Component({
+    selector: 'jhi-account-information',
+    templateUrl: './ssh-user-settings-fingerprints.component.html',
+    styleUrls: ['./ssh-user-settings-fingerprints.component.scss', '../ssh-user-settings.component.scss'],
+})
+export class SshUserSettingsFingerprintsComponent implements OnInit {
+    readonly sshUserSettingsService = inject(SshUserSettingsFingerprintsService);
+
+    protected sshFingerprints?: { [key: string]: string };
+
+    readonly documentationType: DocumentationType = 'SshSetup';
+    protected readonly ButtonType = ButtonType;
+
+    protected readonly ButtonSize = ButtonSize;
+
+    async ngOnInit() {
+        this.sshFingerprints = await this.sshUserSettingsService.getSshFingerprints();
+    }
+}

src/main/webapp/app/shared/user-settings/ssh-settings/fingerprints/ssh-user-settings-fingerprints.service.ts

@@ -0,0 +1,14 @@
+import { Injectable, inject } from '@angular/core';
+import { HttpClient } from '@angular/common/http';
+import { firstValueFrom } from 'rxjs';
+
+@Injectable({ providedIn: 'root' })
+export class SshUserSettingsFingerprintsService {
+    error?: string;
+
+    private http = inject(HttpClient);
+
+    public async getSshFingerprints(): Promise<{ [key: string]: string }> {
+        return await firstValueFrom(this.http.get<{ [key: string]: string }>('api/ssh-fingerprints'));
+    }
+}

src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.html

@@ -27,7 +27,7 @@ <h4 class="text-center mb-4 mt-8" jhiTranslate="artemisApp.userSettings.sshSetti
         <!-- Initial state: There are keys -->
         @if (keyCount > 0) {
             <div class="list-group-item">
-                <div class="d-flex flex-wrap mt-4">
+                <div class="d-flex flex-wrap">
                     <p>
                         <span class="mt-4 font-medium" jhiTranslate="artemisApp.userSettings.sshSettingsPage.whatToUseSSHForInfo"> </span>
                         <jhi-documentation-link [documentationType]="documentationType" [displayString]="'artemisApp.userSettings.sshSettingsPage.learnMore'">
@@ -103,6 +103,11 @@ <h4 class="text-center mb-4 mt-8" jhiTranslate="artemisApp.userSettings.sshSetti
                 </table>
                 <div class="d-flex justify-content-between align-items-center">
                     <div></div>
+                    <div>
+                        <a [routerLink]="['fingerprints']">
+                            <span style="font-size: small" jhiTranslate="artemisApp.userSettings.sshSettingsPage.fingerprints"></span>
+                        </a>
+                    </div>
                     <div>
                         <a class="btn rounded-btn btn-primary btn-sm" [routerLink]="['add']">
                             <span class="jhi-btn__title" style="font-size: small" jhiTranslate="artemisApp.userSettings.sshSettingsPage.addNewSshKey"></span>

src/main/webapp/app/shared/user-settings/user-settings.module.ts

@@ -13,6 +13,7 @@ import { FormDateTimePickerModule } from 'app/shared/date-time-picker/date-time-
 import { IdeSettingsComponent } from 'app/shared/user-settings/ide-preferences/ide-settings.component';
 import { DocumentationLinkComponent } from 'app/shared/components/documentation-link/documentation-link.component';
 import { SshUserSettingsKeyDetailsComponent } from 'app/shared/user-settings/ssh-settings/details/ssh-user-settings-key-details.component';
+import { SshUserSettingsFingerprintsComponent } from 'app/shared/user-settings/ssh-settings/fingerprints/ssh-user-settings-fingerprints.component';
 
 @NgModule({
     imports: [RouterModule.forChild(userSettingsState), ArtemisSharedModule, ArtemisSharedComponentModule, ClipboardModule, FormDateTimePickerModule, DocumentationLinkComponent],
@@ -22,6 +23,7 @@ import { SshUserSettingsKeyDetailsComponent } from 'app/shared/user-settings/ssh
         ScienceSettingsComponent,
         SshUserSettingsComponent,
         SshUserSettingsKeyDetailsComponent,
+        SshUserSettingsFingerprintsComponent,
         VcsAccessTokensSettingsComponent,
         IdeSettingsComponent,
     ],

src/main/webapp/app/shared/user-settings/user-settings.route.ts

@@ -9,6 +9,7 @@ import { SshUserSettingsComponent } from 'app/shared/user-settings/ssh-settings/
 import { VcsAccessTokensSettingsComponent } from 'app/shared/user-settings/vcs-access-tokens-settings/vcs-access-tokens-settings.component';
 import { IdeSettingsComponent } from 'app/shared/user-settings/ide-preferences/ide-settings.component';
 import { SshUserSettingsKeyDetailsComponent } from 'app/shared/user-settings/ssh-settings/details/ssh-user-settings-key-details.component';
+import { SshUserSettingsFingerprintsComponent } from 'app/shared/user-settings/ssh-settings/fingerprints/ssh-user-settings-fingerprints.component';
 
 export const userSettingsState: Routes = [
     {
@@ -60,6 +61,13 @@ export const userSettingsState: Routes = [
                     pageTitle: 'artemisApp.userSettings.categories.SSH_SETTINGS',
                 },
             },
+            {
+                path: 'ssh/fingerprints',
+                component: SshUserSettingsFingerprintsComponent,
+                data: {
+                    pageTitle: 'artemisApp.userSettings.categories.SSH_SETTINGS',
+                },
+            },
             {
                 path: 'ssh/view/:keyId',
                 component: SshUserSettingsKeyDetailsComponent,

src/main/webapp/i18n/de/userSettings.json

@@ -55,6 +55,10 @@
                 "expiresOn": "Läuft ab am",
                 "hasExpiredOn": "Abgelaufen am",
                 "fingerprint": "Fingerabdruck",
+                "fingerprints": "Fingerabdrücke",
+                "sshFingerprints": "SSH Fingerabdrücke",
+                "fingerprintsExplanation": "Mit SSH-Schlüsseln kannst du eine sichere Verbindung zwischen deinem Computer und Artemis herstellen. SSH-Fingerabdrücke stellen sicher, dass der Client eine Verbindung zum richtigen Host herstellt.",
+                "fingerprintsLearnMore": "Lerne mehr über Fingerabdrücke",
                 "commentUsedAsLabel": "Wenn du kein Label hinzufügst, wird der Schlüsselkommentar (sofern vorhanden) als Label verwendet.",
                 "expiry": {
                     "title": "Ablauf",

src/main/webapp/i18n/en/userSettings.json

@@ -55,6 +55,10 @@
                 "expiresOn": "Expires on",
                 "hasExpiredOn": "Expired on",
                 "fingerprint": "Fingerprint",
+                "fingerprints": "Fingerprints",
+                "sshFingerprints": "SSH Fingerprints",
+                "fingerprintsExplanation": "SSH keys allow you to establish a secure connection between your computer and Artemis. SSH fingerprints verify that the client is connecting to the correct host.",
+                "fingerprintsLearnMore": "Learn more about fingerprints",
                 "commentUsedAsLabel": "If you do not add a label, the key comment will be used as the default label if present.",
                 "expiry": {
                     "title": "Expiry",

src/test/java/de/tum/cit/aet/artemis/programming/icl/SshFingerprintsProviderIntegrationTest.java

@@ -0,0 +1,77 @@
+package de.tum.cit.aet.artemis.programming.icl;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.doThrow;
+
+import java.io.IOException;
+import java.security.KeyPair;
+import java.security.KeyPairGenerator;
+import java.util.Collections;
+import java.util.Map;
+
+import org.apache.sshd.common.keyprovider.KeyPairProvider;
+import org.apache.sshd.server.SshServer;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+import org.mockito.Mock;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.http.HttpStatus;
+import org.springframework.security.test.context.support.WithMockUser;
+
+import de.tum.cit.aet.artemis.programming.service.localvc.ssh.HashUtils;
+import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationLocalCILocalVCTest;
+
+class SshFingerprintsProviderIntegrationTest extends AbstractSpringIntegrationLocalCILocalVCTest {
+
+    private static final String TEST_PREFIX = "sshFingerprintsTest";
+
+    @MockBean
+    private SshServer sshServer;
+
+    @Mock
+    private KeyPairProvider keyPairProvider;
+
+    private String expectedFingerprint;
+
+    @BeforeEach
+    void setup() throws Exception {
+        KeyPairGenerator keyPairGenerator = KeyPairGenerator.getInstance("RSA");
+        keyPairGenerator.initialize(2048);
+        KeyPair testKeyPair = keyPairGenerator.generateKeyPair();
+
+        expectedFingerprint = HashUtils.getSha256Fingerprint(testKeyPair.getPublic());
+        doReturn(keyPairProvider).when(sshServer).getKeyPairProvider();
+        doReturn(Collections.singleton(testKeyPair)).when(keyPairProvider).loadKeys(null);
+    }
+
+    @Nested
+    class SshFingerprintsProvider {
+
+        @Test
+        @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER")
+        void shouldReturnFingerprints() throws Exception {
+            var response = request.get("/api/ssh-fingerprints", HttpStatus.OK, Map.class);
+            assertThat(response.get("RSA")).isNotNull();
+            assertThat(response.get("RSA")).isEqualTo(expectedFingerprint);
+        }
+
+        @Test
+        @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER")
+        void shouldReturnNoFingerprintsWithoutKeyProviderSetup() throws Exception {
+            doReturn(null).when(sshServer).getKeyPairProvider();
+
+            var response = request.get("/api/ssh-fingerprints", HttpStatus.OK, Map.class);
+            assertThat(response.isEmpty()).isTrue();
+        }
+
+        @Test
+        @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER")
+        void shouldReturnBadRequestWhenLoadKeysThrowsException() throws Exception {
+            doThrow(new IOException("Test exception")).when(keyPairProvider).loadKeys(null);
+
+            request.get("/api/ssh-fingerprints", HttpStatus.BAD_REQUEST, Map.class);
+        }
+    }
+}