source: branches/eraser6/Manager/FileSystem.cs @ 1032

/* 
 * $Id$
 * Copyright 2008 The Eraser Project
 * Original Author: Joel Low <lowjoel@users.sourceforge.net>
 * Modified By: Kasra Nassiri <cjax@users.sourceforge.net> @17/10/2008
 * Modified By: 
 * 
 * This file is part of Eraser.
 * 
 * Eraser 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 3 of the License, or (at your option) any later
 * version.
 * 
 * Eraser 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.
 * 
 * A copy of the GNU General Public License can be found at
 * <http://www.gnu.org/licenses/>.
 */

using System;
using System.Collections.Generic;
using System.Text;
using Eraser.Util;
using System.IO;
using System.Threading;

namespace Eraser.Manager
{
    /// <summary>
    /// Provides functions to handle erasures specfic to file systems.
    /// </summary>
    public abstract class FileSystem
    {
        /// <summary>
        /// Gets the FileSystem object that implements the FileSystem interface
        /// for the given file system.
        /// </summary>
        /// <param name="volume">The volume to get the FileSystem provider for.</param>
        /// <returns>The FileSystem object providing interfaces to handle the
        /// given volume.</returns>
        /// <exception cref="NotSupportedException">Thrown when an unimplemented
        /// file system is requested.</exception>
        public static FileSystem Get(VolumeInfo volume)
        {
            switch (volume.VolumeFormat)
            {
                case "FAT":
                case "FAT32":
                    return new FatFileSystem();
                case "NTFS":
                    return new NtfsFileSystem();
            }

            throw new NotSupportedException(S._("The file system on the drive {0} is not " +
                "supported.", volume.IsMounted ? volume.MountPoints[0] : volume.VolumeId));
        }

        /// <summary>
        /// Generates a random file name with the given length.
        /// </summary>
        /// <remarks>The generated file name is guaranteed not to exist.</remarks>
        /// <param name="info">The directory to generate the file name in. This
        /// parameter can be null to indicate merely a random file name</param>
        /// <param name="length">The length of the file name to generate.</param>
        /// <returns>A full path to a file containing random file name.</returns>
        public static string GenerateRandomFileName(DirectoryInfo info, int length)
        {
            //Get a random file name
            Prng prng = PrngManager.GetInstance(ManagerLibrary.Settings.ActivePrng);
            string resultPrefix = info == null ? string.Empty : info.FullName +
                Path.DirectorySeparatorChar;
            byte[] resultAry = new byte[length];
            string result = string.Empty;

            do
            {
                prng.NextBytes(resultAry);

                //Validate the name
                string validFileNameChars = "0123456789abcdefghijklmnopqrstuvwxyz" +
                    "ABCDEFGHIJKLMNOPQRSTUVWXYZ _+=-()[]{}',`~!";
                for (int j = 0, k = resultAry.Length; j < k; ++j)
                    resultAry[j] = (byte)validFileNameChars[
                        (int)resultAry[j] % validFileNameChars.Length];

                result = Encoding.UTF8.GetString(resultAry);
            }
            while (info != null && (Directory.Exists(resultPrefix + result) ||
                System.IO.File.Exists(resultPrefix + result)));
            return resultPrefix + result;
        }

        /// <summary>
        /// Gets a random file from within the provided directory.
        /// </summary>
        /// <param name="info">The directory to get a random file name from.</param>
        /// <returns>A string containing the full path to the file.</returns>
        public static string GetRandomFile(DirectoryInfo info)
        {
            //First retrieve the list of files and folders in the provided directory.
            FileSystemInfo[] entries = null;
            try
            {
                entries = info.GetFileSystemInfos();
            }
            catch (Exception)
            {
                return string.Empty;
            }
            if (entries.Length == 0)
                return string.Empty;

            //Find a random entry.
            Prng prng = PrngManager.GetInstance(ManagerLibrary.Settings.ActivePrng);
            string result = string.Empty;
            while (result.Length == 0)
            {
                int index = prng.Next(entries.Length - 1);
                if (entries[index] is DirectoryInfo)
                    result = GetRandomFile((DirectoryInfo)entries[index]);
                else
                    result = ((FileInfo)entries[index]).FullName;
            }

            return result;
        }

