TracecatHQ / tracecat

The open source Tines / Splunk SOAR alternative for security engineers.
https://tracecat.com
GNU Affero General Public License v3.0
2.42k stars 173 forks source link

feat: Promote first user to admin superuser + remove default admin user #532

Closed daryllimyt closed 1 week ago

daryllimyt commented 1 week ago

Changes

Screens

https://github.com/user-attachments/assets/6305dfa2-f92a-49f0-8610-d36414244ef1

Summary by CodeRabbit

Release Notes

These changes enhance user experience and security while simplifying the setup process.

coderabbitai[bot] commented 1 week ago

Walkthrough

The pull request introduces significant changes to the authentication configuration across multiple files. It removes specific admin user setup environment variables and adds new variables that enhance general authentication settings. Additionally, workflow configurations have been updated to allow manual execution, and error handling improvements have been made in user registration processes. These changes streamline the setup and management of authentication while enhancing error handling and flexibility in the application.

Changes

File Change Summary
.env.example Removed TRACECAT__SETUP_ADMIN_EMAIL, TRACECAT__SETUP_ADMIN_PASSWORD; added TRACECAT__AUTH_ALLOWED_DOMAINS, TRACECAT__AUTH_MIN_PASSWORD_LENGTH.
.github/workflows/test-python.yml Added workflow_dispatch trigger; updated permissions; removed TRACECAT__SETUP_ADMIN_EMAIL and TRACECAT__SETUP_ADMIN_PASSWORD.
docker-compose.dev.yml Added TRACECAT__AUTH_ALLOWED_DOMAINS, TRACECAT__AUTH_MIN_PASSWORD_LENGTH; removed TRACECAT__SETUP_ADMIN_EMAIL, TRACECAT__SETUP_ADMIN_PASSWORD.
docker-compose.yml Added TRACECAT__AUTH_ALLOWED_DOMAINS, TRACECAT__AUTH_MIN_PASSWORD_LENGTH; removed TRACECAT__SETUP_ADMIN_EMAIL, TRACECAT__SETUP_ADMIN_PASSWORD.
env.sh Removed user prompts for admin email and password; deleted password validation logic.
frontend/src/components/auth/sign-up.tsx Enhanced error handling in BasicRegistrationForm for registration errors.
tests/conftest.py Added TRACECAT__AUTH_ALLOWED_DOMAINS to env_sandbox; updated test_admin_user fixture to use dynamic values.
tracecat/api/app.py Added exception handler for FastAPIUsersException; removed logic for creating default admin user.
tracecat/auth/users.py Added InvalidDomainException; enhanced user management with new validation methods.
tracecat/config.py Added TRACECAT__AUTH_ALLOWED_DOMAINS and TRACECAT__AUTH_MIN_PASSWORD_LENGTH configuration variables.
tracecat/registry/client.py Updated error handling in call_action method to check if detail is a mapping.
pyproject.toml Added dependency email-validator with version constraint >=2.0.0.

Possibly related PRs

Suggested labels

internal, infrastructure

Suggested reviewers

Poem

🐰 In the meadow where bunnies play,
New settings bloom, brightening the day.
Admin paths have faded away,
With domains and passwords, come what may!
Hop along, let errors be clear,
A joyful change, let’s give a cheer! 🌼

[!WARNING]

Rate limit exceeded

@daryllimyt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 25 seconds before requesting another review.

⌛ How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
🚦 How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://docs.coderabbit.ai/faq) for further information.
📥 Commits Reviewing files that changed from the base of the PR and between 549735863c1f1a9486d7c1726fbc93d69c64fbb3 and 853739478a94caf2f99af7b18cfd3f8726ca0dce.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.