LGPL
[vlc.git] / src / network / acl.c
index 8e81d3e..d2a4518 100644 (file)
@@ -1,39 +1,40 @@
 /*****************************************************************************
  * acl.c:
  *****************************************************************************
- * Copyright (C) 2005 Rémi Denis-Courmont
+ * Copyright © 2005-2007 Rémi Denis-Courmont
  * $Id$
  *
  * Authors: Rémi Denis-Courmont <rem # videolan.org>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * 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 General Public License for more details.
+ * 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 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.
+ * 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
  *****************************************************************************/
-#include <stdlib.h>
-#include <string.h>
-#include <ctype.h>
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
 
-#include "vlc_acl.h"
+#include <vlc_common.h>
 
-#include <errno.h>
+#include <ctype.h>
+#include <vlc_acl.h>
 
-#include "network.h"
+#include <vlc_network.h>
+#include <vlc_fs.h>
 
 /* FIXME: rwlock on acl, but libvlc doesn't implement rwlock */
 typedef struct vlc_acl_entry_t
@@ -41,7 +42,7 @@ typedef struct vlc_acl_entry_t
     uint8_t    host[17];
     uint8_t    i_bytes_match;
     uint8_t    i_bits_mask;
-    vlc_bool_t b_allow;
+    bool b_allow;
 } vlc_acl_entry_t;
 
 struct vlc_acl_t
@@ -49,15 +50,16 @@ struct vlc_acl_t
     vlc_object_t    *p_owner;
     unsigned         i_size;
     vlc_acl_entry_t *p_entries;
