nitrokey.nk3.secrets_app

Oath Authenticator client

Se utiliza a través del transporte CTAPHID, mediante el comando de proveedor personalizado. También se puede utilizar directamente a través de CCID.

exception nitrokey.nk3.secrets_app.SecretsAppException

Bases: Exception

SecretsAppException(code: str, context: str)

__init__(code, context)

Parámetros:

• code (str)

• context (str)

Tipo del valor devuelto:

None

to_id()

Tipo del valor devuelto:

SecretsAppExceptionID

to_string()

Tipo del valor devuelto:

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)

Parámetros:

attribute_byte (bytes)

Tipo del valor devuelto:

str

classmethod from_attribute_byte_type(a)

Parámetros:

a (int)

Tipo del valor devuelto:

Kind

Hmac = 64

Hotp = 16

HotpReverse = 48

NotSet = 240

Totp = 32

class nitrokey.nk3.secrets_app.ListItem

Bases: objeto

ListItem(kind: “Tipo”, algorithm: “Algoritmo”, label: bytes, properties: nitrokey.nk3.secrets_app.ListItemProperties)

__init__(kind, algorithm, label, properties)

Parámetros:

• kind (Kind)

• algorithm (Algorithm)

• label (bytes)

• properties (ListItemProperties)

Tipo del valor devuelto:

None

classmethod get_type_name(x)

Parámetros:

x (Any)

Tipo del valor devuelto:

str

algorithm: Algorithm

kind: Kind

label: bytes

properties: ListItemProperties

class nitrokey.nk3.secrets_app.ListItemProperties

Bases: objeto

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

__init__(touch_required, secret_encryption, pws_data_exist)

Parámetros:

• touch_required (bool)

• secret_encryption (bool)

• pws_data_exist (bool)

Tipo del valor devuelto:

None

classmethod from_byte(b)

Parámetros:

b (int)

Tipo del valor devuelto:

ListItemProperties

pws_data_exist: bool

secret_encryption: bool

touch_required: bool

class nitrokey.nk3.secrets_app.PasswordSafeEntry

Bases: objeto

PasswordSafeEntry(login: Opcional[bytes], contraseña: Optional[bytes], metadatos: Optional[bytes], propiedades: Optional[bytes] = None, nombre: Optional[bytes] = None)

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

Parámetros:

• login (bytes | None)

• password (bytes | None)

• metadata (bytes | None)

• properties (bytes | None)

• name (bytes | None)

Tipo del valor devuelto:

None

tlv_encode()

Tipo del valor devuelto:

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

RawBytes(datos: lista[int])

__init__(data)

Parámetros:

data (list[int])

Tipo del valor devuelto:

None

data: list[int]

class nitrokey.nk3.secrets_app.SecretsApp

Bases: objeto

Este es un cliente de Secrets App https://github.com/Nitrokey/trussed-secrets-app

__init__(dev, logfn=None)

Parámetros:

• dev (NK3)

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

calculate(cred_id, challenge=None)

Calcular el código OTP para la credencial denominada cred_id, y con reto challenge.

Parámetros:

• cred_id (bytes) – The name of the credential

• challenge (int | None) – Desafío para los cálculos (sólo TOTP). Debe ser igual a: timestamp/period. El valor de periodo utilizado habitualmente es 30.

Devuelve:

Código OTP como cadena de bytes

Tipo del valor devuelto:

bytes

change_pin_raw(password, new_password)

Parámetros:

• password (str)

• new_password (str)

Tipo del valor devuelto:

None

clear_code()

Borra la frase de contraseña utilizada para autenticarse en otros comandos.

Tipo del valor devuelto:

None

delete(cred_id)

Borra la credencial con el id dado. No falla, si la credencial dada no existe. :param credid: ID de la credencial

Parámetros:

cred_id (bytes)

Tipo del valor devuelto:

None

classmethod encode_properties_to_send(touch_button_required, pin_based_encryption, tlv=False)

Codificar la estructura de propiedades en un único byte @param touch_button_required: si se requiere el uso del botón táctil @param pin_based_encryption: si se solicita el cifrado del PIN (sólo durante el registro) @param tlv: establecer True, si esto debe ser codificado como TLV, en lugar de «TV» por defecto, w/o L

Parámetros:

• touch_button_required (bool)

• pin_based_encryption (bool)

• tlv (bool)

Tipo del valor devuelto:

RawBytes

feature_active_PIN_authentication()

Tipo del valor devuelto:

bool

feature_challenge_response_support()

Tipo del valor devuelto:

bool

feature_extended_list()

Tipo del valor devuelto:

bool

feature_old_application_version()

Tipo del valor devuelto:

bool

feature_pws_support()

Tipo del valor devuelto:

bool

get_credential(cred_id)

Parámetros:

cred_id (bytes)

Tipo del valor devuelto:

PasswordSafeEntry

get_feature_status_cached()

Tipo del valor devuelto:

SelectResponse

get_response_for_secret(challenge, secret)

Parámetros:

• challenge (bytes)

• secret (bytes)

Tipo del valor devuelto:

bytes

get_secret_for_passphrase(passphrase)

Parámetros:

passphrase (str)

Tipo del valor devuelto:

bytes

is_pin_healthy()

Tipo del valor devuelto:

bool

list(extended=False)

Devuelve una lista de las credenciales registradas :return: Lista de bytestrings, o tupla de bytestrings, si se proporciona el modificador «extended» @deprecated

