libssh2_agent_sign.3 (1751B)
1.TH libssh2_agent_sign 3 "1 Oct 2022" "libssh2" "libssh2" 2.SH NAME 3libssh2_agent_sign - sign data, with the help of ssh-agent 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_agent_sign(LIBSSH2_AGENT *agent, 10 struct libssh2_agent_publickey *identity, 11 unsigned char **sig, 12 size_t *s_len, 13 const unsigned char *data, 14 size_t d_len, 15 const char *method, 16 unsigned int method_len); 17.fi 18.SH DESCRIPTION 19\fIagent\fP - ssh-agent handle as returned by 20.BR libssh2_agent_init(3) 21 22\fIidentity\fP - Public key to authenticate with, as returned by 23.BR libssh2_agent_get_identity(3) 24 25\fIsig\fP - A pointer to a buffer in which to place the signature. The caller 26is responsible for freeing the signature with LIBSSH2_FREE. 27 28\fIs_len\fP - A pointer to the length of the sig parameter. 29 30\fIdata\fP - The data to sign. 31 32\fId_len\fP - The length of the data parameter. 33 34\fImethod\fP - A buffer indicating the signing method. This should match the 35string at the start of identity->blob. 36 37\fImethod_len\fP - The length of the method parameter. 38 39Sign data using an ssh-agent. This function can be used in a callback 40registered with libssh2_session_callback_set(3) using 41LIBSSH2_CALLBACK_AUTHAGENT_SIGN to sign an authentication challenge from a 42server. However, the client is responsible for implementing the code that calls 43this callback in response to a SSH2_AGENTC_SIGN_REQUEST message. 44.SH RETURN VALUE 45Returns 0 if succeeded, or a negative value for error. 46.SH AVAILABILITY 47Added in libssh2 1.11.0 48.SH SEE ALSO 49.BR libssh2_agent_init(3) 50.BR libssh2_agent_get_identity(3) 51.BR libssh2_agent_userauth(3) 52.BR libssh2_session_callback_set(3)