nitrokey.nk3.secrets_app

Oath Authenticator client

Używany przez transport CTAPHID, za pośrednictwem niestandardowego polecenia dostawcy. Może być również używany bezpośrednio przez CCID.

exception nitrokey.nk3.secrets_app.SecretsAppException

Klasy bazowe: Exception

SecretsAppException(code: str, context: str)

__init__(code, context)
Parametry:

  • code (str)

  • context (str)

Typ zwracany:

None

to_id()
Typ zwracany:

SecretsAppExceptionID

to_string()
Typ zwracany:

str

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

Klasy bazowe: Exception

class nitrokey.nk3.secrets_app.Algorithm

Klasy bazowe: Enum

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

Klasy bazowe: Enum

Select = 164
class nitrokey.nk3.secrets_app.Instruction

Klasy bazowe: 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

Klasy bazowe: Enum

classmethod from_attribute_byte(attribute_byte)
Parametry:

attribute_byte (bytes)

Typ zwracany:

str

classmethod from_attribute_byte_type(a)
Parametry:

a (int)

Typ zwracany:

Kind

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

Klasy bazowe: object

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

__init__(kind, algorithm, label, properties)
Parametry:
Typ zwracany:

None

classmethod get_type_name(x)
Parametry:

x (Any)

Typ zwracany:

str

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

Klasy bazowe: object

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

__init__(touch_required, secret_encryption, pws_data_exist)
Parametry:

  • touch_required (bool)

  • secret_encryption (bool)

  • pws_data_exist (bool)

Typ zwracany:

None

classmethod from_byte(b)
Parametry:

b (int)

Typ zwracany:

ListItemProperties

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

Klasy bazowe: 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)
Parametry:

  • login (bytes | None)

  • password (bytes | None)

  • metadata (bytes | None)

  • properties (bytes | None)

  • name (bytes | None)

Typ zwracany:

None

tlv_encode()
Typ zwracany:

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

Klasy bazowe: object

RawBytes(data: list[int])

__init__(data)
Parametry:

data (list[int])

Typ zwracany:

None

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

Klasy bazowe: object

To jest klient aplikacji Secrets https://github.com/Nitrokey/trussed-secrets-app.

__init__(dev, logfn=None)
Parametry:

  • dev (NK3)

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

calculate(cred_id, challenge=None)

Oblicz kod OTP dla poświadczenia o nazwie cred_id i z wyzwaniem challenge.

Parametry:

  • cred_id (bytes) – The name of the credential

  • challenge (int | None) – Wyzwanie dla obliczeń (tylko TOTP). Powinno być równe: timestamp/period. Powszechnie używaną wartością okresu jest 30.

Zwraca:

Kod OTP jako ciąg bajtów

Typ zwracany:

bytes

change_pin_raw(password, new_password)
Parametry:

  • password (str)

  • new_password (str)

Typ zwracany:

None

clear_code()

Wyczyść hasło używane do uwierzytelniania innych poleceń.

Typ zwracany:

None

delete(cred_id)

Usuwa poświadczenie o podanym identyfikatorze. Nie powiedzie się, jeśli podane poświadczenie nie istnieje :param credid: Identyfikator poświadczenia

Parametry:

cred_id (bytes)

Typ zwracany:

None

classmethod encode_properties_to_send(touch_button_required, pin_based_encryption, tlv=False)

Koduj strukturę właściwości do pojedynczego bajtu @param touch_button_required: czy wymagane jest użycie przycisku dotykowego @param pin_based_encryption: czy wymagane jest szyfrowanie PIN (tylko podczas rejestracji) @param tlv: ustaw True, jeśli ma to być zakodowane jako TLV, w przeciwieństwie do domyślnego „TV”, bez L

Parametry:

  • touch_button_required (bool)

  • pin_based_encryption (bool)

  • tlv (bool)

Typ zwracany:

RawBytes

feature_active_PIN_authentication()
Typ zwracany:

bool

feature_challenge_response_support()
Typ zwracany:

bool

feature_extended_list()
Typ zwracany:

bool

feature_old_application_version()
Typ zwracany:

bool

feature_pws_support()
Typ zwracany:

bool

get_credential(cred_id)
Parametry:

cred_id (bytes)

Typ zwracany:

PasswordSafeEntry

get_feature_status_cached()
Typ zwracany:

SelectResponse

get_response_for_secret(challenge, secret)
Parametry:

  • challenge (bytes)

  • secret (bytes)

Typ zwracany:

bytes

get_secret_for_passphrase(passphrase)
Parametry:

passphrase (str)

Typ zwracany:

bytes

is_pin_healthy()
Typ zwracany:

bool

list(extended=False)

Zwraca listę zarejestrowanych poświadczeń :return: List of bytestrings, or tuple of bytestrings, if „extended” switch is provided @deprecated

Parametry:

extended (bool)

Typ zwracany:

list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)

Zwraca listę zarejestrowanych poświadczeń z właściwościami :return: List of ListItems

Parametry:

version (int)

Typ zwracany:

List[ListItem]

