2 // Open Service Platform
3 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
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
9 // http://www.apache.org/licenses/LICENSE-2.0
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.
19 * @file FSecPkcsInitialVector.h
20 * @brief This is the header file for the %InitialVector class.
22 * This header file contains the declarations of the %InitialVector class.
25 #ifndef _FSEC_PKCS_INITIAL_VECTOR_H_
26 #define _FSEC_PKCS_INITIAL_VECTOR_H_
28 #include <FBaseByteBuffer.h>
29 #include <FSecPkcsIAlgorithmParameters.h>
30 #include <FSecPkcsTypes.h>
32 namespace Tizen { namespace Security { namespace Pkcs
36 * @class InitialVector
37 * @brief This class implements the functionalities specified by the %InitialVector class.
41 * The %InitialVector class implements the functionalities specified by the %InitialVector class.
42 * This class represents the Initial Vector parameter for symmetric ciphers such as DES, AES, DES_EDE.
43 * This %InitialVector parameters will be used by both PKCS05 and PKCS08 related classes at the time of encryption.
48 class _OSP_EXPORT_ InitialVector
49 : public virtual IAlgorithmParameters
50 , public Tizen::Base::Object
55 * The object is not fully constructed after this constructor is called. @n
56 * For full construction, the Construct() method must be called right after calling this constructor.
63 * This destructor overrides Tizen::Base::Object::~Object().
68 virtual ~InitialVector(void);
71 * Initializes this instance of %InitialVector with the specified input buffer.
75 * @return An error code
77 * @param[in] initialVector An instance of Tizen::Base::ByteBuffer, holding the initial vector data
78 * @exception E_SUCCESS The method is successful.
79 * @exception E_INVALID_ARG The specified input parameter is invalid.
81 result Construct(const Tizen::Base::ByteBuffer& initialVector);
84 * Gets copy of this instance.
88 * @return A pointer to IAlgorithmParameters, containing the copy of this instance
89 * @remarks The specific error code can be accessed using the GetLastResult() method.
91 virtual IAlgorithmParameters* CloneN(void) const;
94 * Gets the algorithm parameter type enum value for Initial Vector.
98 * @return PkcsAlgorithmParameterType Enum value containing the PKCS_ALGO_PARAM_TYPE_IV value for Initial Vector parameter
101 virtual PkcsAlgorithmParameterType GetType(void) const;
104 * Checks whether the specified instance of %InitialVector equals the current instance.
108 * @return @c true if the specified instance equals the current instance, @n
110 * @param[in] rhs An instance of %InitialVector
111 * @exception E_SUCCESS The method is successful.
112 * @exception E_INVALID_ARG The specified input parameter is invalid.
113 * @remarks The specific error code can be accessed using the GetLastResult() method.
115 virtual bool Equals(const Tizen::Base::Object& rhs) const;
118 * Gets the hash value of the current instance of %InitialVector.
122 * @return An integer value indicating the hash value of the current instance of %InitialVector
124 virtual int GetHashCode(void) const;
127 * Gets the instance of Tizen::Base::ByteBuffer that contains the Initial Vector value.
131 * @return A reference to the Tizen::Base::ByteBuffer class that contains the output
133 const Tizen::Base::ByteBuffer& GetInitialVector(void) const;
136 * Gets the encoded form of the InitialVector. @n
137 * It is assumed that each InitialVector type will have only a single form of encoding that is DER encoding.
141 * @return Pointer to the DER encoded Tizen::Base::ByteBuffer, @n
142 * else @c null if an error occurs
143 * @exception E_SUCCESS The method is successful.
144 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
145 * @remarks The specific error code can be accessed using the GetLastResult() method.
147 Tizen::Base::ByteBuffer* GetEncodedDataN(void) const;
150 // This copy constructor is intentionally declared as private to prohibit @n
151 // copying of objects by users.
154 InitialVector(const InitialVector& rhs);
156 // The implementation of this copy assignment operator is intentionally blank and @n
157 // declared as private to prohibit copying of objects.Use CloneN() to get an exact copy of the instance. @n
158 // Use Equals() to compare the contents of one instance with the other.
161 InitialVector& operator =(const InitialVector& rhs);
164 class _InitialVectorImpl* __pInitialVectorImpl;
165 friend class _InitialVectorImpl;
169 } } } //Tizen::Security::Pkcs
171 #endif //_FSEC_PKCS_INITIAL_VECTOR_H_