libssh2_agent_get_identity(3)

libssh2_agent_get_identity3

Get a public key off the collection of public keys managed by ssh-agent

Usage

#include <libssh2.h>
int
libssh2_agent_get_identity(LIBSSH2_AGENT *agent,
                           struct libssh2_agent_publickey **store,
                           struct libssh2_agent_publickey *prev);

Overview

libssh2_agent_get_identity(3) allows an application to iterate over all public keys in the collection managed by ssh-agent.

store should point to a pointer that gets filled in to point to the public key data.

prev is a pointer to a previous 'struct libssh2_agent_publickey' as returned by a previous invoke of this function, or NULL to get the first entry in the internal collection.

Return value

Returns 0 if everything is fine and information about a host was stored in the store struct.

Returns 1 if it reached the end of public keys.

Returns negative values 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.