Roxedus/py-kms
1
0
Fork 0
mirror of https://github.com/SystemRage/py-kms.git synced 2024-11-22 00:05:38 +01:00
Code Issues Projects Releases Wiki Activity

Move docs to Readthedocs (#87)

Browse Source 
* Modified rtd template

* Added current wiki files

* Superseeded by index.rst

* Removed dead links

* Minor formatting

* Moved usage to own topic

* Reformatting...

* Reformatting...

* Formulations

* New topic structure

* Split into subsections

* Heading changes

* Ooops, missed a file

* Reformatting

* Changed file name

* Link fixes

* Topic level change

* Minor title change

* Formulations

* Again more heading changes

* Added todos

* Removed old manual wiki copy

* Table fix

* Table fix chars

* Reformulated

* Formatting and reformulations

* Heading change

* Merged key files

* Fixed heading problems

* Added TODO

* Added TODOs

* Moinor formatting

* Removed empty lines

* Switched to local copies of images

* Changed in-doc ref

* Done Ref replacement

* Key table reformat

* Hidden TODOs

* Moved manual section

* Started moving into docs

* Minimized

* Moved readme file
Merged docker section
Pending still other readme sections at manual execution

* Added one sentence regarding ipv4/ipv6 to docker

* Merged manual execution information

* Added some badges

* Reworked fast run doc

* Added note to the rest of options

* Added changelog to docs

* Added tables?

* Added table support

* removed test table

* Finished TODO

* Moved subtopic to top (old parent was not "logically connected")

* Typo

* Changed readme url to new docs

* Fixed wrong docs badge uri

* Changed doc title to link, so it is impossible to miss
This commit is contained in:
Simonmicro 2020-09-01 23:29:46 +02:00 committed by GitHub
parent 5b328d20f4
commit 27aa94a6e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
22 changed files with 1716 additions and 941 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -1,3 +1,5 @@
# Changelog
### py-kms_2020-07-01
- py-kms Gui: now matches all cli options, added modes onlyserver / onlyclient,
added some animations.

82
README.md
View File

@ -1,8 +1,17 @@
# History
# Readme
![repo-size](https://img.shields.io/github/repo-size/SystemRage/py-kms)
![open-issues](https://img.shields.io/github/issues/SystemRage/py-kms)
![last-commit](https://img.shields.io/github/last-commit/SystemRage/py-kms/master)
![docker-status](https://img.shields.io/docker/cloud/build/pykmsorg/py-kms)
![docker-pulls](https://img.shields.io/docker/pulls/pykmsorg/py-kms)
![read-the-docs](https://img.shields.io/readthedocs/py-kms)
***
## History
_py-kms_ is a port of node-kms created by [cyrozap](http://forums.mydigitallife.info/members/183074-markedsword), which is a port of either the C#, C++, or .NET implementations of KMS Emulator. The original version was written by [CODYQX4](http://forums.mydigitallife.info/members/89933-CODYQX4) and is derived from the reverse-engineered code of Microsoft's official KMS.
# Features
- Responds to V4, V5, and V6 KMS requests.
## Features
- Responds to `v4`, `v5`, and `v6` KMS requests.
- Supports activating:
- Windows Vista
- Windows 7
@ -20,59 +29,24 @@ _py-kms_ is a port of node-kms created by [cyrozap](http://forums.mydigitallife.
- Microsoft Office 2013 ( Volume License )
- Microsoft Office 2016 ( Volume License )
- Microsoft Office 2019 ( Volume License )
- It's written in Python:
- tested with Python 3.6.9
- It's written in Python (tested with Python 3.6.7)
- Supports execution by `Docker`, `systemd`, `Upstart` and many more...
- Includes a GUI for simlpe managing
- Uses `sqlite` for persistent data storage
# Dependencies
- Python 3.x.
- Tkinter module.
- If the `tzlocal` module is installed, the "Request Time" in the verbose output will be converted into local time. Otherwise, it will be in UTC.
- It can use the `sqlite3` module so you can use the database function, storing activation data so it can be recalled again.
- Installation example on Ubuntu / Mint:
- `sudo apt-get update`
- `sudo apt-get install python3-tk python3-pip`
- `sudo pip3 install tzlocal pysqlite3`
## [Documentation](https://py-kms.readthedocs.io/en/latest/)
The documentation has been completly reworked and is now available on [readthedocs.com](https://py-kms.readthedocs.io/en/latest/Usage.html#start-parameters). It should you provide all necessary information how to get py-kms up
and running using your favourite tools - all without clumping this readme up. The documentation also houses more information about activation with _py-kms_ and to how get GVLK keys.
# Usage
- To start the server, execute `python3 pykms_Server.py [IPADDRESS] [PORT]`, the default _IPADDRESS_ is `0.0.0.0` ( all interfaces ) and the default _PORT_ is `1688`. Note that both the address and port are optional. It's allowed to use IPv4 and IPv6 addresses. If you have a IPv6-capable dual-stack OS, a dual-stack socket is created when using a IPv6 address.
- To run the client (only for testing purposes), use `python3 pykms_Client.py [IPADDRESS] [PORT]`, with the same defaults of `pykms_Server.py`.
## Get it running (fast)...
- To start the server manually, execute `python3 pykms_Server.py [IPADDRESS] [PORT]`, the default `IPADDRESS` is `::` ( all ipv6-interfaces ) and the default `PORT` is `1688`. Note that both the address and port are optional.
Also note that it is recommended to use an IPv6 address - even if you are just plan to use IPv4 (the kernel maps the incoming IPv4 requests automatically to IPv6)!
- To start the server automatically using Docker, execute `docker run -d --name py-kms --restart always -p 1688:1688 pykmsorg/py-kms`.
- To show the help pages type: `python3 pykms_Server.py -h` and `python3 pykms_Client.py -h`.
- To generate a random HWID use `-w` option: `python3 pykms_Server.py -w RANDOM`.
- To get the HWID from any server use the client, for example type: `python3 pykms_Client.py :: 1688 -m Windows8.1 -V INFO`.
- For launching py-kms GUI make the file `pykms_Server.py` executable with `chmod +x /path/to/folder/py-kms/pykms_Server.py`, then simply run `pykms_Server.py` by double-clicking.
- To change your logfile path use `-F` option, for example: `python3 pykms_Server.py -F /path/to/your/logfile.log -V DEBUG`.
- To view a minimal set of logging information use `-V MINI` option, for example: `python3 pykms_Server.py -F /path/to/your/logfile.log -V MINI`.
- To redirect logging on stdout use `-F STDOUT` option, for example: `python3 pykms_Server.py -F STDOUT -V DEBUG`.
- You can create logfile and view logging information on stdout at the same time with `-F FILESTDOUT` option, for example: `python3 pykms_Server.py -F FILESTDOUT /path/to/your/logfile.log -V DEBUG`.
- With `-F STDOUTOFF` you disable all stdout messages (but a logfile will be created), for example: `python3 pykms_Server.py -F STDOUTOFF /path/to/your/logfile.log -V DEBUG`.
- With `-F FILEOFF` you disable logfile creation.
_If you wish to learn more about using py-kms, please refer to the documentation [here](Getting Started.md)!_
- Select timeout (seconds) for py-kms with `-t0` option, for example `python3 pykms_Server.py -t0 10`.
- Option `-y` enables printing asynchronously of messages (pretty / logging).
- For launching py-kms GUI make executable `pykms_Server.py` file with `chmod +x /path/to/folder/py-kms/pykms_Server.py`, then simply run `pykms_Server.py` double-clicking.
- You can run py-kms daemonized (via [Etrigan](https://github.com/SystemRage/Etrigan)) using a command like: `python3 pykms_Server.py etrigan start` and stop it with: `python3 pykms_Server.py etrigan stop`.
- With Etrigan you have another way to launch py-kms GUI (specially suitable if you're using a virtualenv), so: `python3 pykms_Server.py etrigan start -g`
and stop the GUI with `python3 pykms_Server.py etrigan stop` (or interact with the EXIT button).
# Docker
![auto-docker](https://img.shields.io/docker/cloud/automated/pykmsorg/py-kms)
![status-docker](https://img.shields.io/docker/cloud/build/pykmsorg/py-kms)
![pulls-docker](https://img.shields.io/docker/pulls/pykmsorg/py-kms)
![size-docker](https://img.shields.io/docker/image-size/pykmsorg/py-kms)
This project has docker image support. You can find all available image configurations inside the docker folder.
There are three tags of the images available:
* `latest`, currently the same like minimal...
* `minimal`, wich is based on the python3 minimal configuration of py-kms. _This image does NOT include SQLLite support!_
* `python3`, which is fully configurable and equiped with SQLLite support and web interface.
If you just want to use the image and don't want to build them yourself, you can use the official image at the docker hub (`pykmsorg/py-kms`).
To ensure that the image is always up-to-date you should check [watchtower](https://github.com/containrrr/watchtower) out!
# Other Important Stuff
Consult the [Wiki](https://github.com/SystemRage/py-kms/wiki) for more information about activation with _py-kms_ and to get GVLK keys.
# License
- _py-kms_ is [![License0](https://img.shields.io/badge/license-unlicense-lightgray.svg)](https://github.com/SystemRage/py-kms/blob/master/LICENSE)
- _py-kms GUI_ is [![License1](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/SystemRage/py-kms/blob/master/LICENSE.gui.md) © Matteo ℱan
## License
- _py-kms_ is [![Unlicense](https://img.shields.io/badge/license-unlicense-lightgray.svg)](https://github.com/SystemRage/py-kms/blob/master/LICENSE)
- _py-kms GUI_ is [![MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/SystemRage/py-kms/blob/master/LICENSE.gui.md) © Matteo ℱan

346
docs/Documentation.md Normal file
View File

@ -0,0 +1,346 @@
# Documentation
What follows are some detailed explanations how some parts work.
## Understanding Key Management Service
KMS activates Microsoft products on a local network, eliminating the need for individual computers to connect to Microsoft. To do this, KMS uses a client–server topology. A KMS client locates a KMS server by using DNS or a static
configuration, then contact it by using Remote Procedure Call (RPC) and tries to activate against it. KMS can activate both physical computers and virtual machines, but a network must meet or exceed the activation threshold
(minimum number of computers that KMS requires) of 25. For activation, KMS clients on the network need to install a KMS client key (General Volume License Key, GVLK), so the product no longer asks Microsoft server but a user–defined
server (the KMS server) which usually resides in a company’s intranet.
_py-kms_ is a free open source KMS server emulator written in Python, while Microsoft gives their KMS server only to corporations that signed a Select contract. Furthermore _py-kms_ never refuses activation since it is without
restrictions, while the Microsoft KMS server only activates the products the customer has paid for. _py-kms_ supports KMS protocol versions `4`, `5` and `6`.
**Although _py-kms_ does neither require an activation key nor any payment, it is not meant to run illegal copies of Windows.** Its purpose is to ensure that owners of legal copies can use their software without restrictions,
e.g. if you buy a new computer or motherboard and your key will be refused activation from Microsoft servers due to hardware changes.
Activation with _py-kms_ is achieved with the following steps:
1. Run _py-kms_ on a computer in the network (this is KMS server or local host).
2. Install the product on client (or said remote host, which is the computer sending data to local host) and enter the GVLK.
3. Configure the client to use the KMS server.
Note that KMS activations are only valid for 180 days, the activation validity interval, or 30 to 45 days with consumer-only products. To remain activated, KMS client computers must renew their activation by connecting to the KMS
server at least once every 180 days. For this to work, you have to should ensure that a KMS server is always reachable for all clients on the network. Also remember **you can't activate Windows 8.1 (and above) on a KMS server hosted
on the same machine** (the KMS server must be a different computer than the client).
### About GVLK keys
The GVLK keys for products sold via volume license contracts (renewal every 180 days) are published on Microsoft’s Technet web site.
* Windows: [https://technet.microsoft.com/en-us/library/jj612867.aspx](https://technet.microsoft.com/en-us/library/jj612867.aspx)
* Office 2010: [https://technet.microsoft.com/en-us/library/ee624355(v=office.14).aspx#section2_3](https://technet.microsoft.com/en-us/library/ee624355(v=office.14).aspx)
* Office 2013: [https://technet.microsoft.com/en-us/library/dn385360.aspx](https://technet.microsoft.com/en-us/library/dn385360.aspx)
* Office 2016: [https://technet.microsoft.com/en-en/library/dn385360(v=office.16).aspx](https://technet.microsoft.com/en-en/library/dn385360(v=office.16).aspx)
There are also not official keys for consumer-only versions of Windows that require activation renewal every 45 days (Windows 8.1) or 30 days (Windows 8). A more complete and well defined list is available [here](Keys.md).
### SLMGR and OSPP commands
The software License Manager (`slmgr.vbs`) is a Visual Basic script used to configure and retrieve Volume Activation information. The script can be run locally or remotely on the target computer, using the Windows-based script host
(`wscript.exe`) or the command-based script host (`cscript.exe`) - administrators can specify which script engine to use. If no script engine is specified, _SLMGR_ runs using the default script engine (it is recommended to utilize
the `cscript.exe` script engine that resides in the system32 directory). The Software Licensing Service must be restarted for any changes to take effect. To restart it, the Microsoft Management Console (MMC) Services can be used or
running the following command:
```
net stop sppsvc && net start sppsvc
```
The _SLMGR_ requires at least one parameter. If the script is run without any parameters, it displays help information. The general syntax of `slmgr.vbs` is as follows (using the `cscript.exe` as the script engine):
```
cscript slmgr.vbs /parameter
cscript slmgr.vbs [ComputerName] [User] [Password] [Option]
```
Where command line options are:
```
[ComputerName] Name of a remote computer (default is local computer).
[User] Account with the required privilege on the remote computer.
[Password] Password for the account with required privileges on the remote compute.
[Option] Options are shown in the table below.
```
#### SLMGR
Following tables lists _SLMGR_ more relevant options and a brief description of each. Most of the parameters configure the KMS host.
<table width="700" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="250">
<col span="1" width="450">
</colgroup>
<thead><tr><th>Global options</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td>/ipk <<i>ProductKey</i>></td>
<td>Attempts to install a 5×5 <i>ProductKey</i> for Windows or other application identified by the <i>ProductKey</i>. If the key is valid, this is installed. If a key is already installed, it's silently replaced.</td>
</tr>
<tr>
<td>/ato [<i>ActivationID</i>]</td>
<td>Prompts Windows to attempt online activation, for retail and volume systems with KMS host key. Specifying the <i>ActivationID</i> parameter isolates the effects of the option to the edition associated with that value.</td>
</tr>
<tr>
<td>/dli [<i>ActivationID</i> | <i>All</i>]</td>
<td>Display license information. Specifying the <i>ActivationID</i> parameter displays the license information for the specified edition associated with that <i>ActivationID</i>. Specifying <i>All</i> will display all applicable installed products’ license information. Useful for retrieve the current KMS activation count from the KMS host.</td>
</tr>
<tr>
<td>/dlv [<i>ActivationID</i> | <i>All</i>]</td>
<td>Display detailed license information.</td>
</tr>
<tr>
<td>/xpr [<i>ActivationID</i>]</td>
<td>Display the activation expiration date for the current license state.</td>
</tr>
</tbody>
</table>
<table width="700" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="250">
<col span="1" width="450">
</colgroup>
<thead><tr><th>Advanced options</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td>/cpky</td>
<td>Some servicing operations require the product key to be available in the registry during Out-of-Box Experience (OOBE) operations. So this option removes the product key from the registry to prevent from being stolen by malicious code.</td>
</tr>
<tr>
<td>/ilc <<i>LicenseFile</i>></td>
<td>Installs the <i>LicenseFile</i> specified by the required parameter.</td>
</tr>
<tr>
<td>/rilc</td>
<td>Reinstalls all licenses stored in <i>%SystemRoot%\system32\oem</i> and <i>%SystemRoot%\System32\spp\tokens</i>.</td>
</tr>
<tr>
<td>/rearm</td>
<td>Resets the activation timers.</td>
</tr>
<tr>
<td>/rearm-app <<i>ApplicationID</i>></td>
<td>Resets the licensing status of the specified application.</td>
</tr>
<tr>
<td>/rearm-sku <<i>ApplicationID</i>></td>
<td>Resets the licensing status of the specified <i>SKU</i>.</td>
</tr>
<tr>
<td>/upk [<i>ActivationID</i>]</td>
<td>Uninstalls the product key of the current Windows edition. After a restart, the system will be in an unlicensed state unless a new product key is installed.</td>
</tr>
<tr>
<td>/dti [<i>ActivationID</i>]</td>
<td>Displays installation ID for offline activation of the KMS host for Windows (default) or the application that is identified when its <i>ActivationID</i> is provided.</td>
</tr>
<tr>
<td>/atp [<i>ConfirmationID</i>][<i>ActivationID</i>]</td>
<td>Activate product with user-provided <i>ConfirmationID</i>.</td>
</tr>
</tbody>
</table>
<table width="750" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="250">
<col span="1" width="450">
</colgroup>
<thead><tr><th>KMS client options</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td>/skms <<i>Name</i>[:<i>Port</i>] | : <i>port</i>> [<i>ActivationID</i>]</td>
<td>Specifies the name and the port of the KMS host computer to contact. Setting this value disables auto-detection of the KMS host. If the KMS host uses IPv6 only, the address must be specified in the format [<i>hostname</i>]:<i>port</i>.</td>
</tr>
<tr>
<td>/skms-domain <<i>FQDN</i>> [<i>ActivationID</i>]</td>
<td>Sets the specific DNS domain in which all KMS SRV records can be found. This setting has no effect if the specific single KMS host is set with the /skms option. Use this option, especially in disjoint namespace environments, to force KMS to ignore the DNS suffix search list and look for KMS host records in the specified DNS domain instead. </td>
</tr>
<tr>
<td>/ckms [<i>ActivationID</i>]</td>
<td>Removes the specified KMS hostname, address, and port information from the registry and restores KMS auto-discovery behavior.</td>
</tr>
<tr>
<td>/skhc</td>
<td>Enables KMS host caching (default), which blocks the use of DNS priority and weight after the initial discovery of a working KMS host. If the system can no longer contact the working KMS host, discovery will be attempted again.</td>
</tr>
<tr>
<td>/ckhc</td>
<td>Disables KMS host caching. This setting instructs the client to use DNS auto-discovery each time it attempts KMS activation (recommended when using priority and weight).</td>
</tr>
<tr>
<td>/sai <<i>ActivationInterval</i>></td>
<td>Changes how often a KMS client attempts to activate itself when it cannot find a KMS host. Replace <i>ActivationInterval</i> with a number of minutes between 15 minutes an 30 days. The default setting is 120.</td>
</tr>
<tr>
<td>/sri <<i>RenewalInterval</i>></td>
<td>Changes how often a KMS client attempts to renew its activation by contacting a KMS host. Replace <i>RenewalInterval</i> with a number of minutes between 15 minutes an 30 days. The default setting is 10080 (7 days).</td>
</tr>
<tr>
<td>/sprt <<i>PortNumber</i>></td>
<td>Sets the TCP communications port on a KMS host. It replaces PortNumber with the TCP port number to use. The default setting is 1688.</td>
</tr>
<tr>
<td>/sdns</td>
<td>Enables automatic DNS publishing by the KMS host.</td>
</tr>
<tr>
<td>/cdns</td>
<td>Disables automatic DNS publishing by a KMS host.</td>
</tr>
<tr>
<td>/spri</td>
<td>Sets the priority of KMS host processes to <i>Normal</i>.</td>
</tr>
<tr>
<td>/cpri</td>
<td>Set the KMS priority to <i>Low</i>.</td>
</tr>
<tr>
<td>/act-type [<i>ActivationType</i>] [<i>ActivationID<i/>]</td>
<td>Sets a value in the registry that limits volume activation to a single type. <i>ActivationType</i> 1 limits activation to active directory only; 2 limits it to KMS activation; 3 to token-based activation. The 0 option allows any activation type and is the default value.</td>
</tr>
</tbody>
</table>
#### OSPP
The Office Software Protection Platform script (`ospp.vbs`) can help you to configure and test volume license editions of Office client products. You must open a command prompt by using administrator permissions and navigate to the
folder that contains the mentioned script. The script is located in the folder of the Office installation (use `\Office14` for Office 2010, `\Office15` for Office 2013 and `\Office16` for Office 2016): `%installdir%\Program Files\Microsoft Office\Office15`.
If you are running a 32-bit Office on a 64-bit operating system, the script is located in the folder: `%installdir%\Program Files (x86)\Microsoft Office\Office15`.
Running _OSPP_ requires the `cscript.exe` script engine. To see the help file, type the following command, and then press ENTER:
```
cscript ospp.vbs /?
```
The general syntax is as follows:
```
cscript ospp.vbs [Option:Value] [ComputerName] [User] [Password]
```
Where command line options are:
```
[Option:Value] Specifies the option and Value to use to activate a product, install or uninstall a product key, install and display license information, set KMS host name and port, and remove KMS host. The options and values are listed in the tables below.
[ComputerName] Name of the remote computer. If a computer name is not provided, the local computer is used.
[User] Account that has the required permission on the remote computer.
[Password] Password for the account. If a user account and password are not provided, the current credentials are used.
```
<table width="750" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="250">
<col span="1" width="450">
</colgroup>
<thead><tr><th>Global options</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td>/act</td>
<td>Activates installed Office product keys.</td>
</tr>
<tr>
<td>/inpkey:<<i>ProductKey</i>></td>
<td>Installs a <i>ProductKey</i> (replaces existing key) with a user-provided <i>ProductKey</i>.</td>
</tr>
<tr>
<td>/unpkey:<<i>ProductKey</i>></td>
<td>Uninstalls an installed <i>ProductKey</i> with the last five digits of the <i>ProductKey</i> to uninstall (as displayed by the /dstatus option).</td>
</tr>
<tr>
<td>/inslic:<<i>LicenseFile</i>></td>
<td>Installs a <i>LicenseFile</i> with user-provided path of the .xrm-ms license.</td>
</tr>
<tr>
<td>/dstatus</td>
<td>Displays license information for installed product keys.</td>
</tr>
<tr>
<td>/dstatusall</td>
<td>Displays license information for all installed licenses.</td>
</tr>
<tr>
<td>/dhistoryacterr</td>
<td>Displays the failure history for MAK / Retail activation.</td>
</tr>
<tr>
<td>/dinstid</td>
<td>Displays Installation ID for offline activation.</td>
</tr>
<tr>
<td>/actcid:<<i>ConfirmationID</i>></td>
<td>Activates product with user-provided <i>ConfirmationID</i>.</td>
</tr>
<tr>
<td>/rearm</td>
<td>Resets the licensing status for all installed Office product keys.</td>
</tr>
<tr>
<td>/rearm:<<i>ApplicationID</i>></td>
<td>Resets the licensing status for an Office license with a user-provided <i>SKUID</i> value. Use this option with the <i>SKUID</i> value specified by using the /dstatus option if you have run out of rearms and have activated Office through KMS or Active Directory-based activation to gain an additional rearm.</td>
</tr>
<tr>
<td>/ddescr:<<i>ErrorCode</i>></td>
<td>Displays the description for a user-provided <i>ErrorCode</i>.</td>
</tr>
</tbody>
</table>
<table width="750" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="250">
<col span="1" width="450">
</colgroup>
<thead><tr><th>KMS client options</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td>/dhistorykms</td>
<td>Displays KMS client activation history.</td>
</tr>
<tr>
<td>/dcmid</td>
<td>Displays KMS client computer ID (CMID)</td>
</tr>
<tr>
<td>/sethst:<<i>HostName</i>></td>
<td>Sets a KMS host name with a user-provided <i>HostName</i>.</td>
</tr>
<tr>
<td>/setprt:<<i>Port</i>></td>
<td>Sets a KMS port with a user-provided <i>Port</i> number.</td>
</tr>
<tr>
<td>/remhst</td>
<td>Removes KMS hostname (sets port to default).</td>
</tr>
<tr>
<td>/cachst:<<i>Value</i>></td>
<td>Allows or denies KMS host caching. Parameter <i>Value</i> can be TRUE or FALSE.</td>
</tr>
<tr>
<td>/actype:<<i>Value</i>></td>
<td>(Windows 8 and later only) Sets volume activation type. Parameter <i>Value</i> can be: 1 (for Active Directory-based), 2 (for KMS), 0 (for both).</td>
</tr>
<tr>
<td>/skms-domain:<<i>Value</i>></td>
<td>(Windows 8 and later only) Sets the specific DNS domain in which all KMS SRV records can be found. This setting has no effect if the specific single KMS host is set by the /sethst option. Parameter <i>Value</i> is the Fully Qualified Domain Name (FQDN).</td>
</tr>
<tr>
<td>/ckms-domain</td>
<td>(Windows 8 and later only) Clears the specific DNS domain in which all KMS SRV records can be found. The specific KMS host is used if it is set by the /sethst option. Otherwise, auto-discovery of the KMS host is used.</td>
</tr>
</tbody>
</table>
## Further references
* <sup>[1]</sup> https://forums.mydigitallife.net/threads/emulated-kms-servers-on-non-windows-platforms.50234
* <sup>[2]</sup> https://forums.mydigitallife.net/threads/discussion-microsoft-office-2019.75232
* <sup>[3]</sup> https://forums.mydigitallife.net/threads/miscellaneous-kms-related-developments.52594
* <sup>[4]</sup> https://forums.mydigitallife.net/threads/kms-activate-windows-8-1-en-pro-and-office-2013.49686
* <sup>[5]</sup> https://github.com/myanaloglife/py-kms
* <sup>[6]</sup> https://github.com/Wind4/vlmcsd
* <sup>[7]</sup> https://github.com/ThunderEX/py-kms
* <sup>[8]</sup> https://github.com/CNMan/balala/blob/master/pkconfig.csv
* <sup>[9]</sup> http://www.level7techgroup.com/docs/kms_overview.pdf
* <sup>[10]</sup> https://www.dell.com/support/article/it/it/itbsdt1/sln266176/windows-server-using-the-key-management-service-kms-for-activation-of-volume-licensed-systems?lang=en
* <sup>[11]</sup> https://social.technet.microsoft.com/Forums/en-US/c3331743-cba2-4d92-88aa-9633ac74793a/office-2010-kms-current-count-remain-at-10?forum=officesetupdeployprevious
* <sup>[12]</sup> https://betawiki.net/wiki/Microsoft_Windows
* <sup>[13]</sup> https://thecollectionbook.info/builds/windows
* <sup>[14]</sup> https://www.betaarchive.com/forum/viewtopic.php%3Ft%3D29131+&cd=10&hl=it&ct=clnk&gl=it
* <sup>[15]</sup> https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=12&cad=rja&uact=8&ved=2ahUKEwjmvZihtOHeAhVwyoUKHSjeD5Q4ChAWMAF6BAgHEAI&url=ftp%3A%2F%2Flynas.ittc.vu.lt%2Fpub%2FMicrosoft%2FWindows%2520Vista%2FWindows%2520Vista_Volume_Activation_2.0%2FWindows%2520Vista%2520Volume%2520Activation%2FWindows%2520Vista_Volume_Activation_2.0%2Fvolume%2520activation%25202%25200%2520step-by-step%2520guide.doc&usg=AOvVaw3kqhCu3xT-3r416DRGUUs_
* <sup>[16]</sup> https://www.itprotoday.com/windows-78/volume-activation-server-2008
* <sup>[17]</sup> https://docs.microsoft.com/en-us/windows-server/get-started-19/activation-19
* <sup>[18]</sup> https://docs.microsoft.com/en-us/windows-server/get-started/windows-server-release-info
* <sup>[19]</sup> https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet

170
docs/Getting Started.md Normal file
View File

@ -0,0 +1,170 @@
# Getting Started
What follows are some guides how to start the `pykms_Server.py` script, which provides the server.
## Running as a service
***
You can simply manage a daemon that runs as a background process. This can be achieved by using any of the guides below or by writing your own solution.
### Docker
![docker-auto](https://img.shields.io/docker/cloud/automated/pykmsorg/py-kms)
![docker-status](https://img.shields.io/docker/cloud/build/pykmsorg/py-kms)
![docker-pulls](https://img.shields.io/docker/pulls/pykmsorg/py-kms)
![docker-size](https://img.shields.io/docker/image-size/pykmsorg/py-kms)
If you wish to get _py-kms_ just up and running without installing any dependencies or writing own scripts: Just use Docker! Docker also solves problems regarding the explicit IPv4 and IPv6 usage: It just supports both. The following
command will download, "install" and start _py-kms_ and also keep it alive after any service disruption.
```bash
docker run -d --name py-kms --restart always -p 1688:1688 pykmsorg/py-kms
```
There are currently three tags of the image available (select one just by appending `:<tag>` to the image from above):
* `latest`, currently the same like minimal...
* `minimal`, wich is based on the python3 minimal configuration of py-kms. _This tag does NOT include `sqlite` support!_
* `python3`, which is fully configurable and equipped with `sqlite` support and a web interface for management.
If you just want to use the image and don't want to build them yourself, you can always use the official image at the [Docker Hub](https://hub.docker.com/r/pykmsorg/py-kms) (`pykmsorg/py-kms`). To ensure that you are using always the
latest version you should check something like [watchtower](https://github.com/containrrr/watchtower) out!
### Systemd
If you are running a Linux distro using `systemd`, create the file: `sudo nano /etc/systemd/system/py3-kms.service`, then add the following (change it where needed) and save:
```systemd
[Unit]
Description=py3-kms
After=network.target
StartLimitIntervalSec=0
[Service]
Type=simple
Restart=always
RestartSec=1
KillMode=process
User=root
ExecStart=/usr/bin/python3 </path/to/your/pykms/files/folder>/py-kms/pykms_Server.py 0.0.0.0 1688 -V DEBUG -F </path/to/your/log/files/folder>/pykms_logserver.log
[Install]
WantedBy=multi-user.target
```
Check syntax with `sudo systemd-analyze verify py3-kms.service`, correct file permission (if needed) `sudo chmod 644 /etc/systemd/system/py3-kms.service`, then reload systemd manager configuration `sudo systemctl daemon-reload`,
start the daemon `sudo systemctl start py3-kms.service` and view its status `sudo systemctl status py3-kms.service`. Check if daemon is correctly running with `cat </path/to/your/log/files/folder>/pykms_logserver.log`. Finally a
few generic commands useful for interact with your daemon [here](https://linoxide.com/linux-how-to/enable-disable-services-ubuntu-systemd-upstart/).
### Etrigan
You can run py-kms daemonized (via [Etrigan](https://github.com/SystemRage/Etrigan)) using a command like `python3 pykms_Server.py etrigan start` and stop it with `python3 pykms_Server.py etrigan stop`. With Etrigan you have another
way to launch py-kms GUI (specially suitable if you're using a virtualenv), so `python3 pykms_Server.py etrigan start -g` and stop the GUI with `python3 pykms_Server.py etrigan stop` (or interact with the `EXIT` button).
### Upstart (deprecated)
If you are running a Linux distro using `upstart` (deprecated), create the file: `sudo nano /etc/init/py3-kms.conf`, then add the following (change it where needed) and save:
```
description "py3-kms"
author "SystemRage"
env PYTHONPATH=/usr/bin
env PYKMSPATH=</path/to/your/pykms/files/folder>/py-kms
env LOGPATH=</path/to/your/log/files/folder>/pykms_logserver.log
start on runlevel [2345]
stop on runlevel [016]
exec $PYTHONPATH/python3 $PYKMSPATH/pykms_Server.py 0.0.0.0 1688 -V DEBUG -F $LOGPATH
respawn
```
Check syntax with `sudo init-checkconf -d /etc/init/py3-kms.conf`, then reload upstart to recognise this process `sudo initctl reload-configuration`. Now start the service `sudo start py3-kms`, and you can see the logfile
stating that your daemon is running: `cat </path/to/your/log/files/folder>/pykms_logserver.log`. Finally a few generic commands useful for interact with your daemon [here](https://eopio.com/linux-upstart-process-manager/).
### Windows
If you are using Windows, to run `pykms_Server.py` as service you need to install [pywin32](https://sourceforge.net/projects/pywin32/), then you can create a file for example named `kms-winservice.py` and put into it this code:
```python
import win32serviceutil
import win32service
import win32event
import servicemanager
import socket
import subprocess
class AppServerSvc (win32serviceutil.ServiceFramework):
_svc_name_ = "py-kms"
_svc_display_name_ = "py-kms"
_proc = None
_cmd = ["C:\Windows\Python27\python.exe", "C:\Windows\Python27\py-kms\pykms_Server.py"]
def __init__(self,args):
win32serviceutil.ServiceFramework.__init__(self,args)
self.hWaitStop = win32event.CreateEvent(None,0,0,None)
socket.setdefaulttimeout(60)
def SvcStop(self):
self.killproc()
self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)
win32event.SetEvent(self.hWaitStop)
def SvcDoRun(self):
servicemanager.LogMsg(servicemanager.EVENTLOG_INFORMATION_TYPE,
servicemanager.PYS_SERVICE_STARTED,
(self._svc_name_,''))
self.main()
def main(self):
self._proc = subprocess.Popen(self._cmd)
self._proc.wait()
def killproc(self):
self._proc.kill()
if __name__ == '__main__':
win32serviceutil.HandleCommandLine(AppServerSvc)
```
Now in a command prompt type `C:\Windows\Python27\python.exe kms-winservice.py install` to install the service. Display all the services with `services.msc` and find the service associated with _py-kms_, change the startup type
from `manual` to `auto`. Finally `Start` the service. If this approach fails, you can try to use [Non-Sucking Service Manager](https://nssm.cc/) or Task Scheduler as described [here](https://blogs.esri.com/esri/arcgis/2013/07/30/scheduling-a-scrip/).
## Manual execution
***
### Dependencies
- Python 3.x.
- Tkinter module (for the GUI).
- If the `tzlocal` module is installed, the "Request Time" in the verbose output will be converted into local time. Otherwise, it will be in UTC.
- It can use the `sqlite3` module so you can use the database function, storing activation data so it can be recalled again.
- Installation example on Ubuntu / Mint:
- `sudo apt-get update`
- `sudo apt-get install python3-tk python3-pip`
- `sudo pip3 install tzlocal pysqlite3`
### Startup
A Linux user with `ip addr` command can get his KMS IP (Windows users can try `ipconfig /all`).
```bash
user@host ~ $ ip addr
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
inet 127.0.0.1/8 scope host lo
valid_lft forever preferred_lft forever
inet6 ::1/128 scope host
valid_lft forever preferred_lft forever
2: enp6s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel state UP group default qlen 1000
link/ether **:**:**:**:**:** brd ff:ff:ff:ff:ff:ff
inet 192.168.1.102/24 brd 192.168.1.255 scope global dynamic noprefixroute enp6s0
valid_lft 860084sec preferred_lft 860084sec
inet6 ****:****:****:****:****:****:****:****/64 scope global dynamic noprefixroute
valid_lft 6653sec preferred_lft 3052sec
inet6 ****::****:****:****:****/64 scope link noprefixroute
valid_lft forever preferred_lft forever
```
In the example above is `192.168.1.102` the ip we want to listen on, so it is this command (**note you can omit the ip AND port specification if you just wish to listen on all interfaces**):
```
user@host ~/path/to/folder/py-kms $ python3 pykms_Server.py 192.168.1.102 1688
```
To stop `pykms_Server.py`, in the same bash window where code running, simply press `CTRL+C`.
Alternatively, in a new bash window, use `kill <pid>` command (you can type `ps aux` first and have the process <pid>) or `killall <name_of_server>`.
#### Notes
The following are just some quick notes - for a more detailed list of parameters see [here](Usage.md).
- To generate a random HWID use `-w` option: `python3 pykms_Server.py -w RANDOM`.
- To get the HWID from any server use the client, for example type: `python3 pykms_Client.py :: 1688 -m Windows8.1 -V INFO`.
- To change your logfile path use `-F` option, for example: `python3 pykms_Server.py -F /path/to/your/logfile.log -V DEBUG`.
- To view a minimal set of logging information use `-V MINI` option, for example: `python3 pykms_Server.py -F /path/to/your/logfile.log -V MINI`.
- To redirect logging on stdout use `-F STDOUT` option, for example: `python3 pykms_Server.py -F STDOUT -V DEBUG`.
- You can create logfile and view logging information on stdout at the same time with `-F FILESTDOUT` option, for example: `python3 pykms_Server.py -F FILESTDOUT /path/to/your/logfile.log -V DEBUG`.
- With `-F STDOUTOFF` you disable all stdout messages (but a logfile will be created), for example: `python3 pykms_Server.py -F STDOUTOFF /path/to/your/logfile.log -V DEBUG`.
- With `-F FILEOFF` you disable logfile creation.
- Select timeout (seconds) for py-kms with `-t0` option, for example `python3 pykms_Server.py -t0 10`.
- Option `-y` enables printing asynchronously of messages (pretty / logging).

243
wiki/Windows-GVLK-Keys.md → docs/Keys.md
View File

@ -1,8 +1,15 @@
### _Windows Server 2019_
<table width="650" cellspacing="0" cellpadding="0">
# GVLK Keys
These are keys, which can be used to activate a product with _py-kms_ (note this keys are provided officially by Microsoft). _py-kms_ will not reject any of your keys, instead the product will often revalidate the given key - and
sometimes even reject it by itself (often due too many uses - in that case try to use an other one).
## Windows
***
### Windows Server 2019
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
@ -16,11 +23,11 @@
</tbody>
</table>
### _Windows Server 2016_
<table width="650" cellspacing="0" cellpadding="0">
### Windows Server 2016
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
@ -37,11 +44,11 @@
</tbody>
</table>
### _Windows 10_
<table width="650" cellspacing="0" cellpadding="0">
### Windows 10
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
@ -75,11 +82,11 @@
</tbody>
</table>
### _Windows Server 2012 R2_
<table width="650" cellspacing="0" cellpadding="0">
### Windows Server 2012 R2
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
@ -90,11 +97,11 @@
</tbody>
</table>
### _Windows 8.1_
<table width="650" cellspacing="0" cellpadding="0">
### Windows 8.1
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
@ -120,11 +127,11 @@
</tbody>
</table>
### _Windows Server 2012_
<table width="650" cellspacing="0" cellpadding="0">
### Windows Server 2012
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
@ -139,11 +146,11 @@
</tbody>
</table>
### _Windows 8_
<table width="650" cellspacing="0" cellpadding="0">
### Windows 8
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
@ -162,11 +169,11 @@
</tbody>
</table>
### _Windows Server 2008 R2_
<table width="650" cellspacing="0" cellpadding="0">
### Windows Server 2008 R2
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
@ -180,11 +187,11 @@
</tbody>
</table>
### _Windows 7_
<table width="650" cellspacing="0" cellpadding="0">
### Windows 7
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
@ -200,11 +207,11 @@
</tbody>
</table>
### _Windows Server 2008_
<table width="650" cellspacing="0" cellpadding="0">
### Windows Server 2008
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
@ -220,11 +227,11 @@
</tbody>
</table>
### _Windows Vista_
<table width="650" cellspacing="0" cellpadding="0">
### Windows Vista
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
@ -235,11 +242,11 @@
</tbody>
</table>
### _Windows Previews_
<table width="650" cellspacing="0" cellpadding="0">
### Windows Previews
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
@ -336,3 +343,143 @@
<tr><td>Windows Next Professional S N [Pre-Release]</td><td>?????-?????-?????-?????-?????</td></tr>
</tbody>
</table>
## Office
***
### Office 2019
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
<tr><td>Professional Plus 2019 [C2R]</td><td>VQ9DP-NVHPH-T9HJC-J9PDT-KTQRG</td></tr>
<tr><td>Professional Plus 2019</td><td>NMMKJ-6RK4F-KMJVX-8D9MJ-6MWKP</td></tr>
<tr><td>Standard 2019</td><td>6NWWJ-YQWMR-QKGCB-6TMB3-9D9HK</td></tr>
<tr><td>Project Professional 2019 [C2R]</td><td>XM2V9-DN9HH-QB449-XDGKC-W2RMW</td></tr>
<tr><td>Project Professional 2019</td><td>B4NPR-3FKK7-T2MBV-FRQ4W-PKD2B</td></tr>
<tr><td>Project Standard 2019</td><td>C4F7P-NCP8C-6CQPT-MQHV9-JXD2M</td></tr>
<tr><td>Visio Professional 2019 [C2R]</td><td>N2CG9-YD3YK-936X4-3WR82-Q3X4H </td></tr>
<tr><td>Visio Professional 2019</td><td>9BGNQ-K37YR-RQHF2-38RQ3-7VCBB</td></tr>
<tr><td>Visio Standard 2019</td><td>7TQNQ-K3YQQ-3PFH7-CCPPM-X4VQ2</td></tr>
<tr><td>Access 2019</td><td>9N9PT-27V4Y-VJ2PD-YXFMF-YTFQT</td></tr>
<tr><td>Excel 2019</td><td>TMJWT-YYNMB-3BKTF-644FC-RVXBD</td></tr>
<tr><td>Outlook 2019</td><td>7HD7K-N4PVK-BHBCQ-YWQRW-XW4VK</td></tr>
<tr><td>PowerPoint 2019</td><td>RRNCX-C64HY-W2MM7-MCH9G-TJHMQ</td></tr>
<tr><td>Publisher 2019</td><td>G2KWX-3NW6P-PY93R-JXK2T-C9Y9V</td></tr>
<tr><td>Skype for Business 2019</td><td>NCJ33-JHBBY-HTK98-MYCV8-HMKHJ</td></tr>
<tr><td>Word 2019</td><td>PBX3G-NWMT6-Q7XBW-PYJGG-WXD33</td></tr>
</tbody>
</table>
### Office 2016
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
<tr><td>Professional Plus 2016</td><td>XQNVK-8JYDB-WJ9W3-YJ8YR-WFG99</td></tr>
<tr><td>Standard 2016</td><td>JNRGM-WHDWX-FJJG3-K47QV-DRTFM</td></tr>
<tr><td>Project Professional 2016</td><td>YG9NW-3K39V-2T3HJ-93F3Q-G83KT</td></tr>
<tr><td>Project Professional 2016 [C2R]</td><td>WGT24-HCNMF-FQ7XH-6M8K7-DRTW9</td></tr>
<tr><td>Project Standard 2016</td><td>GNFHQ-F6YQM-KQDGJ-327XX-KQBVC</td></tr>
<tr><td>Project Standard 2016 [C2R]</td><td>D8NRQ-JTYM3-7J2DX-646CT-6836M</td></tr>
<tr><td>Visio Professional 2016</td><td>PD3PC-RHNGV-FXJ29-8JK7D-RJRJK</td></tr>
<tr><td>Visio Professional 2016 [C2R]</td><td>69WXN-MBYV6-22PQG-3WGHK-RM6XC</td></tr>
<tr><td>Visio Standard 2016</td><td>7WHWN-4T7MP-G96JF-G33KR-W8GF4</td></tr>
<tr><td>Visio Standard 2016 [C2R]</td><td>NY48V-PPYYH-3F4PX-XJRKJ-W4423</td></tr>
<tr><td>Access 2016</td><td>GNH9Y-D2J4T-FJHGG-QRVH7-QPFDW</td></tr>
<tr><td>Excel 2016</td><td>9C2PK-NWTVB-JMPW8-BFT28-7FTBF</td></tr>
<tr><td>Mondo 2016</td><td>HFTND-W9MK4-8B7MJ-B6C4G-XQBR2</td></tr>
<tr><td>Mondo Retail 2016</td><td>DMTCJ-KNRKX-26982-JYCKT-P7KB6</td></tr>
<tr><td>OneNote 2016</td><td>DR92N-9HTF2-97XKM-XW2WJ-XW3J6</td></tr>
<tr><td>Outlook 2016</td><td>R69KK-NTPKF-7M3Q4-QYBHW-6MT9B</td></tr>
<tr><td>PowerPoint 2016</td><td>J7MQP-HNJ4Y-WJ7YM-PFYGF-BY6C6</td></tr>
<tr><td>Publisher 2016</td><td>F47MM-N3XJP-TQXJ9-BP99D-8K837</td></tr>
<tr><td>Skype for Business 2016</td><td>869NQ-FJ69K-466HW-QYCP2-DDBV6</td></tr>
<tr><td>Word 2016</td><td>WXY84-JN2Q9-RBCCQ-3Q3J3-3PFJ6</td></tr>
</tbody>
</table>
### Office 2013
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
<tr><td>Professional Plus 2013 [Preview]</td><td>PGD67-JN23K-JGVWV-KTHP4-GXR9G</td></tr>
<tr><td>Professional Plus 2013</td><td>YC7DK-G2NP3-2QQC3-J6H88-GVGXT</td></tr>
<tr><td>Standard 2013</td><td>KBKQT-2NMXY-JJWGP-M62JB-92CD4</td></tr>
<tr><td>Project Professional 2013 [Preview]</td><td>NFKVM-DVG7F-TYWYR-3RPHY-F872K</td></tr>
<tr><td>Project Professional 2013</td><td>FN8TT-7WMH6-2D4X9-M337T-2342K</td></tr>
<tr><td>Project Standard 2013 [Preview]</td><td>N89QF-GGB8J-BKD28-C4V28-W4XTK</td></tr>
<tr><td>Project Standard 2013</td><td>6NTH3-CW976-3G3Y2-JK3TX-8QHTT</td></tr>
<tr><td>Visio Professional 2013 [Preview]</td><td>B3C7Q-D6NH2-2VRFW-HHWDG-FVQB6</td></tr>
<tr><td>Visio Professional 2013</td><td>C2FG9-N6J68-H8BTJ-BW3QX-RM3B3</td></tr>
<tr><td>Visio Standard 2013 [Preview]</td><td>9MKNF-J9XQ6-JV4XB-FJQPY-43F43</td></tr>
<tr><td>Visio Standard 2013</td><td>J484Y-4NKBF-W2HMG-DBMJC-PGWR7</td></tr>
<tr><td>Access 2013 [Preview]</td><td>DJBH8-RGN7Q-836KD-DMP3M-DM9MF</td></tr>
<tr><td>Access 2013</td><td>NG2JY-H4JBT-HQXYP-78QH9-4JM2D</td></tr>
<tr><td>Excel 2013 [Preview]</td><td>Q3BNP-3WXDT-GG8HF-24KMW-HMDBK</td></tr>
<tr><td>Excel 2013</td><td>VGPNG-Y7HQW-9RHP7-TKPV3-BG7GB</td></tr>
<tr><td>OneNote 2013 [Preview]</td><td>VYNYX-8GPBC-7FQMD-D6B7B-7MDFD</td></tr>
<tr><td>OneNote 2013</td><td>TGN6P-8MMBC-37P2F-XHXXK-P34VW</td></tr>
<tr><td>Outlook 2013 [Preview]</td><td>X2KNB-FRRG2-WXDPH-739DM-DM9RH</td></tr>
<tr><td>Outlook 2013</td><td>QPN8Q-BJBTJ-334K3-93TGY-2PMBT</td></tr>
<tr><td>PowerPoint 2013 [Preview]</td><td>B8CT8-BTNFQ-XQXBK-BFWV8-HMDFQ</td></tr>
<tr><td>PowerPoint 2013</td><td>4NT99-8RJFH-Q2VDH-KYG2C-4RD4F</td></tr>
<tr><td>Publisher 2013 [Preview]</td><td>NB67P-J8XP4-XDK9B-V73VH-M4CKR</td></tr>
<tr><td>Publisher 2013</td><td>PN2WF-29XG2-T9HJ7-JQPJR-FCXK4</td></tr>
<tr><td>InfoPath 2013 (Preview)</td><td>7KPJJ-N8TT7-CK3KR-QTV98-YPVXQ</td></tr>
<tr><td>InfoPath 2013</td><td>DKT8B-N7VXH-D963P-Q4PHY-F8894</td></tr>
<tr><td>Lync 2013 [Preview]</td><td>XNVD3-RYC7T-7R6BT-WX6CF-8BYH7</td></tr>
<tr><td>Lync 2013</td><td>2MG3G-3BNTT-3MFW9-KDQW3-TCK7R</td></tr>
<tr><td>Word 2013 [Preview]</td><td>JBGD4-3JNG7-JWWGV-CR6TP-DC62Q</td></tr>
<tr><td>Word 2013</td><td>6Q7VD-NX8JD-WJ2VH-88V73-4GBJ7</td></tr>
<tr><td>Mondo 2013 [Preview]</td><td>GCGCN-6FJRM-TR9Q3-BGMWJ-78KQV</td></tr>
<tr><td>Mondo 2013</td><td>42QTK-RN8M7-J3C4G-BBGYM-88CYV</td></tr>
<tr><td>Mondo 2013 Retail</td><td>?????-?????-?????-?????-?????</td></tr>
<tr><td>SharePoint Workspace (Groove) 2013 [Preview]</td><td>WVCGG-NK4FG-7XKXM-BD4WF-3C624</td></tr>
<tr><td>SharePoint Workspace (Groove) 2013</td><td>H7R7V-WPNXQ-WCYYC-76BGV-VT7GH</td></tr>
<tr><td>SharePoint Designer (Frontpage) 2013 Retail [Preview]</td><td>?????-?????-?????-?????-?????</td></tr>
<tr><td>SharePoint Designer (Frontpage) 2013 Retail</td><td>GYJRG-NMYMF-VGBM4-T3QD4-842DW</td></tr>
</tbody>
</table>
### Office 2010
<table width="100%" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="50%">
<col span="1" width="50%">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
<tr><td>Professional Plus 2010</td><td>VYBBJ-TRJPB-QFQRF-QFT4D-H3GVB</td></tr>
<tr><td>Standard 2010</td><td>V7QKV-4XVVR-XYV4D-F7DFM-8R6BM</td></tr>
<tr><td>Project Professional 2010</td><td>YGX6F-PGV49-PGW3J-9BTGG-VHKC6</td></tr>
<tr><td>Project Standard 2010</td><td>4HP3K-88W3F-W2K3D-6677X-F9PGB</td></tr>
<tr><td>Visio Professional 2010</td><td>7MCW8-VRQVK-G677T-PDJCM-Q8TCP</td></tr>
<tr><td>Visio Standard 2010</td><td>767HD-QGMWX-8QTDB-9G3R2-KHFGJ</td></tr>
<tr><td>Visio Premium 2010</td><td>D9DWC-HPYVV-JGF4P-BTWQB-WX8BJ</td></tr>
<tr><td>Access 2010</td><td>V7Y44-9T38C-R2VJK-666HK-T7DDX</td></tr>
<tr><td>Excel 2010</td><td>H62QG-HXVKF-PP4HP-66KMR-CW9BM</td></tr>
<tr><td>OneNote 2010</td><td>Q4Y4M-RHWJM-PY37F-MTKWH-D3XHX</td></tr>
<tr><td>Outlook 2010</td><td>7YDC2-CWM8M-RRTJC-8MDVC-X3DWQ</td></tr>
<tr><td>PowerPoint 2010</td><td>RC8FX-88JRY-3PF7C-X8P67-P4VTT</td></tr>
<tr><td>Publisher 2010</td><td>BFK7F-9MYHM-V68C7-DRQ66-83YTP</td></tr>
<tr><td>InfoPath 2010</td><td>K96W8-67RPQ-62T9Y-J8FQJ-BT37T</td></tr>
<tr><td>SharePoint Workspace (Groove) 2010</td><td>QYYW6-QP4CB-MBV6G-HYMCJ-4T3J4</td></tr>
<tr><td>Word 2010</td><td>HVHB3-C6FV7-KQX9W-YQG79-CRY7T</td></tr>
<tr><td>Small Business Basics 2010</td><td>D6QFG-VBYP2-XQHM7-J97RH-VVRCK</td></tr>
<tr><td>Starter 2010 Retail</td><td>VXHHB-W7HBD-7M342-RJ7P8-CHBD6</td></tr>
<tr><td>SharePoint Designer (Frontpage) 2010 Retail</td><td>H48K6-FB4Y6-P83GH-9J7XG-HDKKX</td></tr>
<tr><td>Office Mondo 1 2010</td><td>YBJTT-JG6MD-V9Q7P-DBKXJ-38W9R</td></tr>
<tr><td>Office Mondo 2 2010</td><td>7TC2V-WXF6P-TD7RT-BQRXR-B8K32</td></tr>
</tbody>
</table>

177
docs/Makefile Normal file
View File

@ -0,0 +1,177 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ReadtheDocsTemplate.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ReadtheDocsTemplate.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/ReadtheDocsTemplate"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ReadtheDocsTemplate"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

238
docs/Usage.md Normal file
View File

@ -0,0 +1,238 @@
# Usage
## Start Parameters
***
### pykms_Server.py
Follows a list of usable parameters:
ip <IPADDRESS>
> Instructs py-kms to listen on _IPADDRESS_ (can be an hostname too). If this option is not specified, _IPADDRESS_ 0.0.0.0 is used.
port <PORT>
> Define TCP _PORT_ the KMS service is listening on. Default is 1688.
-e or --epid <EPID>
> Enhanced Privacy ID (_EPID_) is a cryptographic scheme for providing anonymous signatures.
Use _EPID_ as Windows _EPID_. If no _EPID_ is specified, a random one will be generated.
-l or --lcid <LCID>
> Do not randomize the locale ID part of the _EPID_ and use _LCID_ instead.
The Language Code Identifier (_LCID_) describes localizable information in Windows.
This structure is used to identify specific languages for the purpose of customizing
software for particular languages and cultures. For example, it can specify the way dates,
times, and numbers are formatted as strings. It can also specify paper sizes and preferred sort order based on language elements.
The _LCID_ must be specified as a decimal number (example: 1049 for "Russian - Russia").
By default py-kms generates a valid locale ID but this may lead to a value which is unlikely to occur in your country.
You may want to select the locale ID of your country instead.
See [here](https://msdn.microsoft.com/en-us/library/cc233982.aspx) for a list of valid _LCIDs_.
If an _EPID_ is manually specified, this setting is ignored. Default is a fixed _LCID_ of 1033 (English - US).
-w or --hwid <HWID>
> Use specified _HWID_ for all products.
Hardware Identification is a security measure used by Microsoft upon the activation of
the Windows operating system. As part of the Product Activation system, a unique
HWID number is generated when the operating system is first installed. The _HWID_ identifies the hardware components that the system
is utilizing, and this number is communicated to Microsoft.
Every 10 days and at every reboot the operating system will generate another _HWID_ number and compare it to the original
to make sure that the operating system is still running on the same device.
If the two _HWID_ numbers differ too much then the operating system will shut down until Microsoft reactivates the product.
The theory behind _HWID_ is to ensure that the operating system is not being used on any device other than the one
for which it was purchased and registered.
HWID must be an 16-character string of hex characters that are interpreted as a series of 8 bytes (big endian).
Default is _364F463A8863D35F_. To auto generate the _HWID_, type `-w RANDOM`.
-c or --client-count <CLIENTCOUNT>
> Use this flag to specify the current _CLIENTCOUNT_. Default is None. Remember that a number >=25 is
required to enable activation of client OSes while for server OSes and Office >=5.
-a or --activation-interval <ACTIVATIONINTERVAL>
> Instructs clients to retry activation every _ACTIVATIONINTERVAL_ minutes if it was unsuccessful,
e.g. because it could not reach the server. The default is 120 minutes (2 hours).
-r or --renewal-interval <RENEWALINTERVAL>
> Instructs clients to renew activation every _RENEWALINTERVAL_ minutes. The default is 10080 minutes (7 days).
-s or --sqlite
> Use this option to store request information from unique clients in an SQLite database.
-t0 or --timeout-idle <TIMEOUT>
> Maximum inactivity time (in seconds) after which the connection with the client is closed.
Default setting is serve forever (no timeout).
-y or --async-msg
> With high levels of logging (e.g hundreds of log statements), in a traditional synchronous log model,
the overhead involved becomes more expensive, so using this option you enable printing (pretty / logging) messages
asynchronously reducing time-consuming. Desactivated by default.
-V or --loglevel <{CRITICAL, ERROR, WARNING, INFO, DEBUG, MINI}>
> Use this flag to set a logging loglevel. The default is _ERROR_.
example:
```
user@host ~/path/to/folder/py-kms $ python3 pykms_Server.py -V INFO
```
creates _pykms_logserver.log_ with these initial messages:
```
Mon, 12 Jun 2017 22:09:00 INFO TCP server listening at 0.0.0.0 on port 1688.
Mon, 12 Jun 2017 22:09:00 INFO HWID: 364F463A8863D35F
```
-F or --logfile <LOGFILE>
> Creates a _LOGFILE.log_ logging file. The default is named _pykms_logserver.log_.
example:
```
user@user ~/path/to/folder/py-kms $ python3 pykms_Server.py 192.168.1.102 8080 -F ~/path/to/folder/py-kms/newlogfile.log -V INFO -w RANDOM
```
creates _newlogfile.log_ with these initial messages:
```
Mon, 12 Jun 2017 22:09:00 INFO TCP server listening at 192.168.1.102 on port 8080.
Mon, 12 Jun 2017 22:09:00 INFO HWID: 58C4F4E53AE14224
```
You can also enable other suboptions of `-F` doing what is reported in the following table:
<table style="width: 100%;">
<thead>
<tr>
<th>command</th>
<th>pretty msg</th>
<th>logging msg</th>
<th>logfile</th>
</tr>
</thead>
<tbody>
<tr>
<td><pre>-F &lt;logfile&gt;</pre></td>
<td>ON</td>
<td>OFF</td>
<td>ON</td>
</tr>
<tr>
<td><pre>-F STDOUT</pre></td>
<td>OFF</td>
<td>ON</td>
<td>OFF</td>
</tr>
<tr>
<td><pre>-F FILESTDOUT &lt;logfile&gt;</pre></td>
<td>OFF</td>
<td>ON</td>
<td>ON</td>
</tr>
<tr>
<td><pre>-F STDOUTOFF &lt;logfile&gt;</pre></td>
<td>OFF</td>
<td>OFF</td>
<td>ON</td>
</tr>
<tr>
<td><pre>-F FILEOFF</pre></td>
<td>ON</td>
<td>OFF</td>
<td>OFF</td>
</tr>
</tbody>
</table>
-S or --logsize <MAXSIZE>
> Use this flag to set a maximum size (in MB) to the output log file. Desactivated by default.
### pykms_Client.py
If _py-kms_ server doesn't works correctly, you can test it with the KMS client `pykms_Client.py`, running on the same machine where you started `pykms_Server.py`.
For example (in separated bash windows) run these commands:
```
user@host ~/path/to/folder/py-kms $ python3 pykms_Server.py -V DEBUG
user@host ~/path/to/folder/py-kms $ python3 pykms_Client.py 0.0.0.0 1688 -V DEBUG
```
Or if you want better specify:
```
user@host ~/path/to/folder/py-kms $ python3 pykms_Server.py <YOUR_IPADDRESS> 1688 -V DEBUG
user@host ~/path/to/folder/py-kms $ python3 pykms_Client.py <YOUR_IPADDRESS> 1688 -V DEBUG
```
You can also put further parameters as defined below:
ip <IPADDRESS>
> Define _IPADDRESS_ (or hostname) of py-kms' KMS Server. This parameter is always required.
port <PORT>
> Define TCP _PORT_ the KMS service is listening on. Default is 1688.
-m or --mode <{WindowsVista, Windows7, Windows8, Windows8.1, Windows10, Office2010, Office2013, Office2016, Office2019}>
> Use this flag to manually specify a Microsoft _PRODUCTNAME_ for testing the KMS server. Default is Windows8.1.
-c or --cmid <CMID>
> Use this flag to manually specify a CMID to use. If no CMID is specified, a random one will be generated.
The Microsoft KMS host machine identifies KMS clients with a unique Client Machine ID
(CMID, example: ae3a27d1-b73a-4734-9878-70c949815218). For a KMS client to successfully activate, the KMS server
needs to meet a threshold, which is a minimum count for KMS clients.
Once a KMS server records a count which meets or exceeds threshold, KMS clients will begin to activate successfully.
Each unique CMID recorded by KMS server adds towards the count threshold for KMS clients. This are retained by the KMS server
for a maximum of 30 days after the last activation request with that CMID. Note that duplicate CMID only impacts on KMS server
machine count of client machines. Once KMS server meets minimum threshold, KMS clients will
activate regardless of CMID being unique for a subset of specific machines or not.
-n or --name <MACHINENAME>
> Use this flag to manually specify an ASCII _MACHINENAME_ to use. If no _MACHINENAME_ is specified a random one will be generated.
-y or --async-msg
> Prints pretty / logging messages asynchronously. Desactivated by default.
-V or --loglevel <{CRITICAL, ERROR, WARNING, INFO, DEBUG, MINI}>
> Use this flag to set a logging loglevel. The default is _ERROR_.
-F or --logfile <LOGFILE>
> Creates a _LOGFILE.log_ logging file. The default is named _pykms_logclient.log_.
You can enable same _pykms_Server.py_ suboptions of `-F`.
-S or --logsize <MAXSIZE>
> Use this flag to set a maximum size (in MB) to the output log file. Desactivated by default.
## Activation Procedure
Briefly the product asks for a key during installation, so it needs you to enter the GVLK. Then the user can set connection parameters, while KMS server must already be running on server machine. Finally with specific
commands activation occurs automatically and can be extended later every time for another 180 (or 30 or 45) days.
### Windows
***
The `//nologo` option of `cscript` was used only to hide the startup logo.
![win1](img/win1.png)
![win2](img/win2.png)
0. Run a Command Prompt as Administrator (you are directly in `C:\Windows\System32` path).
1. This is optional, it's for unistalling any existing product key.
2. Then put in your product's GVLK.
3. Set connection parameters...
4. Try online activation, but... if that fails with error `0xC004F074` you’ll most likely have to configure your firewall that it accepts incoming connections on TCP port 1688. So for Linux users (server-side with `pykms_Server.py`
running): `sudo ufw allow 1688` (to remove this rule `sudo ufw delete allow 1688`)
5. Attempt online activation (now with traffic on 1688 enabled).
6. View license informations (optional).
### Office
***
Note that you’ll have to install a volume license (VL) version of Office. Office versions downloaded from MSDN and / or Technet are non-VL.
![off1](img/off1.png)
![off2](img/off2.png)
![off3](img/off3.png)
![off4](img/off4.png)
0. Run a Command Prompt as Administrator and navigate to Office folder `cd C:\ProgramFiles\Microsoft Office\OfficeXX` (64-bit path) or `cd C:\ProgramFiles(x86)\Microsoft Office\OfficeXX` (32-bit path), where XX = `14` for Office 2010,
`15` for Office 2013, `16` for Office 2016 or Office 2019.
1. As you can see, running `/dstatus`, my Office is expiring (14 days remaining).
2. Only for example, let's go to uninstall this product.
3. This is confirmed running `/dstatus` again.
4. Now i put my product's GVLK (and you your key).
5. Set the connection parameter KMS server address.
6. Set the connection parameter KMS server port.
7. Activate installed Office product key.
8. View license informations (in my case product is now licensed and remaining grace 180 days as expected).
## Supported Products
Note that it is possible to activate all versions in the VL (Volume License) channel, so long as you provide the proper key to let Windows know that it should be activating against a KMS server. KMS activation can't be used for
Retail channel products, however you can install a VL product key specific to your edition of Windows even if it was installed as Retail. This effectively converts Retail installation to VL channel and will allow you to activate
from a KMS server. **However, this is not valid for Office's products**, so Office, Project and Visio must be always volume license versions. Newer version may work as long as the KMS protocol does not change...

1
docs/changelog.md Symbolic link
View File

@ -0,0 +1 @@
../CHANGELOG.md

261
docs/conf.py Normal file
View File

@ -0,0 +1,261 @@
# -*- coding: utf-8 -*-
#
# Read the Docs Template documentation build configuration file, created by
# sphinx-quickstart on Tue Aug 26 14:19:49 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['recommonmark', 'sphinx_markdown_tables']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
}
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'py-kms'
copyright = u'2020, SystemRage'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'py-kms'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'py-kms.tex', u'py-kms Documentation',
u'SystemRage', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'py-kms', u'py-kms Documentation',
[u'SystemRage'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'py-kms', u'py-kms Documentation',
u'SystemRage', 'py-kms', 'KMS Server Emulator written in Python',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False

BIN
docs/img/off1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

BIN
docs/img/off2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

BIN
docs/img/off3.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 33 KiB

BIN
docs/img/off4.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 39 KiB

BIN
docs/img/win1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 44 KiB

BIN
docs/img/win2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 44 KiB

10
docs/index.rst Normal file
View File

@ -0,0 +1,10 @@
Welcome to the py-kms documentation!
==================================================
Contents:
.. toctree::
:maxdepth: 2
:glob:
*

242
docs/make.bat Normal file
View File

@ -0,0 +1,242 @@
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. xml to make Docutils-native XML files
echo. pseudoxml to make pseudoxml-XML files for display purposes
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
%SPHINXBUILD% 2> nul
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\complexity.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\complexity.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdf" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdfja" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf-ja
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
if "%1" == "xml" (
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The XML files are in %BUILDDIR%/xml.
goto end
)
if "%1" == "pseudoxml" (
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
goto end
)
:end

1
docs/readme.md Symbolic link
View File

@ -0,0 +1 @@
../README.md

44
docs/requirements.txt Normal file
View File

@ -0,0 +1,44 @@
alabaster==0.7.12
appdirs==1.4.4
Babel==2.8.0
CacheControl==0.12.6
certifi==2020.4.5.1
chardet==3.0.4
colorama==0.4.3
commonmark==0.9.1
contextlib2==0.6.0
distlib==0.3.0
distro==1.5.0
docutils==0.16
html5lib==1.0.1
idna==2.9
imagesize==1.2.0
Jinja2==2.11.2
lockfile==0.12.2
Markdown==3.2.2
MarkupSafe==1.1.1
msgpack==1.0.0
ordered-set==4.0.1
packaging==20.4
pep517==0.8.2
progress==1.5
Pygments==2.6.1
pyparsing==2.4.7
pytoml==0.1.21
pytz==2020.1
recommonmark==0.6.0
requests==2.23.0
retrying==1.3.3
six==1.15.0
snowballstemmer==2.0.0
Sphinx==3.1.2
sphinx-markdown-tables==0.0.15
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==1.0.3
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.4
toml==0.10.1
urllib3==1.25.9
webencodings==0.5.1

40
wiki/Home.md
View File

@ -1,40 +0,0 @@
Welcome to the _py-kms_ wiki !!
## How To Use
- [User Manual](https://github.com/SystemRage/py-kms/wiki/Manual)
- [Understanding KMS](https://github.com/SystemRage/py-kms/wiki/Manual#understanding-key-management-service)
- [About GVLK Keys](https://github.com/SystemRage/py-kms/wiki/Manual#about-gvlk-keys)
- [SLMGR and OSPP](https://github.com/SystemRage/py-kms/wiki/Manual#slmgr-and-ospp-commands)
- [Usage](https://github.com/SystemRage/py-kms/wiki/Manual#py-kms-usage)
- [Manual Start](https://github.com/SystemRage/py-kms/wiki/Manual#how-to-run-pykms_serverpy-manually)
- [Auto Start](https://github.com/SystemRage/py-kms/wiki/Manual#how-to-run-pykms_serverpy-automatically-at-start)
- [Server Options](https://github.com/SystemRage/py-kms/wiki/Manual#pykms_serverpy-options)
- [Client Options](https://github.com/SystemRage/py-kms/wiki/Manual#pykms_clientpy-options)
- [Activation Procedure](https://github.com/SystemRage/py-kms/wiki/Manual#activation-procedure)
- [Windows](https://github.com/SystemRage/py-kms/wiki/Manual#windows)
- [Office](https://github.com/SystemRage/py-kms/wiki/Manual#office)
- [Supported Products](https://github.com/SystemRage/py-kms/wiki/Manual#supported-products)
- [Documentation](https://github.com/SystemRage/py-kms/wiki/Manual#documentation)
## GVLK Keys
- [Windows GVLK Keys](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys)
- [Windows Server 2019](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys#windows-server-2019)
- [Windows Server 2016](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys#windows-server-2016)
- [Windows 10](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys#windows-10)
- [Windows Server 2012 R2](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys#windows-server-2012-r2)
- [Windows 8.1](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys#windows-81)
- [Windows Server 2012](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys#windows-server-2012)
- [Windows 8](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys#windows-8)
- [Windows Server 2008 R2](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys#windows-server-2008-r2)
- [Windows 7](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys#windows-7)
- [Windows Server 2008](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys#windows-server-2008)
- [Windows Vista](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys#windows-vista)
- [Windows Previews](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys#windows-previews)
- [Office GVLK Keys](https://github.com/SystemRage/py-kms/wiki/Office-GVLK-Keys)
- [Office 2019](https://github.com/SystemRage/py-kms/wiki/Office-GVLK-Keys#office-2019)
- [Office 2016](https://github.com/SystemRage/py-kms/wiki/Office-GVLK-Keys#office-2016)
- [Office 2013](https://github.com/SystemRage/py-kms/wiki/Office-GVLK-Keys#office-2013)
- [Office 2010](https://github.com/SystemRage/py-kms/wiki/Office-GVLK-Keys#office-2010)

662
wiki/Manual.md
View File

@ -1,662 +0,0 @@
## Understanding Key Management Service
KMS activates Microsoft products on a local network, eliminating the need for individual computers to connect to Microsoft. To do this, KMS uses a client–server topology. KMS client locate KMS server by using DNS or a static configuration, then contact it by using Remote Procedure Call (RPC) and tries to activate against it.
KMS can activate both physical computers and virtual machines, but a network must meet or exceed the activation threshold (minimum number of computers that KMS requires). For activation, KMS clients on the network need to install a KMS client key (General Volume License Key, GVLK), so the product no longer asks Microsoft server but a user–defined server (the KMS server) which usually resides in a company’s intranet.
_py-kms_ is a free open source KMS server emulator written in python, while Microsoft gives their KMS server only to corporations that signed a Select contract. Furthermore _py-kms_ never refuses activation since is without restrictions, while the Microsoft KMS server only activates the products the customer has paid for.
_py-kms_ supports KMS protocol versions 4, 5 and 6.
Although _py-kms_ does neither require an activation key nor any payment, it is not meant to run illegal copies of Windows. Its purpose is to ensure that owners of legal copies can use their software without restrictions,
e.g. if you buy a new computer or motherboard and your key will be refused activation from Microsoft servers due to hardware changes.
Activation with _py-kms_ is achieved with the following steps:
1. Run _py-kms_ on a computer in the network (this is KMS server or local host).
2. Install the product on client (or said remote host, which is the computer sending data to local host) and enter the GVLK.
3. Configure the client to use the KMS server.
Note that KMS activations are valid for 180 days, the activation validity interval, or 30 / 45 days with consumer-only products. To remain activated, KMS client computers must renew their activation by connecting to the KMS server at least once every 180 days.
For this to work, should be to guarantee that a KMS server is always reachable for the clients on the network.
To remember you can't activate Windows 8.1 (and above) on a KMS server hosted on the same machine (the KMS server must be a different computer than the client).
## About GVLK keys
The GVLK keys for products sold via volume license contracts (renewal every 180 days) are published on Microsoft’s Technet web site.
* Windows: https://technet.microsoft.com/en-us/library/jj612867.aspx
* Office 2010: https://technet.microsoft.com/en-us/library/ee624355(v=office.14).aspx#section2_3
* Office 2013: https://technet.microsoft.com/en-us/library/dn385360.aspx
* Office 2016: https://technet.microsoft.com/it-it/library/dn385360(v=office.16).aspx
There are also not official keys for consumer-only versions of Windows that require
activation renewal every 45 days (Windows 8.1) or 30 days (Windows 8).
More complete and well defined lists are available [here](https://github.com/SystemRage/py-kms/wiki/Windows-GVLK-Keys) and [here](https://github.com/SystemRage/py-kms/wiki/Office-GVLK-Keys).
## SLMGR and OSPP commands
The software License Manager (```slmgr.vbs```) is a Visual Basic script used to configure and retrieve Volume Activation information. The script can be run locally or remotely on the target computer, using the Windows-based script host (```wscript.exe```) or the command-based script host (```cscript.exe```), and administrators can specify which script engine to use. If no script engine is specified, SLMGR runs using the default script engine (note: it's recommended the cscript.exe script engine that resides in the system32 directory).
The Software Licensing Service must be restarted for any changes to take effect. To restart it, can be used the Microsoft Management Console (MMC) Services or running the following command:
```net stop sppsvc && net start sppsvc```
The _SLMGR_ requires at least one parameter. If the script is run without any parameters, it displays Help information. The general syntax of ```slmgr.vbs``` is as follows (using the ```cscript.exe``` as the script engine):
```
cscript slmgr.vbs /parameter
cscript slmgr.vbs [ComputerName] [User] [Password] [Option]
```
where command line options are:
```
[ComputerName] Name of a remote computer (default is local computer).
[User] Account with the required privilege on the remote computer.
[Password] Password for the account with required privileges on the remote compute.
[Option] Options are shown in the table below.
```
Following tables lists _SLMGR_ more relevant options and a brief description of each. Most of the parameters configure the KMS host.
<table width="700" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="250">
<col span="1" width="450">
</colgroup>
<thead><tr><th>Global options</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td>/ipk <<i>ProductKey</i>></td>
<td>Attempts to install a 5×5 <i>ProductKey</i> for Windows or other application identified by the <i>ProductKey</i>. If the key is valid, this is installed. If a key is already installed, it's silently replaced.</td>
</tr>
<tr>
<td>/ato [<i>ActivationID</i>]</td>
<td>Prompts Windows to attempt online activation, for retail and volume systems with KMS host key. Specifying the <i>ActivationID</i> parameter isolates the effects of the option to the edition associated with that value.</td>
</tr>
<tr>
<td>/dli [<i>ActivationID</i> | <i>All</i>]</td>
<td>Display license information. Specifying the <i>ActivationID</i> parameter displays the license information for the specified edition associated with that <i>ActivationID</i>. Specifying <i>All</i> will display all applicable installed products’ license information. Useful for retrieve the current KMS activation count from the KMS host.</td>
</tr>
<tr>
<td>/dlv [<i>ActivationID</i> | <i>All</i>]</td>
<td>Display detailed license information.</td>
</tr>
<tr>
<td>/xpr [<i>ActivationID</i>]</td>
<td>Display the activation expiration date for the current license state.</td>
</tr>
</tbody>
</table>
<table width="700" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="250">
<col span="1" width="450">
</colgroup>
<thead><tr><th>Advanced options</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td>/cpky</td>
<td>Some servicing operations require the product key to be available in the registry during Out-of-Box Experience (OOBE) operations. So this option removes the product key from the registry to prevent from being stolen by malicious code.</td>
</tr>
<tr>
<td>/ilc <<i>LicenseFile</i>></td>
<td>Installs the <i>LicenseFile</i> specified by the required parameter.</td>
</tr>
<tr>
<td>/rilc</td>
<td>Reinstalls all licenses stored in <i>%SystemRoot%\system32\oem</i> and <i>%SystemRoot%\System32\spp\tokens</i>.</td>
</tr>
<tr>
<td>/rearm</td>
<td>Resets the activation timers.</td>
</tr>
<tr>
<td>/rearm-app <<i>ApplicationID</i>></td>
<td>Resets the licensing status of the specified application.</td>
</tr>
<tr>
<td>/rearm-sku <<i>ApplicationID</i>></td>
<td>Resets the licensing status of the specified <i>SKU</i>.</td>
</tr>
<tr>
<td>/upk [<i>ActivationID</i>]</td>
<td>Uninstalls the product key of the current Windows edition. After a restart, the system will be in an unlicensed state unless a new product key is installed.</td>
</tr>
<tr>
<td>/dti [<i>ActivationID</i>]</td>
<td>Displays installation ID for offline activation of the KMS host for Windows (default) or the application that is identified when its <i>ActivationID</i> is provided.</td>
</tr>
<tr>
<td>/atp [<i>ConfirmationID</i>][<i>ActivationID</i>]</td>
<td>Activate product with user-provided <i>ConfirmationID</i>.</td>
</tr>
</tbody>
</table>
<table width="750" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="250">
<col span="1" width="450">
</colgroup>
<thead><tr><th>KMS client options</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td>/skms <<i>Name</i>[:<i>Port</i>] | : <i>port</i>> [<i>ActivationID</i>]</td>
<td>Specifies the name and the port of the KMS host computer to contact. Setting this value disables auto-detection of the KMS host. If the KMS host uses IPv6 only, the address must be specified in the format [<i>hostname</i>]:<i>port</i>.</td>
</tr>
<tr>
<td>/skms-domain <<i>FQDN</i>> [<i>ActivationID</i>]</td>
<td>Sets the specific DNS domain in which all KMS SRV records can be found. This setting has no effect if the specific single KMS host is set with the /skms option. Use this option, especially in disjoint namespace environments, to force KMS to ignore the DNS suffix search list and look for KMS host records in the specified DNS domain instead. </td>
</tr>
<tr>
<td>/ckms [<i>ActivationID</i>]</td>
<td>Removes the specified KMS hostname, address, and port information from the registry and restores KMS auto-discovery behavior.</td>
</tr>
<tr>
<td>/skhc</td>
<td>Enables KMS host caching (default), which blocks the use of DNS priority and weight after the initial discovery of a working KMS host. If the system can no longer contact the working KMS host, discovery will be attempted again.</td>
</tr>
<tr>
<td>/ckhc</td>
<td>Disables KMS host caching. This setting instructs the client to use DNS auto-discovery each time it attempts KMS activation (recommended when using priority and weight).</td>
</tr>
<tr>
<td>/sai <<i>ActivationInterval</i>></td>
<td>Changes how often a KMS client attempts to activate itself when it cannot find a KMS host. Replace <i>ActivationInterval</i> with a number of minutes between 15 minutes an 30 days. The default setting is 120.</td>
</tr>
<tr>
<td>/sri <<i>RenewalInterval</i>></td>
<td>Changes how often a KMS client attempts to renew its activation by contacting a KMS host. Replace <i>RenewalInterval</i> with a number of minutes between 15 minutes an 30 days. The default setting is 10080 (7 days).</td>
</tr>
<tr>
<td>/sprt <<i>PortNumber</i>></td>
<td>Sets the TCP communications port on a KMS host. It replaces PortNumber with the TCP port number to use. The default setting is 1688.</td>
</tr>
<tr>
<td>/sdns</td>
<td>Enables automatic DNS publishing by the KMS host.</td>
</tr>
<tr>
<td>/cdns</td>
<td>Disables automatic DNS publishing by a KMS host.</td>
</tr>
<tr>
<td>/spri</td>
<td>Sets the priority of KMS host processes to <i>Normal</i>.</td>
</tr>
<tr>
<td>/cpri</td>
<td>Set the KMS priority to <i>Low</i>.</td>
</tr>
<tr>
<td>/act-type [<i>ActivationType</i>] [<i>ActivationID<i/>]</td>
<td>Sets a value in the registry that limits volume activation to a single type. <i>ActivationType</i> 1 limits activation to active directory only; 2 limits it to KMS activation; 3 to token-based activation. The 0 option allows any activation type and is the default value.</td>
</tr>
</tbody>
</table>
The Office Software Protection Platform script (```ospp.vbs```) can help you to configure and test volume license editions of Office client products.
You must open a command prompt by using administrator permissions and navigate to the folder that contains the script. The script is located in the folder of Office installation (```\Office14``` for Office 2010, ```\Office15``` for Office 2013, ```\Office16``` for Office 2016):
```%installdir%\Program Files\Microsoft Office\Office15```.
If you are running 32-bit Office on a 64-bit operating system, the script is located in the folder:
```%installdir%\Program Files (x86)\Microsoft Office\Office15```.
Running _OSPP_ requires the ```cscript.exe``` script engine. To see the Help file, type the following command, and then press ENTER:
```cscript ospp.vbs /?```.
The general syntax is as follows:
```cscript ospp.vbs [Option:Value] [ComputerName] [User] [Password]```,
where command line options are:
```
[Option:Value] Specifies the option and Value to use to activate a product, install or uninstall a product key, install and display license information, set KMS host name and port, and remove KMS host. The options and values are listed in the tables below.
[ComputerName] Name of the remote computer. If a computer name is not provided, the local computer is used.
[User] Account that has the required permission on the remote computer.
[Password] Password for the account. If a user account and password are not provided, the current credentials are used.
```
<table width="750" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="250">
<col span="1" width="450">
</colgroup>
<thead><tr><th>Global options</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td>/act</td>
<td>Activates installed Office product keys.</td>
</tr>
<tr>
<td>/inpkey:<<i>ProductKey</i>></td>
<td>Installs a <i>ProductKey</i> (replaces existing key) with a user-provided <i>ProductKey</i>.</td>
</tr>
<tr>
<td>/unpkey:<<i>ProductKey</i>></td>
<td>Uninstalls an installed <i>ProductKey</i> with the last five digits of the <i>ProductKey</i> to uninstall (as displayed by the /dstatus option).</td>
</tr>
<tr>
<td>/inslic:<<i>LicenseFile</i>></td>
<td>Installs a <i>LicenseFile</i> with user-provided path of the .xrm-ms license.</td>
</tr>
<tr>
<td>/dstatus</td>
<td>Displays license information for installed product keys.</td>
</tr>
<tr>
<td>/dstatusall</td>
<td>Displays license information for all installed licenses.</td>
</tr>
<tr>
<td>/dhistoryacterr</td>
<td>Displays the failure history for MAK / Retail activation.</td>
</tr>
<tr>
<td>/dinstid</td>
<td>Displays Installation ID for offline activation.</td>
</tr>
<tr>
<td>/actcid:<<i>ConfirmationID</i>></td>
<td>Activates product with user-provided <i>ConfirmationID</i>.</td>
</tr>
<tr>
<td>/rearm</td>
<td>Resets the licensing status for all installed Office product keys.</td>
</tr>
<tr>
<td>/rearm:<<i>ApplicationID</i>></td>
<td>Resets the licensing status for an Office license with a user-provided <i>SKUID</i> value. Use this option with the <i>SKUID</i> value specified by using the /dstatus option if you have run out of rearms and have activated Office through KMS or Active Directory-based activation to gain an additional rearm.</td>
</tr>
<tr>
<td>/ddescr:<<i>ErrorCode</i>></td>
<td>Displays the description for a user-provided <i>ErrorCode</i>.</td>
</tr>
</tbody>
</table>
<table width="750" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="250">
<col span="1" width="450">
</colgroup>
<thead><tr><th>KMS client options</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td>/dhistorykms</td>
<td>Displays KMS client activation history.</td>
</tr>
<tr>
<td>/dcmid</td>
<td>Displays KMS client computer ID (CMID)</td>
</tr>
<tr>
<td>/sethst:<<i>HostName</i>></td>
<td>Sets a KMS host name with a user-provided <i>HostName</i>.</td>
</tr>
<tr>
<td>/setprt:<<i>Port</i>></td>
<td>Sets a KMS port with a user-provided <i>Port</i> number.</td>
</tr>
<tr>
<td>/remhst</td>
<td>Removes KMS hostname (sets port to default).</td>
</tr>
<tr>
<td>/cachst:<<i>Value</i>></td>
<td>Allows or denies KMS host caching. Parameter <i>Value</i> can be TRUE or FALSE.</td>
</tr>
<tr>
<td>/actype:<<i>Value</i>></td>
<td>(Windows 8 and later only) Sets volume activation type. Parameter <i>Value</i> can be: 1 (for Active Directory-based), 2 (for KMS), 0 (for both).</td>
</tr>
<tr>
<td>/skms-domain:<<i>Value</i>></td>
<td>(Windows 8 and later only) Sets the specific DNS domain in which all KMS SRV records can be found. This setting has no effect if the specific single KMS host is set by the /sethst option. Parameter <i>Value</i> is the Fully Qualified Domain Name (FQDN).</td>
</tr>
<tr>
<td>/ckms-domain</td>
<td>(Windows 8 and later only) Clears the specific DNS domain in which all KMS SRV records can be found. The specific KMS host is used if it is set by the /sethst option. Otherwise, auto-discovery of the KMS host is used.</td>
</tr>
</tbody>
</table>
## py-kms Usage
#### _How to run pykms_Server.py manually_.
***
A Linux user with ```ifconfig``` command can get his KMS IP (Windows users can try ```ipconfig /all```).
```
user@user ~ $ ifconfig
eth0 Link encap: Ethernet HWaddr xx:xx:xx:xx.....
inet addr: 192.168.1.102 Bcast 192.168.1.255 Mask: 255.255.255.0
UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
RX Packets: 6 errors: 0 dropped, etc.. 0
TX packets: 3 errors:0, etc.. 0
colisions: 0 txqueuelen: 1000
RX bytes: 1020 TX Bytes: 708
lo Link encap: Local Loopback
inet addr: 127.0.0.1 Mask 255.0.0.0
UP Loopback running MTU: 65536 Metric: 1
RX packets 4: errors: 0 etc 0
TX packets 4: errors: 0 etc 0
```
In the example above is 192.168.1.102, so is valid:
```user@user ~/path/to/folder/py-kms $ python3 pykms_Server.py 192.168.1.102 1688```
To stop _pykms_Server.py_, in the same bash window where code running, simply press CTRL+C.
Alternatively, in a new bash window, use ```kill <pid>``` command (you can type ```ps aux``` first and have the process <pid>) or ```killall <name_of_server>```.
#### _How to run pykms_Server.py automatically at start_.
***
You can simply manage a daemon that runs as a background process.
If you are running a Linux distro using ```upstart``` (deprecated),
create the file: ```sudo nano /etc/init/py3-kms.conf```,
then add the following (changing where needed) and save:
```
description "py3-kms"
author "SystemRage"
env PYTHONPATH=/usr/bin
env PYKMSPATH=</path/to/your/pykms/files/folder>/py-kms
env LOGPATH=</path/to/your/log/files/folder>/pykms_logserver.log
start on runlevel [2345]
stop on runlevel [016]
exec $PYTHONPATH/python3 $PYKMSPATH/pykms_Server.py 0.0.0.0 1688 -V DEBUG -F $LOGPATH
respawn
```
Check syntax with: ```sudo init-checkconf -d /etc/init/py3-kms.conf```, then
reload upstart to recognise this process: ```sudo initctl reload-configuration```.
Now start the service: ```sudo start py3-kms```, and
you can see the logfile stating that your daemon is running: ```cat </path/to/your/log/files/folder>/pykms_logserver.log```.
If you are running a Linux distro using ```systemd```,
create the file: ```sudo nano /etc/systemd/system/py3-kms.service```,
then add the following (changing where needed) and save:
```
[Unit]
Description=py3-kms
After=network.target
StartLimitIntervalSec=0
[Service]
Type=simple
Restart=always
RestartSec=1
KillMode=process
User=root
ExecStart=/usr/bin/python3 </path/to/your/pykms/files/folder>/py-kms/pykms_Server.py 0.0.0.0 1688 -V DEBUG -F </path/to/your/log/files/folder>/pykms_logserver.log
[Install]
WantedBy=multi-user.target
```
Check syntax with: ```sudo systemd-analyze verify py3-kms.service```,
give file permission (if needed): ```sudo chmod 644 /etc/systemd/system/py3-kms.service```,
then reload systemd manager configuration: ```sudo systemctl daemon-reload```,
start daemon: ```sudo systemctl start py3-kms.service``` and view status: ```sudo systemctl status py3-kms.service```.
Check if daemon is correctly running: ```cat </path/to/your/log/files/folder>/pykms_logserver.log```.
You can also create a daemon with ```SysV``` (obsolete).
Finally a few generic commands useful for interact with your daemon: [here](https://eopio.com/linux-upstart-process-manager/) and [here](https://linoxide.com/linux-how-to/enable-disable-services-ubuntu-systemd-upstart/)
If you are using Windows, to run _pykms_Server.py_ as service you need to install [pywin32](https://sourceforge.net/projects/pywin32/),
then you can create a file for example named _kms-winservice.py_ and put into it this code:
```
import win32serviceutil
import win32service
import win32event
import servicemanager
import socket
import subprocess
class AppServerSvc (win32serviceutil.ServiceFramework):
_svc_name_ = "py-kms"
_svc_display_name_ = "py-kms"
_proc = None
_cmd = ["C:\Windows\Python27\python.exe", "C:\Windows\Python27\py-kms\pykms_Server.py"]
def __init__(self,args):
win32serviceutil.ServiceFramework.__init__(self,args)
self.hWaitStop = win32event.CreateEvent(None,0,0,None)
socket.setdefaulttimeout(60)
def SvcStop(self):
self.killproc()
self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)
win32event.SetEvent(self.hWaitStop)
def SvcDoRun(self):
servicemanager.LogMsg(servicemanager.EVENTLOG_INFORMATION_TYPE,
servicemanager.PYS_SERVICE_STARTED,
(self._svc_name_,''))
self.main()
def main(self):
self._proc = subprocess.Popen(self._cmd)
self._proc.wait()
def killproc(self):
self._proc.kill()
if __name__ == '__main__':
win32serviceutil.HandleCommandLine(AppServerSvc)
```
Now in a command prompt type ```C:\Windows\Python27\python.exe kms-winservice.py install``` to install the service.
Display all the services with ```services.msc``` and find the service associated with _py-kms_, changing startup type from "manual" to "auto".
Finally "Start" the service.
If this approach fails, you can try to use [Non-Sucking Service Manager](https://nssm.cc/) or Task Scheduler as described [here](https://blogs.esri.com/esri/arcgis/2013/07/30/scheduling-a-scrip/).
#### _pykms_Server.py Options_.
***
Follows a list of usable parameters:
ip <IPADDRESS>
> Instructs py-kms to listen on _IPADDRESS_ (can be an hostname too). If this option is not specified, _IPADDRESS_ 0.0.0.0 is used.
port <PORT>
> Define TCP _PORT_ the KMS service is listening on. Default is 1688.
-e or --epid <EPID>
> Enhanced Privacy ID (_EPID_) is a cryptographic scheme for providing anonymous signatures.
Use _EPID_ as Windows _EPID_. If no _EPID_ is specified, a random one will be generated.
-l or --lcid <LCID>
> Do not randomize the locale ID part of the _EPID_ and use _LCID_ instead.
The Language Code Identifier (_LCID_) describes localizable information in Windows.
This structure is used to identify specific languages for the purpose of customizing
software for particular languages and cultures. For example, it can specify the way dates,
times, and numbers are formatted as strings. It can also specify paper sizes and preferred sort order based on language elements.
The _LCID_ must be specified as a decimal number (example: 1049 for "Russian - Russia").
By default py-kms generates a valid locale ID but this may lead to a value which is unlikely to occur in your country.
You may want to select the locale ID of your country instead.
See [here](https://msdn.microsoft.com/en-us/library/cc233982.aspx) for a list of valid _LCIDs_.
If an _EPID_ is manually specified, this setting is ignored. Default is a fixed _LCID_ of 1033 (English - US).
-w or --hwid <HWID>
> Use specified _HWID_ for all products.
Hardware Identification is a security measure used by Microsoft upon the activation of
the Windows operating system. As part of the Product Activation system, a unique
HWID number is generated when the operating system is first installed. The _HWID_ identifies the hardware components that the system
is utilizing, and this number is communicated to Microsoft.
Every 10 days and at every reboot the operating system will generate another _HWID_ number and compare it to the original
to make sure that the operating system is still running on the same device.
If the two _HWID_ numbers differ too much then the operating system will shut down until Microsoft reactivates the product.
The theory behind _HWID_ is to ensure that the operating system is not being used on any device other than the one
for which it was purchased and registered.
HWID must be an 16-character string of hex characters that are interpreted as a series of 8 bytes (big endian).
Default is _364F463A8863D35F_. To auto generate the _HWID_, type ```-w RANDOM```.
-c or --client-count <CLIENTCOUNT>
> Use this flag to specify the current _CLIENTCOUNT_. Default is None. Remember that a number >=25 is
required to enable activation of client OSes while for server OSes and Office >=5.
-a or --activation-interval <ACTIVATIONINTERVAL>
> Instructs clients to retry activation every _ACTIVATIONINTERVAL_ minutes if it was unsuccessful,
e.g. because it could not reach the server. The default is 120 minutes (2 hours).
-r or --renewal-interval <RENEWALINTERVAL>
> Instructs clients to renew activation every _RENEWALINTERVAL_ minutes. The default is 10080 minutes (7 days).
-s or --sqlite
> Use this option to store request information from unique clients in an SQLite database.
-t0 or --timeout-idle <TIMEOUT>
> Maximum inactivity time (in seconds) after which the connection with the client is closed.
Default setting is serve forever (no timeout).
-y or --async-msg
> With high levels of logging (e.g hundreds of log statements), in a traditional synchronous log model,
the overhead involved becomes more expensive, so using this option you enable printing (pretty / logging) messages
asynchronously reducing time-consuming. Desactivated by default.
-V or --loglevel <{CRITICAL, ERROR, WARNING, INFO, DEBUG, MINI}>
> Use this flag to set a logging loglevel. The default is _ERROR_.
example:
user@user ~/path/to/folder/py-kms $ ```python3 pykms_Server.py -V INFO```
creates _pykms_logserver.log_ with these initial messages:
```
Mon, 12 Jun 2017 22:09:00 INFO TCP server listening at 0.0.0.0 on port 1688.
Mon, 12 Jun 2017 22:09:00 INFO HWID: 364F463A8863D35F
```
-F or --logfile <LOGFILE>
> Creates a _LOGFILE.log_ logging file. The default is named _pykms_logserver.log_.
example:
user@user ~/path/to/folder/py-kms $ ```python3 pykms_Server.py 192.168.1.102 8080 -F ~/path/to/folder/py-kms/newlogfile.log -V INFO -w RANDOM```
creates _newlogfile.log_ with these initial messages:
```
Mon, 12 Jun 2017 22:09:00 INFO TCP server listening at 192.168.1.102 on port 8080.
Mon, 12 Jun 2017 22:09:00 INFO HWID: 58C4F4E53AE14224
```
You can also enable other suboptions of ```-F``` doing what is reported in the following table:
| command | pretty msg | logging msg | logfile |
|-------------------------------|:----------:|:-----------:|:-------:|
| ```-F <logfile>``` | ON | OFF | ON |
| ```-F STDOUT``` | OFF | ON | OFF |
| ```-F FILESTDOUT <logfile>``` | OFF | ON | ON |
| ```-F STDOUTOFF <logfile>``` | OFF | OFF | ON |
| ```-F FILEOFF``` | ON | OFF | OFF |
-S or --logsize <MAXSIZE>
> Use this flag to set a maximum size (in MB) to the output log file. Desactivated by default.
#### _pykms_Client.py Options_.
***
If _py-kms_ server doesn't works correctly, you can test it with the KMS client _pykms_Client.py_,
running on the same machine where you started _pykms_Server.py_.
For example (in separated bash windows) run these commands:
```
user@user ~/path/to/folder/py-kms $ python3 pykms_Server.py -V DEBUG
user@user ~/path/to/folder/py-kms $ python3 pykms_Client.py 0.0.0.0 1688 -V DEBUG
```
or if you want better specify:
```
user@user ~/path/to/folder/py-kms $ python3 pykms_Server.py <YOUR_IPADDRESS> 1688 -V DEBUG
user@user ~/path/to/folder/py-kms $ python3 pykms_Client.py <YOUR_IPADDRESS> 1688 -V DEBUG
```
You can also put further parameters as defined below:
ip <IPADDRESS>
> Define _IPADDRESS_ (or hostname) of py-kms' KMS Server. This parameter is always required.
port <PORT>
> Define TCP _PORT_ the KMS service is listening on. Default is 1688.
-m or --mode <{WindowsVista, Windows7, Windows8, Windows8.1, Windows10, Office2010, Office2013, Office2016, Office2019}>
> Use this flag to manually specify a Microsoft _PRODUCTNAME_ for testing the KMS server. Default is Windows8.1.
-c or --cmid <CMID>
> Use this flag to manually specify a CMID to use. If no CMID is specified, a random one will be generated.
The Microsoft KMS host machine identifies KMS clients with a unique Client Machine ID
(CMID, example: ae3a27d1-b73a-4734-9878-70c949815218). For a KMS client to successfully activate, the KMS server
needs to meet a threshold, which is a minimum count for KMS clients.
Once a KMS server records a count which meets or exceeds threshold, KMS clients will begin to activate successfully.
Each unique CMID recorded by KMS server adds towards the count threshold for KMS clients. This are retained by the KMS server
for a maximum of 30 days after the last activation request with that CMID. Note that duplicate CMID only impacts on KMS server
machine count of client machines. Once KMS server meets minimum threshold, KMS clients will
activate regardless of CMID being unique for a subset of specific machines or not.
-n or --name <MACHINENAME>
> Use this flag to manually specify an ASCII _MACHINENAME_ to use. If no _MACHINENAME_ is specified a random one will be generated.
-y or --async-msg
> Prints pretty / logging messages asynchronously. Desactivated by default.
-V or --loglevel <{CRITICAL, ERROR, WARNING, INFO, DEBUG, MINI}>
> Use this flag to set a logging loglevel. The default is _ERROR_.
-F or --logfile <LOGFILE>
> Creates a _LOGFILE.log_ logging file. The default is named _pykms_logclient.log_.
You can enable same _pykms_Server.py_ suboptions of ```-F```.
-S or --logsize <MAXSIZE>
> Use this flag to set a maximum size (in MB) to the output log file. Desactivated by default.
## Activation Procedure
Briefly the product asks for a key during installation, so it needs to enter the GVLK. Then user can set connection parameters, while KMS server must already be running on server machine. Finally with specific commands activation occurs automatically and can be extended later every time for another 180 (or 45) days.
#### _Windows_
***
![win1](https://user-images.githubusercontent.com/25354386/36869547-74d05076-1d9c-11e8-9dee-1ff641449c7c.png)
![win2](https://user-images.githubusercontent.com/25354386/36871704-5f62dda6-1da3-11e8-91f7-a7bc71670926.png)
0. Run a Command Prompt as Administrator (you are directly in ```C:\Windows\System32``` path).
```//nologo``` option of ```cscript``` needs only to hide startup logo.
1. This is facoltative, it's for unistalling existing product key.
2. Then put your product's GVLK.
3. Set connection parameters.
4. Try online activation, but... if that fails with error ```0xC004F074``` you’ll most likely have to configure your firewall that it accepts incoming connections on TCP port 1688.
So for Linux users (server-side with _pykms_Server.py_ running): ```sudo ufw allow 1688``` (to remove this rule ```sudo ufw delete allow 1688```)
5. Attempt online activation (with now traffic on 1688 enabled).
6. View license informations (facoltative).
#### _Office_
***
Note that you’ll have to install a volume license (VL) version of Office. Office versions downloaded from MSDN and / or Technet are non-VL.
![off1](https://user-images.githubusercontent.com/25354386/36871724-6e9e5958-1da3-11e8-8c09-8fd693b20c52.png)
![off2](https://user-images.githubusercontent.com/25354386/36871740-79ce2ae2-1da3-11e8-9ef1-d9b14b86364c.png)
![off3](https://user-images.githubusercontent.com/25354386/36871754-84fa99e6-1da3-11e8-907b-f9435acd3a2d.png)
![off4](https://user-images.githubusercontent.com/25354386/36871764-8e179e2a-1da3-11e8-8e37-eb138a988dea.png)
0. Run a Command Prompt as Administrator and navigate to Office folder ```cd C:\ProgramFiles\Microsoft Office\OfficeXX``` (64-bit path) or ```cd C:\ProgramFiles(x86)\Microsoft Office\OfficeXX``` (32-bit path), where XX = 14 for Office 2010, 15 for Office 2013, 16 for Office 2016 or Office 2019.
1. As you can see, running ```/dstatus```, my Office is expiring (14 days remaining).
2. Only for example, let's go to uninstall this product.
3. This is confirmed running ```/dstatus``` again.
4. Now i put my product's GVLK (and you your key).
5. Set the connection parameter KMS server address.
6. Set the connection parameter KMS server port.
7. Activate installed Office product key.
8. View license informations (in my case product is now licensed and remaining grace 180 days as expected).
## Supported Products
Note that it is possible to activate all versions in the VL (Volume License) channel, so long as you provide the proper key to let Windows know that it should be activating against a KMS server. KMS activation can't be used for Retail channel products, however you can install a VL product key specific to your edition of Windows even if it was installed as Retail. This effectively converts Retail installation to VL channel and will allow you to activate from a KMS server. This is not valid for Office's products, so Office, Project and Visio must be volume license versions. Newer version may work as long as the KMS protocol does not change.
## Documentation
* <sup>[1]</sup> https://forums.mydigitallife.net/threads/emulated-kms-servers-on-non-windows-platforms.50234
* <sup>[2]</sup> https://forums.mydigitallife.net/threads/discussion-microsoft-office-2019.75232
* <sup>[3]</sup> https://forums.mydigitallife.net/threads/miscellaneous-kms-related-developments.52594
* <sup>[4]</sup> https://forums.mydigitallife.net/threads/kms-activate-windows-8-1-en-pro-and-office-2013.49686
* <sup>[5]</sup> https://github.com/myanaloglife/py-kms
* <sup>[6]</sup> https://github.com/Wind4/vlmcsd
* <sup>[7]</sup> https://github.com/ThunderEX/py-kms
* <sup>[8]</sup> https://github.com/CNMan/balala/blob/master/pkconfig.csv
* <sup>[9]</sup> http://www.level7techgroup.com/docs/kms_overview.pdf
* <sup>[10]</sup> https://www.dell.com/support/article/it/it/itbsdt1/sln266176/windows-server-using-the-key-management-service-kms-for-activation-of-volume-licensed-systems?lang=en
* <sup>[11]</sup> https://social.technet.microsoft.com/Forums/en-US/c3331743-cba2-4d92-88aa-9633ac74793a/office-2010-kms-current-count-remain-at-10?forum=officesetupdeployprevious
* <sup>[12]</sup> https://betawiki.net/wiki/Microsoft_Windows
* <sup>[13]</sup> https://thecollectionbook.info/builds/windows
* <sup>[14]</sup> https://www.betaarchive.com/forum/viewtopic.php%3Ft%3D29131+&cd=10&hl=it&ct=clnk&gl=it
* <sup>[15]</sup> https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=12&cad=rja&uact=8&ved=2ahUKEwjmvZihtOHeAhVwyoUKHSjeD5Q4ChAWMAF6BAgHEAI&url=ftp%3A%2F%2Flynas.ittc.vu.lt%2Fpub%2FMicrosoft%2FWindows%2520Vista%2FWindows%2520Vista_Volume_Activation_2.0%2FWindows%2520Vista%2520Volume%2520Activation%2FWindows%2520Vista_Volume_Activation_2.0%2Fvolume%2520activation%25202%25200%2520step-by-step%2520guide.doc&usg=AOvVaw3kqhCu3xT-3r416DRGUUs_
* <sup>[16]</sup> https://www.itprotoday.com/windows-78/volume-activation-server-2008
* <sup>[17]</sup> https://docs.microsoft.com/en-us/windows-server/get-started-19/activation-19
* <sup>[18]</sup> https://docs.microsoft.com/en-us/windows-server/get-started/windows-server-release-info
* <sup>[19]</sup> https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet

136
wiki/Office-GVLK-Keys.md
View File

@ -1,136 +0,0 @@
### _Office 2019_
<table width="650" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
<tr><td>Professional Plus 2019 [C2R]</td><td>VQ9DP-NVHPH-T9HJC-J9PDT-KTQRG</td></tr>
<tr><td>Professional Plus 2019</td><td>NMMKJ-6RK4F-KMJVX-8D9MJ-6MWKP</td></tr>
<tr><td>Standard 2019</td><td>6NWWJ-YQWMR-QKGCB-6TMB3-9D9HK</td></tr>
<tr><td>Project Professional 2019 [C2R]</td><td>XM2V9-DN9HH-QB449-XDGKC-W2RMW</td></tr>
<tr><td>Project Professional 2019</td><td>B4NPR-3FKK7-T2MBV-FRQ4W-PKD2B</td></tr>
<tr><td>Project Standard 2019</td><td>C4F7P-NCP8C-6CQPT-MQHV9-JXD2M</td></tr>
<tr><td>Visio Professional 2019 [C2R]</td><td>N2CG9-YD3YK-936X4-3WR82-Q3X4H </td></tr>
<tr><td>Visio Professional 2019</td><td>9BGNQ-K37YR-RQHF2-38RQ3-7VCBB</td></tr>
<tr><td>Visio Standard 2019</td><td>7TQNQ-K3YQQ-3PFH7-CCPPM-X4VQ2</td></tr>
<tr><td>Access 2019</td><td>9N9PT-27V4Y-VJ2PD-YXFMF-YTFQT</td></tr>
<tr><td>Excel 2019</td><td>TMJWT-YYNMB-3BKTF-644FC-RVXBD</td></tr>
<tr><td>Outlook 2019</td><td>7HD7K-N4PVK-BHBCQ-YWQRW-XW4VK</td></tr>
<tr><td>PowerPoint 2019</td><td>RRNCX-C64HY-W2MM7-MCH9G-TJHMQ</td></tr>
<tr><td>Publisher 2019</td><td>G2KWX-3NW6P-PY93R-JXK2T-C9Y9V</td></tr>
<tr><td>Skype for Business 2019</td><td>NCJ33-JHBBY-HTK98-MYCV8-HMKHJ</td></tr>
<tr><td>Word 2019</td><td>PBX3G-NWMT6-Q7XBW-PYJGG-WXD33</td></tr>
</tbody>
</table>
### _Office 2016_
<table width="650" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
<tr><td>Professional Plus 2016</td><td>XQNVK-8JYDB-WJ9W3-YJ8YR-WFG99</td></tr>
<tr><td>Standard 2016</td><td>JNRGM-WHDWX-FJJG3-K47QV-DRTFM</td></tr>
<tr><td>Project Professional 2016</td><td>YG9NW-3K39V-2T3HJ-93F3Q-G83KT</td></tr>
<tr><td>Project Professional 2016 [C2R]</td><td>WGT24-HCNMF-FQ7XH-6M8K7-DRTW9</td></tr>
<tr><td>Project Standard 2016</td><td>GNFHQ-F6YQM-KQDGJ-327XX-KQBVC</td></tr>
<tr><td>Project Standard 2016 [C2R]</td><td>D8NRQ-JTYM3-7J2DX-646CT-6836M</td></tr>
<tr><td>Visio Professional 2016</td><td>PD3PC-RHNGV-FXJ29-8JK7D-RJRJK</td></tr>
<tr><td>Visio Professional 2016 [C2R]</td><td>69WXN-MBYV6-22PQG-3WGHK-RM6XC</td></tr>
<tr><td>Visio Standard 2016</td><td>7WHWN-4T7MP-G96JF-G33KR-W8GF4</td></tr>
<tr><td>Visio Standard 2016 [C2R]</td><td>NY48V-PPYYH-3F4PX-XJRKJ-W4423</td></tr>
<tr><td>Access 2016</td><td>GNH9Y-D2J4T-FJHGG-QRVH7-QPFDW</td></tr>
<tr><td>Excel 2016</td><td>9C2PK-NWTVB-JMPW8-BFT28-7FTBF</td></tr>
<tr><td>Mondo 2016</td><td>HFTND-W9MK4-8B7MJ-B6C4G-XQBR2</td></tr>
<tr><td>Mondo Retail 2016</td><td>DMTCJ-KNRKX-26982-JYCKT-P7KB6</td></tr>
<tr><td>OneNote 2016</td><td>DR92N-9HTF2-97XKM-XW2WJ-XW3J6</td></tr>
<tr><td>Outlook 2016</td><td>R69KK-NTPKF-7M3Q4-QYBHW-6MT9B</td></tr>
<tr><td>PowerPoint 2016</td><td>J7MQP-HNJ4Y-WJ7YM-PFYGF-BY6C6</td></tr>
<tr><td>Publisher 2016</td><td>F47MM-N3XJP-TQXJ9-BP99D-8K837</td></tr>
<tr><td>Skype for Business 2016</td><td>869NQ-FJ69K-466HW-QYCP2-DDBV6</td></tr>
<tr><td>Word 2016</td><td>WXY84-JN2Q9-RBCCQ-3Q3J3-3PFJ6</td></tr>
</tbody>
</table>
### _Office 2013_
<table width="650" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
<tr><td>Professional Plus 2013 [Preview]</td><td>PGD67-JN23K-JGVWV-KTHP4-GXR9G</td></tr>
<tr><td>Professional Plus 2013</td><td>YC7DK-G2NP3-2QQC3-J6H88-GVGXT</td></tr>
<tr><td>Standard 2013</td><td>KBKQT-2NMXY-JJWGP-M62JB-92CD4</td></tr>
<tr><td>Project Professional 2013 [Preview]</td><td>NFKVM-DVG7F-TYWYR-3RPHY-F872K</td></tr>
<tr><td>Project Professional 2013</td><td>FN8TT-7WMH6-2D4X9-M337T-2342K</td></tr>
<tr><td>Project Standard 2013 [Preview]</td><td>N89QF-GGB8J-BKD28-C4V28-W4XTK</td></tr>
<tr><td>Project Standard 2013</td><td>6NTH3-CW976-3G3Y2-JK3TX-8QHTT</td></tr>
<tr><td>Visio Professional 2013 [Preview]</td><td>B3C7Q-D6NH2-2VRFW-HHWDG-FVQB6</td></tr>
<tr><td>Visio Professional 2013</td><td>C2FG9-N6J68-H8BTJ-BW3QX-RM3B3</td></tr>
<tr><td>Visio Standard 2013 [Preview]</td><td>9MKNF-J9XQ6-JV4XB-FJQPY-43F43</td></tr>
<tr><td>Visio Standard 2013</td><td>J484Y-4NKBF-W2HMG-DBMJC-PGWR7</td></tr>
<tr><td>Access 2013 [Preview]</td><td>DJBH8-RGN7Q-836KD-DMP3M-DM9MF</td></tr>
<tr><td>Access 2013</td><td>NG2JY-H4JBT-HQXYP-78QH9-4JM2D</td></tr>
<tr><td>Excel 2013 [Preview]</td><td>Q3BNP-3WXDT-GG8HF-24KMW-HMDBK</td></tr>
<tr><td>Excel 2013</td><td>VGPNG-Y7HQW-9RHP7-TKPV3-BG7GB</td></tr>
<tr><td>OneNote 2013 [Preview]</td><td>VYNYX-8GPBC-7FQMD-D6B7B-7MDFD</td></tr>
<tr><td>OneNote 2013</td><td>TGN6P-8MMBC-37P2F-XHXXK-P34VW</td></tr>
<tr><td>Outlook 2013 [Preview]</td><td>X2KNB-FRRG2-WXDPH-739DM-DM9RH</td></tr>
<tr><td>Outlook 2013</td><td>QPN8Q-BJBTJ-334K3-93TGY-2PMBT</td></tr>
<tr><td>PowerPoint 2013 [Preview]</td><td>B8CT8-BTNFQ-XQXBK-BFWV8-HMDFQ</td></tr>
<tr><td>PowerPoint 2013</td><td>4NT99-8RJFH-Q2VDH-KYG2C-4RD4F</td></tr>
<tr><td>Publisher 2013 [Preview]</td><td>NB67P-J8XP4-XDK9B-V73VH-M4CKR</td></tr>
<tr><td>Publisher 2013</td><td>PN2WF-29XG2-T9HJ7-JQPJR-FCXK4</td></tr>
<tr><td>InfoPath 2013 (Preview)</td><td>7KPJJ-N8TT7-CK3KR-QTV98-YPVXQ</td></tr>
<tr><td>InfoPath 2013</td><td>DKT8B-N7VXH-D963P-Q4PHY-F8894</td></tr>
<tr><td>Lync 2013 [Preview]</td><td>XNVD3-RYC7T-7R6BT-WX6CF-8BYH7</td></tr>
<tr><td>Lync 2013</td><td>2MG3G-3BNTT-3MFW9-KDQW3-TCK7R</td></tr>
<tr><td>Word 2013 [Preview]</td><td>JBGD4-3JNG7-JWWGV-CR6TP-DC62Q</td></tr>
<tr><td>Word 2013</td><td>6Q7VD-NX8JD-WJ2VH-88V73-4GBJ7</td></tr>
<tr><td>Mondo 2013 [Preview]</td><td>GCGCN-6FJRM-TR9Q3-BGMWJ-78KQV</td></tr>
<tr><td>Mondo 2013</td><td>42QTK-RN8M7-J3C4G-BBGYM-88CYV</td></tr>
<tr><td>Mondo 2013 Retail</td><td>?????-?????-?????-?????-?????</td></tr>
<tr><td>SharePoint Workspace (Groove) 2013 [Preview]</td><td>WVCGG-NK4FG-7XKXM-BD4WF-3C624</td></tr>
<tr><td>SharePoint Workspace (Groove) 2013</td><td>H7R7V-WPNXQ-WCYYC-76BGV-VT7GH</td></tr>
<tr><td>SharePoint Designer (Frontpage) 2013 Retail [Preview]</td><td>?????-?????-?????-?????-?????</td></tr>
<tr><td>SharePoint Designer (Frontpage) 2013 Retail</td><td>GYJRG-NMYMF-VGBM4-T3QD4-842DW</td></tr>
</tbody>
</table>
### _Office 2010_
<table width="650" cellspacing="0" cellpadding="0">
<colgroup>
<col span="1" width="300">
<col span="1" width="350">
</colgroup>
<thead><tr><th>Product</th><th>GVLK</th></tr></thead>
<tbody>
<tr><td>Professional Plus 2010</td><td>VYBBJ-TRJPB-QFQRF-QFT4D-H3GVB</td></tr>
<tr><td>Standard 2010</td><td>V7QKV-4XVVR-XYV4D-F7DFM-8R6BM</td></tr>
<tr><td>Project Professional 2010</td><td>YGX6F-PGV49-PGW3J-9BTGG-VHKC6</td></tr>
<tr><td>Project Standard 2010</td><td>4HP3K-88W3F-W2K3D-6677X-F9PGB</td></tr>
<tr><td>Visio Professional 2010</td><td>7MCW8-VRQVK-G677T-PDJCM-Q8TCP</td></tr>
<tr><td>Visio Standard 2010</td><td>767HD-QGMWX-8QTDB-9G3R2-KHFGJ</td></tr>
<tr><td>Visio Premium 2010</td><td>D9DWC-HPYVV-JGF4P-BTWQB-WX8BJ</td></tr>
<tr><td>Access 2010</td><td>V7Y44-9T38C-R2VJK-666HK-T7DDX</td></tr>
<tr><td>Excel 2010</td><td>H62QG-HXVKF-PP4HP-66KMR-CW9BM</td></tr>
<tr><td>OneNote 2010</td><td>Q4Y4M-RHWJM-PY37F-MTKWH-D3XHX</td></tr>
<tr><td>Outlook 2010</td><td>7YDC2-CWM8M-RRTJC-8MDVC-X3DWQ</td></tr>
<tr><td>PowerPoint 2010</td><td>RC8FX-88JRY-3PF7C-X8P67-P4VTT</td></tr>
<tr><td>Publisher 2010</td><td>BFK7F-9MYHM-V68C7-DRQ66-83YTP</td></tr>
<tr><td>InfoPath 2010</td><td>K96W8-67RPQ-62T9Y-J8FQJ-BT37T</td></tr>
<tr><td>SharePoint Workspace (Groove) 2010</td><td>QYYW6-QP4CB-MBV6G-HYMCJ-4T3J4</td></tr>
<tr><td>Word 2010</td><td>HVHB3-C6FV7-KQX9W-YQG79-CRY7T</td></tr>
<tr><td>Small Business Basics 2010</td><td>D6QFG-VBYP2-XQHM7-J97RH-VVRCK</td></tr>
<tr><td>Starter 2010 Retail</td><td>VXHHB-W7HBD-7M342-RJ7P8-CHBD6</td></tr>
<tr><td>SharePoint Designer (Frontpage) 2010 Retail</td><td>H48K6-FB4Y6-P83GH-9J7XG-HDKKX</td></tr>
<tr><td>Office Mondo 1 2010</td><td>YBJTT-JG6MD-V9Q7P-DBKXJ-38W9R</td></tr>
<tr><td>Office Mondo 2 2010</td><td>7TC2V-WXF6P-TD7RT-BQRXR-B8K32</td></tr>
</tbody>
</table>