Class: OpenSSL::PKey::RSA

Inherits:
PKey
  • Object
show all
Defined in:
ossl_pkey_rsa.c

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PKey

#sign, #verify

Constructor Details

#new([size | encoded_key][, pass]) ⇒ Object

Parameters

  • size is an integer representing the desired key size.

  • encoded_key is a string containing PEM or DER encoded key.

  • pass is an optional string with the password to decrypt the encoded key.

Examples

  • RSA.new(2048) -> rsa

  • RSA.new(File.read(“rsa.pem”)) -> rsa

  • RSA.new(File.read(“rsa.pem”), “mypassword”) -> rsa



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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'ossl_pkey_rsa.c', line 131

static VALUE
ossl_rsa_initialize(int argc, VALUE *argv, VALUE self)
{
    EVP_PKEY *pkey;
    RSA *rsa;
    BIO *in;
    char *passwd = NULL;
    VALUE arg, pass;
  
    GetPKey(self, pkey);
    if(rb_scan_args(argc, argv, "02", &arg, &pass) == 0) {
  rsa = RSA_new();
    }
    else if (FIXNUM_P(arg)) {
  rsa = rsa_generate(FIX2INT(arg), NIL_P(pass) ? RSA_F4 : NUM2INT(pass));
  if (!rsa) ossl_raise(eRSAError, NULL);
    }
    else {
  if (!NIL_P(pass)) passwd = StringValuePtr(pass);
  arg = ossl_to_der_if_possible(arg);
  in = ossl_obj2bio(arg);
  rsa = PEM_read_bio_RSAPrivateKey(in, NULL, ossl_pem_passwd_cb, passwd);
  if (!rsa) {
      BIO_reset(in);
      rsa = PEM_read_bio_RSAPublicKey(in, NULL, NULL, NULL);
  }
  if (!rsa) {
      BIO_reset(in);
      rsa = PEM_read_bio_RSA_PUBKEY(in, NULL, NULL, NULL);
  }
  if (!rsa) {
      BIO_reset(in);
      rsa = d2i_RSAPrivateKey_bio(in, NULL);
  }
  if (!rsa) {
      BIO_reset(in);
      rsa = d2i_RSAPublicKey_bio(in, NULL);
  }
  if (!rsa) {
      BIO_reset(in);
      rsa = d2i_RSA_PUBKEY_bio(in, NULL);
  }
  BIO_free(in);
  if (!rsa) ossl_raise(eRSAError, "Neither PUB key nor PRIV key:");
    }
    if (!EVP_PKEY_assign_RSA(pkey, rsa)) {
  RSA_free(rsa);
  ossl_raise(eRSAError, NULL);
    }

    return self;
}

Class Method Details

.generate(size[, exponent]) ⇒ Object

Parameters

  • size is an integer representing the desired key size. Keys smaller than 1024 should be considered insecure.

  • exponent is an odd number normally 3, 17, or 65537.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'ossl_pkey_rsa.c', line 96

static VALUE
ossl_rsa_s_generate(int argc, VALUE *argv, VALUE klass)
{
/* why does this method exist?  why can't initialize take an optional exponent? */
    RSA *rsa;
    VALUE size, exp;
    VALUE obj;

    rb_scan_args(argc, argv, "11", &size, &exp);

    rsa = rsa_generate(NUM2INT(size), NIL_P(exp) ? RSA_F4 : NUM2INT(exp)); /* err handled by rsa_instance */
    obj = rsa_instance(klass, rsa);

    if (obj == Qfalse) {
  RSA_free(rsa);
  ossl_raise(eRSAError, NULL);
    }

    return obj;
}

Instance Method Details

#to_pem([cipher, pass]) ⇒ aString Also known as: to_pem, to_s

Parameters

  • cipher is a Cipher object.

  • pass is a string.

Examples

  • rsa.to_pem -> aString

  • rsa.to_pem(cipher, pass) -> aString

Returns:

  • (aString) 


230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'ossl_pkey_rsa.c', line 230

static VALUE
ossl_rsa_export(int argc, VALUE *argv, VALUE self)
{
    EVP_PKEY *pkey;
    BIO *out;
    const EVP_CIPHER *ciph = NULL;
    char *passwd = NULL;
    VALUE cipher, pass, str;

    GetPKeyRSA(self, pkey);

    rb_scan_args(argc, argv, "02", &cipher, &pass);

    if (!NIL_P(cipher)) {
  ciph = GetCipherPtr(cipher);
  if (!NIL_P(pass)) {
      passwd = StringValuePtr(pass);
  }
    }
    if (!(out = BIO_new(BIO_s_mem()))) {
  ossl_raise(eRSAError, NULL);
    }
    if (RSA_HAS_PRIVATE(pkey->pkey.rsa)) {
  if (!PEM_write_bio_RSAPrivateKey(out, pkey->pkey.rsa, ciph,
           NULL, 0, ossl_pem_passwd_cb, passwd)) {
      BIO_free(out);
      ossl_raise(eRSAError, NULL);
  }
    } else {
  if (!PEM_write_bio_RSAPublicKey(out, pkey->pkey.rsa)) {
      BIO_free(out);
      ossl_raise(eRSAError, NULL);
  }
    }
    str = ossl_membio2str(out);
    
    return str;
}

