class OpenSSL::X509::Name

X.509 名称表示与公钥关联的主机名、电子邮件地址或其他实体。

您可以通过解析可分辨名称 String 或通过将可分辨名称作为 Array 提供来创建 Name。

name = OpenSSL::X509::Name.parse_rfc2253 'DC=example,CN=nobody'

name = OpenSSL::X509::Name.new [['CN', 'nobody'], ['DC', 'example']]

常量

COMPAT

用于 to_s 的标志。

如果返回的名称超过 80 个字符，则将其分成多行。

DEFAULT_OBJECT_TYPE

名称条目的默认对象类型。

MULTILINE

用于 to_s 的标志。

返回多行格式。

OBJECT_TYPE_TEMPLATE

名称条目的默认对象类型模板。

ONELINE

用于 to_s 的标志。

返回比 RFC2253 更具可读性的格式。

RFC2253

用于 to_s 的标志。

返回 RFC2253 格式的名称。

公共类方法

X509::Name.new → name

X509::Name.new(der) → name

X509::Name.new(distinguished_name) → name

X509::Name.new(distinguished_name, template) → name

源代码

static VALUE
ossl_x509name_initialize(int argc, VALUE *argv, VALUE self)
{
    X509_NAME *name;
    VALUE arg, template;

    GetX509Name(self, name);
    if (rb_scan_args(argc, argv, "02", &arg, &template) == 0) {
        return self;
    }
    else {
        VALUE tmp = rb_check_array_type(arg);
        if (!NIL_P(tmp)) {
            VALUE args;
            if(NIL_P(template)) template = OBJECT_TYPE_TEMPLATE;
            args = rb_ary_new3(2, self, template);
            rb_block_call(tmp, rb_intern("each"), 0, 0, ossl_x509name_init_i, args);
        }
        else{
            const unsigned char *p;
            VALUE str = ossl_to_der_if_possible(arg);
            X509_NAME *x;
            StringValue(str);
            p = (unsigned char *)RSTRING_PTR(str);
            x = d2i_X509_NAME(&name, &p, RSTRING_LEN(str));
            DATA_PTR(self) = name;
            if(!x){
                ossl_raise(eX509NameError, NULL);
            }
        }
    }

    return self;
}

创建一个新的 Name。

可以从 DER 编码的字符串 der、表示 distinguished_name 的 Array 或 distinguished_name 以及 template 创建一个名称。

name = OpenSSL::X509::Name.new [['CN', 'nobody'], ['DC', 'example']]

name = OpenSSL::X509::Name.new name.to_der

有关 distinguished_name 数组内容的描述，请参阅 add_entry。

parse (str, template=OBJECT_TYPE_TEMPLATE)

别名为：parse_openssl

parse_openssl (str, template=OBJECT_TYPE_TEMPLATE)

源代码

# File ext/openssl/lib/openssl/x509.rb, line 305
def parse_openssl(str, template=OBJECT_TYPE_TEMPLATE)
  if str.start_with?("/")
    # /A=B/C=D format
    ary = str[1..-1].split("/").map { |i| i.split("=", 2) }
  else
    # Comma-separated
    ary = str.split(",").map { |i| i.strip.split("=", 2) }
  end
  self.new(ary, template)
end

解析可分辨名称的字符串表示形式。支持两种不同的形式

to_s 使用的 OpenSSL 格式（X509_NAME_oneline()）。例如：/DC=com/DC=example/CN=nobody
to_s(OpenSSL::X509::Name::COMPAT) 使用的 OpenSSL 格式（X509_NAME_print()）。例如：DC=com, DC=example, CN=nobody

它们都不是标准化的，并且在处理转义字符或多值 RDN 时存在怪癖和不一致之处。

不建议在新应用程序中使用此方法。有关替代方案，请参阅 Name.parse_rfc2253 和 to_utf8。

也别名为：parse

parse_rfc2253 (str, template=OBJECT_TYPE_TEMPLATE)

源代码

# File ext/openssl/lib/openssl/x509.rb, line 286
def parse_rfc2253(str, template=OBJECT_TYPE_TEMPLATE)
  ary = OpenSSL::X509::Name::RFC2253DN.scan(str)
  self.new(ary, template)
