diff options
| author | Kazuki Yamaguchi <k@rhe.jp> | 2021-10-17 21:16:54 +0900 |
|---|---|---|
| committer | Kazuki Yamaguchi <k@rhe.jp> | 2021-10-17 21:16:54 +0900 |
| commit | 0c12273a7174d300bad342a053186ae172d2952d (patch) | |
| tree | bdc64bc3164b5d534717c7272a8d309a60021a76 /OpenSSL/ASN1/ASN1Data.html | |
| parent | ad2abc0cd93977a35565178a3b4b4e50edbd8f0b (diff) | |
| download | ruby-openssl-0c12273a7174d300bad342a053186ae172d2952d.tar.gz | |
Sync with v2.2.1
Diffstat (limited to 'OpenSSL/ASN1/ASN1Data.html')
| -rw-r--r-- | OpenSSL/ASN1/ASN1Data.html | 74 |
1 files changed, 8 insertions, 66 deletions
diff --git a/OpenSSL/ASN1/ASN1Data.html b/OpenSSL/ASN1/ASN1Data.html index 4fccbabf..879e7ba8 100644 --- a/OpenSSL/ASN1/ASN1Data.html +++ b/OpenSSL/ASN1/ASN1Data.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -71,26 +69,23 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- 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> @@ -188,21 +183,15 @@ </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 @@ -210,12 +199,9 @@ </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 @@ -223,12 +209,9 @@ </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 @@ -236,12 +219,9 @@ </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 @@ -249,12 +229,9 @@ </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 @@ -262,38 +239,26 @@ </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> @@ -305,10 +270,7 @@ <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) @@ -323,44 +285,29 @@ ossl_asn1data_initialize(VALUE self, VALUE value, VALUE tag, VALUE tag_class) 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) @@ -377,25 +324,20 @@ ossl_asn1data_to_der(VALUE self) } }</pre> </div> - </div> - - </div> - </section> - - </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.2.1. + <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> |