OpenSSL::X509::Certificate

class OpenSSL::X509::Certificate

父类:Object

实施RFC 5280中规定的X.509证书。提供对证书属性的访问，并允许从字符串中读取证书，但也支持从头开始创建新证书。

从文件中读取证书

证书能够处理以OpenSSL的PEM格式编码的DER编码证书和证书。

raw = File.read "cert.cer" # DER- or PEM-encoded
certificate = OpenSSL::X509::Certificate.new raw

将证书保存到文件

证书可以用DER格式编码

cert = ...
File.open("cert.cer", "wb") { |f| f.print cert.to_der }

或以PEM格式

cert = ...
File.open("cert.pem", "wb") { |f| f.print cert.to_pem }

X.509证书与私钥/公钥对（通常是RSA，DSA或ECC密钥）相关联（另请参阅OpenSSL :: PKey :: RSA，OpenSSL :: PKey :: DSA和OpenSSL :: PKey :: EC），公钥本身存储在证书中，可以以OpenSSL :: PKey的形式访问。证书通常用于将某种形式的身份与密钥对相关联，例如，通过HTTP服务页面的Web服务器使用证书向用户进行身份验证。

公钥基础设施（PKI）模型依赖颁发这些证书的可信证书颁发机构（“根CA”），因此最终用户需要将其信任基础放在选定的少数几个权威人士身上，这些权威人员再次为下属CA颁发证书终端用户。

OpenSSL :: X509模块提供了设置独立PKI的工具，类似于'openssl'命令行工具用于在私有PKI中颁发证书的场景。

创建根CA证书和最终实体证书

首先，我们需要创建一个“自签名”根证书。为此，我们需要首先生成密钥。请注意，选择“1”作为序列号被视为真正证书的安全缺陷。安全选择是两位字节范围内的整数，理想情况下不是顺序但安全的随机数字，这里省略步骤以保持示例简洁。

root_key = OpenSSL::PKey::RSA.new 2048 # the CA's public/private key
root_ca = OpenSSL::X509::Certificate.new
root_ca.version = 2 # cf. RFC 5280 - to make it a "v3" certificate
root_ca.serial = 1
root_ca.subject = OpenSSL::X509::Name.parse "/DC=org/DC=ruby-lang/CN=Ruby CA"
root_ca.issuer = root_ca.subject # root CA's are "self-signed"
root_ca.public_key = root_key.public_key
root_ca.not_before = Time.now
root_ca.not_after = root_ca.not_before + 2 * 365 * 24 * 60 * 60 # 2 years validity
ef = OpenSSL::X509::ExtensionFactory.new
ef.subject_certificate = root_ca
ef.issuer_certificate = root_ca
root_ca.add_extension(ef.create_extension("basicConstraints","CA:TRUE",true))
root_ca.add_extension(ef.create_extension("keyUsage","keyCertSign, cRLSign", true))
root_ca.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false))
root_ca.add_extension(ef.create_extension("authorityKeyIdentifier","keyid:always",false))
root_ca.sign(root_key, OpenSSL::Digest::SHA256.new)

下一步是使用根CA证书创建最终实体证书。

key = OpenSSL::PKey::RSA.new 2048
cert = OpenSSL::X509::Certificate.new
cert.version = 2
cert.serial = 2
cert.subject = OpenSSL::X509::Name.parse "/DC=org/DC=ruby-lang/CN=Ruby certificate"
cert.issuer = root_ca.subject # root CA is the issuer
cert.public_key = key.public_key
cert.not_before = Time.now
cert.not_after = cert.not_before + 1 * 365 * 24 * 60 * 60 # 1 years validity
ef = OpenSSL::X509::ExtensionFactory.new
ef.subject_certificate = cert
ef.issuer_certificate = root_ca
cert.add_extension(ef.create_extension("keyUsage","digitalSignature", true))
cert.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false))
cert.sign(root_key, OpenSSL::Digest::SHA256.new)

公共类方法

new → cert 显示源

new(string) → cert

