class OpenSSL::X509::Name

Родительский класс:: Object
Подключённые модули:: OpenSSL::Marshal, Comparable

Имя X.509 представляет имя хоста, адрес электронной почты или другую сущность, связанную с открытым ключом.

Можно создать Name, разобрав отличительное имя String или передав отличительное имя в виде Array.

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, из Array, представляющего distinguished_name, или из 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

Разбирает строковое представление отличительного имени. Поддерживаются два разных формата:

Формат OpenSSL (X509_NAME_oneline()), используемый методом to_s. Например: /DC=com/DC=example/CN=nobody
Формат OpenSSL (X509_NAME_print()), используемый методом #to_s(OpenSSL::X509::Name::COMPAT). Например: 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

Разбирает строковое представление отличительного имени в кодировке UTF-8 согласно RFC 2253.

Обратную операцию выполняет to_utf8.

Сравнивает этот объект 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;
}

Возвращает true, если name и other ссылаются на один и тот же ключ хеша.

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

Возвращает хеш на основе MD5, использовавшийся в OpenSSL версии 0.9.X.

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;
    int entries;
    VALUE ret;

    GetX509Name(self, name);
    entries = X509_NAME_entry_count(name);
    ret = rb_ary_new_capa(entries);
    for (int i = 0; i < entries; i++) {
        const X509_NAME_ENTRY *entry = X509_NAME_get_entry(name, i);
        if (!entry)
            ossl_raise(eX509NameError, "X509_NAME_get_entry");
        const ASN1_OBJECT *obj = X509_NAME_ENTRY_get_object(entry);
        VALUE vname = ossl_asn1obj_to_string(obj);
        const ASN1_STRING *data = X509_NAME_ENTRY_get_data(entry);
        VALUE vdata = asn1str_to_str(data);
        VALUE type = INT2NUM(ASN1_STRING_type(data));
        rb_ary_push(ret, rb_ary_new_from_args(3, vname, vdata, type));
    }
    return ret;
}

Возвращает представление отличительного имени в виде Array, подходящее для передачи в ::new

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.

Ruby Core © 1993–2025 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.