#params ⇒ Hash

Stores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don’t use :-)) (I’s up to you)

Returns:

  • (Hash) 


420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'ossl_pkey_rsa.c', line 420

static VALUE
ossl_rsa_get_params(VALUE self)
{
    EVP_PKEY *pkey;
    VALUE hash;

    GetPKeyRSA(self, pkey);

    hash = rb_hash_new();

    rb_hash_aset(hash, rb_str_new2("n"), ossl_bn_new(pkey->pkey.rsa->n));
    rb_hash_aset(hash, rb_str_new2("e"), ossl_bn_new(pkey->pkey.rsa->e));
    rb_hash_aset(hash, rb_str_new2("d"), ossl_bn_new(pkey->pkey.rsa->d));
    rb_hash_aset(hash, rb_str_new2("p"), ossl_bn_new(pkey->pkey.rsa->p));
    rb_hash_aset(hash, rb_str_new2("q"), ossl_bn_new(pkey->pkey.rsa->q));
    rb_hash_aset(hash, rb_str_new2("dmp1"), ossl_bn_new(pkey->pkey.rsa->dmp1));
    rb_hash_aset(hash, rb_str_new2("dmq1"), ossl_bn_new(pkey->pkey.rsa->dmq1));
    rb_hash_aset(hash, rb_str_new2("iqmp"), ossl_bn_new(pkey->pkey.rsa->iqmp));
    
    return hash;
}

#private? ⇒ Boolean

Returns:

  • (Boolean) 


208
209
210
211
212
213
214
215
216
 
# File 'ossl_pkey_rsa.c', line 208

static VALUE
ossl_rsa_is_private(VALUE self)
{
    EVP_PKEY *pkey;
  
    GetPKeyRSA(self, pkey);
    
    return (RSA_PRIVATE(self, pkey->pkey.rsa)) ? Qtrue : Qfalse;
}

#private_decrypt(string[, padding]) ⇒ aString

Returns:

  • (aString) 


388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'ossl_pkey_rsa.c', line 388

static VALUE
ossl_rsa_private_decrypt(int argc, VALUE *argv, VALUE self)
{
    EVP_PKEY *pkey;
    int buf_len, pad;
    VALUE str, buffer, padding;

    GetPKeyRSA(self, pkey);
    if (!RSA_PRIVATE(self, pkey->pkey.rsa)) {
  ossl_raise(eRSAError, "private key needed.");
    }
    rb_scan_args(argc, argv, "11", &buffer, &padding);
    pad = (argc == 1) ? RSA_PKCS1_PADDING : NUM2INT(padding);
    StringValue(buffer);
    str = rb_str_new(0, ossl_rsa_buf_size(pkey));
    buf_len = RSA_private_decrypt(RSTRING_LEN(buffer), RSTRING_PTR(buffer),
          RSTRING_PTR(str), pkey->pkey.rsa,
          pad);
    if (buf_len < 0) ossl_raise(eRSAError, NULL);
    rb_str_set_len(str, buf_len);

    return str;
}

#private_encrypt(string[, padding]) ⇒ aString

Returns:

  • (aString) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'ossl_pkey_rsa.c', line 358

static VALUE
ossl_rsa_private_encrypt(int argc, VALUE *argv, VALUE self)
{
    EVP_PKEY *pkey;
    int buf_len, pad;
    VALUE str, buffer, padding;

    GetPKeyRSA(self, pkey);
    if (!RSA_PRIVATE(self, pkey->pkey.rsa)) {
  ossl_raise(eRSAError, "private key needed.");
    } 
    rb_scan_args(argc, argv, "11", &buffer, &padding);
    pad = (argc == 1) ? RSA_PKCS1_PADDING : NUM2INT(padding);
    StringValue(buffer);
    str = rb_str_new(0, ossl_rsa_buf_size(pkey));
    buf_len = RSA_private_encrypt(RSTRING_LEN(buffer), RSTRING_PTR(buffer),
          RSTRING_PTR(str), pkey->pkey.rsa,
          pad);
    if (buf_len < 0) ossl_raise(eRSAError, NULL);
    rb_str_set_len(str, buf_len);
    
    return str;
}

#public? ⇒ true

The return value is always true since every private key is also a public key.

