nitrokey.nk3.secrets_app

Oath Authenticator client

Kasutatakse CTAPHIDi transpordi kaudu, kohandatud müüja käsu kaudu. Võib kasutada ka otse CCID kaudu.

exception nitrokey.nk3.secrets_app.SecretsAppException

Põlvnemine: Exception

SecretsAppException(kood: str, kontekst: str)

__init__(code, context)
Parameetrid:

  • code (str)

  • context (str)

Tagastustüüp:

None

to_id()
Tagastustüüp:

SecretsAppExceptionID

to_string()
Tagastustüüp:

str

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

Põlvnemine: Exception

class nitrokey.nk3.secrets_app.Algorithm

Põlvnemine: Enum

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

Põlvnemine: Enum

Select = 164
class nitrokey.nk3.secrets_app.Instruction

Põlvnemine: 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

Põlvnemine: Enum

classmethod from_attribute_byte(attribute_byte)
Parameetrid:

attribute_byte (bytes)

Tagastustüüp:

str

classmethod from_attribute_byte_type(a)
Parameetrid:

a (int)

Tagastustüüp:

Kind

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

Põlvnemine: object

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

__init__(kind, algorithm, label, properties)
Parameetrid:
Tagastustüüp:

None

classmethod get_type_name(x)
Parameetrid:

x (Any)

Tagastustüüp:

str

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

Põlvnemine: object

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

__init__(touch_required, secret_encryption, pws_data_exist)
Parameetrid:

  • touch_required (bool)

  • secret_encryption (bool)

  • pws_data_exist (bool)

Tagastustüüp:

None

classmethod from_byte(b)
Parameetrid:

b (int)

Tagastustüüp:

ListItemProperties

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

Põlvnemine: object

PasswordSafeEntry(login: Password: Optional[bytes], password: [bait], metadata: baitid], properties: Optional[bytes] = None, name: Optional[bytes] = None)

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

  • login (bytes | None)

  • password (bytes | None)

  • metadata (bytes | None)

  • properties (bytes | None)

  • name (bytes | None)

Tagastustüüp:

None

tlv_encode()
Tagastustüüp:

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

Põlvnemine: object

RawBytes(data: list[int])

__init__(data)
Parameetrid:

data (list[int])

Tagastustüüp:

None

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

Põlvnemine: object

See on Secrets App klient https://github.com/Nitrokey/trussed-secrets-app

__init__(dev, logfn=None)
Parameetrid:

  • dev (NK3)

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

calculate(cred_id, challenge=None)

Arvutab OTP-koodi mandaadi nimega cred_id ja väljakutse challenge jaoks.

Parameetrid:

  • cred_id (bytes) – The name of the credential

  • challenge (int | None) – Väljakutse arvutuste jaoks (ainult TOTP). Peaks olema võrdne: ajatempel/periood. Tavaliselt kasutatav perioodi väärtus on 30.

Tagastab:

OTP-kood baitide kaupa

Tagastustüüp:

bytes

change_pin_raw(password, new_password)
Parameetrid:

  • password (str)

  • new_password (str)

Tagastustüüp:

None

clear_code()

Tühjendage teiste käskude autentimiseks kasutatav salasõna.

Tagastustüüp:

None

delete(cred_id)

Kustutab antud id-ga volikirja. Ei ebaõnnestu, kui antud volikirja ei ole olemas. :param credid: Credential ID

Parameetrid:

cred_id (bytes)

Tagastustüüp:

None

classmethod encode_properties_to_send(touch_button_required, pin_based_encryption, tlv=False)

Kodeerib omaduste struktuuri üheks baidiks @param touch_button_required: kas puudutusnupu kasutamine on nõutav @param pin_based_encryption: kas PIN-krüpteerimist nõutakse (ainult registreerimise ajal) @param tlv: määrata True, kui see peaks olema kodeeritud TLV-na, erinevalt vaikimisi „TV“, w/o L

Parameetrid:

  • touch_button_required (bool)

  • pin_based_encryption (bool)

  • tlv (bool)

Tagastustüüp:

RawBytes

feature_active_PIN_authentication()
Tagastustüüp:

bool

feature_challenge_response_support()
Tagastustüüp:

bool

feature_extended_list()
Tagastustüüp:

bool

feature_old_application_version()
Tagastustüüp:

bool

feature_pws_support()
Tagastustüüp:

bool

get_credential(cred_id)
Parameetrid:

cred_id (bytes)

Tagastustüüp:

PasswordSafeEntry

get_feature_status_cached()
Tagastustüüp:

SelectResponse

get_response_for_secret(challenge, secret)
Parameetrid:

  • challenge (bytes)

  • secret (bytes)

Tagastustüüp:

bytes

get_secret_for_passphrase(passphrase)
Parameetrid:

passphrase (str)

Tagastustüüp:

bytes

is_pin_healthy()
Tagastustüüp:

bool

list(extended=False)

Tagastab registreeritud volituste nimekirja :return: Kui on esitatud lüliti „extended“, siis on see loend @deprecated.

Parameetrid:

extended (bool)

Tagastustüüp:

list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)

Tagastab nimekirja registreeritud volikirjadest koos omadustega :return: List of ListItems

