security/acme-client: DNS-01 nsupdate: Help for secret key should mention format
@fraenki is already working on this.
Since Feb 7, 2024.
- Dominant language
- PHP
- Stars
- 1.2k
- Forks
- 863
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 10
Description
Important notices
Before you add a new report, we ask you kindly to acknowledge the following:
- I have read the contributing guide lines at https://github.com/opnsense/plugins/blob/master/CONTRIBUTING.md
- I have searched the existing issues, open and closed, and I'm convinced that mine is new.
- When the request is meant for an existing plugin, I've added its name to the title.
Is your feature request related to a problem? Please describe.
It was unclear for me what to enter in the text field "Secret Key" for the challenge type "DNS-01", DNS Service "nsupdate (RFC 2136)". The help text currently says:
Requires the whole key file in a format that is compatible with nsupdate.
I entered the content of the key file as produced by tsig-keygen resp. dnssec-keygen:
Private-key-format: v1.3
Algorithm: 165 (HMAC_SHA512)
Key: 7DXXX...
Bits: AAA=
Created: 20240205213656
Publish: 20240205213656
Activate: 20240205213656
...which did not work.
After lengthy researches I found that the form, which is used in named.conf to define keys, did work:
key "_acme-challenge.example.com." {
algorithm hmac-sha512;
secret "7DXXX...";
};
The help text did not help me much. That's why I am asking to change it.
I don't know whether the code could work with the contents of a key file from tsig-keygen (I think it would need the pair of files K<xxx>.key and K<xxx>.private), if yes, then this request to change the help text is almost obsolete and there should be some testing with that key file format or describe how to use it.
Describe the solution you'd like
Since nsupdate supports two formats for key files, the help text is not wrong, but could be more elaborate to help. Please change the help text to say content of the key file, not to confuse with a path to a key file. Secondly, for as long as it is unclear whether the key file format from tsig-keygen does work or not, mention the format that works:
Enter the the key exactly as it is defined in named.conf of your bind server configuration, use the whole key{}-statement.
Please change this if needed, I am not a native speaker.
Describe alternatives you've considered
Alternatively:
Requires the whole content of the key file in a format that is compatible with nsupdate, which is one of two formats: a single key statement as used in named.conf of the bind server software, which was generated by ddns-confgen; or the content of the key file generated by dnssec-keygen resp. tsig-keygen.
Additional context
It might be possible that even SIG(0) key pairs are supported. In this case the help text should mention this as well.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.