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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class OpenSSL::ASN1::Primitive - 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::Primitive-label-Primitive+sub-classes+and+their+mapping+to+Ruby+classes">Primitive sub-classes and their mapping to Ruby classes</a>
<li><a href="#class-OpenSSL::ASN1::Primitive-label-OpenSSL-3A-3AASN1-3A-3ABitString">OpenSSL::ASN1::BitString</a>
<li><a href="#class-OpenSSL::ASN1::Primitive-label-Additional+attributes">Additional attributes</a>
<li><a href="#class-OpenSSL::ASN1::Primitive-label-OpenSSL-3A-3AASN1-3A-3AObjectId">OpenSSL::ASN1::ObjectId</a>
<li><a href="#class-OpenSSL::ASN1::Primitive-label-Additional+attributes">Additional attributes</a>
<li><a href="#class-OpenSSL::ASN1::Primitive-label-Examples">Examples</a>
<li><a href="#class-OpenSSL::ASN1::Primitive-label-Creating+EndOfContent">Creating EndOfContent</a>
<li><a href="#class-OpenSSL::ASN1::Primitive-label-Creating+any+other+Primitive">Creating any other Primitive</a>
</ul>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="ASN1Data.html">OpenSSL::ASN1::ASN1Data</a>
</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::Primitive">
<h1 id="class-OpenSSL::ASN1::Primitive" class="class">
class OpenSSL::ASN1::Primitive
</h1>
<section class="description">
<p>The parent class for all primitive encodings. Attributes are the same as for <a href="ASN1Data.html"><code>ASN1Data</code></a>, with the addition of <em>tagging</em>. <a href="Primitive.html"><code>Primitive</code></a> values can never be encoded with indefinite length form, thus it is not possible to set the <em>indefinite_length</em> attribute for <a href="Primitive.html"><code>Primitive</code></a> and its sub-classes.</p>
<h2 id="class-OpenSSL::ASN1::Primitive-label-Primitive+sub-classes+and+their+mapping+to+Ruby+classes"><a href="Primitive.html"><code>Primitive</code></a> sub-classes and their mapping to Ruby classes<span><a href="#class-OpenSSL::ASN1::Primitive-label-Primitive+sub-classes+and+their+mapping+to+Ruby+classes">¶</a> <a href="#top">↑</a></span></h2>
<ul><li>
<p>OpenSSL::ASN1::EndOfContent <=> <em>value</em> is always <code>nil</code></p>
</li><li>
<p>OpenSSL::ASN1::Boolean <=> <em>value</em> is <code>true</code> or <code>false</code></p>
</li><li>
<p>OpenSSL::ASN1::Integer <=> <em>value</em> is an <a href="../BN.html"><code>OpenSSL::BN</code></a></p>
</li><li>
<p>OpenSSL::ASN1::BitString <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::OctetString <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::Null <=> <em>value</em> is always <code>nil</code></p>
</li><li>
<p>OpenSSL::ASN1::Object <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::Enumerated <=> <em>value</em> is an <a href="../BN.html"><code>OpenSSL::BN</code></a></p>
</li><li>
<p>OpenSSL::ASN1::UTF8String <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::NumericString <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::PrintableString <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::T61String <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::VideotexString <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::IA5String <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::UTCTime <=> <em>value</em> is a Time</p>
</li><li>
<p>OpenSSL::ASN1::GeneralizedTime <=> <em>value</em> is a Time</p>
</li><li>
<p>OpenSSL::ASN1::GraphicString <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::ISO64String <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::GeneralString <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::UniversalString <=> <em>value</em> is a String</p>
</li><li>
<p>OpenSSL::ASN1::BMPString <=> <em>value</em> is a String</p>
</li></ul>
<h2 id="class-OpenSSL::ASN1::Primitive-label-OpenSSL-3A-3AASN1-3A-3ABitString">OpenSSL::ASN1::BitString<span><a href="#class-OpenSSL::ASN1::Primitive-label-OpenSSL-3A-3AASN1-3A-3ABitString">¶</a> <a href="#top">↑</a></span></h2>
<h3 id="class-OpenSSL::ASN1::Primitive-label-Additional+attributes">Additional attributes<span><a href="#class-OpenSSL::ASN1::Primitive-label-Additional+attributes">¶</a> <a href="#top">↑</a></span></h3>
<p><em>unused_bits</em>: if the underlying BIT STRING’s length is a multiple of 8 then <em>unused_bits</em> is 0. Otherwise <em>unused_bits</em> indicates the number of bits that are to be ignored in the final octet of the BitString’s <em>value</em>.</p>
<h2 id="class-OpenSSL::ASN1::Primitive-label-OpenSSL-3A-3AASN1-3A-3AObjectId"><a href="ObjectId.html"><code>OpenSSL::ASN1::ObjectId</code></a><span><a href="#class-OpenSSL::ASN1::Primitive-label-OpenSSL-3A-3AASN1-3A-3AObjectId">¶</a> <a href="#top">↑</a></span></h2>
<p>NOTE: While <a href="Primitive.html#method-c-new"><code>OpenSSL::ASN1::ObjectId.new</code></a> will allocate a new <a href="ObjectId.html"><code>ObjectId</code></a>, it is not typically allocated this way, but rather that are received from parsed <a href="../ASN1.html"><code>ASN1</code></a> encodings.</p>
<h3 id="class-OpenSSL::ASN1::Primitive-label-Additional+attributes">Additional attributes<span><a href="#class-OpenSSL::ASN1::Primitive-label-Additional+attributes">¶</a> <a href="#top">↑</a></span></h3>
<ul><li>
<p><em>sn</em>: the short name as defined in <openssl/objects.h>.</p>
</li><li>
<p><em>ln</em>: the long name as defined in <openssl/objects.h>.</p>
</li><li>
<p><em>oid</em>: the object identifier as a String, e.g. “1.2.3.4.5”</p>
</li><li>
<p><em>short_name</em>: alias for <em>sn</em>.</p>
</li><li>
<p><em>long_name</em>: alias for <em>ln</em>.</p>
</li></ul>
<h2 id="class-OpenSSL::ASN1::Primitive-label-Examples">Examples<span><a href="#class-OpenSSL::ASN1::Primitive-label-Examples">¶</a> <a href="#top">↑</a></span></h2>
<p>With the Exception of OpenSSL::ASN1::EndOfContent, each <a href="Primitive.html"><code>Primitive</code></a> class constructor takes at least one parameter, the <em>value</em>.</p>
<h3 id="class-OpenSSL::ASN1::Primitive-label-Creating+EndOfContent">Creating EndOfContent<span><a href="#class-OpenSSL::ASN1::Primitive-label-Creating+EndOfContent">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">eoc</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">EndOfContent</span>.<span class="ruby-identifier">new</span>
</pre>
<h3 id="class-OpenSSL::ASN1::Primitive-label-Creating+any+other+Primitive">Creating any other <a href="Primitive.html"><code>Primitive</code></a><span><a href="#class-OpenSSL::ASN1::Primitive-label-Creating+any+other+Primitive">¶</a> <a href="#top">↑</a></span></h3>
<pre>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)</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-tagging" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">tagging</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>May be used as a hint for encoding a value either implicitly or explicitly by setting it either to <code>:IMPLICIT</code> or to <code>:EXPLICIT</code>. <em>tagging</em> is not set when a ASN.1 structure is parsed using <a href="../ASN1.html#method-c-decode"><code>OpenSSL::ASN1.decode</code></a>.</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::Primitive.new(value [, tag, tagging, tag_class ]) → Primitive
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><em>value</em>: is mandatory.</p>
<p><em>tag</em>: optional, may be specified for tagged values. If no <em>tag</em> is specified, the UNIVERSAL tag corresponding to the <a href="Primitive.html"><code>Primitive</code></a> sub-class is used by default.</p>
<p><em>tagging</em>: may be used as an encoding hint to encode a value either explicitly or implicitly, see <a href="../ASN1.html"><code>ASN1</code></a> for possible values.</p>
<p><em>tag_class</em>: if <em>tag</em> and <em>tagging</em> are <code>nil</code> then this is set to <code>:UNIVERSAL</code> by default. If either <em>tag</em> or <em>tagging</em> are set then <code>:CONTEXT_SPECIFIC</code> is used as the default. For possible values please cf. <a href="../ASN1.html"><code>ASN1</code></a>.</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">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">42</span>)
<span class="ruby-identifier">zero_tagged_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">42</span>, <span class="ruby-value">0</span>, <span class="ruby-value">:IMPLICIT</span>)
<span class="ruby-identifier">private_explicit_zero_tagged_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">42</span>, <span class="ruby-value">0</span>, <span class="ruby-value">:EXPLICIT</span>, <span class="ruby-value">:PRIVATE</span>)
</pre>
<div class="method-source-code" id="new-source">
<pre>static VALUE
ossl_asn1_initialize(int argc, VALUE *argv, VALUE self)
{
VALUE value, tag, tagging, tag_class;
int default_tag;
rb_scan_args(argc, argv, "13", &value, &tag, &tagging, &tag_class);
default_tag = ossl_asn1_default_tag(self);
if (default_tag == -1 || 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");
}
else{
tag = INT2NUM(default_tag);
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_indefinite_length(self, Qfalse);
if (default_tag == V_ASN1_BIT_STRING)
rb_ivar_set(self, sivUNUSED_BITS, INT2FIX(0));
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>See <a href="ASN1Data.html#method-i-to_der"><code>ASN1Data#to_der</code></a> for details.</p>
<div class="method-source-code" id="to_der-source">
<pre>static VALUE
ossl_asn1prim_to_der(VALUE self)
{
ASN1_TYPE *asn1;
long alllen, bodylen;
unsigned char *p0, *p1;
int j, tag, tc, state;
VALUE str;
if (ossl_asn1_default_tag(self) == -1) {
str = ossl_asn1_get_value(self);
return to_der_internal(self, 0, 0, StringValue(str));
}
asn1 = ossl_asn1_get_asn1type(self);
alllen = i2d_ASN1_TYPE(asn1, NULL);
if (alllen < 0) {
ASN1_TYPE_free(asn1);
ossl_raise(eASN1Error, "i2d_ASN1_TYPE");
}
str = ossl_str_new(NULL, alllen, &state);
if (state) {
ASN1_TYPE_free(asn1);
rb_jump_tag(state);
}
p0 = p1 = (unsigned char *)RSTRING_PTR(str);
i2d_ASN1_TYPE(asn1, &p0);
ASN1_TYPE_free(asn1);
assert(p0 - p1 == alllen);
/* Strip header since to_der_internal() wants only the payload */
j = ASN1_get_object((const unsigned char **)&p1, &bodylen, &tag, &tc, alllen);
if (j & 0x80)
ossl_raise(eASN1Error, "ASN1_get_object"); /* should not happen */
return to_der_internal(self, 0, 0, rb_str_drop_bytes(str, alllen - bodylen));
}</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>
|
