Fix warning related mandatory comments
[platform/core/csapi/security.git] / Tizen.Security / Tizen.Security.SecureRepository / Crypto / AesCtrCipherParameters.cs
1 /*
2  *  Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
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 namespace Tizen.Security.SecureRepository.Crypto
18 {
19     /// <summary>
20     /// A class holding parameters for AES algorithm with counter mode.
21     /// </summary>
22     public class AesCtrCipherParameters : AesCipherParameters
23     {
24         /// <summary>
25         /// A default constructor
26         /// </summary>
27         /// <remarks>The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCtr.</remarks>
28         public AesCtrCipherParameters() : base(CipherAlgorithmType.AesCtr)
29         {
30         }
31
32         /// <summary>
33         /// Length of counter block in bits. 
34         /// </summary>
35         /// <remarks>Optional, only 128b is supported at the moment.</remarks>
36         public long CounterLength
37         {
38             get
39             {
40                 return (uint)GetInteger(CipherParameterName.CounterLength);
41             }
42             set
43             {
44                 Add(CipherParameterName.CounterLength, value);
45             }
46         }
47     }
48 }