<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.rnp.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.rnp-op-generate-key.php',
    1 => 'rnp_op_generate_key',
    2 => 'Генерирует ключ',
  ),
  'up' => 
  array (
    0 => 'ref.rnp.php',
    1 => 'Функции Rnp',
  ),
  'prev' => 
  array (
    0 => 'function.rnp-op-encrypt.php',
    1 => 'rnp_op_encrypt',
  ),
  'next' => 
  array (
    0 => 'function.rnp-op-sign.php',
    1 => 'rnp_op_sign',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/rnp/functions/rnp-op-generate-key.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.rnp-op-generate-key" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">rnp_op_generate_key</h1>
  <p class="verinfo">(PECL rnp &gt;= 0.1.1)</p><p class="refpurpose"><span class="refname">rnp_op_generate_key</span> &mdash; <span class="dc-title">Генерирует ключ</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.rnp-op-generate-key-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>rnp_op_generate_key</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.rnpffi.php" class="type RnpFFI">RnpFFI</a></span> <code class="parameter">$ffi</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$userid</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$key_alg</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$sub_alg</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$options</code><span class="initializer"> = ?</span></span><br>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">

  </p>


 </div>


 <div class="refsect1 parameters" id="refsect1-function.rnp-op-generate-key-parameters">
  <h3 class="title">Список параметров</h3>
  <dl>
   
    <dt><code class="parameter">ffi</code></dt>
    <dd>
     <span class="simpara">
      FFI-объект, который возвращает функция <span class="function"><a href="function.rnp-ffi-create.php" class="function">rnp_ffi_create()</a></span>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">userid</code></dt>
    <dd>
     <span class="simpara">
      PGP User ID - текст, предназначенный для представления
      имени и адреса электронной почты владельца ключа.
     </span>
    </dd>
   
   
    <dt><code class="parameter">key_alg</code></dt>
    <dd>
     <span class="simpara">
      Алгоритм первичного ключа (например, &#039;RSA&#039;, &#039;DSA&#039; и т.д.).
     </span>
    </dd>
   
   
    <dt><code class="parameter">sub_alg</code></dt>
    <dd>
     <span class="simpara">
      Алгоритм дочернего ключа. Если значение не задано,
      то дочерний ключ генерироваться не будет.
     </span>
    </dd>
   
   
    <dt><code class="parameter">options</code></dt>
    <dd>
     <span class="simpara">
      Ассоциативный массив с опциями.
     </span>
     <table class="doctable informaltable">
      
       <thead>
        <tr>
         <th>Ключ</th>
         <th>Тип данных</th>
         <th>Описание</th>
        </tr>

       </thead>

       <tbody class="tbody">
        <tr>
         <td><code class="literal">&quot;bits&quot;</code></td>
         <td>integer</td>
         <td>Размер первичного ключа в битах. Применяется только для ключей RSA, DSA и El-Gamal.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;hash&quot;</code></td>
         <td>string</td>
         <td>Хеш-алгоритм, используемый в самоподписи или подписи с привязкой к дочернему ключу.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;dsa_qbits&quot;</code></td>
         <td>integer</td>
         <td>
          Устанавливает размер параметра <code class="literal">q</code> для DSA-ключа.
          Примечание: в зависимости от разрядности ключа будет установлено соответствующее
          значение по умолчанию. Однако при необходимости его можно переопределить.
         </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;curve&quot;</code></td>
         <td>string</td>
         <td>Установка кривой, используемой для ключа ECC. Примечание: это применимо только для ключей ECDSA, ECDH и SM2.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;request_password&quot;</code></td>
         <td>boolean</td>
         <td>
          Включает запрос пароля через провайдера паролей. Этот пароль будет использоваться
          для шифрования ключа. Callback-функция провайдера паролей должна быть задана
          заранее вызовом функции <span class="function"><a href="function.rnp-ffi-set-pass-provider.php" class="function">rnp_ffi_set_pass_provider()</a></span>.
          Примечание: данная настройка будет проигнорирована,
          если пароль был задан через с помощью <code class="literal">&quot;password&quot;</code>.
         </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;password&quot;</code></td>
         <td>string</td>
         <td>Устанавливает пароль, используемый для шифрования данных секретного ключа.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;expiration&quot;</code></td>
         <td>integer</td>
         <td>Устанавливает время истечения срока действия ключей и дочерних ключей в секундах.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;sub_bits&quot;</code></td>
         <td>integer</td>
         <td>Размер дочернего ключа в битах. Применяется только для ключей RSA, DSA и El-Gamal.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;sub_hash&quot;</code></td>
         <td>string</td>
         <td>Хеш-алгоритм, используемый в самоподписи дочернего ключа или в подписи с привязкой к дочернему ключу.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;sub_curve&quot;</code></td>
         <td>string</td>
         <td>Устанавливает кривую, используемую для дочернего ключа ECC. Примечание: это применимо только для ключей ECDSA, ECDH и SM2.</td>
        </tr>

       </tbody>
      
     </table>

    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.rnp-op-generate-key-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="simpara">
   Отпечаток сгенерированного первичного ключа или <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если возникла ошибка.
   Этот отпечаток может быть использован в дальнейшем для ссылки на ключ
   в операциях подписи и шифрования.
   Данные ключа хранятся в контексте памяти FFI и могут быть сохранены
   с помощью функции <span class="function"><a href="function.rnp-save-keys.php" class="function">rnp_save_keys()</a></span> или <span class="function"><a href="function.rnp-save-keys-to-path.php" class="function">rnp_save_keys_to_path()</a></span>.
  </p>
 </div>


</div><?php manual_footer($setup); ?>