a425c24dfa94c9b57ea987b9460423c5653aef54
[ffmpeg.git] / libavformat / libssh.c
1 /*
2  * Copyright (c) 2013 Lukasz Marek <lukasz.m.luki@gmail.com>
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #include <fcntl.h>
22 #include <libssh/sftp.h>
23 #include "libavutil/avstring.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/attributes.h"
26 #include "avformat.h"
27 #include "internal.h"
28 #include "url.h"
29
30 typedef struct {
31     const AVClass *class;
32     ssh_session session;
33     sftp_session sftp;
34     sftp_file file;
35     int64_t filesize;
36     int rw_timeout;
37     int trunc;
38     char *priv_key;
39 } LIBSSHContext;
40
41 static av_cold int libssh_authentication(LIBSSHContext *libssh, const char *user, const char *password)
42 {
43     int authorized = 0;
44     int auth_methods;
45
46     if (user)
47         ssh_options_set(libssh->session, SSH_OPTIONS_USER, user);
48
49     auth_methods = ssh_userauth_list(libssh->session, NULL);
50
51     if (auth_methods & SSH_AUTH_METHOD_PUBLICKEY) {
52         if (libssh->priv_key) {
53             ssh_string pub_key;
54             ssh_private_key priv_key;
55             int type;
56             if (!ssh_try_publickey_from_file(libssh->session, libssh->priv_key, &pub_key, &type)) {
57                 priv_key = privatekey_from_file(libssh->session, libssh->priv_key, type, password);
58                 if (ssh_userauth_pubkey(libssh->session, NULL, pub_key, priv_key) == SSH_AUTH_SUCCESS) {
59                     av_log(libssh, AV_LOG_DEBUG, "Authentication successful with selected private key.\n");
60                     authorized = 1;
61                 }
62             } else {
63                 av_log(libssh, AV_LOG_DEBUG, "Invalid key is provided.\n");
64                 return AVERROR(EACCES);
65             }
66         } else if (ssh_userauth_autopubkey(libssh->session, password) == SSH_AUTH_SUCCESS) {
67             av_log(libssh, AV_LOG_DEBUG, "Authentication successful with auto selected key.\n");
68             authorized = 1;
69         }
70     }
71
72     if (!authorized && (auth_methods & SSH_AUTH_METHOD_PASSWORD)) {
73         if (ssh_userauth_password(libssh->session, NULL, password) == SSH_AUTH_SUCCESS) {
74             av_log(libssh, AV_LOG_DEBUG, "Authentication successful with password.\n");
75             authorized = 1;
76         }
77     }
78
79     if (!authorized) {
80         av_log(libssh, AV_LOG_ERROR, "Authentication failed.\n");
81         return AVERROR(EACCES);
82     }
83
84     return 0;
85 }
86
87 static av_cold int libssh_open_file(LIBSSHContext *libssh, int flags, const char *file)
88 {
89     int access;
90
91     if ((flags & AVIO_FLAG_WRITE) && (flags & AVIO_FLAG_READ)) {
92         access = O_CREAT | O_RDWR;
93         if (libssh->trunc)
94             access |= O_TRUNC;
95     } else if (flags & AVIO_FLAG_WRITE) {
96         access = O_CREAT | O_WRONLY;
97         if (libssh->trunc)
98             access |= O_TRUNC;
99     } else
100         access = O_RDONLY;
101
102     /* 0666 = -rw-rw-rw- = read+write for everyone, minus umask */
103     if (!(libssh->file = sftp_open(libssh->sftp, file, access, 0666))) {
104         av_log(libssh, AV_LOG_ERROR, "Error opening sftp file: %s\n", ssh_get_error(libssh->session));
105         return AVERROR(EIO);
106     }
107
108     return 0;
109 }
110
111 static int libssh_close(URLContext *h)
112 {
113     LIBSSHContext *s = h->priv_data;
114     if (s->file)
115         sftp_close(s->file);
116     if (s->sftp)
117         sftp_free(s->sftp);
118     if (s->session) {
119         ssh_disconnect(s->session);
120         ssh_free(s->session);
121     }
122     return 0;
123 }
124
125 static int libssh_open(URLContext *h, const char *url, int flags)
126 {
127     static const int verbosity = SSH_LOG_NOLOG;
128     LIBSSHContext *s = h->priv_data;
129     char proto[10], path[MAX_URL_SIZE], hostname[1024], credencials[1024];
130     int port = 22, ret;
131     long timeout = s->rw_timeout * 1000;
132     const char *user = NULL, *pass = NULL;
133     char *end = NULL;
134     sftp_attributes stat;
135
136     av_url_split(proto, sizeof(proto),
137                  credencials, sizeof(credencials),
138                  hostname, sizeof(hostname),
139                  &port,
140                  path, sizeof(path),
141                  url);
142
143     if (port <= 0 || port > 65535)
144         port = 22;
145
146     if (!(s->session = ssh_new())) {
147         ret = AVERROR(ENOMEM);
148         goto fail;
149     }
150     user = av_strtok(credencials, ":", &end);
151     pass = av_strtok(end, ":", &end);
152     ssh_options_set(s->session, SSH_OPTIONS_HOST, hostname);
153     ssh_options_set(s->session, SSH_OPTIONS_PORT, &port);
154     ssh_options_set(s->session, SSH_OPTIONS_LOG_VERBOSITY, &verbosity);
155     if (timeout > 0)
156         ssh_options_set(s->session, SSH_OPTIONS_TIMEOUT_USEC, &timeout);
157
158     if (ssh_connect(s->session) != SSH_OK) {
159         av_log(h, AV_LOG_ERROR, "Connection failed. %s\n", ssh_get_error(s->session));
160         ret = AVERROR(EIO);
161         goto fail;
162     }
163
164     if ((ret = libssh_authentication(s, user, pass)) < 0)
165         goto fail;
166
167     if (!(s->sftp = sftp_new(s->session))) {
168         av_log(h, AV_LOG_ERROR, "SFTP session creation failed: %s\n", ssh_get_error(s->session));
169         ret = AVERROR(ENOMEM);
170         goto fail;
171     }
172
173     if (sftp_init(s->sftp) != SSH_OK) {
174         av_log(h, AV_LOG_ERROR, "Error initializing sftp session: %s\n", ssh_get_error(s->session));
175         ret = AVERROR(EIO);
176         goto fail;
177     }
178
179     if ((ret = libssh_open_file(s, flags, path)) < 0)
180         goto fail;
181
182     if (!(stat = sftp_fstat(s->file))) {
183         av_log(h, AV_LOG_WARNING, "Cannot stat remote file %s.\n", path);
184         s->filesize = -1;
185     } else {
186         s->filesize = stat->size;
187         sftp_attributes_free(stat);
188     }
189
190     return 0;
191
192   fail:
193     libssh_close(h);
194     return ret;
195 }
196
197 static int64_t libssh_seek(URLContext *h, int64_t pos, int whence)
198 {
199     LIBSSHContext *s = h->priv_data;
200     int64_t newpos;
201
202     if (s->filesize == -1 && (whence == AVSEEK_SIZE || whence == SEEK_END)) {
203         av_log(h, AV_LOG_ERROR, "Error during seeking.\n");
204         return AVERROR(EIO);
205     }
206
207     switch(whence) {
208     case AVSEEK_SIZE:
209         return s->filesize;
210     case SEEK_SET:
211         newpos = pos;
212         break;
213     case SEEK_CUR:
214         newpos = sftp_tell64(s->file);
215         break;
216     case SEEK_END:
217         newpos = s->filesize + pos;
218         break;
219     default:
220         return AVERROR(EINVAL);
221     }
222
223     if (sftp_seek64(s->file, newpos)) {
224         av_log(h, AV_LOG_ERROR, "Error during seeking.\n");
225         return AVERROR(EIO);
226     }
227
228     return newpos;
229 }
230
231 static int libssh_read(URLContext *h, unsigned char *buf, int size)
232 {
233     LIBSSHContext *s = h->priv_data;
234     int bytes_read;
235
236     if ((bytes_read = sftp_read(s->file, buf, size)) < 0) {
237         av_log(h, AV_LOG_ERROR, "Read error.\n");
238         return AVERROR(EIO);
239     }
240     return bytes_read;
241 }
242
243 static int libssh_write(URLContext *h, const unsigned char *buf, int size)
244 {
245     LIBSSHContext *s = h->priv_data;
246     int bytes_written;
247
248     if ((bytes_written = sftp_write(s->file, buf, size)) < 0) {
249         av_log(h, AV_LOG_ERROR, "Write error.\n");
250         return AVERROR(EIO);
251     }
252     return bytes_written;
253 }
254
255 #define OFFSET(x) offsetof(LIBSSHContext, x)
256 #define D AV_OPT_FLAG_DECODING_PARAM
257 #define E AV_OPT_FLAG_ENCODING_PARAM
258 static const AVOption options[] = {
259     {"timeout", "set timeout of socket I/O operations", OFFSET(rw_timeout), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, D|E },
260     {"truncate", "Truncate existing files on write", OFFSET(trunc), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, E },
261     {"private_key", "set path to private key", OFFSET(priv_key), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, D|E },
262     {NULL}
263 };
264
265 static const AVClass libssh_context_class = {
266     .class_name     = "libssh",
267     .item_name      = av_default_item_name,
268     .option         = options,
269     .version        = LIBAVUTIL_VERSION_INT,
270 };
271
272 URLProtocol ff_libssh_protocol = {
273     .name                = "sftp",
274     .url_open            = libssh_open,
275     .url_read            = libssh_read,
276     .url_write           = libssh_write,
277     .url_seek            = libssh_seek,
278     .url_close           = libssh_close,
279     .priv_data_size      = sizeof(LIBSSHContext),
280     .priv_data_class     = &libssh_context_class,
281     .flags               = URL_PROTOCOL_FLAG_NETWORK,
282 };