Add a libdsm based SMB/CIFS access module

Signed-off-by: Jean-Baptiste Kempf <jb@videolan.org>

NEWS

@@ -3,7 +3,7 @@ Changes between 2.2.x and 3.0.0-git:
 
 Access:
  * Support HDS (Http Dynamic Streaming) from Adobe (f4m, f4v, etc.)
-
+ * New SMB access module using libdsm
 
 Changes between 2.1.x and 2.2.0:
 --------------------------------

configure.ac

@@ -1718,6 +1718,10 @@ dnl
 PKG_ENABLE_MODULES_VLC([SMBCLIENT], [smb], [smbclient], (SMB/CIFS support), [auto])
 AS_IF([test "${SYS}" = "mingw32"], [ VLC_ADD_PLUGIN([access_smb]) ])
 
+dnl
+dnl  liBDSM access module
+dnl
+PKG_ENABLE_MODULES_VLC([DSM], [dsm], [libdsm], [libdsm SMB/CIFS access/sd module], [auto])
 
 dnl
 dnl sftp access support

modules/MODULES_LIST

@@ -98,6 +98,7 @@ $Id$
  * dolby_surround_decoder: simple decoder for dolby surround encoded streams
  * drawable: legacy LibVLC video window provider
  * dshow: DirectShow access plugin for encoding cards under Windows
+ * dsm: SMB access module
  * dts: DTS basic parser/packetizer
  * dtstofloat32: DTS Audio converter
  * dtstospdif: Audio converter that encapsulates DTS into S/PDIF

modules/access/Makefile.am

@@ -386,6 +386,13 @@ libsmb_plugin_la_LDFLAGS = $(AM_LDFLAGS) -rpath '$(accessdir)'
 access_LTLIBRARIES += $(LTLIBsmb)
 EXTRA_LTLIBRARIES += libsmb_plugin.la
 
+libdsm_plugin_la_SOURCES = access/dsm/access.c access/dsm/common.h
+libdsm_plugin_la_CFLAGS = $(AM_CFLAGS) $(DSM_CFLAGS)
+libdsm_plugin_la_LIBADD = $(DSM_LIBS)
+libdsm_plugin_la_LDFLAGS = $(AM_LDFLAGS) -rpath '$(sddir)'
+access_LTLIBRARIES += $(LTLIBdsm)
+EXTRA_LTLIBRARIES += libdsm_plugin.la
+
 libtcp_plugin_la_SOURCES = access/tcp.c
 libtcp_plugin_la_LIBADD = $(SOCKET_LIBS)
 access_LTLIBRARIES += libtcp_plugin.la

modules/access/dsm/access.c

