digitalautonomy/keymirror

KeyMirror is a tool to help inspect and convert key material on your computer.

keymirror's Issues

AS A system administrator I WANT TO be able to load key details about an SSH key pair containing both a private and public key IN ORDER TO understand the key better and make sure the information is valid

AS A system administrator I WANT TO be able to load key details about an SSH private key on my system IN ORDER TO understand the key better even without the public key

Acceptance criteria:

• When pressing a private key in the key list, the path for the private key should be displayed in the key details window
• The path should follow the same requirements as those used for displaying the public key path
• When a public key is pressed, no information about a private key will be visible
• The key detail window should indicate in some way that you are viewing a private key instead of a public key, apart from the path

AS A system administrator I WANT a key list that includes EcDSA SK key files that are configured inside the SSH configuration file IN ORDER TO understand what keys I have available

AS A system administrator I WANT a key list that includes Ed25519 SK key files that are configured inside the SSH configuration file IN ORDER TO understand what keys I have available

AS A system administrator I WANT a key list that includes EcDSA SK key files from the SSH2 directory in my home directory IN ORDER TO understand what keys I have available

AS A latin american user with Spanish as my operating system language I WANT all dialogs and texts to automatically be in Spanish IN ORDER TO understand the application

AS A system administrator I WANT TO be able to see that no private key is available IN ORDER TO know what kind of key I'm working on

AS A system administrator I WANT a key list that includes EcDSA key files that are configured inside the SSH configuration file IN ORDER TO understand what keys I have available

AS A system administrator I WANT a key list that includes Ed25519 key files from the SSH2 directory in my home directory IN ORDER TO understand what keys I have available

AS A system administrator I WANT TO be able to see that no public key is available IN ORDER TO know what kind of key I'm working on

AS A system administrator I WANT a key list that includes Ed25519 key files that are configured inside the SSH configuration file IN ORDER TO understand what keys I have available

AS A system administrator I WANT a key list that includes DSA key files from the SSH2 directory in my home directory IN ORDER TO understand what keys I have available

AS A system administrator I WANT the key listing to be sorted by the user id of the key and then the path of the key by default IN ORDER TO have an initial view that is easy to follow

AS A system administrator I WANT a key list that includes Ed25519 SK key files from the SSH directory in my home directory IN ORDER TO understand what keys I have available

AS A system administrator I WANT TO be sure that the private and public key together are a valid key pair IN ORDER TO identify corrupted keys on my system or other potential issues

AS A system administrator I WANT the key list to show the path to the private key file if no public key file is available IN ORDER TO know where the key is stored

AS A system administrator I WANT TO be informed if a key uses an algorithm or key size that is weak IN ORDER TO be able to improve the security of my system

AS A system administrator I WANT TO be able to load key details about an SSH public key on my system IN ORDER TO understand the key better even without the private key

Acceptance criteria

