nitrokey.nk3.secrets_app¶

Oath Authenticator client

Utilizado através do transporte CTAPHID, através do comando personalizado do fornecedor. Também pode ser utilizado diretamente através do CCID.

exception nitrokey.nk3.secrets_app.SecretsAppException¶

Bases: Exception

SecretsAppException(código: str, contexto: str)

__init__(code, context)¶

Parâmetros:

code (str)
context (str)

Tipo de retorno:

None

to_id()¶

Tipo de retorno:: SecretsAppExceptionID

to_string()¶

Tipo de retorno:: 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 de retorno:: str

classmethod from_attribute_byte_type(a)¶

Parâmetros:: a (int)
Tipo de retorno:: 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)¶

Parâmetros:

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

Tipo de retorno:

None

classmethod get_type_name(x)¶

Parâmetros:: x (Any)
Tipo de retorno:: 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)¶

Parâmetros:

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

Tipo de retorno:

None

classmethod from_byte(b)¶

Parâmetros:: b (int)
Tipo de retorno:: 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] = Nenhum, nome: Optional[bytes] = Nenhum)

__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 de retorno:

None

tlv_encode()¶

Tipo de retorno:: 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(dados: lista[int])

__init__(data)¶

Parâmetros:: data (list[int])
Tipo de retorno:: None

data: list[int]¶

class nitrokey.nk3.secrets_app.SecretsApp¶

Bases: object

Este é um cliente da aplicação Secrets 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 o código OTP para a credencial denominada cred_id e com o desafio challenge.

Parâmetros:

cred_id (bytes) – The name of the credential
challenge (int | None) – Desafio para os cálculos (apenas TOTP). Deve ser igual a: carimbo de data/hora/período. O valor de período normalmente utilizado é 30.

Retorno:

Código OTP como uma cadeia de bytes

Tipo de retorno:

bytes

change_pin_raw(password, new_password)¶

Parâmetros:

password (str)
new_password (str)

Tipo de retorno:

None

clear_code()¶

Limpar a frase-chave utilizada para autenticar outros comandos.

Tipo de retorno:: None

delete(cred_id)¶

Apaga a credencial com o id fornecido. Não falha, se a credencial fornecida não existir. :param credid: ID da credencial

Parâmetros:: cred_id (bytes)
Tipo de retorno:: None

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

Codificar a estrutura das propriedades num único byte @param touch_button_required: se é necessária a utilização do botão tátil @param pin_based_encryption: se é pedida a encriptação do PIN (apenas durante o registo) @param tlv: definir True, se isto deve ser codificado como TLV, por oposição à predefinição «TV», sem L

Parâmetros:

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

Tipo de retorno:

RawBytes

feature_active_PIN_authentication()¶

Tipo de retorno:: bool

feature_challenge_response_support()¶

Tipo de retorno:: bool

feature_extended_list()¶

Tipo de retorno:: bool

feature_old_application_version()¶

Tipo de retorno:: bool

feature_pws_support()¶

Tipo de retorno:: bool

get_credential(cred_id)¶

Parâmetros:: cred_id (bytes)
Tipo de retorno:: PasswordSafeEntry

get_feature_status_cached()¶

Tipo de retorno:: SelectResponse

get_response_for_secret(challenge, secret)¶

Parâmetros:

challenge (bytes)
secret (bytes)

Tipo de retorno:

bytes

get_secret_for_passphrase(passphrase)¶

Parâmetros:: passphrase (str)
Tipo de retorno:: bytes

is_pin_healthy()¶

Tipo de retorno:: bool

list(extended=False)¶

Devolve uma lista das credenciais registadas :return: Lista de bytestrings, ou tupla de bytestrings, se a opção «extended» for fornecida @deprecated

Parâmetros:: extended (bool)
Tipo de retorno:: list[Tuple[bytes, bytes] | bytes]

list_with_properties(version=1)¶

Devolve uma lista das credenciais registadas com as propriedades :return: Lista de ListItems

Parâmetros:: version (int)
Tipo de retorno:: List[ListItem]

protocol_v2_confirm_all_requests_with_pin()¶

Tipo de retorno:: bool

protocol_v3_separate_pin_and_no_pin_space()¶

Tipo de retorno:: 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)¶

