vlmcsd.ini.5.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509
  1. <!-- Creator : groff version 1.22.3 -->
  2. <!-- CreationDate: Tue Oct 11 21:34:50 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="#VALID EPIDS">VALID EPIDS</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 (not all keywords may be
  110. available depending on the operating system and the options
  111. used when <b>vlmcsd</b>(8) was compiled):</p>
  112. <table width="100%" border="0" rules="none" frame="void"
  113. cellspacing="0" cellpadding="0">
  114. <tr valign="top" align="left">
  115. <td width="11%"></td>
  116. <td width="9%">
  117. <p><b>Listen</b></p></td>
  118. <td width="2%"></td>
  119. <td width="78%">
  120. <p>This defines on what combinations of IP addresses and
  121. ports vlmcsd should listen. <b>Listen</b> can be specified
  122. more than once. The <i>argument</i> has the form
  123. <i>ipaddress</i>[:<i>port</i>]. If you omit the <i>port</i>,
  124. the default port of 1688 is used. If the <i>ipaddress</i>
  125. contains colons and a <i>port</i> is used, you must enclose
  126. the <i>ipaddress</i> in brackets. The default is to listen
  127. to 0.0.0.0:1688 and [::]:1688 which means listen to all IPv4
  128. and all IPv6 addresses. See the <b>-L</b> option in
  129. <b>vlmcsd</b>(8) for more info about the syntax. If you use
  130. <b>-L</b> or <b>-P</b> on the command line, all
  131. <b>Listen</b> keywords in the ini file will be ignored. The
  132. <b>Listen</b> keyword cannot be used if vlmcsd has been
  133. compiled to use Microsoft RPC (Windows and Cygwin only) or
  134. simple sockets.</p></td></tr>
  135. </table>
  136. <p style="margin-left:22%; margin-top: 1em">Examples:</p>
  137. <p style="margin-left:22%; margin-top: 1em">Listen =
  138. 192.168.1.123:1688 <br>
  139. Listen = 0.0.0.0:1234 <br>
  140. Listen = [fe80::1721:12ff:fe81:d36b%eth0]:1688</p>
  141. <table width="100%" border="0" rules="none" frame="void"
  142. cellspacing="0" cellpadding="0">
  143. <tr valign="top" align="left">
  144. <td width="11%"></td>
  145. <td width="6%">
  146. <p style="margin-top: 1em"><b>Port</b></p></td>
  147. <td width="5%"></td>
  148. <td width="78%">
  149. <p style="margin-top: 1em">Can only be used if vlmcsd has
  150. been compiled to use simple sockets or on Windows and Cygwin
  151. if <b>vlmcsd</b>(8) has been compiled to use Microsoft RPC.
  152. Otherwise you must use <b>Listen</b> instead. Causes vlmcsd
  153. to listen on that port instead of 1688.</p></td></tr>
  154. </table>
  155. <p style="margin-left:11%;"><b>FreeBind</b></p>
  156. <p style="margin-left:22%;">Can be TRUE or FALSE. If TRUE,
  157. you can use the <b>Listen</b> keyword with IP addresses that
  158. are currently not defined on your system. <b>vlmcsd</b>(8)
  159. will start listening on these IP addresses as soon as they
  160. become available. This keyword is only available under Linux
  161. and FreeBSD because no other OS currently supports that
  162. feature. FreeBSD supports this only for IPv4 and requires
  163. the PRIV_NETINET_BINDANY privilege which is normally
  164. assigned to proccesses of the root user.</p>
  165. <p style="margin-left:11%;"><b>PublicIPProtectionLevel</b></p>
  166. <p style="margin-left:22%;">Set the level of protection
  167. against KMS activations from public IP addresses.</p>
  168. <p style="margin-left:22%; margin-top: 1em">0 = No
  169. protection (default) <br>
  170. 1&nbsp;=&nbsp;Listen on private IP addresses only (plus
  171. those specified by one or more <b>Listen</b> statements)
  172. <br>
  173. 2&nbsp;=&nbsp;Disconnect clients with public IP addresses
  174. without activating <br>
  175. 3&nbsp;=&nbsp;Combines 1 and 2</p>
  176. <p style="margin-left:22%; margin-top: 1em">For details on
  177. public IP protection levels see <b>vlmcsd</b>(8) command
  178. line option <b>-o</b>.</p>
  179. <p style="margin-left:11%;"><b>UseNDR64</b></p>
  180. <p style="margin-left:22%;">Can be TRUE or FALSE. Specifies
  181. whether you want to use the NDR64 transfer syntax. See
  182. options <b>-n0</b> and <b>-n1</b> in <b>vlmcsd</b>(8). The
  183. default is TRUE.</p>
  184. <p style="margin-left:11%;"><b>UseBTFN</b></p>
  185. <p style="margin-left:22%;">Can be TRUE or FALSE. Specifies
  186. whether you want to use bind time feature negotiation in
  187. RPC. See options <b>-b0</b> and <b>-b1</b> in
  188. <b>vlmcsd</b>(8). The default is TRUE.</p>
  189. <p style="margin-left:11%;"><b>RandomizationLevel</b></p>
  190. <p style="margin-left:22%;">The <i>argument</i> must 0, 1
  191. or 2. This specifies the ePID randomization level. See
  192. options <b>-r0</b>, <b>-r1</b> and <b>-r2</b> in
  193. <b>vlmcsd</b>(8). The default randomization level is 1. A
  194. <b>RandomizationLevel</b> of 2 is not recommended and should
  195. be treated as a debugging level.</p>
  196. <table width="100%" border="0" rules="none" frame="void"
  197. cellspacing="0" cellpadding="0">
  198. <tr valign="top" align="left">
  199. <td width="11%"></td>
  200. <td width="6%">
  201. <p><b>LCID</b></p></td>
  202. <td width="5%"></td>
  203. <td width="78%">
  204. <p>Use a specific culture id (LCID) even if the ePID is
  205. randomized. The <i>argument</i> must be a number between 1
  206. and 32767. While any number in that range is valid, you
  207. should use an offcial LCID. A list of assigned LCIDs can be
  208. found at
  209. http://msdn.microsoft.com/en&minus;us/goglobal/bb964664.aspx.
  210. On the command line you control this setting with option
  211. <b>-C</b>.</p> </td></tr>
  212. </table>
  213. <p style="margin-left:11%;"><b>MaxWorkers</b></p>
  214. <p style="margin-left:22%;">The <i>argument</i> specifies
  215. the maximum number of worker processes or threads that will
  216. be used to serve activation requests concurrently. This is
  217. the same as specifying <b>-m</b> on the command line.
  218. Minimum is 1. The maximum is platform specific and is at
  219. least 32767 but is likely to be greater on most systems. The
  220. default is no limit.</p>
  221. <p style="margin-left:11%;"><b>ConnectionTimeout</b></p>
  222. <p style="margin-left:22%;">Used to control when the vlmcsd
  223. disconnects idle TPC connections. The default is 30 seconds.
  224. This is the same setting as <b>-t</b> on the command
  225. line.</p>
  226. <p style="margin-left:11%;"><b>DisconnectClientsImmediately</b></p>
  227. <p style="margin-left:22%;">Set this to TRUE to disconnect
  228. a client after it got an activation response regardless
  229. whether a timeout has occured or not. The default is FALSE.
  230. Setting this to TRUE is non-standard behavior. Use only if
  231. you are experiencing DoS or DDoS attacks. On the command
  232. line you control this behavior with options <b>-d</b> and
  233. <b>-k</b>.</p>
  234. <p style="margin-left:11%;"><b>PidFile</b></p>
  235. <p style="margin-left:22%;">Write a pid file. The
  236. <i>argument</i> is the full pathname of a pid file. The pid
  237. file contains is single line containing the process id of
  238. the vlmcsd process. It can be used to stop (SIGTERM) or
  239. restart (SIGHUP) vlmcsd. This directive can be overriden
  240. using <b>-p</b> on the command line.</p>
  241. <p style="margin-left:11%;"><b>LogFile</b></p>
  242. <p style="margin-left:22%;">Write a log file. The
  243. <i>argument</i> is the full pathname of a log file. On a
  244. unixoid OS and with Cygwin you can use the special filename
  245. &rsquo;syslog&rsquo; to log to the syslog facility. This is
  246. the same as specifying <b>-l</b> on the command line.</p>
  247. <p style="margin-left:11%;"><b>LogDateAndTime</b></p>
  248. <p style="margin-left:22%;">Can be TRUE or FALSE. The
  249. default is TRUE. If set to FALSE, logging output does not
  250. include date and time. This is useful if you log to
  251. <b>stdout</b>(3) which is redirected to another logging
  252. mechanism that already includes date and time in its output,
  253. for instance <b>systemd-journald</b>(8). If you log to
  254. <b>syslog</b>(3), <b>LogDateAndTime</b> is ignored and date
  255. and time will never be included in the output sent to
  256. <b>syslog</b>(3). Using the command line you control this
  257. setting with options <b>-T0</b> and <b>-T1</b>.</p>
  258. <p style="margin-left:11%;"><b>LogVerbose</b></p>
  259. <p style="margin-left:22%;">Set this to either TRUE or
  260. FALSE. The default is FALSE. If set to TRUE, more details of
  261. each activation will be logged. You use <b>-v</b> and
  262. <b>-q</b> in the command line to control this setting.
  263. <b>LogVerbose</b> has an effect only if you specify a log
  264. file or redirect logging to <b>stdout</b>(3).</p>
  265. <p style="margin-left:11%;"><b>ActivationInterval</b></p>
  266. <p style="margin-left:22%;">This is the same as specifying
  267. <b>-A</b> on the command line. See <b>vlmcsd</b>(8) for
  268. details. The default is 2 hours. Example: ActivationInterval
  269. = 1h</p>
  270. <p style="margin-left:11%;"><b>RenewalInterval</b></p>
  271. <p style="margin-left:22%;">This is the same as specifying
  272. <b>-R</b> on the command line. See <b>vlmcsd</b>(8) for
  273. details. The default is 7 days. Example: RenewalInterval =
  274. 3d. Please note that the KMS client decides itself when to
  275. renew activation. Even though vlmcsd sends the renewal
  276. interval you specify, it is no more than some kind of
  277. recommendation to the client. Older KMS clients did follow
  278. the recommendation from a KMS server or emulator. Newer
  279. clients do not.</p>
  280. <table width="100%" border="0" rules="none" frame="void"
  281. cellspacing="0" cellpadding="0">
  282. <tr valign="top" align="left">
  283. <td width="11%"></td>
  284. <td width="7%">
  285. <p><b>User</b></p></td>
  286. <td width="4%"></td>
  287. <td width="78%">
  288. <p>Run vlmcsd as another, preferrably less privileged,
  289. user. The <i>argument</i> can be a user name or a numeric
  290. user id. You must have the required privileges (capabilities
  291. on Linux) to change the security context of a process
  292. without providing any credentials (a password in most
  293. cases). On most unixoid OSses &rsquo;root&rsquo; is the only
  294. user who has these privileges in the default configuration.
  295. This setting is not available in the native Windows version
  296. of vlmcsd. See <b>-u</b> in <b>vlmcsd</b>(8). This setting
  297. cannot be changed on the fly by sending SIGHUP to
  298. vlmcsd.</p> </td></tr>
  299. <tr valign="top" align="left">
  300. <td width="11%"></td>
  301. <td width="7%">
  302. <p><b>Group</b></p></td>
  303. <td width="4%"></td>
  304. <td width="78%">
  305. <p>Run vlmcsd as another, preferrably less privileged,
  306. group. The <i>argument</i> can be a group name or a numeric
  307. group id. You must have the required privileges
  308. (capabilities on Linux) to change the security context of a
  309. process without providing any credentials (a password in
  310. most cases). On most unixoid OSses &rsquo;root&rsquo; is the
  311. only user who has these privileges in the default
  312. configuration. This setting is not available in the native
  313. Windows version of vlmcsd. See <b>-g</b> in
  314. <b>vlmcsd</b>(8). This setting cannot be changed on the fly
  315. by sending SIGHUP to vlmcsd.</p></td></tr>
  316. </table>
  317. <p style="margin-left:11%;"><b>Windows</b></p>
  318. <p style="margin-left:22%;">The <i>argument</i> has the
  319. form <i>ePID</i> [ / <i>HwId</i> ]. Always use <i>ePID</i>
  320. and <i>HwId</i> for Windows activations. If specified,
  321. <b>RandomizationLevel</b> for Windows activitations will be
  322. ignored.</p>
  323. <p style="margin-left:11%;"><b>Office2010</b></p>
  324. <p style="margin-left:22%;">The <i>argument</i> has the
  325. form <i>ePID</i> [ / <i>HwId</i> ]. Always use <i>ePID</i>
  326. and <i>HwId</i> for Office 2010 activations. If specified,
  327. <b>RandomizationLevel</b> for Office 2010 activitations will
  328. be ignored.</p>
  329. <p style="margin-left:11%;"><b>Office2013</b></p>
  330. <p style="margin-left:22%;">The <i>argument</i> has the
  331. form <i>ePID</i> [ / <i>HwId</i> ]. Always use <i>ePID</i>
  332. and <i>HwId</i> for Office 2013 activations. If specified,
  333. <b>RandomizationLevel</b> for Office 2013 activitations will
  334. be ignored.</p>
  335. <p style="margin-left:11%;"><b>Office2016</b></p>
  336. <p style="margin-left:22%;">The <i>argument</i> has the
  337. form <i>ePID</i> [ / <i>HwId</i> ]. Always use <i>ePID</i>
  338. and <i>HwId</i> for Office 2016 activations. If specified,
  339. <b>RandomizationLevel</b> for Office 2016 activitations will
  340. be ignored.</p>
  341. <h2>VALID EPIDS
  342. <a name="VALID EPIDS"></a>
  343. </h2>
  344. <p style="margin-left:11%; margin-top: 1em">The ePID is
  345. currently a comment only. You can specify any string up to
  346. 63 bytes. In Windows 7 Microsoft has blacklisted few ( &lt;
  347. 10 ) ePIDs that were used in KMSv5 versions of the
  348. &quot;Ratiborus Virtual Machine&quot;. Microsoft has given
  349. up on blacklisting when KMS emulators appeared in the
  350. wild.</p>
  351. <p style="margin-left:11%; margin-top: 1em">Even if you can
  352. use &quot;Activated by cool hacker guys&quot; as an ePID,
  353. you may wish to use ePIDs that cannot be detected as non-MS
  354. ePIDs. If you don&rsquo;t know how these &quot;valid&quot;
  355. ePIDs look like exactly, do not use GUIDS in vlmcsd.ini.
  356. vlmcsd provides internal mechanisms to generate valid
  357. ePIDs.</p>
  358. <p style="margin-left:11%; margin-top: 1em">If you use
  359. non-ASCII characters in your ePID (you shouldn&rsquo;t do
  360. anyway), these must be in UTF-8 format. This is especially
  361. important when you run vlmcsd on Windows or cygwin because
  362. UTF-8 is not the default encoding for most editors.</p>
  363. <p style="margin-left:11%; margin-top: 1em">If you are
  364. specifying an optional HWID it follows the same syntax as in
  365. the <b>&minus;H</b> option in <b>vlmcsd</b>(8) ecxept that
  366. you must not enclose a HWID in quotes even if it contains
  367. spaces.</p>
  368. <h2>FILES
  369. <a name="FILES"></a>
  370. </h2>
  371. <p style="margin-left:11%; margin-top: 1em"><b>vlmcsd.ini</b>(5)</p>
  372. <h2>AUTHOR
  373. <a name="AUTHOR"></a>
  374. </h2>
  375. <p style="margin-left:11%; margin-top: 1em"><b>vlmcsd</b>(8)
  376. was written by crony12, Hotbird64 and vityan666. With
  377. contributions from DougQaid.</p>
  378. <h2>CREDITS
  379. <a name="CREDITS"></a>
  380. </h2>
  381. <p style="margin-left:11%; margin-top: 1em">Thanks to
  382. CODYQX4, deagles, eIcn, mikmik38, nosferati87, qad,
  383. Ratiborus, ...</p>
  384. <h2>SEE ALSO
  385. <a name="SEE ALSO"></a>
  386. </h2>
  387. <p style="margin-left:11%; margin-top: 1em"><b>vlmcsd</b>(8),
  388. <b>vlmcsd</b>(7), <b>vlmcs</b>(1), <b>vlmcsdmulti</b>(1)</p>
  389. <hr>
  390. </body>
  391. </html>