add more func in doc

doc/certificates.rst

@@ -161,7 +161,7 @@
 Функция:
 ::
 
-  ak_asn1 ak_certificate_new_p7b_skeleton( ak_asn1 *sequence )
+  ak_asn1 ak_certificate_new_p7b_skeleton(ak_asn1 *sequence)
 
 Данная функция позволяет создать новый (пустой) p7b контейнер. Параметры функции:
 
@@ -172,7 +172,7 @@
 Функция:
 ::
 
-  int ak_asn1_import_from_file( ak_asn1 asn, const char *filename, export_format_t *format )
+  int ak_asn1_import_from_file(ak_asn1 asn, const char *filename, export_format_t *format)
 
 Данная функция позволяет импортировать ASN.1 дерево из файла, содержащего der-последовательность.
 
@@ -187,7 +187,7 @@
 Функция:
 ::
 
-  int ak_certificate_import_from_asn1( ak_certificate subject_cert, ak_certificate issuer_cert, ak_asn1 root )
+  int ak_certificate_import_from_asn1(ak_certificate subject_cert, ak_certificate issuer_cert, ak_asn1 root)
 
 Данная функция позволяет импортировать открытый ключ асимметричного преобразования из сертификата открытого ключа, представленного в виде asn1 дерева. Параметры функции:
 
@@ -197,7 +197,25 @@
 
 * `ak_asn1 root` - указатель на вершину asn1 дерева
 
-Возвращаемое значение: 
+Возвращаемое значение: код ошибки типа `int`. Если функция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+ 
+  int ak_asn1_export_to_file(ak_asn1 asn, const char *filename, export_format_t format, crypto_content_t content)
+
+Данная функция позволяет экспортировать ASN.1 дерево в файл. Параметры функции:
+
+* `ak_asn1 asn` - указатель на текущий уровень ASN.1 дерева
+
+* `const char *filename` - имя файла, в который записываются данные
+
+* `export_format_t format` - формат, в котором сохраняются данные
+
+* `crypto_content_t content` - тип сохраняемого контента, используется для формирования заголовков pem-файла.
+
+Возвращаемое значение: код ошибки типа `int`. Если функция отработала успешно возвращается `ak_error_ok`.
 
 
 Вывод содержимого p7b контейнера и разделение p7b контейнера на отдельные сертификаты
@@ -237,7 +255,7 @@
 Функция:
 ::
 
-  int ak_certificate_set_repository( const char *path )
+  int ak_certificate_set_repository(const char *path)
 
 Данная функция позволяет установить путь к каталогу, в котором хранятся доверенные сертификаты,
 изменив значение перменной `ca_repository_path`. Параметры функции:
@@ -255,13 +273,182 @@
 Функция:
 ::
 
-  const char * ak_certificate_get_repository( void )
+  const char *ak_certificate_get_repository(void)
 
 Данная функция позволяет получить из глобальной переменной `ca_repository_path` путь к каталогу,
 в котором хранятся доверенные сертификаты.
 
 Возвращаемое значение: путь к каталогу с доеренными сертификатами.
 
