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

Missing documentation for Infix keystore #914

Open
jovatn opened this issue Jan 28, 2025 · 0 comments
Open

Missing documentation for Infix keystore #914

jovatn opened this issue Jan 28, 2025 · 0 comments
Labels
bug Something isn't working
Milestone

Comments

@jovatn
Copy link
Contributor

jovatn commented Jan 28, 2025

Current Behavior

Infix management documentation refers to the keystore as part of the SSH section, but there is no user documenation on the Infix keystore and how to use it.

As minimum, the existing functionality should be documented. Perhaps there should also be additional functionality, but that would render a new issue (or the title of this issue should be changed).

The following functionality is available for configuration

admin@example:/config/> edit keystore
admin@example:/config/keystore/> help
  asymmetric-key                    An asymmetric key.
  symmetric-key                     A symmetric key.
admin@example:/config/keystore/>

The current online help is sparse, and I cannot say if it is correct

admin@example:/config/keystore/> help asymmetric-key 
NAME
        name <string>

DESCRIPTION
        An arbitrary name for the asymmetric key.

admin@example:/config/keystore/> help symmetric-key 
NAME
        name <string>

DESCRIPTION
        An arbitrary name for the symmetric key.

admin@example:/config/keystore/>

This is what the config output looks like on infix default (qemu).

admin@example:/config/keystore/> show
asymmetric-keys {
  asymmetric-key genkey {
    public-key-format ssh-public-key-format;
    public-key MIIBCgKCAQEAm6uCENSafz7mIfIJ8O.... AQAB;
    private-key-format rsa-private-key-format;
    cleartext-private-key MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYw...b7dyPr4mpHg==;
  }
}


admin@example:/config/keystore/>

Expected Behavior

User documentation for the keystore could perhaps be put in separate file like "doc/keystore.md".
It could contain rudimentary information on how it works, and example of how to use it.

Steps To Reproduce

Not applicable

Additional information

None

@jovatn jovatn added bug Something isn't working triage Pending investigation & classification (CCB) labels Jan 28, 2025
@troglobit troglobit removed the triage Pending investigation & classification (CCB) label Jan 30, 2025
@troglobit troglobit added this to the Infix v25.02 milestone Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: No status
Development

No branches or pull requests

2 participants