Skip to content

Commit

Permalink
update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
tandasat committed May 2, 2016
1 parent 809bb80 commit 7fcebb5
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 15 deletions.
Binary file not shown.
Binary file removed Documents/UsersDocuments.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion HyperPlatform.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = HyperPlatform
PROJECT_NAME = "HyperPlatform Programmer's Reference"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand Down
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,15 @@ potential applications are:
- Implementing virtual-machine-based intrusion prevention system (VIPS)
- Reverse-engineering the Windows kernel

Two of those ideas were already implemented: MemoryMon detecting execution of
kernel memory, and GuardMon monitoring some of PatchGuard activities. See their
project pages for more details:
- https://github.com/tandasat/MemoryMon
- https://github.com/tandasat/GuardMon
A simplified implementation of those ideas are available:
- MemoryMon detecting execution of kernel memory for rootkit analysis
- https://github.com/tandasat/MemoryMon
- EopMon spotting a successful elevation of privilege (EoP) exploit
- https://github.com/tandasat/EopMon
- DdiMon monitoring and controlling kernel API calls with stealth hook using EPT
- https://github.com/tandasat/DdiMon
- GuardMon observing some of PatchGuard activities
- https://github.com/tandasat/GuardMon


Advantages
Expand All @@ -36,15 +40,15 @@ especially those who are familiar with Windows. For instance:
- HyperPlatform has no dependencies, supports use of STL and is released under
a relaxed license.

For more details, see the HyperPlatform User's Documents and doxygen documents.
- https://github.com/tandasat/HyperPlatform/tree/master/Documents
For more details, see the HyperPlatform User Document and Programmer's Reference.
- http://tandasat.github.io/HyperPlatform/userdocument/
- http://tandasat.github.io/HyperPlatform/doxygen/


Build
------
To build HyperPlatform, the following are required.
- Visual Studio Community 2015 Update 2
- Visual Studio Community 2015 Update 1 or 2
- https://www.visualstudio.com/en-us/news/vs2015-update1-vs.aspx
- Windows Software Development Kit (SDK) for Windows 10
- https://dev.windows.com/en-us/downloads/windows-10-sdk
Expand All @@ -54,9 +58,6 @@ To build HyperPlatform, the following are required.

Installation and Uninstallation
--------------------------------
Download an archive file for compiled files form the release page.
- https://github.com/tandasat/HyperPlatform/releases

On the x64 platform, you have to enable test signing to install the driver.
To do that, open the command prompt with the administrator privilege and type
the following command, and then restart the system to activate the change:
Expand All @@ -76,10 +77,10 @@ For uninstallation:


Note that the system must support the Intel VT-x and EPT technology to
successfully install the driver.
successfully install the driver.

To install the driver on a virtual machine on VMware Workstation, see an "Using
VMware Workstation" section in the HyperPlatform User's Documents.
VMware Workstation" section in the HyperPlatform User Document.


Output
Expand All @@ -95,7 +96,7 @@ Supported Platforms

Related Project(s)
--------------------
SimpleVisor is a very (very) simple and readable Windows-specific hypervisor. If
SimpleVisor is a very (very) simple and readable Windows-specific hypervisor. If
HyperPlatform is still too large and complicated to learn VT-x for you, I would
recommend to take a look at the project. It should give you a clearer
view of how a hypervisor is initialized and executed.
Expand Down

0 comments on commit 7fcebb5

Please sign in to comment.