+
+Функция:
+::
+
+  int ak_certificate_import_from_file(ak_certificate subject_cert, ak_certificate issuer_cert, const char *filename)
+
+Данная функция позволяет считывает из заданного файла сертификат открытого ключа, хранящийся в виде asn1 дерева. Параметры функции:
+
+* `ak_certificate subject_cert` - структура импортируемого сертификата открытого ключа асимметричного криптографического алгоритма
+
+* `ak_certificate issuer_cert` - сертификат открытого ключа, с помощью которого можно проверить подпись под сертификатом; может принимать значение `NULL`
+
+* `const char *filename` - имя файла, из которого считываются значения параметров открытого ключа
+
+Возвращаемое значение: код ошибки типа `int`. Если функция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  int ak_certificate_export_to_repository(ak_certificate subject_cert, ak_signkey issuer_skey, ak_certificate issuer_cert, ak_random generator)
+
+Данная функция позволяет экспортировать открытый ключ асиметричного криптографического алгоритма в сертификат открытого ключа и поместить его в хранилище сертификатов. Параметры функции:
+
+* `ak_certificate subject_cert` - контекст создаваемого сертификата
+
+* `ak_signkey issuer_skey` - контекст секретного ключа, с помощью которого подписывается создаваемый сертификат
+
+* `ak_certificate issuer_cert` - контекст сертификата открытого ключа, соответствующий секретному ключу подписи
+
+* `ak_random generator` - генератор случайных чисел
+
+Возвращаемое значение: код ошибки типа `int`. Если функция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  int ak_certificate_add_file_to_repository(const char *filename)
+
+Данная функция позволяет сохранить сертификат в текущем репозитории. Параметры функции:
+
+* `const char *filename` - имя файла с сертификатом открытого ключа
+
+Возвращаемое значение: код ошибки типа `int`. Если функция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  int ak_certificate_add_ptr_to_repository(ak_uint8 *buffer, const size_t size)
+
+Данная функция позволяет сохранить сертификат в текущем репозитории. Параметры функции:
+
+* `ak_uint8 *buffer` - указатель на область памяти, в которой расположен сертификат в der-кодировке
+
+* `const size_t size` - размер области памяти
+
+Возвращаемое значение: код ошибки типа `int`. Если функция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  int ak_certificate_add_asn1_to_repository(ak_asn1 root)
+
+Данная функция позволяет сохранить сертификат в текущем репозитории. Параметры функции:
+
+* `ak_asn1 root` - корень asn1 дерева, сожержащего сертификат открытого ключа
+
+Возвращаемое значение: код ошибки типа `int`. Если функция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  int ak_certificate_generate_serial_number(ak_verifykey vk, ak_signkey sk, ak_uint8 *buf, const size_t size)
+
+Данная функция позволяет выработать серийный номер сертификата. Параметры функции:
+
+* `ak_verifykey vk` - контекст открытого ключа, помещаемого в asn1 дерево сертификата
+
+* `ak_signkey sk` - контекст ключа подписи, содержащий параметры центра сертификации
+
+* `ak_uint8 *buf` - буффер, в котором размещается серийный номер
+
+* `const size_t size` - размер буффера
+
+Возвращаемое значение: код ошибки типа `int`. Если функция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  int ak_ceritifcate_generate_repository_name(char *full_name, size_t full_name_size, const ak_uint8 *serial_number, const size_t serial_number_size)
+
+Данная функция позволяет сформировать полное имя, состоящее из пути к репозиторию и имени файла. Параметры функции:
+
+* `char *full_name` - указатель на область памяти, куда помещается создаваемое имя
+
+* `size_t full_name_size` - размер области памяти
+
+* `const ak_uint8 *serial_number` - последовательность октетов, содержащая серийный номер сертификата
+
+* `const size_t serial_number_size` - размер серийного номера
+
+Возвращаемое значение: код ошибки типа `int`. Если функция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  int ak_certificate_import_from_ptr(ak_certificate subject_cert, ak_certificate issuer_cert, const ak_pointer ptr, const size_t size)
+
+Данная функция позволяет импортировать открытый ключ асимметричного преобразования из сертификата открытого ключа, расположенного в памяти. Параметры функции:
+
+* `ak_certificate subject_cert` - контекст импортируемого сертификата открытого ключа
+
+* `ak_certificate issuer_cert` - сертификат открытого ключа, с помощью которого можно проверить подпись под сертификатом; может принимать значение `NULL`
+
+* `const ak_pointer ptr` - указатель на область памяти, в которой распологается сертификат открытого ключа
+
+* `const size_t size` - размер сертификата
+
+Возвращаемое значение: код ошибки типа `int`. Если функция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  ak_asn1 ak_certificate_get_sequence_from_p7b_container(const char *filename)
+
+Данная функция позволяет получить последовательности сертификатов из p7b контейнера. Параметры функции:
+
+* `const char *filename` - имя файла
+
+Возвращаемое значение: указатель на ASN.1 последовательность или `NULL`.
+
+
+Функция:
+::
+
+  int ak_verifykey_create_from_signkey(ak_verifykey pctx, ak_signkey sctx)
+
+Данная функция позволяет инициализировать контекст открытого ключа асимметричного криптографического алгоритма. Параметры функции:
+
+* `ak_verifykey pctx` - контекст открытого ключа электронной подписи
+
+* `ak_signkey sctx` - контекст секретного ключа электронной подписи
+
+Возвращаемое значение: код ошибки типа `int`. Если функция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  int ak_tlv_add_string_to_global_name(ak_tlv tlv, const char *type, const char *value)
+
+Данная функция позволяет добавить типизированную строку в последовательность обобщенных имен, которой владеет текущий узел. Параметры функции:
+
+* `ak_tlv tlv` - указатель на структуру узла ASN1 дерева
+
+* `const char *type` - тип помещаемоцй строки с данными
+
+* `const char *value` - помещаемая строка
+
+Возвращаемое значение: код ошибки типа `int`. Если функция отработала успешно возвращается `ak_error_ok`.
+
+
 Вспомогательные функции
 -----------------------
 
@@ -274,4 +461,148 @@
 
 * `ak_certificate cert` - структура сертификата открытого ключа
 