+/*****************************************************************************
+ * bdsm/access.c: liBDSM based SMB/CIFS access module
+ *****************************************************************************
+ * Copyright (C) 2001-2014 VLC authors and VideoLAN
+ *
+ * Authors: Julien 'Lta' BALLET <contact # lta 'dot' io>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+/*****************************************************************************
+ * Preamble
+ *****************************************************************************/
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include "common.h"
+
+#include <vlc_access.h>
+#include <vlc_variables.h>
+#include <vlc_dialog.h>
+
+#include <string.h>
+#include <sys/socket.h>
+#include <netinet/in.h>
+#include <arpa/inet.h>
+#include <netdb.h>
+
+/*****************************************************************************
+ * Module descriptor
+ *****************************************************************************/
+
+#define USER_TEXT N_("SMB user name")
+#define USER_LONGTEXT N_("User name that will " \
+    "be used for the connection. username in uri take precedence over this")
+#define PASS_TEXT N_("SMB password")
+#define PASS_LONGTEXT N_("Password that will be " \
+    "used for the connection. Password in uri take precedence over this.")
+#define DOMAIN_TEXT N_("SMB domain")
+#define DOMAIN_LONGTEXT N_("Domain/Workgroup that " \
+    "will be used for the connection. Domain of uri will also be tried.")
+
+#define BDSM_LOGIN_DIALOG_RETRY 1
+
+#define BDSM_HELP N_("libdsm's SMB (Windows network shares) input and browser")
+
+vlc_module_begin ()
+    set_shortname( "dsm" )
+    set_description( N_("libdsm SMB input") )
+    set_help(BDSM_HELP)
+    set_capability( "access", 20 )
+    set_category( CAT_INPUT )
+    set_subcategory( SUBCAT_INPUT_ACCESS )
+    add_string( "smb-user", NULL, USER_TEXT, USER_LONGTEXT, false )
+    add_password( "smb-pwd", NULL, PASS_TEXT, PASS_LONGTEXT, false )
+    add_string( "smb-domain", NULL, DOMAIN_TEXT, DOMAIN_LONGTEXT, false )
+    add_shortcut( "smb", "cifs" )
+    set_callbacks( Open, Close )
+vlc_module_end ()
+
+/*****************************************************************************
+ * Local prototypes
+ *****************************************************************************/
+static ssize_t Read( access_t *, uint8_t *, size_t );
+static int Seek( access_t *, uint64_t );
+static int Control( access_t *, int, va_list );
+
+static void split_domain_login( char **psz_login, char **psz_domain );
+static void get_credentials( access_t *p_access, access_sys_t *p_sys );
+static bool get_address( access_t *p_access, access_sys_t *p_sys );
+static void login_dialog( access_t *p_access, access_sys_t *p_sys );
+static bool login( access_t *p_access, access_sys_t *p_sys );
+static void backslash_path( vlc_url_t *p_url );
+static bool get_path( access_t *p_access, access_sys_t *p_sys );
+static bool bdsm_init( access_t *p_access, access_sys_t *p_sys );
+static void bdsm_destroy( access_sys_t *p_sys );
+
+/*****************************************************************************
+ * Dialog strings
+ *****************************************************************************/
+#define BDSM_LOGIN_DIALOG_TITLE N_( "%s: Authentication required" )
+#define BDSM_LOGIN_DIALOG_TEXT N_( "The computer you are trying to connect "   \
+    "to requires authentication.\n Please provide a username (and ideally a "  \
+    "domain name using the format DOMAIN\\username)\n and a password." )
+
+/*****************************************************************************
+ * Open: Initialize module's data structures and libdsm
+ *****************************************************************************/
+int Open( vlc_object_t *p_this )
+{
+    access_t     *p_access = (access_t*)p_this;
+    access_sys_t *p_sys;
+
+    /* Init p_access */
+    access_InitFields( p_access );
+    p_sys = p_access->p_sys = (access_sys_t*)calloc( 1, sizeof( access_sys_t ) );
+    if( p_access->p_sys == NULL )
+        return VLC_ENOMEM;
+
+    if( !bdsm_init( p_access, p_sys ) )
+        goto error;
+
+    if( !get_path( p_access, p_sys ) )
+        return BrowserInit( p_access );
+    msg_Dbg( p_access, "Path: Share name = %s, path = %s", p_sys->psz_share,
+             p_sys->psz_path );
+
+
+    /* Connect to the share */
+    p_sys->i_tid = smb_tree_connect( p_sys->p_session, p_sys->psz_share );
+    if( !p_sys->i_tid )
+    {
+        msg_Err( p_access, "Unable to connect to share %s", p_sys->psz_share );
+        goto error;
+    }
+
+    /* Let's finally ask a handle to the file we wanna read ! */
+    p_sys->i_fd = smb_fopen( p_sys->p_session, p_sys->i_tid, p_sys->psz_path,
+                             SMB_MOD_RO );
+    if( !p_sys->i_fd )
+    {
+        msg_Err( p_access, "Unable to open file with path %s (in share %s)",
+                 p_sys->psz_path, p_sys->psz_share );
+        goto error;
+    }
+
+    smb_stat st = smb_stat_fd( p_sys->p_session, p_sys->i_fd );
+    if( smb_stat_get( st, SMB_STAT_ISDIR ) )
+    {
+        smb_fclose( p_sys->p_session, p_sys->i_fd );
+        return BrowserInit( p_access );
+    }
+
+    msg_Dbg( p_access, "Successfully opened smb://%s", p_access->psz_location );
+    ACCESS_SET_CALLBACKS( Read, NULL, Control, Seek );
+    return VLC_SUCCESS;
+
+    error:
+        bdsm_destroy( p_sys );
+        free( p_sys );
+        return VLC_EGENERIC;
+}
+
+/*****************************************************************************
+ * Close: free unused data structures
+ *****************************************************************************/
+void Close( vlc_object_t *p_this )
+{
+    access_t     *p_access = (access_t*)p_this;
+    access_sys_t *p_sys = p_access->p_sys;
+
+    smb_fclose( p_sys->p_session, p_sys->i_fd );
+    bdsm_destroy( p_sys );
+    free( p_sys );
+}
+
+/*****************************************************************************
+ * Local functions
+ *****************************************************************************/
+
+/* Split DOMAIN\User if it finds a '\' in psz_login. */
+static void split_domain_login( char **psz_login, char **psz_domain )
+{
+    char *user = strchr( *psz_login, '\\' );
+
+    if( user != NULL )
+    {
+        *psz_domain = *psz_login;
+        *user = '\0';
+        *psz_login = strdup( user + 1 );
+    }
+}
+
+/* Get credentials from uri or variables. */
+static void get_credentials( access_t *p_access, access_sys_t *p_sys )
+{
+    /* Fetch credentials, either from URI or from options if not provided */
+    if( p_sys->url.psz_password == NULL )
+        p_sys->creds.password = var_InheritString( p_access, "smb-pwd" );
+    else
+        p_sys->creds.password = strdup( p_sys->url.psz_password );
+
+    /* Here we support smb://DOMAIN\User:password@XXX, get user from options
+       or default to "Guest" as last resort */
+    if( p_sys->url.psz_username != NULL )
+    {
+        p_sys->creds.login = strdup( p_sys->url.psz_username );
+        split_domain_login( &p_sys->creds.login, &p_sys->creds.domain );
+    }
+    else
+    {
+        p_sys->creds.login = var_InheritString( p_access, "smb-user" );
+        if( p_sys->creds.login == NULL )
+            p_sys->creds.login = strdup( "Guest" );
+    }
+
+    if( p_sys->creds.domain == NULL )
+        p_sys->creds.domain = var_InheritString( p_access, "smb-domain" );
+
+}
+
+/* Returns false if it wasn't able to get an ip address to connect to */
+static bool get_address( access_t *p_access, access_sys_t *p_sys )
+{
+    if( !inet_aton( p_sys->url.psz_host, &p_sys->addr ) )
+    {
+        /* This is not an ip address, let's try netbios/dns resolve */
+        struct addrinfo *p_info = NULL;
+
+        /* Is this a netbios name on this LAN ? */
+        if( netbios_ns_resolve( p_sys->p_ns, p_sys->url.psz_host, 0x20,
+                                &p_sys->addr.s_addr) )
+        {
+            strlcpy( p_sys->netbios_name, p_sys->url.psz_host, 16);
+            return true;
+        }
+        /* or is it an existing dns name ? */
+        else if( getaddrinfo( p_sys->url.psz_host, NULL, NULL, &p_info ) == 0 )
+        {
+            if( p_info->ai_family == AF_INET )
+            {
+                struct sockaddr_in *in = (struct sockaddr_in *)p_info->ai_addr;
+                p_sys->addr.s_addr = in->sin_addr.s_addr;
+            }
+            freeaddrinfo( p_info );
+            if( p_info->ai_family != AF_INET )
+                return false;
+        }
+        else
+            return false;
+    }
+
+    /* We have an IP address, let's find the NETBIOS name */
+    const char *psz_nbt = netbios_ns_inverse( p_sys->p_ns, p_sys->addr.s_addr );
+    if( psz_nbt != NULL )
+        strlcpy( p_sys->netbios_name, psz_nbt, 16 );
+    else
+    {
+        msg_Warn( p_access, "Unable to get netbios name of %s",
+            p_sys->url.psz_host );
+        p_sys->netbios_name[0] = '\0';
+    }
+
+    /* If no domain was explicitly specified, let's use the machine name */
+    if( p_sys->creds.domain == NULL && p_sys->netbios_name[0] )
+        p_sys->creds.domain = strdup( p_sys->netbios_name );
+
+    return true;
+}
+
+/* Displays a dialog for the user to enter his/her credentials */
+static void login_dialog( access_t *p_access, access_sys_t *p_sys )
+{
+    char *psz_login = NULL, *psz_pass = NULL, *psz_title;
+    int i_ret;
+
+    i_ret = asprintf( &psz_title, BDSM_LOGIN_DIALOG_TITLE, p_sys->netbios_name );
+    if( i_ret != -1 )
+        dialog_Login( p_access, &psz_login, &psz_pass, psz_title,
+                      BDSM_LOGIN_DIALOG_TEXT );
+    else
+        dialog_Login( p_access, &psz_login, &psz_pass, BDSM_LOGIN_DIALOG_TITLE,
+                      BDSM_LOGIN_DIALOG_TEXT );
+    free( psz_title );
+
+    if( psz_login != NULL )
+    {
+        if( p_sys->creds.login != NULL )
+            free( p_sys->creds.login );
+        p_sys->creds.login = psz_login;
+        split_domain_login( &p_sys->creds.login, &p_sys->creds.domain );
+    }
+
+    if( psz_pass != NULL )
+    {
+        if( p_sys->creds.password != NULL )
+            free( p_sys->creds.password );
+        p_sys->creds.password = psz_pass;
+    }
+}
+
+/* Performs login with existing credentials and ask the user for new ones on
+   failure */
+static bool login( access_t *p_access, access_sys_t *p_sys )
+{
+    if( p_sys->creds.login == NULL )
+        p_sys->creds.login = strdup( "Guest" );
+    if( p_sys->creds.password == NULL )
+        p_sys->creds.password = strdup( "Guest" );
+    if( p_sys->creds.domain == NULL )
+        p_sys->creds.domain = strdup( "WORKGROUP" );
+
+    /* Try to authenticate on the remote machine */
+    smb_session_set_creds( p_sys->p_session, p_sys->creds.domain,
+                           p_sys->creds.login, p_sys->creds.password );
+    if( !smb_session_login( p_sys->p_session ) )
+    {
+        for( int i = 0; i < BDSM_LOGIN_DIALOG_RETRY; i++ )
+        {
+            login_dialog( p_access, p_sys );
+            smb_session_set_creds( p_sys->p_session, p_sys->creds.domain,
+                                   p_sys->creds.login, p_sys->creds.password );
+            if( smb_session_login( p_sys->p_session ) )
+                return true;
+        }
+
+        /* FIXME, Try to force netbios name as domain then WORKGROUP here */
+        msg_Err( p_access, "Unable to login with username = %s, password = %s, domain = %s",
+                   p_sys->creds.login, p_sys->creds.password,
+                   p_sys->creds.domain );
+        return false;
+    }
+    else if( smb_session_is_guest( p_sys->p_session ) == 1 )
+        msg_Warn( p_access, "Login failure but you were logged in as a Guest");
+
+    return true;
+}
+
+static void backslash_path( vlc_url_t *p_url )
+{
+    char *iter = p_url->psz_path;
+
+    /* Let's switch the path delimiters from / to \ */
+    while( *iter != '\0' )
+    {
+        if( *iter == '/' )
+            *iter = '\\';
+        iter++;
+    }
+}
+
+/* Get the share and filepath from uri (also replace all / by \ in url.psz_path) */
+static bool get_path( access_t *p_access, access_sys_t *p_sys )
+{
+    VLC_UNUSED( p_access );
+
+    char *iter;
+
+    if( p_sys->url.psz_path == NULL )
+        return false;
+
+    backslash_path( &p_sys->url );
+
+    /* Is path longer than just "/" ? */
+    if( strlen( p_sys->url.psz_path ) > 1 )
+    {
+        iter = p_sys->url.psz_path;
+        while( *iter == '\\' ) iter++; /* Handle smb://Host/////Share/ */
+
+        p_sys->psz_share = strdup( iter );
+        if ( p_sys->psz_share == NULL )
+            return false;
+    }
+    else
+    {
+        msg_Dbg( p_access, "no share, nor file path provided, will switch to browser");
+        return false;
+    }
+
+
+    iter = strchr( p_sys->psz_share, '\\' );
+    if( iter == NULL || strlen(iter + 1) == 0 )
+    {
+        if( iter != NULL ) /* Remove the trailing \ */
+            *iter = '\0';
+        p_sys->psz_path = strdup( "" );
+
+        msg_Dbg( p_access, "no file path provided, will switch to browser ");
+        return true;
+    }
+
+    p_sys->psz_path = strdup( iter + 1); /* Skip the first \ */
+    *iter = '\0';
+    if( p_sys->psz_path == NULL )
+        return false;
+
+    return true;
+}
+
+/* get ip address/path/creds, then connects and try to authenticate */
+static bool bdsm_init( access_t *p_access, access_sys_t *p_sys )
+{
+    p_sys->url.psz_buffer = NULL;
+    p_sys->creds.login    = NULL;
+    p_sys->creds.password = NULL;
+    p_sys->creds.domain   = NULL;
+    p_sys->psz_share      = NULL;
+    p_sys->psz_path       = NULL;
+    p_sys->i_fd           = 0;
+    p_sys->i_tid          = 0;
+
+    p_sys->p_session = smb_session_new();
+    if( p_sys->p_session == NULL )
+        return false;
+
+    p_sys->p_ns = netbios_ns_new();
+    if( p_sys->p_ns == NULL )
+        return false;
+
+    vlc_UrlParse( &p_sys->url, p_access->psz_location, 0 );
+    get_credentials( p_access, p_sys );
+    if( !get_address( p_access, p_sys ) )
+        return false;
+
+    msg_Dbg( p_access, "Creds: username = %s, password = %s, domain = %s",
+             p_sys->creds.login, p_sys->creds.password,
+             p_sys->creds.domain );
+    msg_Dbg( p_access, "Session: Host name = %s, ip = %s", p_sys->netbios_name,
+             inet_ntoa( p_sys->addr ) );
+
+    /* Now that we have the required data, let's establish a session */
+    if( !smb_session_connect( p_sys->p_session, p_sys->netbios_name,
+                              p_sys->addr.s_addr, SMB_TRANSPORT_TCP ))
+    {
+        msg_Err( p_access, "Unable to connect/negotiate SMB session");
+        return false;
+    }
+
+    if( !login( p_access, p_sys ) )
+        return false;
+
+
+
+    return true;
+}
+
+/* Cleanup libdsm stuff */
+static void bdsm_destroy( access_sys_t *p_sys )
+{
+    smb_session_destroy( p_sys->p_session );
+    netbios_ns_destroy( p_sys->p_ns );
+
+    free( p_sys->creds.login );
+    free( p_sys->creds.password );
+    free( p_sys->creds.domain );
+    free( p_sys->url.psz_buffer );
+    free( p_sys->psz_share );
+    free( p_sys->psz_path );
+}
+
+/*****************************************************************************
+ * Seek: try to go at the right place
+ *****************************************************************************/
+static int Seek( access_t *p_access, uint64_t i_pos )
+{
+    access_sys_t *p_sys = p_access->p_sys;
+    int64_t      i_ret;
+
+    if( i_pos >= INT64_MAX )
+        return VLC_EGENERIC;
+
+    msg_Dbg( p_access, "seeking to %"PRId64, i_pos );
+
+    /* seek cannot fail in bdsm, but the subsequent read can */
+    i_ret = smb_fseek(p_sys->p_session, p_sys->i_fd, i_pos, SMB_SEEK_SET);
+
+    p_access->info.b_eof = false;
+    p_access->info.i_pos = i_ret;
+
+    return VLC_SUCCESS;
+}
+
+/*****************************************************************************
+ * Read:
+ *****************************************************************************/
+static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
+{
+    access_sys_t *p_sys = p_access->p_sys;
+    int i_read;
+
+    if( p_access->info.b_eof ) return 0;
+
+    i_read = smb_fread( p_sys->p_session, p_sys->i_fd, p_buffer, i_len );
+    if( i_read < 0 )
+    {
+        msg_Err( p_access, "read failed" );
+        return -1;
+    }
+
+    if( i_read == 0 ) p_access->info.b_eof = true;
+    else if( i_read > 0 ) p_access->info.i_pos += i_read;
+
+    return i_read;
+}
+
+/*****************************************************************************
+ * Control:
+ *****************************************************************************/
+static int Control( access_t *p_access, int i_query, va_list args )
+{
+    switch( i_query )
+    {
+    case ACCESS_CAN_SEEK:
+    case ACCESS_CAN_FASTSEEK:
+    case ACCESS_CAN_PAUSE:
+    case ACCESS_CAN_CONTROL_PACE:
+        *va_arg( args, bool* ) = true;
+        break;
+
+    case ACCESS_GET_SIZE:
+    {
+        smb_stat st = smb_stat_fd( p_access->p_sys->p_session,
+                                   p_access->p_sys->i_fd );
+        *va_arg( args, uint64_t * ) = smb_stat_get( st, SMB_STAT_SIZE );
+        break;
+    }
+    case ACCESS_GET_PTS_DELAY:
+        *va_arg( args, int64_t * ) = INT64_C(1000)
+            * var_InheritInteger( p_access, "network-caching" );
+        break;
+
+    case ACCESS_SET_PAUSE_STATE:
+        /* Nothing to do */
+        break;
+
+    default:
+        return VLC_EGENERIC;
+    }
+
+    return VLC_SUCCESS;
+}

