nitrokey.nk3.secrets_app

Oath Authenticator client

A CTAPHID szállításon keresztül, az egyéni szállítói parancson keresztül. Közvetlenül a CCID-n keresztül is használható.

exception nitrokey.nk3.secrets_app.SecretsAppException

Alapok: Exception

SecretsAppException(kód: str, kontextus: str)

__init__(code, context)
Paraméterek:

  • code (str)

  • context (str)

Visszatérés típusa:

None

to_id()
Visszatérés típusa:

SecretsAppExceptionID

to_string()
Visszatérés típusa:

str

code: str
context: str
exception nitrokey.nk3.secrets_app.SecretsAppHealthCheckException

Alapok: Exception

class nitrokey.nk3.secrets_app.Algorithm

Alapok: Enum

Sha1 = 1
Sha256 = 2
Sha512 = 3
class nitrokey.nk3.secrets_app.CCIDInstruction

Alapok: Enum

Select = 164
class nitrokey.nk3.secrets_app.Instruction

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

Alapok: Enum

classmethod from_attribute_byte(attribute_byte)
Paraméterek:

attribute_byte (bytes)

Visszatérés típusa:

str

classmethod from_attribute_byte_type(a)
Paraméterek:

a (int)

Visszatérés típusa:

Kind

Hmac = 64
Hotp = 16
HotpReverse = 48
NotSet = 240
Totp = 32
class nitrokey.nk3.secrets_app.ListItem

Alapok: object

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

__init__(kind, algorithm, label, properties)
Paraméterek:
Visszatérés típusa:

None

classmethod get_type_name(x)
Paraméterek:

x (Any)

Visszatérés típusa:

str

algorithm: Algorithm
kind: Kind
label: bytes
properties: ListItemProperties
class nitrokey.nk3.secrets_app.ListItemProperties

Alapok: object

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

__init__(touch_required, secret_encryption, pws_data_exist)
Paraméterek:

  • touch_required (bool)

  • secret_encryption (bool)

  • pws_data_exist (bool)

Visszatérés típusa:

None

classmethod from_byte(b)
Paraméterek:

b (int)

Visszatérés típusa:

ListItemProperties

pws_data_exist: bool
secret_encryption: bool
touch_required: bool
class nitrokey.nk3.secrets_app.PasswordSafeEntry

Alapok: object

PasswordSafeEntry(login: jelszó: Optional[bytes], password: [bytes], metadata: bájt], properties: Optional[bytes] = None, name: Optional[bytes] = None)

__init__(login, password, metadata, properties=None, name=None)
Paraméterek:

  • login (bytes | None)

  • password (bytes | None)

  • metadata (bytes | None)

  • properties (bytes | None)

  • name (bytes | None)

Visszatérés típusa:

None

tlv_encode()
Visszatérés típusa:

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

Alapok: object

RawBytes(data: list[int])

__init__(data)
Paraméterek:

data (list[int])

Visszatérés típusa:

None

data: list[int]
class nitrokey.nk3.secrets_app.SecretsApp

Alapok: object

Ez egy Secrets App kliens https://github.com/Nitrokey/trussed-secrets-app

__init__(dev, logfn=None)
Paraméterek:

  • dev (NK3)

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

calculate(cred_id, challenge=None)

Számítsa ki az OTP-kódot a cred_id nevű hitelesítő azonosítóhoz és a challenge kihíváshoz.

Paraméterek:

  • cred_id (bytes) – The name of the credential

  • challenge (int | None) – Kihívás a számításokhoz (csak TOTP). Meg kell egyeznie: időbélyeg/időszak. Az általánosan használt időszak értéke 30.

Visszatérési érték:

OTP-kód bájtkódként

Visszatérés típusa:

bytes

change_pin_raw(password, new_password)
Paraméterek:

  • password (str)

  • new_password (str)

Visszatérés típusa:

None

clear_code()