        /// <summary>
        /// Writes a file for plausible deniability over the current stream.
        /// </summary>
        /// <param name="fileStream">The stream to write the data to.</param>
        protected void CopyPlausibleDeniabilityFile(Stream destFileStream)
        {
            //Get the template file to copy
            FileInfo shadowFileInfo;
            {
                string shadowFile = null;
                List<string> entries = ManagerLibrary.Settings.PlausibleDeniabilityFiles.GetRange(
                    0, ManagerLibrary.Settings.PlausibleDeniabilityFiles.Count);
                Prng prng = PrngManager.GetInstance(ManagerLibrary.Settings.ActivePrng);
                do
                {
                    if (entries.Count == 0)
                        throw new FatalException(S._("Plausible deniability was selected, " +
                            "but no decoy files were found. The current file has been only " +
                            "replaced with random data."));

                    int index = prng.Next(entries.Count - 1);
                    if ((System.IO.File.GetAttributes(entries[index]) & FileAttributes.Directory) != 0)
                    {
                        DirectoryInfo dir = new DirectoryInfo(entries[index]);
                        FileInfo[] files = dir.GetFiles("*", SearchOption.AllDirectories);
                        foreach (FileInfo f in files)
                            entries.Add(f.FullName);
                    }
                    else
                        shadowFile = entries[index];

                    entries.RemoveAt(index);
                }
                while (shadowFile == null || shadowFile.Length == 0);
                shadowFileInfo = new FileInfo(shadowFile);
            }

            //Dump the copy (the first 4MB, or less, depending on the file size and available
            //user space)
            long amountToCopy = Math.Min(4 * 1024 * 1024, shadowFileInfo.Length);
            using (FileStream shadowFileStream = shadowFileInfo.OpenRead())
            {
                while (destFileStream.Position < amountToCopy)
                {
                    byte[] buf = new byte[524288];
                    int bytesRead = shadowFileStream.Read(buf, 0, buf.Length);

                    //Stop bothering if the input stream is at the end
                    if (bytesRead == 0)
                        break;

                    //Dump the read contents onto the file to be deleted
                    destFileStream.Write(buf, 0,
                        (int)Math.Min(bytesRead, amountToCopy - destFileStream.Position));
                }
            }
        }

        /// <summary>
        /// Securely deletes the file reference from the directory structures
        /// as well as resetting the Date Created, Date Accessed and Date Modified
        /// records.
        /// </summary>
        /// <param name="info">The file to delete.</param>
        public abstract void DeleteFile(FileInfo info);

        /// <summary>
        /// Securely deletes the folder reference from the directory structures
        /// as well as all subfolders and files, resetting the Date Created, Date
        /// Accessed and Date Modified records.
        /// </summary>
        /// <param name="info">The folder to delete</param>
        public abstract void DeleteFolder(DirectoryInfo info);

        /// <summary>
        /// Erases old file system table-resident files. This creates small one-byte
        /// files until disk is full. This will erase unused space which was used for
        /// files resident in the file system table.
        /// </summary>
        /// <param name="info">The directory information structure containing
        /// the path to store the temporary one-byte files. The file system table
        /// of that drive will be erased.</param>
        /// <param name="method">The method used to erase the files.</param>
        public abstract void EraseOldFileSystemResidentFiles(VolumeInfo info,
            ErasureMethod method, FileSystemEntriesEraseProgress callback);

        /// <summary>
        /// Erases the unused space in the main filesystem structures by creating,
        /// files until the table grows.
        /// 
        /// This will overwrite unused portions of the table which were previously
        /// used to store file entries.
        /// </summary>
        /// <param name="info">The directory information structure containing
        /// the path to store the temporary files.</param>
        /// <param name="callback">The callback function to handle the progress
        /// of the file system entry erasure.</param>
        public abstract void EraseDirectoryStructures(VolumeInfo info,
            FileSystemEntriesEraseProgress callback);

