nitrokey.nk3.secrets_app¶

Oath Authenticator client

Используется через транспорт CTAPHID, с помощью пользовательской команды поставщика. Можно также использовать напрямую через CCID.

exception nitrokey.nk3.secrets_app.SecretsAppException¶

Базовые классы: Exception

SecretsAppException(code: str, context: str)

__init__(code, context)¶

Параметры:

code (str)
context (str)

Тип результата:

None

to_id()¶

Тип результата:: SecretsAppExceptionID

to_string()¶

Тип результата:: str

code: str¶

context: str¶

exception nitrokey.nk3.secrets_app.SecretsAppHealthCheckException¶: Базовые классы: Exception

class nitrokey.nk3.secrets_app.Algorithm¶

Базовые классы: Enum

Sha1 = 1¶

Sha256 = 2¶

Sha512 = 3¶

class nitrokey.nk3.secrets_app.CCIDInstruction¶

Базовые классы: Enum

Select = 164¶

class nitrokey.nk3.secrets_app.Instruction¶

Базовые классы: Enum

Calculate = 162¶

CalculateAll = 164¶

ChangePIN = 179¶

Delete = 2¶

GetCredential = 181¶

List = 161¶

Put = 1¶

Reset = 4¶

SendRemaining = 165¶

SetCode = 3¶

SetPIN = 180¶

UpdateCredential = 183¶

Validate = 163¶

VerifyCode = 177¶

VerifyPIN = 178¶

class nitrokey.nk3.secrets_app.Kind¶

Базовые классы: Enum

classmethod from_attribute_byte(attribute_byte)¶

Параметры:: attribute_byte (bytes)
Тип результата:: str

classmethod from_attribute_byte_type(a)¶

Параметры:: a (int)
Тип результата:: Kind

Hmac = 64¶

Hotp = 16¶

HotpReverse = 48¶

NotSet = 240¶

Totp = 32¶

class nitrokey.nk3.secrets_app.ListItem¶

Базовые классы: object

ListItem(kind: „Kind“, algorithm: „Algorithm“, label: bytes, properties: nitrokey.nk3.secrets_app.ListItemProperties)

__init__(kind, algorithm, label, properties)¶

Параметры:

kind (Kind)
algorithm (Algorithm)
label (bytes)
properties (ListItemProperties)

Тип результата:

None

classmethod get_type_name(x)¶

Параметры:: x (Any)
Тип результата:: str

algorithm: Algorithm¶

kind: Kind¶

label: bytes¶

properties: ListItemProperties¶

class nitrokey.nk3.secrets_app.ListItemProperties¶

Базовые классы: object

ListItemProperties(touch_required: bool, secret_encryption: bool, pws_data_exist: bool)

__init__(touch_required, secret_encryption, pws_data_exist)¶

Параметры:

touch_required (bool)
secret_encryption (bool)
pws_data_exist (bool)

Тип результата:

None

classmethod from_byte(b)¶

Параметры:: b (int)
Тип результата:: ListItemProperties

pws_data_exist: bool¶

secret_encryption: bool¶

touch_required: bool¶

class nitrokey.nk3.secrets_app.PasswordSafeEntry¶

Базовые классы: object

PasswordSafeEntry(login: Optional[bytes], password: Optional[bytes], metadata: Optional[bytes], properties: Optional[bytes] = None, name: Optional[bytes] = None)

__init__(login, password, metadata, properties=None, name=None)¶

Параметры:

login (bytes | None)
password (bytes | None)
metadata (bytes | None)
properties (bytes | None)
name (bytes | None)

Тип результата:

None

tlv_encode()¶

Тип результата:: list[Entry]

login: bytes | None¶

metadata: bytes | None¶

name: bytes | None = None¶

password: bytes | None¶

properties: bytes | None = None¶

class nitrokey.nk3.secrets_app.RawBytes¶

Базовые классы: object

RawBytes(data: list[int])

__init__(data)¶

Параметры:: data (list[int])
Тип результата:: None

data: list[int]¶

class nitrokey.nk3.secrets_app.SecretsApp¶

Базовые классы: object

Это клиент Secrets App https://github.com/Nitrokey/trussed-secrets-app

__init__(dev, logfn=None)¶

Параметры:

dev (NK3)
logfn (Callable[[str], Any] | None)

calculate(cred_id, challenge=None)¶

Рассчитайте код OTP для учетной записи с именем cred_id и с вызовом challenge.

Параметры:

cred_id (bytes) – The name of the credential
challenge (int | None) – Вызов для вычислений (только для TOTP). Должно быть равно: метка времени/период. Обычно используется значение периода 30.

Результат:

Код OTP в виде байтовой строки

Тип результата:

bytes

change_pin_raw(password, new_password)¶

