Integrated code lifecycle: Improve SSH handling

src/main/java/de/tum/in/www1/artemis/web/rest/UserResource.java

@@ -12,12 +12,14 @@
 import org.apache.sshd.common.config.keys.AuthorizedKeyEntry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Profile;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageRequest;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -37,6 +39,7 @@
 import de.tum.in.www1.artemis.service.dto.UserInitializationDTO;
 import de.tum.in.www1.artemis.service.user.UserCreationService;
 import de.tum.in.www1.artemis.service.user.UserService;
+import de.tum.in.www1.artemis.web.rest.util.HeaderUtil;
 import tech.jhipster.web.util.PaginationUtil;
 
 /**
@@ -64,6 +67,9 @@
 @RequestMapping("api/")
 public class UserResource {
 
+    @Value("${jhipster.clientApp.name}")
+    private String applicationName;
+
     private static final Logger log = LoggerFactory.getLogger(UserResource.class);
 
     private final UserService userService;
@@ -184,13 +190,38 @@ public ResponseEntity<Void> setIrisAcceptedToTimestamp() {
     @PutMapping("users/sshpublickey")
     @EnforceAtLeastStudent
     public ResponseEntity<Void> addSshPublicKey(@RequestBody String sshPublicKey) throws GeneralSecurityException, IOException {
+
         User user = userRepository.getUser();
+        log.debug("REST request to add SSH key to user {}", user.getLogin());
         // Parse the public key string
-        AuthorizedKeyEntry keyEntry = AuthorizedKeyEntry.parseAuthorizedKeyEntry(sshPublicKey);
+        AuthorizedKeyEntry keyEntry;
+        try {
+            keyEntry = AuthorizedKeyEntry.parseAuthorizedKeyEntry(sshPublicKey);
+        }
+        catch (IllegalArgumentException e) {
+            return ResponseEntity.badRequest().headers(HeaderUtil.createFailureAlert(applicationName, true, "sshUserSettings", "saveSshKeyError", "Invalid SSH key format"))
+                    .body(null);
+        }
         // Extract the PublicKey object
         PublicKey publicKey = keyEntry.resolvePublicKey(null, null, null);
         String keyHash = HashUtils.getSha512Fingerprint(publicKey);
         userRepository.updateUserSshPublicKeyHash(user.getId(), keyHash, sshPublicKey);
         return ResponseEntity.ok().build();
     }
+
+    /**
+     * PUT users/sshpublickey : sets the ssh public key
+     *
+     * @return the ResponseEntity with status 200 (OK), with status 404 (Not Found), or with status 400 (Bad Request)
+     */
+    @DeleteMapping("users/sshpublickey")
+    @EnforceAtLeastStudent
+    public ResponseEntity<Void> deleteSshPublicKey() {
+        User user = userRepository.getUser();
+        log.debug("REST request to remove SSH key of user {}", user.getLogin());
+        userRepository.updateUserSshPublicKeyHash(user.getId(), null, null);
+
+        log.debug("Successfully deleted SSH key of user {}", user.getLogin());
+        return ResponseEntity.ok().build();
+    }
 }

src/main/webapp/app/app.constants.ts

@@ -23,6 +23,8 @@ export const PROFILE_LOCALVC = 'localvc';
 
 export const PROFILE_LOCALCI = 'localci';
 
+export const PROFILE_GITLAB = 'gitlab';
+
 export const PROFILE_AEOLUS = 'aeolus';
 
 export const PROFILE_IRIS = 'iris';

src/main/webapp/app/core/auth/account.service.ts

@@ -327,10 +327,25 @@ export class AccountService implements IAccountService {
         this.prefilledUsernameValue = prefilledUsername;
     }
 
+    /**
+     * Sends the added SSH key to the server
+     *
+     * @param sshPublicKey
+     */
     addSshPublicKey(sshPublicKey: string): Observable<void> {
         if (this.userIdentity) {
             this.userIdentity.sshPublicKey = sshPublicKey;
         }
         return this.http.put<void>('api/users/sshpublickey', sshPublicKey);
     }
+
+    /**
+     * Sends a request to the server to delete the user's current SSH key
+     */
+    deleteSshPublicKey(): Observable<void> {
+        if (this.userIdentity) {
+            this.userIdentity.sshPublicKey = undefined;
+        }
+        return this.http.delete<void>('api/users/sshpublickey');
+    }
 }

src/main/webapp/app/shared/components/clone-repo-button/clone-repo-button.component.html

@@ -14,7 +14,7 @@
         container="body"
     ></button>
     <ng-template #popContent>
