changed get_id/get_encoding API of private/public key to use new encoding framework
[strongswan.git] / src / libstrongswan / credentials / keys / public_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 public_key public_key
18 * @{ @ingroup keys
19 */
20
21 #ifndef PUBLIC_KEY_H_
22 #define PUBLIC_KEY_H_
23
24 typedef struct public_key_t public_key_t;
25 typedef enum key_type_t key_type_t;
26 typedef enum key_id_type_t key_id_type_t;
27 typedef enum signature_scheme_t signature_scheme_t;
28
29 #include <library.h>
30 #include <utils/identification.h>
31
32 /**
33 * Type of a key pair, the used crypto system
34 */
35 enum key_type_t {
36 /** key type wildcard */
37 KEY_ANY = 0,
38 /** RSA crypto system as in PKCS#1 */
39 KEY_RSA = 1,
40 /** ECDSA as in ANSI X9.62 */
41 KEY_ECDSA = 2,
42 /** DSA */
43 KEY_DSA = 3,
44 /** ElGamal, ... */
45 };
46
47 /**
48 * Enum names for key_type_t
49 */
50 extern enum_name_t *key_type_names;
51
52 /**
53 * Signature scheme for signature creation
54 *
55 * EMSA-PKCS1 signatures are defined in PKCS#1 standard.
56 * A prepended ASN.1 encoded digestInfo field contains the
57 * OID of the used hash algorithm. The ASN.1 type of the PKCS#7
58 * variants is OCTET_STRING instead of the default BIT_STRING.
59 */
60 enum signature_scheme_t {
61 /** Unknown signature scheme */
62 SIGN_UNKNOWN,
63 /** EMSA-PKCS1_v1.5 signature over digest without digestInfo */
64 SIGN_RSA_EMSA_PKCS1_NULL,
65 /** EMSA-PKCS1_v1.5 signature as in PKCS#1 using RSA and MD5 */
66 SIGN_RSA_EMSA_PKCS1_MD5,
67 /** EMSA-PKCS1_v1.5 signature as in PKCS#1 using RSA and SHA-1 */
68 SIGN_RSA_EMSA_PKCS1_SHA1,
69 /** EMSA-PKCS1_v1.5 signature as in PKCS#1 using RSA and SHA-224 */
70 SIGN_RSA_EMSA_PKCS1_SHA224,
71 /** EMSA-PKCS1_v1.5 signature as in PKCS#1 using RSA and SHA-256 */
72 SIGN_RSA_EMSA_PKCS1_SHA256,
73 /** EMSA-PKCS1_v1.5 signature as in PKCS#1 using RSA and SHA-384 */
74 SIGN_RSA_EMSA_PKCS1_SHA384,
75 /** EMSA-PKCS1_v1.5 signature as in PKCS#1 using RSA and SHA-512 */
76 SIGN_RSA_EMSA_PKCS1_SHA512,
77 /** ECDSA over precomputed digest */
78 SIGN_ECDSA_WITH_NULL,
79 /** ECDSA with SHA-1 */
80 SIGN_ECDSA_WITH_SHA1,
81 /** ECDSA on the P-256 curve with SHA-256 as in RFC 4754 */
82 SIGN_ECDSA_256,
83 /** ECDSA on the P-384 curve with SHA-384 as in RFC 4754 */
84 SIGN_ECDSA_384,
85 /** ECDSA on the P-521 curve with SHA-512 as in RFC 4754 */
86 SIGN_ECDSA_521,
87 };
88
89 /**
90 * Enum names for signature_scheme_t
91 */
92 extern enum_name_t *signature_scheme_names;
93
94 /**
95 * Abstract interface of a public key.
96 */
97 struct public_key_t {
98
99 /**
100 * Get the key type.
101 *
102 * @return type of the key
103 */
104 key_type_t (*get_type)(public_key_t *this);
105
106 /**
107 * Verifies a signature against a chunk of data.
108 *
109 * @param scheme signature scheme to use for verification, may be default
110 * @param data data to check signature against
111 * @param signature signature to check
112 * @return TRUE if signature matches
113 */
114 bool (*verify)(public_key_t *this, signature_scheme_t scheme,
115 chunk_t data, chunk_t signature);
116
117 /**
118 * Encrypt a chunk of data.
119 *
120 * @param plain chunk containing plaintext data
121 * @param crypto where to allocate encrypted data
122 * @return TRUE if data successfully encrypted
123 */
124 bool (*encrypt)(public_key_t *this, chunk_t plain, chunk_t *crypto);
125
126 /**
127 * Check if two public keys are equal.
128 *
129 * @param other other public key
130 * @return TRUE, if equality
131 */
132 bool (*equals)(public_key_t *this, public_key_t *other);
133
134 /**
135 * Get the strength of the key in bytes.
136 *
137 * @return strength of the key in bytes
138 */
139 size_t (*get_keysize) (public_key_t *this);
140
141 /**
142 * Get the fingerprint of the key.
143 *
144 * @param type type of fingerprint, one of KEY_ID_*
145 * @param fp fingerprint, points to internal data
146 * @return TRUE if fingerprint type supported
147 */
148 bool (*get_fingerprint)(public_key_t *this, key_encoding_type_t type,
149 chunk_t *fp);
150
151 /**
152 * Get the key in an encoded form as a chunk.
153 *
154 * @param type type of the encoding, one of KEY_PRIV_*
155 * @param encoding encoding of the key, allocated
156 * @return TRUE if encoding supported
157 */
158 bool (*get_encoding)(public_key_t *this, key_encoding_type_t type,
159 chunk_t *encoding);
160
161 /**
162 * Increase the refcount of the key.
163 *
164 * @return this with an increased refcount
165 */
166 public_key_t* (*get_ref)(public_key_t *this);
167
168 /**
169 * Destroy a public_key instance.
170 */
171 void (*destroy)(public_key_t *this);
172 };
173
174 /**
175 * Generic public key equals() implementation, usable by implementors.
176 *
177 * @param this first key to compare
178 * @param other second key to compare
179 * @return TRUE if this is equal to other
180 */
181 bool public_key_equals(public_key_t *this, public_key_t *other);
182
183 /**
184 * Conversion of ASN.1 signature or hash OID to signature scheme.
185 *
186 * @param oid ASN.1 OID
187 * @return signature_scheme, SIGN_UNKNOWN if OID is unsupported
188 */
189 signature_scheme_t signature_scheme_from_oid(int oid);
190
191 #endif /** PUBLIC_KEY_H_ @}*/