Параметры:

password (str)
new_password (str)

Тип результата:

None

clear_code()¶

Очистите парольную фразу, используемую для аутентификации в других командах.

Тип результата:: None

delete(cred_id)¶

Удаляет учетную запись с заданным идентификатором. Не происходит сбоя, если данный мандат не существует. :param credid: ID учетной записи

Параметры:: cred_id (bytes)
Тип результата:: None

classmethod encode_properties_to_send(touch_button_required, pin_based_encryption, tlv=False)¶

Закодируйте структуру свойств в один байт @param touch_button_required: требуется ли использование сенсорной кнопки @param pin_based_encryption: запрашивается ли PIN-шифрование (только при регистрации) @param tlv: установите True, если это должно быть закодировано как TLV, в отличие от стандартного «TV», w/o L

Параметры:

touch_button_required (bool)
pin_based_encryption (bool)
tlv (bool)

Тип результата:

RawBytes

feature_active_PIN_authentication()¶

Тип результата:: bool

feature_challenge_response_support()¶

Тип результата:: bool

feature_extended_list()¶

Тип результата:: bool

feature_old_application_version()¶

Тип результата:: bool

feature_pws_support()¶

Тип результата:: bool

get_credential(cred_id)¶

Параметры:: cred_id (bytes)
Тип результата:: PasswordSafeEntry

get_feature_status_cached()¶

Тип результата:: SelectResponse

get_response_for_secret(challenge, secret)¶

Параметры:

challenge (bytes)
secret (bytes)

Тип результата:

bytes

get_secret_for_passphrase(passphrase)¶

Параметры:: passphrase (str)
Тип результата:: bytes

is_pin_healthy()¶

Тип результата:: bool

list(extended=False)¶

Возвращает список зарегистрированных учетных данных :return: Список байтовых строк или кортеж байтовых строк, если указан ключ «extended» @deprecated

Параметры:: extended (bool)
Тип результата:: list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)¶

Возвращает список зарегистрированных учетных данных со свойствами :return: Список ListItems

Параметры:: version (int)
Тип результата:: List[ListItem]

protocol_v2_confirm_all_requests_with_pin()¶

Тип результата:: bool

protocol_v3_separate_pin_and_no_pin_space()¶

Тип результата:: bool

register(credid, secret=b'00000000000000000000', digits=6, kind=Kind.NotSet, algo=Algorithm.Sha1, initial_counter_value=0, touch_button_required=False, pin_based_encryption=False, login=None, password=None, metadata=None)¶

Регистрация нового OTP-кредита :param credid: Идентификатор учетной записи :param secret: Общий ключ :param digits: Цифры произведенного кода :param kind: Вариант OTP - HOTP или TOTP :param algo: Используемый хэш-алгоритм - SHA1, SHA256 или SHA512 :param initial_counter_value: Начальное значение счетчика для HOTP-учетной записи (только для HOTP) :param touch_button_required: Требуется подтверждение присутствия пользователя для использования этой учетной записи :param pin_based_encryption: Предпочтение пользователя в отношении дополнительного шифрования на основе PIN-кода :param login: Поле логина для Password Safe :param password: Поле пароля для Password Safe :param metadata: Поле метаданных для Password Safe :return: None

Параметры:

credid (bytes)
secret (bytes)
digits (int)
kind (Kind)
algo (Algorithm)
initial_counter_value (int)
touch_button_required (bool)
pin_based_encryption (bool)
login (bytes | None)
password (bytes | None)
metadata (bytes | None)

Тип результата:

None

register_yk_hmac(slot, secret)¶

Зарегистрируйте совместимый с Yubikey слот для вызова-ответа. @param slot: слот для вызова-ответа @param secret: секрет

Параметры:

slot (int)
secret (bytes)

Тип результата:

None

rename_credential(cred_id, new_name)¶

Переименование учетной записи. Псевдоним для вызова update_credential(). @param cred_id: Идентификатор учетной записи для изменения @param new_name: Новый идентификатор учетной записи.

Параметры:

cred_id (bytes)
new_name (bytes)

Тип результата:

None

reset()¶

Удалите все учетные данные из базы данных

Тип результата:: None

select()¶

Выполнение команды SELECT, которая возвращает подробную информацию об устройстве, включая вызов, необходимый для аутентификации. :return SelectResponse Status structure. Поля Challenge и Algorithm равны None, если парольная фраза не задана.

Тип результата:: SelectResponse

set_code(passphrase)¶

Установите код по умолчанию в соответствии со спецификацией протокола: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Параметры:: passphrase (str)
Тип результата:: None

set_code_raw(key, challenge, response)¶

