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