blob: 1f78682ece5b935a68d9aae5f09409afe388a164 [file] [log] [blame]
Jean-Paul Calderone897bc252008-02-18 20:50:23 -05001/*
2 * pkey.c
3 *
Jean-Paul Calderone8671c852011-03-02 19:26:20 -05004 * Copyright (C) AB Strakt
5 * Copyright (C) Jean-Paul Calderone
6 * See LICENSE for details.
Jean-Paul Calderone897bc252008-02-18 20:50:23 -05007 *
8 * Public/rivate key handling code, mostly thin wrappers around OpenSSL.
9 * See the file RATIONALE for a short explanation of why this module was written.
10 *
11 */
12#include <Python.h>
13#define crypto_MODULE
14#include "crypto.h"
15
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050016/*
17 * This is done every time something fails, so turning it into a macro is
18 * really nice.
19 *
20 * Arguments: None
21 * Returns: Doesn't return
22 */
23#define FAIL() \
24do { \
Rick Deand369c932009-07-08 11:48:33 -050025 exception_from_error_queue(crypto_Error); \
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050026 return NULL; \
27} while (0)
28
29
30static char crypto_PKey_generate_key_doc[] = "\n\
31Generate a key of a given type, with a given number of a bits\n\
32\n\
Jean-Paul Calderone54bcc832009-05-27 14:06:48 -040033@param type: The key type (TYPE_RSA or TYPE_DSA)\n\
34@param bits: The number of bits\n\
35@return: None\n\
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050036";
37
38static PyObject *
39crypto_PKey_generate_key(crypto_PKeyObj *self, PyObject *args)
40{
41 int type, bits;
42 RSA *rsa;
43 DSA *dsa;
44
45 if (!PyArg_ParseTuple(args, "ii:generate_key", &type, &bits))
46 return NULL;
47
48 switch (type)
49 {
50 case crypto_TYPE_RSA:
Jean-Paul Calderoneab82db72008-03-06 00:09:31 -050051 if (bits <= 0) {
52 PyErr_SetString(PyExc_ValueError, "Invalid number of bits");
53 return NULL;
54 }
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050055 if ((rsa = RSA_generate_key(bits, 0x10001, NULL, NULL)) == NULL)
56 FAIL();
57 if (!EVP_PKEY_assign_RSA(self->pkey, rsa))
58 FAIL();
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -040059 break;
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050060
61 case crypto_TYPE_DSA:
62 if ((dsa = DSA_generate_parameters(bits, NULL, 0, NULL, NULL, NULL, NULL)) == NULL)
63 FAIL();
64 if (!DSA_generate_key(dsa))
65 FAIL();
66 if (!EVP_PKEY_assign_DSA(self->pkey, dsa))
67 FAIL();
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -040068 break;
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050069
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -040070 default:
71 PyErr_SetString(crypto_Error, "No such key type");
72 return NULL;
73
74 }
75 self->initialized = 1;
76 Py_INCREF(Py_None);
77 return Py_None;
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050078}
79
80static char crypto_PKey_bits_doc[] = "\n\
81Returns the number of bits of the key\n\
82\n\
Jean-Paul Calderone54bcc832009-05-27 14:06:48 -040083@return: The number of bits of the key.\n\
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050084";
85
86static PyObject *
87crypto_PKey_bits(crypto_PKeyObj *self, PyObject *args)
88{
89 if (!PyArg_ParseTuple(args, ":bits"))
90 return NULL;
91
Jean-Paul Calderone2f6c66f2010-08-11 19:53:43 -040092 return PyLong_FromLong(EVP_PKEY_bits(self->pkey));
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050093}
94
95static char crypto_PKey_type_doc[] = "\n\
96Returns the type of the key\n\
97\n\
Jean-Paul Calderone54bcc832009-05-27 14:06:48 -040098@return: The type of the key.\n\
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050099";
100
101static PyObject *
102crypto_PKey_type(crypto_PKeyObj *self, PyObject *args)
103{
104 if (!PyArg_ParseTuple(args, ":type"))
105 return NULL;
106
Jean-Paul Calderone2f6c66f2010-08-11 19:53:43 -0400107 return PyLong_FromLong(self->pkey->type);
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500108}
109
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400110static char crypto_PKey_check_doc[] = "\n\
111Check the consistency of an RSA private key.\n\
112\n\
Jean-Paul Calderonefd0b8d62011-06-12 18:05:50 -0400113@return: True if key is consistent.\n\
114@raise Error: if the key is inconsistent.\n\
115@raise TypeError: if the key is of a type which cannot be checked.\n\
116 Only RSA keys can currently be checked.\n\
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400117";
118
119static PyObject *
Jean-Paul Calderonefd0b8d62011-06-12 18:05:50 -0400120crypto_PKey_check(crypto_PKeyObj *self, PyObject *args) {
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400121 int r;
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400122
Jean-Paul Calderonefd0b8d62011-06-12 18:05:50 -0400123 if (!PyArg_ParseTuple(args, ":check")) {
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400124 return NULL;
Jean-Paul Calderonefd0b8d62011-06-12 18:05:50 -0400125 }
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400126
Jean-Paul Calderone7d748542011-06-12 18:10:01 -0400127 if (self->pkey->type == EVP_PKEY_RSA) {
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400128 RSA *rsa;
Jean-Paul Calderonede207e72009-05-13 14:19:05 -0400129 rsa = EVP_PKEY_get1_RSA(self->pkey);
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400130 r = RSA_check_key(rsa);
Jean-Paul Calderoned338e4e2009-05-13 15:45:07 -0400131 if (r == 1) {
Jean-Paul Calderone49f93ab2009-05-13 14:20:00 -0400132 return PyBool_FromLong(1L);
Jean-Paul Calderoned338e4e2009-05-13 15:45:07 -0400133 } else {
134 FAIL();
135 }
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400136 } else {
Jean-Paul Calderonefd0b8d62011-06-12 18:05:50 -0400137 PyErr_SetString(PyExc_TypeError, "key type unsupported");
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400138 return NULL;
139 }
140}
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500141
142/*
143 * ADD_METHOD(name) expands to a correct PyMethodDef declaration
144 * { 'name', (PyCFunction)crypto_PKey_name, METH_VARARGS }
145 * for convenience
146 */
147#define ADD_METHOD(name) \
148 { #name, (PyCFunction)crypto_PKey_##name, METH_VARARGS, crypto_PKey_##name##_doc }
149static PyMethodDef crypto_PKey_methods[] =
150{
151 ADD_METHOD(generate_key),
152 ADD_METHOD(bits),
153 ADD_METHOD(type),
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400154 ADD_METHOD(check),
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500155 { NULL, NULL }
156};
157#undef ADD_METHOD
158
159
160/*
161 * Constructor for PKey objects, never called by Python code directly
162 *
163 * Arguments: pkey - A "real" EVP_PKEY object
164 * dealloc - Boolean value to specify whether the destructor should
165 * free the "real" EVP_PKEY object
166 * Returns: The newly created PKey object
167 */
168crypto_PKeyObj *
169crypto_PKey_New(EVP_PKEY *pkey, int dealloc)
170{
171 crypto_PKeyObj *self;
172
173 self = PyObject_New(crypto_PKeyObj, &crypto_PKey_Type);
174
175 if (self == NULL)
176 return NULL;
177
178 self->pkey = pkey;
179 self->dealloc = dealloc;
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400180 self->only_public = 0;
181
182 /*
183 * Heuristic. Most call-sites pass an initialized EVP_PKEY. Not
184 * necessarily the case that they will, though. That's part of why this is
185 * a hack. -exarkun
186 */
187 self->initialized = 1;
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500188
189 return self;
190}
191
Jean-Paul Calderone2e1da572009-06-27 10:44:00 -0400192static char crypto_PKey_doc[] = "\n\
193PKey() -> PKey instance\n\
194\n\
195Create a new PKey object.\n\
196\n\
197@return: The PKey object\n\
198";
199static PyObject*
200crypto_PKey_new(PyTypeObject *subtype, PyObject *args, PyObject *kwargs) {
201 crypto_PKeyObj *self;
202
203 if (!PyArg_ParseTuple(args, ":PKey")) {
204 return NULL;
205 }
206
207 self = crypto_PKey_New(EVP_PKEY_new(), 1);
208 if (self) {
209 self->initialized = 0;
210 }
211
212 return (PyObject *)self;
213}
214
215
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500216/*
217 * Deallocate the memory used by the PKey object
218 *
219 * Arguments: self - The PKey object
220 * Returns: None
221 */
222static void
223crypto_PKey_dealloc(crypto_PKeyObj *self)
224{
225 /* Sometimes we don't have to dealloc the "real" EVP_PKEY pointer ourselves */
226 if (self->dealloc)
227 EVP_PKEY_free(self->pkey);
228
229 PyObject_Del(self);
230}
231
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500232PyTypeObject crypto_PKey_Type = {
Jean-Paul Calderone3fe7f672010-08-11 23:55:10 -0400233 PyOpenSSL_HEAD_INIT(&PyType_Type, 0)
Jean-Paul Calderone2e1da572009-06-27 10:44:00 -0400234 "OpenSSL.crypto.PKey",
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500235 sizeof(crypto_PKeyObj),
236 0,
237 (destructor)crypto_PKey_dealloc,
238 NULL, /* print */
Jean-Paul Calderone2f6c66f2010-08-11 19:53:43 -0400239 NULL, /* getattr */
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500240 NULL, /* setattr */
241 NULL, /* compare */
242 NULL, /* repr */
243 NULL, /* as_number */
244 NULL, /* as_sequence */
245 NULL, /* as_mapping */
246 NULL, /* hash */
Jean-Paul Calderone2e1da572009-06-27 10:44:00 -0400247 NULL, /* call */
248 NULL, /* str */
249 NULL, /* getattro */
250 NULL, /* setattro */
251 NULL, /* as_buffer */
Jean-Paul Calderone09654fe2009-06-27 10:54:48 -0400252 Py_TPFLAGS_DEFAULT,
Jean-Paul Calderone2e1da572009-06-27 10:44:00 -0400253 crypto_PKey_doc, /* doc */
254 NULL, /* traverse */
255 NULL, /* clear */
256 NULL, /* tp_richcompare */
257 0, /* tp_weaklistoffset */
258 NULL, /* tp_iter */
259 NULL, /* tp_iternext */
260 crypto_PKey_methods, /* tp_methods */
261 NULL, /* tp_members */
262 NULL, /* tp_getset */
263 NULL, /* tp_base */
264 NULL, /* tp_dict */
265 NULL, /* tp_descr_get */
266 NULL, /* tp_descr_set */
267 0, /* tp_dictoffset */
268 NULL, /* tp_init */
269 NULL, /* tp_alloc */
270 crypto_PKey_new, /* tp_new */
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500271};
272
273
274/*
275 * Initialize the PKey part of the crypto sub module
276 *
Jean-Paul Calderone2e1da572009-06-27 10:44:00 -0400277 * Arguments: module - The crypto module
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500278 * Returns: None
279 */
280int
Jean-Paul Calderone2e1da572009-06-27 10:44:00 -0400281init_crypto_pkey(PyObject *module)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500282{
Jean-Paul Calderone2e1da572009-06-27 10:44:00 -0400283 if (PyType_Ready(&crypto_PKey_Type) < 0) {
284 return 0;
285 }
286
Jean-Paul Calderone86ad7112010-05-11 16:08:45 -0400287 /* PyModule_AddObject steals a reference.
288 */
289 Py_INCREF((PyObject *)&crypto_PKey_Type);
Jean-Paul Calderone2e1da572009-06-27 10:44:00 -0400290 if (PyModule_AddObject(module, "PKey", (PyObject *)&crypto_PKey_Type) != 0) {
291 return 0;
292 }
293
Jean-Paul Calderoneaed23582011-03-12 22:45:02 -0500294 /* PyModule_AddObject steals a reference.
295 */
296 Py_INCREF((PyObject *)&crypto_PKey_Type);
Jean-Paul Calderone2e1da572009-06-27 10:44:00 -0400297 if (PyModule_AddObject(module, "PKeyType", (PyObject *)&crypto_PKey_Type) != 0) {
298 return 0;
299 }
300
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500301 return 1;
302}
303