Add smjs_auth and smjs_generateauth documentation

Infinixius · Infinixius · commit d8cd05eb0cdf · 2022-07-29T12:35:30.000-04:00
diff --git a/docs/Console.html b/docs/Console.html
@@ -572,7 +572,7 @@ <h5>Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/Console.js.html b/docs/Console.js.html
@@ -132,7 +132,7 @@ <h1 class="page-title">Console.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/Player.html b/docs/Player.html
@@ -2934,7 +2934,7 @@ <h5>Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/Player.js.html b/docs/Player.js.html
@@ -516,7 +516,7 @@ <h1 class="page-title">Player.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/Players.html b/docs/Players.html
@@ -1782,7 +1782,7 @@ <h5>Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/Players.js.html b/docs/Players.js.html
@@ -248,7 +248,7 @@ <h1 class="page-title">Players.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/Server.html b/docs/Server.html
@@ -1562,7 +1562,7 @@ <h4 class="name" id="event:ready">ready</h4>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/Server.js.html b/docs/Server.js.html
@@ -261,7 +261,7 @@ <h1 class="page-title">Server.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/Socket.html b/docs/Socket.html
@@ -1247,7 +1247,7 @@ <h4 class="name" id="event:ready">ready</h4>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/Socket.js.html b/docs/Socket.js.html
@@ -310,7 +310,7 @@ <h1 class="page-title">Socket.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/Utilities.js.html b/docs/Utilities.js.html
@@ -239,7 +239,7 @@ <h1 class="page-title">Utilities.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/Weapon.html b/docs/Weapon.html
@@ -750,7 +750,7 @@ <h5>Throws:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/Weapon.js.html b/docs/Weapon.js.html
@@ -844,7 +844,7 @@ <h1 class="page-title">Weapon.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/global.html b/docs/global.html
@@ -10924,7 +10924,7 @@ <h5>Example</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/index.html b/docs/index.html
@@ -144,7 +144,7 @@ <h1>License</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/tutorial-Configuration.html b/docs/tutorial-Configuration.html
@@ -63,17 +63,31 @@ <h2>Server Configuration</h2>
 <p>sourcemod.js has the following <a href="https://developer.valvesoftware.com/wiki/Developer_Console#Commands_and_variables">ConVars</a>:</p>
 <ul>
 <li><strong>smjs_debug 0</strong> - Toggles whether extra debug logging is shown or not. 1 = true, 0 = false.</li>
-<li><strong>smjs_auth test</strong> - Sets the authentication string that all clients must use to connect.</li>
+<li><strong>smjs_auth 098f...</strong> - Sets the MD5 hash authentication string that all clients must use to connect.</li>
 <li><strong>smjs_port 27013</strong> - The port for sourcemod.js to listen on.</li>
 <li><strong>smjs_ip 0.0.0.0</strong> - The IP address for sourcemod.js to listen on.</li>
 </ul>
 <p>The easiest way to change these ConVars is to add them to the launch options of a server:</p>
-<pre class="prettyprint source"><code>srcds.exe +smjs_port 12345 +smjs_auth CustomAuthString +smjs_debug 0
+<pre class="prettyprint source"><code>srcds.exe +smjs_port 12345 +smjs_auth 3a52... +smjs_debug 0
 </code></pre>
