vlmcsd.ini.5.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460
  1. <!-- Creator : groff version 1.22.3 -->
  2. <!-- CreationDate: Tue Mar 8 00:06:22 2016 -->
  3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
  4. "http://www.w3.org/TR/html4/loose.dtd">
  5. <html>
  6. <head>
  7. <meta name="generator" content="groff -Thtml, see www.gnu.org">
  8. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  9. <meta name="Content-Style" content="text/css">
  10. <style type="text/css">
  11. p { margin-top: 0; margin-bottom: 0; vertical-align: top }
  12. pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
  13. table { margin-top: 0; margin-bottom: 0; vertical-align: top }
  14. h1 { text-align: center }
  15. </style>
  16. <title>VLMCSD.INI</title>
  17. </head>
  18. <body>
  19. <h1 align="center">VLMCSD.INI</h1>
  20. <a href="#NAME">NAME</a><br>
  21. <a href="#SYNOPSIS">SYNOPSIS</a><br>
  22. <a href="#DESCRIPTION">DESCRIPTION</a><br>
  23. <a href="#SYNTAX">SYNTAX</a><br>
  24. <a href="#KEYWORDS">KEYWORDS</a><br>
  25. <a href="#SPECIAL KEYWORDS">SPECIAL KEYWORDS</a><br>
  26. <a href="#FILES">FILES</a><br>
  27. <a href="#AUTHOR">AUTHOR</a><br>
  28. <a href="#CREDITS">CREDITS</a><br>
  29. <a href="#SEE ALSO">SEE ALSO</a><br>
  30. <hr>
  31. <h2>NAME
  32. <a name="NAME"></a>
  33. </h2>
  34. <p style="margin-left:11%; margin-top: 1em"><b>vlmcsd.ini</b>
  35. &minus; vlmcsd KMS emulator configuration file</p>
  36. <h2>SYNOPSIS
  37. <a name="SYNOPSIS"></a>
  38. </h2>
  39. <p style="margin-left:11%; margin-top: 1em"><b>vlmcsd.ini</b></p>
  40. <h2>DESCRIPTION
  41. <a name="DESCRIPTION"></a>
  42. </h2>
  43. <p style="margin-left:11%; margin-top: 1em"><b>vlmcsd.ini</b>
  44. (or simply called the &quot;ini file&quot;) is a
  45. configuration file for <b>vlmcsd</b>(8). By default vlmcsd
  46. does not use a configuration file. It is completely optional
  47. and for advanced users only. You must use the <b>-i</b>
  48. option on the vlmcsd command line to use an ini file. There
  49. is no default name or default location for the ini file.</p>
  50. <p style="margin-left:11%; margin-top: 1em">Everything,
  51. that can be configured in the ini file, may also be
  52. specified on the command line. Any configuration option
  53. specified on the command line takes precedence over the
  54. respective configuration line in the ini file.</p>
  55. <p style="margin-left:11%; margin-top: 1em"><b>Benefits of
  56. a configuration file</b></p>
  57. <p style="margin-left:11%; margin-top: 1em">While you can
  58. use the configuration file to simply modify the default
  59. behavior of vlmcsd, it can also be used to change the
  60. configuration of vlmcsd after you sent a HUP
  61. <b>signal</b>(7). Whenever you send SIGHUP, the
  62. configuration file will be re-read. Any changes you made to
  63. the ini file will be reflected after vlmcsd received the
  64. hangup signal.</p>
  65. <p style="margin-left:11%; margin-top: 1em"><b>Differences
  66. between command line and configuration file</b></p>
  67. <p style="margin-left:11%; margin-top: 1em">If you specify
  68. an illegal option or option argument on the command line,
  69. vlmcsd displays help and exits. If you specify an incorrect
  70. <i>keyword</i> or <i>argument</i> in the ini file, vlmcsd
  71. displays a warning with some information, ignores the
  72. respective line and continues. This is intentional and
  73. prevents vlmcsd from aborting after a SIGHUP if the
  74. configuration was modified incorrectly.</p>
  75. <h2>SYNTAX
  76. <a name="SYNTAX"></a>
  77. </h2>
  78. <p style="margin-left:11%; margin-top: 1em">vlmcsd.ini is a
  79. UTF-8 encoded text file with each line being in the format
  80. <i>keyword</i> = <i>argument</i>. The <i>keyword</i> is not
  81. case-sensitive. The <i>argument</i> is treated literally. It
  82. is neither required nor allowed to enclose the
  83. <i>argument</i> in any form of quote characters except when
  84. quote characters are part of the argument itself. Whitespace
  85. characters are ignored only</p>
  86. <p style="margin-left:11%; margin-top: 1em">- at the
  87. beginning of a line <br>
  88. - between the <i>keyword</i> and &rsquo;=&rsquo; <br>
  89. - between &rsquo;=&rsquo; and the <i>argument</i></p>
  90. <p style="margin-left:11%; margin-top: 1em">Lines, that
  91. start with &rsquo;#&rsquo; or &rsquo;;&rsquo; are treated as
  92. comments. Empty lines are ignored as well. If a
  93. <i>keyword</i> is repeated in another line, vlmcsd will use
  94. the <i>argument</i> of the last occurence of the
  95. <i>keyword</i>. An exception to this is the Listen
  96. <i>keyword</i> which can be specified multiple times and
  97. causes vlmcsd to listen on more than one IP address and/or
  98. port.</p>
  99. <p style="margin-left:11%; margin-top: 1em">Some
  100. <i>argument</i>s are binary arguments that need to be either
  101. TRUE or FALSE. You can use &quot;Yes&quot;, &quot;On&quot;
  102. or &quot;1&quot; as an alias for TRUE and &quot;No&quot;,
  103. &quot;Off&quot; or &quot;0&quot; as an alias for FALSE.
  104. Binary arguments are case-insensitive.</p>
  105. <h2>KEYWORDS
  106. <a name="KEYWORDS"></a>
  107. </h2>
  108. <p style="margin-left:11%; margin-top: 1em">The following
  109. <i>keyword</i>s are defined:</p>
  110. <table width="100%" border="0" rules="none" frame="void"
  111. cellspacing="0" cellpadding="0">
  112. <tr valign="top" align="left">
  113. <td width="11%"></td>
  114. <td width="9%">
  115. <p><b>Listen</b></p></td>
  116. <td width="2%"></td>
  117. <td width="78%">
  118. <p>This defines on what combinations of IP addresses and
  119. ports vlmcsd should listen. <b>Listen</b> can be specified
  120. more than once. The <i>argument</i> has the form
  121. <i>ipaddress</i>[:<i>port</i>]. If you omit the <i>port</i>,
  122. the default port of 1688 is used. If the <i>ipaddress</i>
  123. contains colons and a <i>port</i> is used, you must enclose
  124. the <i>ipaddress</i> in brackets. The default is to listen
  125. to 0.0.0.0:1688 and [::]:1688 which means listen to all IPv4
  126. and all IPv6 addresses. See the <b>-L</b> option in
  127. <b>vlmcsd</b>(8) for more info about the syntax. If you use
  128. <b>-L</b>, <b>-P</b>, <b>-4</b> or <b>-6</b> on the command
  129. line, all <b>Listen</b> keywords in the ini file will be
  130. ignored. The <b>Listen</b> keyword cannot be used on Windows
  131. and Cygwin if vlmcsd has been compiled to use Microsoft
  132. RPC.</p> </td></tr>
  133. </table>
  134. <p style="margin-left:22%; margin-top: 1em">Examples:</p>
  135. <p style="margin-left:22%; margin-top: 1em">Listen =
  136. 192.168.1.123:1688 <br>
  137. Listen = 0.0.0.0:1234 <br>
  138. Listen = [fe80::1721:12ff:fe81:d36b%eth0]:1688</p>
  139. <table width="100%" border="0" rules="none" frame="void"
  140. cellspacing="0" cellpadding="0">
  141. <tr valign="top" align="left">
  142. <td width="11%"></td>
  143. <td width="6%">
  144. <p style="margin-top: 1em"><b>Port</b></p></td>
  145. <td width="5%"></td>
  146. <td width="78%">
  147. <p style="margin-top: 1em">Can only be used on Windows and
  148. Cygwin if vlmcsd has been compiled to use Microsoft RPC.
  149. Causes vlmcsd to listen on that port instead of 1688. On all
  150. non-Windows operating systems or if vlmcsd has been compiled
  151. to use its own RPC implementation, you must use
  152. <b>Listen</b> instead.</p></td></tr>
  153. </table>
  154. <p style="margin-left:11%;"><b>UseNDR64</b></p>
  155. <p style="margin-left:22%;">Can be TRUE or FALSE. Specifies
  156. whether you want to use the NDR64 transfer syntax. See
  157. options <b>-n0</b> and <b>-n1</b> in <b>vlmcsd</b>(8). The
  158. default is TRUE.</p>
  159. <p style="margin-left:11%;"><b>UseBTFN</b></p>
  160. <p style="margin-left:22%;">Can be TRUE or FALSE. Specifies
  161. whether you want to use bind time feature negotiation in
  162. RPC. See options <b>-b0</b> and <b>-b1</b> in
  163. <b>vlmcsd</b>(8). The default is TRUE.</p>
  164. <p style="margin-left:11%;"><b>RandomizationLevel</b></p>
  165. <p style="margin-left:22%;">The <i>argument</i> must 0, 1
  166. or 2. This specifies the ePID randomization level. See
  167. options <b>-r0</b>, <b>-r1</b> and <b>-r2</b> in
  168. <b>vlmcsd</b>(8). The default randomization level is 1.</p>
  169. <table width="100%" border="0" rules="none" frame="void"
  170. cellspacing="0" cellpadding="0">
  171. <tr valign="top" align="left">
  172. <td width="11%"></td>
  173. <td width="6%">
  174. <p><b>LCID</b></p></td>
  175. <td width="5%"></td>
  176. <td width="78%">
  177. <p>Use a specific culture id (LCID) even if the ePID is
  178. randomized. The <i>argument</i> must be a number between 1
  179. and 32767. While any number in that range is valid, you
  180. should use an offcial LCID. A list of assigned LCIDs can be
  181. found at
  182. http://msdn.microsoft.com/en&minus;us/goglobal/bb964664.aspx.
  183. On the command line you control this setting with option
  184. <b>-C</b>.</p> </td></tr>
  185. </table>
  186. <p style="margin-left:11%;"><b>MaxWorkers</b></p>
  187. <p style="margin-left:22%;">The <i>argument</i> specifies
  188. the maximum number of worker processes or threads that will
  189. be used to serve activation requests concurrently. This is
  190. the same as specifying <b>-m</b> on the command line.
  191. Minimum is 1. The maximum is platform specific and is at
  192. least 32767 but is likely to be greater on most systems. The
  193. default is no limit.</p>
  194. <p style="margin-left:11%;"><b>ConnectionTimeout</b></p>
  195. <p style="margin-left:22%;">Used to control when the vlmcsd
  196. disconnects idle TPC connections. The default is 30 seconds.
  197. This is the same setting as <b>-t</b> on the command
  198. line.</p>
  199. <p style="margin-left:11%;"><b>DisconnectClientsImmediately</b></p>
  200. <p style="margin-left:22%;">Set this to TRUE to disconnect
  201. a client after it got an activation response regardless
  202. whether a timeout has occured or not. The default is FALSE.
  203. Setting this to TRUE is non-standard behavior. Use only if
  204. you are experiencing DoS or DDoS attacks. On the command
  205. line you control this behavior with options <b>-d</b> and
  206. <b>-k</b>.</p>
  207. <p style="margin-left:11%;"><b>PidFile</b></p>
  208. <p style="margin-left:22%;">Write a pid file. The
  209. <i>argument</i> is the full pathname of a pid file. The pid
  210. file contains is single line containing the process id of
  211. the vlmcsd process. It can be used to stop (SIGTERM) or
  212. restart (SIGHUP) vlmcsd. This directive can be overriden
  213. using <b>-p</b> on the command line.</p>
  214. <p style="margin-left:11%;"><b>LogFile</b></p>
  215. <p style="margin-left:22%;">Write a log file. The
  216. <i>argument</i> is the full pathname of a log file. On a
  217. unixoid OS and with Cygwin you can use the special filename
  218. &rsquo;syslog&rsquo; to log to the syslog facility. This is
  219. the same as specifying <b>-l</b> on the command line.</p>
  220. <p style="margin-left:11%;"><b>LogVerbose</b></p>
  221. <p style="margin-left:22%;">Set this to either TRUE or
  222. FALSE. The default is FALSE. If set to TRUE, more details of
  223. each activation will be logged. You use <b>-v</b> and
  224. <b>-q</b> in the command line to control this setting.
  225. <b>LogVerbose</b> has an effect only if you specify a log
  226. file or redirect logging to <b>stdout</b>(3).</p>
  227. <p style="margin-left:11%;"><b>ActivationInterval</b></p>
  228. <p style="margin-left:22%;">This is the same as specifying
  229. <b>-A</b> on the command line. See <b>vlmcsd</b>(8) for
  230. details. The default is 2 hours. Example: ActivationInterval
  231. = 1h</p>
  232. <p style="margin-left:11%;"><b>RenewalInterval</b></p>
  233. <p style="margin-left:22%;">This is the same as specifying
  234. <b>-R</b> on the command line. See <b>vlmcsd</b>(8) for
  235. details. The default is 7 days. Example: ActivationInterval
  236. = 3h. Please note that the KMS client decides itself when to
  237. renew activation. Even though vlmcsd sends the renewal
  238. interval you specify, it is no more than some kind of
  239. recommendation to the client. Older KMS clients did follow
  240. the recommendation from a KMS server or emulator. Newer
  241. clients do not.</p>
  242. <table width="100%" border="0" rules="none" frame="void"
  243. cellspacing="0" cellpadding="0">
  244. <tr valign="top" align="left">
  245. <td width="11%"></td>
  246. <td width="7%">
  247. <p><b>User</b></p></td>
  248. <td width="4%"></td>
  249. <td width="78%">
  250. <p>Run vlmcsd as another, preferrably less privileged,
  251. user. The <i>argument</i> can be a user name or a numeric
  252. user id. You must have the required privileges (capabilities
  253. on Linux) to change the security context of a process
  254. without providing any credentials (a password in most
  255. cases). On most unixoid OSses &rsquo;root&rsquo; is the only
  256. user who has these privileges in the default configuration.
  257. This setting is not available in the native Windows version
  258. of vlmcsd. See <b>-u</b> in <b>vlmcsd</b>(8). This setting
  259. cannot be changed on the fly by sending SIGHUP to
  260. vlmcsd.</p> </td></tr>
  261. <tr valign="top" align="left">
  262. <td width="11%"></td>
  263. <td width="7%">
  264. <p><b>Group</b></p></td>
  265. <td width="4%"></td>
  266. <td width="78%">
  267. <p>Run vlmcsd as another, preferrably less privileged,
  268. group. The <i>argument</i> can be a group name or a numeric
  269. group id. You must have the required privileges
  270. (capabilities on Linux) to change the security context of a
  271. process without providing any credentials (a password in
  272. most cases). On most unixoid OSses &rsquo;root&rsquo; is the
  273. only user who has these privileges in the default
  274. configuration. This setting is not available in the native
  275. Windows version of vlmcsd. See <b>-g</b> in
  276. <b>vlmcsd</b>(8). This setting cannot be changed on the fly
  277. by sending SIGHUP to vlmcsd.</p></td></tr>
  278. </table>
  279. <h2>SPECIAL KEYWORDS
  280. <a name="SPECIAL KEYWORDS"></a>
  281. </h2>
  282. <p style="margin-left:11%; margin-top: 1em">Any valid GUID
  283. is being treated as a special <b>keyword</b> in the ini
  284. file. It is used to select a specfic ePID and HwId for an
  285. application GUID. The <i>argument</i> has the form
  286. <i>ePID</i> [ / <i>HwId</i> ]. KMS currently knows only 3
  287. application GUIDs:</p>
  288. <p style="margin-left:11%; margin-top: 1em">55c92734&minus;d682&minus;4d71&minus;983e&minus;d6ec3f16059f&nbsp;(Windows)
  289. <br>
  290. 59a52881&minus;a989&minus;479d&minus;af46&minus;f275c6370663&nbsp;(Office
  291. 2010) <br>
  292. 0ff1ce15&minus;a989&minus;479d&minus;af46&minus;f275c6370663&nbsp;(Office
  293. 2013)</p>
  294. <p style="margin-left:11%; margin-top: 1em">To use specific
  295. ePIDs for Windows, Office 2010 and Office 2013/2016 you
  296. could add the following lines to vlmcsd.ini:</p>
  297. <p style="margin-left:11%; margin-top: 1em"><small>55c92734&minus;d682&minus;4d71&minus;983e&minus;d6ec3f16059f&nbsp;=&nbsp;55041&minus;00206&minus;184&minus;207146&minus;03&minus;1062&minus;6002.0000&minus;3322013
  298. <br>
  299. 59a52881&minus;a989&minus;479d&minus;af46&minus;f275c6370663&nbsp;=&nbsp;55041&minus;00096&minus;216&minus;598637&minus;03&minus;17418&minus;6002.0000&minus;3312013
  300. <br>
  301. 0ff1ce15&minus;a989&minus;479d&minus;af46&minus;f275c6370663&nbsp;=&nbsp;55041&minus;00206-234&minus;742099&minus;03&minus;9217&minus;6002.0000&minus;2942013</small></p>
  302. <p style="margin-left:11%; margin-top: 1em">The ePID is
  303. currently a comment only. You can specify any string up to
  304. 63 bytes. In Windows 7 Microsoft has blacklisted few ( &lt;
  305. 10 ) ePIDs that were used in KMSv5 versions of the
  306. &quot;ratiborus virtual machine&quot;. Microsoft has given
  307. up on blacklisting when KMS emulators appeared in the
  308. wild.</p>
  309. <p style="margin-left:11%; margin-top: 1em">Even if you can
  310. use &quot;Activated by cool hacker guys&quot; as an ePID,
  311. you may wish to use ePIDs that cannot be detected as non-MS
  312. ePIDs. If you don&rsquo;t know how these &quot;valid&quot;
  313. ePIDs look like exactly, do not use GUIDS in vlmcsd.ini.
  314. vlmcsd provides internal mechanisms to generate valid
  315. ePIDs.</p>
  316. <p style="margin-left:11%; margin-top: 1em">If you use
  317. non-ASCII characters in your ePID (you shouldn&rsquo;t do
  318. anyway), these must be in UTF-8 format. This is especially
  319. important when you run vlmcsd on Windows or cygwin because
  320. UTF-8 is not the default encoding for most editors.</p>
  321. <p style="margin-left:11%; margin-top: 1em">If you are
  322. specifying an optional HWID it follows the same syntax as in
  323. the <b>&minus;H</b> option in <b>vlmcsd</b>(8) ecxept that
  324. you must not enclose a HWID in quotes even if it contains
  325. spaces.</p>
  326. <h2>FILES
  327. <a name="FILES"></a>
  328. </h2>
  329. <p style="margin-left:11%; margin-top: 1em"><b>vlmcsd.ini</b>(5)</p>
  330. <h2>AUTHOR
  331. <a name="AUTHOR"></a>
  332. </h2>
  333. <p style="margin-left:11%; margin-top: 1em"><b>vlmcsd</b>(8)
  334. was written by crony12, Hotbird64 and vityan666. With
  335. contributions from DougQaid.</p>
  336. <h2>CREDITS
  337. <a name="CREDITS"></a>
  338. </h2>
  339. <p style="margin-left:11%; margin-top: 1em">Thanks to
  340. CODYQX4, deagles, eIcn, mikmik38, nosferati87, qad,
  341. Ratiborus, ...</p>
  342. <h2>SEE ALSO
  343. <a name="SEE ALSO"></a>
  344. </h2>
  345. <p style="margin-left:11%; margin-top: 1em"><b>vlmcsd</b>(8),
  346. <b>vlmcsd</b>(7), <b>vlmcs</b>(1), <b>vlmcsdmulti</b>(1)</p>
  347. <hr>
  348. </body>
  349. </html>