Registar uma nova credencial OTP :param credid: ID da credencial :param secret: A chave partilhada :param digits: Os dígitos do código produzido :param kind: Variante OTP - HOTP ou TOTP :param algo: O algoritmo de hash a utilizar - SHA1, SHA256 ou SHA512 :param initial_counter_value: O valor inicial do contador para a Credencial HOTP (apenas HOTP) :param touch_button_required: É necessária a confirmação da presença do utilizador para utilizar esta credencial :param pin_based_encryption: Preferência do utilizador por encriptação adicional baseada em PIN :param login: Campo de início de sessão para o cofre de senhas :param password: Campo de senha para o cofre de senhas :param metadata: Campo de metadados para a Password Safe :return: Nenhum

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 de retorno:

None

register_yk_hmac(slot, secret)¶

Registar uma ranhura de resposta a desafios compatível com o Yubikey. @param slot: ranhura de desafio-resposta @param secret: o segredo

Parâmetros:

slot (int)
secret (bytes)

Tipo de retorno:

None

rename_credential(cred_id, new_name)¶

Mudar o nome da credencial. Um alias para a chamada update_credential(). @param cred_id: O ID da credencial a modificar @param new_name: Novo ID para a credencial

Parâmetros:

cred_id (bytes)
new_name (bytes)

Tipo de retorno:

None

reset()¶

Remover todas as credenciais da base de dados

Tipo de retorno:: None

select()¶

Executa o comando SELECT, que devolve detalhes sobre o dispositivo, incluindo o desafio necessário para a autenticação. :return SelectResponse Estrutura de estado. Os campos Desafio e Algoritmo são Nenhum, se a frase-chave não estiver definida.

Tipo de retorno:: SelectResponse

set_code(passphrase)¶

Definir o código com as predefinições sugeridas na especificação do protocolo: - https://developers.yubico.com/OATH/YKOATH_Protocol.html

Parâmetros:: passphrase (str)
Tipo de retorno:: None

set_code_raw(key, challenge, response)¶

Define ou apaga a frase-chave utilizada para autenticar outros comandos. Interface bruta. :param key: A frase-chave do utilizador processada através de PBKDF2(ID,1000), e limitada aos primeiros 16 bytes. :param desafio: O desafio atual retirado do comando SELECT. :param resposta: Os dados calculados no cliente, como prova de uma configuração correta.

Parâmetros:

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

Tipo de retorno:

None

set_pin_raw(password)¶

Parâmetros:: password (str)
Tipo de retorno:: None

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

Atualizar campos de credenciais - nome, atributos e campos PWS. Os campos não preenchidos não serão codificados e utilizados durante o processo de atualização (não alteram o valor atual). @param cred_id: A ID da credencial a modificar @param new_name: Nova ID para a credencial @param login: Novo conteúdo do campo login @param password: Novo conteúdo do campo password @param metadata: Novo conteúdo do campo de metadados @param touch_button: Define se a utilização do botão de toque deve ser obrigatória

Parâmetros:

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

Tipo de retorno:

None

validate(passphrase)¶

Authenticate using a passphrase

Parâmetros:: passphrase (str)
Tipo de retorno:: None

validate_raw(challenge, response)¶

Autenticar utilizando uma frase-chave. Interface bruta. :param desafio: O desafio atual retirado do comando SELECT. :param resposta: A resposta calculada com base no desafio e no segredo

Parâmetros:

challenge (bytes)
response (bytes)

Tipo de retorno:

bytes

verify_code(cred_id, code)¶

Procede à verificação do código OTP de entrada (também conhecido como HOTP invertido). :param cred_id: O nome da credencial :param code: O código HOTP a verificar. representação u32. :return: falha com o erro OTPAppException; devolve True se o código corresponder ao valor calculado internamente.

Parâmetros:

cred_id (bytes)
code (int)

Tipo de retorno:

bool

verify_pin_raw(password)¶

Parâmetros:: password (str)
Tipo de retorno:: 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: object

SelectResponse(version: Optional[bytes], pin_attempt_counter: Optional[int], salt: Optional[bytes], challenge: Optional[bytes], algorithm: Opcional[bytes], serial_number: Opcional[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 de retorno:

None

version_str()¶

Tipo de retorno:: 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¶