Moved keys/key_encoding.[ch] to cred_encoding.[ch]
[strongswan.git] / src / libstrongswan / credentials / keys / private_key.h
1 /*
2 * Copyright (C) 2007 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 /**
17 * @defgroup private_key private_key
18 * @{ @ingroup keys
19 */
20
21 #ifndef PRIVATE_KEY_H_
22 #define PRIVATE_KEY_H_
23
24 typedef struct private_key_t private_key_t;
25
26 #include <credentials/cred_encoding.h>
27 #include <credentials/keys/public_key.h>
28
29 /**
30 * Abstract private key interface.
31 */
32 struct private_key_t {
33
34 /**
35 * Get the key type.
36 *
37 * @return type of the key
38 */
39 key_type_t (*get_type)(private_key_t *this);
40
41 /**
42 * Create a signature over a chunk of data.
43 *
44 * @param scheme signature scheme to use
45 * @param data chunk of data to sign
46 * @param signature where to allocate created signature
47 * @return TRUE if signature created
48 */
49 bool (*sign)(private_key_t *this, signature_scheme_t scheme,
50 chunk_t data, chunk_t *signature);
51 /**
52 * Decrypt a chunk of data.
53 *
54 * @param crypto chunk containing encrypted data
55 * @param plain where to allocate decrypted data
56 * @return TRUE if data decrypted and plaintext allocated
57 */
58 bool (*decrypt)(private_key_t *this, chunk_t crypto, chunk_t *plain);
59
60 /**
61 * Get the strength of the key in bytes.
62 *
63 * @return strength of the key in bytes
64 */
65 size_t (*get_keysize) (private_key_t *this);
66
67 /**
68 * Get the public part from the private key.
69 *
70 * @return public key
71 */
72 public_key_t* (*get_public_key)(private_key_t *this);
73
74 /**
75 * Check if two private keys are equal.
76 *
77 * @param other other private key
78 * @return TRUE, if equality
79 */
80 bool (*equals) (private_key_t *this, private_key_t *other);
81
82 /**
83 * Check if a private key belongs to a public key.
84 *
85 * @param public public key
86 * @return TRUE, if keys belong together
87 */
88 bool (*belongs_to) (private_key_t *this, public_key_t *public);
89
90 /**
91 * Get the fingerprint of the key.
92 *
93 * @param type type of fingerprint, one of KEY_ID_*
94 * @param fp fingerprint, points to internal data
95 * @return TRUE if fingerprint type supported
96 */
97 bool (*get_fingerprint)(private_key_t *this, key_encoding_type_t type,
98 chunk_t *fp);
99
100 /**
101 * Check if a key has a given fingerprint of any kind.
102 *
103 * @param fp fingerprint to check
104 * @return TRUE if key has given fingerprint
105 */
106 bool (*has_fingerprint)(private_key_t *this, chunk_t fp);
107
108 /**
109 * Get the key in an encoded form as a chunk.
110 *
111 * @param type type of the encoding, one of KEY_PRIV_*
112 * @param encoding encoding of the key, allocated
113 * @return TRUE if encoding supported
114 */
115 bool (*get_encoding)(private_key_t *this, key_encoding_type_t type,
116 chunk_t *encoding);
117
118 /**
119 * Increase the refcount to this private key.
120 *
121 * @return this, with an increased refcount
122 */
123 private_key_t* (*get_ref)(private_key_t *this);
124
125 /**
126 * Decrease refcount, destroy private_key if no more references.
127 */
128 void (*destroy)(private_key_t *this);
129 };
130
131 /**
132 * Generic private key equals() implementation, usable by implementors.
133 *
134 * @param this first key to compare
135 * @param other second key to compare
136 * @return TRUE if this is equal to other
137 */
138 bool private_key_equals(private_key_t *this, private_key_t *other);
139
140 /**
141 * Generic private key belongs_to() implementation, usable by implementors.
142 *
143 * @param private private key to check
144 * @param public public key to compare
145 * @return TRUE if this is equal to other
146 */
147 bool private_key_belongs_to(private_key_t *private, public_key_t *public);
148
149 /**
150 * Generic private key has_fingerprint() implementation, usable by implementors.
151 *
152 * @param this key to check fingerprint
153 * @param fingerprint fingerprint to check
154 * @return TRUE if key has given fingerprint
155 */
156 bool private_key_has_fingerprint(private_key_t *this, chunk_t fingerprint);
157
158 #endif /** PRIVATE_KEY_H_ @}*/