aboutsummaryrefslogtreecommitdiff
path: root/examples/README.md
diff options
context:
space:
mode:
authorpravic <[email protected]>2016-04-12 16:41:56 +0300
committerpravic <[email protected]>2016-04-12 16:41:56 +0300
commit56c8fa0af0c451febf43a94a6993f81ad364f9c8 (patch)
tree2cfc94f7606079e2f507bed6740b841fe4990c07 /examples/README.md
parentWindows Kernel-Mode library (diff)
downloadwinapi-kmd-rs-56c8fa0af0c451febf43a94a6993f81ad364f9c8.tar.xz
winapi-kmd-rs-56c8fa0af0c451febf43a94a6993f81ad364f9c8.zip
add driver examples
Diffstat (limited to 'examples/README.md')
-rw-r--r--examples/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 0000000..7d30dee
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,15 @@
+## 01.minimal
+
+Minimal Windows kernel driver written in Rust. [DriverEntry](https://msdn.microsoft.com/en-us/library/windows/hardware/ff544113%28v=vs.85%29.aspx) just prints `hello` and quits immediately.
+
+## 02.unload
+
+Simple kernel driver which supports [unloading](https://msdn.microsoft.com/en-us/library/windows/hardware/ff564886%28v=vs.85%29.aspx).
+
+## 03.urandom
+
+[devrandom](https://github.com/pravic/ontl/tree/master/samples/devrandom) driver sample which has been ported to Rust.
+
+It creates `\\.\urandom` device, which can produce random data like `/dev/urandom`, but insecure.
+
+This sample shows how to create a [Device Object](https://msdn.microsoft.com/en-us/library/windows/hardware/ff548014%28v=vs.85%29.aspx), assotiate it with user-mode visible [name](https://msdn.microsoft.com/en-us/library/windows/hardware/ff556420%28v=vs.85%29.aspx) and process [I/O requests](https://msdn.microsoft.com/en-us/library/windows/hardware/ff544248%28v=vs.85%29.aspx) from user-mode applications.