dali/devel-api/adaptor-framework/web-engine-certificate.h

   1 #ifndef DALI_WEB_ENGINE_CERTIFICATE_H
   2 #define DALI_WEB_ENGINE_CERTIFICATE_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 namespace Dali
  25 {
  26 /**
  27  * @brief A class WebEngineCertificate for certificate of web engine.
  28  */
  29 class WebEngineCertificate
  30 {
  31 public:
  32   /**
  33    * @brief Constructor.
  34    */
  35   WebEngineCertificate() = default;
  36
  37   /**
  38    * @brief Destructor.
  39    */
  40   virtual ~WebEngineCertificate() = default;
  41
  42   /**
  43    * @brief Allow the site access about certificate error.
  44    *
  45    * @param[in] allowed A value to decide policy
  46    */
  47   virtual void Allow(bool allowed) = 0;
  48
  49   /**
  50    * @brief Returns information whether the certificate comes from main frame.
  51    *
  52    * @return true if the certificate comes from main frame, false otherwise
  53    */
  54   virtual bool IsFromMainFrame() const = 0;
  55
  56   /**
  57    * @brief Query certificate's PEM data.
  58    *
  59    * @return A certificate itself in the PEM format.
  60    */
  61   virtual std::string GetPem() const = 0;
  62
  63   /**
  64    * @brief Query if the context loaded with a given certificate is secure.
  65    *
  66    * @return true if the context is secure, false otherwise
  67    */
  68   virtual bool IsContextSecure() const = 0;
  69 };
  70
  71 } // namespace Dali
  72
  73 #endif // DALI_WEB_ENGINE_CERTIFICATE_H