1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class OpenSSL::ASN1::ASN1Data - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div class="nav-section">
<h3>Table of Contents</h3>
<ul class="link-list" role="directory">
<li><a href="#class-OpenSSL::ASN1::ASN1Data-label-The+role+of+ASN1Data+for+parsing+tagged+values">The role of ASN1Data for parsing tagged values</a>
<li><a href="#class-OpenSSL::ASN1::ASN1Data-label-Example+of+a+parsed+implicitly+tagged+value">Example of a parsed implicitly tagged value</a>
<li><a href="#class-OpenSSL::ASN1::ASN1Data-label-Example+of+a+parsed+explicitly+tagged+value">Example of a parsed explicitly tagged value</a>
<li><a href="#class-OpenSSL::ASN1::ASN1Data-label-Example+-+Decoding+an+implicitly+tagged+INTEGER">Example - Decoding an implicitly tagged INTEGER</a>
<li><a href="#class-OpenSSL::ASN1::ASN1Data-label-Example+-+Decoding+an+explicitly+tagged+INTEGER">Example - Decoding an explicitly tagged INTEGER</a>
</ul>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Object
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-to_der">#to_der</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-OpenSSL::ASN1::ASN1Data">
<h1 id="class-OpenSSL::ASN1::ASN1Data" class="class">
class OpenSSL::ASN1::ASN1Data
</h1>
<section class="description">
<p>The top-level class representing any ASN.1 object. When parsed by <a href="../ASN1.html#method-c-decode"><code>ASN1.decode</code></a>, tagged values are always represented by an instance of <a href="ASN1Data.html"><code>ASN1Data</code></a>.</p>
<h2 id="class-OpenSSL::ASN1::ASN1Data-label-The+role+of+ASN1Data+for+parsing+tagged+values">The role of <a href="ASN1Data.html"><code>ASN1Data</code></a> for parsing tagged values<span><a href="#class-OpenSSL::ASN1::ASN1Data-label-The+role+of+ASN1Data+for+parsing+tagged+values">¶</a> <a href="#top">↑</a></span></h2>
<p>When encoding an ASN.1 type it is inherently clear what original type (e.g. INTEGER, OCTET STRING etc.) this value has, regardless of its tagging. But opposed to the time an ASN.1 type is to be encoded, when parsing them it is not possible to deduce the “real type” of tagged values. This is why tagged values are generally parsed into <a href="ASN1Data.html"><code>ASN1Data</code></a> instances, but with a different outcome for implicit and explicit tagging.</p>
<h3 id="class-OpenSSL::ASN1::ASN1Data-label-Example+of+a+parsed+implicitly+tagged+value">Example of a parsed implicitly tagged value<span><a href="#class-OpenSSL::ASN1::ASN1Data-label-Example+of+a+parsed+implicitly+tagged+value">¶</a> <a href="#top">↑</a></span></h3>
<p>An implicitly 1-tagged INTEGER value will be parsed as an <a href="ASN1Data.html"><code>ASN1Data</code></a> with</p>
<ul><li>
<p><em>tag</em> equal to 1</p>
</li><li>
<p><em>tag_class</em> equal to <code>:CONTEXT_SPECIFIC</code></p>
</li><li>
<p><em>value</em> equal to a String that carries the raw encoding of the INTEGER.</p>
</li></ul>
<p>This implies that a subsequent decoding step is required to completely decode implicitly tagged values.</p>
<h3 id="class-OpenSSL::ASN1::ASN1Data-label-Example+of+a+parsed+explicitly+tagged+value">Example of a parsed explicitly tagged value<span><a href="#class-OpenSSL::ASN1::ASN1Data-label-Example+of+a+parsed+explicitly+tagged+value">¶</a> <a href="#top">↑</a></span></h3>
<p>An explicitly 1-tagged INTEGER value will be parsed as an <a href="ASN1Data.html"><code>ASN1Data</code></a> with</p>
<ul><li>
<p><em>tag</em> equal to 1</p>
</li><li>
<p><em>tag_class</em> equal to <code>:CONTEXT_SPECIFIC</code></p>
</li><li>
<p><em>value</em> equal to an Array with one single element, an instance of OpenSSL::ASN1::Integer, i.e. the inner element is the non-tagged primitive value, and the tagging is represented in the outer <a href="ASN1Data.html"><code>ASN1Data</code></a></p>
</li></ul>
<h2 id="class-OpenSSL::ASN1::ASN1Data-label-Example+-+Decoding+an+implicitly+tagged+INTEGER">Example - Decoding an implicitly tagged INTEGER<span><a href="#class-OpenSSL::ASN1::ASN1Data-label-Example+-+Decoding+an+implicitly+tagged+INTEGER">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">int</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span><span class="ruby-operator">::</span><span class="ruby-constant">Integer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">1</span>, <span class="ruby-value">0</span>, <span class="ruby-value">:IMPLICIT</span>) <span class="ruby-comment"># implicit 0-tagged</span>
<span class="ruby-identifier">seq</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span><span class="ruby-operator">::</span><span class="ruby-constant">Sequence</span>.<span class="ruby-identifier">new</span>( [<span class="ruby-identifier">int</span>] )
<span class="ruby-identifier">der</span> = <span class="ruby-identifier">seq</span>.<span class="ruby-identifier">to_der</span>
<span class="ruby-identifier">asn1</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span>.<span class="ruby-identifier">decode</span>(<span class="ruby-identifier">der</span>)
<span class="ruby-comment"># pp asn1 => #<OpenSSL::ASN1::Sequence:0x87326e0</span>
<span class="ruby-comment"># @indefinite_length=false,</span>
<span class="ruby-comment"># @tag=16,</span>
<span class="ruby-comment"># @tag_class=:UNIVERSAL,</span>
<span class="ruby-comment"># @tagging=nil,</span>
<span class="ruby-comment"># @value=</span>
<span class="ruby-comment"># [#<OpenSSL::ASN1::ASN1Data:0x87326f4</span>
<span class="ruby-comment"># @indefinite_length=false,</span>
<span class="ruby-comment"># @tag=0,</span>
<span class="ruby-comment"># @tag_class=:CONTEXT_SPECIFIC,</span>
<span class="ruby-comment"># @value="\x01">]></span>
<span class="ruby-identifier">raw_int</span> = <span class="ruby-identifier">asn1</span>.<span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>]
<span class="ruby-comment"># manually rewrite tag and tag class to make it an UNIVERSAL value</span>
<span class="ruby-identifier">raw_int</span>.<span class="ruby-identifier">tag</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span><span class="ruby-operator">::</span><span class="ruby-constant">INTEGER</span>
<span class="ruby-identifier">raw_int</span>.<span class="ruby-identifier">tag_class</span> = <span class="ruby-value">:UNIVERSAL</span>
<span class="ruby-identifier">int2</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span>.<span class="ruby-identifier">decode</span>(<span class="ruby-identifier">raw_int</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">int2</span>.<span class="ruby-identifier">value</span> <span class="ruby-comment"># => 1</span>
</pre>
<h2 id="class-OpenSSL::ASN1::ASN1Data-label-Example+-+Decoding+an+explicitly+tagged+INTEGER">Example - Decoding an explicitly tagged INTEGER<span><a href="#class-OpenSSL::ASN1::ASN1Data-label-Example+-+Decoding+an+explicitly+tagged+INTEGER">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">int</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span><span class="ruby-operator">::</span><span class="ruby-constant">Integer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">1</span>, <span class="ruby-value">0</span>, <span class="ruby-value">:EXPLICIT</span>) <span class="ruby-comment"># explicit 0-tagged</span>
<span class="ruby-identifier">seq</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span><span class="ruby-operator">::</span><span class="ruby-constant">Sequence</span>.<span class="ruby-identifier">new</span>( [<span class="ruby-identifier">int</span>] )
<span class="ruby-identifier">der</span> = <span class="ruby-identifier">seq</span>.<span class="ruby-identifier">to_der</span>
<span class="ruby-identifier">asn1</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span>.<span class="ruby-identifier">decode</span>(<span class="ruby-identifier">der</span>)
<span class="ruby-comment"># pp asn1 => #<OpenSSL::ASN1::Sequence:0x87326e0</span>
<span class="ruby-comment"># @indefinite_length=false,</span>
<span class="ruby-comment"># @tag=16,</span>
<span class="ruby-comment"># @tag_class=:UNIVERSAL,</span>
<span class="ruby-comment"># @tagging=nil,</span>
<span class="ruby-comment"># @value=</span>
<span class="ruby-comment"># [#<OpenSSL::ASN1::ASN1Data:0x87326f4</span>
<span class="ruby-comment"># @indefinite_length=false,</span>
<span class="ruby-comment"># @tag=0,</span>
<span class="ruby-comment"># @tag_class=:CONTEXT_SPECIFIC,</span>
<span class="ruby-comment"># @value=</span>
<span class="ruby-comment"># [#<OpenSSL::ASN1::Integer:0x85bf308</span>
<span class="ruby-comment"># @indefinite_length=false,</span>
<span class="ruby-comment"># @tag=2,</span>
<span class="ruby-comment"># @tag_class=:UNIVERSAL</span>
<span class="ruby-comment"># @tagging=nil,</span>
<span class="ruby-comment"># @value=1>]>]></span>
<span class="ruby-identifier">int2</span> = <span class="ruby-identifier">asn1</span>.<span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>]
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">int2</span>.<span class="ruby-identifier">value</span> <span class="ruby-comment"># => 1</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-indefinite_length" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">indefinite_length</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Never <code>nil</code>. A boolean value indicating whether the encoding uses indefinite length (in the case of parsing) or whether an indefinite length form shall be used (in the encoding case). In DER, every value uses definite length form. But in scenarios where large amounts of data need to be transferred it might be desirable to have some kind of streaming support available. For example, huge OCTET STRINGs are preferably sent in smaller-sized chunks, each at a time. This is possible in BER by setting the length bytes of an encoding to zero and by this indicating that the following value will be sent in chunks. Indefinite length encodings are always constructed. The end of such a stream of chunks is indicated by sending a EOC (End of Content) tag. SETs and SEQUENCEs may use an indefinite length encoding, but also primitive types such as e.g. OCTET STRINGS or BIT STRINGS may leverage this functionality (cf. ITU-T X.690).</p>
</div>
</div>
<div id="attribute-i-infinite_length" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">infinite_length</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Never <code>nil</code>. A boolean value indicating whether the encoding uses indefinite length (in the case of parsing) or whether an indefinite length form shall be used (in the encoding case). In DER, every value uses definite length form. But in scenarios where large amounts of data need to be transferred it might be desirable to have some kind of streaming support available. For example, huge OCTET STRINGs are preferably sent in smaller-sized chunks, each at a time. This is possible in BER by setting the length bytes of an encoding to zero and by this indicating that the following value will be sent in chunks. Indefinite length encodings are always constructed. The end of such a stream of chunks is indicated by sending a EOC (End of Content) tag. SETs and SEQUENCEs may use an indefinite length encoding, but also primitive types such as e.g. OCTET STRINGS or BIT STRINGS may leverage this functionality (cf. ITU-T X.690).</p>
</div>
</div>
<div id="attribute-i-tag" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">tag</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>An <a href="../../Integer.html"><code>Integer</code></a> representing the tag number of this <a href="ASN1Data.html"><code>ASN1Data</code></a>. Never <code>nil</code>.</p>
</div>
</div>
<div id="attribute-i-tag_class" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">tag_class</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>A Symbol representing the tag class of this <a href="ASN1Data.html"><code>ASN1Data</code></a>. Never <code>nil</code>. See <a href="ASN1Data.html"><code>ASN1Data</code></a> for possible values.</p>
</div>
</div>
<div id="attribute-i-value" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">value</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Carries the value of a ASN.1 type. Please confer <a href="Constructive.html"><code>Constructive</code></a> and <a href="Primitive.html"><code>Primitive</code></a> for the mappings between ASN.1 data types and Ruby classes.</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
OpenSSL::ASN1::ASN1Data.new(value, tag, tag_class) → ASN1Data
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><em>value</em>: Please have a look at <a href="Constructive.html"><code>Constructive</code></a> and <a href="Primitive.html"><code>Primitive</code></a> to see how Ruby types are mapped to ASN.1 types and vice versa.</p>
<p><em>tag</em>: An <a href="../../Integer.html"><code>Integer</code></a> indicating the tag number.</p>
<p><em>tag_class</em>: A Symbol indicating the tag class. Please cf. <a href="../ASN1.html"><code>ASN1</code></a> for possible values.</p>
<h2 id="method-c-new-label-Example">Example<span><a href="#method-c-new-label-Example">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">asn1_int</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1Data</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">42</span>, <span class="ruby-value">2</span>, <span class="ruby-value">:UNIVERSAL</span>) <span class="ruby-comment"># => Same as OpenSSL::ASN1::Integer.new(42)</span>
<span class="ruby-identifier">tagged_int</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1Data</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">42</span>, <span class="ruby-value">0</span>, <span class="ruby-value">:CONTEXT_SPECIFIC</span>) <span class="ruby-comment"># implicitly 0-tagged INTEGER</span>
</pre>
<div class="method-source-code" id="new-source">
<pre>static VALUE
ossl_asn1data_initialize(VALUE self, VALUE value, VALUE tag, VALUE tag_class)
{
if(!SYMBOL_P(tag_class))
ossl_raise(eASN1Error, "invalid tag class");
ossl_asn1_set_tag(self, tag);
ossl_asn1_set_value(self, value);
ossl_asn1_set_tag_class(self, tag_class);
ossl_asn1_set_indefinite_length(self, Qfalse);
return self;
}</pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-to_der" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
to_der → DER-encoded String
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Encodes this <a href="ASN1Data.html"><code>ASN1Data</code></a> into a DER-encoded String value. The result is DER-encoded except for the possibility of indefinite length forms. Indefinite length forms are not allowed in strict DER, so strictly speaking the result of such an encoding would be a BER-encoding.</p>
<div class="method-source-code" id="to_der-source">
<pre>static VALUE
ossl_asn1data_to_der(VALUE self)
{
VALUE value = ossl_asn1_get_value(self);
if (rb_obj_is_kind_of(value, rb_cArray))
return ossl_asn1cons_to_der(self);
else {
if (RTEST(ossl_asn1_get_indefinite_length(self)))
ossl_raise(eASN1Error, "indefinite length form cannot be used " \
"with primitive encoding");
return ossl_asn1prim_to_der(self);
}
}</pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|