Установка или очистка парольной фразы, используемой для аутентификации в других командах. Необработанный интерфейс. :param key: Парольная фраза пользователя, обработанная через PBKDF2(ID,1000) и ограниченная первыми 16 байтами. :param challenge: Текущий вызов, взятый из команды SELECT. :param response: Данные, вычисленные клиентом в качестве подтверждения правильности установки.

Параметры:

key (bytes)
challenge (bytes)
response (bytes)

Тип результата:

None

set_pin_raw(password)¶

Параметры:: password (str)
Тип результата:: None

update_credential(cred_id, new_name=None, login=None, password=None, metadata=None, touch_button=None)¶

Обновление полей учетных данных - имени, атрибутов и полей PWS. Незаполненные поля не будут закодированы и использованы в процессе обновления (не изменят текущее значение). @param cred_id: ID учетной записи для изменения @param new_name: Новый ID учетной записи @param login: Содержание нового поля логина @param password: Содержание нового поля пароля @param metadata: Содержание нового поля метаданных @param touch_button: Устанавливает, должно ли быть обязательным использование сенсорной кнопки

Параметры:

cred_id (bytes)
new_name (bytes | None)
login (bytes | None)
password (bytes | None)
metadata (bytes | None)
touch_button (bool | None)

Тип результата:

None

validate(passphrase)¶

Authenticate using a passphrase

Параметры:: passphrase (str)
Тип результата:: None

validate_raw(challenge, response)¶

Аутентификация с использованием парольной фразы. Сырой интерфейс. :param challenge: текущий вызов, полученный из команды SELECT. :param response: Ответ, вычисленный в соответствии с вызовом и секретом.

Параметры:

challenge (bytes)
response (bytes)

Тип результата:

bytes

verify_code(cred_id, code)¶

Приступайте к проверке входящего OTP-кода (он же обратный HOTP). :param cred_id: Имя учетной записи :param code: Код ОТП для проверки. u32-представление. :return: проваливается с ошибкой OTPAppException; возвращает True, если код совпадает со значением, вычисленным внутренне.

Параметры:

cred_id (bytes)
code (int)

Тип результата:

bool

verify_pin_raw(password)¶

Параметры:: password (str)
Тип результата:: None

dev: NK3¶

log: Logger¶

logfn: Callable[[str], Any]¶

write_corpus_fn: Callable[[Instruction | CCIDInstruction, bytes], Any] | None¶

class nitrokey.nk3.secrets_app.SecretsAppExceptionID¶

Базовые классы: IntEnum

__new__(value)¶

ClassNotSupported = 28160¶

CommandChainingNotSupported = 26756¶

ConditionsOfUseNotSatisfied = 27013¶

FunctionNotSupported = 27265¶

IncorrectDataParameter = 27264¶

IncorrectP1OrP2Parameter = 27270¶

InstructionNotSupportedOrInvalid = 27904¶

KeyReferenceNotFound = 27272¶

LogicalChannelNotSupported = 26753¶

MoreDataAvailable = 25087¶

NotEnoughMemory = 27268¶

NotFound = 27266¶

OperationBlocked = 27011¶

SecureMessagingNotSupported = 26754¶

SecurityStatusNotSatisfied = 27010¶

Success = 36864¶

UnspecifiedCheckingError = 28416¶

UnspecifiedNonpersistentExecutionError = 25600¶

UnspecifiedPersistentExecutionError = 25856¶

VerificationFailed = 25344¶

WrongLength = 26368¶

class nitrokey.nk3.secrets_app.SelectResponse¶

Базовые классы: object

SelectResponse(version: Optional[bytes], pin_attempt_counter: Optional[int], salt: Optional[bytes], challenge: Необязательно[байты], алгоритм: Необязательно[байты], серийный_номер: Необязательно[байты])

__init__(version, pin_attempt_counter, salt, challenge, algorithm, serial_number)¶

Параметры:

version (bytes | None)
pin_attempt_counter (int | None)
salt (bytes | None)
challenge (bytes | None)
algorithm (bytes | None)
serial_number (bytes | None)

Тип результата:

None

version_str()¶

Тип результата:: str

algorithm: bytes | None¶

challenge: bytes | None¶

pin_attempt_counter: int | None¶

salt: bytes | None¶

serial_number: bytes | None¶

version: bytes | None¶

class nitrokey.nk3.secrets_app.Tag¶

Базовые классы: Enum

Algorithm = 123¶

Challenge = 116¶

CredentialId = 113¶

InitialCounter = 122¶

Key = 115¶

NameList = 114¶

NewPassword = 129¶

PINCounter = 130¶

Password = 128¶

Properties = 120¶

PwsLogin = 131¶

PwsMetadata = 133¶

PwsPassword = 132¶

Response = 117¶

SerialNumber = 143¶

Version = 121¶