nitrokey.nk3.secrets_app¶

Oath Authenticator client

Gebruikt via CTAPHID transport, via het custom vendor commando. Kan ook rechtstreeks via CCID worden gebruikt.

exception nitrokey.nk3.secrets_app.SecretsAppException¶

Basisklassen: Exception

GeheimenAppExceptie(code: str, context: str)

__init__(code, context)¶

Parameters:

code (str)
context (str)

Return type:

None

to_id()¶

Return type:: SecretsAppExceptionID

to_string()¶

Return type:: str

code: str¶

context: str¶

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

class nitrokey.nk3.secrets_app.Algorithm¶

Basisklassen: Enum

Sha1 = 1¶

Sha256 = 2¶

Sha512 = 3¶

class nitrokey.nk3.secrets_app.CCIDInstruction¶

Basisklassen: Enum

Select = 164¶

class nitrokey.nk3.secrets_app.Instruction¶

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

Basisklassen: Enum

classmethod from_attribute_byte(attribute_byte)¶

Parameters:: attribute_byte (bytes)
Return type:: str

classmethod from_attribute_byte_type(a)¶

Parameters:: a (int)
Return type:: Kind

Hmac = 64¶

Hotp = 16¶

HotpReverse = 48¶

NotSet = 240¶

Totp = 32¶

class nitrokey.nk3.secrets_app.ListItem¶

Basisklassen: object

LijstItem(soort: ‘Soort’, algoritme: ‘Algoritme’, label: bytes, eigenschappen: nitrokey.nk3.secrets_app.ListItemProperties)

__init__(kind, algorithm, label, properties)¶

Parameters:

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

Return type:

None

classmethod get_type_name(x)¶

Parameters:: x (Any)
Return type:: str

algorithm: Algorithm¶

kind: Kind¶

label: bytes¶

properties: ListItemProperties¶

class nitrokey.nk3.secrets_app.ListItemProperties¶

Basisklassen: object

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

__init__(touch_required, secret_encryption, pws_data_exist)¶

Parameters:

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

Return type:

None

classmethod from_byte(b)¶

Parameters:: b (int)
Return type:: ListItemProperties

pws_data_exist: bool¶

secret_encryption: bool¶

touch_required: bool¶

class nitrokey.nk3.secrets_app.PasswordSafeEntry¶

Basisklassen: object

WachtwoordVeiligEntry(login: Optioneel[bytes], wachtwoord: Optioneel[bytes], metagegevens: Optioneel[bytes], eigenschappen: Optioneel[bytes] = Geen, naam: Optioneel[bytes] = Geen)

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

Parameters:

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

Return type:

None

tlv_encode()¶

Return type:: 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¶

Basisklassen: object

RawBytes(data: lijst[int])

__init__(data)¶

Parameters:: data (list[int])
Return type:: None

data: list[int]¶

class nitrokey.nk3.secrets_app.SecretsApp¶

Basisklassen: object

Dit is een Geheimen App-client https://github.com/Nitrokey/trussed-secrets-app

__init__(dev, logfn=None)¶

Parameters:

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

calculate(cred_id, challenge=None)¶

Bereken de OTP-code voor de credential met de naam cred_id en met uitdaging challenge.

Parameters:

cred_id (bytes) – The name of the credential
challenge (int | None) – Uitdaging voor de berekeningen (alleen TOTP). Moet gelijk zijn aan: timestamp/periode. De algemeen gebruikte periodewaarde is 30.

Returns:

OTP-code als bytestring

Return type:

bytes

change_pin_raw(password, new_password)¶

Parameters:

password (str)
new_password (str)

Return type:

None

clear_code()¶

Wis de wachtwoordzin die wordt gebruikt om te verifiëren bij andere commando’s.

Return type:: None

delete(cred_id)¶

Verwijderen van het gegeven id. Faalt niet als het gegeven credential niet bestaat. :param credid: ID van het credential

Parameters:: cred_id (bytes)
Return type:: None

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

Codeer eigenschappenstructuur in een enkele byte @param touch_button_required: of het gebruik van de aanraaktoets vereist is @param pin_based_encryption: of de PIN-encryptie vereist is (alleen tijdens registratie) @param tlv: ingesteld op True, als dit als TLV gecodeerd moet worden, in tegenstelling tot de standaard “TV”, zonder L

Parameters:

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

Return type:

RawBytes

feature_active_PIN_authentication()¶

Return type:: bool

feature_challenge_response_support()¶

Return type:: bool

feature_extended_list()¶

Return type:: bool

feature_old_application_version()¶

Return type:: bool

feature_pws_support()¶

Return type:: bool

get_credential(cred_id)¶

Parameters:: cred_id (bytes)
Return type:: PasswordSafeEntry

get_feature_status_cached()¶

Return type:: SelectResponse

get_response_for_secret(challenge, secret)¶

Parameters:

challenge (bytes)
secret (bytes)

Return type:

bytes

get_secret_for_passphrase(passphrase)¶

Parameters:: passphrase (str)
Return type:: bytes

is_pin_healthy()¶

Return type:: bool

list(extended=False)¶

