Skip to content

Implementing reCAPTCHA validation as part of the authentication service.#214

Merged
vanitha1822 merged 3 commits intodevelopfrom
reCaptcha
Jun 11, 2025
Merged

Implementing reCAPTCHA validation as part of the authentication service.#214
vanitha1822 merged 3 commits intodevelopfrom
reCaptcha

Conversation

@vishwab1
Copy link
Copy Markdown
Member

@vishwab1 vishwab1 commented Jun 6, 2025

📋 Description

JIRA ID: [AMM-1247]

Please provide a summary of the change and the motivation behind it. Include relevant context and details.


✅ Type of Change

  • 🐞 Bug fix (non-breaking change which resolves an issue)
  • New feature (non-breaking change which adds functionality)
  • 🔥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 🛠 Refactor (change that is neither a fix nor a new feature)
  • ⚙️ Config change (configuration file or build script updates)
  • 📚 Documentation (updates to docs or readme)
  • 🧪 Tests (adding new or updating existing tests)
  • 🎨 UI/UX (changes that affect the user interface)
  • 🚀 Performance (improves performance)
  • 🧹 Chore (miscellaneous changes that don't modify src or test files)

ℹ️ Additional Information

Please describe how the changes were tested, and include any relevant screenshots, logs, or other information that provides additional context.

Summary by CodeRabbit

  • New Features
    • Introduced CAPTCHA validation during user authentication to enhance security.
    • Added support for submitting a CAPTCHA token as part of the login process.
  • Configuration
    • Added new configuration properties for CAPTCHA secret key, verification URL, and enable flag in environment and example properties files.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 6, 2025

Walkthrough

CAPTCHA validation has been integrated into the user authentication flow. This includes adding new configuration properties for CAPTCHA integration, introducing a service for CAPTCHA validation, updating the login request model to include a CAPTCHA token, and modifying the authentication controller to validate the CAPTCHA token before proceeding with user authentication.

Changes

Files/Groups Change Summary
src/main/environment/common_ci.properties, src/main/environment/common_example.properties Added captcha.secret-key, captcha.verify-url, and captcha.enable-captcha properties for CAPTCHA integration.
src/main/java/com/iemr/common/model/user/LoginRequestModel.java Added a new field captchaToken to the login request model.
src/main/java/com/iemr/common/service/recaptcha/CaptchaValidationService.java Introduced a new service class for validating CAPTCHA tokens via HTTP POST requests to a configured endpoint.
src/main/java/com/iemr/common/controller/users/IEMRAdminController.java Injected the CAPTCHA validation service and updated the authentication method to validate the CAPTCHA token first, with mobile client detection and error handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Controller as IEMRAdminController
    participant CaptchaService as CaptchaValidationService
    participant AuthService as Existing Auth Logic

    User->>Controller: Submit LoginRequestModel (with captchaToken)
    Controller->>CaptchaService: validateCaptcha(captchaToken)
    CaptchaService->>CaptchaService: Validate token (HTTP POST to verify-url)
    CaptchaService-->>Controller: true/false
    alt CAPTCHA validation fails
        Controller-->>User: Return error (CAPTCHA failed)
    else CAPTCHA validation passes or skipped
        Controller->>AuthService: Continue with password decryption and authentication
        AuthService-->>Controller: Authentication result
        Controller-->>User: Return authentication result
    end
Loading

Suggested reviewers

  • helenKaryamsetty

Poem

In the land of code where logins begin,
A bunny hops in, with CAPTCHA to win.
With secrets and tokens, the gates are now wise,
Only true users may claim their prize.
A hop, a check, and all is secure—
The login meadow is safe, that’s for sure!
🐇🔐


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c48b0bd and 53b82d3.

📒 Files selected for processing (1)
  • src/main/java/com/iemr/common/controller/users/IEMRAdminController.java (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/main/java/com/iemr/common/controller/users/IEMRAdminController.java
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: style-check / checkstyle
  • GitHub Check: Build
  • GitHub Check: Package-test
  • GitHub Check: Analyze (java)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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 anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

🧹 Nitpick comments (1)
src/main/java/com/iemr/common/controller/users/IEMRAdminController.java (1)

83-84: Consider aligning variable naming with class name.

The variable name captchaValidatorService doesn't match the class name CaptchaValidationService. Consider renaming for consistency.

 @Autowired
-private CaptchaValidationService captchaValidatorService;
+private CaptchaValidationService captchaValidationService;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fcb10a7 and b20b51d.

📒 Files selected for processing (5)
  • src/main/environment/common_ci.properties (1 hunks)
  • src/main/environment/common_example.properties (1 hunks)
  • src/main/java/com/iemr/common/controller/users/IEMRAdminController.java (3 hunks)
  • src/main/java/com/iemr/common/model/user/LoginRequestModel.java (1 hunks)
  • src/main/java/com/iemr/common/service/recaptcha/CaptchaValidationService.java (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: style-check / checkstyle
  • GitHub Check: Package-test
  • GitHub Check: Analyze (java)
  • GitHub Check: Build
🔇 Additional comments (4)
src/main/environment/common_ci.properties (1)

177-178: LGTM! Proper environment variable configuration.

The captcha configuration properties are correctly implemented using environment variable placeholders, which is the appropriate approach for CI environments to keep sensitive values secure.

src/main/environment/common_example.properties (1)

201-203: LGTM! Clear example configuration provided.

The captcha configuration examples are well-documented with clear placeholders and the correct Cloudflare Turnstile verification URL. The formatting with the trailing blank line is consistent with the file's style.

src/main/java/com/iemr/common/model/user/LoginRequestModel.java (1)

34-34: LGTM! Clean field addition for captcha support.

The captchaToken field is properly added and will integrate seamlessly with the existing Lombok-generated methods. The field placement and type are appropriate for captcha token handling.

src/main/java/com/iemr/common/controller/users/IEMRAdminController.java (1)

58-58: LGTM: Clean import addition.

The import statement is properly placed and follows Java conventions.

Comment thread src/main/java/com/iemr/common/controller/users/IEMRAdminController.java Outdated
vanitha1822
vanitha1822 previously approved these changes Jun 10, 2025
Comment thread src/main/java/com/iemr/common/controller/users/IEMRAdminController.java Outdated
Comment thread src/main/java/com/iemr/common/controller/users/IEMRAdminController.java Outdated
@sonarqubecloud
Copy link
Copy Markdown

@vishwab1 vishwab1 requested a review from vanitha1822 June 11, 2025 09:10
@vanitha1822 vanitha1822 merged commit 797267a into develop Jun 11, 2025
7 checks passed
@vanitha1822 vanitha1822 deleted the reCaptcha branch June 11, 2025 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants