summaryrefslogtreecommitdiff
path: root/src/libstrongswan/crypto/prfs/prf.h
blob: 8560a4a9cae2dc07d778908803d2e13025000131 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/**
 * @file prf.h
 * 
 * @brief Interface prf_t.
 * 
 */

/*
 * Copyright (C) 2005-2006 Martin Willi
 * Copyright (C) 2005 Jan Hutter
 * Hochschule fuer Technik Rapperswil
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 */

#ifndef PRF_H_
#define PRF_H_

typedef enum pseudo_random_function_t pseudo_random_function_t;
typedef struct prf_t prf_t;

#include <library.h>

/**
 * @brief Pseudo random function, as in IKEv2 RFC 3.3.2.
 *
 * PRF algorithms not defined in IKEv2 are allocated in "private use"
 * space.
 *
 * @ingroup prfs
 */
enum pseudo_random_function_t {
	PRF_UNDEFINED = 1024,
	/** Implemented via hmac_prf_t. */
	PRF_HMAC_MD5 = 1,
	/** Implemented via hmac_prf_t. */
	PRF_HMAC_SHA1 = 2,
	PRF_HMAC_TIGER = 3,
	PRF_AES128_CBC = 4,
	/** Implemented via hmac_prf_t. */
	PRF_HMAC_SHA2_256 = 5,
	/** Implemented via hmac_prf_t. */
	PRF_HMAC_SHA2_384 = 6,
	/** Implemented via hmac_prf_t. */
	PRF_HMAC_SHA2_512 = 7,
	/** Implemented via fips_prf_t, other output sizes would be possible */
	PRF_FIPS_SHA1_160 = 1025,
	/** Could be implemented via fips_prf_t, uses fixed output size of 160bit */
	PRF_FIPS_DES = 1026,
};

/**
 * enum name for encryption_algorithm_t.
 */
extern enum_name_t *pseudo_random_function_names;

/**
 * @brief Generic interface for pseudo-random-functions.
 * 
 * @b Constructors:
 *  - prf_create()
 *  - hmac_prf_create()
 * 
 * @todo Implement more prf algorithms
 * 
 * @ingroup prfs
 */
struct prf_t {
	/**
	 * @brief Generates pseudo random bytes and writes them in the buffer.
	 *
	 * @param this			calling object
	 * @param seed			a chunk containing the seed for the next bytes
	 * @param[out] buffer	pointer where the generated bytes will be written
	 */
	void (*get_bytes) (prf_t *this, chunk_t seed, u_int8_t *buffer);
	
	/**
	 * @brief Generates pseudo random bytes and allocate space for them.
	 * 
	 * @param this			calling object
	 * @param seed			a chunk containing the seed for the next bytes
	 * @param[out] chunk	chunk which will hold generated bytes
	 */
	void (*allocate_bytes) (prf_t *this, chunk_t seed, chunk_t *chunk);
	
	/**
	 * @brief Get the block size of this prf_t object.
	 * 
	 * @param this			calling object
	 * @return				block size in bytes
	 */
	size_t (*get_block_size) (prf_t *this);
	
	/**
	 * @brief Get the key size of this prf_t object.
	 *
	 * This is a suggestion only, all implemented PRFs accept variable key
	 * length.
	 * 
	 * @param this			calling object
	 * @return				key size in bytes
	 */
	size_t (*get_key_size) (prf_t *this);
	
	/**
	 * @brief Set the key for this prf_t object.
	 * 
	 * @param this			calling object
	 * @param key			key to set
	 */
	void (*set_key) (prf_t *this, chunk_t key);
	
	/**
	 * @brief Destroys a prf object.
	 *
	 * @param this 			calling object
	 */
	void (*destroy) (prf_t *this);
};

/**
 * @brief Generic constructor for a prf_t oject.
 * 
 * @param pseudo_random_function	Algorithm to use
 * @return
 * 									- prf_t object
 * 									- NULL if prf algorithm not supported
 *
 * @ingroup prfs
 */
prf_t *prf_create(pseudo_random_function_t pseudo_random_function);

#endif /*PRF_H_*/