nitrokey.nk3.secrets_app

Oath Authenticator client

Uporablja se prek prenosa CTAPHID z ukazom po meri prodajalca. Uporablja se lahko tudi neposredno prek CCID.

exception nitrokey.nk3.secrets_app.SecretsAppException

Osnove: Exception

SecretsAppException(koda: str, kontekst: str)

__init__(code, context)

Parametri:

• code (str)

• context (str)

Vrne tip:

None

to_id()

Vrne tip:

SecretsAppExceptionID

to_string()

Vrne tip:

str

code: str

context: str

exception nitrokey.nk3.secrets_app.SecretsAppHealthCheckException

Osnove: Exception

class nitrokey.nk3.secrets_app.Algorithm

Osnove: Enum

Sha1 = 1

Sha256 = 2

Sha512 = 3

class nitrokey.nk3.secrets_app.CCIDInstruction

Osnove: Enum

Select = 164

class nitrokey.nk3.secrets_app.Instruction

Osnove: 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

Osnove: Enum

classmethod from_attribute_byte(attribute_byte)

Parametri:

attribute_byte (bytes)

Vrne tip:

str

classmethod from_attribute_byte_type(a)

Parametri:

a (int)

Vrne tip:

Kind

Hmac = 64

Hotp = 16

HotpReverse = 48

NotSet = 240

Totp = 32

class nitrokey.nk3.secrets_app.ListItem

Osnove: object

ListItem(kind: ‚Kind‘, algorithm: ‚Algorithm‘, label: bytes, properties: Nitrokey.nk3.secrets_app.ListItemProperties)

__init__(kind, algorithm, label, properties)

Parametri:

• kind (Kind)

• algorithm (Algorithm)

• label (bytes)

• properties (ListItemProperties)

Vrne tip:

None

classmethod get_type_name(x)

Parametri:

x (Any)

Vrne tip:

str

algorithm: Algorithm

kind: Kind

label: bytes

properties: ListItemProperties

class nitrokey.nk3.secrets_app.ListItemProperties

Osnove: object

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

__init__(touch_required, secret_encryption, pws_data_exist)

Parametri:

• touch_required (bool)

• secret_encryption (bool)

• pws_data_exist (bool)

Vrne tip:

None

classmethod from_byte(b)

Parametri:

b (int)

Vrne tip:

ListItemProperties

pws_data_exist: bool

secret_encryption: bool

touch_required: bool

class nitrokey.nk3.secrets_app.PasswordSafeEntry

Osnove: object

PasswordSafeEntry(login: [bajtov], geslo: [bajtov], metapodatki: Optional[bytes], properties: Optional[bytes] = None, name: Optional[bytes] = None)

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

Parametri:

• login (bytes | None)

• password (bytes | None)

• metadata (bytes | None)

• properties (bytes | None)

• name (bytes | None)

Vrne tip:

None

tlv_encode()

Vrne tip:

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

Osnove: object

RawBytes(podatki: seznam[int])

__init__(data)

Parametri:

data (list[int])

Vrne tip:

None

data: list[int]

class nitrokey.nk3.secrets_app.SecretsApp

Osnove: object

To je odjemalec aplikacije Secrets https://github.com/Nitrokey/trussed-secrets-app

__init__(dev, logfn=None)

Parametri:

• dev (NK3)

• logfn (Callable[[str], Any] | None)

calculate(cred_id, challenge=None)

Izračunajte kodo OTP za poverilnico z imenom cred_id in z izzivom challenge.

Parametri:

• cred_id (bytes) – The name of the credential

• challenge (int | None) – Izziv za izračune (samo TOTP). Mora biti enako: časovni žig/obdobje. Običajno uporabljena vrednost obdobja je 30.

Vrne:

Koda OTP kot niz bajtov

Vrne tip:

bytes

change_pin_raw(password, new_password)

Parametri:

• password (str)

• new_password (str)

Vrne tip:

None

clear_code()

Izbrišite geslo, ki se uporablja za preverjanje pristnosti drugih ukazov.

Vrne tip:

None

delete(cred_id)

Izbriši poverilnico z danim id. Neuspešno, če podano pooblastilo ne obstaja. :param credid: ID poverilnice

Parametri:

cred_id (bytes)

Vrne tip:

None

classmethod encode_properties_to_send(touch_button_required, pin_based_encryption, tlv=False)

Kodiranje strukture lastnosti v en bajt @param touch_button_required: ali se zahteva uporaba gumba na dotik @param pin_based_encryption: ali se zahteva šifriranje kode PIN (samo med registracijo) @param tlv: nastavi True, če naj se to kodira kot TLV, v nasprotju s privzetim „TV“, w/o L

Parametri:

• touch_button_required (bool)

• pin_based_encryption (bool)

• tlv (bool)

Vrne tip:

RawBytes

feature_active_PIN_authentication()

Vrne tip:

bool

feature_challenge_response_support()

Vrne tip:

bool

feature_extended_list()

Vrne tip:

bool

feature_old_application_version()

Vrne tip:

bool

feature_pws_support()

Vrne tip:

bool

get_credential(cred_id)

Parametri:

cred_id (bytes)

Vrne tip:

PasswordSafeEntry

get_feature_status_cached()

Vrne tip:

SelectResponse

get_response_for_secret(challenge, secret)

Parametri:

• challenge (bytes)

• secret (bytes)

Vrne tip:

bytes

get_secret_for_passphrase(passphrase)

Parametri:

passphrase (str)

Vrne tip:

bytes

is_pin_healthy()

Vrne tip:

bool

list(extended=False)