end

根据 RFC 2253，解析可分辨名称的 UTF-8 字符串表示形式。

另请参阅 to_utf8 以进行相反的操作。

公共实例方法

name <=> other → -1 | 0 | 1 | nil

将此 Name 与 other 进行比较，如果它们相同则返回 0，如果它们分别大于或小于彼此则返回 -1 或 +1。如果它们不可比较（即不同的类型），则返回 nil。

别名为：cmp

add_entry(oid, value [, type], loc: -1, set: 0) → self

源代码

static
VALUE ossl_x509name_add_entry(int argc, VALUE *argv, VALUE self)
{
    X509_NAME *name;
    VALUE oid, value, type, opts, kwargs[2];
    static ID kwargs_ids[2];
    const char *oid_name;
    int loc = -1, set = 0;

    if (!kwargs_ids[0]) {
        kwargs_ids[0] = rb_intern_const("loc");
        kwargs_ids[1] = rb_intern_const("set");
    }
    rb_scan_args(argc, argv, "21:", &oid, &value, &type, &opts);
    rb_get_kwargs(opts, kwargs_ids, 0, 2, kwargs);
    oid_name = StringValueCStr(oid);
    StringValue(value);
    if(NIL_P(type)) type = rb_aref(OBJECT_TYPE_TEMPLATE, oid);
    if (kwargs[0] != Qundef)
        loc = NUM2INT(kwargs[0]);
    if (kwargs[1] != Qundef)
        set = NUM2INT(kwargs[1]);
    GetX509Name(self, name);
    if (!X509_NAME_add_entry_by_txt(name, oid_name, NUM2INT(type),
                                    (unsigned char *)RSTRING_PTR(value),
                                    RSTRING_LENINT(value), loc, set))
        ossl_raise(eX509NameError, "X509_NAME_add_entry_by_txt");
    return self;
}

将具有给定 oid 和 value 的新条目添加到此名称。oid 是 ASN.1 中定义的对象标识符。一些常见的 OID 是

C: 国家 Name
CN: 通用 Name
DC: 域组件
O: 组织 Name
OU: 组织单位 Name
ST: 州或省 Name

可选的关键字参数 loc 和 set 指定将新属性插入的位置。有关详细信息，请参阅 X509_NAME_add_entry(3) 的手册页。loc 默认为 -1，set 默认为 0。这将单个值的 RDN 追加到末尾。

cmp(other) → -1 | 0 | 1 | nil

源代码

static VALUE
ossl_x509name_cmp(VALUE self, VALUE other)
{
    int result;

    if (!rb_obj_is_kind_of(other, cX509Name))
        return Qnil;

    result = ossl_x509name_cmp0(self, other);
    if (result < 0) return INT2FIX(-1);
    if (result > 0) return INT2FIX(1);

    return INT2FIX(0);
}

也别名为：<=>

eql?(other) → true | false

源代码

static VALUE
ossl_x509name_eql(VALUE self, VALUE other)
{
    if (!rb_obj_is_kind_of(other, cX509Name))
        return Qfalse;

    return ossl_x509name_cmp0(self, other) == 0 ? Qtrue : Qfalse;
}

如果 name 和 other 指的是相同的哈希键，则返回 true。

hash → integer

源代码

static VALUE
ossl_x509name_hash(VALUE self)
{
    X509_NAME *name;
    unsigned long hash;

    GetX509Name(self, name);

    hash = X509_NAME_hash(name);

    return ULONG2NUM(hash);
}

返回的哈希值适合用作 CA 路径中证书的文件名。

hash_old → integer

源代码

static VALUE
ossl_x509name_hash_old(VALUE self)
{
    X509_NAME *name;
    unsigned long hash;

    GetX509Name(self, name);

    hash = X509_NAME_hash_old(name);

    return ULONG2NUM(hash);
}

返回 OpenSSL 0.9.X 中使用的基于 MD5 的哈希。

initialize_copy (p1)

源代码