Returns:

  • (true) 


191
192
193
194
195
196
197
198
199
200
201
 
# File 'ossl_pkey_rsa.c', line 191

static VALUE
ossl_rsa_is_public(VALUE self)
{
    EVP_PKEY *pkey;

    GetPKeyRSA(self, pkey);
    /*
     * This method should check for n and e.  BUG.
     */
    return Qtrue;
}

#public_decrypt(string[, padding]) ⇒ aString

Returns:

  • (aString) 


332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'ossl_pkey_rsa.c', line 332

static VALUE
ossl_rsa_public_decrypt(int argc, VALUE *argv, VALUE self)
{
    EVP_PKEY *pkey;
    int buf_len, pad;
    VALUE str, buffer, padding;

    GetPKeyRSA(self, pkey);
    rb_scan_args(argc, argv, "11", &buffer, &padding);
    pad = (argc == 1) ? RSA_PKCS1_PADDING : NUM2INT(padding);
    StringValue(buffer);
    str = rb_str_new(0, ossl_rsa_buf_size(pkey));
    buf_len = RSA_public_decrypt(RSTRING_LEN(buffer), RSTRING_PTR(buffer),
         RSTRING_PTR(str), pkey->pkey.rsa,
         pad);
    if (buf_len < 0) ossl_raise(eRSAError, NULL);
    rb_str_set_len(str, buf_len);
    
    return str;
}

#public_encrypt(string[, padding]) ⇒ aString

Returns:

  • (aString) 


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'ossl_pkey_rsa.c', line 306

static VALUE
ossl_rsa_public_encrypt(int argc, VALUE *argv, VALUE self)
{
    EVP_PKEY *pkey;
    int buf_len, pad;
    VALUE str, buffer, padding;

    GetPKeyRSA(self, pkey);
    rb_scan_args(argc, argv, "11", &buffer, &padding);
    pad = (argc == 1) ? RSA_PKCS1_PADDING : NUM2INT(padding);
    StringValue(buffer);
    str = rb_str_new(0, ossl_rsa_buf_size(pkey));
    buf_len = RSA_public_encrypt(RSTRING_LEN(buffer), RSTRING_PTR(buffer),
         RSTRING_PTR(str), pkey->pkey.rsa,
         pad);
    if (buf_len < 0) ossl_raise(eRSAError, NULL);
    rb_str_set_len(str, buf_len);

    return str;
}

#public_key ⇒ Object

Makes new instance RSA PUBLIC_KEY from PRIVATE_KEY



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'ossl_pkey_rsa.c', line 476

static VALUE
ossl_rsa_to_public_key(VALUE self)
{
    EVP_PKEY *pkey;
    RSA *rsa;
    VALUE obj;
    
    GetPKeyRSA(self, pkey);
    /* err check performed by rsa_instance */
    rsa = RSAPublicKey_dup(pkey->pkey.rsa);
    obj = rsa_instance(CLASS_OF(self), rsa);
    if (obj == Qfalse) {
  RSA_free(rsa);
  ossl_raise(eRSAError, NULL);
    }
    return obj;
}

#to_der ⇒ aString

Returns:

  • (aString) 


274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'ossl_pkey_rsa.c', line 274

static VALUE
ossl_rsa_to_der(VALUE self)
{
    EVP_PKEY *pkey;
    int (*i2d_func)_((const RSA*, unsigned char**));
    unsigned char *p;
    long len;
    VALUE str;

    GetPKeyRSA(self, pkey);
    if(RSA_HAS_PRIVATE(pkey->pkey.rsa))
  i2d_func = i2d_RSAPrivateKey;
    else
  i2d_func = i2d_RSAPublicKey;
    if((len = i2d_func(pkey->pkey.rsa, NULL)) <= 0)
  ossl_raise(eRSAError, NULL);
    str = rb_str_new(0, len);
    p = RSTRING_PTR(str);
    if(i2d_func(pkey->pkey.rsa, &p) < 0)
  ossl_raise(eRSAError, NULL);
    ossl_str_adjust(str, p);

    return str;
}

#to_text ⇒ aString

Prints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don’t use :-)) (It’s up to you)

Returns:

  • (aString) 


450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'ossl_pkey_rsa.c', line 450

static VALUE
ossl_rsa_to_text(VALUE self)
{
    EVP_PKEY *pkey;
    BIO *out;
    VALUE str;

    GetPKeyRSA(self, pkey);
    if (!(out = BIO_new(BIO_s_mem()))) {
  ossl_raise(eRSAError, NULL);
    }
    if (!RSA_print(out, pkey->pkey.rsa, 0)) { /* offset = 0 */
  BIO_free(out);
  ossl_raise(eRSAError, NULL);
    }
    str = ossl_membio2str(out);

    return str;
}