Vrnite seznam registriranih poverilnic :return: Prijava: seznam bajtnih nizov ali tuple bajtnih nizov, če je zagotovljeno stikalo „extended“ @deprecated

Parametri:

extended (bool)

Vrne tip:

list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)

Vrnite seznam registriranih poverilnic z lastnostmi :return: Seznam elementov seznama

Parametri:

version (int)

Vrne tip:

List[ListItem]

protocol_v2_confirm_all_requests_with_pin()

Vrne tip:

bool

protocol_v3_separate_pin_and_no_pin_space()

Vrne tip:

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)

Registracija novega poverilnika OTP :param credid: ID poverilnice :param secret: Ključ v skupni rabi :param digits: Param: Cifre izdelane kode :param kind: Param: Različica OTP - HOTP ali TOTP :param algo: Algoritem hash za uporabo - SHA1, SHA256 ali SHA512 :param initial_counter_value: Začetna vrednost števca za poverilnico HOTP (samo HOTP) :param touch_button_required: Za uporabo tega poverilnika je potrebna potrditev prisotnosti uporabnika :param pin_based_encryption: Uporabnikova preferenca za dodatno šifriranje na podlagi kode PIN :param login: Prijavno polje za Password Safe :param password: Polje za geslo za Password Safe :param metadata: Param: polje metapodatkov za Password Safe :return: Nič

Parametri:

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

Vrne tip:

None

register_yk_hmac(slot, secret)

Registrirajte z Yubikeyjem združljivo režo za izzive in odgovore. @param reža: reža za odgovor na izziv @param skrivnost: skrivnost

Parametri:

• slot (int)

• secret (bytes)

Vrne tip:

None

rename_credential(cred_id, new_name)

Preimenovanje poverilnice. Vzdevek za klic update_credential(). @param cred_id: ID poverilnice, ki jo želite spremeniti @param new_name: Novi ID za poverilnico

Parametri:

• cred_id (bytes)

• new_name (bytes)

Vrne tip:

None

reset()

Odstranitev vseh poverilnic iz zbirke podatkov

Vrne tip:

None

select()

Izvede ukaz SELECT, ki vrne podrobnosti o napravi, vključno z izzivom, potrebnim za preverjanje pristnosti. :return SelectResponse Statusna struktura. Polji Challenge in Algorithm sta None, če geslo ni nastavljeno.

Vrne tip:

SelectResponse

set_code(passphrase)

Nastavite kodo s privzetimi vrednostmi, kot je predlagano v specifikaciji protokola: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parametri:

passphrase (str)

Vrne tip:

None

set_code_raw(key, challenge, response)

Nastavite ali izbrišite geslo, ki se uporablja za preverjanje pristnosti drugih ukazov. Neobdelan vmesnik. :param key: Uporabniška geselska fraza, obdelana s PBKDF2(ID,1000) in omejena na prvih 16 bajtov. :param izziv: Trenutni izziv, vzet iz ukaza SELECT: Podatki, izračunani na odjemalcu, kot dokaz pravilne nastavitve.

Parametri:

• key (bytes)

• challenge (bytes)

• response (bytes)

Vrne tip:

None

set_pin_raw(password)

Parametri:

password (str)

Vrne tip:

None

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

Posodobite polja poverilnic - ime, atribute in polja PWS. Neizpolnjena polja ne bodo kodirana in uporabljena med postopkom posodabljanja (ne bodo spremenila trenutne vrednosti). @param cred_id: ID poverilnice, ki se spreminja @param new_name: Novi ID za poverilnico @param login: Nova vsebina polja za prijavo @param password: Nova vsebina polja za geslo @param metadata: Nova vsebina polja metapodatkov @param touch_button: Nastavi, ali naj bo uporaba gumba na dotik obvezna

Parametri:

• cred_id (bytes)

• new_name (bytes | None)

• login (bytes | None)

• password (bytes | None)

• metadata (bytes | None)

• touch_button (bool | None)

Vrne tip:

None

validate(passphrase)

Authenticate using a passphrase

Parametri:

passphrase (str)

Vrne tip:

None

validate_raw(challenge, response)

Preverjanje pristnosti z uporabo gesla. Neobdelan vmesnik. :param challenge: Trenutni izziv iz ukaza SELECT. :param response: odgovor, izračunan na podlagi izziva in skrivnosti.

Parametri:

• challenge (bytes)

• response (bytes)

Vrne tip:

bytes

verify_code(cred_id, code)

Nadaljujte s preverjanjem dohodne kode OTP (t. i. obratni HOTP). :param cred_id: Ime poverilnice :param koda: Koda HOTP za preverjanje. predstavitev u32. :return: neuspešen z napako OTPAppException; vrne True, če se koda ujema z interno izračunano vrednostjo.

Parametri:

• cred_id (bytes)

• code (int)

Vrne tip:

bool

verify_pin_raw(password)

Parametri:

password (str)

Vrne tip:

None

dev: NK3

log: Logger

logfn: Callable[[str], Any]

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

class nitrokey.nk3.secrets_app.SecretsAppExceptionID

Osnove: 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

Osnove: object

SelectResponse(različica: [bajtov], pin_attempt_counter: [int], salt: Neobvezno[bajtov], izziv: Neobvezno[bajtov], algoritem: Neobvezno[bajtov], serijska_številka:: algoritem: Neobvezno[bajtov], serijska_številka: [bajtov])

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

Parametri:

• version (bytes | None)

• pin_attempt_counter (int | None)

• salt (bytes | None)

• challenge (bytes | None)

• algorithm (bytes | None)

• serial_number (bytes | None)

Vrne tip:

None

version_str()

Vrne tip:

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

Osnove: 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