nitrokey.nk3.secrets_app¶

Oath Authenticator client

Používá se prostřednictvím přenosu CTAPHID prostřednictvím vlastního příkazu dodavatele. Lze použít i přímo přes CCID.

exception nitrokey.nk3.secrets_app.SecretsAppException¶

Základy: Exception

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

__init__(code, context)¶

Parametry:

code (str)
context (str)

Typ návratové hodnoty:

None

to_id()¶

Typ návratové hodnoty:: SecretsAppExceptionID

to_string()¶

Typ návratové hodnoty:: str

code: str¶

context: str¶

exception nitrokey.nk3.secrets_app.SecretsAppHealthCheckException¶: Základy: Exception

class nitrokey.nk3.secrets_app.Algorithm¶

Základy: Enum

Sha1 = 1¶

Sha256 = 2¶

Sha512 = 3¶

class nitrokey.nk3.secrets_app.CCIDInstruction¶

Základy: Enum

Select = 164¶

class nitrokey.nk3.secrets_app.Instruction¶

Základy: 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¶

Základy: Enum

classmethod from_attribute_byte(attribute_byte)¶

Parametry:: attribute_byte (bytes)
Typ návratové hodnoty:: str

classmethod from_attribute_byte_type(a)¶

Parametry:: a (int)
Typ návratové hodnoty:: Kind

Hmac = 64¶

Hotp = 16¶

HotpReverse = 48¶

NotSet = 240¶

Totp = 32¶

class nitrokey.nk3.secrets_app.ListItem¶

Základy: object

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

__init__(kind, algorithm, label, properties)¶

Parametry:

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

Typ návratové hodnoty:

None

classmethod get_type_name(x)¶

Parametry:: x (Any)
Typ návratové hodnoty:: str

algorithm: Algorithm¶

kind: Kind¶

label: bytes¶

properties: ListItemProperties¶

class nitrokey.nk3.secrets_app.ListItemProperties¶

Základy: 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 návratové hodnoty:

None

classmethod from_byte(b)¶

Parametry:: b (int)
Typ návratové hodnoty:: ListItemProperties

pws_data_exist: bool¶

secret_encryption: bool¶

touch_required: bool¶

class nitrokey.nk3.secrets_app.PasswordSafeEntry¶

Základy: 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 návratové hodnoty:

None

tlv_encode()¶

Typ návratové hodnoty:: 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¶

Základy: object

RawBytes(data: list[int])

__init__(data)¶

Parametry:: data (list[int])
Typ návratové hodnoty:: None

data: list[int]¶

class nitrokey.nk3.secrets_app.SecretsApp¶

Základy: object

Jedná se o klienta aplikace 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)¶

Vypočítá OTP kód pro pověření s názvem cred_id a s výzvou challenge.

Parametry:

cred_id (bytes) – The name of the credential
challenge (int | None) – Výzva pro výpočty (pouze TOTP). Mělo by se rovnat: časové razítko/období. Běžně používaná hodnota periody je 30.

Vrací:

Kód OTP jako řetězec bajtů

Typ návratové hodnoty:

bytes

change_pin_raw(password, new_password)¶

Parametry:

password (str)
new_password (str)

Typ návratové hodnoty:

None

clear_code()¶

Vymazání přístupové fráze používané k ověřování jiných příkazů.

Typ návratové hodnoty:: None

delete(cred_id)¶

Odstranění pověření s daným id. Neselže, pokud dané pověření neexistuje. :param credid: ID pověření

Parametry:: cred_id (bytes)
Typ návratové hodnoty:: None

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

Zakódovat strukturu vlastností do jednoho bajtu @param touch_button_required: zda je vyžadováno použití dotykového tlačítka @param pin_based_encryption: zda je vyžadováno šifrování PIN (pouze při registraci) @param tlv: nastavit True, pokud má být kódováno jako TLV, na rozdíl od výchozího „TV“, w/o L

Parametry:

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

Typ návratové hodnoty:

RawBytes

feature_active_PIN_authentication()¶

Typ návratové hodnoty:: bool

feature_challenge_response_support()¶

Typ návratové hodnoty:: bool

feature_extended_list()¶

Typ návratové hodnoty:: bool

feature_old_application_version()¶

Typ návratové hodnoty:: bool

feature_pws_support()¶

Typ návratové hodnoty:: bool

get_credential(cred_id)¶

Parametry:: cred_id (bytes)
Typ návratové hodnoty:: PasswordSafeEntry

get_feature_status_cached()¶

Typ návratové hodnoty:: SelectResponse

get_response_for_secret(challenge, secret)¶

Parametry:

challenge (bytes)
secret (bytes)

Typ návratové hodnoty:

bytes

get_secret_for_passphrase(passphrase)¶

Parametry:: passphrase (str)
Typ návratové hodnoty:: bytes

is_pin_healthy()¶

Typ návratové hodnoty:: bool

list(extended=False)¶

Vrátit seznam registrovaných pověření :return: Seznam bytestringů nebo tuple bytestringů, pokud je zadán přepínač „extended“ @deprecated

