Add Max Concurrent Connections for database users

notAreYouScared · notAreYouScared · commit f0e4764a1169 · 2020-04-22T06:00:04.000-04:00
Closes pterodactyl#1849 Allows database users to be limited to a number of concurrent connections to prevent one user from connecting hundreds of time and bottlenecking the MySQL server.
diff --git a/app/Contracts/Repository/DatabaseRepositoryInterface.php b/app/Contracts/Repository/DatabaseRepositoryInterface.php
@@ -68,9 +68,10 @@ public function createDatabase(string $database): bool;
      * @param string $username
      * @param string $remote
      * @param string $password
+     * @param string $max_connections
      * @return bool
      */
-    public function createUser(string $username, string $remote, string $password): bool;
+    public function createUser(string $username, string $remote, string $password, string $max_connections): bool;
 
     /**
      * Give a specific user access to a given database.
diff --git a/app/Models/Database.php b/app/Models/Database.php
@@ -30,7 +30,7 @@ class Database extends Model
      * @var array
      */
     protected $fillable = [
-        'server_id', 'database_host_id', 'database', 'username', 'password', 'remote',
+        'server_id', 'database_host_id', 'database', 'username', 'password', 'remote', 'max_connections',
     ];
 
     /**
@@ -51,6 +51,7 @@ class Database extends Model
         'database_host_id' => 'required|exists:database_hosts,id',
         'database' => 'required|string|alpha_dash|between:3,100',
         'username' => 'string|alpha_dash|between:3,100',
+        'max_connections' => 'string',
         'remote' => 'required|string|regex:/^[0-9%.]{1,15}$/',
         'password' => 'string',
     ];
diff --git a/app/Repositories/Eloquent/DatabaseRepository.php b/app/Repositories/Eloquent/DatabaseRepository.php
@@ -135,11 +135,12 @@ public function createDatabase(string $database): bool
      * @param string $username
      * @param string $remote
      * @param string $password
+     * @param string $max_connections
      * @return bool
      */
