nitrokey.nk3.secrets_app¶

Oath Authenticator client

Bruges gennem CTAPHID-transport via den tilpassede leverandørkommando. Kan også bruges direkte over CCID.

exception nitrokey.nk3.secrets_app.SecretsAppException¶

Baser: Exception

SecretsAppException(code: str, context: str)

__init__(code, context)¶

Parametre:

code (str)
context (str)

Returtype:

None

to_id()¶

Returtype:: SecretsAppExceptionID

to_string()¶

Returtype:: str

code: str¶

context: str¶

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

class nitrokey.nk3.secrets_app.Algorithm¶

Baser: Enum

Sha1 = 1¶

Sha256 = 2¶

Sha512 = 3¶

class nitrokey.nk3.secrets_app.CCIDInstruction¶

Baser: Enum

Select = 164¶

class nitrokey.nk3.secrets_app.Instruction¶

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

Baser: Enum

classmethod from_attribute_byte(attribute_byte)¶

Parametre:: attribute_byte (bytes)
Returtype:: str

classmethod from_attribute_byte_type(a)¶

Parametre:: a (int)
Returtype:: Kind

Hmac = 64¶

Hotp = 16¶

HotpReverse = 48¶

NotSet = 240¶

Totp = 32¶

class nitrokey.nk3.secrets_app.ListItem¶

Baser: object

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

__init__(kind, algorithm, label, properties)¶

Parametre:

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

Returtype:

None

classmethod get_type_name(x)¶

Parametre:: x (Any)
Returtype:: str

algorithm: Algorithm¶

kind: Kind¶

label: bytes¶

properties: ListItemProperties¶

class nitrokey.nk3.secrets_app.ListItemProperties¶

Baser: object

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

__init__(touch_required, secret_encryption, pws_data_exist)¶

Parametre:

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

Returtype:

None

classmethod from_byte(b)¶

Parametre:: b (int)
Returtype:: ListItemProperties

pws_data_exist: bool¶

secret_encryption: bool¶

touch_required: bool¶

class nitrokey.nk3.secrets_app.PasswordSafeEntry¶

Baser: object

PasswordSafeEntry(login: Valgfri[bytes], adgangskode: Valgfri[bytes], metadata: Valgfri[bytes], egenskaber: Optional[bytes] = None, name: Optional[bytes] = None)

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

Parametre:

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

Returtype:

None

tlv_encode()¶

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

Baser: object

RawBytes(data: list[int])

__init__(data)¶

Parametre:: data (list[int])
Returtype:: None

data: list[int]¶

class nitrokey.nk3.secrets_app.SecretsApp¶

Baser: object

Dette er en Secrets App-klient https://github.com/Nitrokey/trussed-secrets-app

__init__(dev, logfn=None)¶

Parametre:

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

calculate(cred_id, challenge=None)¶

Beregn OTP-koden for legitimationsoplysningerne med navnet cred_id og med udfordringen challenge.

Parametre:

cred_id (bytes) – The name of the credential
challenge (int | None) – Udfordring for beregningerne (kun TOTP). Bør være lig med: tidsstempel/periode. Den almindeligt anvendte periodeværdi er 30.

Returnerer:

OTP-kode som en bytestreng

Returtype:

bytes

change_pin_raw(password, new_password)¶

Parametre:

password (str)
new_password (str)

Returtype:

None

clear_code()¶

Slet den passphrase, der bruges til at godkende andre kommandoer.

Returtype:: None

delete(cred_id)¶

Slet legitimationsoplysninger med det givne id. Fejler ikke, hvis den givne legitimation ikke findes. :param credid: ID for legitimationsoplysninger

Parametre:: cred_id (bytes)
Returtype:: None

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

Kod egenskabsstrukturen til en enkelt byte @param touch_button_required: om brug af touch-knap er påkrævet @param pin_based_encryption: om der anmodes om PIN-kryptering (kun under registrering) @param tlv: sæt True, hvis dette skal kodes som TLV, i modsætning til standard »TV«, w/o L

Parametre:

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

Returtype:

RawBytes

feature_active_PIN_authentication()¶

Returtype:: bool

feature_challenge_response_support()¶

Returtype:: bool

feature_extended_list()¶

Returtype:: bool

feature_old_application_version()¶

Returtype:: bool

feature_pws_support()¶

Returtype:: bool

get_credential(cred_id)¶

Parametre:: cred_id (bytes)
Returtype:: PasswordSafeEntry

get_feature_status_cached()¶

Returtype:: SelectResponse

get_response_for_secret(challenge, secret)¶

Parametre:

challenge (bytes)
secret (bytes)

Returtype:

bytes

get_secret_for_passphrase(passphrase)¶

Parametre:: passphrase (str)
Returtype:: bytes

is_pin_healthy()¶

Returtype:: bool

list(extended=False)¶

Returnerer en liste over de registrerede legitimationsoplysninger :return: Liste over bytestrings, eller tupel af bytestrings, hvis »extended« switch er angivet @deprecated

