nitrokey.nk3.secrets_app

Oath Authenticator client

Används genom CTAPHID-transport, via det anpassade leverantörskommandot. Kan även användas direkt över CCID.

exception nitrokey.nk3.secrets_app.SecretsAppException

Bas: Exception

SecretsAppException(kod: str, sammanhang: str)

__init__(code, context)
Parametrar:

  • code (str)

  • context (str)

Returtyp:

None

to_id()
Returtyp:

SecretsAppExceptionID

to_string()
Returtyp:

str

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

Bas: Exception

class nitrokey.nk3.secrets_app.Algorithm

Bas: Enum

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

Bas: Enum

Select = 164
class nitrokey.nk3.secrets_app.Instruction

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

Bas: Enum

classmethod from_attribute_byte(attribute_byte)
Parametrar:

attribute_byte (bytes)

Returtyp:

str

classmethod from_attribute_byte_type(a)
Parametrar:

a (int)

Returtyp:

Kind

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

Bas: object

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

__init__(kind, algorithm, label, properties)
Parametrar:
Returtyp:

None

classmethod get_type_name(x)
Parametrar:

x (Any)

Returtyp:

str

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

Bas: object

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

__init__(touch_required, secret_encryption, pws_data_exist)
Parametrar:

  • touch_required (bool)

  • secret_encryption (bool)

  • pws_data_exist (bool)

Returtyp:

None

classmethod from_byte(b)
Parametrar:

b (int)

Returtyp:

ListItemProperties

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

Bas: object

PasswordSafeEntry(inloggning: Valfritt[bytes], lösenord: Valfritt[bytes], metadata: Valfri[bytes], egenskaper: Optional[bytes] = None, name: Optional[bytes] = None)

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

  • login (bytes | None)

  • password (bytes | None)

  • metadata (bytes | None)

  • properties (bytes | None)

  • name (bytes | None)

Returtyp:

None

tlv_encode()
Returtyp:

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

Bas: object

RawBytes(data: lista[int])

__init__(data)
Parametrar:

data (list[int])

Returtyp:

None

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

Bas: object

Detta är en Secrets App-klient https://github.com/Nitrokey/trussed-secrets-app

__init__(dev, logfn=None)
Parametrar:

  • dev (NK3)

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

calculate(cred_id, challenge=None)

Beräkna OTP-koden för referensen med namnet cred_id och med utmaningen challenge.

Parametrar:

  • cred_id (bytes) – The name of the credential

  • challenge (int | None) – Utmaning för beräkningarna (endast TOTP). Bör vara lika med: tidsstämpel/period. Det vanligt förekommande periodvärdet är 30.

Returnerar:

OTP-kod som en byte-sträng

Returtyp:

bytes

change_pin_raw(password, new_password)
Parametrar:

  • password (str)

  • new_password (str)

Returtyp:

None

clear_code()

Rensa lösenfrasen som används för att autentisera till andra kommandon.

Returtyp:

None

delete(cred_id)

Ta bort referensen med det angivna id:et. Misslyckas inte om den angivna referensen inte finns. :param credid: ID för referensen

Parametrar:

cred_id (bytes)

Returtyp:

None

classmethod encode_properties_to_send(touch_button_required, pin_based_encryption, tlv=False)

Koda egenskapsstrukturen till en enda byte @param touch_button_required: om användning av pekknappen krävs @param pin_based_encryption: om PIN-kryptering begärs (endast under registrering) @param tlv: ange True, om detta ska kodas som TLV, i motsats till standard ”TV”, utan L

Parametrar:

  • touch_button_required (bool)

  • pin_based_encryption (bool)

  • tlv (bool)

Returtyp:

RawBytes

feature_active_PIN_authentication()
Returtyp:

bool

feature_challenge_response_support()
Returtyp:

bool

feature_extended_list()
Returtyp:

bool

feature_old_application_version()
Returtyp:

bool

feature_pws_support()
Returtyp:

bool

get_credential(cred_id)
Parametrar:

cred_id (bytes)

Returtyp:

PasswordSafeEntry

get_feature_status_cached()
Returtyp:

SelectResponse

get_response_for_secret(challenge, secret)
Parametrar:

  • challenge (bytes)

  • secret (bytes)

Returtyp:

bytes

get_secret_for_passphrase(passphrase)
Parametrar:

passphrase (str)

Returtyp:

bytes

is_pin_healthy()
Returtyp:

bool

list(extended=False)

Returnerar en lista över registrerade autentiseringsuppgifter :return: Lista över bytestringar, eller tupel av bytestringar, om ”extended”-omkopplaren tillhandahålls @deprecated

Parametrar:

extended (bool)

Returtyp:

list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)

Returnera en lista över registrerade referenser med egenskaperna :return: Lista med ListItems

Parametrar:

version (int)

Returtyp:

List[ListItem]

