Skip to content

Latest commit

 

History

History
108 lines (90 loc) · 3.68 KB

README.md

File metadata and controls

108 lines (90 loc) · 3.68 KB
Raw

RamDrive.OsfMount

RamDrive.OsfMount is a wrapper library for OSForensics OSFMount that allows you to create and manage disks mounted in RAM (no other features provided by design). Supports Windows 11, 10, 8 (theoretical, not tested), 7 SP1 (theoretical, not tested), only 64 bit (there is OSFMount v2 for 32-bit support, but this library does not support this outdated version).

Get Started

Requirements

Library targeting:

  • .NET Framework (4.6.2, 4.7, 4.7.1, 4.7.2, 4.8)
  • .NET (6-windows-only, 7-windows-only)

If the target platform of the project in which you are going to use this library is not Windows, then there is no point in using it. In the case of a cross-platform project, you will need to use the Conditional PackageReference, where for Windows will be used this library.

Install Package

Using Package Manager Console:

PM> Install-Package RamDrive.OsfMount

Using .NET CLI:

dotnet add package RamDrive.OsfMount

Usage

Please note that all operations require your application to have administrator privileges.

Mount ram drive with size 1.5Gb, under drive letter 'X' and file system NTFS:

using RamDrive.OsfMount;
using ByteSizeLib;

var possibleError = await OsfMountRamDrive.Mount(
    ByteSize.FromGibiBytes(1.5),
    DriveLetter.X,
    FileSystemType.NTFS
);

Unmount ram drive under drive letter 'X':

using RamDrive.OsfMount;
using ByteSizeLib;

var possibleError = await OsfMountRamDrive.Unmount(DriveLetter.X);

Force unmount ram drive under drive letter 'X' (force unmount will be abort all drive under letter 'X' operations from other processes in system if exists):

using RamDrive.OsfMount;
using ByteSizeLib;

var possibleError = await OsfMountRamDrive.ForceUnmount(DriveLetter.X);

How to handle errors? Type of returned objects — types of errors described using discriminated union (OneOf type library), which have Switch and Match methods (for pattern matching). See:

using RamDrive.OsfMount;
using ByteSizeLib;
using OneOf;

var result = await OsfMountRamDrive.Mount(
     ByteSize.FromMebiBytes(300),
     DriveLettersForUsage.First(),
     FileSystemType.NTFS);
 
// Log if some error
result?.Switch(
    driveLetterInUseOrNotAllowed => Logger.LogDriveLetterIllegal(driveLetterInUseOrNotAllowed.DriveLetter),
    tooLowSize => Logger.TooLowSizeForDrive(tooLowSize.Size),
    driveSizeCannotBeGreaterThenRamCapacity => Logger.TooBigDriveSize(driveSizeCannotBeGreaterThenRamCapacity.Size)
);

// Or create error message or nothing if some error
string? message = result?.Match(
    case1 => $"Drive letter {case1.DriveLetter} in use or not allowed",
    case2 => $"Drive size {case2.Size} too low",
    case3 => "Drive size cannot be greater then total ram capacity"
);

Or, you can use object-oriented approach with disposable object:

using (var drive = await OsfMountRamDrive.New(ByteSize.FromMebiBytes(512), FileSystemType.NTFS))
{
  string drivePath = drive.Path;
  DriveLetter driveLetter = drive.DriveLetter;
  
  // use drive ...
}

Contributing

See CONTRIBUTION.md.

Changelog/Version history

See VERSION_HISTORY.md

License

RamDrive.OsfMount is Copyright © 2023 flexxxxer Aleksandr under the Apache License, Version 2.0.