class OpenSSL::X509::CRL - Documentation for Ruby 4.0
Description: Documentation for the OpenSSL::X509::CRL class
Keywords: ruby,class,OpenSSL::X509::CRL

🔍

No recent searches

# class OpenSSL::X509::CRL

### Public Class Methods

new (p1 = v1)
Source

    static VALUE
    ossl_x509crl_initialize(int argc, VALUE *argv, VALUE self)
    {
        BIO *in;
        X509_CRL *crl, *crl_orig = RTYPEDDATA_DATA(self);
        VALUE arg;

        rb_check_frozen(self);
        if (rb_scan_args(argc, argv, "01", &arg) == 0) {
            return self;
        }
        arg = ossl_to_der_if_possible(arg);
        in = ossl_obj2bio(&arg);
        crl = d2i_X509_CRL_bio(in, NULL);
        if (!crl) {
            OSSL_BIO_reset(in);
            crl = PEM_read_bio_X509_CRL(in, NULL, NULL, NULL);
        }
        BIO_free(in);
        if (!crl)
            ossl_raise(eX509CRLError, "PEM_read_bio_X509_CRL");

        RTYPEDDATA_DATA(self) = crl;
        X509_CRL_free(crl_orig);

        return self;
    }

### Public Instance Methods

== (other)
Source

    # File ext/openssl/lib/openssl/x509.rb, line 378
    def ==(other)
      return false unless CRL === other
      to_der == other.to_der
    end

add_extension (p1)
Source

    static VALUE
    ossl_x509crl_add_extension(VALUE self, VALUE extension)
    {
        X509_CRL *crl;
        X509_EXTENSION *ext;

        GetX509CRL(self, crl);
        ext = GetX509ExtPtr(extension);
        if (!X509_CRL_add_ext(crl, ext, -1)) {
            ossl_raise(eX509CRLError, NULL);
        }

        return extension;
    }

add_revoked (p1)
Source

    static VALUE
    ossl_x509crl_add_revoked(VALUE self, VALUE revoked)
    {
        X509_CRL *crl;
        X509_REVOKED *rev;

        GetX509CRL(self, crl);
        rev = DupX509RevokedPtr(revoked);
        if (!X509_CRL_add0_revoked(crl, rev)) { /* NO DUP - don't free! */
            X509_REVOKED_free(rev);
            ossl_raise(eX509CRLError, "X509_CRL_add0_revoked");
        }
        X509_CRL_sort(crl);

        return revoked;
    }

extensions ()
Source

    static VALUE
    ossl_x509crl_get_extensions(VALUE self)
    {
        X509_CRL *crl;
        int count, i;
        VALUE ary;

        GetX509CRL(self, crl);
        count = X509_CRL_get_ext_count(crl);
        ary = rb_ary_new_capa(count);
        for (i=0; i<count; i++) {
            const X509_EXTENSION *ext = X509_CRL_get_ext(crl, i);
            rb_ary_push(ary, ossl_x509ext_new(ext));
        }

        return ary;
    }

Gets X509v3 extensions as array of X509Ext objects

extensions= (p1)
Source

    static VALUE
    ossl_x509crl_set_extensions(VALUE self, VALUE ary)
    {
        X509_CRL *crl;
        X509_EXTENSION *ext;
        long i;

        Check_Type(ary, T_ARRAY);
        /* All ary members should be X509 Extensions */
        for (i=0; i<RARRAY_LEN(ary); i++) {
            OSSL_Check_Kind(RARRAY_AREF(ary, i), cX509Ext);
        }
        GetX509CRL(self, crl);
        for (i = X509_CRL_get_ext_count(crl); i > 0; i--)
            X509_EXTENSION_free(X509_CRL_delete_ext(crl, 0));
        for (i=0; i<RARRAY_LEN(ary); i++) {
            ext = GetX509ExtPtr(RARRAY_AREF(ary, i)); /* NO NEED TO DUP */
            if (!X509_CRL_add_ext(crl, ext, -1)) {
                ossl_raise(eX509CRLError, "X509_CRL_add_ext");
            }
        }

        return ary;
    }

Sets X509_EXTENSIONs

issuer ()
Source

    static VALUE
    ossl_x509crl_get_issuer(VALUE self)
    {
        X509_CRL *crl;

        GetX509CRL(self, crl);

        return ossl_x509name_new(X509_CRL_get_issuer(crl)); /* NO DUP - don't free */
    }