• When a public key in the key list is clicked and no key details are being detailed, a segment of the window will open up and show key details for that key - this segment of the window will be called the key details component in the rest of these criteria.
• When a key pair in the key list is clicked, the key details component will remove what was previously shown, and instead display information about the public key from the clicked key pair
• The key details component when displayed, can be closed in some way such that no key details are shown anymore
• In this story, the only information that will be displayed in the key details component is the PATH of the public key
• If a private key is clicked in the key list, the current information in the key details component will be removed, if the component is visible. If the component is not visible, nothing will happen.
• The key list should highlight in some way which key entry is currently being displayed in the key details component.
• If the path of the public key is too long to fit in the current size of the component, the FRONT of the path (the root component) should be truncated to fit, and a ellipsis be inserted in front to indicate the removed parts. For example, if you have the path "/home/someonewithalong/ssh/path/to/their/home/.ssh/github.pub", could be truncated to "...ath/to/their/home/.ssh/github.pub". In the case of truncation, you should be able to hover over the path and the full path will be displayed in a tooltip of some kind.
• If the window is resized, any decision about truncation should be recalculated
• The path should be displayed properly even if it contains "strange" characters, spaces or other unicode code points.
• TODO: create new story for this behavior: The component should have a button in one corner, with some kind of symbol with two arrows maybe, that when you press it will expand the window to a sufficient size to display the information inside it, with reasonable limits (it shouldn't expand to be larger than the display size of the desktop, for example)
• TODO: create new story for adding a button or way of opening of the folder containing the public key in Nautilius or whatever file explorer the user has

AS A system administrator I WANT a key list that includes Ed25519 SK key files that are configured inside the SSH2 configuration file IN ORDER TO understand what keys I have available

AS A non-technical user I WANT the key list to only include one key entry even if both public and private key files are available IN ORDER TO avoid confusion

AS A system administrator I WANT the key list to show whether a key is used for a specific server or not IN ORDER TO get an overview about what keys will be used for what purpose

AS A system administrator I WANT TO be able to see where the private key file displayed was loaded from IN ORDER TO know which key I'm viewing

AS A system administrator I WANT a key list that includes DSA key files that are configured inside the SSH configuration file IN ORDER TO understand what keys I have available

AS A system administrator I WANT a key list that includes RSA key files that are configured inside the SSH configuration file IN ORDER TO understand what keys I have available

AS A system administrator I WANT to be able to sort the key list based on the algorithm of the key IN ORDER TO easier find the key I am interested in

AS A system administrator I WANT a key list that includes EcDSA key files that are configured inside the SSH2 configuration file IN ORDER TO understand what keys I have available

AS A system administrator I WANT a key list that includes RSA key files that are configured inside the SSH2 configuration file IN ORDER TO understand what keys I have available

AS A system administrator I WANT TO be able to see key details about a password protected key IN ORDER TO fully understand the key I'm working on

Acceptance criteria:

• A password protected ed25519 or RSA private key should still show up in the key list, with the same appearance as a non-protected private key
• A password protected ed25519 or RSA private key should also still show up in the key list as part of a key pair with no difference in appearance
• When showing the key details for a password protected private key, or a key entry containing a password protected key, the component should indicate somewhere in the key details window that the private key Is password protected
• For now, we do not need to manage passwords or open up the private key material. This should be revisited in the first story that uses private key material for something.

AS A system administrator I WANT a key list that includes Ed25519 key files from the SSH directory in my home directory IN ORDER TO understand what keys I have available

AS A system administrator I WANT a key list that includes EcDSA key files from the SSH directory in my home directory IN ORDER TO understand what keys I have available

AS A system administrator I WANT a key list that includes EcDSA SK key files that are configured inside the SSH2 configuration file IN ORDER TO understand what keys I have available

AS A system administrator I WANT a key list that includes Ed25519 SK key files from the SSH2 directory in my home directory IN ORDER TO understand what keys I have available

AS A system administrator I WANT a key list that includes DSA key files from the SSH directory in my home directory IN ORDER TO understand what keys I have available

AS A system administrator I WANT a key list that includes DSA key files that are configured inside the SSH2 configuration file IN ORDER TO understand what keys I have available

AS A system administrator I WANT a key list that includes RSA key files from the SSH2 directory in my home directory IN ORDER TO understand what keys I have available

AS A security developer I WANT the key list to show the key size IN ORDER TO know the security properties of the keys on my system and easily be able to identify keys with lower security

AS A system administrator I WANT to be able to sort the key list based on the key size IN ORDER TO easier find the key I am interested in

AS A system administrator I WANT a key list that includes EcDSA SK key files from the SSH directory in my home directory IN ORDER TO understand what keys I have available

AS A system administrator I WANT TO see what servers the current key is used for IN ORDER TO identify how the key I'm working on is used

AS A system administrator I WANT a key list that includes Ed25519 key files that are configured inside the SSH2 configuration file IN ORDER TO understand what keys I have available

AS A security developer I WANT the key list to show the key algorithm used for that key IN ORDER TO know the security properties of the keys on my system

AS A system administrator I WANT the key list to show the path to the public key file IN ORDER TO know where the key is stored

AS A system administrator I WANT TO be able to see where the public key file displayed was loaded from IN ORDER TO know which key I'm viewing

AS A system administrator I WANT a key list that includes EcDSA key files from the SSH2 directory in my home directory IN ORDER TO understand what keys I have available

AS A system administrator I WANT TO be informed if there's some corruption in the private or public key material IN ORDER TO be able to imrpove the security of my system

AS A system administrator I WANT a key list that includes RSA key files from the SSH directory in my home directory IN ORDER TO understand what keys I have available

Acceptance criteria

All the below acceptance criteria are specific to the $HOME/.ssh directory, and that is what is referred to when talking about the directory below.

• A window should be displayed
• If there are no ssh RSA keys in the folder then a message should be displayed
• If there are, an entry for each RSA key pair or public/private key without corresponding pair should appear on the list
• A scroll bar should appear in order to scroll over the list only if there are too many keys to display
• If the user has no .ssh directory in its home directory, the application should behave as if the .ssh directory existed but was empty
• If the program can't read the .ssh directory, the application should behave as if the .ssh directory existed but was empty and log a message in the log
• If there is a file in the .ssh directory that doesn't contain an actual RSA key, then we don't display that file on the list
• If a file does not follow the naming convention but does contain an RSA key, then we display it
• If two files follow the naming convention (for example: id_rsa and id_rsa.pub) we will display them as one entry on the list; we will not verify if they match
• If two files do not follow the naming convention (for example: id_rsa and id_rsa_other.pub) but they match, they will be displayed as two separate items on the list
• No distinction will be made on the list between public or private keys
• No indication that they are RSA keys, only thing on the list will be name of the file
• We should output useful information for each operation in the story for debugging purposes
• This story will NOT cover de-duplication (if a public or private key is found in more than one place, they will be shown as separate entries in the key list)
• When displaying a key entry for a key pair, only the path to the PRIVATE key will be displayed.

AS A security developer I WANT TO see the algorithm for the key I'm currently working on IN ORDER TO know the security properties of the keys on my system

AS A system administrator I WANT the key list to display where a private key is available or only a public key IN ORDER TO understand what types of keys I have available

AS A system administrator I WANT to be able to sort the key list based on the path of the key IN ORDER TO easier find the key I am interested in

AS A system administrator I WANT to be able to sort the key list based on the user ID of the key IN ORDER TO easier find the key I am interested in