protocol_v2_confirm_all_requests_with_pin()
Returtyp:

bool

protocol_v3_separate_pin_and_no_pin_space()
Returtyp:

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)

Registrera ny OTP-legitimation :param credid: Credential ID :param secret: Den delade nyckeln :param digits: Siffror i den producerade koden :param kind: OTP-variant - HOTP eller TOTP :param algo: Den hashalgoritm som ska användas - SHA1, SHA256 eller SHA512 :param initial_counter_value: Räknarens initiala värde för HOTP-legitimationen (endast HOTP) :param touch_button_required: Användarens närvarobekräftelse krävs för att använda denna autentiseringsuppgift :param pin_based_encryption: Användarens preferens för ytterligare PIN-baserad kryptering :param login: Inloggningsfält för Password Safe :param password: Lösenordsfält för Password Safe :param metadata: Metadatafält för Password Safe :return: Ingen

Parametrar:

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

Returtyp:

None

register_yk_hmac(slot, secret)

Registrera en Yubikey-kompatibel utmaning-svar-plats. @param slot: utmaning-svar slot @param secret: hemligheten

Parametrar:

  • slot (int)

  • secret (bytes)

Returtyp:

None

rename_credential(cred_id, new_name)

Byter namn på referenser. Ett alias för update_credential()-anropet. @param cred_id: ID för referensen som ska ändras @param new_name: Nytt ID för referensen

Parametrar:

  • cred_id (bytes)

  • new_name (bytes)

Returtyp:

None

reset()

Ta bort alla autentiseringsuppgifter från databasen

Returtyp:

None

select()

Utför SELECT-kommandot, som returnerar information om enheten, inklusive den utmaning som behövs för autentiseringen. :return SelectResponse Statusstruktur. Fälten Challenge och Algorithm är None om lösenfrasen inte har angetts.

Returtyp:

SelectResponse

set_code(passphrase)

Ställ in koden med de standardvärden som föreslås i protokollspecifikationen: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parametrar:

passphrase (str)

Returtyp:

None

set_code_raw(key, challenge, response)

Ange eller rensa den lösenfras som används för att autentisera andra kommandon. Rått gränssnitt. :param nyckel: Användarens lösenfras som bearbetas genom PBKDF2(ID,1000) och begränsas till de första 16 bytena. :param challenge: Den aktuella utmaningen som hämtas från SELECT-kommandot. :param response: De data som beräknas på klienten, som ett bevis på en korrekt inställning.

Parametrar:

  • key (bytes)

  • challenge (bytes)

  • response (bytes)

Returtyp:

None

set_pin_raw(password)
Parametrar:

password (str)

Returtyp:

None

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

Uppdatera fält för referenser - namn, attribut och PWS-fält. Ej ifyllda fält kommer inte att kodas och användas under uppdateringsprocessen (ändrar inte det aktuella värdet). @param cred_id: Det ID för referensen som ska ändras @param new_name: Nytt ID för referensen @param login: Nytt innehåll i inloggningsfältet @param password: Nytt innehåll i lösenordsfältet @param metadata: Nytt innehåll i metadatafältet @param touch_button: Ange om det ska vara obligatoriskt att använda touch-knappen

Parametrar:

  • cred_id (bytes)

  • new_name (bytes | None)

  • login (bytes | None)

  • password (bytes | None)

  • metadata (bytes | None)

  • touch_button (bool | None)

Returtyp:

None

validate(passphrase)

Authenticate using a passphrase

Parametrar:

passphrase (str)

Returtyp:

None

validate_raw(challenge, response)

Autentisera med hjälp av en lösenfras. Raw-gränssnitt. :param challenge: Den aktuella utmaningen hämtad från SELECT-kommandot. :param response: Svaret som beräknats mot utmaningen och hemligheten

Parametrar:

  • challenge (bytes)

  • response (bytes)

Returtyp:

bytes

verify_code(cred_id, code)

Fortsätt med verifieringen av den inkommande OTP-koden (även kallad omvänd HOTP). :param cred_id: Namnet på referensen :param code: HOTP-koden som ska verifieras. u32-representation. :return: misslyckas med OTPAppException-felet; returnerar True om koden matchar det värde som beräknats internt.

Parametrar:

  • cred_id (bytes)

  • code (int)

Returtyp:

bool

verify_pin_raw(password)
Parametrar:

password (str)

Returtyp:

None

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

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

Bas: object

SelectResponse(version: Valfritt[bytes], pin_attempt_counter: Valfri[int], salt: Valfri[bytes], utmaning: Valfri[bytes], algoritm: Valfri[bytes], serienummer: Valfritt[bytes])

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

  • version (bytes | None)

  • pin_attempt_counter (int | None)

  • salt (bytes | None)

  • challenge (bytes | None)

  • algorithm (bytes | None)

  • serial_number (bytes | None)

Returtyp:

None

version_str()
Returtyp:

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

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