Ruby  3.1.0dev(2021-09-10revisionb76ad15ed0da636161de0243c547ee1e6fc95681)
ossl_x509crl.c
Go to the documentation of this file.
1 /*
2  * 'OpenSSL for Ruby' project
3  * Copyright (C) 2001-2002 Michal Rokos <m.rokos@sh.cvut.cz>
4  * All rights reserved.
5  */
6 /*
7  * This program is licensed under the same licence as Ruby.
8  * (See the file 'LICENCE'.)
9  */
10 #include "ossl.h"
11 
12 #define NewX509CRL(klass) \
13  TypedData_Wrap_Struct((klass), &ossl_x509crl_type, 0)
14 #define SetX509CRL(obj, crl) do { \
15  if (!(crl)) { \
16  ossl_raise(rb_eRuntimeError, "CRL wasn't initialized!"); \
17  } \
18  RTYPEDDATA_DATA(obj) = (crl); \
19 } while (0)
20 #define GetX509CRL(obj, crl) do { \
21  TypedData_Get_Struct((obj), X509_CRL, &ossl_x509crl_type, (crl)); \
22  if (!(crl)) { \
23  ossl_raise(rb_eRuntimeError, "CRL wasn't initialized!"); \
24  } \
25 } while (0)
26 
27 /*
28  * Classes
29  */
32 
33 static void
34 ossl_x509crl_free(void *ptr)
35 {
36  X509_CRL_free(ptr);
37 }
38 
39 static const rb_data_type_t ossl_x509crl_type = {
40  "OpenSSL/X509/CRL",
41  {
42  0, ossl_x509crl_free,
43  },
45 };
46 
47 /*
48  * PUBLIC
49  */
50 X509_CRL *
52 {
53  X509_CRL *crl;
54 
55  GetX509CRL(obj, crl);
56 
57  return crl;
58 }
59 
60 VALUE
61 ossl_x509crl_new(X509_CRL *crl)
62 {
63  X509_CRL *tmp;
64  VALUE obj;
65 
66  obj = NewX509CRL(cX509CRL);
67  tmp = crl ? X509_CRL_dup(crl) : X509_CRL_new();
68  if(!tmp) ossl_raise(eX509CRLError, NULL);
69  SetX509CRL(obj, tmp);
70 
71  return obj;
72 }
73 
74 /*
75  * PRIVATE
76  */
77 static VALUE
78 ossl_x509crl_alloc(VALUE klass)
79 {
80  X509_CRL *crl;
81  VALUE obj;
82 
83  obj = NewX509CRL(klass);
84  if (!(crl = X509_CRL_new())) {
86  }
87  SetX509CRL(obj, crl);
88 
89  return obj;
90 }
91 
92 static VALUE
93 ossl_x509crl_initialize(int argc, VALUE *argv, VALUE self)
94 {
95  BIO *in;
96  X509_CRL *crl, *crl_orig = RTYPEDDATA_DATA(self);
97  VALUE arg;
98 
99  rb_check_frozen(self);
100  if (rb_scan_args(argc, argv, "01", &arg) == 0) {
101  return self;
102  }
103  arg = ossl_to_der_if_possible(arg);
104  in = ossl_obj2bio(&arg);
105  crl = d2i_X509_CRL_bio(in, NULL);
106  if (!crl) {
107  OSSL_BIO_reset(in);
108  crl = PEM_read_bio_X509_CRL(in, NULL, NULL, NULL);
109  }
110  BIO_free(in);
111  if (!crl)
112  ossl_raise(eX509CRLError, "PEM_read_bio_X509_CRL");
113 
114  RTYPEDDATA_DATA(self) = crl;
115  X509_CRL_free(crl_orig);
116 
117  return self;
118 }
119 
120 static VALUE
121 ossl_x509crl_copy(VALUE self, VALUE other)
122 {
123  X509_CRL *a, *b, *crl;
124 
125  rb_check_frozen(self);
126  if (self == other) return self;
127  GetX509CRL(self, a);
128  GetX509CRL(other, b);
129  if (!(crl = X509_CRL_dup(b))) {
131  }
132  X509_CRL_free(a);
133  DATA_PTR(self) = crl;
134 
135  return self;
136 }
137 
138 static VALUE
139 ossl_x509crl_get_version(VALUE self)
140 {
141  X509_CRL *crl;
142  long ver;
143 
144  GetX509CRL(self, crl);
145  ver = X509_CRL_get_version(crl);
146 
147  return LONG2NUM(ver);
148 }
149 
150 static VALUE
151 ossl_x509crl_set_version(VALUE self, VALUE version)
152 {
153  X509_CRL *crl;
154  long ver;
155 
156  if ((ver = NUM2LONG(version)) < 0) {
157  ossl_raise(eX509CRLError, "version must be >= 0!");
158  }
159  GetX509CRL(self, crl);
160  if (!X509_CRL_set_version(crl, ver)) {
162  }
163 
164  return version;
165 }
166 
167 static VALUE
168 ossl_x509crl_get_signature_algorithm(VALUE self)
169 {
170  X509_CRL *crl;
171  const X509_ALGOR *alg;
172  BIO *out;
173 
174  GetX509CRL(self, crl);
175  if (!(out = BIO_new(BIO_s_mem()))) {
177  }
178  X509_CRL_get0_signature(crl, NULL, &alg);
179  if (!i2a_ASN1_OBJECT(out, alg->algorithm)) {
180  BIO_free(out);
182  }
183 
184  return ossl_membio2str(out);
185 }
186 
187 static VALUE
188 ossl_x509crl_get_issuer(VALUE self)
189 {
190  X509_CRL *crl;
191 
192  GetX509CRL(self, crl);
193 
194  return ossl_x509name_new(X509_CRL_get_issuer(crl)); /* NO DUP - don't free */
195 }
196 
197 static VALUE
198 ossl_x509crl_set_issuer(VALUE self, VALUE issuer)
199 {
200  X509_CRL *crl;
201 
202  GetX509CRL(self, crl);
203 
204  if (!X509_CRL_set_issuer_name(crl, GetX509NamePtr(issuer))) { /* DUPs name */
206  }
207  return issuer;
208 }
209 
210 static VALUE
211 ossl_x509crl_get_last_update(VALUE self)
212 {
213  X509_CRL *crl;
214  const ASN1_TIME *time;
215 
216  GetX509CRL(self, crl);
217  time = X509_CRL_get0_lastUpdate(crl);
218  if (!time)
219  return Qnil;
220 
221  return asn1time_to_time(time);
222 }
223 
224 static VALUE
225 ossl_x509crl_set_last_update(VALUE self, VALUE time)
226 {
227  X509_CRL *crl;
228  ASN1_TIME *asn1time;
229 
230  GetX509CRL(self, crl);
231  asn1time = ossl_x509_time_adjust(NULL, time);
232  if (!X509_CRL_set1_lastUpdate(crl, asn1time)) {
233  ASN1_TIME_free(asn1time);
234  ossl_raise(eX509CRLError, "X509_CRL_set_lastUpdate");
235  }
236  ASN1_TIME_free(asn1time);
237 
238  return time;
239 }
240 
241 static VALUE
242 ossl_x509crl_get_next_update(VALUE self)
243 {
244  X509_CRL *crl;
245  const ASN1_TIME *time;
246 
247  GetX509CRL(self, crl);
248  time = X509_CRL_get0_nextUpdate(crl);
249  if (!time)
250  return Qnil;
251 
252  return asn1time_to_time(time);
253 }
254 
255 static VALUE
256 ossl_x509crl_set_next_update(VALUE self, VALUE time)
257 {
258  X509_CRL *crl;
259  ASN1_TIME *asn1time;
260 
261  GetX509CRL(self, crl);
262  asn1time = ossl_x509_time_adjust(NULL, time);
263  if (!X509_CRL_set1_nextUpdate(crl, asn1time)) {
264  ASN1_TIME_free(asn1time);
265  ossl_raise(eX509CRLError, "X509_CRL_set_nextUpdate");
266  }
267  ASN1_TIME_free(asn1time);
268 
269  return time;
270 }
271 
272 static VALUE
273 ossl_x509crl_get_revoked(VALUE self)
274 {
275  X509_CRL *crl;
276  int i, num;
277  X509_REVOKED *rev;
278  VALUE ary, revoked;
279 
280  GetX509CRL(self, crl);
281  num = sk_X509_REVOKED_num(X509_CRL_get_REVOKED(crl));
282  if (num < 0) {
283  OSSL_Debug("num < 0???");
284  return rb_ary_new();
285  }
286  ary = rb_ary_new2(num);
287  for(i=0; i<num; i++) {
288  /* NO DUP - don't free! */
289  rev = sk_X509_REVOKED_value(X509_CRL_get_REVOKED(crl), i);
290  revoked = ossl_x509revoked_new(rev);
291  rb_ary_push(ary, revoked);
292  }
293 
294  return ary;
295 }
296 
297 static VALUE
298 ossl_x509crl_set_revoked(VALUE self, VALUE ary)
299 {
300  X509_CRL *crl;
301  X509_REVOKED *rev;
302  STACK_OF(X509_REVOKED) *sk;
303  long i;
304 
305  Check_Type(ary, T_ARRAY);
306  /* All ary members should be X509 Revoked */
307  for (i=0; i<RARRAY_LEN(ary); i++) {
309  }
310  GetX509CRL(self, crl);
311  if ((sk = X509_CRL_get_REVOKED(crl))) {
312  while ((rev = sk_X509_REVOKED_pop(sk)))
313  X509_REVOKED_free(rev);
314  }
315  for (i=0; i<RARRAY_LEN(ary); i++) {
316  rev = DupX509RevokedPtr(RARRAY_AREF(ary, i));
317  if (!X509_CRL_add0_revoked(crl, rev)) { /* NO DUP - don't free! */
318  X509_REVOKED_free(rev);
319  ossl_raise(eX509CRLError, "X509_CRL_add0_revoked");
320  }
321  }
322  X509_CRL_sort(crl);
323 
324  return ary;
325 }
326 
327 static VALUE
328 ossl_x509crl_add_revoked(VALUE self, VALUE revoked)
329 {
330  X509_CRL *crl;
331  X509_REVOKED *rev;
332 
333  GetX509CRL(self, crl);
334  rev = DupX509RevokedPtr(revoked);
335  if (!X509_CRL_add0_revoked(crl, rev)) { /* NO DUP - don't free! */
336  X509_REVOKED_free(rev);
337  ossl_raise(eX509CRLError, "X509_CRL_add0_revoked");
338  }
339  X509_CRL_sort(crl);
340 
341  return revoked;
342 }
343 
344 static VALUE
345 ossl_x509crl_sign(VALUE self, VALUE key, VALUE digest)
346 {
347  X509_CRL *crl;
348  EVP_PKEY *pkey;
349  const EVP_MD *md;
350 
351  GetX509CRL(self, crl);
352  pkey = GetPrivPKeyPtr(key); /* NO NEED TO DUP */
353  md = ossl_evp_get_digestbyname(digest);
354  if (!X509_CRL_sign(crl, pkey, md)) {
356  }
357 
358  return self;
359 }
360 
361 static VALUE
362 ossl_x509crl_verify(VALUE self, VALUE key)
363 {
364  X509_CRL *crl;
365  EVP_PKEY *pkey;
366 
367  GetX509CRL(self, crl);
368  pkey = GetPKeyPtr(key);
370  switch (X509_CRL_verify(crl, pkey)) {
371  case 1:
372  return Qtrue;
373  case 0:
375  return Qfalse;
376  default:
378  }
379 }
380 
381 static VALUE
382 ossl_x509crl_to_der(VALUE self)
383 {
384  X509_CRL *crl;
385  BIO *out;
386 
387  GetX509CRL(self, crl);
388  if (!(out = BIO_new(BIO_s_mem()))) {
390  }
391  if (!i2d_X509_CRL_bio(out, crl)) {
392  BIO_free(out);
394  }
395 
396  return ossl_membio2str(out);
397 }
398 
399 static VALUE
400 ossl_x509crl_to_pem(VALUE self)
401 {
402  X509_CRL *crl;
403  BIO *out;
404 
405  GetX509CRL(self, crl);
406  if (!(out = BIO_new(BIO_s_mem()))) {
408  }
409  if (!PEM_write_bio_X509_CRL(out, crl)) {
410  BIO_free(out);
412  }
413 
414  return ossl_membio2str(out);
415 }
416 
417 static VALUE
418 ossl_x509crl_to_text(VALUE self)
419 {
420  X509_CRL *crl;
421  BIO *out;
422 
423  GetX509CRL(self, crl);
424  if (!(out = BIO_new(BIO_s_mem()))) {
426  }
427  if (!X509_CRL_print(out, crl)) {
428  BIO_free(out);
430  }
431 
432  return ossl_membio2str(out);
433 }
434 
435 /*
436  * Gets X509v3 extensions as array of X509Ext objects
437  */
438 static VALUE
439 ossl_x509crl_get_extensions(VALUE self)
440 {
441  X509_CRL *crl;
442  int count, i;
443  X509_EXTENSION *ext;
444  VALUE ary;
445 
446  GetX509CRL(self, crl);
447  count = X509_CRL_get_ext_count(crl);
448  if (count < 0) {
449  OSSL_Debug("count < 0???");
450  return rb_ary_new();
451  }
452  ary = rb_ary_new2(count);
453  for (i=0; i<count; i++) {
454  ext = X509_CRL_get_ext(crl, i); /* NO DUP - don't free! */
455  rb_ary_push(ary, ossl_x509ext_new(ext));
456  }
457 
458  return ary;
459 }
460 
461 /*
462  * Sets X509_EXTENSIONs
463  */
464 static VALUE
465 ossl_x509crl_set_extensions(VALUE self, VALUE ary)
466 {
467  X509_CRL *crl;
468  X509_EXTENSION *ext;
469  long i;
470 
471  Check_Type(ary, T_ARRAY);
472  /* All ary members should be X509 Extensions */
473  for (i=0; i<RARRAY_LEN(ary); i++) {
475  }
476  GetX509CRL(self, crl);
477  while ((ext = X509_CRL_delete_ext(crl, 0)))
478  X509_EXTENSION_free(ext);
479  for (i=0; i<RARRAY_LEN(ary); i++) {
480  ext = GetX509ExtPtr(RARRAY_AREF(ary, i)); /* NO NEED TO DUP */
481  if (!X509_CRL_add_ext(crl, ext, -1)) {
483  }
484  }
485 
486  return ary;
487 }
488 
489 static VALUE
490 ossl_x509crl_add_extension(VALUE self, VALUE extension)
491 {
492  X509_CRL *crl;
493  X509_EXTENSION *ext;
494 
495  GetX509CRL(self, crl);
496  ext = GetX509ExtPtr(extension);
497  if (!X509_CRL_add_ext(crl, ext, -1)) {
499  }
500 
501  return extension;
502 }
503 
504 /*
505  * INIT
506  */
507 void
509 {
510 #if 0
511  mOSSL = rb_define_module("OpenSSL");
514 #endif
515 
517 
519 
520  rb_define_alloc_func(cX509CRL, ossl_x509crl_alloc);
521  rb_define_method(cX509CRL, "initialize", ossl_x509crl_initialize, -1);
522  rb_define_method(cX509CRL, "initialize_copy", ossl_x509crl_copy, 1);
523 
524  rb_define_method(cX509CRL, "version", ossl_x509crl_get_version, 0);
525  rb_define_method(cX509CRL, "version=", ossl_x509crl_set_version, 1);
526  rb_define_method(cX509CRL, "signature_algorithm", ossl_x509crl_get_signature_algorithm, 0);
527  rb_define_method(cX509CRL, "issuer", ossl_x509crl_get_issuer, 0);
528  rb_define_method(cX509CRL, "issuer=", ossl_x509crl_set_issuer, 1);
529  rb_define_method(cX509CRL, "last_update", ossl_x509crl_get_last_update, 0);
530  rb_define_method(cX509CRL, "last_update=", ossl_x509crl_set_last_update, 1);
531  rb_define_method(cX509CRL, "next_update", ossl_x509crl_get_next_update, 0);
532  rb_define_method(cX509CRL, "next_update=", ossl_x509crl_set_next_update, 1);
533  rb_define_method(cX509CRL, "revoked", ossl_x509crl_get_revoked, 0);
534  rb_define_method(cX509CRL, "revoked=", ossl_x509crl_set_revoked, 1);
535  rb_define_method(cX509CRL, "add_revoked", ossl_x509crl_add_revoked, 1);
536  rb_define_method(cX509CRL, "sign", ossl_x509crl_sign, 2);
537  rb_define_method(cX509CRL, "verify", ossl_x509crl_verify, 1);
538  rb_define_method(cX509CRL, "to_der", ossl_x509crl_to_der, 0);
539  rb_define_method(cX509CRL, "to_pem", ossl_x509crl_to_pem, 0);
540  rb_define_alias(cX509CRL, "to_s", "to_pem");
541  rb_define_method(cX509CRL, "to_text", ossl_x509crl_to_text, 0);
542  rb_define_method(cX509CRL, "extensions", ossl_x509crl_get_extensions, 0);
543  rb_define_method(cX509CRL, "extensions=", ossl_x509crl_set_extensions, 1);
544  rb_define_method(cX509CRL, "add_extension", ossl_x509crl_add_extension, 1);
545 }
GetPKeyPtr
EVP_PKEY * GetPKeyPtr(VALUE obj)
Definition: ossl_pkey.c:432
GetX509CRLPtr
X509_CRL * GetX509CRLPtr(VALUE obj)
Definition: ossl_x509crl.c:51
rb_define_module_under
VALUE rb_define_module_under(VALUE outer, const char *name)
Definition: class.c:914
X509_CRL_get0_lastUpdate
#define X509_CRL_get0_lastUpdate(x)
ossl_x509name_new
VALUE ossl_x509name_new(X509_NAME *)
Definition: ossl_x509name.c:56
eX509CRLError
VALUE eX509CRLError
Definition: ossl_x509crl.c:31
GetX509ExtPtr
X509_EXTENSION * GetX509ExtPtr(VALUE)
Definition: ossl_x509ext.c:85
ossl_to_der_if_possible
VALUE ossl_to_der_if_possible(VALUE obj)
Definition: ossl.c:261
ossl_membio2str
VALUE ossl_membio2str(BIO *bio)
Definition: ossl_bio.c:29
ossl_x509_time_adjust
ASN1_TIME * ossl_x509_time_adjust(ASN1_TIME *s, VALUE time)
Definition: ossl_x509.c:19
asn1time_to_time
VALUE asn1time_to_time(const ASN1_TIME *time)
Definition: ossl_asn1.c:20
ossl_obj2bio
BIO * ossl_obj2bio(volatile VALUE *pobj)
Definition: ossl_bio.c:13
OSSL_Check_Kind
#define OSSL_Check_Kind(obj, klass)
Definition: ossl.h:58
OSSL_BIO_reset
#define OSSL_BIO_reset(bio)
Definition: ossl.h:115
rb_define_module
VALUE rb_define_module(const char *name)
Definition: class.c:887
mX509
VALUE mX509
Definition: ossl_x509.c:12
LONG2NUM
#define LONG2NUM
Definition: long.h:50
ossl.h
ossl_x509revoked_new
VALUE ossl_x509revoked_new(X509_REVOKED *)
Definition: ossl_x509revoked.c:51
argv
char ** argv
Definition: ruby.c:243
ossl_clear_error
void ossl_clear_error(void)
Definition: ossl.c:310
DupX509RevokedPtr
X509_REVOKED * DupX509RevokedPtr(VALUE)
Definition: ossl_x509revoked.c:71
ptr
struct RIMemo * ptr
Definition: debug.c:87
NewX509CRL
#define NewX509CRL(klass)
Definition: ossl_x509crl.c:12
rb_define_alias
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
Definition: class.c:2050
ossl_pkey_check_public_key
void ossl_pkey_check_public_key(const EVP_PKEY *pkey)
Definition: ossl_pkey.c:392
RUBY_TYPED_FREE_IMMEDIATELY
@ RUBY_TYPED_FREE_IMMEDIATELY
Definition: rtypeddata.h:62
X509_CRL_get0_nextUpdate
#define X509_CRL_get0_nextUpdate(x)
cX509Ext
VALUE cX509Ext
Definition: ossl_x509ext.c:43
mOSSL
VALUE mOSSL
Definition: ossl.c:237
rb_define_alloc_func
void rb_define_alloc_func(VALUE, rb_alloc_func_t)
rb_cObject
VALUE rb_cObject
Object class.
Definition: object.c:50
Qfalse
#define Qfalse
Definition: special_consts.h:50
rb_ary_push
VALUE rb_ary_push(VALUE ary, VALUE item)
Definition: array.c:1312
Qnil
#define Qnil
Definition: special_consts.h:51
ossl_raise
void ossl_raise(VALUE exc, const char *fmt,...)
Definition: ossl.c:299
cX509CRL
VALUE cX509CRL
Definition: ossl_x509crl.c:30
GetX509CRL
#define GetX509CRL(obj, crl)
Definition: ossl_x509crl.c:20
NULL
#define NULL
Definition: regenc.h:69
ossl_x509crl_new
VALUE ossl_x509crl_new(X509_CRL *crl)
Definition: ossl_x509crl.c:61
RTYPEDDATA_DATA
#define RTYPEDDATA_DATA(v)
Definition: rtypeddata.h:47
rb_scan_args
int rb_scan_args(int argc, const VALUE *argv, const char *fmt,...)
Definition: class.c:2347
key
key
Definition: openssl_missing.h:145
X509_CRL_set1_nextUpdate
#define X509_CRL_set1_nextUpdate(x, t)
Qtrue
#define Qtrue
Definition: special_consts.h:52
rb_ary_new2
#define rb_ary_new2
Definition: array.h:72
SetX509CRL
#define SetX509CRL(obj, crl)
Definition: ossl_x509crl.c:14
VALUE
unsigned long VALUE
Definition: value.h:38
X509_CRL_set1_lastUpdate
#define X509_CRL_set1_lastUpdate(x, t)
STACK_OF
STACK_OF(X509) *ossl_x509_ary2sk(VALUE)
ossl_x509ext_new
VALUE ossl_x509ext_new(X509_EXTENSION *)
Definition: ossl_x509ext.c:65
OSSL_Debug
#define OSSL_Debug(...)
Definition: ossl.h:139
NUM2LONG
#define NUM2LONG
Definition: long.h:51
GetX509NamePtr
X509_NAME * GetX509NamePtr(VALUE)
Definition: ossl_x509name.c:76
rb_check_frozen
#define rb_check_frozen
Definition: error.h:72
argc
int argc
Definition: ruby.c:242
T_ARRAY
#define T_ARRAY
Definition: value_type.h:56
cX509Rev
VALUE cX509Rev
Definition: ossl_x509revoked.c:30
rb_data_type_struct
Definition: rtypeddata.h:70
RARRAY_AREF
#define RARRAY_AREF(a, i)
Definition: missing.h:201
count
int count
Definition: nkf.c:5055
eOSSLError
VALUE eOSSLError
Definition: ossl.c:242
rb_define_class_under
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
Definition: class.c:809
DATA_PTR
#define DATA_PTR(obj)
Definition: rdata.h:55
rb_define_method
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
Definition: cxxanyargs.hpp:655
RARRAY_LEN
#define RARRAY_LEN
Definition: rarray.h:52
rb_ary_new
VALUE rb_ary_new(void)
Definition: array.c:754
GetPrivPKeyPtr
EVP_PKEY * GetPrivPKeyPtr(VALUE obj)
Definition: ossl_pkey.c:442
ossl_evp_get_digestbyname
const EVP_MD * ossl_evp_get_digestbyname(VALUE obj)
Definition: ossl_digest.c:45
rb_eStandardError
VALUE rb_eStandardError
Definition: error.c:1090
Init_ossl_x509crl
void Init_ossl_x509crl(void)
Definition: ossl_x509crl.c:508
X509_CRL_get0_signature
#define X509_CRL_get0_signature
Definition: openssl_missing.h:46