summaryrefslogtreecommitdiff
path: root/src/libstrongswan/crypto/crypters/crypter.h
blob: 46d94ce93c0e48644e93cf9417caabdda4134137 (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
143
144
145
146
147
148
149
150
151
152
153
154
155
/**
 * @file crypter.h
 * 
 * @brief Interface crypter_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 CRYPTER_H_
#define CRYPTER_H_

typedef enum encryption_algorithm_t encryption_algorithm_t;
typedef struct crypter_t crypter_t;

#include <library.h>

/**
 * @brief Encryption algorithm, as in IKEv2 RFC 3.3.2.
 *
 * Currently only the following algorithms are implemented:
 * - ENCR_AES_CBC
 * - ENCR_DES
 * - ENCR_3DES
 *
 * @ingroup crypters
 */
enum encryption_algorithm_t {
	ENCR_UNDEFINED = 1024,
	ENCR_DES_IV64 = 1,
	/** Implemented in class des_crypter_t */
	ENCR_DES = 2,
	/** Implemented in class des_crypter_t */
	ENCR_3DES = 3,
	ENCR_RC5 = 4,
	ENCR_IDEA = 5,
	ENCR_CAST = 6,
	ENCR_BLOWFISH = 7,
	ENCR_3IDEA = 8,
	ENCR_DES_IV32 = 9,
	ENCR_NULL = 11,
	/** Implemented in class aes_cbc_crypter_t */
	ENCR_AES_CBC = 12,
	ENCR_AES_CTR = 13
};

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

/**
 * @brief Generic interface for symmetric encryption algorithms.
 *
 * @b Constructors:
 *  - crypter_create()
 *
 * @ingroup crypters
 */
struct crypter_t {
	
	/**
	 * @brief Encrypt a chunk of data and allocate space for the encrypted value.
	 *
	 * @param this				calling object
	 * @param data				data to encrypt
	 * @param iv				initializing vector
	 * @param[out] encrypted	pointer where the encrypted bytes will be written
	 * @return
	 * 							- SUCCESS
	 * 							- INVALID_ARG if data size not a multiple of block size
	 */
	status_t (*encrypt) (crypter_t *this, chunk_t data, chunk_t iv, chunk_t *encrypted);
	
	/**
	 * @brief Decrypt a chunk of data and allocate space for the decrypted value.
	 * 
	 * @param this				calling object
	 * @param data				data to decrypt
	 * @param iv				initializing vector
	 * @param[out] encrypted	pointer where the decrypted bytes will be written
	 * @return
	 * 							- SUCCESS
	 * 							- INVALID_ARG if data size not a multiple of block size
	 */
	status_t (*decrypt) (crypter_t *this, chunk_t data, chunk_t iv, chunk_t *decrypted);

	/**
	 * @brief Get the block size of this crypter_t object.
	 * 
	 * @param this				calling object
	 * @return					block size in bytes
	 */
	size_t (*get_block_size) (crypter_t *this);

	/**
	 * @brief Get the key size of this crypter_t object.
	 * 
	 * @param this				calling object
	 * @return					key size in bytes
	 */
	size_t (*get_key_size) (crypter_t *this);
	
	/**
	 * @brief Set the key for this crypter_t object.
	 * 
	 * @param this				calling object
	 * @param key				key to set
	 * @return
	 * 							- SUCCESS
	 * 							- INVALID_ARG if key length invalid
	 */
	status_t (*set_key) (crypter_t *this, chunk_t key);
	
	/**
	 * @brief Destroys a crypter_t object.
	 *
	 * @param this 				calling object
	 */
	void (*destroy) (crypter_t *this);
};

/**
 * @brief Generic constructor for crypter_t objects.
 * 
 * Currently only the following algorithms are implemented:
 * - ENCR_AES_CBC
 * - ENCR_DES
 * - ENCR_3DES
 * 
 * The key_size is ignored for algorithms with fixed key size.
 * 
 * @param encryption_algorithm	Algorithm to use for crypter
 * @param key_size 				size of the key in bytes
 * @return
 * 								- crypter_t object
 * 								- NULL if encryption algorithm/key_size is not supported
 */
crypter_t *crypter_create(encryption_algorithm_t encryption_algorithm, size_t key_size);

#endif /*CRYPTER_H_*/