Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add DISABLE_SIGNUP environment variable #518

Closed

Conversation

justsml
Copy link

@justsml justsml commented Jan 5, 2025

Fixes #480

What kind of change does this PR introduce?

Add support for an env var to disable registration, DISABLE_SIGNUP.

Why was this change needed?

Other information:

Focused PR, shouldn't impact future enhancements.

Checklist:

Put a "X" in the boxes below to indicate you have followed the checklist;

  • I have read the CONTRIBUTING guide.
  • I checked that there were not similar issues or PRs already open for this.
  • This PR fixes just ONE issue (do not include multiple issues or types of change in the same PR) For example, don't try and fix a UI issue and include new dependencies in the same PR.

Summary by CodeRabbit

  • New Features
    • Added configuration option to disable user signups with the DISABLE_REGISTRATION variable.
  • Bug Fixes
    • Implemented signup restriction mechanism across authentication routes and services.
  • Configuration
    • Enhanced error reporting and validation for the DISABLE_REGISTRATION environment variable, including checks for boolean values.

Copy link

vercel bot commented Jan 5, 2025

@justsml is attempting to deploy a commit to the Listinai Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Jan 5, 2025

Walkthrough

The pull request introduces a new configuration variable DISABLE_REGISTRATION to control user registration. This feature allows administrators to disable new user signups by setting the environment variable to "true". The changes span across the .env.example file, the authentication controller, and the authentication service, implementing a mechanism to prevent new user registrations when the feature is toggled.

Changes

File Change Summary
.env.example Added DISABLE_REGISTRATION="false" configuration variable with explanatory comment
apps/backend/src/api/routes/auth.controller.ts Added conditional check to block user registration when DISABLE_REGISTRATION is "true"
apps/backend/src/services/auth/auth.service.ts Implemented error handling to prevent user creation when signup is disabled
libraries/helpers/src/configuration/configuration.checker.ts Added checkIsBoolean method for validating DISABLE_REGISTRATION and updated checkNonEmpty method to include description

Assessment against linked issues

