nitrokey.nk3.secrets_app¶

Oath Authenticator client

Използва се чрез транспорта на CTAPHID, чрез командата за персонализиран доставчик. Може да се използва и директно през CCID.

exception nitrokey.nk3.secrets_app.SecretsAppException¶

Бази: Exception

SecretsAppException(код: str, контекст: str)

__init__(code, context)¶

Параметри:

code (str)
context (str)

Return type:

None

to_id()¶

Return type:: SecretsAppExceptionID

to_string()¶

Return type:: 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)
Return type:: str

classmethod from_attribute_byte_type(a)¶

Параметри:: a (int)
Return type:: 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)

Return type:

None

classmethod get_type_name(x)¶

Параметри:: x (Any)
Return type:: 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)

Return type:

None

classmethod from_byte(b)¶

Параметри:: b (int)
Return type:: 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)

Return type:

None

tlv_encode()¶

Return type:: 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])
Return type:: None

data: list[int]¶

class nitrokey.nk3.secrets_app.SecretsApp¶

Бази: object

Това е клиент на приложението Secrets 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.

Returns:

OTP код като низ от байтове

Return type:

bytes

change_pin_raw(password, new_password)¶

Параметри:

password (str)
new_password (str)

Return type:

None

clear_code()¶

Изчистете паролата, използвана за удостоверяване на други команди.

Return type:: None

delete(cred_id)¶

Изтриване на пълномощно с дадения id. Не се проваля, ако даденото удостоверение не съществува. :param credid: идентификатор на пълномощно

Параметри:: cred_id (bytes)
Return type:: None

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

Кодиране на структурата на свойствата в един байт @param touch_button_required: дали се изисква използването на сензорен бутон @param pin_based_encryption: дали се изисква криптиране на ПИН (само по време на регистрация) @param tlv: задайте True, ако това трябва да се кодира като TLV, за разлика от стандартното „TV“, w/o L

Параметри:

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

Return type:

RawBytes

feature_active_PIN_authentication()¶

Return type:: bool

feature_challenge_response_support()¶

Return type:: bool

feature_extended_list()¶

Return type:: bool

feature_old_application_version()¶

Return type:: bool

feature_pws_support()¶

Return type:: bool

get_credential(cred_id)¶

Параметри:: cred_id (bytes)
Return type:: PasswordSafeEntry

get_feature_status_cached()¶

Return type:: SelectResponse

get_response_for_secret(challenge, secret)¶

Параметри:

challenge (bytes)
secret (bytes)

Return type:

bytes

get_secret_for_passphrase(passphrase)¶

Параметри:: passphrase (str)
Return type:: bytes

is_pin_healthy()¶

Return type:: bool

list(extended=False)¶

Връщане на списък с регистрираните пълномощни :return: Списък от байтове или кортеж от байтове, ако е предоставен превключвател „extended“ @deprecated

Параметри:: extended (bool)
Return type:: list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)¶

Връщане на списък на регистрираните пълномощни със свойства :return: Списък на ListItems

Параметри:: version (int)
Return type:: List[ListItem]

protocol_v2_confirm_all_requests_with_pin()¶

Return type:: bool

protocol_v3_separate_pin_and_no_pin_space()¶

Return type:: 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 Credential :param credid: ID на удостоверението :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: Няма

Параметри:

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)

Return type:

None

register_yk_hmac(slot, secret)¶

Регистрирайте съвместим с Yubikey слот за предизвикателства и отговори. @param slot: слот за отговор на предизвикателство @param secret: тайната

Параметри:

slot (int)
secret (bytes)

Return type:

None

rename_credential(cred_id, new_name)¶

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

Параметри:

cred_id (bytes)
new_name (bytes)

Return type:

None

reset()¶

Премахване на всички пълномощия от базата данни

Return type:: None

select()¶

Изпълнение на командата SELECT, която връща подробна информация за устройството, включително предизвикателството, необходимо за удостоверяването. :return SelectResponse Status structure. Полетата Challenge (Предизвикателство) и Algorithm (Алгоритъм) са None (Няма), ако паролата не е зададена.

Return type:: SelectResponse

set_code(passphrase)¶

Задайте кода по подразбиране, както е предложено в спецификацията на протокола: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Параметри:: passphrase (str)
Return type:: None

set_code_raw(key, challenge, response)¶

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

Параметри:

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

Return type:

None

set_pin_raw(password)¶

Параметри:: password (str)
Return type:: 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: New login field content @param password: New password field content @param metadata: New metadata field content @param touch_button: Задайте дали използването на бутона за докосване трябва да бъде задължително

Параметри:

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

Return type:

None

validate(passphrase)¶

Authenticate using a passphrase

Параметри:: passphrase (str)
Return type:: None

validate_raw(challenge, response)¶

Удостоверяване на автентичността чрез парола. Необработен интерфейс. :param challenge: Текущото предизвикателство, взето от командата SELECT. :param response: Отговорът, изчислен спрямо предизвикателството и тайната

Параметри:

challenge (bytes)
response (bytes)

Return type:

bytes

verify_code(cred_id, code)¶

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

Параметри:

cred_id (bytes)
code (int)

Return type:

bool

verify_pin_raw(password)¶

Параметри:: password (str)
Return type:: 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(версия: Optional[bytes], pin_attempt_counter: Optional[int], salt: Optional[bytes], challenge: Optional[bytes], algorithm: Optional[bytes], serial_number: Optional[bytes])

__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)

Return type:

None

version_str()¶

Return type:: 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¶