protocol_v2_confirm_all_requests_with_pin()
Typ zwracany:

bool

protocol_v3_separate_pin_and_no_pin_space()
Typ zwracany:

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)

Register new OTP Credential :param credid: Identyfikator poświadczenia :param secret: Klucz współdzielony :param digits: Digits of the produced code :param kind: OTP variant - HOTP or TOTP :param algo: The hash algorithm to use - SHA1, SHA256 or SHA512 :param initial_counter_value: Początkowa wartość licznika dla HOTP Credential (tylko HOTP) :param touch_button_required: Potwierdzenie obecności użytkownika jest wymagane do użycia tego poświadczenia :param pin_based_encryption: Preferencje użytkownika dotyczące dodatkowego szyfrowania opartego na kodzie PIN :param login: Pole logowania dla Password Safe :param password: Pole hasła dla Password Safe :param metadata: Pole metadanych dla Password Safe :return: None

Parametry:

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

Typ zwracany:

None

register_yk_hmac(slot, secret)

Zarejestruj gniazdo odpowiedzi na wyzwanie kompatybilne z Yubikey. @param slot: slot odpowiedzi na wyzwanie @param secret: sekret

Parametry:

  • slot (int)

  • secret (bytes)

Typ zwracany:

None

rename_credential(cred_id, new_name)

Zmiana nazwy poświadczenia. Alias dla wywołania update_credential(). @param cred_id: Identyfikator poświadczenia do modyfikacji @param new_name: Nowy identyfikator poświadczenia

Parametry:

  • cred_id (bytes)

  • new_name (bytes)

Typ zwracany:

None

reset()

Usunięcie wszystkich danych uwierzytelniających z bazy danych

Typ zwracany:

None

select()

Wykonuje polecenie SELECT, które zwraca szczegółowe informacje o urządzeniu, w tym wyzwanie wymagane do uwierzytelnienia. zwraca strukturę stanu SelectResponse. Pola Challenge i Algorithm mają wartość None, jeśli nie ustawiono hasła.

Typ zwracany:

SelectResponse

set_code(passphrase)

Ustaw kod z wartościami domyślnymi sugerowanymi w specyfikacji protokołu: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parametry:

passphrase (str)

Typ zwracany:

None

set_code_raw(key, challenge, response)

Ustawia lub usuwa hasło używane do uwierzytelniania innych poleceń. Surowy interfejs. :param key: Hasło użytkownika przetworzone przez PBKDF2(ID,1000) i ograniczone do pierwszych 16 bajtów. :param challenge: Bieżące wyzwanie pobrane z polecenia SELECT. :param response: Dane obliczone na kliencie, jako dowód poprawnej konfiguracji.

Parametry:

  • key (bytes)

  • challenge (bytes)

  • response (bytes)

Typ zwracany:

None

set_pin_raw(password)
Parametry:

password (str)

Typ zwracany:

None

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

Aktualizacja pól poświadczeń - nazwy, atrybutów i pól PWS. Niewypełnione pola nie będą kodowane i używane podczas procesu aktualizacji (nie zmienią bieżącej wartości). @param cred_id: Identyfikator poświadczenia do modyfikacji @param new_name: Nowy identyfikator poświadczenia @param login: Nowa zawartość pola logowania @param password: Nowa zawartość pola hasła @param metadata: Nowa zawartość pola metadanych @param touch_button: Ustawia, czy użycie przycisku dotykowego powinno być wymagane

Parametry:

  • cred_id (bytes)

  • new_name (bytes | None)

  • login (bytes | None)

  • password (bytes | None)

  • metadata (bytes | None)

  • touch_button (bool | None)

Typ zwracany:

None

validate(passphrase)

Authenticate using a passphrase

Parametry:

passphrase (str)

Typ zwracany:

None

validate_raw(challenge, response)

Uwierzytelnianie przy użyciu hasła. Surowy interfejs. :param challenge: Bieżące wyzwanie pobrane z polecenia SELECT. :param response: Odpowiedź obliczona na podstawie wyzwania i hasła tajnego

Parametry:

  • challenge (bytes)

  • response (bytes)

Typ zwracany:

bytes

verify_code(cred_id, code)

Kontynuuj weryfikację przychodzącego kodu OTP (aka odwrotne HOTP). :param cred_id: Nazwa poświadczenia :param code: Kod HOTP do weryfikacji. reprezentacja u32. :return: nie powiedzie się z błędem OTPAppException; zwraca True, jeśli kod pasuje do wartości obliczonej wewnętrznie.

Parametry:

  • cred_id (bytes)

  • code (int)

Typ zwracany:

bool

verify_pin_raw(password)
Parametry:

password (str)

Typ zwracany:

None

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

Klasy bazowe: 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

Klasy bazowe: object

SelectResponse(version: 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)
Parametry:

  • version (bytes | None)

  • pin_attempt_counter (int | None)

  • salt (bytes | None)

  • challenge (bytes | None)

  • algorithm (bytes | None)

  • serial_number (bytes | None)

Typ zwracany:

None

version_str()
Typ zwracany:

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

Klasy bazowe: 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