nitrokey.nk3.secrets_app¶

Oath Authenticator client

Utilizzato attraverso il trasporto CTAPHID, tramite il comando personalizzato del fornitore. Può essere utilizzato anche direttamente su CCID.

exception nitrokey.nk3.secrets_app.SecretsAppException¶

Basi: Exception

SecretsAppException(codice: str, contesto: str)

__init__(code, context)¶

Parametri:

code (str)
context (str)

Tipo di ritorno:

None

to_id()¶

Tipo di ritorno:: SecretsAppExceptionID

to_string()¶

Tipo di ritorno:: str

code: str¶

context: str¶

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

class nitrokey.nk3.secrets_app.Algorithm¶

Basi: Enum

Sha1 = 1¶

Sha256 = 2¶

Sha512 = 3¶

class nitrokey.nk3.secrets_app.CCIDInstruction¶

Basi: Enum

Select = 164¶

class nitrokey.nk3.secrets_app.Instruction¶

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

Basi: Enum

classmethod from_attribute_byte(attribute_byte)¶

Parametri:: attribute_byte (bytes)
Tipo di ritorno:: str

classmethod from_attribute_byte_type(a)¶

Parametri:: a (int)
Tipo di ritorno:: Kind

Hmac = 64¶

Hotp = 16¶

HotpReverse = 48¶

NotSet = 240¶

Totp = 32¶

class nitrokey.nk3.secrets_app.ListItem¶

Basi: object

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

__init__(kind, algorithm, label, properties)¶

Parametri:

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

Tipo di ritorno:

None

classmethod get_type_name(x)¶

Parametri:: x (Any)
Tipo di ritorno:: str

algorithm: Algorithm¶

kind: Kind¶

label: bytes¶

properties: ListItemProperties¶

class nitrokey.nk3.secrets_app.ListItemProperties¶

Basi: object

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

__init__(touch_required, secret_encryption, pws_data_exist)¶

Parametri:

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

Tipo di ritorno:

None

classmethod from_byte(b)¶

Parametri:: b (int)
Tipo di ritorno:: ListItemProperties

pws_data_exist: bool¶

secret_encryption: bool¶

touch_required: bool¶

class nitrokey.nk3.secrets_app.PasswordSafeEntry¶

Basi: object

PasswordSafeEntry(login: Opzionale[byte], password: Opzionale[byte], metadati: Opzionale[byte], proprietà: Opzionale[byte] = Nessuno, nome: Opzionale[byte] = Nessuno)

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

Parametri:

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

Tipo di ritorno:

None

tlv_encode()¶

Tipo di ritorno:: 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¶

Basi: object

RawBytes(dati: elenco[int])

__init__(data)¶

Parametri:: data (list[int])
Tipo di ritorno:: None

data: list[int]¶

class nitrokey.nk3.secrets_app.SecretsApp¶

Basi: object

Questo è un client dell’applicazione Secrets https://github.com/Nitrokey/trussed-secrets-app.

__init__(dev, logfn=None)¶

Parametri:

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

calculate(cred_id, challenge=None)¶

Calcolare il codice OTP per la credenziale denominata cred_id e con la sfida challenge.

Parametri:

cred_id (bytes) – The name of the credential
challenge (int | None) – Sfida per i calcoli (solo TOTP). Deve essere uguale a: timestamp/periodo. Il valore del periodo comunemente usato è 30.

Ritorna:

Codice OTP come stringa di byte

Tipo di ritorno:

bytes

change_pin_raw(password, new_password)¶

Parametri:

password (str)
new_password (str)

Tipo di ritorno:

None

clear_code()¶

Cancellare la passphrase utilizzata per l’autenticazione ad altri comandi.

Tipo di ritorno:: None

delete(cred_id)¶

Elimina la credenziale con l’id indicato. Non fallisce se la credenziale data non esiste. :param credid: ID della credenziale

Parametri:: cred_id (bytes)
Tipo di ritorno:: None

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

Codifica la struttura delle proprietà in un singolo byte @param touch_button_required: se è richiesto l’uso del pulsante a sfioramento @param pin_based_encryption: se è richiesta la codifica del PIN (solo durante la registrazione) @param tlv: impostare True, se questo deve essere codificato come TLV, al contrario del default «TV», senza L

Parametri:

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

Tipo di ritorno:

RawBytes

feature_active_PIN_authentication()¶

Tipo di ritorno:: bool

feature_challenge_response_support()¶

Tipo di ritorno:: bool

feature_extended_list()¶

Tipo di ritorno:: bool

feature_old_application_version()¶

Tipo di ritorno:: bool

feature_pws_support()¶

Tipo di ritorno:: bool

get_credential(cred_id)¶

Parametri:: cred_id (bytes)
Tipo di ritorno:: PasswordSafeEntry

get_feature_status_cached()¶

Tipo di ritorno:: SelectResponse

get_response_for_secret(challenge, secret)¶

Parametri:

challenge (bytes)
secret (bytes)

Tipo di ritorno:

bytes

get_secret_for_passphrase(passphrase)¶

Parametri:: passphrase (str)
Tipo di ritorno:: bytes

is_pin_healthy()¶

Tipo di ritorno:: bool

list(extended=False)¶

Restituisce un elenco delle credenziali registrate :return: Elenco di bytestring, o tupla di bytestring, se viene fornito lo switch «extended» @deprecato

Parametri:: extended (bool)
Tipo di ritorno:: list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)¶

Restituisce un elenco delle credenziali registrate con le proprietà :return: Elenco di elementi dell’elenco

Parametri:: version (int)
Tipo di ritorno:: List[ListItem]

protocol_v2_confirm_all_requests_with_pin()¶

Tipo di ritorno:: bool

protocol_v3_separate_pin_and_no_pin_space()¶

Tipo di ritorno:: 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)¶

Registra una nuova credenziale OTP :param credid: ID della credenziale :param secret: La chiave condivisa :param digits: Cifre del codice prodotto :param kind: Variante OTP - HOTP o TOTP :param algo: L’algoritmo di hash da utilizzare - SHA1, SHA256 o SHA512 :param initial_counter_value: Il valore iniziale del contatore per la credenziale HOTP (solo HOTP) :param touch_button_required: La conferma della presenza dell’utente è necessaria per utilizzare questa credenziale :param pin_based_encryption: Preferenza dell’utente per la crittografia aggiuntiva basata sul PIN :param login: Campo login per Password Safe :param password: Campo password per Password Safe :param metadata: Campo metadati per Password Safe :return: Nessuno

Parametri:

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)

Tipo di ritorno:

None

register_yk_hmac(slot, secret)¶

Registra uno slot di sfida-risposta compatibile con Yubikey. @param slot: slot di sfida-risposta @param secret: il segreto

Parametri:

slot (int)
secret (bytes)

Tipo di ritorno:

None

rename_credential(cred_id, new_name)¶

Rinomina la credenziale. Un alias per la chiamata update_credential(). @param cred_id: L’ID della credenziale da modificare @param new_name: Nuovo ID per la credenziale

Parametri:

cred_id (bytes)
new_name (bytes)

Tipo di ritorno:

None

reset()¶

Rimuovere tutte le credenziali dal database

Tipo di ritorno:: None

select()¶

Esegue il comando SELECT, che restituisce i dettagli sul dispositivo, compresa la sfida necessaria per l’autenticazione. :restituisce la struttura di stato SelectResponse. I campi Challenge e Algorithm sono None, se la passphrase non è impostata.

Tipo di ritorno:: SelectResponse

set_code(passphrase)¶

Impostare il codice con i valori predefiniti suggeriti nelle specifiche del protocollo: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parametri:: passphrase (str)
Tipo di ritorno:: None

set_code_raw(key, challenge, response)¶

Imposta o cancella la passphrase utilizzata per l’autenticazione ad altri comandi. Interfaccia grezza. :param key: La passphrase dell’utente elaborata tramite PBKDF2(ID,1000) e limitata ai primi 16 byte. :param challenge: La sfida corrente presa dal comando SELECT. :param response: I dati calcolati sul client, come prova di una configurazione corretta.

Parametri:

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

Tipo di ritorno:

None

set_pin_raw(password)¶

Parametri:: password (str)
Tipo di ritorno:: None

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

Aggiornare i campi delle credenziali: nome, attributi e campi PWS. I campi non popolati non saranno codificati e utilizzati durante il processo di aggiornamento (non cambieranno il valore corrente). @param cred_id: L’ID della credenziale da modificare @param new_name: Nuovo ID per la credenziale @param login: Nuovo contenuto del campo login @param password: Nuovo contenuto del campo password @param metadata: Nuovo contenuto del campo metadati @param touch_button: Imposta se l’uso del pulsante a sfioramento deve essere richiesto

Parametri:

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

Tipo di ritorno:

None

validate(passphrase)¶

Authenticate using a passphrase

Parametri:: passphrase (str)
Tipo di ritorno:: None

validate_raw(challenge, response)¶

Autentica utilizzando una passphrase. Interfaccia grezza. :param challenge: La sfida corrente presa dal comando SELECT. :param response: La risposta calcolata in base alla sfida e al segreto

Parametri:

challenge (bytes)
response (bytes)

Tipo di ritorno:

bytes

verify_code(cred_id, code)¶

Procede con la verifica del codice OTP in entrata (alias HOTP inverso). :param cred_id: Il nome della credenziale :param codice: Il codice HOTP da verificare. Rappresentazione u32. :return: fallisce con errore OTPAppException; restituisce True se il codice corrisponde al valore calcolato internamente.

Parametri:

cred_id (bytes)
code (int)

Tipo di ritorno:

bool

verify_pin_raw(password)¶

Parametri:: password (str)
Tipo di ritorno:: None

dev: NK3¶

log: Logger¶

logfn: Callable[[str], Any]¶

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

class nitrokey.nk3.secrets_app.SecretsAppExceptionID¶

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

Basi: object

SelectResponse(version: Opzionale[byte], pin_attempt_counter: Opzionale[int], salt: Opzionale[byte], challenge: Opzionale[byte], algoritmo: Opzionale[byte], serial_number: Opzionale[byte])

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

Parametri:

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

Tipo di ritorno:

None

version_str()¶

Tipo di ritorno:: 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¶

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