libssh2_agent_userauth(3)

libssh2_agent_userauth3

Authenticate a session with a public key, with the help of ssh-agent

Usage

#include <libssh2.h>
int
libssh2_agent_userauth(LIBSSH2_AGENT *agent,
                       const char *username,
                       struct libssh2_agent_publickey *identity);

Overview

agent - ssh-agent handle as returned by libssh2_agent_init(3)

username - Remote user name to authenticate as.

identity - Public key to authenticate with, as returned by libssh2_agent_get_identity(3)

Attempt public key authentication with the help of ssh-agent.

Return value

Returns 0 if succeeded, or a negative value for error.

Releases

9 releases since Debian 6.0 (Squeeze); the text changed 1 time.

  1. 6.0–12
  2. 13–Arch

Availability

Added in libssh2 1.2

From libssh2 1.11.1-7 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.