+Возвращаемое значение: код ошибки типа `int`. Если функуция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  ak_asn1 ak_asn1_new(void)
+
+Данная функция позволяет выделить памяти и создать один уровня ASN1 дерева.
+
+Возвращаемое значение: в случае успеха возвращется указатель на созданный контекст asn1 дерева. В случае ошибки возвращается NULL.
+
+
+Функция:
+::
+
+  ak_pointer ak_asn1_delete(ak_pointer asn1)
+
+Данная функция позволяет уничтожить текущий уровня ASN1 дерева и освободить памяти. Параметры функции:
+
+* `ak_pointer asn1` - указатель на уровань ASN1 дерева
+
+Возвращаемое значение: `NULL`.
+
+
+Функция:
+::
+
+  ak_pointer ak_asn1_destroy(ak_asn1 asn1)
+
+Данная функция позволяет уничтожить текущий уровня ASN1 дерева. Параметры функции:
+
+* `ak_asn1 asn1` - указатель на уровань ASN1 дерева
+
+Возвращаемое значение: код ошибки типа `int`. Если функуция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  bool_t ak_asn1_remove(ak_asn1 asn1)
+
+Данная функция позволяет уничтожить текущий узел с текущего уровня ASN1 дерева. Параметры функции:
+
+* `ak_asn1 asn1` - указатель на узел ASN1 дерева
+
+Возвращаемое значение: в случаи успеха возвращает true, иначе false.
+
+
+Функция:
+::
+
+  int ak_asn1_add_tlv(ak_asn1 asn1, ak_tlv tlv)
+
+Данная функция позволяет добавить новый узел к текущему уровню ASN1 дерева. Параметры функции:
+
+* `ak_asn1 asn1` - указатель на уровань ASN1 дерева
+
+* `ak_tlv tlv` - указатель на узел ASN1 дерева
+
+Возвращаемое значение: код ошибки типа `int`. Если функуция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  int ak_asn1_export_to_file(ak_asn1 asn, const char *filename, export_format_t format, crypto_content_t content)
+
+Данная функция позволяет экспортировать ASN1 дерево в файл. Параметры функции:
+
+* `ak_asn1 asn` - указатель на уровань ASN1 дерева
+
+* `const char *filename` - имя файла, в который записываются данные
+
+* `export_format_t format` - формат, в котором сохраняются данные
+
+* `crypto_content_t content` - тип сохраняемого контента, используется для формирования заголовков pem-файла
+
+Возвращаемое значение: код ошибки типа `int`. Если функуция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  bool_t ak_asn1_first(ak_asn1 asn1)
+
+Данная функция позволяет переместиться к первому узлу текущего уровня ASN1 дерева. Параметры функции:
+
+* `ak_asn1 asn1` - указатель на уровань ASN1 дерева
+
+Возвращаемое значение: возвращает `false`.
+
+
+Функция:
+::
+
+  ak_tlv ak_asn1_exclude(ak_asn1 asn1)
+
+Данная функция позволяет изъять текущий узел из ASN1 дерева. Параметры функции:
+
+* `ak_asn1 asn1` - уровень asn1 дерева, из которого изымается текущий узел
+
+Возвращаемое значение: в случае успеха функция возвращает указатель на изъятый узел. Иначе `NULL`.
+
+
+Функция:
+::
+
+  int ak_asn1_export_to_derfile(ak_asn1 asn, const char *filename)
+
+Данная функция позволяет экспортировать ASN1 дерево в файл в виде der-последовательности. Параметры функции:
+
+* `ak_asn1 asn` - указатель на текущий уровень ASN1 дерева
+
+* `const char *filename` - имя файла, в который записываются данные
+
+Возвращаемое значение: код ошибки типа `int`. Если функуция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  int ak_asn1_export_to_pemfile(ak_asn1 asn, const char *filename, crypto_content_t type)
+
+Данная функция позволяет экспортировать ASN1 дерево в файл в виде der-последовательности, закодированной в base64. Параметры функции:
+
+* `ak_asn1 asn` - указатель на текущий уровень ASN1 дерева
+
+* `const char *filename` - имя файла, в который записываются данные
+
+* `crypto_content_t type` - тип сохраняемого контента, используется для формирования заголовков pem-файла
+
+Возвращаемое значение: код ошибки типа `int`. Если функуция отработала успешно возвращается `ak_error_ok`.
+
+
+Функция:
+::
+
+  bool_t ak_asn1_is_certificate(ak_asn1 root)
+
+Данная функция позволяет проверить, является ли заданное ASN1 дерево сертификатом открытого ключа. Параметры функции:
+
+* `ak_asn1 root` - корень asn1 дерево, содержащее запрос на сертификат
+
 Возвращаемое значение: код ошибки типа `int`. Если функуция отработала успешно возвращается `ak_error_ok`.
\ No newline at end of file