Geeft een lijst met geregistreerde referenties :return: Lijst met bytestrings, of tupel van bytestrings, als de schakeloptie “extended” is opgegeven @deprecated

Parameters:: extended (bool)
Return type:: list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)¶

Geeft een lijst van de geregistreerde referenties met eigenschappen :return: Lijst met lijstitems

Parameters:: version (int)
Return type:: List[ListItem]

protocol_v2_confirm_all_requests_with_pin()¶

Return type:: bool

protocol_v3_separate_pin_and_no_pin_space()¶

Return type:: 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)¶

Nieuw OTP-credential registreren :param credid: Credential ID :param secret: De gedeelde sleutel :param digits: Cijfers van de geproduceerde code :param soort: OTP-variant - HOTP of TOTP :param algo: Het te gebruiken hash-algoritme - SHA1, SHA256 of SHA512 :param initial_counter_value: De beginwaarde van de teller voor de HOTP Credential (alleen HOTP) :param touch_button_required: Aanwezigheidsbevestiging van de gebruiker is vereist om deze Credential te gebruiken :param pin_based_encryption: Voorkeur van de gebruiker voor extra versleuteling op basis van PIN-code :param login: Aanmeldingsveld voor Password Safe :param wachtwoord: Wachtwoordveld voor Password Safe :param metadata: Metagegevensveld voor wachtwoordkluis :return: Geen

Parameters:

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)

Return type:

None

register_yk_hmac(slot, secret)¶

Registreer een Yubikey-compatibel challenge-response slot. @param slot: uitdaging-antwoord slot @param geheim: het geheim

Parameters:

slot (int)
secret (bytes)

Return type:

None

rename_credential(cred_id, new_name)¶

Inloggegevens hernoemen. Een alias voor de aanroep update_credential(). @param cred_id: De te wijzigen credential ID @param new_name: Nieuwe ID voor de credential

Parameters:

cred_id (bytes)
new_name (bytes)

Return type:

None

reset()¶

Alle referenties uit de database verwijderen

Return type:: None

select()¶

SELECT-commando uitvoeren dat details over het apparaat retourneert, inclusief de uitdaging die nodig is voor de authenticatie. :return SelectResponse Statusstructuur. De velden Challenge en Algorithm zijn Geen als de wachtwoordzin niet is ingesteld.

Return type:: SelectResponse

set_code(passphrase)¶

Stel de code in met de standaardwaarden zoals voorgesteld in de protocolspecificatie: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parameters:: passphrase (str)
Return type:: None

set_code_raw(key, challenge, response)¶

Stel de wachtwoordzin in of verwijder deze om te authenticeren naar andere commando’s. Ruwe interface. :param key: Gebruikerswachtzin verwerkt door PBKDF2(ID,1000) en beperkt tot de eerste 16 bytes. :param challenge: De huidige uitdaging uit het SELECT-commando. :param response: De gegevens die op de client worden berekend, als bewijs van een correcte opstelling.

Parameters:

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

Return type:

None

set_pin_raw(password)¶

Parameters:: password (str)
Return type:: None

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

Credential velden bijwerken - naam, attributen en PWS velden. Niet ingevulde velden worden niet gecodeerd en gebruikt tijdens het updateproces (de huidige waarde wordt niet gewijzigd). @param cred_id: De credential ID die gewijzigd moet worden @param new_name: Nieuwe ID voor de credential @param login: Inhoud van het nieuwe aanmeldingsveld @param wachtwoord: Inhoud van het nieuwe wachtwoordveld @param metadata: Nieuwe metadata veldinhoud @param touch_button: Stel in of het gebruik van de aanraakknop verplicht moet zijn

Parameters:

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

Return type:

None

validate(passphrase)¶

Authenticate using a passphrase

Parameters:: passphrase (str)
Return type:: None

validate_raw(challenge, response)¶

Authenticeren met een wachtwoordzin. Ruwe interface. :param challenge: De huidige uitdaging uit het SELECT-commando. :param response: Het antwoord berekend aan de hand van de uitdaging en het geheim

Parameters:

challenge (bytes)
response (bytes)

Return type:

bytes

verify_code(cred_id, code)¶

Ga verder met de inkomende verificatie van de OTP-code (ook wel omgekeerde HOTP genoemd). :param cred_id: De naam van het credential :param code: De te verifiëren HOTP-code. u32-weergave. :return: mislukt met OTPAppException-fout; geeft True terug als de code overeenkomt met de intern berekende waarde.

Parameters:

cred_id (bytes)
code (int)

Return type:

bool

verify_pin_raw(password)¶

Parameters:: password (str)
Return type:: None

dev: NK3¶

log: Logger¶

logfn: Callable[[str], Any]¶

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

class nitrokey.nk3.secrets_app.SecretsAppExceptionID¶

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

Basisklassen: object

SelectResponse(versie: Optioneel[bytes], pin_poging_teller: Optioneel[int], zout: Optioneel[bytes], uitdaging: Optioneel[bytes], algoritme: Optioneel[bytes], serienummer: Optioneel[bytes])

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

Parameters:

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

Return type:

None

version_str()¶

Return type:: 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¶

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