Objective Addressed Explanation
Add ENV-Variable to disable user registration [#480]
Prevent abuse on public instances The variable added is DISABLE_REGISTRATION, not USER_REGISTRATION as specified in the issue.

Poem

🐰 A rabbit's tale of signup's fate,
Where config flags can regulate,
No more accounts at random's call,
With DISABLE_REGISTRATION, we control it all!
Security hops, registration stops. 🔒


📜 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 8196e74 and 8408e5c.

📒 Files selected for processing (1)
  • libraries/helpers/src/configuration/configuration.checker.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • libraries/helpers/src/configuration/configuration.checker.ts

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
🪧 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 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

@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: 0

🧹 Nitpick comments (4)
apps/backend/src/services/auth/auth.service.ts (2)

37-40: Assert consistent user feedback when signup is disabled.

When throwing the error 'Signup is disabled' here, ensure that the frontend properly handles and displays it. Consider returning a status code for a disabled signup scenario that is distinct from other error codes, making it easier for clients to handle this specific condition.


139-142: Avoid duplicating signup-disabled check logic.

These lines replicate the logic introduced in the routeAuth method. To keep the code DRY, consider abstracting the signup-disabled check into a shared helper function or a guard. That would ensure consistency & easier maintenance.

- if (process.env.DISABLE_SIGNUP === 'true') {
-   throw new Error('Signup is disabled');
- }
+ this.ensureSignupEnabled();

... // Then define a small helper function:
private ensureSignupEnabled() {
  if (process.env.DISABLE_SIGNUP === 'true') {
    throw new Error('Signup is disabled');
  }
}
.env.example (1)

10-10: Provide environment variable usage instructions.

This new environment variable is critical to controlling user registration. Consider adding a clarifying comment on how strongly the system enforces the restriction, and whether it affects only the local signup or all providers.

apps/backend/src/api/routes/auth.controller.ts (1)

40-43: Return an HTTP status code that best represents the disabled signup condition.

Using a 400 Bad Request for disabled signup is somewhat generic. Consider returning a 403 Forbidden or a 503 Service Unavailable for better semantic meaning and to accurately describe that the server is refusing signup requests due to configuration.

- response.status(400).json({ error: 'Signup is disabled' });
+ response.status(403).json({ error: 'Signup is disabled' });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5657b21 and 18d7b75.

📒 Files selected for processing (3)
  • .env.example (1 hunks)
  • apps/backend/src/api/routes/auth.controller.ts (1 hunks)
  • apps/backend/src/services/auth/auth.service.ts (2 hunks)

@nevo-david
Copy link
Contributor

@justsml
Copy link
Author

justsml commented Jan 6, 2025

I'm sure there's several adjacent auth features needed.

My thinking was to prioritize this security related "fix" since it buys time until a more robust solution can be implemented - never mind the necessary discussion & planning. (And I'm sure it'll get removed when it is no longer needed.)

As for the nginx config, I'm sure nginx users would appreciate that. There's also nginxproxymanager.com for a GUI to configure your nginx in pretty slick little container app.
(Don't forget Caddy users too...)

Users may eventually need something robust for Auth (w/ OAuth/Open ConnectID, SAML, MFA, Passkeys, etc 🙀.) I have been using Logto and Authentik however I recently started using Zitadel.

These options are probably better discussed under Discussions...

@justsml justsml mentioned this pull request Jan 6, 2025
1 task
.env.example Outdated Show resolved Hide resolved
Copy link

@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: 0

🧹 Nitpick comments (1)
libraries/helpers/src/configuration/configuration.checker.ts (1)

29-29: LGTM! Consider adding boolean value validation.

The addition of the DISABLE_REGISTRATION environment variable check is good. However, since this is meant to be a boolean flag, consider adding validation to ensure the value is either "true" or "false".

Here's a suggested implementation:

+ checkIsBoolean(key: string, description?: string): boolean {
+   if (!this.checkNonEmpty(key, description)) {
+     return false;
+   }
+   const value = this.get(key)?.toLowerCase();
+   if (value !== 'true' && value !== 'false') {
+     this.issues.push(`${key} must be either "true" or "false". ${description || ''}`);
+     return false;
+   }
+   return true;
+ }

  check() {
    this.checkDatabaseServers()
    this.checkNonEmpty('JWT_SECRET')
-   this.checkNonEmpty('DISABLE_REGISTRATION', 'Set to true to disable signup')
+   this.checkIsBoolean('DISABLE_REGISTRATION', 'Set to true to disable signup')
    this.checkIsValidUrl('MAIN_URL')
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d68c807 and d499f43.

📒 Files selected for processing (4)
  • .env.example (1 hunks)
  • apps/backend/src/api/routes/auth.controller.ts (1 hunks)
  • apps/backend/src/services/auth/auth.service.ts (2 hunks)
  • libraries/helpers/src/configuration/configuration.checker.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • .env.example
  • apps/backend/src/api/routes/auth.controller.ts
  • apps/backend/src/services/auth/auth.service.ts
🔇 Additional comments (1)
libraries/helpers/src/configuration/configuration.checker.ts (1)

29-29: Variable name inconsistency with PR objectives.

The PR objectives mention DISABLE_SIGNUP, but the code uses DISABLE_REGISTRATION. This inconsistency should be resolved to maintain clarity and prevent confusion.

Let's check for any other occurrences of these variables in the codebase:

Copy link

@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: 0

🧹 Nitpick comments (1)
libraries/helpers/src/configuration/configuration.checker.ts (1)

37-50: Enhance boolean validation robustness and consistency.

While the implementation works, consider these improvements:

  1. Handle undefined values explicitly
  2. Support case-insensitive comparison
  3. Simplify description handling
  4. Maintain consistent error message formatting

Here's a suggested implementation:

   checkIsBoolean (key: string, description?: string): boolean {
     const v = this.get(key)
-
-    if (!description) {
-      description = ''
-    }
-
-    if (v !== 'true' && v !== 'false') {
-      this.issues.push(key + ' is not a boolean. ' + description)
+    description = description || ''
+
+    if (!v) {
+      this.issues.push(`${key} not set. ${description}`)
+      return false
+    }
+
+    const normalized = v.toLowerCase()
+    if (normalized !== 'true' && normalized !== 'false') {
+      this.issues.push(`${key} is not a boolean. ${description}`)
       return false
     }

     return true
   }

This implementation:

  • Handles undefined values consistently with other methods
  • Supports case-insensitive comparison ('TRUE', 'True', etc.)
  • Uses template literals for consistent string formatting
  • Simplifies the description handling
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d499f43 and 8196e74.

📒 Files selected for processing (1)
  • libraries/helpers/src/configuration/configuration.checker.ts (1 hunks)
🔇 Additional comments (2)
libraries/helpers/src/configuration/configuration.checker.ts (2)

29-29: LGTM! Clear and well-placed validation check.

The addition of the DISABLE_REGISTRATION check with a descriptive message aligns well with the PR's objective to control user registration.


29-29: Verify the security implications of this feature.

Since this is a security-related feature for disabling user registration, let's verify its usage across the codebase.

Also applies to: 37-50

✅ Verification successful

Security implementation for DISABLE_REGISTRATION is robust and complete

The feature is properly implemented with multiple layers of protection:

  • Configuration validation in environment variables
  • Service-layer enforcement for both direct and provider-based registration
  • API-level protection with proper error responses
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage and implementation of DISABLE_REGISTRATION
# across the codebase to ensure proper security controls.

echo "Checking for DISABLE_REGISTRATION usage:"
rg -l "DISABLE_REGISTRATION"

echo -e "\nChecking for registration-related endpoints and their security controls:"
ast-grep --pattern 'router.$_(
  "/register",
  $$$
)'

echo -e "\nChecking for potential security bypass attempts:"
rg -i "register|signup" --type ts

Length of output: 12670

@justsml justsml closed this Jan 22, 2025
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.

Disable User Regsitration
3 participants