        /// <summary>
        /// The number of times file names are renamed to erase the file name from
        /// the file system table.
        /// </summary>
        public const int FileNameErasePasses = 7;

        /// <summary>
        /// The maximum number of times Eraser tries to erase a file/folder before
        /// it gives up.
        /// </summary>
        public const int FileNameEraseTries = 50;
    }

    /// <summary>
    /// The prototype of callbacks handling the file system table erase progress.
    /// </summary>
    /// <param name="currentFile">The current file being erased.</param>
    /// <param name="totalFiles">The estimated number of files that must be
    /// erased.</param>
    public delegate void FileSystemEntriesEraseProgress(int currentFile, int totalFiles);

    /// <summary>
    /// Base class for all Windows filesystems.
    /// </summary>
    public abstract class WindowsFileSystem : FileSystem
    {
        public override void DeleteFile(FileInfo info)
        {
            //Set the date of the file to be invalid to prevent forensic
            //detection
            info.CreationTime = info.LastWriteTime = info.LastAccessTime = MinTimestamp;
            info.Attributes = FileAttributes.Normal;
            info.Attributes = FileAttributes.NotContentIndexed;

            //Rename the file a few times to erase the entry from the file system
            //table.
            string newPath = GenerateRandomFileName(info.Directory, info.Name.Length);
            for (int i = 0, tries = 0; i < FileNameErasePasses; ++tries)
            {
                //Try to rename the file. If it fails, it is probably due to another
                //process locking the file. Defer, then rename again.
                try
                {
                    info.MoveTo(newPath);
                    ++i;
                }
                catch (IOException)
                {
                    Thread.Sleep(100);

                    //If after FilenameEraseTries the file is still locked, some program is
                    //definitely using the file; throw an exception.
                    if (tries > FileNameEraseTries)
                        throw new IOException(S._("The file {0} is currently in use and " +
                            "cannot be removed.", info.FullName));
                }
            }

            //If the user wants plausible deniability, find a random file on the same
            //volume and write it over.
            if (Manager.ManagerLibrary.Settings.PlausibleDeniability)
            {
                CopyPlausibleDeniabilityFile(info.OpenWrite());
            }

            //Then delete the file.
            for (int i = 0; i < FileNameEraseTries; ++i)
                try
                {
                    info.Delete();
                    break;
                }
                catch (IOException)
                {
                    if (i > FileNameEraseTries)
                        throw new IOException(S._("The file {0} is currently in use and " +
                            "cannot be removed.", info.FullName));
                    Thread.Sleep(100);
                }
        }

        public override void DeleteFolder(DirectoryInfo info)
        {
            //TODO: check for reparse points
            foreach (DirectoryInfo dir in info.GetDirectories())
                DeleteFolder(dir);
            foreach (FileInfo file in info.GetFiles())
                DeleteFile(file);

            //Then clean up this folder.
            for (int i = 0; i < FileNameErasePasses; ++i)
            {
                //Rename the folder.
                string newPath = GenerateRandomFileName(info.Parent, info.Name.Length);

                //Try to rename the file. If it fails, it is probably due to another
                //process locking the file. Defer, then rename again.
                try
                {
                    info.MoveTo(newPath);
                }
                catch (IOException)
                {
                    Thread.Sleep(100);
                    --i;
                }
            }

            //Remove the folder
            info.Delete(true);
        }

        /// <summary>
        /// The minimum timestamp the file system can take. This is for secure file
        /// deletion.
        /// </summary>
        protected abstract DateTime MinTimestamp { get; }
    }

