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
22 #include <libssh/sftp.h>
23 #include "libavutil/avstring.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/attributes.h"
41 static av_cold int libssh_create_ssh_session(LIBSSHContext *libssh, const char* hostname, unsigned int port)
43 static const int verbosity = SSH_LOG_NOLOG;
45 if (!(libssh->session = ssh_new())) {
46 av_log(libssh, AV_LOG_ERROR, "SSH session creation failed: %s\n", ssh_get_error(libssh->session));
47 return AVERROR(ENOMEM);
49 ssh_options_set(libssh->session, SSH_OPTIONS_HOST, hostname);
50 ssh_options_set(libssh->session, SSH_OPTIONS_PORT, &port);
51 ssh_options_set(libssh->session, SSH_OPTIONS_LOG_VERBOSITY, &verbosity);
52 if (libssh->rw_timeout > 0) {
53 long timeout = libssh->rw_timeout * 1000;
54 ssh_options_set(libssh->session, SSH_OPTIONS_TIMEOUT_USEC, &timeout);
57 if (ssh_connect(libssh->session) != SSH_OK) {
58 av_log(libssh, AV_LOG_ERROR, "Connection failed: %s\n", ssh_get_error(libssh->session));
65 static av_cold int libssh_authentication(LIBSSHContext *libssh, const char *user, const char *password)
71 ssh_options_set(libssh->session, SSH_OPTIONS_USER, user);
73 auth_methods = ssh_userauth_list(libssh->session, NULL);
75 if (auth_methods & SSH_AUTH_METHOD_PUBLICKEY) {
76 if (libssh->priv_key) {
78 ssh_private_key priv_key;
80 if (!ssh_try_publickey_from_file(libssh->session, libssh->priv_key, &pub_key, &type)) {
81 priv_key = privatekey_from_file(libssh->session, libssh->priv_key, type, password);
82 if (ssh_userauth_pubkey(libssh->session, NULL, pub_key, priv_key) == SSH_AUTH_SUCCESS) {
83 av_log(libssh, AV_LOG_DEBUG, "Authentication successful with selected private key.\n");
87 av_log(libssh, AV_LOG_DEBUG, "Invalid key is provided.\n");
88 return AVERROR(EACCES);
90 } else if (ssh_userauth_autopubkey(libssh->session, password) == SSH_AUTH_SUCCESS) {
91 av_log(libssh, AV_LOG_DEBUG, "Authentication successful with auto selected key.\n");
96 if (!authorized && (auth_methods & SSH_AUTH_METHOD_PASSWORD)) {
97 if (ssh_userauth_password(libssh->session, NULL, password) == SSH_AUTH_SUCCESS) {
98 av_log(libssh, AV_LOG_DEBUG, "Authentication successful with password.\n");
104 av_log(libssh, AV_LOG_ERROR, "Authentication failed.\n");
105 return AVERROR(EACCES);
111 static av_cold int libssh_create_sftp_session(LIBSSHContext *libssh)
113 if (!(libssh->sftp = sftp_new(libssh->session))) {
114 av_log(libssh, AV_LOG_ERROR, "SFTP session creation failed: %s\n", ssh_get_error(libssh->session));
115 return AVERROR(ENOMEM);
118 if (sftp_init(libssh->sftp) != SSH_OK) {
119 av_log(libssh, AV_LOG_ERROR, "Error initializing sftp session: %s\n", ssh_get_error(libssh->session));
126 static av_cold int libssh_open_file(LIBSSHContext *libssh, int flags, const char *file)
130 if ((flags & AVIO_FLAG_WRITE) && (flags & AVIO_FLAG_READ)) {
131 access = O_CREAT | O_RDWR;
134 } else if (flags & AVIO_FLAG_WRITE) {
135 access = O_CREAT | O_WRONLY;
141 /* 0666 = -rw-rw-rw- = read+write for everyone, minus umask */
142 if (!(libssh->file = sftp_open(libssh->sftp, file, access, 0666))) {
143 av_log(libssh, AV_LOG_ERROR, "Error opening sftp file: %s\n", ssh_get_error(libssh->session));
150 static av_cold void libssh_stat_file(LIBSSHContext *libssh)
152 sftp_attributes stat;
154 if (!(stat = sftp_fstat(libssh->file))) {
155 av_log(libssh, AV_LOG_WARNING, "Cannot stat remote file.\n");
156 libssh->filesize = -1;
158 libssh->filesize = stat->size;
159 sftp_attributes_free(stat);
163 static av_cold int libssh_close(URLContext *h)
165 LIBSSHContext *libssh = h->priv_data;
167 sftp_close(libssh->file);
169 sftp_free(libssh->sftp);
170 if (libssh->session) {
171 ssh_disconnect(libssh->session);
172 ssh_free(libssh->session);
177 static av_cold int libssh_open(URLContext *h, const char *url, int flags)
179 LIBSSHContext *libssh = h->priv_data;
180 char proto[10], path[MAX_URL_SIZE], hostname[1024], credencials[1024];
182 const char *user = NULL, *pass = NULL;
185 av_url_split(proto, sizeof(proto),
186 credencials, sizeof(credencials),
187 hostname, sizeof(hostname),
192 if (port <= 0 || port > 65535)
195 if ((ret = libssh_create_ssh_session(libssh, hostname, port)) < 0)
198 user = av_strtok(credencials, ":", &end);
199 pass = av_strtok(end, ":", &end);
201 if ((ret = libssh_authentication(libssh, user, pass)) < 0)
204 if ((ret = libssh_create_sftp_session(libssh)) < 0)
207 if ((ret = libssh_open_file(libssh, flags, path)) < 0)
210 libssh_stat_file(libssh);
219 static int64_t libssh_seek(URLContext *h, int64_t pos, int whence)
221 LIBSSHContext *libssh = h->priv_data;
224 if (libssh->filesize == -1 && (whence == AVSEEK_SIZE || whence == SEEK_END)) {
225 av_log(h, AV_LOG_ERROR, "Error during seeking.\n");
231 return libssh->filesize;
236 newpos = sftp_tell64(libssh->file) + pos;
239 newpos = libssh->filesize + pos;
242 return AVERROR(EINVAL);
245 if (sftp_seek64(libssh->file, newpos)) {
246 av_log(h, AV_LOG_ERROR, "Error during seeking.\n");
253 static int libssh_read(URLContext *h, unsigned char *buf, int size)
255 LIBSSHContext *libssh = h->priv_data;
258 if ((bytes_read = sftp_read(libssh->file, buf, size)) < 0) {
259 av_log(libssh, AV_LOG_ERROR, "Read error.\n");
265 static int libssh_write(URLContext *h, const unsigned char *buf, int size)
267 LIBSSHContext *libssh = h->priv_data;
270 if ((bytes_written = sftp_write(libssh->file, buf, size)) < 0) {
271 av_log(libssh, AV_LOG_ERROR, "Write error.\n");
274 return bytes_written;
277 #define OFFSET(x) offsetof(LIBSSHContext, x)
278 #define D AV_OPT_FLAG_DECODING_PARAM
279 #define E AV_OPT_FLAG_ENCODING_PARAM
280 static const AVOption options[] = {
281 {"timeout", "set timeout of socket I/O operations", OFFSET(rw_timeout), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, D|E },
282 {"truncate", "Truncate existing files on write", OFFSET(trunc), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, E },
283 {"private_key", "set path to private key", OFFSET(priv_key), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, D|E },
287 static const AVClass libssh_context_class = {
288 .class_name = "libssh",
289 .item_name = av_default_item_name,
291 .version = LIBAVUTIL_VERSION_INT,
294 URLProtocol ff_libssh_protocol = {
296 .url_open = libssh_open,
297 .url_read = libssh_read,
298 .url_write = libssh_write,
299 .url_seek = libssh_seek,
300 .url_close = libssh_close,
301 .priv_data_size = sizeof(LIBSSHContext),
302 .priv_data_class = &libssh_context_class,
303 .flags = URL_PROTOCOL_FLAG_NETWORK,