infix icon indicating copy to clipboard operation
infix copied to clipboard

Missing documentation for Infix keystore

Open jovatn opened this issue 11 months ago • 0 comments

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 avatar Jan 28 '25 09:01 jovatn