libssh: legacy.h Source File

libssh 0.11.2 The SSH library

Loading...
Searching...
No Matches
legacy.h
1/*
2 * This file is part of the SSH Library
3 *
4 * Copyright (c) 2010 by Aris Adamantiadis
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21/* Since libssh.h includes legacy.h, it's important that libssh.h is included
22 * first. we don't define LEGACY_H now because we want it to be defined when
23 * included from libssh.h
24 * All function calls declared in this header are deprecated and meant to be
25 * removed in future.
26 */
27
28#ifndef LEGACY_H_
29#define LEGACY_H_
30
31typedef struct ssh_private_key_struct* ssh_private_key;
32typedef struct ssh_public_key_struct* ssh_public_key;
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38LIBSSH_API int ssh_auth_list(ssh_session session);
39LIBSSH_API int ssh_userauth_offer_pubkey(ssh_session session, const char *username, int type, ssh_string publickey);
40LIBSSH_API int ssh_userauth_pubkey(ssh_session session, const char *username, ssh_string publickey, ssh_private_key privatekey);
41#ifndef _WIN32
42LIBSSH_API int ssh_userauth_agent_pubkey(ssh_session session, const char *username,
43 ssh_public_key publickey);
44#endif
45LIBSSH_API int ssh_userauth_autopubkey(ssh_session session, const char *passphrase);
46LIBSSH_API int ssh_userauth_privatekey_file(ssh_session session, const char *username,
47 const char *filename, const char *passphrase);
48
49SSH_DEPRECATED LIBSSH_API void buffer_free(ssh_buffer buffer);
50SSH_DEPRECATED LIBSSH_API void *buffer_get(ssh_buffer buffer);
51SSH_DEPRECATED LIBSSH_API uint32_t buffer_get_len(ssh_buffer buffer);
52SSH_DEPRECATED LIBSSH_API ssh_buffer buffer_new(void);
53
54SSH_DEPRECATED LIBSSH_API ssh_channel channel_accept_x11(ssh_channel channel, int timeout_ms);
55SSH_DEPRECATED LIBSSH_API int channel_change_pty_size(ssh_channel channel,int cols,int rows);
56SSH_DEPRECATED LIBSSH_API ssh_channel channel_forward_accept(ssh_session session, int timeout_ms);
57SSH_DEPRECATED LIBSSH_API int channel_close(ssh_channel channel);
58SSH_DEPRECATED LIBSSH_API int channel_forward_cancel(ssh_session session, const char *address, int port);
59SSH_DEPRECATED LIBSSH_API int channel_forward_listen(ssh_session session, const char *address, int port, int *bound_port);
60SSH_DEPRECATED LIBSSH_API void channel_free(ssh_channel channel);
61SSH_DEPRECATED LIBSSH_API int channel_get_exit_status(ssh_channel channel);
62SSH_DEPRECATED LIBSSH_API ssh_session channel_get_session(ssh_channel channel);
63SSH_DEPRECATED LIBSSH_API int channel_is_closed(ssh_channel channel);
64SSH_DEPRECATED LIBSSH_API int channel_is_eof(ssh_channel channel);
65SSH_DEPRECATED LIBSSH_API int channel_is_open(ssh_channel channel);
66SSH_DEPRECATED LIBSSH_API ssh_channel channel_new(ssh_session session);
67SSH_DEPRECATED LIBSSH_API int channel_open_forward(ssh_channel channel, const char *remotehost,
68 int remoteport, const char *sourcehost, int localport);
69SSH_DEPRECATED LIBSSH_API int channel_open_session(ssh_channel channel);
70SSH_DEPRECATED LIBSSH_API int channel_poll(ssh_channel channel, int is_stderr);
71SSH_DEPRECATED LIBSSH_API int channel_read(ssh_channel channel, void *dest, uint32_t count, int is_stderr);
72
73SSH_DEPRECATED LIBSSH_API int channel_read_buffer(ssh_channel channel, ssh_buffer buffer, uint32_t count,
74 int is_stderr);
75
76SSH_DEPRECATED LIBSSH_API int channel_read_nonblocking(ssh_channel channel, void *dest, uint32_t count,
77 int is_stderr);
78SSH_DEPRECATED LIBSSH_API int channel_request_env(ssh_channel channel, const char *name, const char *value);
79SSH_DEPRECATED LIBSSH_API int channel_request_exec(ssh_channel channel, const char *cmd);
80SSH_DEPRECATED LIBSSH_API int channel_request_pty(ssh_channel channel);
81SSH_DEPRECATED LIBSSH_API int channel_request_pty_size(ssh_channel channel, const char *term,
82 int cols, int rows);
83SSH_DEPRECATED LIBSSH_API int channel_request_shell(ssh_channel channel);
84SSH_DEPRECATED LIBSSH_API int channel_request_send_signal(ssh_channel channel, const char *signum);
85SSH_DEPRECATED LIBSSH_API int channel_request_sftp(ssh_channel channel);
86SSH_DEPRECATED LIBSSH_API int channel_request_subsystem(ssh_channel channel, const char *subsystem);
87SSH_DEPRECATED LIBSSH_API int channel_request_x11(ssh_channel channel, int single_connection, const char *protocol,
88 const char *cookie, int screen_number);
89SSH_DEPRECATED LIBSSH_API int channel_send_eof(ssh_channel channel);
90SSH_DEPRECATED LIBSSH_API int channel_select(ssh_channel *readchans, ssh_channel *writechans, ssh_channel *exceptchans, struct
91 timeval * timeout);
92SSH_DEPRECATED LIBSSH_API void channel_set_blocking(ssh_channel channel, int blocking);
93SSH_DEPRECATED LIBSSH_API int channel_write(ssh_channel channel, const void *data, uint32_t len);
94
95SSH_DEPRECATED LIBSSH_API void privatekey_free(ssh_private_key prv);
96SSH_DEPRECATED LIBSSH_API ssh_private_key privatekey_from_file(ssh_session session, const char *filename,
97 int type, const char *passphrase);
98SSH_DEPRECATED LIBSSH_API void publickey_free(ssh_public_key key);
99SSH_DEPRECATED LIBSSH_API int ssh_publickey_to_file(ssh_session session, const char *file,
100 ssh_string pubkey, int type);
101SSH_DEPRECATED LIBSSH_API ssh_string publickey_from_file(ssh_session session, const char *filename,
102 int *type);
103SSH_DEPRECATED LIBSSH_API ssh_public_key publickey_from_privatekey(ssh_private_key prv);
104SSH_DEPRECATED LIBSSH_API ssh_string publickey_to_string(ssh_public_key key);
105SSH_DEPRECATED LIBSSH_API int ssh_try_publickey_from_file(ssh_session session, const char *keyfile,
106 ssh_string *publickey, int *type);
107SSH_DEPRECATED LIBSSH_API enum ssh_keytypes_e ssh_privatekey_type(ssh_private_key privatekey);
108
109LIBSSH_API ssh_string ssh_get_pubkey(ssh_session session);
110
111LIBSSH_API ssh_message ssh_message_retrieve(ssh_session session, uint32_t packettype);
112LIBSSH_API ssh_public_key ssh_message_auth_publickey(ssh_message msg);
113
114SSH_DEPRECATED LIBSSH_API void string_burn(ssh_string str);
115SSH_DEPRECATED LIBSSH_API ssh_string string_copy(ssh_string str);
116SSH_DEPRECATED LIBSSH_API void *string_data(ssh_string str);
117SSH_DEPRECATED LIBSSH_API int string_fill(ssh_string str, const void *data, size_t len);
118SSH_DEPRECATED LIBSSH_API void string_free(ssh_string str);
119SSH_DEPRECATED LIBSSH_API ssh_string string_from_char(const char *what);
120SSH_DEPRECATED LIBSSH_API size_t string_len(ssh_string str);
121SSH_DEPRECATED LIBSSH_API ssh_string string_new(size_t size);
122SSH_DEPRECATED LIBSSH_API char *string_to_char(ssh_string str);
123
124#ifdef __cplusplus
125}
126#endif
127
128#endif /* LEGACY_H_ */
channel_read_buffer
SSH_DEPRECATED LIBSSH_API int channel_read_buffer(ssh_channel channel, ssh_buffer buffer, uint32_t count, int is_stderr)
Read data from a channel into a buffer.
Definition channels.c:2955