modules/access/dsm/common.h

+/**
+ * @file bdsm/common.h
+ * @brief List host supporting NETBIOS on the local network
+ */
+/*****************************************************************************
+ * Copyright © 2014 Authors and the VideoLAN team
+ *
+ * Authors: - Julien 'Lta' BALLET <contact # lta 'dot' io>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+#include <bdsm/bdsm.h>
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#include <vlc_access.h>
+#include <vlc_url.h>
+
+int Open( vlc_object_t * );
+void Close( vlc_object_t * );
+
+int BrowserInit( access_t *p_access ) { return VLC_EGENERIC; }
+
+struct access_sys_t
+{
+    netbios_ns         *p_ns;               /**< Netbios name service */
+    smb_session        *p_session;          /**< bdsm SMB Session object */
+    smb_creds           creds;              /**< Credentials used to connect */
+
+    vlc_url_t           url;
+    char               *psz_share;
+    char               *psz_path;
+
+    char                netbios_name[16];
+    struct in_addr      addr;
+
+    smb_fd              i_fd;               /**< SMB fd for the file we're reading */
+    smb_tid             i_tid;              /**< SMB Tree ID we're connected to */
+};
+

po/POTFILES.in

@@ -192,6 +192,7 @@ modules/access/dshow/crossbar.cpp
 modules/access/dshow/dshow.cpp
 modules/access/dshow/filter.cpp
 modules/access/dshow/filter.h
+modules/access/dsm/access.c
 modules/access/dtv/access.c
 modules/access/dv.c
 modules/access/dvdnav.c