2 * Copyright (c) 2013 Lukasz Marek <lukasz.m.luki@gmail.com>
4 * This file is part of FFmpeg.
6 * FFmpeg 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.
11 * FFmpeg 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.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #include <libssh/sftp.h>
24 #include "libavutil/avstring.h"
25 #include "libavutil/opt.h"
26 #include "libavutil/attributes.h"
42 static av_cold int libssh_create_ssh_session(LIBSSHContext *libssh, const char* hostname, unsigned int port)
44 static const int verbosity = SSH_LOG_NOLOG;
46 if (!(libssh->session = ssh_new())) {
47 av_log(libssh, AV_LOG_ERROR, "SSH session creation failed: %s\n", ssh_get_error(libssh->session));
48 return AVERROR(ENOMEM);
50 ssh_options_set(libssh->session, SSH_OPTIONS_HOST, hostname);
51 ssh_options_set(libssh->session, SSH_OPTIONS_PORT, &port);
52 ssh_options_set(libssh->session, SSH_OPTIONS_LOG_VERBOSITY, &verbosity);
53 if (libssh->rw_timeout > 0) {
54 long timeout = libssh->rw_timeout * 1000;
55 ssh_options_set(libssh->session, SSH_OPTIONS_TIMEOUT_USEC, &timeout);
58 if (ssh_options_parse_config(libssh->session, NULL) < 0) {
59 av_log(libssh, AV_LOG_WARNING, "Could not parse the config file.\n");
62 if (ssh_connect(libssh->session) != SSH_OK) {
63 av_log(libssh, AV_LOG_ERROR, "Connection failed: %s\n", ssh_get_error(libssh->session));
70 static av_cold int libssh_authentication(LIBSSHContext *libssh, const char *user, const char *password)
76 ssh_options_set(libssh->session, SSH_OPTIONS_USER, user);
78 if (ssh_userauth_none(libssh->session, NULL) == SSH_AUTH_SUCCESS)
81 auth_methods = ssh_userauth_list(libssh->session, NULL);
83 if (auth_methods & SSH_AUTH_METHOD_PUBLICKEY) {
84 if (libssh->priv_key) {
86 ssh_private_key priv_key;
88 if (!ssh_try_publickey_from_file(libssh->session, libssh->priv_key, &pub_key, &type)) {
89 priv_key = privatekey_from_file(libssh->session, libssh->priv_key, type, password);
90 if (ssh_userauth_pubkey(libssh->session, NULL, pub_key, priv_key) == SSH_AUTH_SUCCESS) {
91 av_log(libssh, AV_LOG_DEBUG, "Authentication successful with selected private key.\n");
95 av_log(libssh, AV_LOG_DEBUG, "Invalid key is provided.\n");
96 return AVERROR(EACCES);
98 } else if (ssh_userauth_autopubkey(libssh->session, password) == SSH_AUTH_SUCCESS) {
99 av_log(libssh, AV_LOG_DEBUG, "Authentication successful with auto selected key.\n");
104 if (!authorized && (auth_methods & SSH_AUTH_METHOD_PASSWORD)) {
105 if (ssh_userauth_password(libssh->session, NULL, password) == SSH_AUTH_SUCCESS) {
106 av_log(libssh, AV_LOG_DEBUG, "Authentication successful with password.\n");
112 av_log(libssh, AV_LOG_ERROR, "Authentication failed.\n");
113 return AVERROR(EACCES);
119 static av_cold int libssh_create_sftp_session(LIBSSHContext *libssh)
121 if (!(libssh->sftp = sftp_new(libssh->session))) {
122 av_log(libssh, AV_LOG_ERROR, "SFTP session creation failed: %s\n", ssh_get_error(libssh->session));
123 return AVERROR(ENOMEM);
126 if (sftp_init(libssh->sftp) != SSH_OK) {
127 av_log(libssh, AV_LOG_ERROR, "Error initializing sftp session: %s\n", ssh_get_error(libssh->session));
134 static av_cold int libssh_open_file(LIBSSHContext *libssh, int flags, const char *file)
138 if ((flags & AVIO_FLAG_WRITE) && (flags & AVIO_FLAG_READ)) {
139 access = O_CREAT | O_RDWR;
142 } else if (flags & AVIO_FLAG_WRITE) {
143 access = O_CREAT | O_WRONLY;
149 /* 0666 = -rw-rw-rw- = read+write for everyone, minus umask */
150 if (!(libssh->file = sftp_open(libssh->sftp, file, access, 0666))) {
151 av_log(libssh, AV_LOG_ERROR, "Error opening sftp file: %s\n", ssh_get_error(libssh->session));
158 static av_cold void libssh_stat_file(LIBSSHContext *libssh)
160 sftp_attributes stat;
162 if (!(stat = sftp_fstat(libssh->file))) {
163 av_log(libssh, AV_LOG_WARNING, "Cannot stat remote file.\n");
164 libssh->filesize = -1;
166 libssh->filesize = stat->size;
167 sftp_attributes_free(stat);
171 static av_cold int libssh_close(URLContext *h)
173 LIBSSHContext *libssh = h->priv_data;
175 sftp_close(libssh->file);
179 sftp_free(libssh->sftp);
182 if (libssh->session) {
183 ssh_disconnect(libssh->session);
184 ssh_free(libssh->session);
185 libssh->session = NULL;
190 static av_cold int libssh_open(URLContext *h, const char *url, int flags)
192 LIBSSHContext *libssh = h->priv_data;
193 char proto[10], path[MAX_URL_SIZE], hostname[1024], credencials[1024];
195 const char *user = NULL, *pass = NULL;
198 av_url_split(proto, sizeof(proto),
199 credencials, sizeof(credencials),
200 hostname, sizeof(hostname),
205 // a port of 0 will use a port from ~/.ssh/config or the default value 22
206 if (port < 0 || port > 65535)
209 if ((ret = libssh_create_ssh_session(libssh, hostname, port)) < 0)
212 user = av_strtok(credencials, ":", &end);
213 pass = av_strtok(end, ":", &end);
215 if ((ret = libssh_authentication(libssh, user, pass)) < 0)
218 if ((ret = libssh_create_sftp_session(libssh)) < 0)
221 if ((ret = libssh_open_file(libssh, flags, path)) < 0)
224 libssh_stat_file(libssh);
233 static int64_t libssh_seek(URLContext *h, int64_t pos, int whence)
235 LIBSSHContext *libssh = h->priv_data;
238 if (libssh->filesize == -1 && (whence == AVSEEK_SIZE || whence == SEEK_END)) {
239 av_log(h, AV_LOG_ERROR, "Error during seeking.\n");
245 return libssh->filesize;
250 newpos = sftp_tell64(libssh->file) + pos;
253 newpos = libssh->filesize + pos;
256 return AVERROR(EINVAL);
260 av_log(h, AV_LOG_ERROR, "Seeking to nagative position.\n");
261 return AVERROR(EINVAL);
264 if (sftp_seek64(libssh->file, newpos)) {
265 av_log(h, AV_LOG_ERROR, "Error during seeking.\n");
272 static int libssh_read(URLContext *h, unsigned char *buf, int size)
274 LIBSSHContext *libssh = h->priv_data;
277 if ((bytes_read = sftp_read(libssh->file, buf, size)) < 0) {
278 av_log(libssh, AV_LOG_ERROR, "Read error.\n");
284 static int libssh_write(URLContext *h, const unsigned char *buf, int size)
286 LIBSSHContext *libssh = h->priv_data;
289 if ((bytes_written = sftp_write(libssh->file, buf, size)) < 0) {
290 av_log(libssh, AV_LOG_ERROR, "Write error.\n");
293 return bytes_written;
296 #define OFFSET(x) offsetof(LIBSSHContext, x)
297 #define D AV_OPT_FLAG_DECODING_PARAM
298 #define E AV_OPT_FLAG_ENCODING_PARAM
299 static const AVOption options[] = {
300 {"timeout", "set timeout of socket I/O operations", OFFSET(rw_timeout), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, D|E },
301 {"truncate", "Truncate existing files on write", OFFSET(trunc), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, E },
302 {"private_key", "set path to private key", OFFSET(priv_key), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, D|E },
306 static const AVClass libssh_context_class = {
307 .class_name = "libssh",
308 .item_name = av_default_item_name,
310 .version = LIBAVUTIL_VERSION_INT,
313 URLProtocol ff_libssh_protocol = {
315 .url_open = libssh_open,
316 .url_read = libssh_read,
317 .url_write = libssh_write,
318 .url_seek = libssh_seek,
319 .url_close = libssh_close,
320 .priv_data_size = sizeof(LIBSSHContext),
321 .priv_data_class = &libssh_context_class,
322 .flags = URL_PROTOCOL_FLAG_NETWORK,