-    vlc_bool_t       b_allow_default;
+    bool       b_allow_default;
 };
 
 static int ACL_Resolve( vlc_object_t *p_this, uint8_t *p_bytes,
                         const char *psz_ip )
 {
-    struct addrinfo hints = { 0 }, *res;
+    struct addrinfo hints, *res;
     int i_family;
 
+    memset (&hints, 0, sizeof (hints));
     hints.ai_socktype = SOCK_STREAM; /* doesn't matter */
     hints.ai_flags = AI_NUMERICHOST;
 
@@ -82,9 +84,7 @@ static int ACL_Resolve( vlc_object_t *p_this, uint8_t *p_bytes,
             break;
         }
 
-#if defined (HAVE_GETADDRINFO) || defined (WIN32)
-        /* unfortunately many people define AF_INET6
-           though they don't have struct sockaddr_in6 */
+#ifdef AF_INET6
         case AF_INET6:
         {
             struct sockaddr_in6 *addr;
@@ -96,18 +96,25 @@ static int ACL_Resolve( vlc_object_t *p_this, uint8_t *p_bytes,
 #endif
 
         default:
-            msg_Err( p_this, "IMPOSSIBLE: unknown address family!" );
-            vlc_freeaddrinfo( res );
+            msg_Err( p_this, "unknown address family" );
+            freeaddrinfo( res );
             return -1;
     }
 
-    vlc_freeaddrinfo( res );
+    freeaddrinfo( res );
     return i_family;
 }
 
 
-/*
- * Returns 0 if allowed, 1 if not, -1 on error.
+/**
+ * Check if a given address passes an access control list.
+ *
+ * @param p_acl pre-existing ACL to match the address against
+ * @param psz_ip numeric IPv4/IPv6 address
+ *
+ * @return 0 if the first matching ACL entry is an access grant,
+ * 1 if the first matching ACL entry is a denial of access,
+ * -1 on error.
  */
 int ACL_Check( vlc_acl_t *p_acl, const char *psz_ip )
 {
@@ -138,8 +145,12 @@ int ACL_Check( vlc_acl_t *p_acl, const char *psz_ip )
     return !p_acl->b_allow_default;
 }
 
+/**
+ * Adds an item to an ACL.
+ * Items are always matched in the same order as they are added.
+ */
 int ACL_AddNet( vlc_acl_t *p_acl, const char *psz_ip, int i_len,
-                vlc_bool_t b_allow )
+                bool b_allow )
 {
     vlc_acl_entry_t *p_ent;
     unsigned i_size;
@@ -174,9 +185,6 @@ int ACL_AddNet( vlc_acl_t *p_acl, const char *psz_ip, int i_len,
 
         if( i_len > 128 )
             i_len = 128;
-        else
-        if( i_len < 0 )
-            i_len = 0;
     }
     else
         i_len = 128; /* ACL_AddHost */
@@ -189,8 +197,16 @@ int ACL_AddNet( vlc_acl_t *p_acl, const char *psz_ip, int i_len,
     return 0;
 }
 
-
-vlc_acl_t *__ACL_Create( vlc_object_t *p_this, vlc_bool_t b_allow )
+#undef ACL_Create
+/**
+ * Creates an empty ACL.
+ *
+ * @param b_allow whether to grant (true) or deny (false) access
+ * by default (ie if none of the ACL entries matched).
+ *
+ * @return an ACL object. NULL in case of error.
+ */
+vlc_acl_t *ACL_Create( vlc_object_t *p_this, bool b_allow )
 {
     vlc_acl_t *p_acl;
 
@@ -198,7 +214,7 @@ vlc_acl_t *__ACL_Create( vlc_object_t *p_this, vlc_bool_t b_allow )
     if( p_acl == NULL )
         return NULL;
 
-    vlc_object_yield( p_this );
+    vlc_object_hold( p_this );
     p_acl->p_owner = p_this;
     p_acl->i_size = 0;
     p_acl->p_entries = NULL;
@@ -207,8 +223,16 @@ vlc_acl_t *__ACL_Create( vlc_object_t *p_this, vlc_bool_t b_allow )
     return p_acl;
 }
 
-
-vlc_acl_t *__ACL_Duplicate( vlc_object_t *p_this, const vlc_acl_t *p_acl )
+#undef ACL_Duplicate
+/**
+ * Perform a deep copy of an existing ACL.
+ *
+ * @param p_this object to attach the copy to.
+ * @param p_acl ACL object to be copied.
+ *
+ * @return a new ACL object, or NULL on error.
+ */
+vlc_acl_t *ACL_Duplicate( vlc_object_t *p_this, const vlc_acl_t *p_acl )
 {
     vlc_acl_t *p_dupacl;
 
@@ -236,7 +260,7 @@ vlc_acl_t *__ACL_Duplicate( vlc_object_t *p_this, const vlc_acl_t *p_acl )
     else
         p_dupacl->p_entries = NULL;
 
-    vlc_object_yield( p_this );
+    vlc_object_hold( p_this );
     p_dupacl->p_owner = p_this;
     p_dupacl->i_size = p_acl->i_size;
     p_dupacl->b_allow_default = p_acl->b_allow_default;
@@ -245,22 +269,28 @@ vlc_acl_t *__ACL_Duplicate( vlc_object_t *p_this, const vlc_acl_t *p_acl )
 }
 
 
+/**
+ * Releases all resources associated with an ACL object.
+ */
 void ACL_Destroy( vlc_acl_t *p_acl )
 {
     if( p_acl != NULL )
     {
-        if( p_acl->p_entries != NULL )
-            free( p_acl->p_entries );
-
+        free( p_acl->p_entries );
         vlc_object_release( p_acl->p_owner );
         free( p_acl );
     }
 }
 
-#ifndef isblank 
-#   define isblank(c) ((c) == ' ' || (c) == '\t')
-#endif
 
+/**
+ * Reads ACL entries from a file.
+ *
+ * @param p_acl ACL object in which to insert parsed entries.
+ * @param psz_patch filename from which to parse entries.
+ *
+ * @return 0 on success, -1 on error.
+ */
 int ACL_LoadFile( vlc_acl_t *p_acl, const char *psz_path )
 {
     FILE *file;
@@ -268,7 +298,7 @@ int ACL_LoadFile( vlc_acl_t *p_acl, const char *psz_path )
     if( p_acl == NULL )
         return -1;
 
-    file = fopen( psz_path, "r" );
+    file = vlc_fopen( psz_path, "r" );
     if( file == NULL )
         return -1;
 
@@ -282,8 +312,7 @@ int ACL_LoadFile( vlc_acl_t *p_acl, const char *psz_path )
         {
             if( ferror( file ) )
             {
-                msg_Err( p_acl->p_owner, "Error reading %s : %s\n", psz_path,
-                        strerror( errno ) );
+                msg_Err( p_acl->p_owner, "error reading %s : %m", psz_path );
                 goto error;
             }
             continue;
@@ -293,25 +322,27 @@ int ACL_LoadFile( vlc_acl_t *p_acl, const char *psz_path )
         psz_ip = line;
 
         /* skips blanks - cannot overflow given '\0' is not space */
-        while( isspace( *psz_ip ) )
+        while( isspace( (unsigned char)*psz_ip ) )
             psz_ip++;
 
         if( *psz_ip == '\0' ) /* empty/blank line */
             continue;
 
         ptr = strchr( psz_ip, '\n' );
-        if( ptr == NULL )
+        if( ptr == NULL && !feof(file) )
         {
-            msg_Warn( p_acl->p_owner, "Skipping overly long line in %s\n",
+            msg_Warn( p_acl->p_owner, "skipping overly long line in %s",
                       psz_path);
             do
             {
-                fgets( line, sizeof( line ), file );
-                if( ferror( file ) || feof( file ) )
+                if( fgets( line, sizeof( line ), file ) == NULL )
                 {
-                    msg_Err( p_acl->p_owner, "Error reading %s : %s\n",
-                             psz_path, strerror( errno ) );
-                    goto error;
+                     if( ferror( file ) )
+                     {
+                         msg_Err( p_acl->p_owner, "error reading %s : %m",
+                                  psz_path );
+                     }
+                     goto error;
                 }
             }
             while( strchr( line, '\n' ) == NULL);
@@ -319,16 +350,15 @@ int ACL_LoadFile( vlc_acl_t *p_acl, const char *psz_path )
             continue; /* skip unusable line */
         }
 
-        /* skips comment-only line */
-        if( *psz_ip == '#' )
-            continue;
-
-        /* looks for first space, CR, LF, etc. or end-of-line comment */
-        /* (there is at least a linefeed) */
-        for( ptr = psz_ip; ( *ptr != '#' ) && !isspace( *ptr ); ptr++ );
+        /* look for first space, CR, LF, etc. or comment character */
+        for( ptr = psz_ip; ( *ptr!='#' ) && !isspace( (unsigned char)*ptr ) && *ptr; ++ptr );
 
         *ptr = '\0';
 
+        /* skip lines without usable information */
+        if( ptr == psz_ip )
+            continue;
+
         msg_Dbg( p_acl->p_owner, "restricted to %s", psz_ip );
 
         ptr = strchr( psz_ip, '/' );
@@ -336,11 +366,11 @@ int ACL_LoadFile( vlc_acl_t *p_acl, const char *psz_path )
             *ptr++ = '\0'; /* separate address from mask length */
 
         if( (ptr != NULL)
-            ? ACL_AddNet( p_acl, psz_ip, atoi( ptr ), VLC_TRUE ) 
-            : ACL_AddHost( p_acl, psz_ip, VLC_TRUE ) )
+            ? ACL_AddNet( p_acl, psz_ip, atoi( ptr ), true )
+            : ACL_AddHost( p_acl, psz_ip, true ) )
         {
             msg_Err( p_acl->p_owner, "cannot add ACL from %s", psz_path );
-            goto error;
+            continue;
         }
     }