-        @if (useSsh && !localVCEnabled) {
+        @if (useSsh && (!user.sshPublicKey || gitlabVCEnabled)) {
             <div class="alert alert-warning" [innerHTML]="getSshKeyTip()"></div>
         }
         @if (participations && participations.length > 1) {

src/main/webapp/app/shared/components/clone-repo-button/clone-repo-button.component.ts

@@ -9,7 +9,7 @@ import { LocalStorageService } from 'ngx-webstorage';
 import { ProgrammingExerciseStudentParticipation } from 'app/entities/participation/programming-exercise-student-participation.model';
 import { ParticipationService } from 'app/exercises/shared/participation/participation.service';
 import { Exercise } from 'app/entities/exercise.model';
-import { PROFILE_LOCALVC } from 'app/app.constants';
+import { PROFILE_GITLAB, PROFILE_LOCALVC } from 'app/app.constants';
 import { isPracticeMode } from 'app/entities/participation/student-participation.model';
 import { faDownload, faExternalLink } from '@fortawesome/free-solid-svg-icons';
 
@@ -33,13 +33,15 @@ export class CloneRepoButtonComponent implements OnInit, OnChanges {
     exercise?: Exercise;
 
     useSsh = false;
-    sshKeysUrl?: string;
+    setupSshKeysUrl?: string;
     sshEnabled = false;
     sshTemplateUrl?: string;
     repositoryPassword?: string;
     versionControlUrl: string;
     versionControlAccessTokenRequired?: boolean;
     localVCEnabled = false;
+    gitlabVCEnabled = false;
+
     user: User;
     cloneHeadline: string;
     wasCopied = false;
@@ -67,14 +69,22 @@ export class CloneRepoButtonComponent implements OnInit, OnChanges {
 
         // Get ssh information from the user
         this.profileService.getProfileInfo().subscribe((profileInfo) => {
-            this.sshKeysUrl = profileInfo.sshKeysURL;
+            this.setupSshKeysUrl = profileInfo.sshKeysURL;
             this.sshTemplateUrl = profileInfo.sshCloneURLTemplate;
+
             this.sshEnabled = !!this.sshTemplateUrl;
             if (profileInfo.versionControlUrl) {
                 this.versionControlUrl = profileInfo.versionControlUrl;
             }
+
             this.versionControlAccessTokenRequired = profileInfo.versionControlAccessToken;
             this.localVCEnabled = profileInfo.activeProfiles.includes(PROFILE_LOCALVC);
+            this.gitlabVCEnabled = profileInfo.activeProfiles.includes(PROFILE_GITLAB);
+            if (this.localVCEnabled) {
+                this.setupSshKeysUrl = `${window.location.origin}/user-settings/sshSettings`;
+            } else {
+                this.setupSshKeysUrl = profileInfo.sshKeysURL;
+            }
         });
 
         this.useSsh = this.localStorage.retrieve('useSsh') || false;
@@ -170,7 +180,7 @@ export class CloneRepoButtonComponent implements OnInit, OnChanges {
      * Inserts the correct link to the translated ssh tip.
      */
     getSshKeyTip() {
-        return this.translateService.instant('artemisApp.exerciseActions.sshKeyTip').replace(/{link:(.*)}/, '<a href="' + this.sshKeysUrl + '" target="_blank">$1</a>');
+        return this.translateService.instant('artemisApp.exerciseActions.sshKeyTip').replace(/{link:(.*)}/, '<a href="' + this.setupSshKeysUrl + '" target="_blank">$1</a>');
     }
 
     /**

src/main/webapp/app/shared/components/documentation-button/documentation-button.component.ts

@@ -12,6 +12,7 @@ const DocumentationLinks = {
     Quiz: 'exercises/quiz/',
     Model: 'exercises/modeling/',
     Programming: 'exercises/programming/',
+    SshSetup: 'exercises/programming.html#repository-access',
     Text: 'exercises/textual/',
     FileUpload: 'exercises/file-upload/',
     Notifications: 'notifications/',

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

@@ -49,30 +49,5 @@ <h1>
                 <dd>{{ currentUser.createdDate | artemisDate }}</dd>
             </div>
         }
-        @if (localVCEnabled) {
-            <div class="list-group-item">
-                <dt>
-                    <!--Local Version Control SSH Key-->
-                    <div class="row pb-1">
-                        <div class="col">
-                            {{ 'artemisApp.userSettings.accountInformationPage.sshKey' | artemisTranslate }}
-                        </div>
-                        <div class="col col-auto text-right">
-                            <div class="btn-group" role="group" aria-label="Actions">
-                                <button class="btn btn-sm btn-warning" (click)="editSshKey = !editSshKey">
-                                    <fa-icon [icon]="faEdit" />
-                                </button>
-                                <button class="btn btn-sm btn-success" (click)="saveSshKey()" [disabled]="!editSshKey">
-                                    <fa-icon [icon]="faSave" />
-                                </button>
-                            </div>
-                        </div>
-                    </div>
-                </dt>
-                <dd>
-                    <textarea class="form-control" rows="5" [readonly]="!editSshKey" [(ngModel)]="sshKey"></textarea>
-                </dd>
-            </div>
-        }
     </div>
 }

src/main/webapp/app/shared/user-settings/account-information/account-information.component.ts

@@ -2,9 +2,6 @@ import { Component, OnInit } from '@angular/core';
 import { User } from 'app/core/user/user.model';
 import { AccountService } from 'app/core/auth/account.service';
 import { Subscription, tap } from 'rxjs';
-import { ProfileService } from 'app/shared/layouts/profiles/profile.service';
-import { PROFILE_LOCALVC } from 'app/app.constants';
-import { faEdit, faSave } from '@fortawesome/free-solid-svg-icons';
 
 @Component({
     selector: 'jhi-account-information',
@@ -13,38 +10,14 @@ import { faEdit, faSave } from '@fortawesome/free-solid-svg-icons';
 })
 export class AccountInformationComponent implements OnInit {
     currentUser?: User;
-    localVCEnabled: boolean = false;
-    sshKey: string = '';
-    editSshKey = false;
-
-    faEdit = faEdit;
-    faSave = faSave;
-
     private authStateSubscription: Subscription;
 
-    constructor(
-        private accountService: AccountService,
-        private profileService: ProfileService,
-    ) {}
+    constructor(private accountService: AccountService) {}
 
     ngOnInit() {
-        this.profileService.getProfileInfo().subscribe((profileInfo) => {
-            this.localVCEnabled = profileInfo.activeProfiles.includes(PROFILE_LOCALVC);
-        });
-
         this.authStateSubscription = this.accountService
             .getAuthenticationState()
-            .pipe(
-                tap((user: User) => {
-                    this.sshKey = user.sshPublicKey || '';
-                    return (this.currentUser = user);
-                }),
-            )
+            .pipe(tap((user: User) => (this.currentUser = user)))
             .subscribe();
     }
-
-    saveSshKey() {
-        this.editSshKey = false;
-        this.accountService.addSshPublicKey(this.sshKey).subscribe();
-    }
 }

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

@@ -0,0 +1,83 @@
+<h1 jhiTranslate="artemisApp.userSettings.sshSettings">
+    <!--SSH Settings-->
+</h1>
+@if (currentUser) {
+    <div class="list-group d-block">
+        <div class="list-group-item">
+            <dt>
+                <span jhiTranslate="artemisApp.userSettings.sshSettingsPage.sshSettingsInfoText"> </span>
+                <jhi-documentation-button [type]="documentationType" />
+            </dt>
+        </div>
+        @if (storedSshKey === '' && !editSshKey) {
+            <div class="list-group-item">
+                <jhi-button
+                    [btnType]="ButtonType.PRIMARY"
+                    [btnSize]="ButtonSize.SMALL"
+                    [title]="'artemisApp.userSettings.sshSettingsPage.addNewSshKey'"
+                    (onClick)="editSshKey = !editSshKey"
+                />
+            </div>
+        }
+        @if (storedSshKey !== '' && !editSshKey) {
+            <dt class="list-group-item" jhiTranslate="artemisApp.userSettings.sshSettingsPage.sshKeyDisplayedInformation"></dt>
+            <div class="list-group-item">
+                {{ sshKey }}
+            </div>
+            <div class="list-group-item">
+                <div class="btn-group" role="group" aria-label="Actions">
+                    <jhi-button
+                        class="d-flex"
+                        [btnType]="ButtonType.PRIMARY"
+                        [btnSize]="ButtonSize.SMALL"
+                        [icon]="faEdit"
+                        [title]="'artemisApp.userSettings.sshSettingsPage.editExistingSshKey'"
+                        (onClick)="editSshKey = !editSshKey"
+                    />
+                </div>
+                <div class="btn-group" role="group" aria-label="Actions">
+                    <button
+                        class="btn btn-md flex-grow-1 d-flex align-items-center"
+                        jhiDeleteButton
+                        [renderButtonText]="false"
+                        (delete)="deleteSshKey()"
+                        deleteQuestion="artemisApp.userSettings.sshSettingsPage.deleteSshKeyQuestion"
+                        [dialogError]="dialogError$"
+                    >
+                        <fa-icon [icon]="faTrash" />
+                        <div jhiTranslate="artemisApp.userSettings.sshSettingsPage.deleteSshKey" class="ms-2">Delete</div>
+                    </button>
+                </div>
+            </div>
+        }
+        @if (editSshKey) {
+            <div class="list-group-item">
+                <div jhiTranslate="artemisApp.userSettings.sshSettingsPage.key"></div>
+            </div>
+            <div class="list-group-item">
+                <dd>
+                    <textarea class="form-control" rows="10" [readonly]="!editSshKey" [(ngModel)]="sshKey"></textarea>
+                </dd>
+                <div class="col col-auto text-right">
+                    <div class="btn-group" role="group" aria-label="Actions">
+                        <jhi-button
+                            [btnType]="ButtonType.PRIMARY"
+                            [btnSize]="ButtonSize.SMALL"
+                            [icon]="faSave"
+                            [title]="'artemisApp.userSettings.sshSettingsPage.saveSshKey'"
+                            (onClick)="saveSshKey()"
+                        />
+                    </div>
+                    <div class="btn-group" role="group" aria-label="Actions">
+                        <jhi-button
+                            [btnType]="ButtonType.PRIMARY"
+                            [btnSize]="ButtonSize.SMALL"
+                            [title]="'artemisApp.userSettings.sshSettingsPage.cancelSavingSshKey'"
+                            (onClick)="cancelEditingSshKey()"
+                        />
+                    </div>
+                </div>
+            </div>
+        }
+    </div>
+}