More descriptive authentication errors

[itaymendel]

Expected Behavior

When my remote command fails due to an authentication issue, have a more descriptive error presented, instead of looking into the logs.

Actual Behavior

Bit fails to authenticate, prompts username/password request, and fails again. The actual error is found in the logs.

Examples

While there are few examples of it, and different flow Bit tries to do when authenticating, this might be somewhat problematic... As Bit has a fallback mechanism between different ways it tries to authenticate.

• SSH key defined in bit config.
• SSH key fetches from ssh-agent.
• user.token not defined...
• ssh key has passphrase and Bit can't handle it at the moment.
• an actual authentication issue with the remote scope.

each issue needs to be asserted in an error message.
also - consider add --verbose option to show each of the fallbacks.

[GiladShoham]

Thanks, we will improve our logs.
@davidfirst can we improve our ssh logs?

[itaymendel]

I'm not referring to the logs, but rather the outputs to the terminal. Right now the only possible way to debug connectivity issues is via the logs, as the outputs are meaningless.

[davidfirst]

To address this issue, two PRs were opened.

1. enable print log messages that start with a specific string to the co… #1481 (merged), which enabled printing a specific chunk of the log to the console. In this case, to print only log messages of the ssh module, prefix the command with BIT_LOG=ssh.

2. Ssh login refactoring #1480 (merged), which changes all the previous obscure messages to be descriptive and meaningful. An example of a case where all strategies were failed:

BIT_LOG=ssh bit import david.utils/is-string

ssh, trying to connect using token
ssh, token exists but failed to authenticate. either, the token is invalid or invoked
ssh, failed to connect using token
ssh, trying to connect using ssh-agent
ssh there is no ssh-agent socket or it has been disabled
ssh, failed to connect using ssh-agent
ssh, trying to connect using ssh-key
ssh, reading ssh key at /Users/myuser/.ssh/id_rsa
ssh, got an error connecting with ssh-key, in case passphrase is used, try to enable the ssh-agent
ssh ssh-key exists but failed to connect due to an error "Cannot parse privateKey: Unsupported key format"
ssh, failed to connect using ssh-key
ssh, trying to connect using user-password
ssh, user and password were entered but failed to connect
ssh, failed to connect using user-password
ssh all connection strategies have been failed!
authentication failed. see troubleshooting at https://docs.bitsrc.io/docs/authentication-issues.html

Also, the error message has been improved to outline the failed strategy.
An example of such an error:
bit import david.utils/is-string

authentication failed. see troubleshooting at https://docs.bitsrc.io/docs/authentication-issues.html

The following strategies were failed
[-] token exists but failed to authenticate. either, the token is invalid or invoked
[-] there is no ssh-agent socket or it has been disabled
[-] got an error connecting with ssh-key, in case passphrase is used, try to enable the ssh-agent
[-] user and password were entered but failed to connect