Parameetrid:

version (int)

Tagastustüüp:

List[ListItem]

protocol_v2_confirm_all_requests_with_pin()
Tagastustüüp:

bool

protocol_v3_separate_pin_and_no_pin_space()
Tagastustüüp:

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)

Registreerib uue OTP-volituse :param credid: :param secret: Jagatud võti :param digits: Toodud koodi numbrid :param kind: OTP variant - HOTP või TOTP :param algo: kasutatav hash-algoritm - SHA1, SHA256 või SHA512 :param initial_counter_value: Loenduri algväärtus HOTP-volituse jaoks (ainult HOTP) :param touch_button_required: Selle mandaadi kasutamiseks on vaja kasutaja kohaloleku kinnitust :param pin_based_encryption: Kasutaja eelistus täiendava PIN-põhise krüpteerimise jaoks :param login: Parameeter: Parool: Parooli väli Password Safe jaoks :param metadata: Metaandmete väli Password Safe jaoks :return: None

Parameetrid:

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

Tagastustüüp:

None

register_yk_hmac(slot, secret)

Registreerige Yubikey-ühilduv väljakutse-vastuse pesa. @param slot: challenge-response slot @param secret: saladus

Parameetrid:

  • slot (int)

  • secret (bytes)

Tagastustüüp:

None

rename_credential(cred_id, new_name)

Nimetage volitused ümber. Pseudonimi update_credential() kutsele. @param cred_id: @param new_name: volikirja uus ID, mida muuta @param new_name: volikirja uus ID.

Parameetrid:

  • cred_id (bytes)

  • new_name (bytes)

Tagastustüüp:

None

reset()

Eemaldage kõik volitused andmebaasist

Tagastustüüp:

None

select()

Käsu SELECT täitmine, mis tagastab andmed seadme kohta, sealhulgas autentimiseks vajaliku väljakutse. :return SelectResponse Status structure. Väljad Challenge ja Algorithm on None, kui salasõna ei ole määratud.

Tagastustüüp:

SelectResponse

set_code(passphrase)

Määrake kood vaikimisi, nagu on soovitatud protokolli spetsifikatsioonis: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parameetrid:

passphrase (str)

Tagastustüüp:

None

set_code_raw(key, challenge, response)

Määrake või tühjendage teiste käskude autentimiseks kasutatav salasõna. Toorliides. :param key: Kasutaja tunnussõna, mida töödeldakse PBKDF2(ID,1000) kaudu ja mis on piiratud esimese 16 baidiga. :param challenge: Praegune väljakutse, mis on võetud käsuga SELECT. :param response: Kliendi poolt arvutatud andmed, mis on tõendiks korrektsest seadistamisest.

Parameetrid:

  • key (bytes)

  • challenge (bytes)

  • response (bytes)

Tagastustüüp:

None

set_pin_raw(password)
Parameetrid:

password (str)

Tagastustüüp:

None

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

Volituste väljad - nimi, atribuudid ja PWS-väljad - ajakohastatakse. Täitmata väljad ei kodeerita ja neid ei kasutata uuendamise käigus (ei muuda praegust väärtust). @param cred_id: Muudetava mandaadi ID @param new_name: mandaadi uus ID @param login: Uue sisselogimisvälja sisu @param password: Uue paroolivälja sisu @param metadata: Uus metaandmete välja sisu @param touch_button: Määra, kas puutenupu kasutamine peaks olema kohustuslik

Parameetrid:

  • cred_id (bytes)

  • new_name (bytes | None)

  • login (bytes | None)

  • password (bytes | None)

  • metadata (bytes | None)

  • touch_button (bool | None)

Tagastustüüp:

None

validate(passphrase)

Authenticate using a passphrase

Parameetrid:

passphrase (str)

Tagastustüüp:

None

validate_raw(challenge, response)

Autentimine paroolifraasi abil. Toorliides. :param challenge: Praegune väljakutse, mis on võetud SELECT-komandost. :param response: Vastus, mis on arvutatud väljakutse ja saladuse alusel.

Parameetrid:

  • challenge (bytes)

  • response (bytes)

Tagastustüüp:

bytes

verify_code(cred_id, code)

Jätkata sissetuleva OTP-koodi kontrollimist (ka vastupidine HOTP). :param cred_id: :param code: HOTP-kood, mida tuleb kontrollida. u32 esitus. :return: ebaõnnestub OTPAppException’i veaga; tagastab True, kui kood vastab sisemiselt arvutatud väärtusele.

Parameetrid:

  • cred_id (bytes)

  • code (int)

Tagastustüüp:

bool

verify_pin_raw(password)
Parameetrid:

password (str)

Tagastustüüp:

None

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

Põlvnemine: 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

Põlvnemine: object

SelectResponse(version: baitide], pin_attempt_counter: salt: [bait], challenge: Valikuline[bytes], algorithm: Optional[bytes], serial_number: Optional[bytes])

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

  • version (bytes | None)

  • pin_attempt_counter (int | None)

  • salt (bytes | None)

  • challenge (bytes | None)

  • algorithm (bytes | None)

  • serial_number (bytes | None)

Tagastustüüp:

None

version_str()
Tagastustüüp:

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

Põlvnemine: 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