Rutoken Flash 2.0.1
Управление flash-памятью устройств Рутокен ЭЦП 3.0 Flash
rtflash-types.h
См. документацию.
1#ifndef RTFLASH_TYPES_H
2#define RTFLASH_TYPES_H
5#include "rtflash-macros.h"
6
7#include <stddef.h>
8#include <stdint.h>
9
10#ifdef __cplusplus
11extern "C" {
12#endif
13
14#define RTFLASH_MIN_JOURNAL_SECTION_SIZE 500
15
16#define RTFLASH_LOCAL_PIN_MAX_SIZE 32
17#define RTFLASH_LOCAL_PIN_MIN_SIZE 6
18#define RTFLASH_PIN_MAX_SIZE 249
19#define RTFLASH_MAX_LOGIN_ATTEMPT_COUNT 10
20#define RTFLASH_MIN_LOGIN_ATTEMPT_COUNT 1
21#define RTFLASH_SECT_SEC_ATTR_COUNT 6
22
23#define RTFLASH_MVA_MAX_RECORD_SIZE 249
24#define RTFLASH_MVA_MAX_RECORD_COUNT 254
25#define RTFLASH_MVA_MAX_SIZE 33020
26
27typedef uint64_t rtflash_TokenSerial;
28typedef uint8_t rtflash_RecordId;
29typedef uint8_t rtflash_SectionId;
30typedef uint32_t rtflash_MemSizeMB;
31typedef uint64_t rtflash_UnixTime;
32
34typedef struct rtflash_String {
35 size_t size;
36 const char* ptr;
37} rtflash_String;
38
39typedef rtflash_String rtflash_PinCode;
40
42typedef struct rtflash_MvaRecord {
43 size_t size;
44 const uint8_t* ptr;
45} rtflash_MvaRecord;
46
49typedef uint16_t rtflash_SecretId;
50
52typedef enum rtflash_SecretType {
53 RTFLASH_SECRET_T_NONE = 0,
54 RTFLASH_SECRET_T_MVA = 1,
55 RTFLASH_SECRET_T_LOCAL_PIN = 2,
56 RTFLASH_SECRET_T_UNKNOWN = 3
57} rtflash_SecretType;
58
60typedef enum rtflash_SecureType {
61 RTFLASH_SECURE_T_NONE = 0,
62 RTFLASH_SECURE_T_ADMIN = 1,
63 RTFLASH_SECURE_T_USER = 2,
64 RTFLASH_SECURE_T_LOCAL_PIN = 3
65} rtflash_SecureType;
66
69typedef struct rtflash_Secret {
70 rtflash_SecretId id;
71 rtflash_SecretType type;
72} rtflash_Secret;
73
75#define RTFLASH_SECRET_NONE \
76 { 0, RTFLASH_SECRET_T_NONE }
77
78#define RTFLASH_SECRET_MIN_ID 3
79#define RTFLASH_SECRET_MAX_ID 31
80#define RTFLASH_SECRET_MAX_COUNT 29
81
82typedef rtflash_SecretId rtflash_MvaId;
83typedef rtflash_SecretId rtflash_LocalPinId;
84
85#define RTFLASH_Token_NULL RTFLASH_NULL_PTR
86
87typedef struct rtflash_TokenImpl_* rtflash_Token;
88
89typedef enum rtflash_SectionType {
90 RTFLASH_SECTION_USER = 0,
91 RTFLASH_SECTION_JOURNAL_EVENTS = 1,
92 RTFLASH_SECTION_JOURNAL_ACCESS = 2,
93 RTFLASH_SECTION_ENCRYPTED = 3
94} rtflash_SectionType;
95
97typedef enum rtflash_SectionAccessState {
98 RTFLASH_SECTION_ACCESS_HI = 0,
99 RTFLASH_SECTION_ACCESS_RO = 1,
100 RTFLASH_SECTION_ACCESS_RW = 3,
101 RTFLASH_SECTION_ACCESS_CD = 5
102} rtflash_SectionAccessState;
103
105typedef enum rtflash_PrCondGlobal {
106 RTFLASH_PR_COND_GLOBAL_FORBIDDEN = 0xFF,
107 RTFLASH_PR_COND_GLOBAL_NONE = 0x00,
108 RTFLASH_PR_COND_GLOBAL_ADMIN = 0x01,
109 RTFLASH_PR_COND_GLOBAL_USER = 0x02,
110 RTFLASH_PR_COND_GLOBAL_ADMIN_OR_USER = 0x03
111} rtflash_PrCondGlobal;
112
124typedef struct rtflash_PrConds {
125 rtflash_PrCondGlobal global;
126 rtflash_Secret secret;
127} rtflash_PrConds;
128
130#define rtflash_PrConds_FORBIDDEN \
131 RTFLASH_PR_COND_GLOBAL_FORBIDDEN, RTFLASH_SECRET_NONE
132
134#define rtflash_PrConds_NONE \
135 RTFLASH_PR_COND_GLOBAL_NONE, RTFLASH_SECRET_NONE
136
138#define RTFLASH_PrConds_ADMIN_ONLY \
139 RTFLASH_PR_COND_GLOBAL_ADMIN, RTFLASH_SECRET_NONE
140
142#define RTFLASH_PrConds_USER_ONLY \
143 RTFLASH_PR_COND_GLOBAL_USER, RTFLASH_SECRET_NONE
144
146#define rtflash_PrConds_SECRET(secretId, secretType) \
147 RTFLASH_PR_COND_GLOBAL_NONE, { secretId, secretType }
148
150typedef enum rtflash_SectionSecOp {
151 RTFLASH_SECT_OP_HI_PERM = 0,
152 RTFLASH_SECT_OP_RO_TEMP = 1,
153 RTFLASH_SECT_OP_RO_PERM = 2,
154 RTFLASH_SECT_OP_RW_TEMP = 3,
155 RTFLASH_SECT_OP_RW_PERM = 4,
156 RTFLASH_SECT_OP_CD_PERM = 5
157} rtflash_SectionSecOp;
158
163typedef rtflash_PrConds rtflash_SectionSecAttrs[RTFLASH_SECT_SEC_ATTR_COUNT];
164
167#define rtflash_SectionSecAttrs_JOURNAL_DEFAULT \
168 /* HI_PERM */ { rtflash_PrConds_FORBIDDEN }, \
169 /* RO_TEMP */ { rtflash_PrConds_NONE }, \
170 /* RO_PERM */ { rtflash_PrConds_FORBIDDEN }, \
171 /* RW_TEMP */ { rtflash_PrConds_FORBIDDEN }, \
172 /* RW_PERM */ { rtflash_PrConds_FORBIDDEN }, \
173 /* CD_PERM */ { rtflash_PrConds_FORBIDDEN }
174
176typedef struct rtflash_Section {
177 rtflash_SectionId id;
178 rtflash_SectionType type;
179 rtflash_MemSizeMB size;
180 rtflash_SectionAccessState accessRights;
181 rtflash_SectionSecAttrs secAttrs;
182} rtflash_Section;
183
186typedef struct rtflash_MvaParams {
187 uint8_t maxRecordCount;
188 uint8_t maxRecordSize;
189 uint8_t maxAttemptCount;
190} rtflash_MvaParams;
191
193typedef struct rtflash_PcInfo {
194 rtflash_String userName;
195 // Если имя пользователя недоступно, необходимо передать RTFLASH_NULL_PTR.
196
197 rtflash_String domainName;
198 // Если ПК не является частью домена, необходимо передать RTFLASH_NULL_PTR.
199
200 rtflash_String osVersion;
201 // Если версия ОС недоступна, необходимо передать RTFLASH_NULL_PTR.
202
203 rtflash_String deviceName;
204 // Если имя ПК недоступно, необходимо передать RTFLASH_NULL_PTR.
205
206
207 rtflash_UnixTime systemTime;
208} rtflash_PcInfo;
209
210typedef uint16_t rtflash_Attempts;
211
212#ifdef __cplusplus
213}
214#endif
215
216#endif // RTFLASH_TYPES_H
rtflash-macros.h
Макросы
rtflash_SectionId
uint8_t rtflash_SectionId
Идентификатор раздела
Definition: rtflash-types.h:29
rtflash_SecretId
uint16_t rtflash_SecretId
Definition: rtflash-types.h:49
rtflash_SecureType
rtflash_SecureType
Тип защиты от при создании локального PIN-кода.
Definition: rtflash-types.h:60
RTFLASH_SECURE_T_USER
@ RTFLASH_SECURE_T_USER
PIN-код Пользователя
Definition: rtflash-types.h:63
RTFLASH_SECURE_T_LOCAL_PIN
@ RTFLASH_SECURE_T_LOCAL_PIN
Локальный PIN-код
Definition: rtflash-types.h:64
RTFLASH_SECURE_T_NONE
@ RTFLASH_SECURE_T_NONE
Не заданно
Definition: rtflash-types.h:61
RTFLASH_SECURE_T_ADMIN
@ RTFLASH_SECURE_T_ADMIN
PIN-код Администратора
Definition: rtflash-types.h:62
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_PcInfo
struct rtflash_PcInfo rtflash_PcInfo
Представляет сведения о ПК пользователя для записи в журнал СБ.
RTFLASH_SECT_SEC_ATTR_COUNT
#define RTFLASH_SECT_SEC_ATTR_COUNT
Количество атрибутов безопасности раздела
Definition: rtflash-types.h:21
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_UnixTime
uint64_t rtflash_UnixTime
Время в формате unix-time (неотрицательное целое число секунд с 1970.01.01.00:00:00)
Definition: rtflash-types.h:31
rtflash_PinCode
rtflash_String rtflash_PinCode
Definition: rtflash-types.h:39
rtflash_PrConds
struct rtflash_PrConds rtflash_PrConds
Условия защиты операции. Операцию можно защитить на глобальное условие защиты и/или аутентификацию по...
rtflash_MemSizeMB
uint32_t rtflash_MemSizeMB
Память в МБ
Definition: rtflash-types.h:30
rtflash_Attempts
uint16_t rtflash_Attempts
Definition: rtflash-types.h:210
rtflash_String
struct rtflash_String rtflash_String
Строка
rtflash_MvaParams
struct rtflash_MvaParams rtflash_MvaParams
Представляет входные параметры для создания MVA.
rtflash_SectionType
rtflash_SectionType
Definition: rtflash-types.h:89
RTFLASH_SECTION_ENCRYPTED
@ RTFLASH_SECTION_ENCRYPTED
Зашифрованный раздел.
Definition: rtflash-types.h:93
RTFLASH_SECTION_JOURNAL_EVENTS
@ RTFLASH_SECTION_JOURNAL_EVENTS
Журнал СБ.
Definition: rtflash-types.h:91
RTFLASH_SECTION_USER
@ RTFLASH_SECTION_USER
Пользовательский раздел.
Definition: rtflash-types.h:90
RTFLASH_SECTION_JOURNAL_ACCESS
@ RTFLASH_SECTION_JOURNAL_ACCESS
Журнал ФО.
Definition: rtflash-types.h:92
rtflash_SecretType
rtflash_SecretType
Тип секрета (rtflash_Secret).
Definition: rtflash-types.h:52
RTFLASH_SECRET_T_LOCAL_PIN
@ RTFLASH_SECRET_T_LOCAL_PIN
Локальный PIN-код
Definition: rtflash-types.h:55
RTFLASH_SECRET_T_MVA
@ RTFLASH_SECRET_T_MVA
MVA.
Definition: rtflash-types.h:54
RTFLASH_SECRET_T_UNKNOWN
@ RTFLASH_SECRET_T_UNKNOWN
Тип секрета не известен
Definition: rtflash-types.h:56
RTFLASH_SECRET_T_NONE
@ RTFLASH_SECRET_T_NONE
Тип секрета не задан
Definition: rtflash-types.h:53
rtflash_SectionAccessState
rtflash_SectionAccessState
Режим доступа к разделу.
Definition: rtflash-types.h:97
RTFLASH_SECTION_ACCESS_RW
@ RTFLASH_SECTION_ACCESS_RW
Полный доступ (чтение и запись).
Definition: rtflash-types.h:100
RTFLASH_SECTION_ACCESS_RO
@ RTFLASH_SECTION_ACCESS_RO
Только чтение.
Definition: rtflash-types.h:99
RTFLASH_SECTION_ACCESS_CD
@ RTFLASH_SECTION_ACCESS_CD
CD-ROM.
Definition: rtflash-types.h:101
RTFLASH_SECTION_ACCESS_HI
@ RTFLASH_SECTION_ACCESS_HI
Раздел скрыт.
Definition: rtflash-types.h:98
rtflash_MvaRecord
struct rtflash_MvaRecord rtflash_MvaRecord
Запись MVA - байтовая последовательность.
rtflash_PrCondGlobal
rtflash_PrCondGlobal
Глобальное условие защиты операции.
Definition: rtflash-types.h:105
RTFLASH_PR_COND_GLOBAL_USER
@ RTFLASH_PR_COND_GLOBAL_USER
Аутентификация по PIN-коду Пользователя
Definition: rtflash-types.h:109
RTFLASH_PR_COND_GLOBAL_FORBIDDEN
@ RTFLASH_PR_COND_GLOBAL_FORBIDDEN
Операция не выполнима никогда.
Definition: rtflash-types.h:106
RTFLASH_PR_COND_GLOBAL_NONE
@ RTFLASH_PR_COND_GLOBAL_NONE
Глобальное условие защиты отсутствует.
Definition: rtflash-types.h:107
RTFLASH_PR_COND_GLOBAL_ADMIN_OR_USER
@ RTFLASH_PR_COND_GLOBAL_ADMIN_OR_USER
Аутентификация по PIN-коду Администратора ИЛИ Пользователя
Definition: rtflash-types.h:110
RTFLASH_PR_COND_GLOBAL_ADMIN
@ RTFLASH_PR_COND_GLOBAL_ADMIN
Аутентификация по PIN-коду Администратора
Definition: rtflash-types.h:108
rtflash_Secret
struct rtflash_Secret rtflash_Secret
Представляет собой объект для аутентификации. Секрет - абстрактное понятие в рамках интерфейса библио...
rtflash_Section
struct rtflash_Section rtflash_Section
Представляет раздел flash-памяти токена и информацию о разделе.
rtflash_TokenSerial
uint64_t rtflash_TokenSerial
Серийный номер устройства
Definition: rtflash-types.h:27
rtflash_SectionSecAttrs
rtflash_PrConds rtflash_SectionSecAttrs[6]
Definition: rtflash-types.h:163
rtflash_SectionSecOp
rtflash_SectionSecOp
Операции смены режима доступа к разделу (защищенные операции).
Definition: rtflash-types.h:150
RTFLASH_SECT_OP_RW_PERM
@ RTFLASH_SECT_OP_RW_PERM
Чтение и запись, постоянно.
Definition: rtflash-types.h:155
RTFLASH_SECT_OP_RW_TEMP
@ RTFLASH_SECT_OP_RW_TEMP
Чтение и запись, временно.
Definition: rtflash-types.h:154
RTFLASH_SECT_OP_RO_TEMP
@ RTFLASH_SECT_OP_RO_TEMP
Только чтение, временно.
Definition: rtflash-types.h:152
RTFLASH_SECT_OP_HI_PERM
@ RTFLASH_SECT_OP_HI_PERM
Скрыт, постоянно.
Definition: rtflash-types.h:151
RTFLASH_SECT_OP_CD_PERM
@ RTFLASH_SECT_OP_CD_PERM
Режим CD-ROM, постоянно.
Definition: rtflash-types.h:156
RTFLASH_SECT_OP_RO_PERM
@ RTFLASH_SECT_OP_RO_PERM
Только чтение, постоянно.
Definition: rtflash-types.h:153
rtflash_MvaParams
Представляет входные параметры для создания MVA.
Definition: rtflash-types.h:186
rtflash_MvaParams::maxAttemptCount
uint8_t maxAttemptCount
Допустимый диапазон значений: [1, 10].
Definition: rtflash-types.h:189
rtflash_MvaParams::maxRecordSize
uint8_t maxRecordSize
Допустимый диапазон значений: [1, RTFLASH_MVA_MAX_RECORD_SIZE].
Definition: rtflash-types.h:188
rtflash_MvaParams::maxRecordCount
uint8_t maxRecordCount
Допустимый диапазон значений: [1, RTFLASH_MVA_MAX_RECORD_COUNT].
Definition: rtflash-types.h:187
rtflash_MvaRecord
Запись MVA - байтовая последовательность.
Definition: rtflash-types.h:42
rtflash_MvaRecord::size
size_t size
Размер последовательности.
Definition: rtflash-types.h:43
rtflash_MvaRecord::ptr
const uint8_t * ptr
Указатель на последовательность.
Definition: rtflash-types.h:44
rtflash_PcInfo
Представляет сведения о ПК пользователя для записи в журнал СБ.
Definition: rtflash-types.h:193
rtflash_PcInfo::domainName
rtflash_String domainName
Доменное имя ПК. Указатель на строку UTF-8, содержащую имя домена.
Definition: rtflash-types.h:197
rtflash_PcInfo::osVersion
rtflash_String osVersion
Версия операционной системы ПК. Указатель на строку UTF-8, указывающую версию ОС.
Definition: rtflash-types.h:200
rtflash_PcInfo::systemTime
rtflash_UnixTime systemTime
Системное время в формате unix-time.
Definition: rtflash-types.h:207
rtflash_PcInfo::userName
rtflash_String userName
Имя пользователя ПК. Указатель на строку UTF-8, содержащую имя пользователя.
Definition: rtflash-types.h:194
rtflash_PcInfo::deviceName
rtflash_String deviceName
Имя ПК. Указатель на строку UTF-8, содержащую имя ПК.
Definition: rtflash-types.h:203
rtflash_PrConds
Условия защиты операции. Операцию можно защитить на глобальное условие защиты и/или аутентификацию по...
Definition: rtflash-types.h:124
rtflash_PrConds::global
rtflash_PrCondGlobal global
Глобальное условие защиты.
Definition: rtflash-types.h:125
rtflash_PrConds::secret
rtflash_Secret secret
Секрет. Если secret.id = 0, то защита на секрет отсутствует.
Definition: rtflash-types.h:126
rtflash_Secret
Представляет собой объект для аутентификации. Секрет - абстрактное понятие в рамках интерфейса библио...
Definition: rtflash-types.h:69
rtflash_Secret::id
rtflash_SecretId id
Definition: rtflash-types.h:70
rtflash_Secret::type
rtflash_SecretType type
Definition: rtflash-types.h:71
rtflash_Section
Представляет раздел flash-памяти токена и информацию о разделе.
Definition: rtflash-types.h:176
rtflash_Section::accessRights
rtflash_SectionAccessState accessRights
Текущие права доступа к разделу.
Definition: rtflash-types.h:180
rtflash_Section::id
rtflash_SectionId id
Уникальный идентификатор раздела.
Definition: rtflash-types.h:177
rtflash_Section::size
rtflash_MemSizeMB size
Размер раздела в МБ.
Definition: rtflash-types.h:179
rtflash_Section::type
rtflash_SectionType type
Тип раздела.
Definition: rtflash-types.h:178
rtflash_Section::secAttrs
rtflash_SectionSecAttrs secAttrs
Атрибуты безопасности раздела.
Definition: rtflash-types.h:181
rtflash_String
Строка
Definition: rtflash-types.h:34
rtflash_String::size
size_t size
Размер строки (без учета '\0').
Definition: rtflash-types.h:35
rtflash_String::ptr
const char * ptr
Definition: rtflash-types.h:36
Создано системой doxygen 1.9.4