    /// <summary>
    /// Provides functions to handle erasures specific to NTFS volumes.
    /// </summary>
    public class NtfsFileSystem : WindowsFileSystem
    {
        public override void EraseOldFileSystemResidentFiles(VolumeInfo info,
            ErasureMethod method, FileSystemEntriesEraseProgress callback)
        {
            try
            {
                //Squeeze one-byte files until the volume or the MFT is full.
                DirectoryInfo rootDir = new DirectoryInfo(info.MountPoints[0]);
                long oldMFTSize = NtfsApi.GetMftValidSize(info);

                for ( ; ; )
                {
                    //Open this stream
                    using (FileStream strm = new FileStream(GenerateRandomFileName(rootDir, 18),
                        FileMode.CreateNew, FileAccess.Write, FileShare.None, 8,
                        FileOptions.WriteThrough))
                    {
                        //Stretch the file size to use up some of the resident space.
                        strm.SetLength(1);

                        //Then run the erase task
                        method.Erase(strm, long.MaxValue,
                            PrngManager.GetInstance(ManagerLibrary.Settings.ActivePrng),
                            null);
                    }

                    //We can stop when the MFT has grown.
                    if (NtfsApi.GetMftValidSize(info) > oldMFTSize)
                        break;
                }
            }
            catch (IOException)
            {
                //OK, enough squeezing.
            }
        }

        public override void EraseDirectoryStructures(VolumeInfo info,
            FileSystemEntriesEraseProgress callback)
        {
            //Create a directory to hold all the temporary files
            DirectoryInfo tempDir = new DirectoryInfo(info.MountPoints[0]);
            tempDir = new DirectoryInfo(FileSystem.GenerateRandomFileName(tempDir, 32));
            tempDir.Create();

            try
            {
                //Get the size of the MFT
                long mftSize = NtfsApi.GetMftValidSize(info);
                long mftRecordSegmentSize = NtfsApi.GetMftRecordSegmentSize(info);
                int pollingInterval = (int)Math.Max(1, (mftSize / info.ClusterSize / 20));
                int totalFiles = (int)Math.Max(1L, mftSize / mftRecordSegmentSize) *
                    (FileNameErasePasses + 1);
                int filesCreated = 0;

                while (true)
                {
                    ++filesCreated;
                    using (FileStream strm = new FileStream(FileSystem.GenerateRandomFileName(
                        tempDir, 220), FileMode.CreateNew, FileAccess.Write))
                    {
                    }

                    if (filesCreated % pollingInterval == 0)
                    {
                        if (callback != null)
                            callback(filesCreated, totalFiles);

                        //Check if the MFT has grown.
                        if (mftSize < NtfsApi.GetMftValidSize(info))
                            break;
                    }
                }
            }
            catch (IOException)
            {
            }
            finally
            {
                //Clear up all the temporary files
                FileInfo[] files = tempDir.GetFiles("*", SearchOption.AllDirectories);
                int totalFiles = files.Length * (FileNameErasePasses + 1);
                for (int i = 0; i < files.Length; ++i)
                {
                    if (callback != null && i % 50 == 0)
                        callback(files.Length + i * FileNameErasePasses, totalFiles);
                    DeleteFile(files[i]);
                }

                DeleteFolder(tempDir);
            }
        }

        protected override DateTime MinTimestamp
        {
            get
            {
                return new DateTime(1601, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc);
            }
        }
    }

    /// <summary>
    /// Provides functions to handle erasures specific to FAT volumes.
    /// </summary>
    public class FatFileSystem : WindowsFileSystem
    {
        public override void EraseOldFileSystemResidentFiles(VolumeInfo info,
            ErasureMethod method, FileSystemEntriesEraseProgress callback)
        {
            //Nothing to be done here. FAT doesn't store files in its FAT.
        }

        public override void EraseDirectoryStructures(VolumeInfo info,
            FileSystemEntriesEraseProgress callback)
        {
            throw new NotImplementedException();
        }

        protected override DateTime MinTimestamp
        {
            get
            {
                return new DateTime(1980, 1, 1, 0, 0, 0);
            }
        }
    }
}