handler_authorize_login.h

Go to the documentation of this file.

/*
  Copyright (c) 2021, 2025, Oracle and/or its affiliates.
 
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License, version 2.0,
  as published by the Free Software Foundation.
 
  This program is designed to work with certain software (including
  but not limited to OpenSSL) that is licensed under separate terms,
  as designated in a particular file or component or in included license
  documentation.  The authors of MySQL hereby grant you an additional
  permission to link the program and your derivative works with the
  separately licensed software that they have either included with
  the program or referenced in the documentation.
 
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
 
#ifndef ROUTER_SRC_MYSQL_REST_SERVICE_SRC_MRS_ENDPOINT_HANDLER_AUTHENTICATION_AUTHORIZE_LOGIN_H_
#define ROUTER_SRC_MYSQL_REST_SERVICE_SRC_MRS_ENDPOINT_HANDLER_AUTHENTICATION_AUTHORIZE_LOGIN_H_
 
#include <optional>
#include <string>
#include <vector>
 
#include "helper/media_type.h"
#include "mrs/endpoint/handler/authentication/handler_authorize_base.h"
#include "mrs/interface/authorize_manager.h"
#include "mysql/harness/matcher_interface.h"
 
namespace mrs {
namespace endpoint {
namespace handler {
 
class HandlerAuthorizeLogin : public HandlerAuthorizeBase {
 public:
  using Session = http::SessionManager::Session;
  using SessionPtr = http::SessionManager::SessionPtr;
  using Matcher = ::mysql_harness::MatcherInterface;
 
 public:
  HandlerAuthorizeLogin(const Protocol protocol, const std::string &url_host,
                        const UniversalId service_id,
                        const std::string &service_path,
                        const UriPathMatcher &rest_path_matcher,
                        const std::string &options,
                        const std::string &redirection,
                        const std::optional<std::string> &redirection_validator,
                        interface::AuthorizeManager *auth_manager);
 
  Authorization requires_authentication() const override;
  bool may_check_access() const override;
  UniversalId get_service_id() const override;
  UniversalId get_db_object_id() const override;
  UniversalId get_schema_id() const override;
  const std::string &get_service_path() const override;
  const std::string &get_db_object_path() const override;
  const std::string &get_schema_path() const override;
  uint32_t get_access_rights() const override;
 
  bool request_begin(RequestContext *) override;
  bool request_error(RequestContext *ctxt, const http::Error &e) override;
 
  HttpResult handle_get(RequestContext *ctxt) override;
  HttpResult handle_post(RequestContext *ctxt,
                         const std::vector<uint8_t> &document) override;
  HttpResult handle_delete(RequestContext *ctxt) override;
  HttpResult handle_put(RequestContext *ctxt) override;
 
 private:
  std::string append_status_parameters(const SessionPtr &session,
                                       const http::Error &error) const;
  void set_session_cookie(RequestContext *ctxt) const;
 
  UniversalId service_id_;
  const std::string service_path_;
  const std::string redirection_;
  std::string copy_url_;
  std::string copy_path_;
  std::shared_ptr<Matcher> redirection_validator_;
};
 
}  // namespace handler
}  // namespace endpoint
}  // namespace mrs
 
#endif  // ROUTER_SRC_MYSQL_REST_SERVICE_SRC_MRS_ENDPOINT_HANDLER_AUTHENTICATION_AUTHORIZE_LOGIN_H_