In Files

  • openssl/ossl_asn1.c

Class/Module Index [+]

Quicksearch

OpenSSL::ASN1::ObjectId

Document-class: OpenSSL::ASN1::Constructive

The parent class for all constructed encodings. The +value+ attribute
of a Constructive is always an +Array+. Attributes are the same as
for ASN1Data, with the addition of +tagging+.

== SET and SEQUENCE

Most constructed encodings come in the form of a SET or a SEQUENCE.
These encodings are represented by one of the two sub-classes of
Constructive:
* OpenSSL::ASN1::Set
* OpenSSL::ASN1::Sequence
Please note that tagged sequences and sets are still parsed as
instances of ASN1Data. Find further details on tagged values
there.

=== Example - constructing a SEQUENCE
  int = OpenSSL::ASN1::Integer.new(1)
  str = OpenSSL::ASN1::PrintableString.new('abc')
  sequence = OpenSSL::ASN1::Sequence.new( [ int, str ] )

=== Example - constructing a SET
  int = OpenSSL::ASN1::Integer.new(1)
  str = OpenSSL::ASN1::PrintableString.new('abc')
  set = OpenSSL::ASN1::Set.new( [ int, str ] )

== Infinite length primitive values

The only case where Constructive is used directly is for infinite
length encodings of primitive values. These encodings are always
constructed, with the contents of the +value+ +Array+ being either
UNIVERSAL non-infinite length partial encodings of the actual value
or again constructive encodings with infinite length (i.e. infinite
length primitive encodings may be constructed recursively with another
infinite length value within an already infinite length value). Each
partial encoding must be of the same UNIVERSAL type as the overall
encoding. The value of the overall encoding consists of the
concatenation of each partial encoding taken in sequence. The +value+
array of the outer infinite length value must end with a
OpenSSL::ASN1::EndOfContent instance.

Please note that it is not possible to encode Constructive without
the +infinite_length+ attribute being set to +true+, use
OpenSSL::ASN1::Sequence or OpenSSL::ASN1::Set in these cases instead.

=== Example - Infinite length OCTET STRING
  partial1 = OpenSSL::ASN1::OctetString.new("\x01")
  partial2 = OpenSSL::ASN1::OctetString.new("\x02")
  inf_octets = OpenSSL::ASN1::Constructive.new( [ partial1,
                                                  partial2,
                                                  OpenSSL::ASN1::EndOfContent.new ],
                                                OpenSSL::ASN1::OCTET_STRING,
                                                nil,
                                                :UNIVERSAL )
  # The real value of inf_octets is "\x01\x02", i.e. the concatenation
  # of partial1 and partial2
  inf_octets.infinite_length = true
  der = inf_octets.to_der
  asn1 = OpenSSL::ASN1.decode(der)
  puts asn1.infinite_length # => true

Public Class Methods

register(p1, p2, p3) click to toggle source
 
               static VALUE
ossl_asn1obj_s_register(VALUE self, VALUE oid, VALUE sn, VALUE ln)
{
    StringValue(oid);
    StringValue(sn);
    StringValue(ln);

    if(!OBJ_create(RSTRING_PTR(oid), RSTRING_PTR(sn), RSTRING_PTR(ln)))
        ossl_raise(eASN1Error, NULL);

    return Qtrue;
}
            

Public Instance Methods

ln() click to toggle source
 
               static VALUE
ossl_asn1obj_get_ln(VALUE self)
{
    VALUE val, ret = Qnil;
    int nid;

    val = ossl_asn1_get_value(self);
    if ((nid = OBJ_txt2nid(StringValuePtr(val))) != NID_undef)
        ret = rb_str_new2(OBJ_nid2ln(nid));

    return ret;
}
            
Also aliased as: long_name
long_name() click to toggle source
Alias for: ln
oid() click to toggle source
 
               static VALUE
ossl_asn1obj_get_oid(VALUE self)
{
    VALUE val;
    ASN1_OBJECT *a1obj;
    char buf[128];

    val = ossl_asn1_get_value(self);
    a1obj = obj_to_asn1obj(val);
    OBJ_obj2txt(buf, sizeof(buf), a1obj, 1);
    ASN1_OBJECT_free(a1obj);

    return rb_str_new2(buf);
}
            
short_name() click to toggle source
Alias for: sn
sn() click to toggle source
 
               static VALUE
ossl_asn1obj_get_sn(VALUE self)
{
    VALUE val, ret = Qnil;
    int nid;

    val = ossl_asn1_get_value(self);
    if ((nid = OBJ_txt2nid(StringValuePtr(val))) != NID_undef)
        ret = rb_str_new2(OBJ_nid2sn(nid));

    return ret;
}
            
Also aliased as: short_name

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus