nitrokey.nk3.secrets_app¶

Oath Authenticator client

Naudojama per CTAPHID transportą, naudojant pasirinktinio pardavėjo komandą. Galima naudoti ir tiesiogiai per CCID.

exception nitrokey.nk3.secrets_app.SecretsAppException¶

Pagrindai: Exception

SecretsAppException(kodas: str, kontekstas: str)

__init__(code, context)¶

Parametrai:

code (str)
context (str)

Grąžinamos reikšmės tipas:

None

to_id()¶

Grąžinamos reikšmės tipas:: SecretsAppExceptionID

to_string()¶

Grąžinamos reikšmės tipas:: str

code: str¶

context: str¶

exception nitrokey.nk3.secrets_app.SecretsAppHealthCheckException¶: Pagrindai: Exception

class nitrokey.nk3.secrets_app.Algorithm¶

Pagrindai: Enum

Sha1 = 1¶

Sha256 = 2¶

Sha512 = 3¶

class nitrokey.nk3.secrets_app.CCIDInstruction¶

Pagrindai: Enum

Select = 164¶

class nitrokey.nk3.secrets_app.Instruction¶

Pagrindai: 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¶

Pagrindai: Enum

classmethod from_attribute_byte(attribute_byte)¶

Parametrai:: attribute_byte (bytes)
Grąžinamos reikšmės tipas:: str

classmethod from_attribute_byte_type(a)¶

Parametrai:: a (int)
Grąžinamos reikšmės tipas:: Kind

Hmac = 64¶

Hotp = 16¶

HotpReverse = 48¶

NotSet = 240¶

Totp = 32¶

class nitrokey.nk3.secrets_app.ListItem¶

Pagrindai: object

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

__init__(kind, algorithm, label, properties)¶

Parametrai:

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

Grąžinamos reikšmės tipas:

None

classmethod get_type_name(x)¶

Parametrai:: x (Any)
Grąžinamos reikšmės tipas:: str

algorithm: Algorithm¶

kind: Kind¶

label: bytes¶

properties: ListItemProperties¶

class nitrokey.nk3.secrets_app.ListItemProperties¶

Pagrindai: object

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

__init__(touch_required, secret_encryption, pws_data_exist)¶

Parametrai:

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

Grąžinamos reikšmės tipas:

None

classmethod from_byte(b)¶

Parametrai:: b (int)
Grąžinamos reikšmės tipas:: ListItemProperties

pws_data_exist: bool¶

secret_encryption: bool¶

touch_required: bool¶

class nitrokey.nk3.secrets_app.PasswordSafeEntry¶

Pagrindai: object

PasswordSafeEntry(login: password: Neprivalomas[baitai], metaduomenys: Neprivalomas[baitai], savybės: Neprivalomas[baitų] = Nėra, pavadinimas: Neprivalomas[baitų] = Nėra)

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

Parametrai:

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

Grąžinamos reikšmės tipas:

None

tlv_encode()¶

Grąžinamos reikšmės tipas:: 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¶

Pagrindai: object

RawBytes(data: list[int])

__init__(data)¶

Parametrai:: data (list[int])
Grąžinamos reikšmės tipas:: None

data: list[int]¶

class nitrokey.nk3.secrets_app.SecretsApp¶

Pagrindai: object

Tai „Secrets App“ klientas https://github.com/Nitrokey/trussed-secrets-app

__init__(dev, logfn=None)¶

Parametrai:

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

calculate(cred_id, challenge=None)¶

Apskaičiuokite OTP kodą kredencialui, pavadintam cred_id, ir iššūkiui challenge.

Parametrai:

cred_id (bytes) – The name of the credential
challenge (int | None) – Iššūkis skaičiavimams (tik TOTP). Turėtų būti lygus: laiko žyma/laikotarpis. Dažniausiai naudojama periodo reikšmė yra 30.

Grąžinamos reikšmės:

OTP kodas kaip baitų eilutė

Grąžinamos reikšmės tipas:

bytes

change_pin_raw(password, new_password)¶

Parametrai:

password (str)
new_password (str)

Grąžinamos reikšmės tipas:

None

clear_code()¶

