Fix "pihole-FTL --help" output for --gen-x509 option with domain parameter

mattvw · October 24, 2024, 1:01pm

Hello,

This is in the 6.0 beta (running latest development branches for each component).

Currently the 'pihole-FTL --help' command output shows this:

...
TLS X.509 certificate generator:
    Generate a self-signed certificate suitable for SSL/TLS
    and store it in outfile.

    By default, this new certificate is based on the elliptic
    curve secp521r1. If the optional flag [rsa] is specified,
    an RSA (4096 bit) key will be generated instead.

    Usage: pihole-FTL --gen-x509 outfile [rsa]
...

However, per X.509: Create and export CA certificate by DL6ER · Pull Request #1860 · pi-hole/FTL · GitHub, it seems to be possible to also specify an optional domain parameter to this command to make it generate a certificate for a specific domain (2nd example in the "Note" of the PR description). I've tried it and it works successfully just as you'd expect!

It'd be great to see use ability to use that optional parameter be included in the --help output as well (and any other documentation being created), as I didn't realize it was possible until I manually searched the Pi-hole Discourse and found a post that mentioned the above PR (PiHole v6 & Firefox android - #5 by DL6ER).

Just a suggestion to make it more clear what you can do with this command! It's also already shown in the --read-x509 option that you can specify an optional domain parameter.

I also wanted to take the opportunity to give some praise:
The more I've explored all the new functionality in 6.0, the more I'm impressed and the more I'm excited for it to be GA for everyone! Awesome work! I'm proud to continue to support and advocate for the use of Pi-hole!

Thanks as always for all your amazing work on this project!

DL6ER · October 24, 2024, 5:23pm

Thank you for the hint!

Please check out if you think this is sufficient:

Screenshot from 2024-10-24 19-22-03

github.com/pi-hole/FTL

Update --gen-x509 help text

pi-hole:development ← pi-hole:fix/help_x509

opened 05:23PM - 24 Oct 24 UTC

DL6ER

+4 -1

# What does this implement/fix? Adds description for optional `[domain]`: …![image](https://github.com/user-attachments/assets/245eb5b2-fc16-43d2-aa77-0a6744b7e047) --- **Related issue or feature (if applicable):** https://discourse.pi-hole.net/t/fix-pihole-ftl-help-output-for-gen-x509-option-with-domain-parameter/73622 **Pull request in [docs](https://github.com/pi-hole/docs) with documentation (if applicable):** N/A --- **By submitting this pull request, I confirm the following:** 1. I have read and understood the [contributors guide](https://docs.pi-hole.net/guides/github/contributing/), as well as this entire template. I understand which branch to base my commits and Pull Requests against. 2. I have commented my proposed changes within the code. 3. I am willing to help maintain this change if there are issues with it later. 4. It is compatible with the [EUPL 1.2 license](https://opensource.org/licenses/EUPL-1.1) 5. I have squashed any insignificant commits. ([`git rebase`](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)) ## Checklist: - [x] The code change is tested and works locally. - [x] I based my code and PRs against the repositories `developmental` branch. - [x] I [signed off](https://docs.pi-hole.net/guides/github/how-to-signoff/) all commits. Pi-hole enforces the [DCO](https://docs.pi-hole.net/guides/github/dco/) for all contributions - [x] I [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) all my commits. Pi-hole requires signatures to verify authorship - [x] I have read the above and my PR is ready for review.

edit Already part of development by now.

mattvw · October 24, 2024, 8:16pm

Looks great to me!

Thanks!!