mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-03 22:13:11 +03:00
f6aa31f48f
- All files have prominent copyright and SPDX identifier - If not embedded in the file, in the .reuse/dep5 file - All used licenses are in LICENSES/ (not shipped in tarballs) - A new REUSE CI job verify that all files are OK Assisted-by: Viktor Szakats Closes #1084
45 lines
1.4 KiB
Groff
45 lines
1.4 KiB
Groff
.\" Copyright (C) The libssh2 project and its contributors.
|
|
.\" SPDX-License-Identifier: BSD-3-Clause
|
|
.TH libssh2_session_handshake 3 "7 Oct 2010" "libssh2" "libssh2"
|
|
.SH NAME
|
|
libssh2_session_handshake - perform the SSH handshake
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_session_handshake(LIBSSH2_SESSION *session, libssh2_socket_t socket);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\fIsession\fP - Session instance as returned by
|
|
.BR libssh2_session_init_ex(3)
|
|
|
|
\fIsocket\fP - Connected socket descriptor. Typically a TCP connection
|
|
though the protocol allows for any reliable transport and the library will
|
|
attempt to use any berkeley socket.
|
|
|
|
Begin transport layer protocol negotiation with the connected host.
|
|
.SH RETURN VALUE
|
|
Returns 0 on success, negative on failure.
|
|
.SH ERRORS
|
|
\fILIBSSH2_ERROR_SOCKET_NONE\fP - The socket is invalid.
|
|
|
|
\fILIBSSH2_ERROR_BANNER_SEND\fP - Unable to send banner to remote host.
|
|
|
|
\fILIBSSH2_ERROR_KEX_FAILURE\fP - Encryption key exchange with the remote
|
|
host failed.
|
|
|
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
|
|
|
\fILIBSSH2_ERROR_SOCKET_DISCONNECT\fP - The socket was disconnected.
|
|
|
|
\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on
|
|
the socket.
|
|
|
|
\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.
|
|
.SH AVAILABILITY
|
|
Added in 1.2.8
|
|
.SH SEE ALSO
|
|
.BR libssh2_session_free(3)
|
|
.BR libssh2_session_init_ex(3)
|