nitrokey.nk3.secrets_app

Oath Authenticator client

Used through CTAPHID transport, via the custom vendor command. Can be used directly over CCID as well.

exception nitrokey.nk3.secrets_app.SecretsAppException

Bases: Exception

SecretsAppException(code: str, context: str)

__init__(code, context)
Parametri:

  • code (str)

  • context (str)

Atgriežamais tips:

None

to_id()
Atgriežamais tips:

SecretsAppExceptionID

to_string()
Atgriežamais tips:

str

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

Bases: Exception

class nitrokey.nk3.secrets_app.Algorithm

Bases: Enum

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

Bases: Enum

Select = 164
class nitrokey.nk3.secrets_app.Instruction

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

Bases: Enum

classmethod from_attribute_byte(attribute_byte)
Parametri:

attribute_byte (bytes)

Atgriežamais tips:

str

classmethod from_attribute_byte_type(a)
Parametri:

a (int)

Atgriežamais tips:

Kind

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

Bases: object

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

__init__(kind, algorithm, label, properties)
Parametri:
Atgriežamais tips:

None

classmethod get_type_name(x)
Parametri:

x (Any)

Atgriežamais tips:

str

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

Bases: 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)

Atgriežamais tips:

None

classmethod from_byte(b)
Parametri:

b (int)

Atgriežamais tips:

ListItemProperties

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

Bases: object

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

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

  • login (bytes | None)

  • password (bytes | None)

  • metadata (bytes | None)

  • properties (bytes | None)

  • name (bytes | None)

Atgriežamais tips:

None

tlv_encode()
Atgriežamais tips:

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

Bases: object

RawBytes(data: list[int])

__init__(data)
Parametri:

data (list[int])

Atgriežamais tips:

None

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

Bases: object

This is a Secrets App client https://github.com/Nitrokey/trussed-secrets-app

__init__(dev, logfn=None)
Parametri:

  • dev (NK3)

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

calculate(cred_id, challenge=None)

Calculate the OTP code for the credential named cred_id, and with challenge challenge.

Parametri:

  • cred_id (bytes) – The name of the credential

  • challenge (int | None) – Challenge for the calculations (TOTP only). Should be equal to: timestamp/period. The commonly used period value is 30.

Atgriež:

OTP code as a byte string

Atgriežamais tips:

bytes

change_pin_raw(password, new_password)
Parametri:

  • password (str)

  • new_password (str)

Atgriežamais tips:

None

clear_code()

Clear the passphrase used to authenticate to other commands.

Atgriežamais tips:

None

delete(cred_id)

Dzēst akreditācijas datus ar norādīto id. Neizdara kļūdu, ja dotā pilnvara nepastāv. :param credid: ID:: pilnvaras ID

Parametri:

cred_id (bytes)

Atgriežamais tips:

None

classmethod encode_properties_to_send(touch_button_required, pin_based_encryption, tlv=False)

Īpašību struktūras kodēšana vienā baitā @param touch_button_required: vai tiek pieprasīta skārienpoga izmantošana @param pin_based_encryption: vai tiek pieprasīta PIN-šifrēšana (tikai reģistrācijas laikā) @param tlv: iestatiet True, ja tas ir jākodē kā TLV, nevis kā noklusējuma „TV“, w/o L

Parametri:

  • touch_button_required (bool)

  • pin_based_encryption (bool)

  • tlv (bool)

Atgriežamais tips:

RawBytes

feature_active_PIN_authentication()
Atgriežamais tips:

bool

feature_challenge_response_support()
Atgriežamais tips:

bool

feature_extended_list()
Atgriežamais tips:

bool

feature_old_application_version()
Atgriežamais tips:

bool

feature_pws_support()
Atgriežamais tips:

bool

get_credential(cred_id)
Parametri:

cred_id (bytes)

Atgriežamais tips:

PasswordSafeEntry

get_feature_status_cached()
Atgriežamais tips:

SelectResponse

get_response_for_secret(challenge, secret)
Parametri:

  • challenge (bytes)

  • secret (bytes)

Atgriežamais tips:

bytes

get_secret_for_passphrase(passphrase)
Parametri:

passphrase (str)

Atgriežamais tips:

bytes

is_pin_healthy()
Atgriežamais tips:

bool

list(extended=False)

Atgriež reģistrēto pilnvaru sarakstu :return: Ja ir sniegts slēdzis „extended“, tiek atgriezts: @deprecated

Parametri:

extended (bool)

Atgriežamais tips:

list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)

Atgriež reģistrēto pilnvaru sarakstu ar īpašībām :return: Saraksts ListItems

Parametri:

version (int)

Atgriežamais tips:

List[ListItem]

protocol_v2_confirm_all_requests_with_pin()
Atgriežamais tips:

bool

protocol_v3_separate_pin_and_no_pin_space()
Atgriežamais tips:

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)