Törölje a más parancsok hitelesítéséhez használt jelszót.

Visszatérés típusa:

None

delete(cred_id)

A megadott azonosítóval rendelkező hitelesítő adatok törlése. Nem hibázik, ha az adott hitelesítő adat nem létezik. :param credid: Credential ID

Paraméterek:

cred_id (bytes)

Visszatérés típusa:

None

classmethod encode_properties_to_send(touch_button_required, pin_based_encryption, tlv=False)

A tulajdonságok struktúrájának egyetlen bájtba kódolása @param touch_button_required: szükséges-e az érintőgomb használata @param pin_based_encryption: szükséges-e a PIN-kódolás (csak a regisztráció során) @param tlv: True, ha ezt TLV-ként kell kódolni, szemben az alapértelmezett „TV”-vel, w/o L

Paraméterek:

  • touch_button_required (bool)

  • pin_based_encryption (bool)

  • tlv (bool)

Visszatérés típusa:

RawBytes

feature_active_PIN_authentication()
Visszatérés típusa:

bool

feature_challenge_response_support()
Visszatérés típusa:

bool

feature_extended_list()
Visszatérés típusa:

bool

feature_old_application_version()
Visszatérés típusa:

bool

feature_pws_support()
Visszatérés típusa:

bool

get_credential(cred_id)
Paraméterek:

cred_id (bytes)

Visszatérés típusa:

PasswordSafeEntry

get_feature_status_cached()
Visszatérés típusa:

SelectResponse

get_response_for_secret(challenge, secret)
Paraméterek:

  • challenge (bytes)

  • secret (bytes)

Visszatérés típusa:

bytes

get_secret_for_passphrase(passphrase)
Paraméterek:

passphrase (str)

Visszatérés típusa:

bytes

is_pin_healthy()
Visszatérés típusa:

bool

list(extended=False)

Visszaadja a regisztrált hitelesítő adatok listáját :return: bytestringek listája, vagy bytestringekből álló tuple, ha a „extended” kapcsoló meg van adva @deprecated

Paraméterek:

extended (bool)

Visszatérés típusa:

list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)

Visszaadja a regisztrált hitelesítő adatok listáját a tulajdonságokkal :return: ListItems listája

Paraméterek:

version (int)

Visszatérés típusa:

List[ListItem]

protocol_v2_confirm_all_requests_with_pin()
Visszatérés típusa:

bool

protocol_v3_separate_pin_and_no_pin_space()
Visszatérés típusa:

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)

Új OTP hitelesítő azonosító regisztrálása :param credid: param secret: A megosztott kulcs :param digits: Az előállított kód számjegyei :param kind: OTP-változat - HOTP vagy TOTP :param algo: A használandó hash-algoritmus - SHA1, SHA256 vagy SHA512 :param initial_counter_value: A számláló kezdeti értéke a HOTP hitelesítő adatlaphoz (csak HOTP) :param touch_button_required: A felhasználó jelenlétének megerősítése szükséges a hitelesítő okmány használatához :param pin_based_encryption: A felhasználó preferenciája a további PIN-alapú titkosításhoz :param login: Password Safe :param password: Jelszó mező a Password Safe-hoz :param metadata: metaadat mező a Password Safe számára :return: None

Paraméterek:

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

Visszatérés típusa:

None

register_yk_hmac(slot, secret)

Regisztráljon egy Yubikey-kompatibilis kihívás-válasz slotot. @param slot: kihívás-válasz slot @param secret: a titok

Paraméterek:

  • slot (int)

  • secret (bytes)

Visszatérés típusa:

None

rename_credential(cred_id, new_name)

Nevezze át a hitelesítő adatlapot. A update_credential() hívás alias neve. @param cred_id: @param new_name: A hitelesítő adatlap új azonosítója.

Paraméterek:

  • cred_id (bytes)

  • new_name (bytes)

Visszatérés típusa:

None

reset()

