1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
|
/*
** The Sleuth Kit
**
** Brian Carrier [carrier <at> sleuthkit [dot] org]
** Copyright (c) 2010-2013 Brian Carrier. All Rights reserved
**
** This software is distributed under the Common Public License 1.0
**
*/
/**
* \file auto.cpp
* Contains C++ code that creates the base file extraction automation class.
*/
#include "tsk_auto_i.h"
#include "tsk/fs/tsk_fatxxfs.h"
#include "tsk/img/img_writer.h"
// @@@ Follow through some error paths for sanity check and update docs somewhere to reflect the new scheme
TskAuto::TskAuto()
{
m_img_info = NULL;
m_tag = TSK_AUTO_TAG;
m_volFilterFlags = (TSK_VS_PART_FLAG_ENUM)(TSK_VS_PART_FLAG_ALLOC | TSK_VS_PART_FLAG_UNALLOC);
m_fileFilterFlags = TSK_FS_DIR_WALK_FLAG_RECURSE;
m_stopAllProcessing = false;
m_internalOpen = false;
m_curVsPartValid = false;
m_curVsPartDescr = "";
m_imageWriterEnabled = false;
m_imageWriterPath = NULL;
}
TskAuto::~TskAuto()
{
closeImage();
m_exteralFsInfoList.clear(); // Don't close the file systems that were passed in
m_tag = 0;
}
void TskAuto::setCurVsPart(const TSK_VS_PART_INFO *partInfo) {
if (partInfo->desc)
m_curVsPartDescr = partInfo->desc;
else
m_curVsPartDescr = "";
m_curVsPartFlag = partInfo->flags;
m_curVsPartValid = true;
}
std::string TskAuto::getCurVsPartDescr() const {
return m_curVsPartDescr;
}
TSK_VS_PART_FLAG_ENUM TskAuto::getCurVsPartFlag() const {
return m_curVsPartFlag;
}
bool TskAuto::isCurVsValid() const {
return m_curVsPartValid;
}
/**
* Opens the disk image to be analyzed. This must be called before any
* of the findFilesInXXX() methods.
*
* @param a_numImg The number of images to open (will be > 1 for split images).
* @param a_images The path to the image files (the number of files must
* be equal to num_img and they must be in a sorted order)
* @param a_imgType The disk image type (can be autodetection)
* @param a_sSize Size of device sector in bytes (or 0 for default)
* @returns 1 on error (messages were NOT registered), 0 on success
*/
uint8_t
TskAuto::openImage(int a_numImg, const TSK_TCHAR * const a_images[],
TSK_IMG_TYPE_ENUM a_imgType, unsigned int a_sSize)
{
resetErrorList();
if (m_img_info)
closeImage();
m_internalOpen = true;
m_img_info = tsk_img_open(a_numImg, a_images, a_imgType, a_sSize);
if (m_img_info)
return 0;
else
return 1;
}
/**
* Opens the disk image to be analyzed. This must be called before any
* of the findFilesInXXX() methods. Always uses the utf8 tsk_img_open
* even in windows.
*
* @param a_numImg The number of images to open (will be > 1 for split images).
* @param a_images The path to the image files (the number of files must
* be equal to num_img and they must be in a sorted order)
* @param a_imgType The disk image type (can be autodetection)
* @param a_sSize Size of device sector in bytes (or 0 for default)
* @returns 1 on error (messages were NOT registered), 0 on success
*/
uint8_t
TskAuto::openImageUtf8(int a_numImg, const char *const a_images[],
TSK_IMG_TYPE_ENUM a_imgType, unsigned int a_sSize)
{
resetErrorList();
if (m_img_info)
closeImage();
m_internalOpen = true;
m_img_info = tsk_img_open_utf8(a_numImg, a_images, a_imgType, a_sSize);
if (m_img_info) {
return 0;
}
else
return 1;
}
/**
* Uses the already opened image for future analysis. This must be called before any
* of the findFilesInXXX() methods. Note that the TSK_IMG_INFO will not
* be freed when the TskAuto class is closed.
* @param a_img_info Handle to an already opened disk image.
* @returns 1 on error (messages were NOT registered) and 0 on success
*/
uint8_t TskAuto::openImageHandle(TSK_IMG_INFO * a_img_info)
{
resetErrorList();
if (m_img_info)
closeImage();
m_internalOpen = false;
m_img_info = a_img_info;
return 0;
}
/**
* Closes the handles to the open disk image. Should be called after
* you have completed analysis of the image.
*/
void
TskAuto::closeImage()
{
for (size_t i = 0; i < m_poolInfos.size(); i++) {
tsk_pool_close(m_poolInfos[i]);
}
m_poolInfos.clear();
if ((m_img_info) && (m_internalOpen)) {
tsk_img_close(m_img_info);
}
m_img_info = NULL;
}
/**
* Set the attributes for the volumes that should be processed.
* The default settings are for Allocated Non-Meta volumes only.
* This must be called before the findFilesInXX() method.
* @param vs_flags Flags to use for filtering
*/
void
TskAuto::setVolFilterFlags(TSK_VS_PART_FLAG_ENUM vs_flags)
{
m_volFilterFlags = vs_flags;
}
/**
* Set the attributes for the files that should be processed.
* The default settings are for all files (allocated and deleted).
* This must be called before the findFilesInXX() method.
* @param file_flags Flags to use for filtering
*/
void
TskAuto::setFileFilterFlags(TSK_FS_DIR_WALK_FLAG_ENUM file_flags)
{
m_fileFilterFlags = file_flags;
}
/**
* Store a list of pointers to open file systems to use when calling findFilesInImg
* instead of opening a new copy.
*/
void
TskAuto::setExternalFileSystemList(const std::list<TSK_FS_INFO *>& fsInfoList)
{
m_exteralFsInfoList.resize(fsInfoList.size());
m_exteralFsInfoList.assign(fsInfoList.begin(), fsInfoList.end());
}
/**
* @return The size of the image in bytes or -1 if the
* image is not open.
*/
TSK_OFF_T TskAuto::getImageSize() const
{
if (m_img_info == NULL)
return -1;
return m_img_info->size;
}
TSK_FILTER_ENUM
TskAuto::filterVs(const TSK_VS_INFO * /*vs_info*/)
{
return TSK_FILTER_CONT;
}
TSK_FILTER_ENUM
TskAuto::filterVol(const TSK_VS_PART_INFO * /*vs_part*/)
{
return TSK_FILTER_CONT;
}
TSK_FILTER_ENUM
TskAuto::filterPoolVol(const TSK_POOL_VOLUME_INFO * /*pool_vol*/)
{
/* Most of our tools can't handle pool volumes yet */
if (tsk_verbose)
fprintf(stderr, "filterPoolVol: Pool handling is not yet implemented for this tool\n");
return TSK_FILTER_SKIP;
}
TSK_FILTER_ENUM
TskAuto::filterPool(const TSK_POOL_INFO * /*pool_info*/) {
/* Most of our tools can't handle pool volumes yet */
if (tsk_verbose)
fprintf(stderr, "filterPool: Pool handling is not yet implemented for this tool\n");
return TSK_FILTER_SKIP;
}
TSK_FILTER_ENUM
TskAuto::filterFs(TSK_FS_INFO * /*fs_info*/)
{
return TSK_FILTER_CONT;
}
/**
* Starts in sector 0 of the opened disk images and looks for a
* volume or file system. Will call processFile() on each file
* that is found.
* @return 1 if an error occurred (message will have been registered) and 0 on success
*/
uint8_t
TskAuto::findFilesInImg()
{
if (!m_img_info) {
tsk_error_reset();
tsk_error_set_errno(TSK_ERR_AUTO_NOTOPEN);
tsk_error_set_errstr("findFilesInImg -- img_info");
registerError();
return 1;
}
if (m_img_info->itype == TSK_IMG_TYPE_LOGICAL) {
return findFilesInFs(0, TSK_FS_TYPE_LOGICAL);
}
return findFilesInVs(0);
}
/** \internal
* Volume system walk callback function that will analyze
* each volume to find a file system.
* Does not return ERROR because all errors have been registered
* and returning an error would indicate to TSK that errno and such are set.
*/
TSK_WALK_RET_ENUM
TskAuto::vsWalkCb(TSK_VS_INFO * /*a_vs_info*/,
const TSK_VS_PART_INFO * a_vs_part, void *a_ptr)
{
TskAuto *tsk = (TskAuto *) a_ptr;
if (tsk->m_tag != TSK_AUTO_TAG) {
// we have no way to register an error...
return TSK_WALK_STOP;
}
//save the current volume description
tsk->setCurVsPart(a_vs_part);
// see if the super class wants to continue with this.
TSK_FILTER_ENUM retval1 = tsk->filterVol(a_vs_part);
if (retval1 == TSK_FILTER_SKIP)
return TSK_WALK_CONT;
else if ((retval1 == TSK_FILTER_STOP) || (tsk->getStopProcessing()))
return TSK_WALK_STOP;
// process it
if (tsk->hasPool(a_vs_part->start * a_vs_part->vs->block_size)) {
if (TSK_STOP == tsk->findFilesInPool(a_vs_part->start * a_vs_part->vs->block_size)
|| tsk->getStopProcessing()) {
return TSK_WALK_STOP;
}
}
else {
TSK_RETVAL_ENUM retval2 = tsk->findFilesInFsRet(
a_vs_part->start * a_vs_part->vs->block_size, TSK_FS_TYPE_DETECT);
if ((retval2 == TSK_STOP) || (tsk->getStopProcessing())) {
return TSK_WALK_STOP;
}
}
//all errors would have been registered
return TSK_WALK_CONT;
}
/**
* Starts in a specified byte offset of the opened disk images and looks for a
* volume system or file system. Will call processFile() on each file
* that is found.
* @param a_start Byte offset to start analyzing from.
* @param a_vtype Volume system type to analyze
* @return 1 if an error occurred (messages will have been registered) and 0 on success
*/
uint8_t
TskAuto::findFilesInVs(TSK_OFF_T a_start, TSK_VS_TYPE_ENUM a_vtype)
{
if (!m_img_info) {
tsk_error_reset();
tsk_error_set_errno(TSK_ERR_AUTO_NOTOPEN);
tsk_error_set_errstr("findFilesInVs -- img_info");
registerError();
return 1;
}
TSK_VS_INFO *vs_info;
// Use mm_walk to get the volumes
if ((vs_info = tsk_vs_open(m_img_info, a_start, a_vtype)) == NULL) {
/* If the error code is for encryption, we will register it.
* If the error code is for multiple volume systems found, register the error
* and return without trying to load a file system. Otherwise,
* ignore this error to avoid confusion if the fs_open passes. */
if (tsk_error_get_errno() == TSK_ERR_VS_ENCRYPTED) {
registerError();
}
else if (tsk_error_get_errno() == TSK_ERR_VS_MULTTYPE) {
registerError();
return 1;
}
tsk_error_reset();
if(tsk_verbose)
fprintf(stderr, "findFilesInVs: Error opening volume system, trying as a file system\n");
/* There was no volume system, but there could be a file system
* Errors will have been registered */
if (hasPool(a_start)) {
findFilesInPool(a_start);
}
else {
findFilesInFs(a_start);
}
}
// process the volume system
else {
TSK_FILTER_ENUM retval = filterVs(vs_info);
if ((retval == TSK_FILTER_STOP) || (retval == TSK_FILTER_SKIP)|| (m_stopAllProcessing))
return m_errors.empty() ? 0 : 1;
/* Walk the allocated volumes (skip metadata and unallocated volumes) */
if (tsk_vs_part_walk(vs_info, 0, vs_info->part_count - 1,
m_volFilterFlags, vsWalkCb, this)) {
registerError();
tsk_vs_close(vs_info);
return 1;
}
tsk_vs_close(vs_info);
}
return m_errors.empty() ? 0 : 1;
}
/**
* Starts in a specified byte offset of the opened disk images and looks for a
* volume system or file system. Will call processFile() on each file
* that is found.
* @param a_start Byte offset to start analyzing from.
* @return 1 if an error occurred (message will have been registered), 0 on success
*/
uint8_t
TskAuto::findFilesInVs(TSK_OFF_T a_start)
{
return findFilesInVs(a_start, TSK_VS_TYPE_DETECT);
}
/**
* Checks whether a volume contains a pool.
* @param a_start Byte offset to start analyzing from.
* @return true if a pool is found, false if not or on error
*/
bool
TskAuto::hasPool(TSK_OFF_T a_start)
{
if (!m_img_info) {
tsk_error_reset();
tsk_error_set_errno(TSK_ERR_AUTO_NOTOPEN);
tsk_error_set_errstr("hasPool -- img_info");
registerError();
return false;
}
const auto pool = tsk_pool_open_img_sing(m_img_info, a_start, TSK_POOL_TYPE_DETECT);
if (pool == nullptr) {
return false;
}
tsk_pool_close(pool);
return true;
}
/**
* Starts in a specified byte offset of the opened disk images and opens a pool
* to search though any file systems in the pool. Will call processFile() on each file
* that is found.
* @param start Byte offset to start analyzing from.
* @return 1 if an error occurred (message will have been registered), 0 on success
*/
uint8_t
TskAuto::findFilesInPool(TSK_OFF_T start)
{
return findFilesInPool(start, TSK_POOL_TYPE_DETECT);
}
/**
* Starts in a specified byte offset of the opened disk images and opens a pool
* to search though any file systems in the pool. Will call processFile() on each file
* that is found.
* @param start Byte offset to start analyzing from.
* @param ptype The type of pool
* @return 1 if an error occurred (message will have been registered), 0 on success
*/
uint8_t
TskAuto::findFilesInPool(TSK_OFF_T start, TSK_POOL_TYPE_ENUM ptype)
{
if (!m_img_info) {
tsk_error_reset();
tsk_error_set_errno(TSK_ERR_AUTO_NOTOPEN);
tsk_error_set_errstr("findFilesInPool -- img_info");
registerError();
return TSK_ERR;
}
const auto pool = tsk_pool_open_img_sing(m_img_info, start, ptype);
if (pool == nullptr) {
tsk_error_set_errstr2(
"findFilesInPool: Error opening pool");
registerError();
return TSK_ERR;
}
// see if the super class wants to continue with this.
TSK_FILTER_ENUM retval1 = filterPool(pool);
if (retval1 == TSK_FILTER_SKIP)
return TSK_OK;
else if (retval1 == TSK_FILTER_STOP)
return TSK_STOP;
/* Only APFS pools are currently supported */
if (pool->ctype == TSK_POOL_TYPE_APFS) {
TSK_POOL_VOLUME_INFO *vol_info = pool->vol_list;
while (vol_info != NULL) {
TSK_FILTER_ENUM filterRetval = filterPoolVol(vol_info);
if ((filterRetval == TSK_FILTER_STOP) || (m_stopAllProcessing)) {
tsk_pool_close(pool);
return TSK_STOP;
}
if (filterRetval != TSK_FILTER_SKIP) {
TSK_IMG_INFO *pool_img = pool->get_img_info(pool, vol_info->block);
if (pool_img != NULL) {
TSK_FS_INFO *fs_info = apfs_open(pool_img, 0, TSK_FS_TYPE_APFS, "");
if (fs_info) {
TSK_RETVAL_ENUM retval = findFilesInFsInt(fs_info, fs_info->root_inum);
tsk_fs_close(fs_info);
if (retval == TSK_STOP) {
tsk_img_close(pool_img);
tsk_pool_close(pool);
return TSK_STOP;
}
}
else {
if (vol_info->flags & TSK_POOL_VOLUME_FLAG_ENCRYPTED) {
tsk_error_reset();
tsk_error_set_errno(TSK_ERR_FS_ENCRYPTED);
tsk_error_set_errstr(
"Encrypted APFS file system");
tsk_error_set_errstr2("Block: %" PRIdOFF, vol_info->block);
registerError();
}
else {
tsk_error_set_errstr2(
"findFilesInPool: Error opening APFS file system");
registerError();
}
}
tsk_img_close(pool_img);
}
else {
tsk_pool_close(pool);
tsk_error_set_errstr2(
"findFilesInPool: Error opening APFS pool");
registerError();
return TSK_ERR;
}
}
vol_info = vol_info->next;
}
}
else {
tsk_pool_close(pool);
tsk_error_reset();
tsk_error_set_errno(TSK_ERR_POOL_UNSUPTYPE);
tsk_error_set_errstr("%d", pool->ctype);
registerError();
return TSK_ERR;
}
// Store the pool_info for later use. It will be closed at the end of the add image process.
m_poolInfos.push_back(pool);
return TSK_OK;
}
/**
* Starts in a specified byte offset of the opened disk images and looks for a
* file system. Will call processFile() on each file
* that is found. Same as findFilesInFs, but gives more detailed return values.
* @param a_start Byte offset to start analyzing from.
* @param a_ftype File system type.
* @returns Error (messages will have been registered), OK, or STOP.
*/
TSK_RETVAL_ENUM
TskAuto::findFilesInFsRet(TSK_OFF_T a_start, TSK_FS_TYPE_ENUM a_ftype)
{
if (!m_img_info) {
tsk_error_reset();
tsk_error_set_errno(TSK_ERR_AUTO_NOTOPEN);
tsk_error_set_errstr("findFilesInFsRet -- img_info");
registerError();
return TSK_ERR;
}
// If we already have an open copy of this file system, use it
for (auto itr = m_exteralFsInfoList.begin(); itr != m_exteralFsInfoList.end(); itr++) {
if ((*itr)->offset == a_start) {
TSK_FS_INFO *fs_info = *itr;
TSK_RETVAL_ENUM retval = findFilesInFsInt(fs_info, fs_info->root_inum);
if (m_errors.empty() == false)
return TSK_ERR;
else
return retval;
}
}
TSK_FS_INFO *fs_info;
if ((fs_info = tsk_fs_open_img(m_img_info, a_start, a_ftype)) == NULL) {
if (isCurVsValid() == false) {
tsk_error_set_errstr2 ("Sector offset: %" PRIdOFF, a_start/512);
registerError();
return TSK_ERR;
}
else if (getCurVsPartFlag() & TSK_VS_PART_FLAG_ALLOC) {
tsk_error_set_errstr2 (
"Sector offset: %" PRIdOFF ", Partition Type: %s",
a_start/512, getCurVsPartDescr().c_str()
);
registerError();
return TSK_ERR;
}
else {
tsk_error_reset();
return TSK_OK;
}
}
TSK_RETVAL_ENUM retval = findFilesInFsInt(fs_info, fs_info->root_inum);
tsk_fs_close(fs_info);
if (m_errors.empty() == false)
return TSK_ERR;
else
return retval;
}
/**
* Starts in a specified byte offset of the opened disk images and looks for a
* file system. Will call processFile() on each file
* that is found.
*
* @param a_start Byte offset of file system starting location.
*
* @returns 1 if an error occurred (messages will have been registered) and 0 on success
*/
uint8_t
TskAuto::findFilesInFs(TSK_OFF_T a_start)
{
return findFilesInFs(a_start, TSK_FS_TYPE_DETECT);
}
/**
* Starts in a specified byte offset of the opened disk images and looks for a
* file system. Will call processFile() on each file
* that is found.
*
* @param a_start Byte offset of file system starting location.
* @param a_ftype Type of file system that is located at the offset.
*
* @returns 1 if an error occurred (messages will have been registered) and 0 on success
*/
uint8_t
TskAuto::findFilesInFs(TSK_OFF_T a_start, TSK_FS_TYPE_ENUM a_ftype)
{
findFilesInFsRet(a_start, a_ftype);
return m_errors.empty() ? 0 : 1;
}
/**
* Starts in a specified byte offset of the opened disk images and looks for a
* file system. Will start processing the file system at a specified
* file system. Will call processFile() on each file
* that is found in that directory.
*
* @param a_start Byte offset of file system starting location.
* @param a_ftype Type of file system that will be analyzed.
* @param a_inum inum to start walking files system at.
*
* @returns 1 if an error occurred (messages will have been registered) and 0 on success
*/
uint8_t
TskAuto::findFilesInFs(TSK_OFF_T a_start, TSK_FS_TYPE_ENUM a_ftype,
TSK_INUM_T a_inum)
{
if (!m_img_info) {
tsk_error_reset();
tsk_error_set_errno(TSK_ERR_AUTO_NOTOPEN);
tsk_error_set_errstr("findFilesInFs -- img_info ");
registerError();
return 1;
}
// If we already have an open copy of this file system, use it
for (auto itr = m_exteralFsInfoList.begin(); itr != m_exteralFsInfoList.end(); itr++) {
if ((*itr)->offset == a_start) {
TSK_FS_INFO *fs_info = *itr;
TSK_RETVAL_ENUM retval = findFilesInFsInt(fs_info, fs_info->root_inum);
if (m_errors.empty() == false)
return TSK_ERR;
else
return retval;
}
}
TSK_FS_INFO *fs_info;
if ((fs_info = tsk_fs_open_img(m_img_info, a_start, a_ftype)) == NULL) {
if (isCurVsValid() == false) {
tsk_error_set_errstr2 ("Sector offset: %" PRIdOFF, a_start/512);
registerError();
return TSK_ERR;
}
else if (getCurVsPartFlag() & TSK_VS_PART_FLAG_ALLOC) {
tsk_error_set_errstr2(
"Sector offset: %" PRIdOFF ", Partition Type: %s",
a_start / 512, getCurVsPartDescr().c_str());
registerError();
return 1;
}
else {
tsk_error_reset();
return 0;
}
}
findFilesInFsInt(fs_info, a_inum);
tsk_fs_close(fs_info);
return m_errors.empty() ? 0 : 1;
}
/**
* Starts in a specified byte offset of the opened disk images and looks for a
* file system. Will start processing the file system at a specified
* file system. Will call processFile() on each file
* that is found in that directory.
*
* @param a_start Byte offset of file system starting location.
* @param a_inum inum to start walking files system at.
*
* @returns 1 if an error occurred (messages will have been registered) and 0 on success
*/
uint8_t
TskAuto::findFilesInFs(TSK_OFF_T a_start, TSK_INUM_T a_inum)
{
return TskAuto::findFilesInFs(a_start, TSK_FS_TYPE_DETECT, a_inum);
}
/**
* Processes the file system represented by the given TSK_FS_INFO
* pointer. Will Call processFile() on each file that is found.
*
* @param a_fs_info Pointer to a previously opened file system.
*
* @returns 1 if an error occurred (messages will have been registered) and 0 on success
*/
uint8_t
TskAuto::findFilesInFs(TSK_FS_INFO * a_fs_info)
{
if (a_fs_info == NULL) {
tsk_error_reset();
tsk_error_set_errno(TSK_ERR_AUTO_NOTOPEN);
tsk_error_set_errstr("findFilesInFs - fs_info");
registerError();
return 1;
}
findFilesInFsInt(a_fs_info, a_fs_info->root_inum);
return m_errors.empty() ? 0 : 1;
}
/**
* Processes the file system represented by the given TSK_FS_INFO
* pointer. Will Call processFile() on each file that is found.
*
* @param a_fs_info Pointer to a previously opened file system.
* @param a_inum inum to start walking files system at.
*
* @returns 1 if an error occurred (messages will have been registered) and 0 on success
*/
uint8_t
TskAuto::findFilesInFs(TSK_FS_INFO * a_fs_info, TSK_INUM_T inum)
{
if (a_fs_info == NULL) {
tsk_error_reset();
tsk_error_set_errno(TSK_ERR_AUTO_NOTOPEN);
tsk_error_set_errstr("findFilesInFs - fs_info");
registerError();
return 1;
}
findFilesInFsInt(a_fs_info, inum);
return m_errors.empty() ? 0 : 1;
}
/** \internal
* file name walk callback. Walk the contents of each file
* that is found.
*
* Does not return ERROR because all errors have been registered
* and returning an error would indicate to TSK that errno and such are set.
*/
TSK_WALK_RET_ENUM
TskAuto::dirWalkCb(TSK_FS_FILE * a_fs_file, const char *a_path,
void *a_ptr)
{
TskAuto *tsk = (TskAuto *) a_ptr;
if (tsk->m_tag != TSK_AUTO_TAG) {
// we have no way to register an error...
return TSK_WALK_STOP;
}
TSK_RETVAL_ENUM retval = tsk->processFile(a_fs_file, a_path);
if ((retval == TSK_STOP) || (tsk->getStopProcessing()))
return TSK_WALK_STOP;
else
return TSK_WALK_CONT;
}
/** \internal
* Internal method that the other findFilesInFs can call after they
* have opened FS_INFO.
* @returns OK, STOP, or ERR (error message will already have been registered)
*/
TSK_RETVAL_ENUM
TskAuto::findFilesInFsInt(TSK_FS_INFO * a_fs_info, TSK_INUM_T a_inum)
{
// see if the super class wants us to proceed
TSK_FILTER_ENUM retval = filterFs(a_fs_info);
if ((retval == TSK_FILTER_STOP) || (m_stopAllProcessing))
return TSK_STOP;
else if (retval == TSK_FILTER_SKIP)
return TSK_OK;
/* Walk the files, starting at the given inum */
if (tsk_fs_dir_walk(a_fs_info, a_inum,
(TSK_FS_DIR_WALK_FLAG_ENUM) (TSK_FS_DIR_WALK_FLAG_RECURSE |
m_fileFilterFlags), dirWalkCb, this)) {
tsk_error_set_errstr2(
"Error walking directory in file system at offset %" PRIdOFF, a_fs_info->offset);
registerError();
return TSK_ERR;
}
if (m_stopAllProcessing)
return TSK_STOP;
/* We could do some analysis of unallocated blocks at this point... */
return TSK_OK;
}
/**
* Method that can be used from within processFile() to look at each
* attribute that a file may have. This will call the processAttribute()
* method (which you must implement) on each of the attributes in the file.
* @param fs_file file details
* @param path full path of parent directory
* @returns STOP if the file system processing should stop and not process more files or OK.
*/
TSK_RETVAL_ENUM
TskAuto::processAttributes(TSK_FS_FILE * fs_file, const char *path)
{
int
count = tsk_fs_file_attr_getsize(fs_file), i;
for (i = 0; i < count; i++) {
TSK_RETVAL_ENUM retval =
processAttribute(fs_file, tsk_fs_file_attr_get_idx(fs_file, i),
path);
if ((retval == TSK_STOP) || (m_stopAllProcessing))
return TSK_STOP;
}
return TSK_OK;
}
TSK_RETVAL_ENUM
TskAuto::processAttribute(TSK_FS_FILE * /*fs_file*/,
const TSK_FS_ATTR * /*fs_attr*/,
const char * /*path*/)
{
return TSK_OK;
}
void TskAuto::setStopProcessing() {
m_stopAllProcessing = true;
}
bool TskAuto::getStopProcessing() const {
return m_stopAllProcessing;
}
TSK_RETVAL_ENUM
TskAuto::enableImageWriter(const char * imagePath) {
#ifdef TSK_WIN32
m_imageWriterEnabled = false;
size_t ilen;
UTF16 *utf16;
UTF8 *utf8;
TSKConversionResult retval2;
// we allocate the buffer with the same number of chars as the UTF-8 length
ilen = strlen(imagePath);
if ((m_imageWriterPath =
(wchar_t *)tsk_malloc((ilen + 1) * sizeof(wchar_t))) == NULL) {
free(m_imageWriterPath);
return TSK_ERR;
}
utf8 = (UTF8 *)imagePath;
utf16 = (UTF16 *)m_imageWriterPath;
retval2 =
tsk_UTF8toUTF16((const UTF8 **)&utf8, &utf8[ilen],
&utf16, &utf16[ilen], TSKlenientConversion);
if (retval2 != TSKconversionOK) {
tsk_error_set_errno(TSK_ERR_IMG_CONVERT);
tsk_error_set_errstr
("enableImageWriter: Error converting output path %s %d",
imagePath, retval2);
free(m_imageWriterPath);
return TSK_ERR;
}
*utf16 = '\0';
// At this point the path conversion was successful, so image writer is ready to go
m_imageWriterEnabled = true;
#else
m_imageWriterEnabled = false;
#endif
return TSK_OK;
}
void
TskAuto::disableImageWriter() {
m_imageWriterEnabled = false;
}
uint8_t TskAuto::registerError() {
// add to our list of errors
error_record er;
er.code = tsk_error_get_errno();
er.msg1 = tsk_error_get_errstr();
er.msg2 = tsk_error_get_errstr2();
m_errors.push_back(er);
// call super class implementation
uint8_t retval = handleError();
tsk_error_reset();
return retval;
}
const std::vector<TskAuto::error_record> TskAuto::getErrorList() {
return m_errors;
}
void TskAuto::resetErrorList() {
m_errors.clear();
}
std::string TskAuto::errorRecordToString(error_record &rec) {
tsk_error_reset();
tsk_error_set_errno(rec.code);
tsk_error_set_errstr("%s", rec.msg1.c_str());
tsk_error_set_errstr2("%s", rec.msg2.c_str());
const char *msg = tsk_error_get();
std::string ret;
if (msg != NULL)
ret = msg;
tsk_error_reset();
return ret;
}
uint8_t
TskAuto::handleError() {
return 0;
}
/**
* Utility method to help determine if a file is an NTFS file system file (such as $MFT).
*
* @returns 1 if the file is an NTFS System file, 0 if not.
*/
uint8_t
TskAuto::isNtfsSystemFiles(TSK_FS_FILE * a_fs_file, const char * /*a_path*/)
{
if ((a_fs_file) && (a_fs_file->fs_info)
&& (TSK_FS_TYPE_ISNTFS(a_fs_file->fs_info->ftype))
&& (a_fs_file->name) && (a_fs_file->name->name[0] == '$')
&& (a_fs_file->name->meta_addr < 20))
return 1;
else
return 0;
}
/**
* Utility method to help determine if a file is a FAT file system file (such as $MBR).
*
* @returns 1 if the file is an FAT System file, 0 if not.
*/
uint8_t
TskAuto::isFATSystemFiles(TSK_FS_FILE *a_fs_file)
{
if (a_fs_file && a_fs_file->fs_info && a_fs_file->name
&& TSK_FS_TYPE_ISFAT(a_fs_file->fs_info->ftype)) {
FATFS_INFO *fatfs = (FATFS_INFO*)a_fs_file->fs_info;
TSK_INUM_T addr = a_fs_file->name->meta_addr;
if ((addr == fatfs->mbr_virt_inum) ||
(addr == fatfs->fat1_virt_inum) ||
(addr == fatfs->fat2_virt_inum && fatfs->numfat == 2)) {
return 1;
}
}
return 0;
}
/**
* Utility method to help determine if a file is a . or .. directory.
* @param a_fs_file File to evaluate
*
* @returns 1 if the file is a dot directory, 0 if not.
*/
uint8_t
TskAuto::isDotDir(TSK_FS_FILE * a_fs_file)
{
if ((!a_fs_file) || (!a_fs_file->name)
|| (a_fs_file->name->type != TSK_FS_NAME_TYPE_DIR))
return 0;
if ((a_fs_file->name->name_size >= 2)
&& (a_fs_file->name->name[0] == '.')
&& ((a_fs_file->name->name[1] == '\0')
|| ((a_fs_file->name->name_size > 2)
&& (a_fs_file->name->name[1] == '.')
&& (a_fs_file->name->name[2] == '\0'))))
return 1;
else
return 0;
}
/**
* Utility method to help determine if a file is a directory.
*
* @returns 1 if the file is a directory, 0 if not.
*/
uint8_t
TskAuto::isDir(TSK_FS_FILE * a_fs_file)
{
if ((a_fs_file) && (a_fs_file->name)) {
if (TSK_FS_IS_DIR_NAME(a_fs_file->name->type)){
return 1;
}
else if (a_fs_file->name->type == TSK_FS_NAME_TYPE_UNDEF) {
if ((a_fs_file->meta)
&& (TSK_FS_IS_DIR_META(a_fs_file->meta->type))){
return 1;
}
}
}
return 0;
}
/**
* Utility method to help determine if a file is a file (and not a directory).
*
* @returns 1 if the file is a file, 0 if not.
*/
uint8_t
TskAuto::isFile(TSK_FS_FILE * a_fs_file)
{
if ((a_fs_file) && (a_fs_file->name)) {
if (a_fs_file->name->type == TSK_FS_NAME_TYPE_REG) {
return 1;
}
else if (a_fs_file->name->type == TSK_FS_NAME_TYPE_UNDEF) {
if ((a_fs_file->meta)
&& (a_fs_file->meta->type == TSK_FS_META_TYPE_REG)) {
return 1;
}
}
}
return 0;
}
/**
* Utility method to help determine if an attribute is the default type for the file/dir.
*
* @returns 1 if the attribute is a default type, 0 if not.
*/
uint8_t
TskAuto::isDefaultType(TSK_FS_FILE * a_fs_file,
const TSK_FS_ATTR * a_fs_attr)
{
if ((a_fs_file) && (a_fs_file->fs_info)
&& (a_fs_file->fs_info->get_default_attr_type(a_fs_file) ==
a_fs_attr->type))
return 1;
else
return 0;
}
/**
* Utility method to help determine if an attribute is non-resident (meaning it uses blocks to store data)
*
* @returns 1 if the attribute is non-resident, 0 if not.
*/
uint8_t
TskAuto::isNonResident(const TSK_FS_ATTR * a_fs_attr)
{
if ((a_fs_attr) && (a_fs_attr->flags & TSK_FS_ATTR_NONRES))
return 1;
else
return 0;
}
|