AccessDeniedRedirect.php
1 year ago
AdminToolbar.php
1 year ago
ApiRoute.php
1 year ago
BackendMenu.php
1 year ago
BackwardCompatibility.php
1 year ago
Capability.php
1 year ago
Configs.php
5 months ago
Content.php
1 year ago
Identity.php
1 year ago
Jwt.php
5 months ago
LoginRedirect.php
1 year ago
LogoutRedirect.php
1 year ago
Metabox.php
1 year ago
Mu.php
1 year ago
NotFoundRedirect.php
1 year ago
Policies.php
1 year ago
Roles.php
1 year ago
SecureLogin.php
1 year ago
SecurityAudit.php
1 year ago
ServiceTrait.php
1 year ago
Settings.php
1 year ago
Urls.php
1 year ago
Users.php
1 year ago
Widgets.php
1 year ago
SecureLogin.php
181 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 | * RESTful API for the Secure Login service |
| 12 | * |
| 13 | * @package AAM |
| 14 | * @version 7.0.0 |
| 15 | */ |
| 16 | class AAM_Restful_SecureLogin |
| 17 | { |
| 18 | |
| 19 | use AAM_Restful_ServiceTrait; |
| 20 | |
| 21 | /** |
| 22 | * Necessary permissions to access endpoint |
| 23 | * |
| 24 | * @version 7.0.0 |
| 25 | */ |
| 26 | const PERMISSIONS = [ |
| 27 | 'aam_manager', |
| 28 | 'aam_manage_admin_toolbar' |
| 29 | ]; |
| 30 | |
| 31 | /** |
| 32 | * Constructor |
| 33 | * |
| 34 | * @return void |
| 35 | * @access protected |
| 36 | * |
| 37 | * @version 7.0.0 |
| 38 | */ |
| 39 | protected function __construct() |
| 40 | { |
| 41 | // Register API endpoint |
| 42 | add_action('rest_api_init', function() { |
| 43 | // Create a redirect rule |
| 44 | $this->_register_route('/authenticate', [ |
| 45 | 'methods' => WP_REST_Server::CREATABLE, |
| 46 | 'callback' => [ $this, 'authenticate' ], |
| 47 | 'args' => [ |
| 48 | 'username' => [ |
| 49 | 'description' => 'Valid username', |
| 50 | 'type' => 'string', |
| 51 | 'required' => true |
| 52 | ], |
| 53 | 'password' => [ |
| 54 | 'description' => 'Valid password', |
| 55 | 'type' => 'string', |
| 56 | 'required' => true |
| 57 | ], |
| 58 | 'remember' => [ |
| 59 | 'description' => 'Prolong the user session.', |
| 60 | 'type' => 'boolean', |
| 61 | 'default' => false |
| 62 | ], |
| 63 | 'return_auth_cookies' => [ |
| 64 | 'description' => 'Return auth cookies.', |
| 65 | 'type' => 'boolean', |
| 66 | 'default' => false |
| 67 | ], |
| 68 | 'fields' => [ |
| 69 | 'description' => 'List of additional fields to return', |
| 70 | 'type' => 'string', |
| 71 | 'validate_callback' => function ($value) { |
| 72 | return $this->_validate_fields_input($value); |
| 73 | } |
| 74 | ] |
| 75 | ] |
| 76 | ], function() { return !is_user_logged_in(); }, false); |
| 77 | }); |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * Authenticate user |
| 82 | * |
| 83 | * @param WP_REST_Request $request |
| 84 | * |
| 85 | * @return WP_REST_Response |
| 86 | * @access public |
| 87 | * |
| 88 | * @version 7.0.0 |
| 89 | */ |
| 90 | public function authenticate(WP_REST_Request $request) |
| 91 | { |
| 92 | try { |
| 93 | // No need to generate Auth cookies, unless explicitly stated so |
| 94 | if ($request->get_param('return_auth_cookies') !== true) { |
| 95 | add_filter('send_auth_cookies', '__return_false'); |
| 96 | } |
| 97 | |
| 98 | $user = wp_signon([ |
| 99 | 'user_login' => $request->get_param('username'), |
| 100 | 'user_password' => $request->get_param('password'), |
| 101 | 'remember' => $request->get_param('remember') |
| 102 | ]); |
| 103 | |
| 104 | if (!is_wp_error($user)) { |
| 105 | $result = $this->_prepare_user_data($user, $request); |
| 106 | } else { |
| 107 | throw new DomainException($user->get_error_message()); |
| 108 | } |
| 109 | } catch (Exception $e) { |
| 110 | $result = $this->_prepare_error_response($e); |
| 111 | } |
| 112 | |
| 113 | return rest_ensure_response($result); |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Prepare user data that is returned |
| 118 | * |
| 119 | * @param WP_User $user |
| 120 | * @param WP_REST_Request $request |
| 121 | * |
| 122 | * @return array |
| 123 | * @access protected |
| 124 | * |
| 125 | * @version 7.0.0 |
| 126 | */ |
| 127 | private function _prepare_user_data($user, $request) |
| 128 | { |
| 129 | $response = []; |
| 130 | $fields = $request->get_param('fields'); |
| 131 | $props = array_unique(array_merge( |
| 132 | [ 'ID' ], is_string($fields) ? explode(',', $fields) : [] |
| 133 | )); |
| 134 | |
| 135 | foreach($props as $prop) { |
| 136 | if (isset($user->{$prop})) { |
| 137 | $response[$prop] = $user->{$prop}; |
| 138 | } |
| 139 | } |
| 140 | |
| 141 | return apply_filters( |
| 142 | 'aam_rest_authenticated_user_data_filter', $response, $request, $user |
| 143 | ); |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Validate the input field "fields" |
| 148 | * |
| 149 | * @param string|null $value Input value |
| 150 | * |
| 151 | * @return bool|WP_Error |
| 152 | * @access private |
| 153 | * |
| 154 | * @version 7.0.0 |
| 155 | */ |
| 156 | private function _validate_fields_input($value) |
| 157 | { |
| 158 | $response = true; |
| 159 | |
| 160 | if (is_string($value) && strlen($value) > 0) { |
| 161 | $invalid_fields = []; |
| 162 | |
| 163 | foreach(explode(',', $value) as $field) { |
| 164 | if (strlen(sanitize_key($field)) !== strlen($field)) { |
| 165 | $invalid_fields[] = $field; |
| 166 | } |
| 167 | } |
| 168 | |
| 169 | if (count($invalid_fields) > 0) { |
| 170 | $response = new WP_Error( |
| 171 | 'rest_invalid_param', |
| 172 | sprintf('Invalid fields: %s', implode(', ', $invalid_fields)), |
| 173 | [ 'status' => 400 ] |
| 174 | ); |
| 175 | } |
| 176 | } |
| 177 | |
| 178 | return $response; |
| 179 | } |
| 180 | |
| 181 | } |