1 /*****************************************************************************
2 * sftp.c: SFTP input module
3 *****************************************************************************
4 * Copyright (C) 2009 VLC authors and VideoLAN
7 * Authors: RĂ©mi Duraffort <ivoire@videolan.org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
36 #include <vlc_access.h>
37 #include <vlc_dialog.h>
38 #include <vlc_network.h>
42 #include <libssh2_sftp.h>
45 /*****************************************************************************
47 *****************************************************************************/
48 static int Open ( vlc_object_t* );
49 static void Close( vlc_object_t* );
51 #define USER_TEXT N_("SFTP user name")
52 #define USER_LONGTEXT N_("User name that will be used for the connection.")
53 #define PASS_TEXT N_("SFTP password")
54 #define PASS_LONGTEXT N_("Password that will be used for the connection.")
55 #define PORT_TEXT N_("SFTP port")
56 #define PORT_LONGTEXT N_("SFTP port number to use on the server")
57 #define MTU_TEXT N_("Read size")
58 #define MTU_LONGTEXT N_("Size of the request for reading access")
61 set_shortname( "SFTP" )
62 set_description( N_("SFTP input") )
63 set_capability( "access", 0 )
64 set_category( CAT_INPUT )
65 set_subcategory( SUBCAT_INPUT_ACCESS )
66 add_integer( "sftp-readsize", 8192, MTU_TEXT, MTU_LONGTEXT, true )
67 add_integer( "sftp-port", 22, PORT_TEXT, PORT_LONGTEXT, true )
68 add_shortcut( "sftp" )
69 set_callbacks( Open, Close )
73 /*****************************************************************************
75 *****************************************************************************/
76 static block_t* Block( access_t * );
77 static int Seek( access_t *, uint64_t );
78 static int Control( access_t *, int, va_list );
84 LIBSSH2_SESSION* ssh_session;
85 LIBSSH2_SFTP* sftp_session;
86 LIBSSH2_SFTP_HANDLE* file;
93 * Connect to the sftp server and ask for a file
94 * @param p_this: the vlc_object
95 * @return VLC_SUCCESS if everything was fine
97 static int Open( vlc_object_t* p_this )
99 access_t* p_access = (access_t*)p_this;
101 char* psz_username = NULL;
102 char* psz_password = NULL;
109 if( !p_access->psz_location )
112 STANDARD_BLOCK_ACCESS_INIT;
115 const char* path = p_access->psz_location;
116 vlc_UrlParse( &url, path, 0 );
118 /* Check for some parameters */
119 if( EMPTY_STR( url.psz_host ) )
121 msg_Err( p_access, "You might give a non empty host" );
125 /* If the user name is empty, ask the user */
126 if( !EMPTY_STR( url.psz_username ) && url.psz_password )
128 psz_username = strdup( url.psz_username );
129 psz_password = strdup( url.psz_password );
133 dialog_Login( p_access, &psz_username, &psz_password,
134 _("SFTP authentication"),
135 _("Please enter a valid login and password for the sftp "
136 "connexion to %s"), url.psz_host );
137 if( EMPTY_STR(psz_username) || !psz_password )
141 if( url.i_port <= 0 )
142 i_port = var_InheritInteger( p_access, "sftp-port" );
147 /* Connect to the server using a regular socket */
148 p_sys->i_socket = net_Connect( p_access, url.psz_host, i_port, SOCK_STREAM, 0 );
150 /* Create the ssh connexion and wait until the server answer */
151 if( ( p_sys->ssh_session = libssh2_session_init() ) == NULL )
154 while( ( i_ret = libssh2_session_startup( p_sys->ssh_session,
156 == LIBSSH2_ERROR_EAGAIN );
160 msg_Err( p_access, "Impossible to open the connection to %s:%i", url.psz_host, i_port );
164 /* Set the socket in non-blocking mode */
165 libssh2_session_set_blocking( p_sys->ssh_session, 1 );
167 /* List the know hosts */
168 LIBSSH2_KNOWNHOSTS *ssh_knownhosts = libssh2_knownhost_init( p_sys->ssh_session );
169 if( !ssh_knownhosts )
172 char *psz_home = config_GetUserDir( VLC_HOME_DIR );
173 char *psz_knownhosts_file;
174 if( asprintf( &psz_knownhosts_file, "%s/.ssh/known_hosts", psz_home ) != -1 )
176 libssh2_knownhost_readfile( ssh_knownhosts, psz_knownhosts_file,
177 LIBSSH2_KNOWNHOST_FILE_OPENSSH );
178 free( psz_knownhosts_file );
182 const char *fingerprint = libssh2_session_hostkey( p_sys->ssh_session, &i_len, &i_type );
183 struct libssh2_knownhost *host;
184 int check = libssh2_knownhost_check( ssh_knownhosts, url.psz_host,
186 LIBSSH2_KNOWNHOST_TYPE_PLAIN |
187 LIBSSH2_KNOWNHOST_KEYENC_RAW,
190 libssh2_knownhost_free( ssh_knownhosts );
192 /* Check that it does match or at least that the host is unknown */
195 case LIBSSH2_KNOWNHOST_CHECK_FAILURE:
196 case LIBSSH2_KNOWNHOST_CHECK_NOTFOUND:
197 msg_Dbg( p_access, "Unable to check the remote host" );
199 case LIBSSH2_KNOWNHOST_CHECK_MATCH:
200 msg_Dbg( p_access, "Succesfuly matched the host" );
202 case LIBSSH2_KNOWNHOST_CHECK_MISMATCH:
203 msg_Err( p_access, "The host does not match !! The remote key changed !!" );
207 //TODO: ask for the available auth methods
209 /* send the login/password */
210 if( libssh2_userauth_password( p_sys->ssh_session, psz_username, psz_password ) )
212 msg_Err( p_access, "Authentication by password failed" );
216 /* Create the sftp session */
217 p_sys->sftp_session = libssh2_sftp_init( p_sys->ssh_session );
219 if( !p_sys->sftp_session )
221 msg_Err( p_access, "Unable to initialize the SFTP session" );
225 /* Open the given file */
226 p_sys->file = libssh2_sftp_open( p_sys->sftp_session, url.psz_path, LIBSSH2_FXF_READ, 0 );
229 msg_Err( p_access, "Unable to open the remote file %s", url.psz_path );
233 /* Get some information */
234 LIBSSH2_SFTP_ATTRIBUTES attributes;
235 if( libssh2_sftp_stat( p_sys->sftp_session, url.psz_path, &attributes ) )
237 msg_Err( p_access, "Impossible to get information about the remote file %s", url.psz_path );
240 p_access->info.i_size = attributes.filesize;
242 p_sys->i_read_size = var_InheritInteger( p_access, "sftp-readsize" );
244 free( psz_password );
245 free( psz_username );
246 vlc_UrlClean( &url );
250 if( p_sys->ssh_session )
251 libssh2_session_free( p_sys->ssh_session );
252 free( psz_password );
253 free( psz_username );
254 vlc_UrlClean( &url );
260 /* Close: quit the module */
261 static void Close( vlc_object_t* p_this )
263 access_t* p_access = (access_t*)p_this;
264 access_sys_t* p_sys = p_access->p_sys;
266 libssh2_sftp_close_handle( p_sys->file );
267 libssh2_sftp_shutdown( p_sys->sftp_session );
269 libssh2_session_free( p_sys->ssh_session );
274 static block_t* Block( access_t* p_access )
276 if( p_access->info.b_eof )
279 /* Allocate the buffer we need */
280 size_t i_len = __MIN( p_access->p_sys->i_read_size, p_access->info.i_size -
281 p_access->info.i_pos );
282 block_t* p_block = block_Alloc( i_len );
286 /* Read the specified size */
287 ssize_t i_ret = libssh2_sftp_read( p_access->p_sys->file, (char*)p_block->p_buffer, i_len );
291 block_Release( p_block );
292 msg_Err( p_access, "read failed" );
295 else if( i_ret == 0 )
297 p_access->info.b_eof = true;
298 block_Release( p_block );
303 p_access->info.i_pos += i_ret;
309 static int Seek( access_t* p_access, uint64_t i_pos )
311 p_access->info.i_pos = i_pos;
312 p_access->info.b_eof = false;
314 libssh2_sftp_seek( p_access->p_sys->file, i_pos );
319 static int Control( access_t* p_access, int i_query, va_list args )
326 case ACCESS_CAN_SEEK:
327 pb_bool = (bool*)va_arg( args, bool* );
331 case ACCESS_CAN_FASTSEEK:
332 pb_bool = (bool*)va_arg( args, bool* );
336 case ACCESS_CAN_PAUSE:
337 case ACCESS_CAN_CONTROL_PACE:
338 pb_bool = (bool*)va_arg( args, bool* );
342 case ACCESS_GET_PTS_DELAY:
343 pi_64 = (int64_t*)va_arg( args, int64_t* );
344 *pi_64 = INT64_C(1000)
345 * var_InheritInteger( p_access, "network-caching" );
348 case ACCESS_SET_PAUSE_STATE:
351 case ACCESS_GET_TITLE_INFO:
352 case ACCESS_SET_TITLE:
353 case ACCESS_SET_SEEKPOINT:
354 case ACCESS_SET_PRIVATE_ID_STATE:
355 case ACCESS_GET_META:
356 case ACCESS_GET_PRIVATE_ID_STATE:
357 case ACCESS_GET_CONTENT_TYPE:
361 msg_Warn( p_access, "unimplemented query %d in control", i_query );