Skip to content

/ dokany

User mode file system library for windows with FUSE Wrapper
dokan dokan-library driver kernel-mode c fuse dll sys filesystem filesystem-library drivers windows userland device-driver fuse-wrapper createfile
C C++ Assembly PowerShell Rich Text Format C# Other
  1. C 79.0%
  2. C++ 10.1%
  3. Assembly 4.6%
  4. PowerShell 1.8%
  5. Rich Text Format 1.2%
  6. C# 1.1%
  7. Other 2.2%
Branch: master
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Latest commit

@Liryna
Liryna Appveyor - Use latest MSYS2 installer
Latest commit 07918d6 May 26, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Delete FUNDING.yml Apr 2, 2020
cert Build - Adapt sign process with new certificates Dec 1, 2019
documentations Release 1.3.0.1000 Jul 24, 2019
dokan lib - Remove export define on DokanRemoveMountPointEx May 26, 2020
dokan_control Mirror/Library - Fixing printf for WCHAR args type strings Apr 29, 2020
dokan_fuse fuse - Add mount manager option Apr 15, 2020
dokan_np Release 1.3.1.1000 Dec 16, 2019
dokan_vsix VSIX - Upgrade project and fix extension build Mar 9, 2020
dokan_wix Installer - Fix incorrect pdb file copied for driver Apr 7, 2020
samples Mirror - Fix unsafe argc usage Apr 29, 2020
scripts Scripts - Add VM debug env helper to allow self signed driver install… Mar 30, 2020
sys sys - Fix AppendVarSizeOutputString missing irp information set when … May 13, 2020
.clang-format Add dokan.h documentation Aug 10, 2016
.gitignore .gitignore *.bak files Apr 7, 2020
CHANGELOG.md Update CHANGELOG.md Apr 21, 2020
Dokan.props Release 1.3.1.1000 Dec 16, 2019
README.md README - Fix Build section instructions Mar 22, 2020
appveyor.yml Appveyor - Use latest MSYS2 installer May 26, 2020
dokan.sln Kernel / CI / Installer - Migrate dokan sys to single driver Nov 3, 2019
license.lgpl.txt Add original Dokan project source files Dec 10, 2014
license.mit.txt Update MIT Copyright year Jan 9, 2020

README.md

Dokany

Build status Quality Gate Status Coverity Scan Codacy Badge CII Best Practices FOSSA Status | Bounty | Average time to resolve an issue Percentage of issues still open

Dokan Demo

What is Dokan

When you want to create a new file system on Windows, other than FAT or NTFS, you need to develop a file system driver. Developing a device driver that works in kernel mode on windows is extremely technical. By using Dokan, you can create your own file systems very easily without writing device drivers. Dokan is similar to FUSE (Linux file system in user space) but works on Windows. Moreover, dokany includes a FUSE wrapper that helps you to port your FUSE filesystems without changes.

What is Dokany

Dokany is a fork of Dokan 0.6.0 with bug fixes, clean change history and updated to build with latest tools.

Because the original Dokan Legacy (< 0.6.0) project is no longer maintained.

Since version 0.8.0, dokany broke compatibility with the dokan API. See Choose a version for more information.

Signed x86 / x64 / ARM / ARM64 drivers are provided at each release.

Licensing

Dokan contains LGPL and MIT licensed programs.

  • user-mode library (dokan1.dll) LGPL
  • driver (dokan1.sys) LGPL
  • network library (dokannp1.dll) LGPL
  • fuse library (dokanfuse1.dll) LGPL
  • installer (DokanSetup.exe) LGPL
  • control program (dokanctl.exe) MIT
  • samples (mirror.c) MIT

For details, please check the license files.

  • LGPL license.lgpl.txt
  • MIT license.mit.txt

You can obtain source files from https://dokan-dev.github.io

Environment

Dokan works on

  • Windows Server 2019
  • Windows Server 2016
  • Windows 10
  • Windows Server 2012 R2
  • Windows 8.1
  • Windows Server 2012
  • Windows 8
  • Windows Server 2008 R2 SP1
  • Windows 7 SP1

Platform

  • x86
  • x64
  • ARM
  • ARM64

How it works

Dokan library contains a user mode DLL (dokan1.dll) and a kernel mode file system driver (dokan1.sys). Once the Dokan file system driver is installed, you can create file systems which can be seen as normal file systems in Windows. The application that creates file systems using Dokan library is called File system application.

File operation requests from user programs (e.g., CreateFile, ReadFile, WriteFile, ...) will be sent to the Windows I/O subsystem (runs in kernel mode) which will subsequently forward the requests to the Dokan file system driver (dokan1.sys). By using functions provided by the Dokan user mode library (dokan1.dll), file system applications are able to register callback functions to the file system driver. The file system driver will invoke these callback routines in order to respond to the requests it received. The results of the callback routines will be sent back to the user program.

For example, when Windows Explorer requests to open a directory, the CreateFile with Direction option request will be sent to Dokan file system driver and the driver will invoke the CreateFile callback provided by the file system application. The results of this routine are sent back to Windows Explorer as the response to the CreateFile request. Therefore, the Dokan file system driver acts as a proxy between user programs and file system applications. The advantage of this approach is that it allows programmers to develop file systems in user mode which is safe and easy to debug.

To learn more about Dokan file system development, see the API documentation.

Build

In short, download and install the Visual Studio 2019, select Windows 10 SDK component during the install or from the Tools menu & install the WDK 10

For details, see the build page.

Installation

For manual installation, see the installation page.

Contribute

You want Dokan to get better? Contribute!

Learn the code and suggest your changes on GitHub repository.

Detect defects and report them on GitHub issue tracker.

Ask and answer questions on Google discussion group.

You can’t perform that action at this time.