1abd10f9041f16fd8bcc840be813c546c745b91d
[strongswan.git] / src / libstrongswan / crypto / proposal / proposal_keywords.h
1 /*
2 * Copyright (c) 2012 Nanoteq Pty Ltd
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 * THE SOFTWARE.
21 */
22
23 /**
24 * @defgroup proposal_keywords proposal_keywords
25 * @{ @ingroup crypto
26 */
27
28 #ifndef PROPOSAL_KEYWORDS_H_
29 #define PROPOSAL_KEYWORDS_H_
30
31 #include <crypto/transform.h>
32
33 typedef struct proposal_token proposal_token_t;
34
35 /**
36 * Class representing a proposal token..
37 */
38 struct proposal_token {
39
40 /**
41 * The name of the token.
42 */
43 char *name;
44
45 /**
46 * The type of transform in the token.
47 */
48 transform_type_t type;
49
50 /**
51 * The IKE id of the algorithm.
52 */
53 u_int16_t algorithm;
54
55 /**
56 * The key size associated with the specific algorithm.
57 */
58 u_int16_t keysize;
59 };
60
61 /**
62 * Returns a proposal token for the specified string if a token exists.
63 *
64 * @param str the string containing the name of the token
65 * @param len the length of the string
66 * @return proposal_tolen if found otherwise NULL
67 */
68 const proposal_token_t* proposal_get_token(const char *str, u_int len);
69
70 #endif /** PROPOSAL_KEYWORDS_H_ @}*/