AuditCheckTrait.php
1 year ago
CoreUserRoleOptionIntegrityCheck.php
1 year ago
EditableFileSystemCheck.php
7 months ago
ElevatedCoreRoleCheck.php
7 months ago
EmptyUnusedRoleCheck.php
7 months ago
HighPrivilegeContentModeratorCheck.php
7 months ago
HighPrivilegeOrElevatedUserCheck.php
7 months ago
HighPrivilegeRoleCheck.php
7 months ago
HighPrivilegeUserCountCheck.php
7 months ago
RestfulAutoDiscoverEndpointCheck.php
7 months ago
RoleCapabilityNamingConventionCheck.php
7 months ago
RoleIntegrityCheck.php
7 months ago
RoleTransparencyCheck.php
7 months ago
XmlRpcEndpointCheck.php
7 months ago
CoreUserRoleOptionIntegrityCheck.php
161 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * ====================================================================== |
| 5 | * LICENSE: This file is subject to the terms and conditions defined in * |
| 6 | * file 'license.txt', which is part of this source code package. * |
| 7 | * ====================================================================== |
| 8 | */ |
| 9 | |
| 10 | /** |
| 11 | * Role integrity audit check |
| 12 | * |
| 13 | * @package AAM |
| 14 | * @version 7.0.0 |
| 15 | */ |
| 16 | class AAM_Audit_CoreUserRoleOptionIntegrityCheck |
| 17 | { |
| 18 | |
| 19 | use AAM_Audit_AuditCheckTrait; |
| 20 | |
| 21 | /** |
| 22 | * Step ID |
| 23 | * |
| 24 | * @version 7.0.0 |
| 25 | */ |
| 26 | const ID = 'user_roles_option_integrity'; |
| 27 | |
| 28 | /** |
| 29 | * Run the check |
| 30 | * |
| 31 | * @return array |
| 32 | * |
| 33 | * @access public |
| 34 | * @static |
| 35 | * |
| 36 | * @version 7.0.0 |
| 37 | */ |
| 38 | public static function run() |
| 39 | { |
| 40 | $issues = []; |
| 41 | $response = [ 'is_completed' => true ]; |
| 42 | |
| 43 | try { |
| 44 | $db_roles = self::_read_role_key_option(); |
| 45 | |
| 46 | // The core user_roles structure is intact and not deviated from |
| 47 | // the WordPress core original standard |
| 48 | array_push( |
| 49 | $issues, |
| 50 | ...self::_validate_core_option_structure($db_roles) |
| 51 | ); |
| 52 | } catch (Exception $e) { |
| 53 | array_push($issues, self::_format_issue( |
| 54 | 'APPLICATION_ERROR', |
| 55 | [ |
| 56 | 'message' => $e->getMessage() |
| 57 | ], |
| 58 | 'error' |
| 59 | )); |
| 60 | } |
| 61 | |
| 62 | if (count($issues) > 0) { |
| 63 | $response['issues'] = $issues; |
| 64 | } |
| 65 | |
| 66 | // Determine final status for the check |
| 67 | self::_determine_check_status($response); |
| 68 | |
| 69 | return $response; |
| 70 | } |
| 71 | |
| 72 | /** |
| 73 | * Get a collection of error messages for current step |
| 74 | * |
| 75 | * @return array |
| 76 | * @access private |
| 77 | * @static |
| 78 | * |
| 79 | * @version 7.0.0 |
| 80 | */ |
| 81 | private static function _get_message_templates() |
| 82 | { |
| 83 | return [ |
| 84 | 'INVALID_ROLE_SLUG' => __( |
| 85 | 'Detected role %s (%s) with invalid slug', |
| 86 | 'advanced-access-manager' |
| 87 | ), |
| 88 | 'ILLEGAL_ROLE_PROPERTY' => __( |
| 89 | 'Detected role %s (%s) with invalid properties: %s', |
| 90 | 'advanced-access-manager' |
| 91 | ), |
| 92 | 'MISSING_ROLE_PROPERTY' => __( |
| 93 | 'Detected role %s (%s) with missing mandatory properties: %s', |
| 94 | 'advanced-access-manager' |
| 95 | ) |
| 96 | ]; |
| 97 | } |
| 98 | |
| 99 | /** |
| 100 | * Validate WordPress core option _user_roles |
| 101 | * |
| 102 | * @param array $db_roles |
| 103 | * |
| 104 | * @return array |
| 105 | * |
| 106 | * @access private |
| 107 | * @static |
| 108 | * |
| 109 | * @version 7.0.0 |
| 110 | */ |
| 111 | private static function _validate_core_option_structure($db_roles) |
| 112 | { |
| 113 | $response = []; |
| 114 | |
| 115 | foreach($db_roles as $role_id => $role) { |
| 116 | // Step #1. Validating that all the keys are strings |
| 117 | if (!is_string($role_id)) { |
| 118 | array_push($response, self::_format_issue( |
| 119 | 'INVALID_ROLE_SLUG', |
| 120 | [ |
| 121 | 'name' => isset($role['name']) ? $role['name'] : $role_id, |
| 122 | 'slug' => $role_id |
| 123 | ], |
| 124 | 'warning' |
| 125 | )); |
| 126 | } |
| 127 | |
| 128 | // Step #2. Verifying that each role has only proper properties & no core |
| 129 | // props are missing |
| 130 | $props = array_keys($role); |
| 131 | $invalid_props = array_diff($props, ['name', 'capabilities']); |
| 132 | $missing_props = array_diff(['name', 'capabilities'], $props); |
| 133 | |
| 134 | if (!empty($invalid_props)) { |
| 135 | array_push($response, self::_format_issue( |
| 136 | 'ILLEGAL_ROLE_PROPERTY', |
| 137 | [ |
| 138 | 'name' => isset($role['name']) ? $role['name'] : $role_id, |
| 139 | 'slug' => $role_id, |
| 140 | 'props' => $invalid_props |
| 141 | ] |
| 142 | )); |
| 143 | } |
| 144 | |
| 145 | if (!empty($missing_props)) { |
| 146 | array_push($response, self::_format_issue( |
| 147 | 'MISSING_ROLE_PROPERTY', |
| 148 | [ |
| 149 | 'name' => isset($role['name']) ? $role['name'] : $role_id, |
| 150 | 'slug' => $role_id, |
| 151 | 'props' => $missing_props |
| 152 | ], |
| 153 | 'critical' |
| 154 | )); |
| 155 | } |
| 156 | } |
| 157 | |
| 158 | return $response; |
| 159 | } |
| 160 | |
| 161 | } |