nitrokey.nk3.secrets_app

Oath Authenticator client

Utilizat prin intermediul transportului CTAPHID, prin comanda personalizată a furnizorului. Poate fi utilizat și direct prin CCID.

exception nitrokey.nk3.secrets_app.SecretsAppException

Bazele: Exception

SecretsAppException(cod: str, context: str)

__init__(code, context)
Parametrii:

  • code (str)

  • context (str)

Tipul întors:

None

to_id()
Tipul întors:

SecretsAppExceptionID

to_string()
Tipul întors:

str

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

Bazele: Exception

class nitrokey.nk3.secrets_app.Algorithm

Bazele: Enum

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

Bazele: Enum

Select = 164
class nitrokey.nk3.secrets_app.Instruction

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

Bazele: Enum

classmethod from_attribute_byte(attribute_byte)
Parametrii:

attribute_byte (bytes)

Tipul întors:

str

classmethod from_attribute_byte_type(a)
Parametrii:

a (int)

Tipul întors:

Kind

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

Bazele: object

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

__init__(kind, algorithm, label, properties)
Parametrii:
Tipul întors:

None

classmethod get_type_name(x)
Parametrii:

x (Any)

Tipul întors:

str

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

Bazele: object

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

__init__(touch_required, secret_encryption, pws_data_exist)
Parametrii:

  • touch_required (bool)

  • secret_encryption (bool)

  • pws_data_exist (bool)

Tipul întors:

None

classmethod from_byte(b)
Parametrii:

b (int)

Tipul întors:

ListItemProperties

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

Bazele: object

PasswordSafeEntry(login: Opțional[bytes], parolă: Optional[bytes], metadata: Optional[bytes], properties: Optional[bytes] = None, name: Optional[bytes] = None)

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

  • login (bytes | None)

  • password (bytes | None)

  • metadata (bytes | None)

  • properties (bytes | None)

  • name (bytes | None)

Tipul întors:

None

tlv_encode()
Tipul întors:

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

Bazele: object

RawBytes(date: listă[int])

__init__(data)
Parametrii:

data (list[int])

Tipul întors:

None

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

Bazele: object

Acesta este un client Secrets App https://github.com/Nitrokey/trussed-secrets-app

__init__(dev, logfn=None)
Parametrii:

  • dev (NK3)

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

calculate(cred_id, challenge=None)

Calculați codul OTP pentru acreditivul numit cred_id și cu provocarea challenge.

Parametrii:

  • cred_id (bytes) – The name of the credential

  • challenge (int | None) – Provocare pentru calcule (numai TOTP). Ar trebui să fie egală cu: timestamp/period. Valoarea perioadei utilizată în mod obișnuit este 30.

Întoarce:

Codul OTP ca șir de octeți

Tipul întors:

bytes

change_pin_raw(password, new_password)
Parametrii:

  • password (str)

  • new_password (str)

Tipul întors:

None

clear_code()

Ștergeți fraza de acces utilizată pentru autentificarea la alte comenzi.

Tipul întors:

None

delete(cred_id)

Șterge credențiala cu id-ul dat. Nu eșuează, dacă acreditivul dat nu există. :param credid: ID-ul acreditării

Parametrii:

cred_id (bytes)

Tipul întors:

None

classmethod encode_properties_to_send(touch_button_required, pin_based_encryption, tlv=False)

Codificați structura proprietăților într-un singur octet @param touch_button_required: dacă este necesară utilizarea butonului tactil @param pin_based_encryption: dacă este solicitată criptarea PIN-ului (numai în timpul înregistrării) @param tlv: setați True, dacă acest lucru ar trebui codificat ca TLV, spre deosebire de codul implicit „TV”, w/o L

Parametrii:

  • touch_button_required (bool)

  • pin_based_encryption (bool)

  • tlv (bool)

Tipul întors:

RawBytes

feature_active_PIN_authentication()
Tipul întors:

bool

feature_challenge_response_support()
Tipul întors:

bool

feature_extended_list()
Tipul întors:

bool

feature_old_application_version()
Tipul întors:

bool

feature_pws_support()
Tipul întors:

bool

get_credential(cred_id)
Parametrii:

cred_id (bytes)

Tipul întors:

PasswordSafeEntry

get_feature_status_cached()
Tipul întors:

SelectResponse

get_response_for_secret(challenge, secret)
Parametrii:

  • challenge (bytes)

  • secret (bytes)

Tipul întors:

bytes

get_secret_for_passphrase(passphrase)
Parametrii:

passphrase (str)

Tipul întors:

bytes

is_pin_healthy()
Tipul întors:

bool

list(extended=False)

Returnează o listă a acreditărilor înregistrate :return: Listă de bytestringuri sau tuple de bytestringuri, dacă se furnizează comutatorul „extended” @deprecated

Parametrii:

extended (bool)

Tipul întors:

list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)

Returnează o listă a acreditărilor înregistrate cu proprietățile :return: List of ListItems