-    public function createUser(string $username, string $remote, string $password): bool
+    public function createUser(string $username, string $remote, string $password, string $max_connections): bool
     {
-        return $this->run(sprintf('CREATE USER `%s`@`%s` IDENTIFIED BY \'%s\'', $username, $remote, $password));
+        return $this->run(sprintf('CREATE USER `%s`@`%s` IDENTIFIED BY \'%s\' WITH MAX_USER_CONNECTIONS %s', $username, $remote, $password, $max_connections));
     }
 
     /**
diff --git a/app/Services/Databases/DatabaseManagementService.php b/app/Services/Databases/DatabaseManagementService.php
@@ -84,7 +84,8 @@ public function create($server, array $data)
             $this->repository->createUser(
                 $database->username,
                 $database->remote,
-                $this->encrypter->decrypt($database->password)
+                $this->encrypter->decrypt($database->password),
+                $database->max_connections
             );
             $this->repository->assignUserToDatabase(
                 $database->database,
diff --git a/app/Services/Databases/DatabasePasswordService.php b/app/Services/Databases/DatabasePasswordService.php
@@ -71,7 +71,7 @@ public function handle(Database $database): string
             ]);
 
             $this->repository->dropUser($database->username, $database->remote);
-            $this->repository->createUser($database->username, $database->remote, $password);
+            $this->repository->createUser($database->username, $database->remote, $password, $database->max_connections);
             $this->repository->assignUserToDatabase($database->database, $database->username, $database->remote);
             $this->repository->flush();
         });
diff --git a/app/Transformers/Api/Application/ServerDatabaseTransformer.php b/app/Transformers/Api/Application/ServerDatabaseTransformer.php
@@ -56,6 +56,7 @@ public function transform(Database $model): array
             'database' => $model->database,
             'username' => $model->username,
             'remote' => $model->remote,
+            'max_connections' => $model->max_connections,
             'created_at' => Chronos::createFromFormat(Chronos::DEFAULT_TO_STRING_FORMAT, $model->created_at)
                 ->setTimezone(config('app.timezone'))
                 ->toIso8601String(),
diff --git a/database/migrations/2020_04_22_055500_add_max_connections_column.php b/database/migrations/2020_04_22_055500_add_max_connections_column.php
@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddMaxConnectionsColumnToDatabasesTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('databases', function (Blueprint $table) {
+            $table->integer('max_connections')->nullable(false)->default(0)->after('password');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('databases', function (Blueprint $table) {
+            $table->dropColumn('max_connections');
+        });
+    }
+}
diff --git a/resources/scripts/components/server/databases/DatabaseRow.tsx b/resources/scripts/components/server/databases/DatabaseRow.tsx
@@ -151,6 +151,10 @@ export default ({ database, className }: Props) => {
                     <p className={'text-sm'}>{database.username}</p>
                     <p className={'mt-1 text-2xs text-neutral-500 uppercase select-none'}>Username</p>
                 </div>
+                <div className={'ml-8 text-center'}>
+                    <p className={'text-sm'}>{database.max_connections}</p>
+                    <p className={'mt-1 text-2xs text-neutral-500 uppercase select-none'}>Max Connections</p>
+                </div>
                 <div className={'ml-8'}>
                     <button className={'btn btn-sm btn-secondary mr-2'} onClick={() => setConnectionVisible(true)}>
                         <FontAwesomeIcon icon={faEye} fixedWidth={true}/>
diff --git a/resources/views/admin/databases/view.blade.php b/resources/views/admin/databases/view.blade.php
@@ -99,6 +99,7 @@
                         <th>Database Name</th>
                         <th>Username</th>
                         <th>Connections From</th>
+                        <th>Max Connections</th>
                         <th></th>
                     </tr>
                     @foreach($databases as $database)
@@ -107,6 +108,7 @@
                             <td class="middle">{{ $database->database }}</td>
                             <td class="middle">{{ $database->username }}</td>
                             <td class="middle">{{ $database->remote }}</td>
+                            <td class="middle">{{ $database->max_connections }}</td>
                             <td class="text-center">
                                 <a href="{{ route('admin.servers.view.database', $database->getRelation('server')->id) }}">
                                     <button class="btn btn-xs btn-primary">Manage</button>
diff --git a/resources/views/admin/servers/view/database.blade.php b/resources/views/admin/servers/view/database.blade.php
@@ -37,6 +37,7 @@
                         <th>Username</th>
                         <th>Connections From</th>
                         <th>Host</th>
+                        <th>Max Conenctions</th>
                         <th></th>
                     </tr>
                     @foreach($server->databases as $database)
@@ -45,6 +46,7 @@
                             <td>{{ $database->username }}</td>
                             <td>{{ $database->remote }}</td>
                             <td><code>{{ $database->host->host }}:{{ $database->host->port }}</code></td>
+                            <td>{{ $database->max_connections }}</td>
                             <td class="text-center">
                                 <button data-action="reset-password" data-id="{{ $database->id }}" class="btn btn-xs btn-primary"><i class="fa fa-refresh"></i></button>
                                 <button data-action="remove" data-id="{{ $database->id }}" class="btn btn-xs btn-danger"><i class="fa fa-trash"></i></button>
@@ -83,6 +85,11 @@
                         <input id="pRemote" type="text" name="remote" class="form-control" value="%" />
                         <p class="text-muted small">This should reflect the IP address that connections are allowed from. Uses standard MySQL notation. If unsure leave as <code>%</code>.</p>
                     </div>
+                    <div class="form-group">
+                        <label for="pmax_connections" class="control-label">Max Concurrent Connections</label>
+                        <input id="pmax_connections" type="text" name="max_connections" class="form-control" value="150" />
+                        <p class="text-muted small">This should reflect the max number of concurrent connections from this user to the database. Use <code>0</code> for unlimited</p>
+                    </div>
                 </div>
                 <div class="box-footer">
                     {!! csrf_field() !!}

Original file line number	Diff line number	Diff line change
`@@ -135,11 +135,12 @@ public function createDatabase(string $database): bool`
`135`	`135`	`* @param string $username`
`136`	`136`	`* @param string $remote`
`137`	`137`	`* @param string $password`
	`138`	`+ * @param string $max_connections`
`138`	`139`	`* @return bool`
`139`	`140`	`*/`
`140`		`- public function createUser(string $username, string $remote, string $password): bool`
	`141`	`+ public function createUser(string $username, string $remote, string $password, string $max_connections): bool`
`141`	`142`	`{`
`142`		- return $this->run(sprintf('CREATE USER `%s`@`%s` IDENTIFIED BY \'%s\'', $username, $remote, $password));
	`143`	+ return $this->run(sprintf('CREATE USER `%s`@`%s` IDENTIFIED BY \'%s\' WITH MAX_USER_CONNECTIONS %s', $username, $remote, $password, $max_connections));
`143`	`144`	`}`
`144`	`145`
`145`	`146`	`/**`