inc/FSecPkcsIAlgorithmParameters.h

   1 //
   2 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18  * @file                FSecPkcsIAlgorithmParameters.h
  19  * @brief               This is the header file for the %IAlgorithmParameters interface.
  20  *
  21  * This header file contains the declarations of the %IAlgorithmParameters interface.
  22  */
  23
  24 #ifndef _FSEC_PKCS_IALGORITHM_PARAMETERS_H_
  25 #define _FSEC_PKCS_IALGORITHM_PARAMETERS_H_
  26
  27 #include <FSecPkcsTypes.h>
  28
  29 namespace Tizen { namespace Security { namespace Pkcs
  30 {
  31
  32 /**
  33  * @interface   IAlgorithmParameters
  34  * @brief               This interface is an interface class for cryptographic algorithm parameters such as IV, etc. It provides the generic
  35  *                                      functionalities that must be supported by all derived algorithm parameters such PbKdf2Parameters, PbEs2Parameters.
  36  *
  37  * @since               2.1
  38  *
  39  * The %IAlgorithmParameters interface is an interface class for cryptographic algorithm parameters such as IV, etc. It provides the generic
  40  *                                      functionalities that must be supported by all derived algorithm parameters such PbKdf2Parameters, PbEs2Parameters.
  41  *                                      This is an abstract class and hence, object of this class cannot be instantiated.
  42  *
  43  */
  44
  45 class _OSP_EXPORT_ IAlgorithmParameters
  46 {
  47 public:
  48         /**
  49          * This polymorphic destructor should be overridden if required. This way, @n
  50          * the destructors of the derived classes are called when the destructor of this interface is called.
  51          *
  52          * @since               2.1
  53          */
  54         virtual ~IAlgorithmParameters(void) {}
  55
  56         /**
  57          * Gets the copy of parameters of the specified algorithm type.
  58          *
  59          * @since                       2.1
  60          *
  61          * @return              Pointer to AlgorithmParameters, containing the instance of algorithm parameter , @n
  62          *                                              else @c null if an error occurs
  63          * @remarks             The specific error code can be accessed using the GetLastResult() method.
  64          */
  65         virtual IAlgorithmParameters* CloneN(void) const = 0;
  66
  67         /**
  68          * Gets the PKCS algorithm parameter type enumerated value.
  69          *
  70          * @since                       2.1
  71          *
  72          * @return              PkcsAlgorithmParamterType, containing the enumerated value of PkcsAlgorithmParameterType
  73          *
  74          */
  75         virtual PkcsAlgorithmParameterType GetType(void) const = 0;
  76
  77
  78 protected:
  79         //
  80         // This method is for internal use only. Using this method can cause behavioral, security-related,
  81         // and consistency-related issues in the application.
  82         //
  83         // This method is reserved and may change its name at any time without prior notice.
  84         //
  85         // @since       2.1
  86         //
  87         virtual void IAlgorithmParameters_Reserved1(void) {}
  88
  89         //
  90         // This method is for internal use only. Using this method can cause behavioral, security-related,
  91         // and consistency-related issues in the application.
  92         //
  93         // This method is reserved and may change its name at any time without prior notice.
  94         //
  95         // @since       2.1
  96         //
  97         virtual void IAlgorithmParameters_Reserved2(void) {}
  98
  99         //
 100         // This method is for internal use only. Using this method can cause behavioral, security-related,
 101         // and consistency-related issues in the application.
 102         //
 103         // This method is reserved and may change its name at any time without prior notice.
 104         //
 105         // @since       2.1
 106         //
 107         virtual void IAlgorithmParameters_Reserved3(void) {}
 108
 109 }; // IAlgorithmParameters
 110
 111 } } } // Tizen::Security::Pkcs
 112
 113 #endif // _FSEC_PKCS_IAGORITHM_PARAMETERS_H_