Parámetros:

extended (bool)

Tipo del valor devuelto:

list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)

Devuelve una lista de las credenciales registradas con propiedades :return: Lista de ListItems

Parámetros:

version (int)

Tipo del valor devuelto:

List[ListItem]

protocol_v2_confirm_all_requests_with_pin()

Tipo del valor devuelto:

bool

protocol_v3_separate_pin_and_no_pin_space()

Tipo del valor devuelto:

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)

Registrar nueva credencial OTP :param credid: ID de la credencial :param secret: La clave compartida :param digits: Los dígitos del código producido :param kind: Variante OTP - HOTP o TOTP :param algo: El algoritmo hash a utilizar - SHA1, SHA256 o SHA512 :param initial_counter_value: El valor inicial del contador para la credencial HOTP (sólo HOTP) :param touch_button_required: Se requiere la confirmación de presencia del usuario para utilizar esta credencial :param pin_based_encryption: Preferencia del usuario para cifrado adicional basado en PIN :param login: Campo de inicio de sesión para Password Safe :param password: Campo de contraseña para Password Safe :param metadata: Campo de metadatos para Password Safe :return: Ninguno

Parámetros:

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

Tipo del valor devuelto:

None

register_yk_hmac(slot, secret)

Registrar una ranura desafío-respuesta compatible con Yubikey. @param slot: ranura de desafío-respuesta @param secret: el secreto

Parámetros:

• slot (int)

• secret (bytes)

Tipo del valor devuelto:

None

rename_credential(cred_id, new_name)

Renombrar credencial. Un alias para la llamada update_credential(). @param cred_id: El ID de la credencial a modificar @param new_name: Nuevo ID para la credencial

Parámetros:

• cred_id (bytes)

• new_name (bytes)

Tipo del valor devuelto:

None

reset()

Eliminar todas las credenciales de la base de datos

Tipo del valor devuelto:

None

select()

Ejecuta el comando SELECT, que devuelve detalles sobre el dispositivo, incluido el desafío necesario para la autenticación. :return Estructura de estado SelectResponse. Los campos Challenge y Algorithm son None, si no se ha establecido la frase de contraseña.

Tipo del valor devuelto:

SelectResponse

set_code(passphrase)

Configure el código con los valores predeterminados sugeridos en la especificación del protocolo: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parámetros:

passphrase (str)

Tipo del valor devuelto:

None

set_code_raw(key, challenge, response)

Establece o borra la frase de contraseña utilizada para autenticarse en otros comandos. Interfaz sin procesar. :param key: Frase de contraseña del usuario procesada mediante PBKDF2(ID,1000), y limitada a los 16 primeros bytes. :param challenge: El desafío actual tomado del comando SELECT. :param response: Los datos calculados en el cliente, como prueba de una configuración correcta.

Parámetros:

• key (bytes)

• challenge (bytes)

• response (bytes)

Tipo del valor devuelto:

None

set_pin_raw(password)

Parámetros:

password (str)

Tipo del valor devuelto:

None

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

Actualizar campos de credenciales: nombre, atributos y campos PWS. Los campos no rellenados no se codificarán ni se utilizarán durante el proceso de actualización (no cambiarán el valor actual). @param cred_id: El ID de la credencial a modificar @param new_name: Nuevo ID para la credencial @param login: Nuevo contenido del campo login @param password: Nuevo contenido del campo password @param metadata: Nuevo contenido del campo de metadatos @param touch_button: Establece si el uso del botón táctil debe ser obligatorio

Parámetros:

• cred_id (bytes)

• new_name (bytes | None)

• login (bytes | None)

• password (bytes | None)

• metadata (bytes | None)

• touch_button (bool | None)

Tipo del valor devuelto:

None

validate(passphrase)

Authenticate using a passphrase

Parámetros:

passphrase (str)

Tipo del valor devuelto:

None

validate_raw(challenge, response)

Autenticación mediante frase de contraseña. Interfaz sin procesar. :param challenge: El desafío actual tomado del comando SELECT. :param response: La respuesta calculada contra el reto y el secreto.

Parámetros:

• challenge (bytes)

• response (bytes)

Tipo del valor devuelto:

bytes

verify_code(cred_id, code)

Proceder a la verificación del código OTP entrante (también conocido como HOTP inverso). :param cred_id: El nombre de la credencial :param code: El código HOTP a verificar. Representación u32. :return: falla con error OTPAppException; devuelve True si el código coincide con el valor calculado internamente.

Parámetros:

• cred_id (bytes)

• code (int)

Tipo del valor devuelto:

bool

verify_pin_raw(password)

Parámetros:

password (str)

Tipo del valor devuelto:

None

dev: NK3

log: Logger

logfn: Callable[[str], Any]

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

class nitrokey.nk3.secrets_app.SecretsAppExceptionID

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

SeleccionarRespuesta(version: Opcional[bytes], pin_attempt_counter: Optional[int], salt: Optional[bytes], challenge: Optional[bytes], algoritmo: Optional[bytes], número_serie: Optional[bytes])

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

Parámetros:

• version (bytes | None)

• pin_attempt_counter (int | None)

• salt (bytes | None)

• challenge (bytes | None)

• algorithm (bytes | None)

• serial_number (bytes | None)

Tipo del valor devuelto:

None

version_str()

Tipo del valor devuelto:

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