2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
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
8 // http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file FSecISecureRandom.h
19 * @brief This is the header file for the %ISecureRandom interface.
21 * This header file contains the declarations of the %ISecureRandom interface.
23 #ifndef _FSEC_ISECURE_RANDOM_H_
24 #define _FSEC_ISECURE_RANDOM_H_
26 #include <FBaseString.h>
27 #include <FBaseByteBuffer.h>
29 namespace Tizen { namespace Security
33 * @interface ISecureRandom
34 * @brief This interface provides the abstract methods for generating a secure random object.
38 * The %ISecureRandom interface provides the abstract methods for generating a secure random object. @n
40 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/key_mgmt_and_csprng.htm">Key Management and CSPRNG</a>.
42 * @see Tizen::Security::AesSecureRandom
43 * @see Tizen::Security::DesSecureRandom
44 * @see Tizen::Security::DesEdeSecureRandom
46 class _OSP_EXPORT_ ISecureRandom
51 * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n
52 * are called when the destructor of this interface is called.
56 virtual ~ISecureRandom(void) {}
59 * Generates a user-specified number of random bytes.
63 * @return A pointer to the Tizen::Base::ByteBuffer class, @n
64 * else @c null if an error occurs
65 * @param[in] numBytes The number of random bytes to generate
66 * @exception E_SUCCESS The method is successful.
67 * @exception E_OUT_OF_MEMORY The memory is insufficient.
68 * @exception E_INVALID_ARG The specified @c numBytes is @c 0 or negative.
69 * @exception E_SYSTEM A system error has occurred. @n
70 * The method has failed to operate with the OpenSSL library, or the Tizen::Base::ByteBuffer operation has failed.
71 * @remarks The specific error code can be accessed using the GetLastResult() method.
74 virtual Tizen::Base::ByteBuffer* GenerateRandomBytesN(int numBytes) = 0;
78 // This method is for internal use only. Using this method can cause behavioral, security-related,
79 // and consistency-related issues in the application.
81 // This method is reserved and may change its name at any time without prior notice.
85 virtual void ISecureRandom_Reserved1(void) {}
91 #endif // _FSEC_ISECURE_RANDOM_H_