在线文档教程
Ruby 2.4
OpenSSL

OpenSSL::X509::Name

class OpenSSL::X509::Name

父类:ObjectIncluded modules:Comparable

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

您可以通过解析可分辨名称字符串或通过将可分辨名称作为数组提供来创建名称。

name = OpenSSL::X509::Name.parse 'CN=nobody/DC=example' 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(the)→name

X509::Name.new(distinguished_name) → name

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

创建一个新的名称。

名称可以由DER编码的字符串创建der,一个数组表示一个distinguished_namedistinguished_name一个template

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

有关distinguished_name数组内容的说明,请参阅#add_entry

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; }

parse(str, template=OBJECT_TYPE_TEMPLATE)

别名为:parse_openssl

parse_openssl(str,template = OBJECT_TYPE_TEMPLATE)显示源文件

# File ext/openssl/lib/openssl/x509.rb, line 140 def parse_openssl(str, template=OBJECT_TYPE_TEMPLATE) ary = str.scan(/\s*([^\/,]+)\s*/).collect{|i| i[0].split("=", 2) } self.new(ary, template) end

另外别名为:解析

parse_rfc2253(str,template = OBJECT_TYPE_TEMPLATE)显示源文件

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

公共实例方法

<=>(p1)

别名为:cmp

add_entry(oid,value,type)→自己显示源文件

添加具有给定名称oidvalue该名称的新条目。这oid是在ASN.1中定义的对象标识符。一些常见的OID是:

C

国家的名字

CN

通用名称

DC

域组件

O

机构名称

OU

组织单位名称

ST

州或省名称

static VALUE ossl_x509name_add_entry(int argc, VALUE *argv, VALUE self) { X509_NAME *name; VALUE oid, value, type; const char *oid_name; rb_scan_args(argc, argv, "21", &oid, &value, &type oid_name = StringValueCStr(oid StringValue(value if(NIL_P(type)) type = rb_aref(OBJECT_TYPE_TEMPLATE, oid GetX509Name(self, name if (!X509_NAME_add_entry_by_txt(name, oid_name, NUM2INT(type), (const unsigned char *)RSTRING_PTR(value), RSTRING_LENINT(value), -1, 0)) { ossl_raise(eX509NameError, NULL } return self; }

cmp其他→整数显示源码

<=> other → integer

与此相比较名称other,并返回0,如果它们是相同的和-1或+1,如果他们分别大于彼此更大或更小。

static VALUE ossl_x509name_cmp(VALUE self, VALUE other) { int result; result = ossl_x509name_cmp0(self, other if (result < 0) return INT2FIX(-1 if (result > 1) return INT2FIX(1 return INT2FIX(0 }

另外别名为:<=>

EQL?其他→布尔显示源

如果返回true name,并other指相同的哈希键。

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; }

散列→整数显示源文件

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

static VALUE ossl_x509name_hash(VALUE self) { X509_NAME *name; unsigned long hash; GetX509Name(self, name hash = X509_NAME_hash(name return ULONG2NUM(hash }

hash_old→整数显示源文件

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

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 }

pretty_print(q)显示源文件

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

to_a→[姓名,数据,类型],...()

返回适用于传递给:: new的专有名称的数组表示形式

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; }

to_der→字符串显示源

将名称转换为DER编码

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; }

to_s→string显示源文件

to_s(flags) → string

将此名称作为可分辨名称字符串返回。flags可能是以下之一:

  • OpenSSL::X509::Name::COMPAT

  • OpenSSL::X509::Name::RFC2253

  • OpenSSL::X509::Name::ONELINE

  • OpenSSL::X509::Name::MULTILINE

static VALUE ossl_x509name_to_s(int argc, VALUE *argv, VALUE self) { X509_NAME *name; VALUE flag, str; BIO *out; unsigned long iflag; rb_scan_args(argc, argv, "01", &flag if (NIL_P(flag)) return ossl_x509name_to_s_old(self else iflag = NUM2ULONG(flag if (!(out = BIO_new(BIO_s_mem()))) ossl_raise(eX509NameError, NULL GetX509Name(self, name if (!X509_NAME_print_ex(out, name, 0, iflag)){ BIO_free(out ossl_raise(eX509NameError, NULL } str = ossl_membio2str(out return str; }