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/PKey/EC/Group.html | |
| parent | ad2abc0cd93977a35565178a3b4b4e50edbd8f0b (diff) | |
| download | ruby-openssl-0c12273a7174d300bad342a053186ae172d2952d.tar.gz | |
Sync with v2.2.1
Diffstat (limited to 'OpenSSL/PKey/EC/Group.html')
| -rw-r--r-- | OpenSSL/PKey/EC/Group.html | 330 |
1 files changed, 12 insertions, 318 deletions
diff --git a/OpenSSL/PKey/EC/Group.html b/OpenSSL/PKey/EC/Group.html index 55253bed..42d18499 100644 --- a/OpenSSL/PKey/EC/Group.html +++ b/OpenSSL/PKey/EC/Group.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"> @@ -59,60 +57,40 @@ <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-3D-3D">#==</a> - <li ><a href="#method-i-asn1_flag">#asn1_flag</a> - <li ><a href="#method-i-asn1_flag-3D">#asn1_flag=</a> - <li ><a href="#method-i-cofactor">#cofactor</a> - <li ><a href="#method-i-curve_name">#curve_name</a> - <li ><a href="#method-i-degree">#degree</a> - <li ><a href="#method-i-eql-3F">#eql?</a> - <li ><a href="#method-i-generator">#generator</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-order">#order</a> - <li ><a href="#method-i-point_conversion_form">#point_conversion_form</a> - <li ><a href="#method-i-point_conversion_form-3D">#point_conversion_form=</a> - <li ><a href="#method-i-seed">#seed</a> - <li ><a href="#method-i-seed-3D">#seed=</a> - <li ><a href="#method-i-set_generator">#set_generator</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_pem">#to_pem</a> - <li ><a href="#method-i-to_text">#to_text</a> - </ul> </div> @@ -128,67 +106,46 @@ </section> - <section id="5Buntitled-5D" class="documentation-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::PKey::EC::Group.new(ec_group) </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC::Group.new(pem_or_der_encoded) </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC::Group.new(ec_method) </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC::Group.new(:GFp, bignum_p, bignum_a, bignum_b) </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC::Group.new(:GF2m, bignum_p, bignum_a, bignum_b) </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="Group.html"><code>EC::Group</code></a> object.</p> <p><em>ec_method</em> is a symbol that represents an EC_METHOD. Currently the following are supported:</p> @@ -203,10 +160,7 @@ </li></ul> <p>If the first argument is :GFp or :GF2m, creates a new curve with given parameters.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ec_group_initialize(int argc, VALUE *argv, VALUE self) { @@ -312,74 +266,49 @@ 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-3D-3D" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name">==</span><span - class="method-args">(p1)</span> - + <span class="method-callseq"> + group1 == group2 → true | false + </span> </div> - <div class="method-description"> - - - - + <p>Returns <code>true</code> if the two groups use the same curve and have the same parameters, <code>false</code> otherwise.</p> - </div> - - <div class="aliases"> Alias for: <a href="Group.html#method-i-eql-3F">eql?</a> </div> - </div> - <div id="method-i-asn1_flag" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> asn1_flag → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the flags set on the group.</p> <p>See also <a href="Group.html#method-i-asn1_flag-3D"><code>asn1_flag=</code></a>.</p> - - - <div class="method-source-code" id="asn1_flag-source"> <pre>static VALUE ossl_ec_group_get_asn1_flag(VALUE self) { @@ -392,31 +321,20 @@ return INT2NUM(flag); }</pre> </div> - </div> - - </div> - <div id="method-i-asn1_flag-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> asn1_flag = flags </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets flags on the group. The flag value is used to determine how to encode the group: encode explicit parameters or named curve using an OID.</p> <p>The flag value can be either of:</p> @@ -427,10 +345,7 @@ </li></ul> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_set_asn1_flag().</p> - - - <div class="method-source-code" id="asn1_flag-3D-source"> <pre>static VALUE ossl_ec_group_set_asn1_flag(VALUE self, VALUE flag_v) { @@ -442,38 +357,24 @@ return flag_v; }</pre> </div> - </div> - - </div> - <div id="method-i-cofactor" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> get_cofactor → cofactor_bn </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the cofactor of the group.</p> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_get_cofactor()</p> - - - <div class="method-source-code" id="cofactor-source"> <pre>static VALUE ossl_ec_group_get_cofactor(VALUE self) { @@ -492,38 +393,24 @@ return bn_obj; }</pre> </div> - </div> - - </div> - <div id="method-i-curve_name" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> curve_name → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the curve name (sn).</p> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_get_curve_name()</p> - - - <div class="method-source-code" id="curve_name-source"> <pre>static VALUE ossl_ec_group_get_curve_name(VALUE self) { @@ -540,36 +427,22 @@ return rb_str_new2(OBJ_nid2sn(nid)); }</pre> </div> - </div> - - </div> - <div id="method-i-degree" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> degree → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_get_degree()</p> - - - <div class="method-source-code" id="degree-source"> <pre>static VALUE ossl_ec_group_get_degree(VALUE self) { @@ -580,43 +453,22 @@ return INT2NUM(EC_GROUP_get_degree(group)); }</pre> </div> - </div> - - </div> - <div id="method-i-eql-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> eql?(group2) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-heading"> - <span class="method-callseq"> - group1 == group2 → true | false - </span> - - </div> - - <div class="method-description"> - <p>Returns <code>true</code> if the two groups use the same curve and have the same parameters, <code>false</code> otherwise.</p> - - - <div class="method-source-code" id="eql-3F-source"> <pre>static VALUE ossl_ec_group_eql(VALUE a, VALUE b) { @@ -631,42 +483,27 @@ return Qtrue; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="Group.html#method-i-3D-3D">==</a> </div> - - </div> - <div id="method-i-generator" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> generator → ec_point </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the generator of the group.</p> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_get0_generator()</p> - - - <div class="method-source-code" id="generator-source"> <pre>static VALUE ossl_ec_group_get_generator(VALUE self) { @@ -681,33 +518,21 @@ return ec_point_new(generator, group); }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_ec_group_initialize_copy(VALUE self, VALUE other) @@ -727,38 +552,24 @@ ossl_ec_group_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-order" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> get_order → order_bn </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the order of the group.</p> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_get_order()</p> - - - <div class="method-source-code" id="order-source"> <pre>static VALUE ossl_ec_group_get_order(VALUE self) { @@ -777,38 +588,24 @@ ossl_ec_group_initialize_copy(VALUE self, VALUE other) return bn_obj; }</pre> </div> - </div> - - </div> - <div id="method-i-point_conversion_form" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> point_conversion_form → Symbol </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the form how <a href="Point.html"><code>EC::Point</code></a> data is encoded as ASN.1.</p> <p>See also <a href="Group.html#method-i-point_conversion_form-3D"><code>point_conversion_form=</code></a>.</p> - - - <div class="method-source-code" id="point_conversion_form-source"> <pre>static VALUE ossl_ec_group_get_point_conversion_form(VALUE self) { @@ -829,31 +626,20 @@ ossl_ec_group_initialize_copy(VALUE self, VALUE other) return ID2SYM(ret); }</pre> </div> - </div> - - </div> - <div id="method-i-point_conversion_form-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> point_conversion_form = form </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the form how <a href="Point.html"><code>EC::Point</code></a> data is encoded as ASN.1 as defined in X9.62.</p> <p><em>format</em> can be one of these:</p> @@ -869,10 +655,7 @@ ossl_ec_group_initialize_copy(VALUE self, VALUE other) </dd></dl> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_set_point_conversion_form()</p> - - - <div class="method-source-code" id="point_conversion_form-3D-source"> <pre>static VALUE ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) @@ -888,36 +671,22 @@ ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) return form_v; }</pre> </div> - </div> - - </div> - <div id="method-i-seed" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> seed → String or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_get0_seed()</p> - - - <div class="method-source-code" id="seed-source"> <pre>static VALUE ossl_ec_group_get_seed(VALUE self) { @@ -933,36 +702,22 @@ ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) return rb_str_new((const char *)EC_GROUP_get0_seed(group), seed_len); }</pre> </div> - </div> - - </div> - <div id="method-i-seed-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> seed = seed → seed </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_set_seed()</p> - - - <div class="method-source-code" id="seed-3D-source"> <pre>static VALUE ossl_ec_group_set_seed(VALUE self, VALUE seed) { @@ -977,38 +732,24 @@ ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) return seed; }</pre> </div> - </div> - - </div> - <div id="method-i-set_generator" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_generator(generator, order, cofactor) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the curve parameters. <em>generator</em> must be an instance of <a href="Point.html"><code>EC::Point</code></a> that is on the curve. <em>order</em> and <em>cofactor</em> are integers.</p> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_set_generator()</p> - - - <div class="method-source-code" id="set_generator-source"> <pre>static VALUE ossl_ec_group_set_generator(VALUE self, VALUE generator, VALUE order, VALUE cofactor) { @@ -1027,108 +768,66 @@ ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for i2d_ECPKParameters_bio()</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_ec_group_to_der(VALUE self) { return ossl_ec_group_to_string(self, EXPORT_DER); }</pre> </div> - </div> - - </div> - <div id="method-i-to_pem" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_pem → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for PEM_write_bio_ECPKParameters()</p> - - - <div class="method-source-code" id="to_pem-source"> <pre>static VALUE ossl_ec_group_to_pem(VALUE self) { return ossl_ec_group_to_string(self, EXPORT_PEM); }</pre> </div> - </div> - - </div> - <div id="method-i-to_text" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_text → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for ECPKParameters_print()</p> - - - <div class="method-source-code" id="to_text-source"> <pre>static VALUE ossl_ec_group_to_text(VALUE self) { @@ -1149,25 +848,20 @@ ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) return str; }</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> |