aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 8016986450b905e29453fd2878bb2f3f94485b56 (plain) (blame)
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
## Windows Kernel-Mode Drivers written in Rust

This library is just a proof-of-concept of the windows kernel-mode drivers, which can be written in Rust programming language.

It contains the types, constants and bindings for the [Windows Driver Kit](https://en.wikipedia.org/wiki/Windows_Driver_Kit)
with target OS starting from Windows XP (x86/x64).


### Getting started

To compile you need the following:

* Nightly Rust with MSVC ABI starting from 2016-04-12 (?), which supports "[is-like-msvc](https://github.com/rust-lang/rust/pull/32823)" target flavor.
* MSVC itself, either VS 2015 or just MSVC Build Tools.
* Rust environment for the Windows drivers: [kmd-env-rs](https://github.com/pravic/kmd-env-rs).

As workaround you can compile drivers as `#[crate_type="staticlib"]` and link them manually (see *examples/03.urandom/build.cmd*).


Setting up:

```
git clone https://github.com/pravic/kmd-env-rs .
git submodule init
git submodule update --recursive
```

Set the nightly-msvc Rust toolchain [for this](https://github.com/rust-lang-nursery/multirust-rs#directory-overrides) repository:

`rustup override add nightly-i686-msvc`

Try to compile example:

```
cd km\examples\01.minimal\
cargo build --release
```

If linker fails with error "*cannot open input file 'ntoskrnl.lib'*",
open `kmd-env-rs/.cargo/config` file and replace `../../../` with the full path to the "*kmd-env-rs*" directory.


### Examples

See [examples](https://github.com/pravic/winapi-kmd-rs/tree/master/examples) folder with a driver samples and screenshots.


### [Reference documentation](http://pravic.github.io/winapi-kmd-rs/).


#### Acknowledges

In memory of [Four-F](http://four-f.narod.ru/) - the author of tutorials about kernel mode drivers development in assembly language (2002-2005).