junction-verbatim 1.3.0

library for working with NTFS junctions (fork with verbatim prefix fix)
Documentation 
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

[![Documentation](https://docs.rs/junction-verbatim/badge.svg)](https://docs.rs/junction-verbatim)
[![Crates.io](https://img.shields.io/crates/v/junction-verbatim.svg)](https://crates.io/crates/junction-verbatim)

# junction-verbatim

**This is a fork of [tesuji/junction](https://github.com/tesuji/junction) with a fix for verbatim prefix handling.**

Library for working with [NTFS junctions][junction].

As opposed to symlinks, junction does not require [administrator privileges during creation][perm].
(*However starting with Windows 10 Insiders build 14972, symlinks
can be created without needing to elevate the console as
administrator*)[^1][improvement].

Quoted from [Computer Hope](https://www.computerhope.com/jargon/j/junction.htm):

> A junction, also called an NTFS junction point, is a feature of the
> NTFS file system. It is pointer to a directory on the local volume,
> similar to a symlink. It can be accessed through the Windows GUI in
> addition to the Windows command line. Junction points were first
> introduced with Windows 2000 and NTFS 3.0, and are supported in all
> subsequent versions of Windows.

## What's fixed in this fork

This fork fixes an issue where `junction::create()` would silently fail when passed paths containing the Windows verbatim prefix (`\\?\`), which are commonly produced by `std::fs::canonicalize()` on Windows. See [issue #30](https://github.com/tesuji/junction/issues/30) for details.

**Example that now works:**

```rust
let target = std::fs::canonicalize(&target_dir)?;  // Returns \\?\C:\...
let link = std::fs::canonicalize(&link_parent)? .join("junc");

// This now works correctly instead of creating a broken junction
junction::create(&target, &link)?;
```

### Minimal Supported Rust versions

Specified in the `rust-version` field in `Cargo.toml`.

## All relevant references

* https://www.codeproject.com/Articles/194/Windows-2000-Junction-Points#The_Solution
* https://www.codeproject.com/Articles/15633/Manipulating-NTFS-Junction-Points-in-NET
* https://web.archive.org/web/20230411010804/http://www.flexhex.com/docs/articles/hard-links.phtml
* https://googleprojectzero.blogspot.com/2016/02/the-definitive-guide-on-win32-to-nt.html
* https://github.com/googleprojectzero/symboliclink-testing-tools/blob/master/DumpReparsePoint/DumpReparsePoint.cpp
* https://github.com/googleprojectzero/symboliclink-testing-tools/blob/master/CommonUtils/ReparsePoint.cpp
* https://github.com/containerd/continuity/blob/master/syscallx/syscall_windows.go

## License

All the code in this repository is released under the MIT License,
for more information, please read COPYRIGHT file.

[actions-badge]: https://github.com/lzutao/junction/workflows/Rust/badge.svg?branchName=master
[actions-url]: https://github.com/lzutao/junction/actions
[junction]: https://learn.microsoft.com/en-us/windows/win32/fileio/hard-links-and-junctions#junctions
[perm]: https://en.wikipedia.org/wiki/NTFS_links#Restrictions_and_drawbacks
[improvement]: https://blogs.windows.com/windowsdeveloper/2016/12/02/symlinks-windows-10/#Ed9Olhkz6hJp4KWV.97