issuer= (p1)
Source

    static VALUE
    ossl_x509crl_set_issuer(VALUE self, VALUE issuer)
    {
        X509_CRL *crl;

        GetX509CRL(self, crl);

        if (!X509_CRL_set_issuer_name(crl, GetX509NamePtr(issuer))) { /* DUPs name */
            ossl_raise(eX509CRLError, NULL);
        }
        return issuer;
    }

last_update ()
Source

    static VALUE
    ossl_x509crl_get_last_update(VALUE self)
    {
        X509_CRL *crl;
        const ASN1_TIME *time;

        GetX509CRL(self, crl);
        time = X509_CRL_get0_lastUpdate(crl);
        if (!time)
            return Qnil;

        return asn1time_to_time(time);
    }

last_update= (p1)
Source

    static VALUE
    ossl_x509crl_set_last_update(VALUE self, VALUE time)
    {
        X509_CRL *crl;
        ASN1_TIME *asn1time;

        GetX509CRL(self, crl);
        asn1time = ossl_x509_time_adjust(NULL, time);
        if (!X509_CRL_set1_lastUpdate(crl, asn1time)) {
            ASN1_TIME_free(asn1time);
            ossl_raise(eX509CRLError, "X509_CRL_set_lastUpdate");
        }
        ASN1_TIME_free(asn1time);

        return time;
    }

next_update ()
Source

    static VALUE
    ossl_x509crl_get_next_update(VALUE self)
    {
        X509_CRL *crl;
        const ASN1_TIME *time;

        GetX509CRL(self, crl);
        time = X509_CRL_get0_nextUpdate(crl);
        if (!time)
            return Qnil;

        return asn1time_to_time(time);
    }

next_update= (p1)
Source

    static VALUE
    ossl_x509crl_set_next_update(VALUE self, VALUE time)
    {
        X509_CRL *crl;
        ASN1_TIME *asn1time;

        GetX509CRL(self, crl);
        asn1time = ossl_x509_time_adjust(NULL, time);
        if (!X509_CRL_set1_nextUpdate(crl, asn1time)) {
            ASN1_TIME_free(asn1time);
            ossl_raise(eX509CRLError, "X509_CRL_set_nextUpdate");
        }
        ASN1_TIME_free(asn1time);

        return time;
    }

revoked ()
Source

    static VALUE
    ossl_x509crl_get_revoked(VALUE self)
    {
        X509_CRL *crl;
        int i, num;
        STACK_OF(X509_REVOKED) *sk;
        VALUE ary;

        GetX509CRL(self, crl);
        sk = X509_CRL_get_REVOKED(crl);
        if (!sk)
            return rb_ary_new();

        num = sk_X509_REVOKED_num(sk);
        ary = rb_ary_new_capa(num);
        for(i=0; i<num; i++) {
            const X509_REVOKED *rev = sk_X509_REVOKED_value(sk, i);
            rb_ary_push(ary, ossl_x509revoked_new(rev));
        }

        return ary;
    }

revoked= (p1)
Source

    static VALUE
    ossl_x509crl_set_revoked(VALUE self, VALUE ary)
    {
        X509_CRL *crl;
        X509_REVOKED *rev;
        STACK_OF(X509_REVOKED) *sk;
        long i;

        Check_Type(ary, T_ARRAY);
        /* All ary members should be X509 Revoked */
        for (i=0; i<RARRAY_LEN(ary); i++) {
            OSSL_Check_Kind(RARRAY_AREF(ary, i), cX509Rev);
        }
        GetX509CRL(self, crl);
        if ((sk = X509_CRL_get_REVOKED(crl))) {
            while ((rev = sk_X509_REVOKED_pop(sk)))
                X509_REVOKED_free(rev);
        }
        for (i=0; i<RARRAY_LEN(ary); i++) {
            rev = DupX509RevokedPtr(RARRAY_AREF(ary, i));
            if (!X509_CRL_add0_revoked(crl, rev)) { /* NO DUP - don't free! */
                X509_REVOKED_free(rev);
                ossl_raise(eX509CRLError, "X509_CRL_add0_revoked");
            }
        }
        X509_CRL_sort(crl);

        return ary;
    }

sign (p1, p2)
Source

    static VALUE
    ossl_x509crl_sign(VALUE self, VALUE key, VALUE digest)
    {
        X509_CRL *crl;
        EVP_PKEY *pkey;
        const EVP_MD *md;
        VALUE md_holder;

        GetX509CRL(self, crl);
        pkey = GetPrivPKeyPtr(key); /* NO NEED TO DUP */
        /* NULL needed for some key types, e.g. Ed25519 */
        md = NIL_P(digest) ? NULL : ossl_evp_md_fetch(digest, &md_holder);
        if (!X509_CRL_sign(crl, pkey, md))
            ossl_raise(eX509CRLError, "X509_CRL_sign");

        return self;
    }

signature_algorithm → string
Source

    static VALUE
    ossl_x509crl_get_signature_algorithm(VALUE self)
    {
        X509_CRL *crl;
        const X509_ALGOR *alg;
        const ASN1_OBJECT *obj;

        GetX509CRL(self, crl);
        X509_CRL_get0_signature(crl, NULL, &alg);
        X509_ALGOR_get0(&obj, NULL, NULL, alg);
        return ossl_asn1obj_to_string_long_name(obj);
    }

Returns the signature algorithm used to sign this `CRL`.

Returns the long name of the signature algorithm, or the dotted decimal notation if OpenSSL does not define a long name for it.

to_der ()
Source

    static VALUE
    ossl_x509crl_to_der(VALUE self)
    {
        X509_CRL *crl;
        BIO *out;

        GetX509CRL(self, crl);
        if (!(out = BIO_new(BIO_s_mem()))) {
            ossl_raise(eX509CRLError, NULL);
        }
        if (!i2d_X509_CRL_bio(out, crl)) {
            BIO_free(out);
            ossl_raise(eX509CRLError, NULL);
        }

        return ossl_membio2str(out);
    }

to_pem ()
Source

    static VALUE
    ossl_x509crl_to_pem(VALUE self)
    {
        X509_CRL *crl;
        BIO *out;

        GetX509CRL(self, crl);
        if (!(out = BIO_new(BIO_s_mem()))) {
            ossl_raise(eX509CRLError, NULL);
        }
        if (!PEM_write_bio_X509_CRL(out, crl)) {
            BIO_free(out);
            ossl_raise(eX509CRLError, NULL);
        }

        return ossl_membio2str(out);
    }

Also aliased as: to_s
to_s ()
Alias for: to_pem
to_text ()
Source

    static VALUE
    ossl_x509crl_to_text(VALUE self)
    {
        X509_CRL *crl;
        BIO *out;

        GetX509CRL(self, crl);
        if (!(out = BIO_new(BIO_s_mem()))) {
            ossl_raise(eX509CRLError, NULL);
        }
        if (!X509_CRL_print(out, crl)) {
            BIO_free(out);
            ossl_raise(eX509CRLError, NULL);
        }

        return ossl_membio2str(out);
    }

verify (p1)
Source

    static VALUE
    ossl_x509crl_verify(VALUE self, VALUE key)
    {
        X509_CRL *crl;
        EVP_PKEY *pkey;

        GetX509CRL(self, crl);
        pkey = GetPKeyPtr(key);
        ossl_pkey_check_public_key(pkey);
        switch (X509_CRL_verify(crl, pkey)) {
          case 1:
            return Qtrue;
          case 0:
            ossl_clear_error();
            return Qfalse;
          default:
            ossl_raise(eX509CRLError, NULL);
        }
    }

version ()
Source

    static VALUE
    ossl_x509crl_get_version(VALUE self)
    {
        X509_CRL *crl;
        long ver;

        GetX509CRL(self, crl);
        ver = X509_CRL_get_version(crl);

        return LONG2NUM(ver);
    }

version= (p1)
Source

    static VALUE
    ossl_x509crl_set_version(VALUE self, VALUE version)
    {
        X509_CRL *crl;
        long ver;

        if ((ver = NUM2LONG(version)) < 0) {
            ossl_raise(eX509CRLError, "version must be >= 0!");
        }
        GetX509CRL(self, crl);
        if (!X509_CRL_set_version(crl, ver)) {
            ossl_raise(eX509CRLError, NULL);
        }

        return version;
    }