/* * Python object definition of the libfsntfs file name attribute * * Copyright (C) 2010-2019, Joachim Metz * * Refer to AUTHORS for acknowledgements. * * This software 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 3 of the License, or * (at your option) any later version. * * This software 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. * * You should have received a copy of the GNU Lesser General Public License * along with this software. If not, see . */ #include #include #if defined( HAVE_STDLIB_H ) || defined( HAVE_WINAPI ) #include #endif #include "pyfsntfs_attribute.h" #include "pyfsntfs_datetime.h" #include "pyfsntfs_error.h" #include "pyfsntfs_file_name_attribute.h" #include "pyfsntfs_integer.h" #include "pyfsntfs_libcerror.h" #include "pyfsntfs_libfsntfs.h" #include "pyfsntfs_python.h" #include "pyfsntfs_unused.h" PyMethodDef pyfsntfs_file_name_attribute_object_methods[] = { /* Functions to access the attribute values */ { "get_parent_file_reference", (PyCFunction) pyfsntfs_file_name_attribute_get_parent_file_reference, METH_NOARGS, "get_parent_file_reference() -> Integer\n" "\n" "Returns the parent file reference, a combination of MFT entry index and sequence number." }, { "get_creation_time", (PyCFunction) pyfsntfs_file_name_attribute_get_creation_time, METH_NOARGS, "get_creation_time() -> Datetime or None\n" "\n" "Returns the creation date and time." }, { "get_creation_time_as_integer", (PyCFunction) pyfsntfs_file_name_attribute_get_creation_time_as_integer, METH_NOARGS, "get_creation_time_as_integer() -> Integer or None\n" "\n" "Returns the creation date and time as a 64-bit integer containing a FILETIME value." }, { "get_modification_time", (PyCFunction) pyfsntfs_file_name_attribute_get_modification_time, METH_NOARGS, "get_modification_time() -> Datetime or None\n" "\n" "Returns the modification date and time." }, { "get_modification_time_as_integer", (PyCFunction) pyfsntfs_file_name_attribute_get_modification_time_as_integer, METH_NOARGS, "get_modification_time_as_integer() -> Integer or None\n" "\n" "Returns the modification date and time as a 64-bit integer containing a FILETIME value." }, { "get_access_time", (PyCFunction) pyfsntfs_file_name_attribute_get_access_time, METH_NOARGS, "get_access_time() -> Datetime or None\n" "\n" "Returns the access date and time." }, { "get_access_time_as_integer", (PyCFunction) pyfsntfs_file_name_attribute_get_access_time_as_integer, METH_NOARGS, "get_access_time_as_integer() -> Integer or None\n" "\n" "Returns the access date and time as a 64-bit integer containing a FILETIME value." }, { "get_entry_modification_time", (PyCFunction) pyfsntfs_file_name_attribute_get_entry_modification_time, METH_NOARGS, "get_entry_modification_time() -> Datetime or None\n" "\n" "Returns the entry modification date and time." }, { "get_entry_modification_time_as_integer", (PyCFunction) pyfsntfs_file_name_attribute_get_entry_modification_time_as_integer, METH_NOARGS, "get_entry_modification_time_as_integer() -> Integer or None\n" "\n" "Returns the entry modification date and time as a 64-bit integer containing a FILETIME value." }, { "get_file_attribute_flags", (PyCFunction) pyfsntfs_file_name_attribute_get_file_attribute_flags, METH_NOARGS, "get_file_attribute_flags() -> Integer\n" "\n" "Returns the file attribute flags." }, { "get_name", (PyCFunction) pyfsntfs_file_name_attribute_get_name, METH_NOARGS, "get_name() -> Unicode string or None\n" "\n" "Returns the name." }, /* Sentinel */ { NULL, NULL, 0, NULL } }; PyGetSetDef pyfsntfs_file_name_attribute_object_get_set_definitions[] = { { "parent_file_reference", (getter) pyfsntfs_file_name_attribute_get_parent_file_reference, (setter) 0, "The parent file reference, a combination of MFT entry index and sequence number.", NULL }, { "creation_time", (getter) pyfsntfs_file_name_attribute_get_creation_time, (setter) 0, "The creation date and time.", NULL }, { "modification_time", (getter) pyfsntfs_file_name_attribute_get_modification_time, (setter) 0, "The modification date and time.", NULL }, { "access_time", (getter) pyfsntfs_file_name_attribute_get_access_time, (setter) 0, "The access date and time.", NULL }, { "entry_modification_time", (getter) pyfsntfs_file_name_attribute_get_entry_modification_time, (setter) 0, "The entry modification date and time.", NULL }, { "file_attribute_flags", (getter) pyfsntfs_file_name_attribute_get_file_attribute_flags, (setter) 0, "The file attribute flags.", NULL }, { "name", (getter) pyfsntfs_file_name_attribute_get_name, (setter) 0, "The name.", NULL }, /* Sentinel */ { NULL, NULL, NULL, NULL, NULL } }; PyTypeObject pyfsntfs_file_name_attribute_type_object = { PyVarObject_HEAD_INIT( NULL, 0 ) /* tp_name */ "pyfsntfs.file_name_attribute", /* tp_basicsize */ sizeof( pyfsntfs_attribute_t ), /* tp_itemsize */ 0, /* tp_dealloc */ 0, /* tp_print */ 0, /* tp_getattr */ 0, /* tp_setattr */ 0, /* tp_compare */ 0, /* tp_repr */ 0, /* tp_as_number */ 0, /* tp_as_sequence */ 0, /* tp_as_mapping */ 0, /* tp_hash */ 0, /* tp_call */ 0, /* tp_str */ 0, /* tp_getattro */ 0, /* tp_setattro */ 0, /* tp_as_buffer */ 0, /* tp_flags */ Py_TPFLAGS_DEFAULT, /* tp_doc */ "pyfsntfs file name attribute object (wraps libfsntfs_attribute_t type LIBFSNTFS_ATTRIBUTE_TYPE_FILE_NAME)", /* tp_traverse */ 0, /* tp_clear */ 0, /* tp_richcompare */ 0, /* tp_weaklistoffset */ 0, /* tp_iter */ 0, /* tp_iternext */ 0, /* tp_methods */ pyfsntfs_file_name_attribute_object_methods, /* tp_members */ 0, /* tp_getset */ pyfsntfs_file_name_attribute_object_get_set_definitions, /* tp_base */ &pyfsntfs_attribute_type_object, /* tp_dict */ 0, /* tp_descr_get */ 0, /* tp_descr_set */ 0, /* tp_dictoffset */ 0, /* tp_init */ 0, /* tp_alloc */ 0, /* tp_new */ 0, /* tp_free */ 0, /* tp_is_gc */ 0, /* tp_bases */ NULL, /* tp_mro */ NULL, /* tp_cache */ NULL, /* tp_subclasses */ NULL, /* tp_weaklist */ NULL, /* tp_del */ 0 }; /* Retrieves the parent file reference * Returns a Python object if successful or NULL on error */ PyObject *pyfsntfs_file_name_attribute_get_parent_file_reference( pyfsntfs_attribute_t *pyfsntfs_attribute, PyObject *arguments PYFSNTFS_ATTRIBUTE_UNUSED ) { libcerror_error_t *error = NULL; PyObject *integer_object = NULL; static char *function = "pyfsntfs_file_name_attribute_get_parent_file_reference"; uint64_t file_reference = 0; int result = 0; PYFSNTFS_UNREFERENCED_PARAMETER( arguments ) if( pyfsntfs_attribute == NULL ) { PyErr_Format( PyExc_TypeError, "%s: invalid attribute.", function ); return( NULL ); } Py_BEGIN_ALLOW_THREADS result = libfsntfs_file_name_attribute_get_parent_file_reference( pyfsntfs_attribute->attribute, &file_reference, &error ); Py_END_ALLOW_THREADS if( result != 1 ) { pyfsntfs_error_raise( error, PyExc_IOError, "%s: unable to retrieve parent file reference.", function ); libcerror_error_free( &error ); return( NULL ); } integer_object = pyfsntfs_integer_unsigned_new_from_64bit( file_reference ); return( integer_object ); } /* Retrieves the creation date and time * Returns a Python object if successful or NULL on error */ PyObject *pyfsntfs_file_name_attribute_get_creation_time( pyfsntfs_attribute_t *pyfsntfs_attribute, PyObject *arguments PYFSNTFS_ATTRIBUTE_UNUSED ) { libcerror_error_t *error = NULL; PyObject *date_time_object = NULL; static char *function = "pyfsntfs_file_name_attribute_get_creation_time"; uint64_t filetime = 0; int result = 0; PYFSNTFS_UNREFERENCED_PARAMETER( arguments ) if( pyfsntfs_attribute == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid attribute.", function ); return( NULL ); } Py_BEGIN_ALLOW_THREADS result = libfsntfs_file_name_attribute_get_creation_time( pyfsntfs_attribute->attribute, &filetime, &error ); Py_END_ALLOW_THREADS if( result == -1 ) { pyfsntfs_error_raise( error, PyExc_IOError, "%s: unable to retrieve creation time.", function ); libcerror_error_free( &error ); return( NULL ); } else if( result == 0 ) { Py_IncRef( Py_None ); return( Py_None ); } date_time_object = pyfsntfs_datetime_new_from_filetime( filetime ); return( date_time_object ); } /* Retrieves the creation date and time as an integer * Returns a Python object if successful or NULL on error */ PyObject *pyfsntfs_file_name_attribute_get_creation_time_as_integer( pyfsntfs_attribute_t *pyfsntfs_attribute, PyObject *arguments PYFSNTFS_ATTRIBUTE_UNUSED ) { libcerror_error_t *error = NULL; PyObject *integer_object = NULL; static char *function = "pyfsntfs_file_name_attribute_get_creation_time_as_integer"; uint64_t filetime = 0; int result = 0; PYFSNTFS_UNREFERENCED_PARAMETER( arguments ) if( pyfsntfs_attribute == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid attribute.", function ); return( NULL ); } Py_BEGIN_ALLOW_THREADS result = libfsntfs_file_name_attribute_get_creation_time( pyfsntfs_attribute->attribute, &filetime, &error ); Py_END_ALLOW_THREADS if( result == -1 ) { pyfsntfs_error_raise( error, PyExc_IOError, "%s: unable to retrieve creation time.", function ); libcerror_error_free( &error ); return( NULL ); } else if( result == 0 ) { Py_IncRef( Py_None ); return( Py_None ); } integer_object = pyfsntfs_integer_unsigned_new_from_64bit( filetime ); return( integer_object ); } /* Retrieves the modification date and time * Returns a Python object if successful or NULL on error */ PyObject *pyfsntfs_file_name_attribute_get_modification_time( pyfsntfs_attribute_t *pyfsntfs_attribute, PyObject *arguments PYFSNTFS_ATTRIBUTE_UNUSED ) { libcerror_error_t *error = NULL; PyObject *date_time_object = NULL; static char *function = "pyfsntfs_file_name_attribute_get_modification_time"; uint64_t filetime = 0; int result = 0; PYFSNTFS_UNREFERENCED_PARAMETER( arguments ) if( pyfsntfs_attribute == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid attribute.", function ); return( NULL ); } Py_BEGIN_ALLOW_THREADS result = libfsntfs_file_name_attribute_get_modification_time( pyfsntfs_attribute->attribute, &filetime, &error ); Py_END_ALLOW_THREADS if( result == -1 ) { pyfsntfs_error_raise( error, PyExc_IOError, "%s: unable to retrieve modification time.", function ); libcerror_error_free( &error ); return( NULL ); } else if( result == 0 ) { Py_IncRef( Py_None ); return( Py_None ); } date_time_object = pyfsntfs_datetime_new_from_filetime( filetime ); return( date_time_object ); } /* Retrieves the modification date and time as an integer * Returns a Python object if successful or NULL on error */ PyObject *pyfsntfs_file_name_attribute_get_modification_time_as_integer( pyfsntfs_attribute_t *pyfsntfs_attribute, PyObject *arguments PYFSNTFS_ATTRIBUTE_UNUSED ) { libcerror_error_t *error = NULL; PyObject *integer_object = NULL; static char *function = "pyfsntfs_file_name_attribute_get_modification_time_as_integer"; uint64_t filetime = 0; int result = 0; PYFSNTFS_UNREFERENCED_PARAMETER( arguments ) if( pyfsntfs_attribute == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid attribute.", function ); return( NULL ); } Py_BEGIN_ALLOW_THREADS result = libfsntfs_file_name_attribute_get_modification_time( pyfsntfs_attribute->attribute, &filetime, &error ); Py_END_ALLOW_THREADS if( result == -1 ) { pyfsntfs_error_raise( error, PyExc_IOError, "%s: unable to retrieve modification time.", function ); libcerror_error_free( &error ); return( NULL ); } else if( result == 0 ) { Py_IncRef( Py_None ); return( Py_None ); } integer_object = pyfsntfs_integer_unsigned_new_from_64bit( filetime ); return( integer_object ); } /* Retrieves the access date and time * Returns a Python object if successful or NULL on error */ PyObject *pyfsntfs_file_name_attribute_get_access_time( pyfsntfs_attribute_t *pyfsntfs_attribute, PyObject *arguments PYFSNTFS_ATTRIBUTE_UNUSED ) { libcerror_error_t *error = NULL; PyObject *date_time_object = NULL; static char *function = "pyfsntfs_file_name_attribute_get_access_time"; uint64_t filetime = 0; int result = 0; PYFSNTFS_UNREFERENCED_PARAMETER( arguments ) if( pyfsntfs_attribute == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid attribute.", function ); return( NULL ); } Py_BEGIN_ALLOW_THREADS result = libfsntfs_file_name_attribute_get_access_time( pyfsntfs_attribute->attribute, &filetime, &error ); Py_END_ALLOW_THREADS if( result == -1 ) { pyfsntfs_error_raise( error, PyExc_IOError, "%s: unable to retrieve access time.", function ); libcerror_error_free( &error ); return( NULL ); } else if( result == 0 ) { Py_IncRef( Py_None ); return( Py_None ); } date_time_object = pyfsntfs_datetime_new_from_filetime( filetime ); return( date_time_object ); } /* Retrieves the access date and time as an integer * Returns a Python object if successful or NULL on error */ PyObject *pyfsntfs_file_name_attribute_get_access_time_as_integer( pyfsntfs_attribute_t *pyfsntfs_attribute, PyObject *arguments PYFSNTFS_ATTRIBUTE_UNUSED ) { libcerror_error_t *error = NULL; PyObject *integer_object = NULL; static char *function = "pyfsntfs_file_name_attribute_get_access_time_as_integer"; uint64_t filetime = 0; int result = 0; PYFSNTFS_UNREFERENCED_PARAMETER( arguments ) if( pyfsntfs_attribute == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid attribute.", function ); return( NULL ); } Py_BEGIN_ALLOW_THREADS result = libfsntfs_file_name_attribute_get_access_time( pyfsntfs_attribute->attribute, &filetime, &error ); Py_END_ALLOW_THREADS if( result == -1 ) { pyfsntfs_error_raise( error, PyExc_IOError, "%s: unable to retrieve access time.", function ); libcerror_error_free( &error ); return( NULL ); } else if( result == 0 ) { Py_IncRef( Py_None ); return( Py_None ); } integer_object = pyfsntfs_integer_unsigned_new_from_64bit( filetime ); return( integer_object ); } /* Retrieves the entry modification date and time * Returns a Python object if successful or NULL on error */ PyObject *pyfsntfs_file_name_attribute_get_entry_modification_time( pyfsntfs_attribute_t *pyfsntfs_attribute, PyObject *arguments PYFSNTFS_ATTRIBUTE_UNUSED ) { libcerror_error_t *error = NULL; PyObject *date_time_object = NULL; static char *function = "pyfsntfs_file_name_attribute_get_entry_modification_time"; uint64_t filetime = 0; int result = 0; PYFSNTFS_UNREFERENCED_PARAMETER( arguments ) if( pyfsntfs_attribute == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid attribute.", function ); return( NULL ); } Py_BEGIN_ALLOW_THREADS result = libfsntfs_file_name_attribute_get_entry_modification_time( pyfsntfs_attribute->attribute, &filetime, &error ); Py_END_ALLOW_THREADS if( result == -1 ) { pyfsntfs_error_raise( error, PyExc_IOError, "%s: unable to retrieve entry modification time.", function ); libcerror_error_free( &error ); return( NULL ); } else if( result == 0 ) { Py_IncRef( Py_None ); return( Py_None ); } date_time_object = pyfsntfs_datetime_new_from_filetime( filetime ); return( date_time_object ); } /* Retrieves the entry modification date and time as an integer * Returns a Python object if successful or NULL on error */ PyObject *pyfsntfs_file_name_attribute_get_entry_modification_time_as_integer( pyfsntfs_attribute_t *pyfsntfs_attribute, PyObject *arguments PYFSNTFS_ATTRIBUTE_UNUSED ) { libcerror_error_t *error = NULL; PyObject *integer_object = NULL; static char *function = "pyfsntfs_file_name_attribute_get_entry_modification_time_as_integer"; uint64_t filetime = 0; int result = 0; PYFSNTFS_UNREFERENCED_PARAMETER( arguments ) if( pyfsntfs_attribute == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid attribute.", function ); return( NULL ); } Py_BEGIN_ALLOW_THREADS result = libfsntfs_file_name_attribute_get_entry_modification_time( pyfsntfs_attribute->attribute, &filetime, &error ); Py_END_ALLOW_THREADS if( result == -1 ) { pyfsntfs_error_raise( error, PyExc_IOError, "%s: unable to retrieve entry modification time.", function ); libcerror_error_free( &error ); return( NULL ); } else if( result == 0 ) { Py_IncRef( Py_None ); return( Py_None ); } integer_object = pyfsntfs_integer_signed_new_from_64bit( filetime ); return( integer_object ); } /* Retrieves the file attribute flags * Returns a Python object if successful or NULL on error */ PyObject *pyfsntfs_file_name_attribute_get_file_attribute_flags( pyfsntfs_attribute_t *pyfsntfs_attribute, PyObject *arguments PYFSNTFS_ATTRIBUTE_UNUSED ) { libcerror_error_t *error = NULL; PyObject *integer_object = NULL; static char *function = "pyfsntfs_file_name_attribute_get_file_attribute_flags"; uint32_t file_attribute_flags = 0; int result = 0; PYFSNTFS_UNREFERENCED_PARAMETER( arguments ) if( pyfsntfs_attribute == NULL ) { PyErr_Format( PyExc_TypeError, "%s: invalid attribute.", function ); return( NULL ); } Py_BEGIN_ALLOW_THREADS result = libfsntfs_file_name_attribute_get_file_attribute_flags( pyfsntfs_attribute->attribute, &file_attribute_flags, &error ); Py_END_ALLOW_THREADS if( result != 1 ) { pyfsntfs_error_raise( error, PyExc_IOError, "%s: unable to retrieve file attribute flags.", function ); libcerror_error_free( &error ); return( NULL ); } integer_object = pyfsntfs_integer_unsigned_new_from_64bit( (uint64_t) file_attribute_flags ); return( integer_object ); } /* Retrieves the name * Returns a Python object if successful or NULL on error */ PyObject *pyfsntfs_file_name_attribute_get_name( pyfsntfs_attribute_t *pyfsntfs_attribute, PyObject *arguments PYFSNTFS_ATTRIBUTE_UNUSED ) { libcerror_error_t *error = NULL; PyObject *string_object = NULL; const char *errors = NULL; uint8_t *name = NULL; static char *function = "pyfsntfs_file_name_attribute_get_name"; size_t name_size = 0; int result = 0; PYFSNTFS_UNREFERENCED_PARAMETER( arguments ) if( pyfsntfs_attribute == NULL ) { PyErr_Format( PyExc_TypeError, "%s: invalid attribute.", function ); return( NULL ); } Py_BEGIN_ALLOW_THREADS result = libfsntfs_file_name_attribute_get_utf8_name_size( pyfsntfs_attribute->attribute, &name_size, &error ); Py_END_ALLOW_THREADS if( result == -1 ) { pyfsntfs_error_raise( error, PyExc_IOError, "%s: unable to retrieve name size.", function ); libcerror_error_free( &error ); goto on_error; } else if( ( result == 0 ) || ( name_size == 0 ) ) { Py_IncRef( Py_None ); return( Py_None ); } name = (uint8_t *) PyMem_Malloc( sizeof( uint8_t ) * name_size ); if( name == NULL ) { PyErr_Format( PyExc_IOError, "%s: unable to create name.", function ); goto on_error; } Py_BEGIN_ALLOW_THREADS result = libfsntfs_file_name_attribute_get_utf8_name( pyfsntfs_attribute->attribute, name, name_size, &error ); Py_END_ALLOW_THREADS if( result != 1 ) { pyfsntfs_error_raise( error, PyExc_IOError, "%s: unable to retrieve name.", function ); libcerror_error_free( &error ); goto on_error; } /* Pass the string length to PyUnicode_DecodeUTF8 * otherwise it makes the end of string character is part * of the string */ string_object = PyUnicode_DecodeUTF8( (char *) name, (Py_ssize_t) name_size - 1, errors ); PyMem_Free( name ); return( string_object ); on_error: if( name != NULL ) { PyMem_Free( name ); } return( NULL ); }