static VALUE
ossl_x509name_initialize_copy(VALUE self, VALUE other)
{
    X509_NAME *name, *name_other, *name_new;

    rb_check_frozen(self);
    GetX509Name(self, name);
    GetX509Name(other, name_other);

    name_new = X509_NAME_dup(name_other);
    if (!name_new)
        ossl_raise(eX509NameError, "X509_NAME_dup");

    SetX509Name(self, name_new);
    X509_NAME_free(name);

    return self;
}

pretty_print (q)

源代码

# File ext/openssl/lib/openssl/x509.rb, line 319
def pretty_print(q)
  q.object_group(self) {
    q.text ' '
    q.text to_s(OpenSSL::X509::Name::RFC2253)
  }
end

to_a → [[name, data, type], ...]

源代码

static VALUE
ossl_x509name_to_a(VALUE self)
{
    X509_NAME *name;
    X509_NAME_ENTRY *entry;
    int i,entries,nid;
    char long_name[512];
    const char *short_name;
    VALUE ary, vname, ret;
    ASN1_STRING *value;

    GetX509Name(self, name);
    entries = X509_NAME_entry_count(name);
    if (entries < 0) {
        OSSL_Debug("name entries < 0!");
        return rb_ary_new();
    }
    ret = rb_ary_new2(entries);
    for (i=0; i<entries; i++) {
        if (!(entry = X509_NAME_get_entry(name, i))) {
            ossl_raise(eX509NameError, NULL);
        }
        if (!i2t_ASN1_OBJECT(long_name, sizeof(long_name),
                             X509_NAME_ENTRY_get_object(entry))) {
            ossl_raise(eX509NameError, NULL);
        }
        nid = OBJ_ln2nid(long_name);
        if (nid == NID_undef) {
            vname = rb_str_new2((const char *) &long_name);
        } else {
            short_name = OBJ_nid2sn(nid);
            vname = rb_str_new2(short_name); /*do not free*/
        }
        value = X509_NAME_ENTRY_get_data(entry);
        ary = rb_ary_new3(3, vname, asn1str_to_str(value), INT2NUM(value->type));
        rb_ary_push(ret, ary);
    }
    return ret;
}

返回可传递给 ::new 的可分辨名称的 Array 表示形式。

to_der → string

源代码

static VALUE
ossl_x509name_to_der(VALUE self)
{
    X509_NAME *name;
    VALUE str;
    long len;
    unsigned char *p;

    GetX509Name(self, name);
    if((len = i2d_X509_NAME(name, NULL)) <= 0)
        ossl_raise(eX509NameError, NULL);
    str = rb_str_new(0, len);
    p = (unsigned char *)RSTRING_PTR(str);
    if(i2d_X509_NAME(name, &p) <= 0)
        ossl_raise(eX509NameError, NULL);
    ossl_str_adjust(str, p);

    return str;
}

将名称转换为 DER 编码

to_s → string

to_s(format) → string

源代码

static VALUE
ossl_x509name_to_s(int argc, VALUE *argv, VALUE self)
{
    rb_check_arity(argc, 0, 1);
    /* name.to_s(nil) was allowed */
    if (!argc || NIL_P(argv[0]))
        return ossl_x509name_to_s_old(self);
    else
        return x509name_print(self, NUM2ULONG(argv[0]));
}

返回可分辨 Name 的 String 表示形式。format 是以下之一

如果省略 format，则选择大部分已损坏的传统 OpenSSL 格式（X509_NAME_oneline() 格式）。

不建议使用此方法。 除了 OpenSSL::X509::Name::RFC2253 之外的所有格式都不是标准化的，并且可能在 OpenSSL 版本中显示不一致的行为。

建议改用 to_utf8，它等效于调用 name.to_s(OpenSSL::X509::Name::RFC2253).force_encoding("UTF-8")。

to_utf8 → string

源代码

static VALUE
ossl_x509name_to_utf8(VALUE self)
{
    VALUE str = x509name_print(self, XN_FLAG_RFC2253 & ~ASN1_STRFLGS_ESC_MSB);
    rb_enc_associate_index(str, rb_utf8_encindex());
    return str;
}

返回可分辨名称的 UTF-8 表示形式，如 RFC 2253 中指定的那样。