Minden hitelesítő adatot eltávolít az adatbázisból

Visszatérés típusa:

None

select()

SELECT parancs végrehajtása, amely adatokat szolgáltat az eszközről, beleértve a hitelesítéshez szükséges kihívást is. :return SelectResponse Status structure. A Challenge és Algorithm mezők None, ha a jelszó nincs megadva.

Visszatérés típusa:

SelectResponse

set_code(passphrase)

Állítsa be a kódot a protokollspecifikációban javasolt alapértelmezett értékekkel: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Paraméterek:

passphrase (str)

Visszatérés típusa:

None

set_code_raw(key, challenge, response)

A más parancsok hitelesítéséhez használt jelszótag beállítása vagy törlése. Nyers interfész. :param key: A PBKDF2(ID,1000) segítségével feldolgozott, az első 16 bájtra korlátozott felhasználói jelszó. :param challenge: A SELECT parancsból vett aktuális kihívás. :param response: Az ügyfél által kiszámított adatok, a helyes beállítás bizonyítékaként.

Paraméterek:

  • key (bytes)

  • challenge (bytes)

  • response (bytes)

Visszatérés típusa:

None

set_pin_raw(password)
Paraméterek:

password (str)

Visszatérés típusa:

None

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

Hitelesítési mezők frissítése - név, attribútumok és PWS-mezők. A ki nem töltött mezők nem kerülnek kódolásra és felhasználásra a frissítési folyamat során (nem változtatja meg az aktuális értéket). @param cred_id: A módosítandó hitelesítő azonosítója @param new_name: A hitelesítő új azonosítója @param login: Új login mező tartalma @param password: Új jelszó mező tartalma @param metadata: Új metaadat mező tartalma @param touch_button: Beállítja, hogy az érintőgomb használata kötelező legyen-e

Paraméterek:

  • cred_id (bytes)

  • new_name (bytes | None)

  • login (bytes | None)

  • password (bytes | None)

  • metadata (bytes | None)

  • touch_button (bool | None)

Visszatérés típusa:

None

validate(passphrase)

Authenticate using a passphrase

Paraméterek:

passphrase (str)

Visszatérés típusa:

None

validate_raw(challenge, response)

Hitelesítés jelszóval. Nyers interfész. :param challenge: A SELECT parancsból vett aktuális kihívás. :param response: A kihívás és a titok alapján kiszámított válasz.

Paraméterek:

  • challenge (bytes)

  • response (bytes)

Visszatérés típusa:

bytes

verify_code(cred_id, code)

Folytassa a bejövő OTP-kód ellenőrzését (más néven fordított HOTP). :param cred_id: A hitelesítő adat neve :param code: Az ellenőrizendő HOTP-kód. u32 ábrázolás. :return: OTPAppException hiba esetén sikertelen; True-t ad vissza, ha a kód megegyezik a belsőleg kiszámított értékkel.

Paraméterek:

  • cred_id (bytes)

  • code (int)

Visszatérés típusa:

bool

verify_pin_raw(password)
Paraméterek:

password (str)

Visszatérés típusa:

None

dev: NK3
log: Logger
logfn: Callable[[str], Any]
write_corpus_fn: Callable[[Instruction | CCIDInstruction, bytes], Any] | None
class nitrokey.nk3.secrets_app.SecretsAppExceptionID

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

Alapok: object

SelectResponse(version: bájt], pin_attempt_counter: int], salt: bájt], challenge: [bytes], algorithm: Optional[bytes], serial_number: Optional[bytes])

__init__(version, pin_attempt_counter, salt, challenge, algorithm, serial_number)
Paraméterek:

  • version (bytes | None)

  • pin_attempt_counter (int | None)

  • salt (bytes | None)

  • challenge (bytes | None)

  • algorithm (bytes | None)

  • serial_number (bytes | None)

Visszatérés típusa:

None

version_str()
Visszatérés típusa:

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

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