Rutoken Flash 2.0.1
Управление flash-памятью устройств Рутокен ЭЦП 3.0 Flash
rtflash.h
См. документацию.
1#ifndef RTFLASH_H
2#define RTFLASH_H
3
6
7#include "rtflash-macros.h"
8#include "rtflash-status.h"
9#include "rtflash-types.h"
10
11#include <stdbool.h>
12
13#ifdef __cplusplus
14extern "C" {
15#endif
16
18// Базовые операции
19
26RTFLASH_API rtflash_StatusCode rtflash_create_token_list(rtflash_TokenSerial** outTokens, size_t* outTokenCount);
27
30RTFLASH_API void rtflash_destroy_token_list(rtflash_TokenSerial** tokens);
31
38RTFLASH_API rtflash_StatusCode rtflash_create_token(rtflash_TokenSerial tokenSerial, rtflash_Token* outToken);
39
43RTFLASH_API void rtflash_destroy_token(rtflash_Token* token);
44
49RTFLASH_API rtflash_StatusCode rtflash_is_token_supported(rtflash_Token token, bool* outIsSupported);
50
52// Login / Logout
53
62RTFLASH_API rtflash_StatusCode rtflash_login_user(rtflash_Token token, const rtflash_PinCode pin);
63
72RTFLASH_API rtflash_StatusCode rtflash_login_admin(rtflash_Token token, const rtflash_PinCode pin);
73
83RTFLASH_API rtflash_StatusCode rtflash_login_mva(rtflash_Token token,
84 rtflash_MvaId mvaId,
85 rtflash_MvaRecord record);
86
97RTFLASH_API rtflash_StatusCode rtflash_login_local_pin(rtflash_Token token,
98 rtflash_LocalPinId localPinId,
99 rtflash_PinCode localPin);
100
104RTFLASH_API rtflash_StatusCode rtflash_logout(rtflash_Token token);
105
110RTFLASH_API rtflash_StatusCode rtflash_reset_login_attempts_user(rtflash_Token token);
111
117RTFLASH_API rtflash_StatusCode rtflash_reset_login_attempts_local_pin(rtflash_Token token,
118 rtflash_LocalPinId localPinId);
119
125RTFLASH_API rtflash_StatusCode rtflash_reset_login_attempts_mva(rtflash_Token token, rtflash_MvaId mvaId);
126
131RTFLASH_API rtflash_StatusCode rtflash_get_remaining_login_attempts_user(rtflash_Token token,
132 rtflash_Attempts* outAttemptsLeft);
133
138RTFLASH_API rtflash_StatusCode rtflash_get_remaining_login_attempts_admin(rtflash_Token token,
139 rtflash_Attempts* outAttemptsLeft);
140
146RTFLASH_API rtflash_StatusCode rtflash_get_remaining_login_attempts_mva(rtflash_Token token,
147 rtflash_MvaId mvaId,
148 rtflash_Attempts* outAttemptsLeft);
149
155RTFLASH_API rtflash_StatusCode rtflash_get_remaining_login_attempts_local_pin(rtflash_Token token,
156 rtflash_LocalPinId localPinId,
157 rtflash_Attempts* outAttemptsLeft);
158
160// Работа с flash-разделами
161
169RTFLASH_API rtflash_StatusCode rtflash_create_section_list(rtflash_Token token,
170 rtflash_Section** outSections,
171 size_t* outSectionCount);
172
175RTFLASH_API void rtflash_destroy_section_list(rtflash_Section** sections);
176
182RTFLASH_API rtflash_StatusCode rtflash_get_available_flash_size(rtflash_Token token, rtflash_MemSizeMB* outSize);
183
202RTFLASH_API rtflash_StatusCode rtflash_split_into_sections(rtflash_Token token,
203 rtflash_Section const* sections,
204 size_t sectionCount);
205
217RTFLASH_API rtflash_StatusCode rtflash_change_section_access_rights(rtflash_Token token,
218 rtflash_SectionId sectionId,
219 rtflash_SectionAccessState accessRights,
220 bool isPermanent);
221
223// Работа с MVA
224
231RTFLASH_API rtflash_StatusCode rtflash_create_mva_id_list(rtflash_Token token, rtflash_MvaId** outIds, size_t* outCount);
232
235RTFLASH_API void rtflash_destroy_mva_id_list(rtflash_MvaId** mvaIds);
236
246RTFLASH_API rtflash_StatusCode rtflash_create_mva(rtflash_Token token,
247 rtflash_MvaParams const* params,
248 rtflash_MvaId* outMvaId);
249
258RTFLASH_API rtflash_StatusCode rtflash_mva_add_record(rtflash_Token token,
259 rtflash_MvaId mvaId,
260 rtflash_MvaRecord record,
261 rtflash_RecordId* outRecordId);
262
269RTFLASH_API rtflash_StatusCode rtflash_mva_delete_record(rtflash_Token token,
270 rtflash_MvaId mvaId,
271 rtflash_RecordId recordId);
272
278RTFLASH_API rtflash_StatusCode rtflash_mva_clear_all_records(rtflash_Token token, rtflash_MvaId mvaId);
279
281// Работа с локальными PIN-кодами
282
290RTFLASH_API rtflash_StatusCode rtflash_create_local_pin_id_list(rtflash_Token token,
291 rtflash_LocalPinId** outIds,
292 size_t* outCount);
293
296RTFLASH_API void rtflash_destroy_local_pin_id_list(rtflash_LocalPinId** ids);
297
309RTFLASH_API rtflash_StatusCode rtflash_create_local_pin(rtflash_Token token,
310 rtflash_PinCode localPin,
311 rtflash_SecureType secureType,
312 rtflash_LocalPinId* outLocalId);
313
321RTFLASH_API rtflash_StatusCode rtflash_change_local_pin(rtflash_Token token,
322 rtflash_LocalPinId localId,
323 rtflash_PinCode newLocalPin);
324
326// Другие функции
327
331RTFLASH_API rtflash_StatusCode rtflash_add_pc_info_to_journal(rtflash_Token token, rtflash_PcInfo const* pcInfo);
332
333#ifdef __cplusplus
334}
335#endif
336
337#endif // RTFLASH_H
rtflash-macros.h
Макросы
RTFLASH_API
#define RTFLASH_API
Definition: rtflash-macros.h:12
rtflash-status.h
Обработка кодов возврата
rtflash_StatusCode
rtflash_StatusCode
Коды возврата функций библиотеки
Definition: rtflash-status.h:19
rtflash_SectionId
uint8_t rtflash_SectionId
Идентификатор раздела
Definition: rtflash-types.h:29
rtflash_SecureType
rtflash_SecureType
Тип защиты от при создании локального PIN-кода.
Definition: rtflash-types.h:60
rtflash_LocalPinId
rtflash_SecretId rtflash_LocalPinId
Идентификатор локального PIN-кода
Definition: rtflash-types.h:83
rtflash_MvaId
rtflash_SecretId rtflash_MvaId
Идентификатор MVA.
Definition: rtflash-types.h:82
rtflash_RecordId
uint8_t rtflash_RecordId
Идентификатор записи MVA.
Definition: rtflash-types.h:28
rtflash_Token
struct rtflash_TokenImpl_ * rtflash_Token
Definition: rtflash-types.h:87
rtflash_MemSizeMB
uint32_t rtflash_MemSizeMB
Память в МБ
Definition: rtflash-types.h:30
rtflash_Attempts
uint16_t rtflash_Attempts
Definition: rtflash-types.h:210
rtflash_SectionAccessState
rtflash_SectionAccessState
Режим доступа к разделу.
Definition: rtflash-types.h:97
rtflash_TokenSerial
uint64_t rtflash_TokenSerial
Серийный номер устройства
Definition: rtflash-types.h:27
rtflash_split_into_sections
rtflash_StatusCode rtflash_split_into_sections(rtflash_Token token, rtflash_Section const *sections, size_t sectionCount)
rtflash_logout
rtflash_StatusCode rtflash_logout(rtflash_Token token)
rtflash_destroy_token_list
void rtflash_destroy_token_list(rtflash_TokenSerial **tokens)
rtflash_get_remaining_login_attempts_user
rtflash_StatusCode rtflash_get_remaining_login_attempts_user(rtflash_Token token, rtflash_Attempts *outAttemptsLeft)
rtflash_create_section_list
rtflash_StatusCode rtflash_create_section_list(rtflash_Token token, rtflash_Section **outSections, size_t *outSectionCount)
rtflash_destroy_local_pin_id_list
void rtflash_destroy_local_pin_id_list(rtflash_LocalPinId **ids)
rtflash_destroy_section_list
void rtflash_destroy_section_list(rtflash_Section **sections)
rtflash_create_mva
rtflash_StatusCode rtflash_create_mva(rtflash_Token token, rtflash_MvaParams const *params, rtflash_MvaId *outMvaId)
rtflash_change_local_pin
rtflash_StatusCode rtflash_change_local_pin(rtflash_Token token, rtflash_LocalPinId localId, rtflash_PinCode newLocalPin)
rtflash_create_token
rtflash_StatusCode rtflash_create_token(rtflash_TokenSerial tokenSerial, rtflash_Token *outToken)
rtflash_is_token_supported
rtflash_StatusCode rtflash_is_token_supported(rtflash_Token token, bool *outIsSupported)
rtflash_create_local_pin
rtflash_StatusCode rtflash_create_local_pin(rtflash_Token token, rtflash_PinCode localPin, rtflash_SecureType secureType, rtflash_LocalPinId *outLocalId)
rtflash_login_mva
rtflash_StatusCode rtflash_login_mva(rtflash_Token token, rtflash_MvaId mvaId, rtflash_MvaRecord record)
rtflash_get_remaining_login_attempts_admin
rtflash_StatusCode rtflash_get_remaining_login_attempts_admin(rtflash_Token token, rtflash_Attempts *outAttemptsLeft)
rtflash_get_available_flash_size
rtflash_StatusCode rtflash_get_available_flash_size(rtflash_Token token, rtflash_MemSizeMB *outSize)
rtflash_change_section_access_rights
rtflash_StatusCode rtflash_change_section_access_rights(rtflash_Token token, rtflash_SectionId sectionId, rtflash_SectionAccessState accessRights, bool isPermanent)
rtflash_create_local_pin_id_list
rtflash_StatusCode rtflash_create_local_pin_id_list(rtflash_Token token, rtflash_LocalPinId **outIds, size_t *outCount)
rtflash_reset_login_attempts_local_pin
rtflash_StatusCode rtflash_reset_login_attempts_local_pin(rtflash_Token token, rtflash_LocalPinId localPinId)
rtflash_reset_login_attempts_user
rtflash_StatusCode rtflash_reset_login_attempts_user(rtflash_Token token)
rtflash_mva_clear_all_records
rtflash_StatusCode rtflash_mva_clear_all_records(rtflash_Token token, rtflash_MvaId mvaId)
rtflash_destroy_mva_id_list
void rtflash_destroy_mva_id_list(rtflash_MvaId **mvaIds)
rtflash_get_remaining_login_attempts_local_pin
rtflash_StatusCode rtflash_get_remaining_login_attempts_local_pin(rtflash_Token token, rtflash_LocalPinId localPinId, rtflash_Attempts *outAttemptsLeft)
rtflash_login_local_pin
rtflash_StatusCode rtflash_login_local_pin(rtflash_Token token, rtflash_LocalPinId localPinId, rtflash_PinCode localPin)
rtflash_get_remaining_login_attempts_mva
rtflash_StatusCode rtflash_get_remaining_login_attempts_mva(rtflash_Token token, rtflash_MvaId mvaId, rtflash_Attempts *outAttemptsLeft)
rtflash_reset_login_attempts_mva
rtflash_StatusCode rtflash_reset_login_attempts_mva(rtflash_Token token, rtflash_MvaId mvaId)
rtflash_mva_add_record
rtflash_StatusCode rtflash_mva_add_record(rtflash_Token token, rtflash_MvaId mvaId, rtflash_MvaRecord record, rtflash_RecordId *outRecordId)
rtflash_create_mva_id_list
rtflash_StatusCode rtflash_create_mva_id_list(rtflash_Token token, rtflash_MvaId **outIds, size_t *outCount)
rtflash_create_token_list
rtflash_StatusCode rtflash_create_token_list(rtflash_TokenSerial **outTokens, size_t *outTokenCount)
rtflash_login_user
rtflash_StatusCode rtflash_login_user(rtflash_Token token, const rtflash_PinCode pin)
rtflash_add_pc_info_to_journal
rtflash_StatusCode rtflash_add_pc_info_to_journal(rtflash_Token token, rtflash_PcInfo const *pcInfo)
rtflash_mva_delete_record
rtflash_StatusCode rtflash_mva_delete_record(rtflash_Token token, rtflash_MvaId mvaId, rtflash_RecordId recordId)
rtflash_destroy_token
void rtflash_destroy_token(rtflash_Token *token)
rtflash_login_admin
rtflash_StatusCode rtflash_login_admin(rtflash_Token token, const rtflash_PinCode pin)
rtflash_MvaParams
Представляет входные параметры для создания MVA.
Definition: rtflash-types.h:186
rtflash_MvaRecord
Запись MVA - байтовая последовательность.
Definition: rtflash-types.h:42
rtflash_PcInfo
Представляет сведения о ПК пользователя для записи в журнал СБ.
Definition: rtflash-types.h:193
rtflash_Section
Представляет раздел flash-памяти токена и информацию о разделе.
Definition: rtflash-types.h:176
rtflash_String
Строка
Definition: rtflash-types.h:34
Создано системой doxygen 1.9.4