Parametrii:

version (int)

Tipul întors:

List[ListItem]

protocol_v2_confirm_all_requests_with_pin()
Tipul întors:

bool

protocol_v3_separate_pin_and_no_pin_space()
Tipul întors:

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)

Înregistrarea unei noi acreditări OTP :param credid: ID-ul acreditării :param secret: Cheia partajată :param digits: Cifrele codului produs :param kind: OTP variant - HOTP sau TOTP :param algo: Algoritmul hash care trebuie utilizat - SHA1, SHA256 sau SHA512 :param initial_counter_value: Valoarea inițială a contorului pentru acreditivul HOTP (numai HOTP) :param touch_button_required: Confirmarea prezenței utilizatorului este necesară pentru utilizarea acestei acreditări :param pin_based_encryption: Preferința utilizatorului pentru criptare suplimentară bazată pe PIN :param login: Câmpul Login pentru Password Safe :param password: Câmpul Password pentru Password Safe :param metadata: Metadata field for Password Safe :return: Niciunul

Parametrii:

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

Tipul întors:

None

register_yk_hmac(slot, secret)

Înregistrați un slot provocare-răspuns compatibil cu Yubikey. @param slot: slot provocare-răspuns @param secret: secretul

Parametrii:

  • slot (int)

  • secret (bytes)

Tipul întors:

None

rename_credential(cred_id, new_name)

Redenumirea acreditării. Un alias pentru apelul update_credential(). @param cred_id: ID-ul acreditării de modificat @param new_name: Noul ID al acreditării

Parametrii:

  • cred_id (bytes)

  • new_name (bytes)

Tipul întors:

None

reset()

Eliminați toate acreditările din baza de date

Tipul întors:

None

select()

Execută comanda SELECT, care returnează detalii despre dispozitiv, inclusiv provocarea necesară pentru autentificare. :return SelectResponse Status structure. Câmpurile Challenge și Algorithm sunt None, dacă nu este setată fraza de acces.

Tipul întors:

SelectResponse

set_code(passphrase)

Setați codul cu valorile implicite sugerate în specificațiile protocolului: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parametrii:

passphrase (str)

Tipul întors:

None

set_code_raw(key, challenge, response)

Setează sau șterge fraza de acces utilizată pentru autentificarea la alte comenzi. Interfață brută. :param key: Fraza de acces a utilizatorului procesată prin PBKDF2(ID,1000) și limitată la primii 16 octeți. :param challenge: Provocarea curentă preluată din comanda SELECT. :param response: Datele calculate pe client, ca dovadă a unei configurări corecte.

Parametrii:

  • key (bytes)

  • challenge (bytes)

  • response (bytes)

Tipul întors:

None

set_pin_raw(password)
Parametrii:

password (str)

Tipul întors:

None

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

Actualizați câmpurile acreditării - nume, atribute și câmpuri PWS. Câmpurile necompletate nu vor fi codificate și utilizate în timpul procesului de actualizare (nu vor modifica valoarea curentă). @param cred_id: ID-ul acreditării de modificat @param new_name: Noul ID al acreditării @param login: New login field content @param password: New password field content @param metadata: New metadata field content @param touch_button: Setează dacă utilizarea butonului tactil ar trebui să fie obligatorie

Parametrii:

  • cred_id (bytes)

  • new_name (bytes | None)

  • login (bytes | None)

  • password (bytes | None)

  • metadata (bytes | None)

  • touch_button (bool | None)

Tipul întors:

None

validate(passphrase)

Authenticate using a passphrase

Parametrii:

passphrase (str)

Tipul întors:

None

validate_raw(challenge, response)

Autentificare utilizând o frază de acces. Interfață brută. :param challenge: Provocarea curentă preluată din comanda SELECT. :param response: Răspunsul calculat în funcție de provocare și de secret

Parametrii:

  • challenge (bytes)

  • response (bytes)

Tipul întors:

bytes

verify_code(cred_id, code)

Procedează la verificarea codului OTP primit (aka reverse HOTP). :param cred_id: Numele acreditării :param code: Codul HOTP de verificat. reprezentare u32. :return: eșuează cu eroarea OTPAppException; returnează True dacă codul corespunde valorii calculate intern.

Parametrii:

  • cred_id (bytes)

  • code (int)

Tipul întors:

bool

verify_pin_raw(password)
Parametrii:

password (str)

Tipul întors:

None

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

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

Bazele: object

SelectResponse(version: Optional[bytes], pin_attempt_counter: Optional[int], salt: Optional[bytes], challenge: Optional[bytes], algorithm: Optional[bytes], serial_number: Opțional[bytes])

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

  • version (bytes | None)

  • pin_attempt_counter (int | None)

  • salt (bytes | None)

  • challenge (bytes | None)

  • algorithm (bytes | None)

  • serial_number (bytes | None)

Tipul întors:

None

version_str()
Tipul întors:

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

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