2015-12-06 13:58:49 -05:00
< ? php
2016-12-07 22:46:38 +00:00
2015-12-06 13:58:49 -05:00
namespace Pterodactyl\Models ;
2019-11-03 17:13:47 -08:00
use Illuminate\Support\Collection ;
2020-04-03 23:22:35 -07:00
class Permission extends Model
2015-12-06 13:58:49 -05:00
{
2018-01-25 21:26:06 -06:00
/**
* The resource name for this model when it is transformed into an
* API representation using fractal .
*/
2021-01-23 12:33:34 -08:00
public const RESOURCE_NAME = 'subuser_permission' ;
2018-01-25 21:26:06 -06:00
2020-03-18 21:08:32 -07:00
/**
* Constants defining different permissions available .
*/
2021-01-23 12:33:34 -08:00
public const ACTION_WEBSOCKET_CONNECT = 'websocket.connect' ;
public const ACTION_CONTROL_CONSOLE = 'control.console' ;
public const ACTION_CONTROL_START = 'control.start' ;
public const ACTION_CONTROL_STOP = 'control.stop' ;
public const ACTION_CONTROL_RESTART = 'control.restart' ;
public const ACTION_DATABASE_READ = 'database.read' ;
public const ACTION_DATABASE_CREATE = 'database.create' ;
public const ACTION_DATABASE_UPDATE = 'database.update' ;
public const ACTION_DATABASE_DELETE = 'database.delete' ;
public const ACTION_DATABASE_VIEW_PASSWORD = 'database.view_password' ;
public const ACTION_SCHEDULE_READ = 'schedule.read' ;
public const ACTION_SCHEDULE_CREATE = 'schedule.create' ;
public const ACTION_SCHEDULE_UPDATE = 'schedule.update' ;
public const ACTION_SCHEDULE_DELETE = 'schedule.delete' ;
public const ACTION_USER_READ = 'user.read' ;
public const ACTION_USER_CREATE = 'user.create' ;
public const ACTION_USER_UPDATE = 'user.update' ;
public const ACTION_USER_DELETE = 'user.delete' ;
public const ACTION_BACKUP_READ = 'backup.read' ;
public const ACTION_BACKUP_CREATE = 'backup.create' ;
public const ACTION_BACKUP_DELETE = 'backup.delete' ;
public const ACTION_BACKUP_DOWNLOAD = 'backup.download' ;
2021-01-25 19:16:40 -08:00
public const ACTION_BACKUP_RESTORE = 'backup.restore' ;
2021-01-23 12:33:34 -08:00
public const ACTION_ALLOCATION_READ = 'allocation.read' ;
public const ACTION_ALLOCATION_CREATE = 'allocation.create' ;
public const ACTION_ALLOCATION_UPDATE = 'allocation.update' ;
public const ACTION_ALLOCATION_DELETE = 'allocation.delete' ;
public const ACTION_FILE_READ = 'file.read' ;
public const ACTION_FILE_READ_CONTENT = 'file.read-content' ;
public const ACTION_FILE_CREATE = 'file.create' ;
public const ACTION_FILE_UPDATE = 'file.update' ;
public const ACTION_FILE_DELETE = 'file.delete' ;
public const ACTION_FILE_ARCHIVE = 'file.archive' ;
public const ACTION_FILE_SFTP = 'file.sftp' ;
public const ACTION_STARTUP_READ = 'startup.read' ;
public const ACTION_STARTUP_UPDATE = 'startup.update' ;
public const ACTION_STARTUP_DOCKER_IMAGE = 'startup.docker-image' ;
public const ACTION_SETTINGS_RENAME = 'settings.rename' ;
public const ACTION_SETTINGS_REINSTALL = 'settings.reinstall' ;
2020-03-22 15:31:25 -07:00
2022-06-12 15:16:48 -04:00
public const ACTION_ACTIVITY_READ = 'activity.read' ;
2017-02-09 19:38:54 -05:00
/**
* Should timestamps be used on this model .
*/
public $timestamps = false ;
2015-12-06 13:58:49 -05:00
/**
* The table associated with the model .
*/
protected $table = 'permissions' ;
2016-01-18 19:57:10 -05:00
/**
* Fields that are not mass assignable .
*/
protected $guarded = [ 'id' , 'created_at' , 'updated_at' ];
2017-02-09 18:44:07 -05:00
/**
* Cast values to correct type .
*/
protected $casts = [
'subuser_id' => 'integer' ,
];
2016-01-26 22:17:51 -05:00
2022-10-14 10:59:20 -06:00
public static array $validationRules = [
2019-09-04 22:19:57 -07:00
'subuser_id' => 'required|numeric|min:1' ,
'permission' => 'required|string' ,
2017-09-24 21:12:30 -05:00
];
2017-03-30 15:30:59 -04:00
/**
2022-10-14 10:59:20 -06:00
* All the permissions available on the system . You should use self :: permissions ()
2019-11-03 17:13:47 -08:00
* to retrieve them , and not directly access this array as it is subject to change .
2017-03-30 15:30:59 -04:00
*
2019-11-03 17:13:47 -08:00
* @ see \Pterodactyl\Models\Permission :: permissions ()
2017-03-30 15:30:59 -04:00
*/
2022-10-14 10:59:20 -06:00
protected static array $permissions = [
2019-11-03 17:13:47 -08:00
'websocket' => [
2020-03-25 21:58:37 -07:00
'description' => 'Allows the user to connect to the server websocket, giving them access to view console output and realtime server stats.' ,
'keys' => [
2020-04-17 10:21:15 -07:00
'connect' => 'Allows a user to connect to the websocket instance for a server to stream the console.' ,
2020-03-25 21:58:37 -07:00
],
2019-11-03 17:13:47 -08:00
],
'control' => [
2020-03-25 21:58:37 -07:00
'description' => 'Permissions that control a user\'s ability to control the power state of a server, or send commands.' ,
'keys' => [
'console' => 'Allows a user to send commands to the server instance via the console.' ,
'start' => 'Allows a user to start the server if it is stopped.' ,
'stop' => 'Allows a user to stop a server if it is running.' ,
'restart' => 'Allows a user to perform a server restart. This allows them to start the server if it is offline, but not put the server in a completely stopped state.' ,
],
2019-11-03 17:13:47 -08:00
],
'user' => [
2020-03-25 21:58:37 -07:00
'description' => 'Permissions that allow a user to manage other subusers on a server. They will never be able to edit their own account, or assign permissions they do not have themselves.' ,
'keys' => [
'create' => 'Allows a user to create new subusers for the server.' ,
'read' => 'Allows the user to view subusers and their permissions for the server.' ,
'update' => 'Allows a user to modify other subusers.' ,
'delete' => 'Allows a user to delete a subuser from the server.' ,
],
2019-11-03 17:13:47 -08:00
],
'file' => [
2020-03-25 21:58:37 -07:00
'description' => 'Permissions that control a user\'s ability to modify the filesystem for this server.' ,
'keys' => [
'create' => 'Allows a user to create additional files and folders via the Panel or direct upload.' ,
2020-08-31 19:36:30 -07:00
'read' => 'Allows a user to view the contents of a directory, but not view the contents of or download files.' ,
'read-content' => 'Allows a user to view the contents of a given file. This will also allow the user to download files.' ,
2020-03-25 21:58:37 -07:00
'update' => 'Allows a user to update the contents of an existing file or directory.' ,
'delete' => 'Allows a user to delete files or directories.' ,
'archive' => 'Allows a user to archive the contents of a directory as well as decompress existing archives on the system.' ,
'sftp' => 'Allows a user to connect to SFTP and manage server files using the other assigned file permissions.' ,
],
2019-11-03 17:13:47 -08:00
],
2020-04-04 10:59:25 -07:00
'backup' => [
'description' => 'Permissions that control a user\'s ability to generate and manage server backups.' ,
'keys' => [
'create' => 'Allows a user to create new backups for this server.' ,
'read' => 'Allows a user to view all backups that exist for this server.' ,
'delete' => 'Allows a user to remove backups from the system.' ,
2021-01-17 17:51:09 -08:00
'download' => 'Allows a user to download a backup for the server. Danger: this allows a user to access all files for the server in the backup.' ,
2021-01-25 19:20:51 -08:00
'restore' => 'Allows a user to restore a backup for the server. Danger: this allows the user to delete all of the server files in the process.' ,
2020-04-04 10:59:25 -07:00
],
],
2019-11-03 17:13:47 -08:00
// Controls permissions for editing or viewing a server's allocations.
'allocation' => [
2020-03-25 21:58:37 -07:00
'description' => 'Permissions that control a user\'s ability to modify the port allocations for this server.' ,
'keys' => [
2020-11-07 09:57:53 -08:00
'read' => 'Allows a user to view all allocations currently assigned to this server. Users with any level of access to this server can always view the primary allocation.' ,
2020-07-09 20:36:08 -07:00
'create' => 'Allows a user to assign additional allocations to the server.' ,
'update' => 'Allows a user to change the primary server allocation and attach notes to each allocation.' ,
'delete' => 'Allows a user to delete an allocation from the server.' ,
2020-03-25 21:58:37 -07:00
],
2019-11-03 17:13:47 -08:00
],
// Controls permissions for editing or viewing a server's startup parameters.
'startup' => [
2020-03-25 21:58:37 -07:00
'description' => 'Permissions that control a user\'s ability to view this server\'s startup parameters.' ,
'keys' => [
2020-08-22 18:13:59 -07:00
'read' => 'Allows a user to view the startup variables for a server.' ,
'update' => 'Allows a user to modify the startup variables for the server.' ,
2020-12-13 11:07:29 -08:00
'docker-image' => 'Allows a user to modify the Docker image used when running the server.' ,
2020-03-25 21:58:37 -07:00
],
2019-11-03 17:13:47 -08:00
],
'database' => [
2020-03-25 21:58:37 -07:00
'description' => 'Permissions that control a user\'s access to the database management for this server.' ,
'keys' => [
'create' => 'Allows a user to create a new database for this server.' ,
'read' => 'Allows a user to view the database associated with this server.' ,
'update' => 'Allows a user to rotate the password on a database instance. If the user does not have the view_password permission they will not see the updated password.' ,
'delete' => 'Allows a user to remove a database instance from this server.' ,
'view_password' => 'Allows a user to view the password associated with a database instance for this server.' ,
],
2019-11-03 17:13:47 -08:00
],
'schedule' => [
2020-03-25 21:58:37 -07:00
'description' => 'Permissions that control a user\'s access to the schedule management for this server.' ,
'keys' => [
2020-11-03 16:11:59 -05:00
'create' => 'Allows a user to create new schedules for this server.' , // task.create-schedule
'read' => 'Allows a user to view schedules and the tasks associated with them for this server.' , // task.view-schedule, task.list-schedules
'update' => 'Allows a user to update schedules and schedule tasks for this server.' , // task.edit-schedule, task.queue-schedule, task.toggle-schedule
'delete' => 'Allows a user to delete schedules for this server.' , // task.delete-schedule
2020-03-25 21:58:37 -07:00
],
2019-11-03 17:13:47 -08:00
],
2020-03-22 15:31:25 -07:00
'settings' => [
2020-03-25 21:58:37 -07:00
'description' => 'Permissions that control a user\'s access to the settings for this server.' ,
'keys' => [
2020-11-03 16:11:59 -05:00
'rename' => 'Allows a user to rename this server.' ,
'reinstall' => 'Allows a user to trigger a reinstall of this server.' ,
2020-03-25 21:58:37 -07:00
],
2020-03-22 15:31:25 -07:00
],
2022-06-12 15:16:48 -04:00
'activity' => [
'description' => 'Permissions that control a user\'s access to the server activity logs.' ,
'keys' => [
'read' => 'Allows a user to view the activity logs for the server.' ,
],
],
2019-11-03 17:13:47 -08:00
];
/**
2022-10-14 10:59:20 -06:00
* Returns all the permissions available on the system for a user to
2019-11-03 17:13:47 -08:00
* have when controlling a server .
*/
public static function permissions () : Collection
{
return Collection :: make ( self :: $permissions );
}
2015-12-06 13:58:49 -05:00
}