Programming exercises: Add logging of failed authorization attempts to the VCS access log

[SimonEntholzer]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Server

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) and too complex database calls.
• I strictly followed the principle of data economy for all database calls.
• I strictly followed the server coding and design guidelines.
• I documented the Java code using JavaDoc style.

Changes affecting Programming Exercises

• High priority: I tested all changes and their related features with all corresponding user types on a test server configured with the integrated lifecycle setup (LocalVC and LocalCI).

Motivation and Context

At the moment the VCS access log, logs only fully successful interactions, and interactions failing at the authentication step already.
When pushing/pulling fails at the authorization, Artemis writes no VCS access log, in the case of HTTPS not even a server log.

Description

• add VCS access log entry when authorization fails for SSH and

Steps for Testing

1. Create a programming exercise
2. participate with a student (clone and push)
3. As the instructor, set the due date of the exercise to the current time
4. Try to push to the repository with the student account (this should fail) Via SSH and HTTPS
5. Check the access log as the instructor

Testserver States

You can manage test servers using Helios. Check environment statuses in the environment list. To deploy to a test server, go to the CI/CD page, find your PR or branch, and trigger the deployment.

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Added a new authentication constant to represent missing authentication headers.
  • Introduced a method for logging failed access attempts to enhance tracking of permission issues.
  • Added a method to retrieve the latest commit hash from a repository.

• Bug Fixes

  • Enhanced error handling for repository access, providing clearer feedback when permissions are denied.
  • Improved logging for failed access attempts, ensuring better tracking of access issues.

[coderabbitai]

Walkthrough

This pull request introduces modifications across authentication and version control access handling. The changes extend the enumeration of authentication mechanisms by adding a new constant NONE, which represents a scenario where the authentication header is missing. Additionally, the service managing local version control now includes enhanced error handling with try-catch blocks, improved logging for failed access attempts, and a centralized method for commit hash retrieval. A related service updates its error handling to log failed access on exceptions, ensuring more detailed tracking of authorization issues.

Changes

File(s)	Change Summary
src/.../AuthenticationMechanism.java	Added a new enum constant: NONE to represent a missing authentication header.
src/.../LocalVCServletService.java	Enhanced error handling via try-catch blocks, improved logging with saveFailedAccessVcsAccessLog, and introduced methods for commit hash retrieval and authentication mechanism resolution. Updated documentation for authorizeUser.
src/.../SshGitLocationResolverService.java	Added a call to saveFailedAccessVcsAccessLog for logging failed access attempts on LocalVCForbiddenException.
src/.../AuthenticationContext.java	Introduced a new sealed interface AuthenticationContext with records Session and Request to standardize IP address retrieval.

Suggested labels

bugfix, tests, documentation

Suggested reviewers

• HawKhiem
• BBesrour
• az108
• JohannesStoehr
• krusche
• N0W0RK

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[ole-ve]

code seems fine, see my inline comments.

just as a pointer: some server tests are currently failing as no exception seem to be thrown anymore. also, coverage is mildly violated 🙃

[ole-ve]

also tested on TS6, works fine.

Code + Manual test

[coolchock]

code + manual test, LGTM

[cremertim]

Code lgtm

[ole-ve]

re-approve after re-throwing exception instead of throwing a new one

[magaupp]

Some suggestions

[magaupp]

Thanks for the change. Code looks good 👍

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/AuthenticationContext.java (3)

7-26: Add JavaDoc documentation to improve code maintainability.

The new AuthenticationContext interface design is clean and follows good principles, but would benefit from proper documentation explaining:

1. The purpose of this interface
2. How it relates to logging failed authorization attempts
3. When to use each implementation

Add documentation like:

/**
 * Provides a common interface for accessing authentication context information
 * from different sources (SSH sessions and HTTP requests).
 * Used primarily for logging failed authorization attempts to the VCS access log.
 */
public sealed interface AuthenticationContext {

    /**
     * Implementation for SSH-based authentication.
     */
    record Session(ServerSession session) implements AuthenticationContext {
        // ...
    }

    /**
     * Implementation for HTTP-based authentication.
     */
    record Request(HttpServletRequest request) implements AuthenticationContext {
        // ...
    }

    /**
     * Returns the IP address of the client.
     * @return the IP address as a string
     */
    String getIpAddress();
}

---

12-14: Consider adding null checks for defensive programming.

The implementation assumes that session will never be null. If there's a possibility of null values, consider adding defensive checks.

@Override
public String getIpAddress() {
-    return session.getClientAddress().toString();
+    return session != null && session.getClientAddress() != null 
+           ? session.getClientAddress().toString() 
+           : "unknown";
}

---

20-22: Consider adding null checks for defensive programming.

Similar to the Session implementation, consider adding checks for null request.

@Override
public String getIpAddress() {
-    return request.getRemoteAddr();
+    return request != null ? request.getRemoteAddr() : "unknown";
}

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f1c58f6 and f659e98.

📒 Files selected for processing (4)

• src/main/java/de/tum/cit/aet/artemis/programming/domain/AuthenticationMechanism.java (1 hunks)
• src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/AuthenticationContext.java (1 hunks)
• src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCServletService.java (5 hunks)
• src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/SshGitLocationResolverService.java (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

• src/main/java/de/tum/cit/aet/artemis/programming/domain/AuthenticationMechanism.java
• src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/SshGitLocationResolverService.java
• src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCServletService.java

🧰 Additional context used

📓 Path-based instructions (1)

`src/main/java/**/*.java`: naming:CamelCase; principles:{sin...

src/main/java/**/*.java: naming:CamelCase; principles:{single_responsibility,small_methods,no_duplication}; db:{perf_queries,datetime_not_timestamp}; rest:{stateless,singleton,delegate_logic,http_only,minimal_dtos}; dtos:{java_records,no_entities,min_data,single_resp}; di:constructor_injection; kiss:simple_code; file_handling:os_indep_paths; practices:{least_access,avoid_transactions,code_reuse,static_member_ref,prefer_primitives}; sql:{param_annotation,uppercase,avoid_subqueries};java:avoid_star_imports

• src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/AuthenticationContext.java

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: Call Build Workflow / Build and Push Docker Image
• GitHub Check: Call Build Workflow / Build .war artifact
• GitHub Check: Codacy Static Code Analysis
• GitHub Check: client-style
• GitHub Check: client-tests
• GitHub Check: server-tests
• GitHub Check: server-style
• GitHub Check: Analyse