Class: OpenSSL::ASN1::Primitive
- Defined in:
- ext/openssl/ossl_asn1.c,
ext/openssl/ossl_asn1.c
Overview
The parent class for all primitive encodings. Attributes are the same as for ASN1Data, with the addition of tagging
. Primitive values can never be infinite length encodings, thus it is not possible to set the infinite_length
attribute for Primitive and its sub-classes.
Primitive sub-classes and their mapping to Ruby classes
-
OpenSSL::ASN1::EndOfContent <=>
value
is alwaysnil
-
OpenSSL::ASN1::Boolean <=>
value
is aBoolean
-
OpenSSL::ASN1::Integer <=>
value
is an OpenSSL::BN -
OpenSSL::ASN1::BitString <=>
value
is aString
-
OpenSSL::ASN1::OctetString <=>
value
is aString
-
OpenSSL::ASN1::Null <=>
value
is alwaysnil
-
OpenSSL::ASN1::Object <=>
value
is aString
-
OpenSSL::ASN1::Enumerated <=>
value
is an OpenSSL::BN -
OpenSSL::ASN1::UTF8String <=>
value
is aString
-
OpenSSL::ASN1::NumericString <=>
value
is aString
-
OpenSSL::ASN1::PrintableString <=>
value
is aString
-
OpenSSL::ASN1::T61String <=>
value
is aString
-
OpenSSL::ASN1::VideotexString <=>
value
is aString
-
OpenSSL::ASN1::IA5String <=>
value
is aString
-
OpenSSL::ASN1::UTCTime <=>
value
is aTime
-
OpenSSL::ASN1::GeneralizedTime <=>
value
is aTime
-
OpenSSL::ASN1::GraphicString <=>
value
is aString
-
OpenSSL::ASN1::ISO64String <=>
value
is aString
-
OpenSSL::ASN1::GeneralString <=>
value
is aString
-
OpenSSL::ASN1::UniversalString <=>
value
is aString
-
OpenSSL::ASN1::BMPString <=>
value
is aString
OpenSSL::ASN1::BitString
Additional attributes
unused_bits
: if the underlying BIT STRING’s length is a multiple of 8 then unused_bits
is 0. Otherwise unused_bits
indicates the number of bits that are to be ignored in the final octet of the BitString
‘s value
.
OpenSSL::ASN1::ObjectId
NOTE: While OpenSSL::ASN1::ObjectId.new will allocate a new ObjectId, it is not typically allocated this way, but rather that are received from parsed ASN1 encodings.
Additional attributes
-
sn
: the short name as defined in <openssl/objects.h>. -
ln
: the long name as defined in <openssl/objects.h>. -
oid
: the object identifier as aString
, e.g. “1.2.3.4.5” -
short_name
: alias forsn
. -
long_name
: alias forln
.
Examples
With the Exception of OpenSSL::ASN1::EndOfContent, each Primitive class constructor takes at least one parameter, the value
.
Creating EndOfContent
eoc = OpenSSL::ASN1::EndOfContent.new
Creating any other Primitive
prim = <class>.new(value) # <class> being one of the sub-classes except EndOfContent
prim_zero_tagged_implicit = <class>.new(value, 0, :IMPLICIT)
prim_zero_tagged_explicit = <class>.new(value, 0, :EXPLICIT)
Direct Known Subclasses
Instance Method Summary collapse
-
#OpenSSL::ASN1::Primitive.new(value[, tag, tagging, tag_class ]) ⇒ Primitive
constructor
value
: is mandatory. -
#to_der ⇒ DER-encoded String
See ASN1Data#to_der for details.
Constructor Details
#OpenSSL::ASN1::Primitive.new(value[, tag, tagging, tag_class ]) ⇒ Primitive
value
: is mandatory.
tag
: optional, may be specified for tagged values. If no tag
is specified, the UNIVERSAL tag corresponding to the Primitive sub-class is used by default.
tagging
: may be used as an encoding hint to encode a value either explicitly or implicitly, see ASN1 for possible values.
tag_class
: if tag
and tagging
are nil
then this is set to :UNIVERSAL
by default. If either tag
or tagging
are set then :CONTEXT_SPECIFIC
is used as the default. For possible values please cf. ASN1.
Example
int = OpenSSL::ASN1::Integer.new(42)
zero_tagged_int = OpenSSL::ASN1::Integer.new(42, 0, :IMPLICIT)
private_explicit_zero_tagged_int = OpenSSL::ASN1::Integer.new(42, 0, :EXPLICIT, :PRIVATE)
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 |
# File 'ext/openssl/ossl_asn1.c', line 1095
static VALUE
ossl_asn1_initialize(int argc, VALUE *argv, VALUE self)
{
VALUE value, tag, tagging, tag_class;
rb_scan_args(argc, argv, "13", &value, &tag, &tagging, &tag_class);
if(argc > 1){
if(NIL_P(tag))
ossl_raise(eASN1Error, "must specify tag number");
if(!NIL_P(tagging) && !SYMBOL_P(tagging))
ossl_raise(eASN1Error, "invalid tagging method");
if(NIL_P(tag_class)) {
if (NIL_P(tagging))
tag_class = sym_UNIVERSAL;
else
tag_class = sym_CONTEXT_SPECIFIC;
}
if(!SYMBOL_P(tag_class))
ossl_raise(eASN1Error, "invalid tag class");
if (tagging == sym_IMPLICIT && NUM2INT(tag) > 31)
ossl_raise(eASN1Error, "tag number for Universal too large");
}
else{
tag = INT2NUM(ossl_asn1_default_tag(self));
tagging = Qnil;
tag_class = sym_UNIVERSAL;
}
ossl_asn1_set_tag(self, tag);
ossl_asn1_set_value(self, value);
ossl_asn1_set_tagging(self, tagging);
ossl_asn1_set_tag_class(self, tag_class);
ossl_asn1_set_infinite_length(self, Qfalse);
return self;
}
|
Instance Method Details
#to_der ⇒ DER-encoded String
See ASN1Data#to_der for details. *
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 |
# File 'ext/openssl/ossl_asn1.c', line 1152
static VALUE
ossl_asn1prim_to_der(VALUE self)
{
ASN1_TYPE *asn1;
int tn, tc, explicit;
long len, reallen;
unsigned char *buf, *p;
VALUE str;
tn = NUM2INT(ossl_asn1_get_tag(self));
tc = ossl_asn1_tag_class(self);
explicit = ossl_asn1_is_explicit(self);
asn1 = ossl_asn1_get_asn1type(self);
len = ASN1_object_size(1, i2d_ASN1_TYPE(asn1, NULL), tn);
if(!(buf = OPENSSL_malloc(len))){
ASN1_TYPE_free(asn1);
ossl_raise(eASN1Error, "cannot alloc buffer");
}
p = buf;
if (tc == V_ASN1_UNIVERSAL) {
i2d_ASN1_TYPE(asn1, &p);
} else if (explicit) {
ASN1_put_object(&p, 1, i2d_ASN1_TYPE(asn1, NULL), tn, tc);
i2d_ASN1_TYPE(asn1, &p);
} else {
i2d_ASN1_TYPE(asn1, &p);
*buf = tc | tn | (*buf & V_ASN1_CONSTRUCTED);
}
ASN1_TYPE_free(asn1);
reallen = p - buf;
assert(reallen <= len);
str = ossl_buf2str((char *)buf, rb_long2int(reallen)); /* buf will be free in ossl_buf2str */
return str;
}
|