static VALUE
ossl_x509_initialize(int argc, VALUE *argv, VALUE self)
{
    BIO *in;
    X509 *x509, *x = DATA_PTR(self
    VALUE arg;

    if (rb_scan_args(argc, argv, "01", &arg) == 0) {
        /* create just empty X509Cert */
        return self;
    }
    arg = ossl_to_der_if_possible(arg
    in = ossl_obj2bio(arg
    x509 = PEM_read_bio_X509(in, &x, NULL, NULL
    DATA_PTR(self) = x;
    if (!x509) {
        OSSL_BIO_reset(in
        x509 = d2i_X509_bio(in, &x
        DATA_PTR(self) = x;
    }
    BIO_free(in
    if (!x509) ossl_raise(eX509CertError, NULL

    return self;
}

公共实例方法

add_extension(extension) → extension 显示源

static VALUE
ossl_x509_add_extension(VALUE self, VALUE extension)
{
    X509 *x509;
    X509_EXTENSION *ext;

    GetX509(self, x509
    ext = GetX509ExtPtr(extension
    if (!X509_add_ext(x509, ext, -1)) { /* DUPs ext - FREE it */
        ossl_raise(eX509CertError, NULL
    }

    return extension;
}

check_private_key(key) 显示源

检查“密钥”是否为此证书的PRIV密钥

static VALUE
ossl_x509_check_private_key(VALUE self, VALUE key)
{
    X509 *x509;
    EVP_PKEY *pkey;

    /* not needed private key, but should be */
    pkey = GetPrivPKeyPtr(key /* NO NEED TO DUP */
    GetX509(self, x509
    if (!X509_check_private_key(x509, pkey)) {
        ossl_clear_error(
        return Qfalse;
    }

    return Qtrue;
}

extensions → extension...()

static VALUE
ossl_x509_get_extensions(VALUE self)
{
    X509 *x509;
    int count, i;
    X509_EXTENSION *ext;
    VALUE ary;

    GetX509(self, x509
    count = X509_get_ext_count(x509
    if (count < 0) {
        return rb_ary_new(
    }
    ary = rb_ary_new2(count
    for (i=0; i<count; i++) {
        ext = X509_get_ext(x509, i /* NO DUP - don't free! */
        rb_ary_push(ary, ossl_x509ext_new(ext)
    }

    return ary;
}

extensions = ext... → ext...()

static VALUE
ossl_x509_set_extensions(VALUE self, VALUE ary)
{
    X509 *x509;
    X509_EXTENSION *ext;
    long i;

    Check_Type(ary, T_ARRAY
    /* All ary's members should be X509Extension */
    for (i=0; i<RARRAY_LEN(ary i++) {
        OSSL_Check_Kind(RARRAY_AREF(ary, i), cX509Ext
    }
    GetX509(self, x509
    while ((ext = X509_delete_ext(x509, 0)))
        X509_EXTENSION_free(ext
    for (i=0; i<RARRAY_LEN(ary i++) {
        ext = GetX509ExtPtr(RARRAY_AREF(ary, i)
        if (!X509_add_ext(x509, ext, -1)) { /* DUPs ext */
            ossl_raise(eX509CertError, NULL
        }
    }

    return ary;
}

inspect() 显示源

static VALUE
ossl_x509_inspect(VALUE self)
{
    return rb_sprintf("#<%"PRIsVALUE": subject=%+"PRIsVALUE", "
                      "issuer=%+"PRIsVALUE", serial=%+"PRIsVALUE", "
                      "not_before=%+"PRIsVALUE", not_after=%+"PRIsVALUE">",
                      rb_obj_class(self),
                      ossl_x509_get_subject(self),
                      ossl_x509_get_issuer(self),
                      ossl_x509_get_serial(self),
                      ossl_x509_get_not_before(self),
                      ossl_x509_get_not_after(self)
}

issuer → name 显示源

static VALUE
ossl_x509_get_issuer(VALUE self)
{
    X509 *x509;
    X509_NAME *name;

    GetX509(self, x509
    if(!(name = X509_get_issuer_name(x509))) { /* NO DUP - don't free! */
        ossl_raise(eX509CertError, NULL
    }

    return ossl_x509name_new(name
}

issuer = name → name 显示源

static VALUE
ossl_x509_set_issuer(VALUE self, VALUE issuer)
{
    X509 *x509;

    GetX509(self, x509
    if (!X509_set_issuer_name(x509, GetX509NamePtr(issuer))) { /* DUPs name */
        ossl_raise(eX509CertError, NULL
    }

    return issuer;
}

not_after → time 显示源

static VALUE
ossl_x509_get_not_after(VALUE self)
{
    X509 *x509;
    const ASN1_TIME *asn1time;

    GetX509(self, x509
    if (!(asn1time = X509_get0_notAfter(x509))) {
        ossl_raise(eX509CertError, NULL
    }

    return asn1time_to_time(asn1time
}

not_after = time → time 显示源

static VALUE
ossl_x509_set_not_after(VALUE self, VALUE time)
{
    X509 *x509;
    ASN1_TIME *asn1time;

    GetX509(self, x509
    asn1time = ossl_x509_time_adjust(NULL, time
    if (!X509_set_notAfter(x509, asn1time)) {
        ASN1_TIME_free(asn1time
        ossl_raise(eX509CertError, "X509_set_notAfter"
    }
    ASN1_TIME_free(asn1time

    return time;
}

not_before → time 显示源

static VALUE
ossl_x509_get_not_before(VALUE self)
{
    X509 *x509;
    const ASN1_TIME *asn1time;

    GetX509(self, x509
    if (!(asn1time = X509_get0_notBefore(x509))) {
        ossl_raise(eX509CertError, NULL
    }

    return asn1time_to_time(asn1time
}

not_before = time → time 显示源

static VALUE
ossl_x509_set_not_before(VALUE self, VALUE time)
{
    X509 *x509;
    ASN1_TIME *asn1time;

    GetX509(self, x509
    asn1time = ossl_x509_time_adjust(NULL, time
    if (!X509_set_notBefore(x509, asn1time)) {
        ASN1_TIME_free(asn1time
        ossl_raise(eX509CertError, "X509_set_notBefore"
    }
    ASN1_TIME_free(asn1time

    return time;
}

pretty_print(q) 显示源

# File ext/openssl/lib/openssl/x509.rb, line 163
def pretty_print(q)
  q.object_group(self) {
    q.breakable
    q.text 'subject='; q.pp self.subject; q.text ','; q.breakable
    q.text 'issuer='; q.pp self.issuer; q.text ','; q.breakable
    q.text 'serial='; q.pp self.serial; q.text ','; q.breakable
    q.text 'not_before='; q.pp self.not_before; q.text ','; q.breakable
    q.text 'not_after='; q.pp self.not_after
  }
end

public_key → key 显示源

static VALUE
ossl_x509_get_public_key(VALUE self)
{
    X509 *x509;
    EVP_PKEY *pkey;

    GetX509(self, x509
    if (!(pkey = X509_get_pubkey(x509))) { /* adds an reference */
        ossl_raise(eX509CertError, NULL
    }

    return ossl_pkey_new(pkey /* NO DUP - OK */
}

public_key = key → key 显示源

static VALUE
ossl_x509_set_public_key(VALUE self, VALUE key)
{
    X509 *x509;

    GetX509(self, x509
    if (!X509_set_pubkey(x509, GetPKeyPtr(key))) { /* DUPs pkey */
        ossl_raise(eX509CertError, NULL
    }

    return key;
}

serial → integer 显示源

static VALUE
ossl_x509_get_serial(VALUE self)
{
    X509 *x509;

    GetX509(self, x509

    return asn1integer_to_num(X509_get_serialNumber(x509)
}

serial = integer → integer 显示源

static VALUE
ossl_x509_set_serial(VALUE self, VALUE num)
{
    X509 *x509;

    GetX509(self, x509
    X509_set_serialNumber(x509, num_to_asn1integer(num, X509_get_serialNumber(x509))

    return num;
}

sign(key, digest) → self 显示源

static VALUE
ossl_x509_sign(VALUE self, VALUE key, VALUE digest)
{
    X509 *x509;
    EVP_PKEY *pkey;
    const EVP_MD *md;

    pkey = GetPrivPKeyPtr(key /* NO NEED TO DUP */
    md = GetDigestPtr(digest
    GetX509(self, x509
    if (!X509_sign(x509, pkey, md)) {
        ossl_raise(eX509CertError, NULL
    }

    return self;
}

signature_algorithm → string 显示源

static VALUE
ossl_x509_get_signature_algorithm(VALUE self)
{
    X509 *x509;
    BIO *out;
    VALUE str;

    GetX509(self, x509
    out = BIO_new(BIO_s_mem()
    if (!out) ossl_raise(eX509CertError, NULL

    if (!i2a_ASN1_OBJECT(out, X509_get0_tbs_sigalg(x509)->algorithm)) {
        BIO_free(out
        ossl_raise(eX509CertError, NULL
    }
    str = ossl_membio2str(out

    return str;
}

subject → name 显示源

static VALUE
ossl_x509_get_subject(VALUE self)
{
    X509 *x509;
    X509_NAME *name;

    GetX509(self, x509
    if (!(name = X509_get_subject_name(x509))) { /* NO DUP - don't free! */
        ossl_raise(eX509CertError, NULL
    }

    return ossl_x509name_new(name
}

subject = name → name 显示源

static VALUE
ossl_x509_set_subject(VALUE self, VALUE subject)
{
    X509 *x509;

    GetX509(self, x509
    if (!X509_set_subject_name(x509, GetX509NamePtr(subject))) { /* DUPs name */
        ossl_raise(eX509CertError, NULL
    }

    return subject;
}

to_der → string 显示源

static VALUE
ossl_x509_to_der(VALUE self)
{
    X509 *x509;
    VALUE str;
    long len;
    unsigned char *p;

    GetX509(self, x509
    if ((len = i2d_X509(x509, NULL)) <= 0)
        ossl_raise(eX509CertError, NULL
    str = rb_str_new(0, len
    p = (unsigned char *)RSTRING_PTR(str
    if (i2d_X509(x509, &p) <= 0)
        ossl_raise(eX509CertError, NULL
    ossl_str_adjust(str, p

    return str;
}

to_pem → string 显示源

static VALUE
ossl_x509_to_pem(VALUE self)
{
    X509 *x509;
    BIO *out;
    VALUE str;

    GetX509(self, x509
    out = BIO_new(BIO_s_mem()
    if (!out) ossl_raise(eX509CertError, NULL

    if (!PEM_write_bio_X509(out, x509)) {
        BIO_free(out
        ossl_raise(eX509CertError, NULL
    }
    str = ossl_membio2str(out

    return str;
}

另外别名为：to_s

to_s()

别名为：to_pem

to_text → string 显示源

static VALUE
ossl_x509_to_text(VALUE self)
{
    X509 *x509;
    BIO *out;
    VALUE str;

    GetX509(self, x509

    out = BIO_new(BIO_s_mem()
    if (!out) ossl_raise(eX509CertError, NULL

    if (!X509_print(out, x509)) {
        BIO_free(out
        ossl_raise(eX509CertError, NULL
    }
    str = ossl_membio2str(out

    return str;
}

verify(key) → true | false 显示源

检查证书签名是用PRIVversion这个PUBLIC'key'

static VALUE
ossl_x509_verify(VALUE self, VALUE key)
{
    X509 *x509;
    EVP_PKEY *pkey;

    pkey = GetPKeyPtr(key /* NO NEED TO DUP */
    GetX509(self, x509

    switch (X509_verify(x509, pkey)) {
      case 1:
        return Qtrue;
      case 0:
        ossl_clear_error(
        return Qfalse;
      default:
        ossl_raise(eX509CertError, NULL
    }
}

version → integer 显示源

static VALUE
ossl_x509_get_version(VALUE self)
{
    X509 *x509;

    GetX509(self, x509

    return LONG2NUM(X509_get_version(x509)
}

version = integer → integer 显示源

static VALUE
ossl_x509_set_version(VALUE self, VALUE version)
{
    X509 *x509;
    long ver;

    if ((ver = NUM2LONG(version)) < 0) {
        ossl_raise(eX509CertError, "version must be >= 0!"
    }
    GetX509(self, x509
    if (!X509_set_version(x509, ver)) {
        ossl_raise(eX509CertError, NULL
    }

    return version;
}