scilab/modules/fileio/help/ru_RU/hash.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
   4  * Copyright (C) 2020 - Stéphane MOTTELET
   5  *
   6  * This file is hereby licensed under the terms of the GNU GPL v2.0,
   7  * For more information, see the COPYING file which you should have received
   8  * along with this program.
   9  *
  10  -->
  11 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
  12 xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
  13 xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
  14 xml:lang="ru" xml:id="hash">
  15     <refnamediv>
  16         <refname>hash</refname>
  17         <refpurpose>
  18             получает контрольную сумму файла или строки, используя различные алгоритмы
  19             получения хеш-сумм
  20         </refpurpose>
  21     </refnamediv>
  22     <refsynopsisdiv>
  23         <title>Синтаксис</title>
  24         <synopsis>
  25             res = hash(fd, algorithm)
  26             res = hash(string, algorithm)
  27         </synopsis>
  28     </refsynopsisdiv>
  29     <refsection>
  30         <title>Аргументы</title>
  31         <variablelist>
  32             <varlistentry>
  33                 <term>res</term>
  34                 <listitem>
  35                     <para>хеш-результат (строка)</para>
  36                 </listitem>
  37             </varlistentry>
  38             <varlistentry>
  39                 <term>fd</term>
  40                 <listitem>
  41                     <para>
  42                         матрица дескрипторов файлов, возвращаемых функцией <function>mopen</function>.
  43                     </para>
  44                 </listitem>
  45             </varlistentry>
  46             <varlistentry>
  47                 <term>string</term>
  48                 <listitem>
  49                     <para>строка или матрица строк</para>
  50                 </listitem>
  51             </varlistentry>
  52             <varlistentry>
  53                 <term>algorithm</term>
  54                 <listitem>
  55                     <para>строка (алгоритм подсчёта хеш-суммы)</para>
  56                 </listitem>
  57             </varlistentry>
  58         </variablelist>
  59     </refsection>
  60     <refsection>
  61         <title>Описание</title>
  62         <para>
  63             <function>hash</function> получает контрольную сумму файла или строки,
  64             используя функцию получения хеш-сумм <varname>algorithm</varname>.
  65             Доступными алгоритмами являются:
  66         </para>
  67         <para>
  68         <informaltable border="1">
  69                <tbody>
  70                  <tr>
  71                      <td>'crc32'</td><td>контрольная сумма crc32</td>
  72                  </tr>
  73                  <tr>
  74                      <td>'md5'</td><td>алгоритм выборки сообщений 5</td>
  75                  </tr>
  76                 <tr>
  77                     <td>'sha1'</td><td>защищённый алгоритм хеширования 1 (160 бит)</td>
  78                 </tr>
  79                 <tr>
  80                     <td>'sha2', 'sha256'</td><td>защищённый алгоритм хеширования 2 (256 бит)</td>
  81                 </tr>
  82                 <tr>
  83                     <td>'sha3-224'</td><td>защищённый алгоритм хеширования 3 (224 бита)</td>
  84                 </tr>
  85                 <tr>
  86                     <td>'sha3-256'</td><td>защищённый алгоритм хеширования 3 (256 бит)</td>
  87                 </tr>
  88                 <tr>
  89                     <td>'sha3-384'</td><td>защищённый алгоритм хеширования 3 (384 бита)</td>
  90                 </tr>
  91                 <tr>
  92                     <td>'sha3-512'</td><td>защищённый алгоритм хеширования 3 (512 бит)</td>
  93                 </tr>
  94             </tbody>
  95         </informaltable>
  96     </para>
  97     </refsection>
  98     <refsection>
  99         <title>Примеры</title>
 100         <programlisting role="example"><![CDATA[
 101 hash('hello world', 'md5')
 102 hash('hello world', 'sha256')
 103 hash(['hello';'world'], 'sha3-256')
 104
 105 hash( mopen(SCI+'/modules/core/etc/core.start') ,'sha256')
 106  ]]></programlisting>
 107     </refsection>
 108       <refsection>
 109         <title>История</title>
 110         <revhistory>
 111             <revision>
 112                 <revnumber>6.1.1</revnumber>
 113                 <revremark>введена hash().</revremark>
 114             </revision>
 115         </revhistory>
 116     </refsection>
 117 </refentry>