Išvalykite slaptažodžių frazę, naudojamą autentifikavimui prie kitų komandų.

Grąžinamos reikšmės tipas:: None

delete(cred_id)¶

Ištrinti įgaliojimą su nurodytu id. Nesuklysta, jei duotasis įgaliojimas neegzistuoja. :param credid: Įgaliojimo ID

Parametrai:: cred_id (bytes)
Grąžinamos reikšmės tipas:: None

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

Savybių struktūros kodavimas į vieną baitą @param touch_button_required: ar reikalaujama naudoti jutiklinį mygtuką @param pin_based_encryption: ar prašoma naudoti PIN kodą (tik registracijos metu) @param tlv: nustatykite True, jei tai turėtų būti koduojama kaip TLV, o ne kaip numatytasis „TV“, be L

Parametrai:

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

Grąžinamos reikšmės tipas:

RawBytes

feature_active_PIN_authentication()¶

Grąžinamos reikšmės tipas:: bool

feature_challenge_response_support()¶

Grąžinamos reikšmės tipas:: bool

feature_extended_list()¶

Grąžinamos reikšmės tipas:: bool

feature_old_application_version()¶

Grąžinamos reikšmės tipas:: bool

feature_pws_support()¶

Grąžinamos reikšmės tipas:: bool

get_credential(cred_id)¶

Parametrai:: cred_id (bytes)
Grąžinamos reikšmės tipas:: PasswordSafeEntry

get_feature_status_cached()¶

Grąžinamos reikšmės tipas:: SelectResponse

get_response_for_secret(challenge, secret)¶

Parametrai:

challenge (bytes)
secret (bytes)

Grąžinamos reikšmės tipas:

bytes

get_secret_for_passphrase(passphrase)¶

Parametrai:: passphrase (str)
Grąžinamos reikšmės tipas:: bytes

is_pin_healthy()¶

Grąžinamos reikšmės tipas:: bool

list(extended=False)¶

Grąžinti užregistruotų įgaliojimų sąrašą :return: Jei pateikiamas jungiklis „extended“, pateikiamas: @deprecated

Parametrai:: extended (bool)
Grąžinamos reikšmės tipas:: list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)¶

Grąžinti registruotų įgaliojimų sąrašą su savybėmis :return: Sąrašas ListItems

Parametrai:: version (int)
Grąžinamos reikšmės tipas:: List[ListItem]

protocol_v2_confirm_all_requests_with_pin()¶

Grąžinamos reikšmės tipas:: bool

protocol_v3_separate_pin_and_no_pin_space()¶

Grąžinamos reikšmės tipas:: 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)¶

Užregistruoti naują OTP įgaliojimą :param credid: Įgaliojimo ID :param secret: Bendrai naudojamas raktas :param skaitmenys: Skaitmenys: Sukurto kodo skaitmenys :param kind: OTP variantas - HOTP arba TOTP :param algo: Naudotinas hash algoritmas - SHA1, SHA256 arba SHA512 :param initial_counter_value: Pradinė HOTP įgaliojimo skaitiklio vertė (tik HOTP) :param touch_button_required: Naudojant šį Įgaliojimą reikalingas naudotojo buvimo patvirtinimas :param pin_based_encryption: Vartotojo pageidavimas dėl papildomo PIN kodu pagrįsto šifravimo :param login: Slaptažodžių saugyklos prisijungimo laukas :param password: Slaptažodžių saugyklos slaptažodžio laukas :param metadata: Metaduomenų laukas Password Safe :return: Parametras: None

Parametrai:

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)

Grąžinamos reikšmės tipas:

None

register_yk_hmac(slot, secret)¶

Užregistruokite su „Yubikey“ suderinamą iššūkio ir atsakymo lizdą. @param lizdas: iššūkio-atsakymo lizdas @param paslaptis: paslaptis

Parametrai:

slot (int)
secret (bytes)

Grąžinamos reikšmės tipas:

None

rename_credential(cred_id, new_name)¶

Pervadinti įgaliojimą. Kvietimo update_credential() slapyvardis. @param cred_id: Įgaliojimo ID, kurį reikia pakeisti @param new_name: Naujas įgaliojimo ID

Parametrai:

cred_id (bytes)
new_name (bytes)

Grąžinamos reikšmės tipas:

None

reset()¶

Pašalinti visus įgaliojimus iš duomenų bazės

Grąžinamos reikšmės tipas:: None

select()¶

Atlikti SELECT komandą, kuri grąžina išsamią informaciją apie įrenginį, įskaitant autentifikavimui reikalingą iššūkį. :return SelectResponse Būsenos struktūra. Iššūkio ir algoritmo laukai yra None, jei slaptoji frazė nenustatyta.

Grąžinamos reikšmės tipas:: SelectResponse

set_code(passphrase)¶

Nustatykite numatytąjį kodą, kaip siūloma protokolo specifikacijoje: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parametrai:: passphrase (str)
Grąžinamos reikšmės tipas:: None

set_code_raw(key, challenge, response)¶

Nustatykite arba ištrinkite slaptažodį, naudojamą autentiškumui patvirtinti kitose komandose. Neapdorota sąsaja. :param key: Vartotojo slaptažodis, apdorotas naudojant PBKDF2(ID,1000) ir apsiribojantis pirmaisiais 16 baitų. :param iššūkis: Dabartinis iššūkis, paimtas iš SELECT komandos. :param atsakymas: Vartotojo slaptažodis, apdorotas naudojant PBKDF2(ID,1000) ir ap Duomenys, apskaičiuoti kliento, kaip teisingos sąrankos įrodymas.

Parametrai:

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

Grąžinamos reikšmės tipas:

None

set_pin_raw(password)¶

Parametrai:: password (str)
Grąžinamos reikšmės tipas:: None

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

Atnaujinkite įgaliojimų laukus - vardą, atributus ir PWS laukus. Neužpildyti laukai nebus koduojami ir naudojami atnaujinimo proceso metu (nepakeis esamos reikšmės). @param cred_id: @param new_name: Naujas kredencialo ID @param login: Naujas kredencialo ID @param login: Naujas prisijungimo lauko turinys @param password: Naujas slaptažodžio lauko turinys @param metadata: Naujas metaduomenų lauko turinys @param touch_button: Nustatykite, ar turi būti reikalaujama naudoti jutiklinį mygtuką

Parametrai:

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

Grąžinamos reikšmės tipas:

None

validate(passphrase)¶

Authenticate using a passphrase

Parametrai:: passphrase (str)
Grąžinamos reikšmės tipas:: None

validate_raw(challenge, response)¶

Autentiškumo nustatymas naudojant slaptažodį. Neapdorota sąsaja. :param iššūkis: Dabartinis iššūkis, paimtas iš SELECT komandos. :param atsakymas: atsakymas, apskaičiuotas pagal iššūkį ir paslaptį.

Parametrai:

challenge (bytes)
response (bytes)

Grąžinamos reikšmės tipas:

bytes

verify_code(cred_id, code)¶

Tęskite įeinančio OTP kodo tikrinimą (dar žinomas kaip atvirkštinis HOTP). :param cred_id: Kreditinės kortelės pavadinimas :param kodas: u32 atvaizdavimas. :return: nepavyksta su OTPAppException klaida; grąžina True, jei kodas atitinka viduje apskaičiuotą vertę.

Parametrai:

cred_id (bytes)
code (int)

Grąžinamos reikšmės tipas:

bool

verify_pin_raw(password)¶

Parametrai:: password (str)
Grąžinamos reikšmės tipas:: None

dev: NK3¶

log: Logger¶

logfn: Callable[[str], Any]¶

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

class nitrokey.nk3.secrets_app.SecretsAppExceptionID¶

Pagrindai: 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¶

Pagrindai: object

SelectResponse(versija: (pasirinktinai[baitai]), pin_attempt_counter: Neprivalomas[int], salt: Neprivalomas[baitai], iššūkis: Neprivalomas[baitai], algoritmas:___T_Optional[baitai], algorithm: Neprivalomas[baitai], serial_number: Neprivalomas[baitai])

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

Parametrai:

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

Grąžinamos reikšmės tipas:

None

version_str()¶

Grąžinamos reikšmės tipas:: 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¶

Pagrindai: 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¶