fabc024695062f7a0f7e2e9b66c266624f2b129d
[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 int libssh_close(URLContext *h)
88 {
89     LIBSSHContext *s = h->priv_data;
90     if (s->file)
91         sftp_close(s->file);
92     if (s->sftp)
93         sftp_free(s->sftp);
94     if (s->session) {
95         ssh_disconnect(s->session);
96         ssh_free(s->session);
97     }
98     return 0;
99 }
100
101 static int libssh_open(URLContext *h, const char *url, int flags)
102 {
103     static const int verbosity = SSH_LOG_NOLOG;
104     LIBSSHContext *s = h->priv_data;
105     char proto[10], path[MAX_URL_SIZE], hostname[1024], credencials[1024];
106     int port = 22, access, ret;
107     long timeout = s->rw_timeout * 1000;
108     const char *user = NULL, *pass = NULL;
109     char *end = NULL;
110     sftp_attributes stat;
111
112     av_url_split(proto, sizeof(proto),
113                  credencials, sizeof(credencials),
114                  hostname, sizeof(hostname),
115                  &port,
116                  path, sizeof(path),
117                  url);
118
119     if (port <= 0 || port > 65535)
120         port = 22;
121
122     if (!(s->session = ssh_new())) {
123         ret = AVERROR(ENOMEM);
124         goto fail;
125     }
126     user = av_strtok(credencials, ":", &end);
127     pass = av_strtok(end, ":", &end);
128     ssh_options_set(s->session, SSH_OPTIONS_HOST, hostname);
129     ssh_options_set(s->session, SSH_OPTIONS_PORT, &port);
130     ssh_options_set(s->session, SSH_OPTIONS_LOG_VERBOSITY, &verbosity);
131     if (timeout > 0)
132         ssh_options_set(s->session, SSH_OPTIONS_TIMEOUT_USEC, &timeout);
133
134     if (ssh_connect(s->session) != SSH_OK) {
135         av_log(h, AV_LOG_ERROR, "Connection failed. %s\n", ssh_get_error(s->session));
136         ret = AVERROR(EIO);
137         goto fail;
138     }
139
140     if ((ret = libssh_authentication(s, user, pass)) < 0)
141         goto fail;
142
143     if (!(s->sftp = sftp_new(s->session))) {
144         av_log(h, AV_LOG_ERROR, "SFTP session creation failed: %s\n", ssh_get_error(s->session));
145         ret = AVERROR(ENOMEM);
146         goto fail;
147     }
148
149     if (sftp_init(s->sftp) != SSH_OK) {
150         av_log(h, AV_LOG_ERROR, "Error initializing sftp session: %s\n", ssh_get_error(s->session));
151         ret = AVERROR(EIO);
152         goto fail;
153     }
154
155     if ((flags & AVIO_FLAG_WRITE) && (flags & AVIO_FLAG_READ)) {
156         access = O_CREAT | O_RDWR;
157         if (s->trunc)
158             access |= O_TRUNC;
159     } else if (flags & AVIO_FLAG_WRITE) {
160         access = O_CREAT | O_WRONLY;
161         if (s->trunc)
162             access |= O_TRUNC;
163     } else {
164         access = O_RDONLY;
165     }
166
167     /* 0666 = -rw-rw-rw- = read+write for everyone, minus umask */
168     if (!(s->file = sftp_open(s->sftp, path, access, 0666))) {
169         av_log(h, AV_LOG_ERROR, "Error opening sftp file: %s\n", ssh_get_error(s->session));
170         ret = AVERROR(EIO);
171         goto fail;
172     }
173
174     if (!(stat = sftp_fstat(s->file))) {
175         av_log(h, AV_LOG_WARNING, "Cannot stat remote file %s.\n", path);
176         s->filesize = -1;
177     } else {
178         s->filesize = stat->size;
179         sftp_attributes_free(stat);
180     }
181
182     return 0;
183
184   fail:
185     libssh_close(h);
186     return ret;
187 }
188
189 static int64_t libssh_seek(URLContext *h, int64_t pos, int whence)
190 {
191     LIBSSHContext *s = h->priv_data;
192     int64_t newpos;
193
194     if (s->filesize == -1 && (whence == AVSEEK_SIZE || whence == SEEK_END)) {
195         av_log(h, AV_LOG_ERROR, "Error during seeking.\n");
196         return AVERROR(EIO);
197     }
198
199     switch(whence) {
200     case AVSEEK_SIZE:
201         return s->filesize;
202     case SEEK_SET:
203         newpos = pos;
204         break;
205     case SEEK_CUR:
206         newpos = sftp_tell64(s->file);
207         break;
208     case SEEK_END:
209         newpos = s->filesize + pos;
210         break;
211     default:
212         return AVERROR(EINVAL);
213     }
214
215     if (sftp_seek64(s->file, newpos)) {
216         av_log(h, AV_LOG_ERROR, "Error during seeking.\n");
217         return AVERROR(EIO);
218     }
219
220     return newpos;
221 }
222
223 static int libssh_read(URLContext *h, unsigned char *buf, int size)
224 {
225     LIBSSHContext *s = h->priv_data;
226     int bytes_read;
227
228     if ((bytes_read = sftp_read(s->file, buf, size)) < 0) {
229         av_log(h, AV_LOG_ERROR, "Read error.\n");
230         return AVERROR(EIO);
231     }
232     return bytes_read;
233 }
234
235 static int libssh_write(URLContext *h, const unsigned char *buf, int size)
236 {
237     LIBSSHContext *s = h->priv_data;
238     int bytes_written;
239
240     if ((bytes_written = sftp_write(s->file, buf, size)) < 0) {
241         av_log(h, AV_LOG_ERROR, "Write error.\n");
242         return AVERROR(EIO);
243     }
244     return bytes_written;
245 }
246
247 #define OFFSET(x) offsetof(LIBSSHContext, x)
248 #define D AV_OPT_FLAG_DECODING_PARAM
249 #define E AV_OPT_FLAG_ENCODING_PARAM
250 static const AVOption options[] = {
251     {"timeout", "set timeout of socket I/O operations", OFFSET(rw_timeout), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, D|E },
252     {"truncate", "Truncate existing files on write", OFFSET(trunc), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, E },
253     {"private_key", "set path to private key", OFFSET(priv_key), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, D|E },
254     {NULL}
255 };
256
257 static const AVClass libssh_context_class = {
258     .class_name     = "libssh",
259     .item_name      = av_default_item_name,
260     .option         = options,
261     .version        = LIBAVUTIL_VERSION_INT,
262 };
263
264 URLProtocol ff_libssh_protocol = {
265     .name                = "sftp",
266     .url_open            = libssh_open,
267     .url_read            = libssh_read,
268     .url_write           = libssh_write,
269     .url_seek            = libssh_seek,
270     .url_close           = libssh_close,
271     .priv_data_size      = sizeof(LIBSSHContext),
272     .priv_data_class     = &libssh_context_class,
273     .flags               = URL_PROTOCOL_FLAG_NETWORK,
274 };