Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1 | /* |
| 2 | * pkey.c |
| 3 | * |
Jean-Paul Calderone | 8671c85 | 2011-03-02 19:26:20 -0500 | [diff] [blame] | 4 | * Copyright (C) AB Strakt |
| 5 | * Copyright (C) Jean-Paul Calderone |
| 6 | * See LICENSE for details. |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 7 | * |
| 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 Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 16 | /* |
| 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() \ |
| 24 | do { \ |
Rick Dean | d369c93 | 2009-07-08 11:48:33 -0500 | [diff] [blame] | 25 | exception_from_error_queue(crypto_Error); \ |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 26 | return NULL; \ |
| 27 | } while (0) |
| 28 | |
| 29 | |
| 30 | static char crypto_PKey_generate_key_doc[] = "\n\ |
| 31 | Generate a key of a given type, with a given number of a bits\n\ |
| 32 | \n\ |
Jonathan Ballet | 78b92a2 | 2011-07-16 08:07:26 +0900 | [diff] [blame^] | 33 | :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 Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 36 | "; |
| 37 | |
| 38 | static PyObject * |
| 39 | crypto_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 Calderone | ab82db7 | 2008-03-06 00:09:31 -0500 | [diff] [blame] | 51 | if (bits <= 0) { |
| 52 | PyErr_SetString(PyExc_ValueError, "Invalid number of bits"); |
| 53 | return NULL; |
| 54 | } |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 55 | 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 Calderone | ac0d95f | 2008-03-10 00:00:42 -0400 | [diff] [blame] | 59 | break; |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 60 | |
| 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 Calderone | ac0d95f | 2008-03-10 00:00:42 -0400 | [diff] [blame] | 68 | break; |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 69 | |
Jean-Paul Calderone | ac0d95f | 2008-03-10 00:00:42 -0400 | [diff] [blame] | 70 | 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 Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 78 | } |
| 79 | |
| 80 | static char crypto_PKey_bits_doc[] = "\n\ |
| 81 | Returns the number of bits of the key\n\ |
| 82 | \n\ |
Jonathan Ballet | 78b92a2 | 2011-07-16 08:07:26 +0900 | [diff] [blame^] | 83 | :return: The number of bits of the key.\n\ |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 84 | "; |
| 85 | |
| 86 | static PyObject * |
| 87 | crypto_PKey_bits(crypto_PKeyObj *self, PyObject *args) |
| 88 | { |
| 89 | if (!PyArg_ParseTuple(args, ":bits")) |
| 90 | return NULL; |
| 91 | |
Jean-Paul Calderone | 2f6c66f | 2010-08-11 19:53:43 -0400 | [diff] [blame] | 92 | return PyLong_FromLong(EVP_PKEY_bits(self->pkey)); |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | static char crypto_PKey_type_doc[] = "\n\ |
| 96 | Returns the type of the key\n\ |
| 97 | \n\ |
Jonathan Ballet | 78b92a2 | 2011-07-16 08:07:26 +0900 | [diff] [blame^] | 98 | :return: The type of the key.\n\ |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 99 | "; |
| 100 | |
| 101 | static PyObject * |
| 102 | crypto_PKey_type(crypto_PKeyObj *self, PyObject *args) |
| 103 | { |
| 104 | if (!PyArg_ParseTuple(args, ":type")) |
| 105 | return NULL; |
| 106 | |
Jean-Paul Calderone | 2f6c66f | 2010-08-11 19:53:43 -0400 | [diff] [blame] | 107 | return PyLong_FromLong(self->pkey->type); |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 108 | } |
| 109 | |
Jean-Paul Calderone | 8e6ce97 | 2009-05-13 12:32:49 -0400 | [diff] [blame] | 110 | static char crypto_PKey_check_doc[] = "\n\ |
| 111 | Check the consistency of an RSA private key.\n\ |
| 112 | \n\ |
Jonathan Ballet | 78b92a2 | 2011-07-16 08:07:26 +0900 | [diff] [blame^] | 113 | :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\ |
Jean-Paul Calderone | fd0b8d6 | 2011-06-12 18:05:50 -0400 | [diff] [blame] | 116 | Only RSA keys can currently be checked.\n\ |
Jean-Paul Calderone | 8e6ce97 | 2009-05-13 12:32:49 -0400 | [diff] [blame] | 117 | "; |
| 118 | |
| 119 | static PyObject * |
Jean-Paul Calderone | fd0b8d6 | 2011-06-12 18:05:50 -0400 | [diff] [blame] | 120 | crypto_PKey_check(crypto_PKeyObj *self, PyObject *args) { |
Jean-Paul Calderone | 8e6ce97 | 2009-05-13 12:32:49 -0400 | [diff] [blame] | 121 | int r; |
Jean-Paul Calderone | 8e6ce97 | 2009-05-13 12:32:49 -0400 | [diff] [blame] | 122 | |
Jean-Paul Calderone | fd0b8d6 | 2011-06-12 18:05:50 -0400 | [diff] [blame] | 123 | if (!PyArg_ParseTuple(args, ":check")) { |
Jean-Paul Calderone | 8e6ce97 | 2009-05-13 12:32:49 -0400 | [diff] [blame] | 124 | return NULL; |
Jean-Paul Calderone | fd0b8d6 | 2011-06-12 18:05:50 -0400 | [diff] [blame] | 125 | } |
Jean-Paul Calderone | 8e6ce97 | 2009-05-13 12:32:49 -0400 | [diff] [blame] | 126 | |
Jean-Paul Calderone | 7d74854 | 2011-06-12 18:10:01 -0400 | [diff] [blame] | 127 | if (self->pkey->type == EVP_PKEY_RSA) { |
Jean-Paul Calderone | 8e6ce97 | 2009-05-13 12:32:49 -0400 | [diff] [blame] | 128 | RSA *rsa; |
Jean-Paul Calderone | de207e7 | 2009-05-13 14:19:05 -0400 | [diff] [blame] | 129 | rsa = EVP_PKEY_get1_RSA(self->pkey); |
Jean-Paul Calderone | 8e6ce97 | 2009-05-13 12:32:49 -0400 | [diff] [blame] | 130 | r = RSA_check_key(rsa); |
Jean-Paul Calderone | d338e4e | 2009-05-13 15:45:07 -0400 | [diff] [blame] | 131 | if (r == 1) { |
Jean-Paul Calderone | 49f93ab | 2009-05-13 14:20:00 -0400 | [diff] [blame] | 132 | return PyBool_FromLong(1L); |
Jean-Paul Calderone | d338e4e | 2009-05-13 15:45:07 -0400 | [diff] [blame] | 133 | } else { |
| 134 | FAIL(); |
| 135 | } |
Jean-Paul Calderone | 8e6ce97 | 2009-05-13 12:32:49 -0400 | [diff] [blame] | 136 | } else { |
Jean-Paul Calderone | fd0b8d6 | 2011-06-12 18:05:50 -0400 | [diff] [blame] | 137 | PyErr_SetString(PyExc_TypeError, "key type unsupported"); |
Jean-Paul Calderone | 8e6ce97 | 2009-05-13 12:32:49 -0400 | [diff] [blame] | 138 | return NULL; |
| 139 | } |
| 140 | } |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 141 | |
| 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 } |
| 149 | static PyMethodDef crypto_PKey_methods[] = |
| 150 | { |
| 151 | ADD_METHOD(generate_key), |
| 152 | ADD_METHOD(bits), |
| 153 | ADD_METHOD(type), |
Jean-Paul Calderone | 8e6ce97 | 2009-05-13 12:32:49 -0400 | [diff] [blame] | 154 | ADD_METHOD(check), |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 155 | { 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 | */ |
| 168 | crypto_PKeyObj * |
| 169 | crypto_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 Calderone | ac0d95f | 2008-03-10 00:00:42 -0400 | [diff] [blame] | 180 | 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 Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 188 | |
| 189 | return self; |
| 190 | } |
| 191 | |
Jean-Paul Calderone | 2e1da57 | 2009-06-27 10:44:00 -0400 | [diff] [blame] | 192 | static char crypto_PKey_doc[] = "\n\ |
| 193 | PKey() -> PKey instance\n\ |
| 194 | \n\ |
| 195 | Create a new PKey object.\n\ |
| 196 | \n\ |
Jonathan Ballet | 78b92a2 | 2011-07-16 08:07:26 +0900 | [diff] [blame^] | 197 | :return: The PKey object\n\ |
Jean-Paul Calderone | 2e1da57 | 2009-06-27 10:44:00 -0400 | [diff] [blame] | 198 | "; |
| 199 | static PyObject* |
| 200 | crypto_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 Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 216 | /* |
| 217 | * Deallocate the memory used by the PKey object |
| 218 | * |
| 219 | * Arguments: self - The PKey object |
| 220 | * Returns: None |
| 221 | */ |
| 222 | static void |
| 223 | crypto_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 Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 232 | PyTypeObject crypto_PKey_Type = { |
Jean-Paul Calderone | 3fe7f67 | 2010-08-11 23:55:10 -0400 | [diff] [blame] | 233 | PyOpenSSL_HEAD_INIT(&PyType_Type, 0) |
Jean-Paul Calderone | 2e1da57 | 2009-06-27 10:44:00 -0400 | [diff] [blame] | 234 | "OpenSSL.crypto.PKey", |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 235 | sizeof(crypto_PKeyObj), |
| 236 | 0, |
| 237 | (destructor)crypto_PKey_dealloc, |
| 238 | NULL, /* print */ |
Jean-Paul Calderone | 2f6c66f | 2010-08-11 19:53:43 -0400 | [diff] [blame] | 239 | NULL, /* getattr */ |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 240 | 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 Calderone | 2e1da57 | 2009-06-27 10:44:00 -0400 | [diff] [blame] | 247 | NULL, /* call */ |
| 248 | NULL, /* str */ |
| 249 | NULL, /* getattro */ |
| 250 | NULL, /* setattro */ |
| 251 | NULL, /* as_buffer */ |
Jean-Paul Calderone | 09654fe | 2009-06-27 10:54:48 -0400 | [diff] [blame] | 252 | Py_TPFLAGS_DEFAULT, |
Jean-Paul Calderone | 2e1da57 | 2009-06-27 10:44:00 -0400 | [diff] [blame] | 253 | 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 Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 271 | }; |
| 272 | |
| 273 | |
| 274 | /* |
| 275 | * Initialize the PKey part of the crypto sub module |
| 276 | * |
Jean-Paul Calderone | 2e1da57 | 2009-06-27 10:44:00 -0400 | [diff] [blame] | 277 | * Arguments: module - The crypto module |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 278 | * Returns: None |
| 279 | */ |
| 280 | int |
Jean-Paul Calderone | 2e1da57 | 2009-06-27 10:44:00 -0400 | [diff] [blame] | 281 | init_crypto_pkey(PyObject *module) |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 282 | { |
Jean-Paul Calderone | 2e1da57 | 2009-06-27 10:44:00 -0400 | [diff] [blame] | 283 | if (PyType_Ready(&crypto_PKey_Type) < 0) { |
| 284 | return 0; |
| 285 | } |
| 286 | |
Jean-Paul Calderone | 86ad711 | 2010-05-11 16:08:45 -0400 | [diff] [blame] | 287 | /* PyModule_AddObject steals a reference. |
| 288 | */ |
| 289 | Py_INCREF((PyObject *)&crypto_PKey_Type); |
Jean-Paul Calderone | 2e1da57 | 2009-06-27 10:44:00 -0400 | [diff] [blame] | 290 | if (PyModule_AddObject(module, "PKey", (PyObject *)&crypto_PKey_Type) != 0) { |
| 291 | return 0; |
| 292 | } |
| 293 | |
Jean-Paul Calderone | aed2358 | 2011-03-12 22:45:02 -0500 | [diff] [blame] | 294 | /* PyModule_AddObject steals a reference. |
| 295 | */ |
| 296 | Py_INCREF((PyObject *)&crypto_PKey_Type); |
Jean-Paul Calderone | 2e1da57 | 2009-06-27 10:44:00 -0400 | [diff] [blame] | 297 | if (PyModule_AddObject(module, "PKeyType", (PyObject *)&crypto_PKey_Type) != 0) { |
| 298 | return 0; |
| 299 | } |
| 300 | |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 301 | return 1; |
| 302 | } |
| 303 | |