-<p>Keep in mind that for security reasons, you cannot change these while the server is running.</p>
-<h2>Client Configuration</h2>
-<p>sourcemod.js on the client is configured when connecting to a server:</p>
-<pre class="prettyprint source lang-js"><code>const server = await new Server(&quot;ws://localhost:6969&quot;,
+<p><code>smjs_auth</code> must be an <a href="https://en.wikipedia.org/wiki/MD5">MD5 Hash</a> of the password you'd like to use. You can easily generate an MD5 hash <a href="https://www.md5hashgenerator.com/">online</a>, or with the command <code>smjs_generateauth</code>.</p>
+<pre class="prettyprint source lang-bash"><code>smjs_auth adminpassword
+# Even if a client tries to authenticate with the password &quot;adminpassword&quot;, they will NOT be able to connect!
+
+smjs_generateauth adminpassword
+# [SMJS] Generated hash: 'e3274be5c857fb42ab72d786e281b4b8'
+smjs_auth e3274be5c857fb42ab72d786e281b4b8
+# Now the client can connect with the password &quot;adminpassword&quot;!
+</code></pre>
+<pre class="prettyprint source"><code>
+Keep in mind that for security reasons, you cannot change these while the server is running.
+
+## Client Configuration
+
+sourcemod.js on the client is configured when connecting to a server:
+
+```js
+const server = await new Server(&quot;ws://localhost:6969&quot;,
 	{
 		auth: &quot;test&quot;
 	}
@@ -94,7 +108,7 @@ <h2>Client Configuration</h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/tutorial-Installation.html b/docs/tutorial-Installation.html
@@ -84,7 +84,7 @@ <h2>Installation</h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/tutorial-InstallationClient.html b/docs/tutorial-InstallationClient.html
@@ -82,7 +82,7 @@ <h2>Installation</h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/tutorial-InstallationServer.html b/docs/tutorial-InstallationServer.html
@@ -117,7 +117,7 @@ <h2>Plugins</h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:21 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/tutorial-Roadmap.html b/docs/tutorial-Roadmap.html
@@ -202,7 +202,7 @@ <h2>Counter-Strike APIs</h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:22 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/tutorial-SoundsCSGO.html b/docs/tutorial-SoundsCSGO.html
@@ -24131,7 +24131,7 @@ <h2>Sounds - Counter-Strike: Global Offensive</h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:22 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/tutorial-SoundsHL2.html b/docs/tutorial-SoundsHL2.html
@@ -3300,7 +3300,7 @@ <h2>Sounds - Half-Life 2</h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:22 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/tutorial-SoundsTF2.html b/docs/tutorial-SoundsTF2.html
@@ -3451,7 +3451,7 @@ <h2>Sounds - Team Fortress 2</h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:22 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/tutorial-Troubleshooting.html b/docs/tutorial-Troubleshooting.html
@@ -92,7 +92,7 @@ <h3><code>Error: Unauthorized!</code></h3>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:25:52 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jul 29 2022 12:35:22 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/plugin/sourcemod.js.sp b/plugin/sourcemod.js.sp
@@ -141,7 +141,7 @@ public Action Command_GenerateAuth(int args) {
 
 	Crypt_MD5(arg, output, sizeof(output));
 
-	PrintToServer("[SMJS] Set smjs_auth to: '%s'", output)
+	PrintToServer("[SMJS] Generated hash: '%s'", output)
 }
 
 public ConVarChanged(ConVar convar, const char[] oldValue, const char[] newValue) {
diff --git a/src/tutorials/Configuration.md b/src/tutorials/Configuration.md
@@ -5,13 +5,25 @@ sourcemod.js has various configuration options.
 sourcemod.js has the following [ConVars](https://developer.valvesoftware.com/wiki/Developer_Console#Commands_and_variables):
 
 - **smjs_debug 0** - Toggles whether extra debug logging is shown or not. 1 = true, 0 = false.
-- **smjs_auth test** - Sets the authentication string that all clients must use to connect.
+- **smjs_auth 098f...** - Sets the MD5 hash authentication string that all clients must use to connect.
 - **smjs_port 27013** - The port for sourcemod.js to listen on.
 - **smjs_ip 0.0.0.0** - The IP address for sourcemod.js to listen on. 
 
 The easiest way to change these ConVars is to add them to the launch options of a server:
 ```
-srcds.exe +smjs_port 12345 +smjs_auth CustomAuthString +smjs_debug 0
+srcds.exe +smjs_port 12345 +smjs_auth 3a52... +smjs_debug 0
+```
+
+`smjs_auth` must be an [MD5 Hash](https://en.wikipedia.org/wiki/MD5) of the password you'd like to use. You can easily generate an MD5 hash [online](https://www.md5hashgenerator.com/), or with the command `smjs_generateauth`.
+```bash
+smjs_auth adminpassword
+# Even if a client tries to authenticate with the password "adminpassword", they will NOT be able to connect!
+
+smjs_generateauth adminpassword
+# [SMJS] Generated hash: 'e3274be5c857fb42ab72d786e281b4b8'
+smjs_auth e3274be5c857fb42ab72d786e281b4b8
+# Now the client can connect with the password "adminpassword"!
+```
 ```
 
 Keep in mind that for security reasons, you cannot change these while the server is running.