Parametre:: extended (bool)
Returtype:: list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)¶

Returnerer en liste over de registrerede legitimationsoplysninger med egenskaber :return: Liste over ListItems

Parametre:: version (int)
Returtype:: List[ListItem]

protocol_v2_confirm_all_requests_with_pin()¶

Returtype:: bool

protocol_v3_separate_pin_and_no_pin_space()¶

Returtype:: 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)¶

Registrer ny OTP-legitimation :param credid: Credential ID :param secret: Den delte nøgle :param digits: Cifre i den producerede kode :param kind: OTP-variant - HOTP eller TOTP :param algo: Den hashalgoritme, der skal bruges - SHA1, SHA256 eller SHA512 :param initial_counter_value: Tællerens oprindelige værdi for HOTP-legitimationen (kun HOTP) :param touch_button_required: Bekræftelse af brugertilstedeværelse er påkrævet for at bruge denne legitimation :param pin_based_encryption: Brugerens præference for yderligere PIN-baseret kryptering :param login: Login-felt til Password Safe :param password: Password-felt til Password Safe :param metadata: Metadatafelt til Password Safe :return: Ingen

Parametre:

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)

Returtype:

None

register_yk_hmac(slot, secret)¶

Registrer en Yubikey-kompatibel udfordring-svar-slot. @param slot: challenge-response slot @param secret: hemmeligheden

Parametre:

slot (int)
secret (bytes)

Returtype:

None

rename_credential(cred_id, new_name)¶

Omdøb legitimationsoplysninger. Et alias for update_credential()-kaldet. @param cred_id: Det legitimations-ID, der skal ændres @param new_name: Nyt ID for legitimationen

Parametre:

cred_id (bytes)
new_name (bytes)

Returtype:

None

reset()¶

Fjern alle legitimationsoplysninger fra databasen

Returtype:: None

select()¶

Udfør SELECT-kommandoen, som returnerer oplysninger om enheden, herunder den udfordring, der er nødvendig for godkendelsen. :return SelectResponse Status-struktur. Felterne Challenge og Algorithm er None, hvis passphrase ikke er indstillet.

Returtype:: SelectResponse

set_code(passphrase)¶

Indstil koden med standardindstillingerne som foreslået i protokolspecifikationen: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parametre:: passphrase (str)
Returtype:: None

set_code_raw(key, challenge, response)¶

Indstil eller slet den passphrase, der bruges til at godkende andre kommandoer. Rå grænseflade. :param key: Brugerens passphrase behandlet gennem PBKDF2(ID,1000) og begrænset til de første 16 bytes. :param challenge: Den aktuelle udfordring fra SELECT-kommandoen. :param response: De data, der beregnes på klienten, som bevis på en korrekt opsætning.

Parametre:

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

Returtype:

None

set_pin_raw(password)¶

Parametre:: password (str)
Returtype:: None

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

Opdater legitimationsfelter - navn, attributter og PWS-felter. Uudfyldte felter vil ikke blive kodet og brugt under opdateringsprocessen (vil ikke ændre den aktuelle værdi). @param cred_id: Det legitimations-ID, der skal ændres @param new_name: Nyt ID for legitimationen @param login: Nyt indhold i login-feltet @param password: Nyt indhold i password-feltet @param metadata: Nyt indhold i metadatafeltet @param touch_button: Indstil, om brug af touch-knap skal være påkrævet

Parametre:

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

Returtype:

None

validate(passphrase)¶

Authenticate using a passphrase

Parametre:: passphrase (str)
Returtype:: None

validate_raw(challenge, response)¶

Godkend ved hjælp af en passphrase. Rå grænseflade. :param challenge: Den aktuelle udfordring hentet fra SELECT-kommandoen. :param response: Svaret beregnet på baggrund af udfordringen og hemmeligheden

Parametre:

challenge (bytes)
response (bytes)

Returtype:

bytes

verify_code(cred_id, code)¶

Fortsæt med den indgående OTP-kodeverifikation (også kaldet omvendt HOTP). :param cred_id: Navnet på legitimationsoplysningerne :param code: HOTP-koden, der skal verificeres. u32-repræsentation. :return: mislykkes med OTPAppException-fejl; returnerer True, hvis koden matcher den værdi, der er beregnet internt.

Parametre:

cred_id (bytes)
code (int)

Returtype:

bool

verify_pin_raw(password)¶

Parametre:: password (str)
Returtype:: None

dev: NK3¶

log: Logger¶

logfn: Callable[[str], Any]¶

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

class nitrokey.nk3.secrets_app.SecretsAppExceptionID¶

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

Baser: object

SelectResponse(version: Valgfri[bytes], pin_attempt_counter: Valgfri[int], salt: Valgfri[bytes], udfordring: Optional[bytes], algorithm: Optional[bytes], serial_number: Valgfri[bytes])

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

Parametre:

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

Returtype:

None

version_str()¶

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

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