inc/FSecPkcsIAlgorithmParameters.h

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