Reģistrēt jaunu OTP akreditīvu :param credid: : Credential ID :param secret: Koplietojamā atslēga :param digits: Izgatavotā koda cipari :param kind: OTP variants - HOTP vai TOTP :param algo: Izmantojamais šifrēšanas algoritms - SHA1, SHA256 vai SHA512 :param initial_counter_value: Sākotnējā skaitītāja vērtība HOTP akreditācijai (tikai HOTP) :param touch_button_required: Lietotāja klātbūtnes apstiprinājums ir nepieciešams, lai izmantotu šo Credential :param pin_based_encryption: Lietotājs dod priekšroku papildu šifrēšanai ar PIN kodu :param login: Pieteikšanās lauks Password Safe :param password: Paroles lauks Password Safe :param metadata: Param Param: metadatu lauks Password Safe :return: : Nav:

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)

Atgriežamais tips:

None

register_yk_hmac(slot, secret)

Reģistrējiet ar Yubikey saderīgu izaicinājuma un atbildes slotu. @param slots: challenge-response slot @param secret: secret

Parametri:

  • slot (int)

  • secret (bytes)

Atgriežamais tips:

None

rename_credential(cred_id, new_name)

Pārdēvēt akreditācijas datus. Izsaukuma update_credential() aizstājvārds. @param cred_id: maināmās pilnvaras ID @param new_name: jauns pilnvaras ID

Parametri:

  • cred_id (bytes)

  • new_name (bytes)

Atgriežamais tips:

None

reset()

Noņemt visus akreditācijas datus no datubāzes

Atgriežamais tips:

None

select()

Izpilda SELECT komandu, kas atgriež informāciju par ierīci, tostarp autentifikācijai nepieciešamo izaicinājumu. :return SelectResponse statusa struktūra. Izaicinājuma un algoritma lauki ir None, ja piekļuves frāze nav iestatīta.

Atgriežamais tips:

SelectResponse

set_code(passphrase)

Iestatiet kodu ar noklusējuma iestatījumiem, kā ieteikts protokola specifikācijā: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parametri:

passphrase (str)

Atgriežamais tips:

None

set_code_raw(key, challenge, response)

Iestatiet vai notīriet piekļuves frāzi, ko izmanto citu komandu autentifikācijai. Neapstrādāts interfeiss. :param atslēga: Lietotāja piekļuves frāze, kas apstrādāta, izmantojot PBKDF2(ID,1000), un ierobežota ar pirmajiem 16 baitiem. :param izaicinājums: Pašreizējais izaicinājums, kas ņemts no SELECT komandas. :param atbilde: Pašreizējais izaicinājums, kas ņemts no Klienta aprēķinātie dati kā pareizas iestatīšanas pierādījums.

Parametri:

  • key (bytes)

  • challenge (bytes)

  • response (bytes)

Atgriežamais tips:

None

set_pin_raw(password)
Parametri:

password (str)

Atgriežamais tips:

None

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

Atjaunināt akreditācijas laukus - nosaukumu, atribūtus un PWS laukus. Neaizpildītie lauki netiks kodēti un izmantoti atjaunināšanas procesā (nemainīs pašreizējo vērtību). @param cred_id: @param new_name: jaunais akreditācijas ID @param login: Jauns pieteikšanās lauka saturs @param password: Jauns paroles lauka saturs @param metadata: Jauns metadatu lauka saturs @param touch_button: Iestatiet, vai jāpieprasa skārienpoga izmantošana

Parametri:

  • cred_id (bytes)

  • new_name (bytes | None)

  • login (bytes | None)

  • password (bytes | None)

  • metadata (bytes | None)

  • touch_button (bool | None)

Atgriežamais tips:

None

validate(passphrase)

Authenticate using a passphrase

Parametri:

passphrase (str)

Atgriežamais tips:

None

validate_raw(challenge, response)

Autentifikācija, izmantojot piekļuves frāzi. Neapstrādāts interfeiss. :param challenge: Pašreizējais izaicinājums, kas ņemts no SELECT komandas. :param response: atbilde, kas aprēķināta, ņemot vērā izaicinājumu un noslēpumu.

Parametri:

  • challenge (bytes)

  • response (bytes)

Atgriežamais tips:

bytes

verify_code(cred_id, code)

Turpināt ienākošā OTP koda pārbaudi (jeb reverso HOTP). :param cred_id: : param kods: HOTP kods pārbaudei. u32 atveidojums. :return: neizdodas ar OTPAppException kļūdu; atgriež True, ja kods atbilst iekšēji aprēķinātajai vērtībai.

Parametri:

  • cred_id (bytes)

  • code (int)

Atgriežamais tips:

bool

verify_pin_raw(password)
Parametri:

password (str)

Atgriežamais tips:

None

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

Bāzes: 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

Bases: object

SelectResponse(versija: (izvēles[baiti]), pin_attempt_counter: Neobligāts[int], salt: Optional[baiti], challenge: Optional[baiti], algoritms:_t_aritm: Neobligāts[baiti], serial_number: (pēc izvēles[baiti])

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

Atgriežamais tips:

None

version_str()
Atgriežamais tips:

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

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