Skip to content

[806][FIX] Ensure passwords are aphanumeric #840

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

darius-m
Copy link

@darius-m darius-m commented Jun 5, 2025

Special characters in passwords may break some functionality. Celery seems to have an issue with special characters (either + or /) that cause the worker to exit without displaying any errors. Attempts to URL-escape the password seem to fail since the value is interpolated at some point and Python throws an exception since some %XX escape codes are not valid syntax.

This change reimplements the validate_config function to check that the POSTGRES password / admin password and IRIS secret key / password salt are long (longer than 30 characters) alphanumeric strings. It should not affect users of the "scripts/iris_helper.sh" helper script since the values generated by it are 32 characters long.

The old implementation was removed because the function was not called and the check section not in self looks invalid.

Closes #806

Special characters in passwords may break some functionality. Celery
seems to have an issue with special characters (either `+` or `/`) that
cause the worker to exit without displaying any errors. Attempts to
URL-escape the password seem to fail since the value is interpolated at
some point and Python throws an exception since some `%XX` escape codes
are not valid syntax.

This change reimplements the `validate_config` function to check that
the POSTGRES password / admin password and IRIS secret key / password
salt are long (longer than 30 characters) alphanumeric strings. It
should not affect users of the "scripts/iris_helper.sh" helper script
since the values generated by it are 32 characters long.

The old implementation was removed because the function was not called and
the check `section not in self` looks invalid.

Closes dfir-iris#806

Signed-off-by: Darius Mihai <[email protected]>
Copy link

coderabbitai bot commented Jun 5, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (1)
  • api_*

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

@whikernel
Copy link
Contributor

Hi @darius-m

Thanks for this PR (and all the other ones, really helpful) - for this one I'm afraid we'd stuck some users that are already using IRIS and don't have the required password length. It's a bit of a breaking change since change the DB password isn't that straightforward.

@darius-m
Copy link
Author

Hi @whikernel

I assumed the length may be an issue, and unfortunately I don't have a good idea how this should be handled. As a stop-gap, I added the environment variable that defines the minimum length, but it's not ideal either. I think the length requirement can be removed, if it can cause too many issues; the important part is making sure (various) special characters are avoided to not break Celery.

Also, the character set can be tweaked using regexes; instead of isalnum, the contents of the password can be checked using a regex (e.g., using ^[A-Za-z0-9_]+$ would also allow the _ character, which I think is not problematic, but I have not checked).

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.

2 participants