Class: OpenSSL::X509::Name

Inherits:

Object

• Object
• OpenSSL::X509::Name

Defined in:

lib/openssl/x509.rb,
ossl_x509name.c

Defined Under Namespace

Modules: RFC2253DN

Constant Summary

DEFAULT_OBJECT_TYPE =

utf8str

OBJECT_TYPE_TEMPLATE =

hash

COMPAT =

ULONG2NUM(XN_FLAG_COMPAT)

RFC2253 =

ULONG2NUM(XN_FLAG_RFC2253)

ONELINE =

ULONG2NUM(XN_FLAG_ONELINE)

MULTILINE =

ULONG2NUM(XN_FLAG_MULTILINE)

Class Method Summary

• .parse_openssl(str, template = OBJECT_TYPE_TEMPLATE) ⇒ Object (also: parse)
• .parse_rfc2253(str, template = OBJECT_TYPE_TEMPLATE) ⇒ Object

Instance Method Summary

• #add_entry(oid, value[, type]) ⇒ self
• #cmp(other) ⇒ Object (also: #<=>)
• #eql?(other) ⇒ Boolean
• #hash ⇒ Integer
• #initialize(*args) ⇒ Object constructor
• #to_a ⇒ Array
• #to_der ⇒ String
• #to_s(*args) ⇒ Object

Constructor Details

#X509::Name.new ⇒ Object #X509::Name.new(string) ⇒ Object #X509::Name.new(dn) ⇒ Object #X509::Name.new(dn, template) ⇒ Object

# File 'ossl_x509name.c', line 119

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{
	    unsigned char *p;
	    VALUE str = ossl_to_der_if_possible(arg);
	    StringValue(str);
	    p = RSTRING_PTR(str);
	    if(!d2i_X509_NAME((X509_NAME**)&DATA_PTR(self), &p, RSTRING_LEN(str))){
		ossl_raise(eX509NameError, NULL);
	    }
	}
    }

    return self;
}

Class Method Details

.parse_openssl(str, template = OBJECT_TYPE_TEMPLATE) ⇒ Object Also known as: parse

# File 'lib/openssl/x509.rb', line 145

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) ⇒ Object

# File 'lib/openssl/x509.rb', line 140

def parse_rfc2253(str, template=OBJECT_TYPE_TEMPLATE)
  ary = OpenSSL::X509::Name::RFC2253DN.scan(str)
  self.new(ary, template)
end

Instance Method Details

#add_entry(oid, value[, type]) ⇒ self

Returns:

• (self)

# File 'ossl_x509name.c', line 155

static
VALUE ossl_x509name_add_entry(int argc, VALUE *argv, VALUE self)
{
    X509_NAME *name;
    VALUE oid, value, type;

    rb_scan_args(argc, argv, "21", &oid, &value, &type);
    StringValue(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, RSTRING_PTR(oid), NUM2INT(type),
		RSTRING_PTR(value), RSTRING_LEN(value), -1, 0)) {
	ossl_raise(eX509NameError, NULL);
    }

    return self;
}

#cmp(other) ⇒ Object Also known as: <=>

# File 'ossl_x509name.c', line 266

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?(other) ⇒ Boolean

Returns:

• (Boolean)

# File 'ossl_x509name.c', line 278

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

    if(CLASS_OF(other) != cX509Name) return Qfalse;
    result = ossl_x509name_cmp0(self, other);

    return (result == 0) ? Qtrue : Qfalse;
}

#hash ⇒ Integer

Returns:

• (Integer)

# File 'ossl_x509name.c', line 293

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

    GetX509Name(self, name);

    hash = X509_NAME_hash(name);

    return ULONG2NUM(hash);
}

#to_a ⇒ Array

Returns:

• (Array)

# File 'ossl_x509name.c', line 222

static VALUE 
ossl_x509name_to_a(VALUE self)
{
    X509_NAME *name;
    X509_NAME_ENTRY *entry;
    int i,entries;
    char long_name[512];
    const char *short_name;
    VALUE ary, ret;
	
    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), entry->object)) {
	    ossl_raise(eX509NameError, NULL);
	}
	short_name = OBJ_nid2sn(OBJ_ln2nid(long_name));
	ary = rb_ary_new3(3, rb_str_new2(short_name),
        		  rb_str_new(entry->value->data, entry->value->length),
        		  INT2FIX(entry->value->type));
	rb_ary_push(ret, ary);
    }
    return ret;
}

#to_der ⇒ String

Returns:

• (String)

# File 'ossl_x509name.c', line 310

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 = 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(integer) ⇒ String

Overloads:

• #to_s ⇒ String

  Returns:

  • (String)
• #to_s(integer) ⇒ String

  Returns:

  • (String)

# File 'ossl_x509name.c', line 194

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