Feature request: Support authentication via ssh-agent

[dosas]

ssh2-python supports authentication using ssh-agent.

Could this be added here additionally to password and key file?

There are setups where for security reasons the password is not given and only login via ssh-key is allowed. Furthermore the key is stored in the agent as not to be leaked in any CI setup.

[JacobCallahan]

@dosas thanks for raising this interesting issue. Is something like this what you're thinking about?

        if key_filename:
            if not Path(key_filename).exists():
                raise FileNotFoundError(f"Key not found in '{key_filename}'")
            self.session.userauth_publickey_fromfile(user, key_filename)
        elif kwargs.get("password"):
            self.session.userauth_password(user, kwargs["password"])
        elif user:
            try:
                self.session.agent_auth(user)
            except Exception as err:
                raise exceptions.AuthenticationError("Agent-based authentication failed.") from err
        else:
            raise exceptions.AuthenticationError("No password or key file provided.")

Additionally, I'd be interested in knowing how you came across this project and this particular area of Broker.

[dosas]

@JacobCallahan yes that is exaclty what I was thinking about :) Very nice.

I came accross this project when trying to run some tests with robottelo.

[JacobCallahan]

Ahh nice, welcome!

[dosas]

Should I create a PR?

[JacobCallahan]

@dosas If you're willing to propose the change and run through a few test scenarios, then please do!

[dosas]

I could not find any tests for session, what do you mean by run through a few test scenarios?

[JacobCallahan]

@dosas since you can't really run our functional tests (no access to internal resources), then that would be manual tests using the different authentication methods against a remote host of your own. Of course, please sanitize any sensitive information.

# key-based auth
test_host = Host(hostname="my.test.host", key_filename="/path/to/key")
assert test_host.hostname in test_host.execute("hostname").stdout


# password-based auth
test_host = Host(hostname="my.test.host", username="myuser", password="mypassword")
assert test_host.hostname in test_host.execute("hostname").stdout


# agent-based auth
test_host = Host(hostname="my.test.host", username="myuser")
assert test_host.hostname in test_host.execute("hostname").stdout