suricata
util-path.h
Go to the documentation of this file.
1 /* Copyright (C) 2007-2012 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /**
19  * \file
20  *
21  * \author Victor Julien <victor@inliniac.net>
22  *
23  */
24 
25 #ifndef __UTIL_PATH_H__
26 #define __UTIL_PATH_H__
27 
28 #ifdef OS_WIN32
29 typedef struct _stat SCStat;
30 #define SCFstatFn(fd, statbuf) _fstat((fd), (statbuf))
31 #define SCStatFn(pathname, statbuf) _stat((pathname), (statbuf))
32 #else
33 typedef struct stat SCStat;
34 #define SCFstatFn(fd, statbuf) fstat((fd), (statbuf))
35 #define SCStatFn(pathname, statbuf) stat((pathname), (statbuf))
36 #endif
37 
38 #if defined OS_WIN32 || defined __CYGWIN__
39 #define PATH_SEPARATOR_SIZE 2
40 #else
41 #define PATH_SEPARATOR_SIZE 1
42 #endif
43 
44 #ifndef HAVE_NON_POSIX_MKDIR
45  #define SCMkDir(a, b) mkdir(a, b)
46 #else
47  #define SCMkDir(a, b) mkdir(a)
48 #endif
49 
50 int PathIsAbsolute(const char *);
51 int PathIsRelative(const char *);
52 int PathMerge(char *out_buf, size_t buf_size, const char *const dir, const char *const fname);
53 char *PathMergeAlloc(const char *const dir, const char *const fname);
54 int PathJoin(char *out_buf, size_t buf_len, const char *const dir, const char *const fname);
55 int SCDefaultMkDir(const char *path);
56 int SCCreateDirectoryTree(const char *path, const bool final);
57 bool SCPathExists(const char *path);
58 bool SCIsRegularDirectory(const struct dirent *const dir_entry);
59 bool SCIsRegularFile(const struct dirent *const dir_entry);
60 char *SCRealPath(const char *path, char *resolved_path);
61 const char *SCBasename(const char *path);
62 bool SCPathContainsTraversal(const char *path);
63 
64 #endif /* __UTIL_PATH_H__ */
PathIsAbsolute
int PathIsAbsolute(const char *)
Check if a path is absolute.
Definition: util-path.c:44
SCIsRegularDirectory
bool SCIsRegularDirectory(const struct dirent *const dir_entry)
OS independent wrapper for directory check.
Definition: util-path.c:236
PathIsRelative
int PathIsRelative(const char *)
Check if a path is relative.
Definition: util-path.c:69
SCIsRegularFile
bool SCIsRegularFile(const struct dirent *const dir_entry)
OS independent to check for regular file.
Definition: util-path.c:254
SCRealPath
char * SCRealPath(const char *path, char *resolved_path)
OS independent wrapper for realpath.
Definition: util-path.c:270
SCPathContainsTraversal
bool SCPathContainsTraversal(const char *path)
Check for directory traversal.
Definition: util-path.c:307
SCCreateDirectoryTree
int SCCreateDirectoryTree(const char *path, const bool final)
Recursively create a directory.
Definition: util-path.c:173
PathMerge
int PathMerge(char *out_buf, size_t buf_size, const char *const dir, const char *const fname)
Definition: util-path.c:74
SCDefaultMkDir
int SCDefaultMkDir(const char *path)
Wrapper around SCMkDir with default mode arguments.
Definition: util-path.c:159
PathJoin
int PathJoin(char *out_buf, size_t buf_len, const char *const dir, const char *const fname)
Wrapper to join a directory and filename and resolve using realpath _fullpath is used for WIN32.
Definition: util-path.c:132
SCBasename
const char * SCBasename(const char *path)
Definition: util-path.c:285
PathMergeAlloc
char * PathMergeAlloc(const char *const dir, const char *const fname)
Definition: util-path.c:107
SCPathExists
bool SCPathExists(const char *path)
Check if a path exists.
Definition: util-path.c:219
SCStat
struct stat SCStat
Definition: util-path.h:33