Parametry:: extended (bool)
Typ návratové hodnoty:: list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)¶

Vrátí seznam registrovaných pověření s vlastnostmi :return: Seznam položek Seznam

Parametry:: version (int)
Typ návratové hodnoty:: List[ListItem]

protocol_v2_confirm_all_requests_with_pin()¶

Typ návratové hodnoty:: bool

protocol_v3_separate_pin_and_no_pin_space()¶

Typ návratové hodnoty:: 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)¶

Registrace nového OTP pověření :param credid: Credential ID :param secret: Sdílený klíč :param digits: Param: Cifry vytvořeného kódu :param druh: Varianta OTP - HOTP nebo TOTP :param algo: Algoritmus hašování, který se má použít - SHA1, SHA256 nebo SHA512 :param initial_counter_value: Počáteční hodnota počítadla pro HOTP pověření (pouze HOTP) :param touch_button_required: Počáteční hodnota počítadla pro HOTP pověření: Přítomnost uživatele je vyžadována pro použití tohoto Ověřovacího certifikátu :param pin_based_encryption: Uživatelská preference pro dodatečné šifrování založené na PIN :param login: Param Login: Pole hesla pro Password Safe :param password: Pole hesla pro Password Safe :param metadata: Parametr: pole metadat pro Password Safe :return: Žádné

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 návratové hodnoty:

None

register_yk_hmac(slot, secret)¶

Zaregistrujte slot pro odpovědi na výzvy kompatibilní s Yubikey. @param slot: challenge-response slot @param secret: secret

Parametry:

slot (int)
secret (bytes)

Typ návratové hodnoty:

None

rename_credential(cred_id, new_name)¶

Přejmenování pověření. Alias pro volání update_credential(). @param cred_id: ID pověření, které se má změnit @param new_name: Nové ID pověření

Parametry:

cred_id (bytes)
new_name (bytes)

Typ návratové hodnoty:

None

reset()¶

Odstranění všech pověření z databáze

Typ návratové hodnoty:: None

select()¶

Provede příkaz SELECT, který vrátí podrobnosti o zařízení, včetně výzvy potřebné pro ověření. :return SelectResponse Stavová struktura. Pole Challenge a Algorithm jsou None, pokud není nastavena přístupová fráze.

Typ návratové hodnoty:: SelectResponse

set_code(passphrase)¶

Nastavte kód s výchozími hodnotami podle specifikace protokolu: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parametry:: passphrase (str)
Typ návratové hodnoty:: None

set_code_raw(key, challenge, response)¶

Nastavení nebo vymazání přístupové fráze, která se používá k ověřování jiných příkazů. Rozhraní Raw. :param key: Uživatelská heslová fráze zpracovaná pomocí PBKDF2(ID,1000) a omezená na prvních 16 bajtů. :param challenge: Aktuální výzva převzatá z příkazu SELECT. :param response: Data vypočtená na klientovi jako důkaz správného nastavení.

Parametry:

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

Typ návratové hodnoty:

None

set_pin_raw(password)¶

Parametry:: password (str)
Typ návratové hodnoty:: None

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

Aktualizujte pole pověření - jméno, atributy a pole PWS. Nevyplněná pole nebudou při aktualizaci zakódována a použita (nezmění aktuální hodnotu). @param cred_id: ID pověření, které má být změněno @param new_name: Nové ID pověření @param login: Nový obsah pole login @param password: Nový obsah pole password @param metadata: Nový obsah pole metadat @param touch_button: Nastavit, zda má být vyžadováno použití dotykového tlačítka

Parametry:

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

Typ návratové hodnoty:

None

validate(passphrase)¶

Authenticate using a passphrase

Parametry:: passphrase (str)
Typ návratové hodnoty:: None

validate_raw(challenge, response)¶

Ověření pomocí přístupové fráze. Rozhraní Raw. :param challenge: Aktuální výzva převzatá z příkazu SELECT. :param response: Odpověď vypočtená na základě výzvy a tajného příkazu.

Parametry:

challenge (bytes)
response (bytes)

Typ návratové hodnoty:

bytes

verify_code(cred_id, code)¶

Pokračujte v ověřování příchozího OTP kódu (tzv. reverzní HOTP). :param cred_id: Název pověření :param kód: reprezentace u32. :return: selže s chybou OTPAppException; vrací True, pokud kód odpovídá interně vypočtené hodnotě.

Parametry:

cred_id (bytes)
code (int)

Typ návratové hodnoty:

bool

verify_pin_raw(password)¶

Parametry:: password (str)
Typ návratové hodnoty:: None

dev: NK3¶

log: Logger¶

logfn: Callable[[str], Any]¶

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

class nitrokey.nk3.secrets_app.SecretsAppExceptionID¶

Základy: 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¶

Základy: object

SelectResponse(verze: bytes], pin_attempt_counter: Volitelné[int], salt: Optional[bytes], challenge: Optional[bytes], algorithm: Optional[bytes], serial_number: Nepovinné[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 návratové hodnoty:

None

version_str()¶

Typ návratové hodnoty:: 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¶

Základy: 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¶